dsapi_const.h

Go to the documentation of this file.

/* Emacs mode: -*- C -*- */

/* 
 * Copyright (c) 2004-2021, Isode Limited, London, England.
 * All rights reserved.
 *
 * Acquisition and use of this software and related materials for any
 * purpose requires a written licence agreement from Isode Limited, or
 * a written licence from an organisation licenced by Isode Limited to
 * grant such a licence.
 *
 */

/*
 * dsapi_const.h
 *
 * Symbolic constants.
 *
 */

/* 
 * 
 *
 * @VERSION@
 */

#ifndef ISODE_DSAPI_CONST_H
#define ISODE_DSAPI_CONST_H

/* API Version. */
#define DSAPI_VERSION 2048

/* Generic parameter representation. */
#ifndef PRIVATE_DEFINITION
#define DS_INT_TYPE 0x01000000

#define DS_STR_TYPE 0x02000000

#define DS_BOOL_TYPE 0x04000000

#define DS_BYTES_TYPE 0x08000000

/* Get parameter type from ID (see dsapi_const.h for parameter IDs). */
#define DS_PARAM_TYPE_MASK 0xff000000

#define PARAMTYPE(id) ( id & DS_PARAM_TYPE_MASK )

/* Add typing bits to a parameter ID value. */
#define MAKE_PARAM_ID(val, param_type) ( val | param_type )

#endif

typedef enum {
    DS_E_NOERROR = 0,
    DS_E_NOSPACE = 1,
    DS_E_BADPARAM = 2,
    DS_E_NOTFOUND = 3,
    DS_E_NOMEMORY = 4,
    DS_E_NOTIMPLEMENTED = 5,
    DS_E_BADATTRTYPE = 6,
    DS_E_BADATTRVALUE = 7,
    DS_E_BADATTRSYNTAX = 8,
    DS_E_BADFILTER = 9,
    DS_E_BADDN = 10,
    DS_E_BADENTRY = 11,
    DS_E_DSOPFAILED = 12,
    DS_E_INTERNAL = 13,
    DS_E_NOTBOUND = 14,
    DS_E_BADADDR = 15,
    DS_E_SIGNEDOPFAILED = 16,
    DS_E_OPFAILED = 17,
    DS_E_ABORTED = 18,
    DS_E_CONNECTIONLOST = 19
} DS_Status;

typedef enum {
    DS_E_SUCCESS = 0,
    /*< Successful operation. */
    
    DS_E_ATTRIBUTE = 1,
    DS_E_NAME = 2,
    DS_E_SERVICE = 3,
    DS_E_REFERRAL = 4,
    DS_E_ABANDONED = 5,
    DS_E_SECURITY = 6,
    DS_E_ABANDONFAILED = 7,
    DS_E_UPDATE = 8,
    DS_E_DSAREFERRAL = 9,
    DS_E_LOCAL = 10,
    DS_E_REMOTE = 11,
    DS_E_UNKNOWN = 12,
    DS_E_X509 = 13
} DS_ErrorType;

typedef enum {
    DS_E_NOINFO = 0,
    DS_E_AT_NOSUCHATTRIBUTE = 1,
    DS_E_AT_INVALIDATTRIBUTESYNTAX = 2,
    DS_E_AT_UNDEFINEDATTRIBUTETYPE = 3,
    DS_E_AT_INAPPROPRIATEMATCHING = 4,
    DS_E_AT_CONSTRAINTVIOLATION = 5,
    DS_E_AT_TYPEORVALUEEXISTS = 6,
    DS_E_NAME_NOSUCHOBJECT = 7,
    DS_E_NAME_ALIASPROBLEM = 8,
    DS_E_NAME_INVALIDATTRIBUTESYNTAX = 9,
    DS_E_NAME_ALIASDEREFERENCE = 10,
    DS_E_SVC_BUSY = 11,
    DS_E_SVC_UNAVAILABLE = 12,
    DS_E_SVC_UNWILLINGTOPERFORM = 13,
    DS_E_SVC_CHAININGREQUIRED = 14,
    DS_E_SVC_UNABLETOPROCEED = 15,
    DS_E_SVC_INVALIDREFERENCE = 16,
    DS_E_SVC_TIMELIMITEXCEEDED = 17,
    DS_E_SVC_ADMINISTRATIVELIMITEXCEEDED = 18,
    DS_E_SVC_LOOPDETECTED = 19,
    DS_E_SVC_UNAVAILABLECRITICALEXTENSION = 20,
    DS_E_SVC_OUTOFSCOPE = 21,
    DS_E_SVC_DITERROR = 22,
    DS_E_SVC_INVALIDQUERYREFERENCE = 23,
    DS_E_SEC_AUTHENTICATION = 24,
    DS_E_SEC_INVALIDCREDENTIALS = 25,
    DS_E_SEC_ACCESSRIGHTS = 26,
    DS_E_SEC_INVALIDSIGNATURE = 27,
    DS_E_SEC_PROTECTIONREQUIRED = 28,
    DS_E_SEC_NOINFORMATION = 29,
    DS_E_AB_NOSUCHOPERATION = 43,
    DS_E_AB_TOOLATE = 44,
    DS_E_AB_CANNOTABANDON = 45,
    DS_E_UPD_NAMINGVIOLATION = 46,
    DS_E_UPD_OBJECTCLASSVIOLATION = 47,
    DS_E_UPD_NOTONNONLEAF = 48,
    DS_E_UPD_NOTONRDN = 49,
    DS_E_UPD_ALREADYEXISTS = 50,
    DS_E_UPD_AFFECTSMULTIPLEDSAS = 51,
    DS_E_UPD_NOOBJECTCLASSMODS = 52,
    DS_E_X509_RESULTSDISCARDED = 53
} DS_ErrorValue;

#define DS_SVC_OPT_PREFERCHAIN  MAKE_PARAM_ID(1, DS_BOOL_TYPE)

#define DS_SVC_OPT_CHAININGPROHIBIT     MAKE_PARAM_ID(2, DS_BOOL_TYPE)

#define DS_SVC_OPT_LOCALSCOPE           MAKE_PARAM_ID(3, DS_BOOL_TYPE)

#define DS_SVC_OPT_DONTUSECOPY  MAKE_PARAM_ID(4, DS_BOOL_TYPE)

#define DS_SVC_OPT_DONTDEREFALIAS       MAKE_PARAM_ID(5, DS_BOOL_TYPE)

#define DS_SVC_OPT_SUBENTRIES           MAKE_PARAM_ID(6, DS_BOOL_TYPE)

#define DS_SVC_OPT_COPYSHALLDO  MAKE_PARAM_ID(7, DS_BOOL_TYPE)

#define DS_SVC_PRIORITY                 MAKE_PARAM_ID(8, DS_INT_TYPE)

#define DS_SVC_TIMELIMIT                MAKE_PARAM_ID(9, DS_INT_TYPE)

#define DS_SVC_SIZELIMIT                MAKE_PARAM_ID(10, DS_INT_TYPE)

#define DS_EXT_OPT_MANAGEDSAIT          MAKE_PARAM_ID(11, DS_BOOL_TYPE)

#define DS_SEC_SIGNED                   MAKE_PARAM_ID(12, DS_BOOL_TYPE)

#define DS_SEC_ENCRYPTED                MAKE_PARAM_ID(13, DS_BOOL_TYPE)

#define DS_SVC_OPT_ATTRSONLY            MAKE_PARAM_ID(14, DS_BOOL_TYPE)

#define DS_SVC_OPT_SEARCHALIASES        MAKE_PARAM_ID(15, DS_BOOL_TYPE)

#define DS_EXT_OPT_USEALIASONUPDATE     MAKE_PARAM_ID(16, DS_BOOL_TYPE)

#define DS_SVC_PASSWORDPOLICY           MAKE_PARAM_ID(17, DS_BOOL_TYPE)

#define DS_SVC_OPT_PAGESIZE             MAKE_PARAM_ID(18, DS_INT_TYPE)

#define DS_SEC_DISABLEVERIFICATION      MAKE_PARAM_ID(19, DS_BOOL_TYPE)

#define DS_SVC_OPT_TXNID                MAKE_PARAM_ID(20, DS_BYTES_TYPE)

typedef enum {
    DS_PP_PASSWORD_EXPIRED = 0,
    DS_PP_ACCOUNT_LOCKED = 1,
    DS_PP_CHANGE_AFTER_RESET = 2,
    DS_PP_PASSWORD_MOD_NOT_ALLOWED = 3,
    DS_PP_MUST_SUPPLY_OLD_PASSWORD = 4,
    DS_PP_INSUFFICIENT_PASSWORD_QUALITY = 5,
    DS_PP_PASSWORD_TOO_SHORT = 6,
    DS_PP_PASSWORD_TOO_YOUNG = 7,
    DS_PP_PASSWORD_IN_HISTORY = 8,
    DS_PP_NO_ERROR = 65535
} DS_PasswordPolicyError;

#endif /* ISODE_DSAPI_CONST_H */