X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=include%2Fldap.h;h=b7cb33777d80d6c5618848f23a92e2498d9eaee2;hb=30fdb0e0cab3ae645ffc42375f19b0e4efb9a5c4;hp=0540f1ffc4b9edd21f2c2377835a3bb2d81c4a31;hpb=6bd59cc58fcb6a03b50c9021a1286059bb6047ba;p=openldap diff --git a/include/ldap.h b/include/ldap.h index 0540f1ffc4..b7cb33777d 100644 --- a/include/ldap.h +++ b/include/ldap.h @@ -1,16 +1,18 @@ /* $OpenLDAP$ */ -/* - * Copyright 1998-2002 The OpenLDAP Foundation, Redwood City, California, USA +/* This work is part of OpenLDAP Software . + * + * Copyright 1998-2004 The OpenLDAP Foundation. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted only as authorized by the OpenLDAP - * Public License. A copy of this license is available at - * http://www.OpenLDAP.org/license.html or in file LICENSE in the - * top-level directory of the distribution. + * Public License. + * + * A copy of this license is available in file LICENSE in the + * top-level directory of the distribution or, alternatively, at + * . */ -/* Portions - * Copyright (c) 1990 Regents of the University of Michigan. +/* Portions Copyright (c) 1990 Regents of the University of Michigan. * All rights reserved. * * Redistribution and use in source and binary forms are permitted @@ -41,11 +43,12 @@ LDAP_BEGIN_DECL #define LDAP_VERSION_MAX LDAP_VERSION3 /* - * We'll use 2000+draft revision for our API version number - * As such, the number will be above the old RFC but below - * whatever number does finally get assigned + * We use 3000+n here because it is above 1823 (for RFC 1823), + * above 2000+rev of IETF LDAPEXT draft (now quite dated), + * yet below allocations for new RFCs (just in case there is + * someday an RFC produced). */ -#define LDAP_API_VERSION 2004 +#define LDAP_API_VERSION 3001 #define LDAP_VENDOR_NAME "OpenLDAP" /* OpenLDAP API Features */ @@ -64,52 +67,59 @@ LDAP_BEGIN_DECL /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */ #endif + #define LDAP_PORT 389 /* ldap:/// default LDAP port */ #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */ #define LDAP_ROOT_DSE "" #define LDAP_NO_ATTRS "1.1" #define LDAP_ALL_USER_ATTRIBUTES "*" -#define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */ +#define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */ + +/* RFC 2251: maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */ +#define LDAP_MAXINT (2147483647) /* - * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02 - * 0x0000 - 0x0fff reserved for api options - * 0x1000 - 0x3fff reserved for api extended options - * 0x4000 - 0x7fff reserved for private and experimental options + * LDAP_OPTions + * 0x0000 - 0x0fff reserved for api options + * 0x1000 - 0x3fff reserved for api extended options + * 0x4000 - 0x7fff reserved for private and experimental options */ + #define LDAP_OPT_API_INFO 0x0000 -#define LDAP_OPT_DESC 0x0001 /* deprecated */ +#define LDAP_OPT_DESC 0x0001 /* historic */ #define LDAP_OPT_DEREF 0x0002 #define LDAP_OPT_SIZELIMIT 0x0003 #define LDAP_OPT_TIMELIMIT 0x0004 -/* 0x05 - 0x07 not defined by current draft */ +/* 0x05 - 0x07 not defined */ #define LDAP_OPT_REFERRALS 0x0008 #define LDAP_OPT_RESTART 0x0009 -/* 0x0a - 0x10 not defined by current draft */ +/* 0x0a - 0x10 not defined */ #define LDAP_OPT_PROTOCOL_VERSION 0x0011 #define LDAP_OPT_SERVER_CONTROLS 0x0012 #define LDAP_OPT_CLIENT_CONTROLS 0x0013 -/* 0x14 not defined by current draft */ +/* 0x14 not defined */ #define LDAP_OPT_API_FEATURE_INFO 0x0015 - -/* 0x16 - 0x2f not defined by current draft */ +/* 0x16 - 0x2f not defined */ #define LDAP_OPT_HOST_NAME 0x0030 -#define LDAP_OPT_ERROR_NUMBER 0x0031 +#define LDAP_OPT_RESULT_CODE 0x0031 +#define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE #define LDAP_OPT_ERROR_STRING 0x0032 #define LDAP_OPT_MATCHED_DN 0x0033 +/* 0x0034 - 0x3fff not defined */ -/* 0x34 - 0x0fff not defined by current draft */ - -#define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000 /* to 0x7FFF inclusive */ +/* API Extensions */ +#define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */ /* private and experimental options */ /* OpenLDAP specific options */ #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */ #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */ #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */ -#define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */ +#define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */ #define LDAP_OPT_URI 0x5006 +#define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */ +#define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */ /* OpenLDAP TLS options */ #define LDAP_OPT_X_TLS 0x6000 @@ -124,10 +134,10 @@ LDAP_BEGIN_DECL #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a -#define LDAP_OPT_X_TLS_NEVER 0 +#define LDAP_OPT_X_TLS_NEVER 0 #define LDAP_OPT_X_TLS_HARD 1 -#define LDAP_OPT_X_TLS_DEMAND 2 -#define LDAP_OPT_X_TLS_ALLOW 3 +#define LDAP_OPT_X_TLS_DEMAND 2 +#define LDAP_OPT_X_TLS_ALLOW 3 #define LDAP_OPT_X_TLS_TRY 4 /* OpenLDAP SASL options */ @@ -142,10 +152,8 @@ LDAP_BEGIN_DECL #define LDAP_OPT_X_SASL_SSF_MAX 0x6108 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109 - -/* on/off values */ -#define LDAP_OPT_ON ((void *) 1) -#define LDAP_OPT_OFF ((void *) 0) +/* Private API Extensions -- reserved for application use */ +#define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */ /* * ldap_get_option() and ldap_set_option() return values. @@ -156,9 +164,13 @@ LDAP_BEGIN_DECL #define LDAP_OPT_SUCCESS 0 #define LDAP_OPT_ERROR (-1) -#define LDAP_API_INFO_VERSION (1) +/* option on/off values */ +#define LDAP_OPT_ON ((void *) &ber_pvt_opt_on) +#define LDAP_OPT_OFF ((void *) 0) + typedef struct ldapapiinfo { - int ldapai_info_version; /* version of LDAPAPIInfo (1) */ + int ldapai_info_version; /* version of LDAPAPIInfo */ +#define LDAP_API_INFO_VERSION (1) int ldapai_api_version; /* revision of API supported */ int ldapai_protocol_version; /* highest LDAP version supported */ char **ldapai_extensions; /* names of API extensions */ @@ -166,69 +178,145 @@ typedef struct ldapapiinfo { int ldapai_vendor_version; /* supplier-specific version * 100 */ } LDAPAPIInfo; -#define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */ typedef struct ldap_apifeature_info { - int ldapaif_info_version; /* version of this struct (1) */ - char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */ - int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */ + int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */ +#define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */ + char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */ + int ldapaif_version; /* value of LDAP_API_FEATURE_... */ } LDAPAPIFeatureInfo; +/* + * LDAP Control structure + */ typedef struct ldapcontrol { - char * ldctl_oid; - struct berval ldctl_value; - char ldctl_iscritical; + char * ldctl_oid; /* numericoid of control */ + struct berval ldctl_value; /* encoded value of control */ + char ldctl_iscritical; /* criticality */ } LDAPControl; /* LDAP Controls */ +/* standard track controls */ +#define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */ +#define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */ +#define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */ -#if 0 - /* chase referrals client control (not yet implemented) */ -#define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616" -#define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U -#define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U -#endif +/* standard track - not implemented in slapd(8) */ +#define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */ +#define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */ -#define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" -#define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" -#define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.1.10.2" +/* but not yet formalized controls */ +#define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" +#define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3" + +/* various works in progress */ +#define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9" +#define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2" +#define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1" +#define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2" #if 0 +/* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */ #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1" #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2" #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3" #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST - -#define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" #endif -#define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" -#define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" +/* LDAP VLV *//* not implemented in slapd(8) */ #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9" #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10" -#define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3" +/* Password policy Controls *//* work in progress */ +#ifdef LDAP_DEVEL +#define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1" +#define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1" +#endif + +/* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */ +#define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1" +#define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1" +#define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2" +#define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3" +#define LDAP_SYNC_INFO LDAP_SYNC_OID ".4" + +#define LDAP_SYNC_NONE 0x00 +#define LDAP_SYNC_REFRESH_ONLY 0x01 +#define LDAP_SYNC_RESERVED 0x02 +#define LDAP_SYNC_REFRESH_AND_PERSIST 0x03 + +#define LDAP_SYNC_REFRESH_PRESENTS 0 +#define LDAP_SYNC_REFRESH_DELETES 1 + +#define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U) +#define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U) +#define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U) +#define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U) + +#define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U) +#define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U) +#define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U) +#define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U) + +#define LDAP_SYNC_PRESENT 0 +#define LDAP_SYNC_ADD 1 +#define LDAP_SYNC_MODIFY 2 +#define LDAP_SYNC_DELETE 3 + +/* MS ActiveDirectory controls (for compatibility) */ +#define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339" +#define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413" +#define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802" +#define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805" +#define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340" +#define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */ +#define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all NCs subordinate to base */ /* LDAP Unsolicited Notifications */ -#define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" +#define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */ #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION /* LDAP Extended Operations */ -#define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" +#define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */ -#define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" +#define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */ #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U) #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U) #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U) #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U) #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" +#define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3" + +/* LDAP Grouping of Related Operations *//* a work in progress */ +#ifdef LDAP_DEVEL +#define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3" +#define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1" +#define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2" +#define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3" +#define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4" +#define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5" +#define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6" +#endif + +/* LDAP Grouping Types *//* a work in progress */ +#ifdef LDAP_DEVEL +#define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4" +#endif /* LDAP Features */ -#define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* + */ -#define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2" +#define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */ +#define LDAP_FEATURE_OBJECTCLASS_ATTRS \ + "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */ #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */ #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4" #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5" +#define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2" + +#ifdef LDAP_DEVEL +#define LDAP_FEATURE_SUBORDINATE_SCOPE \ + "1.3.6.1.4.1.4203.666.8.1" /* "children" */ +#define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE +#endif /* * specific LDAP instantiations of BER types we know about @@ -254,8 +342,10 @@ typedef struct ldapcontrol { /* general stuff */ #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */ #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */ + #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */ #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */ + #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */ #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */ @@ -266,103 +356,112 @@ typedef struct ldapcontrol { #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */ #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */ -#define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */ +#define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */ +#define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */ +#define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */ -/* possible operations a client can invoke */ -#define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */ -#define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */ -#define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */ -#define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */ -#define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */ -#define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */ -#define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */ -#define LDAP_REQ_MODRDN LDAP_REQ_MODDN -#define LDAP_REQ_RENAME LDAP_REQ_MODDN -#define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */ -#define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */ -#define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */ - -/* possible result types a server can return */ -#define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */ -#define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */ +/* LDAP Request Messages */ +#define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */ +#define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */ +#define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */ +#define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */ +#define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */ +#define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */ +#define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */ +#define LDAP_REQ_MODRDN LDAP_REQ_MODDN +#define LDAP_REQ_RENAME LDAP_REQ_MODDN +#define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */ +#define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */ +#define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */ + +/* LDAP Response Messages */ +#define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */ +#define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */ #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */ -#define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */ -#define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */ -#define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */ -#define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */ -#define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */ -#define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */ -#define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */ -#define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */ -#define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */ -#define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */ +#define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */ +#define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */ +#define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */ +#define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */ +#define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */ +#define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */ +#define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */ +#define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */ +#define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */ +#define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */ #define LDAP_RES_ANY (-1) #define LDAP_RES_UNSOLICITED (0) /* sasl methods */ -#define LDAP_SASL_SIMPLE ((char*)0) -#define LDAP_SASL_NULL ("") +#define LDAP_SASL_SIMPLE ((char*)0) +#define LDAP_SASL_NULL ("") /* authentication methods available */ -#define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */ -#define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */ -#define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */ -#define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */ -#define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */ -#define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */ +#define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */ +#define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */ +#define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */ +#define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */ +#define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */ +#define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */ /* filter types */ -#define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */ -#define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */ -#define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */ -#define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */ -#define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */ -#define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */ -#define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */ -#define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */ -#define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */ -#define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */ +#define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */ +#define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */ +#define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */ +#define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */ +#define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */ +#define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */ +#define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */ +#define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */ +#define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */ +#define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */ /* extended filter component types */ -#define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */ +#define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */ #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */ #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */ #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */ /* substring filter component types */ #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */ -#define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */ +#define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */ #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */ /* search scopes */ -#define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) -#define LDAP_SCOPE_BASE ((ber_int_t) 0x0000) -#define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001) -#define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002) +#define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */ +#define LDAP_SCOPE_BASE ((ber_int_t) 0x0000) +#define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE +#define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001) +#define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL +#define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002) +#define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE +#ifdef LDAP_DEVEL +#define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */ +#define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE +#endif /* substring filter component types */ #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */ -#define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */ +#define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */ #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */ /* - * possible error codes we can return + * LDAP Result Codes */ +#define LDAP_SUCCESS 0x00 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y))) -#define LDAP_SUCCESS 0x00 #define LDAP_OPERATIONS_ERROR 0x01 -#define LDAP_PROTOCOL_ERROR 0x02 +#define LDAP_PROTOCOL_ERROR 0x02 #define LDAP_TIMELIMIT_EXCEEDED 0x03 #define LDAP_SIZELIMIT_EXCEEDED 0x04 -#define LDAP_COMPARE_FALSE 0x05 -#define LDAP_COMPARE_TRUE 0x06 +#define LDAP_COMPARE_FALSE 0x05 +#define LDAP_COMPARE_TRUE 0x06 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED #define LDAP_STRONG_AUTH_REQUIRED 0x08 @@ -377,32 +476,33 @@ typedef struct ldapcontrol { #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */ #define LDAP_NO_SUCH_ATTRIBUTE 0x10 -#define LDAP_UNDEFINED_TYPE 0x11 +#define LDAP_UNDEFINED_TYPE 0x11 #define LDAP_INAPPROPRIATE_MATCHING 0x12 #define LDAP_CONSTRAINT_VIOLATION 0x13 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14 -#define LDAP_INVALID_SYNTAX 0x15 +#define LDAP_INVALID_SYNTAX 0x15 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */ -#define LDAP_NO_SUCH_OBJECT 0x20 -#define LDAP_ALIAS_PROBLEM 0x21 +#define LDAP_NO_SUCH_OBJECT 0x20 +#define LDAP_ALIAS_PROBLEM 0x21 #define LDAP_INVALID_DN_SYNTAX 0x22 -#define LDAP_IS_LEAF 0x23 /* not LDAPv3 */ +#define LDAP_IS_LEAF 0x23 /* not LDAPv3 */ #define LDAP_ALIAS_DEREF_PROBLEM 0x24 -#define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */ +#define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */ +#define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */ #define LDAP_INAPPROPRIATE_AUTH 0x30 #define LDAP_INVALID_CREDENTIALS 0x31 #define LDAP_INSUFFICIENT_ACCESS 0x32 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */ -#define LDAP_BUSY 0x33 -#define LDAP_UNAVAILABLE 0x34 +#define LDAP_BUSY 0x33 +#define LDAP_UNAVAILABLE 0x34 #define LDAP_UNWILLING_TO_PERFORM 0x35 -#define LDAP_LOOP_DETECT 0x36 +#define LDAP_LOOP_DETECT 0x36 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */ @@ -410,37 +510,58 @@ typedef struct ldapcontrol { #define LDAP_OBJECT_CLASS_VIOLATION 0x41 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42 #define LDAP_NOT_ALLOWED_ON_RDN 0x43 -#define LDAP_ALREADY_EXISTS 0x44 +#define LDAP_ALREADY_EXISTS 0x44 #define LDAP_NO_OBJECT_CLASS_MODS 0x45 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */ #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */ -#define LDAP_OTHER 0x50 - -#define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */ -#define LDAP_API_RESULT(n) (((n) == LDAP_SUCCESS) || \ - LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */ - -/* reserved for APIs */ -#define LDAP_SERVER_DOWN 0x51 -#define LDAP_LOCAL_ERROR 0x52 -#define LDAP_ENCODING_ERROR 0x53 -#define LDAP_DECODING_ERROR 0x54 -#define LDAP_TIMEOUT 0x55 -#define LDAP_AUTH_UNKNOWN 0x56 -#define LDAP_FILTER_ERROR 0x57 -#define LDAP_USER_CANCELLED 0x58 -#define LDAP_PARAM_ERROR 0x59 -#define LDAP_NO_MEMORY 0x5a - -/* used but not reserved for APIs */ -#define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */ -#define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */ -#define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */ -#define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */ -#define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */ -#define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */ -#define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */ +#define LDAP_OTHER 0x50 + +/* Experimental result codes */ +#define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */ +#define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */ + +/* for the LDAP Sync operation */ +#define LDAP_SYNC_REFRESH_REQUIRED 0x4100 + +/* for the LDAP No-Op control */ +#define LDAP_NO_OPERATION 0x410e + +/* for the Assertion control */ +#define LDAP_ASSERTION_FAILED 0x410f + +/* for the Cancel operation */ +#define LDAP_CANCELLED 0x4110 +#define LDAP_NO_SUCH_OPERATION 0x4111 +#define LDAP_TOO_LATE 0x4112 +#define LDAP_CANNOT_CANCEL 0x4113 + +/* API Error Codes + * + * Based on draft-ietf-ldap-c-api-xx + * but with new negative code values + */ +#define LDAP_API_ERROR(n) ((n)<0) +#define LDAP_API_RESULT(n) ((n)<=0) + +#define LDAP_SERVER_DOWN (-1) +#define LDAP_LOCAL_ERROR (-2) +#define LDAP_ENCODING_ERROR (-3) +#define LDAP_DECODING_ERROR (-4) +#define LDAP_TIMEOUT (-5) +#define LDAP_AUTH_UNKNOWN (-6) +#define LDAP_FILTER_ERROR (-7) +#define LDAP_USER_CANCELLED (-8) +#define LDAP_PARAM_ERROR (-9) +#define LDAP_NO_MEMORY (-10) +#define LDAP_CONNECT_ERROR (-11) +#define LDAP_NOT_SUPPORTED (-12) +#define LDAP_CONTROL_NOT_FOUND (-13) +#define LDAP_NO_RESULTS_RETURNED (-14) +#define LDAP_MORE_RESULTS_TO_RETURN (-15) +#define LDAP_CLIENT_LOOP (-16) +#define LDAP_REFERRAL_LIMIT_EXCEEDED (-17) + /* * This structure represents both ldap messages and ldap responses. @@ -454,10 +575,12 @@ typedef struct ldapmsg LDAPMessage; typedef struct ldapmod { int mod_op; -#define LDAP_MOD_ADD ((ber_int_t) 0x0000) -#define LDAP_MOD_DELETE ((ber_int_t) 0x0001) -#define LDAP_MOD_REPLACE ((ber_int_t) 0x0002) -#define LDAP_MOD_BVALUES ((ber_int_t) 0x0080) +#define LDAP_MOD_OP (0x0007) +#define LDAP_MOD_ADD (0x0000) +#define LDAP_MOD_DELETE (0x0001) +#define LDAP_MOD_REPLACE (0x0002) +#define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */ +#define LDAP_MOD_BVALUES (0x0080) /* IMPORTANT: do not use code 0x1000 (or above), * it is used internally by the backends! * (see ldap/servers/slapd/slap.h) @@ -479,17 +602,17 @@ typedef struct ldapmod { */ typedef struct ldap LDAP; -#define LDAP_DEREF_NEVER 0x00 +#define LDAP_DEREF_NEVER 0x00 #define LDAP_DEREF_SEARCHING 0x01 -#define LDAP_DEREF_FINDING 0x02 -#define LDAP_DEREF_ALWAYS 0x03 +#define LDAP_DEREF_FINDING 0x02 +#define LDAP_DEREF_ALWAYS 0x03 -#define LDAP_NO_LIMIT 0 +#define LDAP_NO_LIMIT 0 /* how many messages to retrieve results for */ -#define LDAP_MSG_ONE 0x00 -#define LDAP_MSG_ALL 0x01 -#define LDAP_MSG_RECEIVED 0x02 +#define LDAP_MSG_ONE 0x00 +#define LDAP_MSG_ALL 0x01 +#define LDAP_MSG_RECEIVED 0x02 /* * types for ldap URL handling @@ -563,6 +686,11 @@ ldap_create_control LDAP_P(( int iscritical, LDAPControl **ctrlp )); +LDAP_F( LDAPControl * ) +ldap_find_control LDAP_P(( + LDAP_CONST char *oid, + LDAPControl **ctrls )); + LDAP_F( void ) ldap_control_free LDAP_P(( LDAPControl *ctrl )); @@ -620,7 +748,7 @@ ldap_parse_extended_result LDAP_P(( int freeit )); LDAP_F( int ) -ldap_parse_extended_partial LDAP_P(( +ldap_parse_intermediate LDAP_P(( LDAP *ld, LDAPMessage *res, char **retoidp, @@ -628,6 +756,112 @@ ldap_parse_extended_partial LDAP_P(( LDAPControl ***serverctrls, int freeit )); +/* + * in groupings.c: + */ +#ifdef LDAP_EXOP_GROUPING_CREATE + +LDAP_F( int ) +ldap_grouping_create LDAP_P(( + LDAP *ld, + LDAP_CONST char *grpoid, + struct berval *grpdata, + LDAPControl **serverctrls, + LDAPControl **clientctrls, + int *msgidp )); + +LDAP_F( int ) +ldap_grouping_create_s LDAP_P(( + LDAP *ld, + LDAP_CONST char *grpoid, + struct berval *grpdata, + LDAPControl **serverctrls, + LDAPControl **clientctrls, + struct berval **retgrpcookiep, + struct berval **retgrpdatap )); + +LDAP_F( int ) +ldap_parse_grouping_create_result LDAP_P(( + LDAP *ld, + LDAPMessage *res, + struct berval **retgrpcookiep, + struct berval **retgrpdatap, + LDAPControl ***serverctrls, + int freeit )); + +LDAP_F( int ) +ldap_grouping_end LDAP_P(( + LDAP *ld, + LDAP_CONST char *grpoid, + struct berval *grpdata, + LDAPControl **serverctrls, + LDAPControl **clientctrls, + int *msgidp )); + +LDAP_F( int ) +ldap_grouping_end_s LDAP_P(( + LDAP *ld, + LDAP_CONST char *grpoid, + struct berval *grpdata, + LDAPControl **serverctrls, + LDAPControl **clientctrls, + struct berval **retgrpdatap )); + +LDAP_F( int ) +ldap_parse_grouping_end_result LDAP_P(( + LDAP *ld, + LDAPMessage *res, + struct berval **retgrpdatap, + LDAPControl ***serverctrls, + int freeit )); + +LDAP_F( int ) +ldap_grouping_action_operation LDAP_P(( + LDAP *ld, + LDAP_CONST char *grpoid, + struct berval *grpdata, + LDAPControl **serverctrls, + LDAPControl **clientctrls, + int *msgidp )); + +LDAP_F( int ) +ldap_grouping_action_operation_s LDAP_P(( + LDAP *ld, + LDAP_CONST char *grpoid, + struct berval *grpdata, + LDAPControl **serverctrls, + LDAPControl **clientctrls, + struct berval **retgrpcookiep, + struct berval **retgrpdatap )); + +LDAP_F( int ) +ldap_parse_grouping_action_result LDAP_P(( + LDAP *ld, + LDAPMessage *res, + struct berval **retgrpcookiep, + struct berval **retgrpdatap, + LDAPControl ***serverctrls, + int freeit )); + +LDAP_F( int ) +ldap_parse_grouping_end_notice LDAP_P(( + LDAP *ld, + LDAPMessage *res, + struct berval **retdatap, + struct berval **retgrpcookiep, + struct berval **retgrpdatap, + int freeit )); + +LDAP_F( int ) +ldap_parse_grouping_info_notice LDAP_P(( + LDAP *ld, + LDAPMessage *res, + struct berval **retdatap, + struct berval **retgrpcookiep, + struct berval **retgrpdatap, + int freeit )); +#endif + /* * in abandon.c: */ @@ -638,10 +872,12 @@ ldap_abandon_ext LDAP_P(( LDAPControl **serverctrls, LDAPControl **clientctrls )); +#if LDAP_DEPRECATED LDAP_F( int ) ldap_abandon LDAP_P(( /* deprecated */ LDAP *ld, int msgid )); +#endif /* @@ -664,6 +900,7 @@ ldap_add_ext_s LDAP_P(( LDAPControl **serverctrls, LDAPControl **clientctrls )); +#if LDAP_DEPRECATED LDAP_F( int ) ldap_add LDAP_P(( /* deprecated */ LDAP *ld, @@ -675,6 +912,7 @@ ldap_add_s LDAP_P(( /* deprecated */ LDAP *ld, LDAP_CONST char *dn, LDAPMod **attrs )); +#endif /* @@ -737,6 +975,7 @@ ldap_parse_sasl_bind_result LDAP_P(( struct berval **servercredp, int freeit )); +#if LDAP_DEPRECATED /* * in bind.c: * (deprecated) @@ -759,13 +998,13 @@ ldap_bind_s LDAP_P(( /* deprecated */ * in sbind.c: */ LDAP_F( int ) -ldap_simple_bind LDAP_P(( +ldap_simple_bind LDAP_P(( /* deprecated */ LDAP *ld, LDAP_CONST char *who, LDAP_CONST char *passwd )); LDAP_F( int ) -ldap_simple_bind_s LDAP_P(( +ldap_simple_bind_s LDAP_P(( /* deprecated */ LDAP *ld, LDAP_CONST char *who, LDAP_CONST char *passwd )); @@ -799,31 +1038,7 @@ LDAP_F( int ) ldap_kerberos_bind2_s LDAP_P(( /* deprecated */ LDAP *ld, LDAP_CONST char *who )); - -/* - * in cache.c - * (deprecated) - */ -LDAP_F( int ) -ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem )); - -LDAP_F( void ) -ldap_disable_cache LDAP_P(( LDAP *ld )); - -LDAP_F( void ) -ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts )); - -LDAP_F( void ) -ldap_destroy_cache LDAP_P(( LDAP *ld )); - -LDAP_F( void ) -ldap_flush_cache LDAP_P(( LDAP *ld )); - -LDAP_F( void ) -ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn )); - -LDAP_F( void ) -ldap_uncache_request LDAP_P(( LDAP *ld, int msgid )); +#endif /* @@ -848,6 +1063,7 @@ ldap_compare_ext_s LDAP_P(( LDAPControl **serverctrls, LDAPControl **clientctrls )); +#if LDAP_DEPRECATED LDAP_F( int ) ldap_compare LDAP_P(( /* deprecated */ LDAP *ld, @@ -861,6 +1077,7 @@ ldap_compare_s LDAP_P(( /* deprecated */ LDAP_CONST char *dn, LDAP_CONST char *attr, LDAP_CONST char *value )); +#endif /* @@ -881,6 +1098,7 @@ ldap_delete_ext_s LDAP_P(( LDAPControl **serverctrls, LDAPControl **clientctrls )); +#if LDAP_DEPRECATED LDAP_F( int ) ldap_delete LDAP_P(( /* deprecated */ LDAP *ld, @@ -890,6 +1108,7 @@ LDAP_F( int ) ldap_delete_s LDAP_P(( /* deprecated */ LDAP *ld, LDAP_CONST char *dn )); +#endif /* @@ -910,6 +1129,7 @@ LDAP_F( char * ) ldap_err2string LDAP_P(( int err )); +#if LDAP_DEPRECATED LDAP_F( int ) ldap_result2error LDAP_P(( /* deprecated */ LDAP *ld, @@ -920,6 +1140,7 @@ LDAP_F( void ) ldap_perror LDAP_P(( /* deprecated */ LDAP *ld, LDAP_CONST char *s )); +#endif /* @@ -942,6 +1163,7 @@ ldap_modify_ext_s LDAP_P(( LDAPControl **serverctrls, LDAPControl **clientctrls )); +#if LDAP_DEPRECATED LDAP_F( int ) ldap_modify LDAP_P(( /* deprecated */ LDAP *ld, @@ -953,6 +1175,7 @@ ldap_modify_s LDAP_P(( /* deprecated */ LDAP *ld, LDAP_CONST char *dn, LDAPMod **mods )); +#endif /* @@ -979,6 +1202,7 @@ ldap_rename_s LDAP_P(( LDAPControl **sctrls, LDAPControl **cctrls )); +#if LDAP_DEPRECATED LDAP_F( int ) ldap_rename2 LDAP_P(( /* deprecated */ LDAP *ld, @@ -1020,13 +1244,15 @@ ldap_modrdn2_s LDAP_P(( /* deprecated */ LDAP_CONST char *dn, LDAP_CONST char *newrdn, int deleteoldrdn)); +#endif /* * in open.c: */ +#if LDAP_DEPRECATED LDAP_F( LDAP * ) -ldap_init LDAP_P(( +ldap_init LDAP_P(( /* deprecated */ LDAP_CONST char *host, int port )); @@ -1034,6 +1260,7 @@ LDAP_F( LDAP * ) ldap_open LDAP_P(( /* deprecated */ LDAP_CONST char *host, int port )); +#endif LDAP_F( int ) ldap_create LDAP_P(( @@ -1068,7 +1295,6 @@ ldap_count_messages LDAP_P(( LDAP *ld, LDAPMessage *chain )); - /* * in references.c: */ @@ -1147,87 +1373,86 @@ typedef struct ldap_ava { struct berval la_attr; struct berval la_value; unsigned la_flags; -#define LDAP_AVA_STRING 0x0000U -#define LDAP_AVA_BINARY 0x0001U -#define LDAP_AVA_NONPRINTABLE 0x0002U +#define LDAP_AVA_NULL 0x0000U +#define LDAP_AVA_STRING 0x0001U +#define LDAP_AVA_BINARY 0x0002U +#define LDAP_AVA_NONPRINTABLE 0x0004U +#define LDAP_AVA_FREE_ATTR 0x0010U +#define LDAP_AVA_FREE_VALUE 0x0020U void *la_private; } LDAPAVA; typedef LDAPAVA** LDAPRDN; -typedef LDAPRDN** LDAPDN; +typedef LDAPRDN* LDAPDN; /* DN formats */ -#define LDAP_DN_FORMAT_LDAP 0x0000U +#define LDAP_DN_FORMAT_LDAP 0x0000U #define LDAP_DN_FORMAT_LDAPV3 0x0010U #define LDAP_DN_FORMAT_LDAPV2 0x0020U -#define LDAP_DN_FORMAT_DCE 0x0030U -#define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */ +#define LDAP_DN_FORMAT_DCE 0x0030U +#define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */ #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */ -#define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */ -#define LDAP_DN_FORMAT_MASK 0x00F0U +#define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */ +#define LDAP_DN_FORMAT_MASK 0x00F0U /* DN flags */ -#define LDAP_DN_PRETTY 0x0100U -#define LDAP_DN_SKIP 0x0200U +#define LDAP_DN_PRETTY 0x0100U +#define LDAP_DN_SKIP 0x0200U #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U -#define LDAP_DN_PEDANTIC 0xF000U +#define LDAP_DN_PEDANTIC 0xF000U -LDAP_F( void ) -ldap_avafree LDAP_P(( LDAPAVA *ava )); -LDAP_F( void ) -ldap_rdnfree LDAP_P(( LDAPRDN *rdn )); -LDAP_F( void ) -ldap_dnfree LDAP_P(( LDAPDN *dn )); +LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn )); +LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn )); LDAP_F( int ) ldap_bv2dn LDAP_P(( struct berval *bv, - LDAPDN **dn, + LDAPDN *dn, unsigned flags )); LDAP_F( int ) ldap_str2dn LDAP_P(( LDAP_CONST char *str, - LDAPDN **dn, + LDAPDN *dn, unsigned flags )); LDAP_F( int ) ldap_dn2bv LDAP_P(( - LDAPDN *dn, + LDAPDN dn, struct berval *bv, unsigned flags )); LDAP_F( int ) ldap_dn2str LDAP_P(( - LDAPDN *dn, + LDAPDN dn, char **str, unsigned flags )); LDAP_F( int ) ldap_bv2rdn LDAP_P(( struct berval *bv, - LDAPRDN **rdn, + LDAPRDN *rdn, char **next, unsigned flags )); LDAP_F( int ) ldap_str2rdn LDAP_P(( LDAP_CONST char *str, - LDAPRDN **rdn, + LDAPRDN *rdn, char **next, unsigned flags )); LDAP_F( int ) ldap_rdn2bv LDAP_P(( - LDAPRDN *rdn, + LDAPRDN rdn, struct berval *bv, unsigned flags )); LDAP_F( int ) ldap_rdn2str LDAP_P(( - LDAPRDN *rdn, + LDAPRDN rdn, char **str, unsigned flags )); @@ -1250,7 +1475,8 @@ ldap_explode_rdn LDAP_P(( /* deprecated */ LDAP_CONST char *rdn, int notypes )); -typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN *dn, unsigned flags )); +typedef int LDAPDN_rewrite_func + LDAP_P(( LDAPDN dn, unsigned flags, void *ctx )); LDAP_F( int ) ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn, @@ -1265,6 +1491,15 @@ ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */ LDAP_F( char * ) ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */ +LDAP_F( int ) +ldap_get_dn_ber LDAP_P(( + LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn )); + +LDAP_F( int ) +ldap_get_attribute_ber LDAP_P(( + LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr, + struct berval **vals )); + /* * in getattr.c */ @@ -1298,6 +1533,7 @@ LDAP_F( void ) ldap_value_free_len LDAP_P(( struct berval **vals )); +#if LDAP_DEPRECATED LDAP_F( char ** ) ldap_get_values LDAP_P(( /* deprecated */ LDAP *ld, @@ -1311,6 +1547,7 @@ ldap_count_values LDAP_P(( /* deprecated */ LDAP_F( void ) ldap_value_free LDAP_P(( /* deprecated */ char **vals )); +#endif /* * in result.c: @@ -1372,6 +1609,7 @@ ldap_search_ext_s LDAP_P(( int sizelimit, LDAPMessage **res )); +#if LDAP_DEPRECATED LDAP_F( int ) ldap_search LDAP_P(( /* deprecated */ LDAP *ld, @@ -1401,19 +1639,12 @@ ldap_search_st LDAP_P(( /* deprecated */ int attrsonly, struct timeval *timeout, LDAPMessage **res )); +#endif /* * in unbind.c */ LDAP_F( int ) -ldap_unbind LDAP_P(( /* deprecated */ - LDAP *ld )); - -LDAP_F( int ) -ldap_unbind_s LDAP_P(( /* deprecated */ - LDAP *ld )); - -LDAP_F( int ) ldap_unbind_ext LDAP_P(( LDAP *ld, LDAPControl **serverctrls, @@ -1425,6 +1656,16 @@ ldap_unbind_ext_s LDAP_P(( LDAPControl **serverctrls, LDAPControl **clientctrls)); +#if LDAP_DEPRECATED +LDAP_F( int ) +ldap_unbind LDAP_P(( /* deprecated */ + LDAP *ld )); + +LDAP_F( int ) +ldap_unbind_s LDAP_P(( /* deprecated */ + LDAP *ld )); +#endif + /* * in filter.c */ @@ -1469,9 +1710,9 @@ ldap_mods_free LDAP_P(( int freemods )); +#if LDAP_DEPRECATED /* - * in sort.c - * (deprecated) + * in sort.c (deprecated) */ typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */ LDAP_CONST char *left, @@ -1497,7 +1738,7 @@ LDAP_F( int ) /* deprecated */ ldap_sort_strcasecmp LDAP_P(( LDAP_CONST void *a, LDAP_CONST void *b )); - +#endif /* * in url.c @@ -1527,12 +1768,34 @@ LDAP_F( void ) ldap_free_urldesc LDAP_P(( LDAPURLDesc *ludp )); + /* - * in sortctrl.c + * LDAP Cancel Extended Operation + * in cancel.c */ +#define LDAP_API_FEATURE_CANCEL 1000 + +LDAP_F( int ) +ldap_cancel LDAP_P(( LDAP *ld, + int cancelid, + LDAPControl **sctrls, + LDAPControl **cctrls, + int *msgidp )); + +LDAP_F( int ) +ldap_cancel_s LDAP_P(( + LDAP *ld, + int cancelid, + LDAPControl **sctrl, + LDAPControl **cctrl )); + /* - * structure for a sort-key + * LDAP Server Side Sort + * in sortctrl.c */ +#define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000 + +/* structure for a sort-key */ typedef struct ldapsortkey { char * attributeType; char * orderingRule; @@ -1564,21 +1827,21 @@ ldap_parse_sort_control LDAP_P(( /* - * in vlvctrl.c + * LDAP Virtual List View + * in vlvctrl.c */ +#define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000 -/* - * structure for virtual list. - */ +/* structure for virtual list */ typedef struct ldapvlvinfo { int ldvlv_version; unsigned long ldvlv_before_count; unsigned long ldvlv_after_count; unsigned long ldvlv_offset; unsigned long ldvlv_count; - struct berval *ldvlv_attrvalue; - struct berval *ldvlv_context; - void *ldvlv_extradata; + struct berval * ldvlv_attrvalue; + struct berval * ldvlv_context; + void * ldvlv_extradata; } LDAPVLVInfo; LDAP_F( int ) @@ -1596,6 +1859,141 @@ ldap_parse_vlv_control LDAP_P(( struct berval **contextp, int *errcodep )); +/* + * LDAP Transactions + * in txn.c + */ +#ifdef LDAP_GROUPING_TRANSACTION +LDAP_F( int ) +ldap_parse_txn_create LDAP_P(( + LDAP *ld, + LDAPMessage *res, + struct berval **cookie )); + +LDAP_F( int ) +ldap_txn_create LDAP_P(( + LDAP *ld, + LDAPControl **sctrls, + LDAPControl **cctrls, + int *msgidp )); + +LDAP_F( int ) +ldap_txn_create_s LDAP_P(( + LDAP *ld, + struct berval **cookie, + LDAPControl **sctrls, + LDAPControl **cctrls )); + +LDAP_F( int ) +ldap_txn_end LDAP_P(( + LDAP *ld, + struct berval *cookie, + int commit, + LDAPControl **sctrls, + LDAPControl **cctrls, + int *msgidp )); + +LDAP_F( int ) +ldap_txn_end_s LDAP_P(( + LDAP *ld, + struct berval *cookie, + int commit, + LDAPControl **sctrls, + LDAPControl **cctrls )); +#endif + +/* + * LDAP Who Am I? + * in whoami.c + */ +#define LDAP_API_FEATURE_WHOAMI 1000 + +LDAP_F( int ) +ldap_parse_whoami LDAP_P(( + LDAP *ld, + LDAPMessage *res, + struct berval **authzid )); + +LDAP_F( int ) +ldap_whoami LDAP_P(( LDAP *ld, + LDAPControl **sctrls, + LDAPControl **cctrls, + int *msgidp )); + +LDAP_F( int ) +ldap_whoami_s LDAP_P(( + LDAP *ld, + struct berval **authzid, + LDAPControl **sctrls, + LDAPControl **cctrls )); + +/* + * LDAP Password Modify + * in passwd.c + */ +#define LDAP_API_FEATURE_PASSWD_MODIFY 1000 + +LDAP_F( int ) +ldap_parse_passwd LDAP_P(( + LDAP *ld, + LDAPMessage *res, + struct berval *newpasswd )); + +LDAP_F( int ) +ldap_passwd LDAP_P(( LDAP *ld, + struct berval *user, + struct berval *oldpw, + struct berval *newpw, + LDAPControl **sctrls, + LDAPControl **cctrls, + int *msgidp )); + +LDAP_F( int ) +ldap_passwd_s LDAP_P(( + LDAP *ld, + struct berval *user, + struct berval *oldpw, + struct berval *newpw, + struct berval *newpasswd, + LDAPControl **sctrls, + LDAPControl **cctrls )); + +#ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST +/* + * LDAP Password Policy controls + * in ppolicy.c + */ +#define LDAP_API_FEATURE_PASSWORD_POLICY 1000 + +typedef enum passpolicyerror_enum { + PP_passwordExpired = 0, + PP_accountLocked = 1, + PP_changeAfterReset = 2, + PP_passwordModNotAllowed = 3, + PP_mustSupplyOldPassword = 4, + PP_insufficientPasswordQuality = 5, + PP_passwordTooShort = 6, + PP_passwordTooYoung = 7, + PP_passwordInHistory = 8, + PP_noError = 65535 +} LDAPPasswordPolicyError; + +LDAP_F( int ) +ldap_create_passwordpolicy_control LDAP_P(( + LDAP *ld, + LDAPControl **ctrlp )); + +LDAP_F( int ) +ldap_parse_passwordpolicy_control LDAP_P(( + LDAP *ld, + LDAPControl *ctrl, + int *expirep, + int *gracep, + LDAPPasswordPolicyError *errorp )); + +LDAP_F( const char * ) +ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError )); +#endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */ LDAP_END_DECL #endif /* _LDAP_H */