git.sur5r.net Git - openldap/blob - include/ldap.h

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1998-2013 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
  16  * All rights reserved.
  17  *
  18  * Redistribution and use in source and binary forms are permitted
  19  * provided that this notice is preserved and that due credit is given
  20  * to the University of Michigan at Ann Arbor. The name of the University
  21  * may not be used to endorse or promote products derived from this
  22  * software without specific prior written permission. This software
  23  * is provided ``as is'' without express or implied warranty.
  24  */
  25
  26 #ifndef _LDAP_H
  27 #define _LDAP_H
  28
  29 /* pull in lber */
  30 #include <lber.h>
  31
  32 /* include version and API feature defines */
  33 #include <ldap_features.h>
  34
  35 LDAP_BEGIN_DECL
  36
  37 #define LDAP_VERSION1   1
  38 #define LDAP_VERSION2   2
  39 #define LDAP_VERSION3   3
  40
  41 #define LDAP_VERSION_MIN        LDAP_VERSION2
  42 #define LDAP_VERSION            LDAP_VERSION2
  43 #define LDAP_VERSION_MAX        LDAP_VERSION3
  44
  45 /*
  46  * We use 3000+n here because it is above 1823 (for RFC 1823),
  47  * above 2000+rev of IETF LDAPEXT draft (now quite dated),
  48  * yet below allocations for new RFCs (just in case there is
  49  * someday an RFC produced).
  50  */
  51 #define LDAP_API_VERSION        3001
  52 #define LDAP_VENDOR_NAME        "OpenLDAP"
  53
  54 /* OpenLDAP API Features */
  55 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
  56
  57 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  58         ( defined( LDAP_THREAD_SAFE ) && \
  59                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  60         /* -lldap may or may not be thread safe */
  61         /* -lldap_r, if available, is always thread safe */
  62 #       define  LDAP_API_FEATURE_THREAD_SAFE            1
  63 #       define  LDAP_API_FEATURE_SESSION_THREAD_SAFE    1
  64 #       define  LDAP_API_FEATURE_OPERATION_THREAD_SAFE  1
  65 #endif
  66 #if defined( LDAP_THREAD_SAFE ) && \
  67         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  68 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  69 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  70 #endif
  71
  72
  73 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
  74 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
  75
  76 #define LDAP_ROOT_DSE                           ""
  77 #define LDAP_NO_ATTRS                           "1.1"
  78 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  79 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
  80
  81 /* RFC 4511:  maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
  82 #define LDAP_MAXINT (2147483647)
  83
  84 /*
  85  * LDAP_OPTions
  86  *      0x0000 - 0x0fff reserved for api options
  87  *      0x1000 - 0x3fff reserved for api extended options
  88  *      0x4000 - 0x7fff reserved for private and experimental options
  89  */
  90
  91 #define LDAP_OPT_API_INFO                       0x0000
  92 #define LDAP_OPT_DESC                           0x0001 /* historic */
  93 #define LDAP_OPT_DEREF                          0x0002
  94 #define LDAP_OPT_SIZELIMIT                      0x0003
  95 #define LDAP_OPT_TIMELIMIT                      0x0004
  96 /* 0x05 - 0x07 not defined */
  97 #define LDAP_OPT_REFERRALS                      0x0008
  98 #define LDAP_OPT_RESTART                        0x0009
  99 /* 0x0a - 0x10 not defined */
 100 #define LDAP_OPT_PROTOCOL_VERSION               0x0011
 101 #define LDAP_OPT_SERVER_CONTROLS                0x0012
 102 #define LDAP_OPT_CLIENT_CONTROLS                0x0013
 103 /* 0x14 not defined */
 104 #define LDAP_OPT_API_FEATURE_INFO               0x0015
 105 /* 0x16 - 0x2f not defined */
 106 #define LDAP_OPT_HOST_NAME                      0x0030
 107 #define LDAP_OPT_RESULT_CODE                    0x0031
 108 #define LDAP_OPT_ERROR_NUMBER                   LDAP_OPT_RESULT_CODE
 109 #define LDAP_OPT_DIAGNOSTIC_MESSAGE             0x0032
 110 #define LDAP_OPT_ERROR_STRING                   LDAP_OPT_DIAGNOSTIC_MESSAGE
 111 #define LDAP_OPT_MATCHED_DN                     0x0033
 112 /* 0x0034 - 0x3fff not defined */
 113 /* 0x0091 used by Microsoft for LDAP_OPT_AUTO_RECONNECT */
 114 #define LDAP_OPT_SSPI_FLAGS                     0x0092
 115 /* 0x0093 used by Microsoft for LDAP_OPT_SSL_INFO */
 116 /* 0x0094 used by Microsoft for LDAP_OPT_REF_DEREF_CONN_PER_MSG */
 117 #define LDAP_OPT_SIGN                           0x0095
 118 #define LDAP_OPT_ENCRYPT                        0x0096
 119 #define LDAP_OPT_SASL_METHOD                    0x0097
 120 /* 0x0098 used by Microsoft for LDAP_OPT_AREC_EXCLUSIVE */
 121 #define LDAP_OPT_SECURITY_CONTEXT               0x0099
 122 /* 0x009A used by Microsoft for LDAP_OPT_ROOTDSE_CACHE */
 123 /* 0x009B - 0x3fff not defined */
 124
 125 /* API Extensions */
 126 #define LDAP_OPT_API_EXTENSION_BASE 0x4000  /* API extensions */
 127
 128 /* private and experimental options */
 129 /* OpenLDAP specific options */
 130 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
 131 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
 132 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
 133 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
 134 #define LDAP_OPT_URI                            0x5006
 135 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 136 #define LDAP_OPT_SOCKBUF            0x5008  /* sockbuf */
 137 #define LDAP_OPT_DEFBASE                0x5009  /* searchbase */
 138 #define LDAP_OPT_CONNECT_ASYNC          0x5010  /* create connections asynchronously */
 139 #define LDAP_OPT_CONNECT_CB                     0x5011  /* connection callbacks */
 140 #define LDAP_OPT_SESSION_REFCNT         0x5012  /* session reference count */
 141
 142 /* OpenLDAP TLS options */
 143 #define LDAP_OPT_X_TLS                          0x6000
 144 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* OpenSSL CTX* */
 145 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 146 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
 147 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
 148 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
 149 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
 150 #define LDAP_OPT_X_TLS_PROTOCOL_MIN     0x6007
 151 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 152 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 153 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a  /* OpenSSL SSL* */
 154 #define LDAP_OPT_X_TLS_CRLCHECK         0x600b
 155 #define LDAP_OPT_X_TLS_CONNECT_CB       0x600c
 156 #define LDAP_OPT_X_TLS_CONNECT_ARG      0x600d
 157 #define LDAP_OPT_X_TLS_DHFILE           0x600e
 158 #define LDAP_OPT_X_TLS_NEWCTX           0x600f
 159 #define LDAP_OPT_X_TLS_CRLFILE          0x6010  /* GNUtls only */
 160 #define LDAP_OPT_X_TLS_PACKAGE          0x6011
 161
 162 #define LDAP_OPT_X_TLS_NEVER    0
 163 #define LDAP_OPT_X_TLS_HARD             1
 164 #define LDAP_OPT_X_TLS_DEMAND   2
 165 #define LDAP_OPT_X_TLS_ALLOW    3
 166 #define LDAP_OPT_X_TLS_TRY              4
 167
 168 #define LDAP_OPT_X_TLS_CRL_NONE 0
 169 #define LDAP_OPT_X_TLS_CRL_PEER 1
 170 #define LDAP_OPT_X_TLS_CRL_ALL  2
 171
 172 /* for LDAP_OPT_X_TLS_PROTOCOL_MIN */
 173 #define LDAP_OPT_X_TLS_PROTOCOL(maj,min)        (((maj) << 8) + (min))
 174 #define LDAP_OPT_X_TLS_PROTOCOL_SSL2            (2 << 8)
 175 #define LDAP_OPT_X_TLS_PROTOCOL_SSL3            (3 << 8)
 176 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_0          ((3 << 8) + 1)
 177 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_1          ((3 << 8) + 2)
 178 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_2          ((3 << 8) + 3)
 179
 180 /* OpenLDAP SASL options */
 181 #define LDAP_OPT_X_SASL_MECH                    0x6100
 182 #define LDAP_OPT_X_SASL_REALM                   0x6101
 183 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 184 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 185 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 186 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 187 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 188 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 189 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 190 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 191 #define LDAP_OPT_X_SASL_MECHLIST                0x610a /* read-only */
 192 #define LDAP_OPT_X_SASL_NOCANON                 0x610b
 193 #define LDAP_OPT_X_SASL_USERNAME                0x610c /* read-only */
 194 #define LDAP_OPT_X_SASL_GSS_CREDS               0x610d
 195
 196 /* OpenLDAP GSSAPI options */
 197 #define LDAP_OPT_X_GSSAPI_DO_NOT_FREE_CONTEXT      0x6200
 198 #define LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL   0x6201
 199
 200 /*
 201  * OpenLDAP per connection tcp-keepalive settings
 202  * (Linux only, ignored where unsupported)
 203  */
 204 #define LDAP_OPT_X_KEEPALIVE_IDLE               0x6300
 205 #define LDAP_OPT_X_KEEPALIVE_PROBES             0x6301
 206 #define LDAP_OPT_X_KEEPALIVE_INTERVAL   0x6302
 207
 208 /* Private API Extensions -- reserved for application use */
 209 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000  /* Private API inclusive */
 210
 211 /*
 212  * ldap_get_option() and ldap_set_option() return values.
 213  * As later versions may return other values indicating
 214  * failure, current applications should only compare returned
 215  * value against LDAP_OPT_SUCCESS.
 216  */
 217 #define LDAP_OPT_SUCCESS        0
 218 #define LDAP_OPT_ERROR          (-1)
 219
 220 /* option on/off values */
 221 #define LDAP_OPT_ON             ((void *) &ber_pvt_opt_on)
 222 #define LDAP_OPT_OFF    ((void *) 0)
 223
 224 typedef struct ldapapiinfo {
 225         int             ldapai_info_version;            /* version of LDAPAPIInfo */
 226 #define LDAP_API_INFO_VERSION   (1)
 227         int             ldapai_api_version;                     /* revision of API supported */
 228         int             ldapai_protocol_version;        /* highest LDAP version supported */
 229         char    **ldapai_extensions;            /* names of API extensions */
 230         char    *ldapai_vendor_name;            /* name of supplier */
 231         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 232 } LDAPAPIInfo;
 233
 234 typedef struct ldap_apifeature_info {
 235         int             ldapaif_info_version;           /* version of LDAPAPIFeatureInfo */
 236 #define LDAP_FEATURE_INFO_VERSION (1)   /* apifeature_info struct version */
 237         char*   ldapaif_name;                           /* LDAP_API_FEATURE_* (less prefix) */
 238         int             ldapaif_version;                        /* value of LDAP_API_FEATURE_... */
 239 } LDAPAPIFeatureInfo;
 240
 241 /*
 242  * LDAP Control structure
 243  */
 244 typedef struct ldapcontrol {
 245         char *                  ldctl_oid;                      /* numericoid of control */
 246         struct berval   ldctl_value;            /* encoded value of control */
 247         char                    ldctl_iscritical;       /* criticality */
 248 } LDAPControl;
 249
 250 /* LDAP Controls */
 251 /*      standard track controls */
 252 #define LDAP_CONTROL_MANAGEDSAIT        "2.16.840.1.113730.3.4.2"  /* RFC 3296 */
 253 #define LDAP_CONTROL_PROXY_AUTHZ        "2.16.840.1.113730.3.4.18" /* RFC 4370 */
 254 #define LDAP_CONTROL_SUBENTRIES         "1.3.6.1.4.1.4203.1.10.1"  /* RFC 3672 */
 255
 256 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
 257
 258 #define LDAP_CONTROL_ASSERT                             "1.3.6.1.1.12"                  /* RFC 4528 */
 259 #define LDAP_CONTROL_PRE_READ                   "1.3.6.1.1.13.1"                /* RFC 4527 */
 260 #define LDAP_CONTROL_POST_READ                  "1.3.6.1.1.13.2"                /* RFC 4527 */
 261
 262 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473" /* RFC 2891 */
 263 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474" /* RFC 2891 */
 264
 265 /*      non-standard track controls */
 266 #define LDAP_CONTROL_PAGEDRESULTS       "1.2.840.113556.1.4.319"   /* RFC 2696 */
 267
 268 #define LDAP_CONTROL_AUTHZID_REQUEST    "2.16.840.1.113730.4.16"   /* RFC 3829 */
 269 #define LDAP_CONTROL_AUTHZID_RESPONSE   "2.16.840.1.113730.4.15"   /* RFC 3829 */
 270
 271 /* LDAP Content Synchronization Operation -- RFC 4533 */
 272 #define LDAP_SYNC_OID                   "1.3.6.1.4.1.4203.1.9.1"
 273 #define LDAP_CONTROL_SYNC               LDAP_SYNC_OID ".1"
 274 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
 275 #define LDAP_CONTROL_SYNC_DONE  LDAP_SYNC_OID ".3"
 276 #define LDAP_SYNC_INFO                  LDAP_SYNC_OID ".4"
 277
 278 #define LDAP_SYNC_NONE                                  0x00
 279 #define LDAP_SYNC_REFRESH_ONLY                  0x01
 280 #define LDAP_SYNC_RESERVED                              0x02
 281 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
 282
 283 #define LDAP_SYNC_REFRESH_PRESENTS              0
 284 #define LDAP_SYNC_REFRESH_DELETES               1
 285
 286 #define LDAP_TAG_SYNC_NEW_COOKIE                ((ber_tag_t) 0x80U)
 287 #define LDAP_TAG_SYNC_REFRESH_DELETE    ((ber_tag_t) 0xa1U)
 288 #define LDAP_TAG_SYNC_REFRESH_PRESENT   ((ber_tag_t) 0xa2U)
 289 #define LDAP_TAG_SYNC_ID_SET                    ((ber_tag_t) 0xa3U)
 290
 291 #define LDAP_TAG_SYNC_COOKIE                    ((ber_tag_t) 0x04U)
 292 #define LDAP_TAG_REFRESHDELETES                 ((ber_tag_t) 0x01U)
 293 #define LDAP_TAG_REFRESHDONE                    ((ber_tag_t) 0x01U)
 294 #define LDAP_TAG_RELOAD_HINT                    ((ber_tag_t) 0x01U)
 295
 296 #define LDAP_SYNC_PRESENT                               0
 297 #define LDAP_SYNC_ADD                                   1
 298 #define LDAP_SYNC_MODIFY                                2
 299 #define LDAP_SYNC_DELETE                                3
 300 #define LDAP_SYNC_NEW_COOKIE                    4
 301
 302 /* LDAP Don't Use Copy Control (RFC 6171) */
 303 #define LDAP_CONTROL_DONTUSECOPY                "1.3.6.1.1.22"
 304
 305 /* Password policy Controls *//* work in progress */
 306 /* ITS#3458: released; disabled by default */
 307 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST      "1.3.6.1.4.1.42.2.27.8.5.1"
 308 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE     "1.3.6.1.4.1.42.2.27.8.5.1"
 309
 310 /* various works in progress */
 311 #define LDAP_CONTROL_NOOP                               "1.3.6.1.4.1.4203.666.5.2"
 312 #define LDAP_CONTROL_NO_SUBORDINATES    "1.3.6.1.4.1.4203.666.5.11"
 313 #define LDAP_CONTROL_RELAX                              "1.3.6.1.4.1.4203.666.5.12"
 314 #define LDAP_CONTROL_MANAGEDIT                  LDAP_CONTROL_RELAX
 315 #define LDAP_CONTROL_SLURP                              "1.3.6.1.4.1.4203.666.5.13"
 316 #define LDAP_CONTROL_VALSORT                    "1.3.6.1.4.1.4203.666.5.14"
 317 #define LDAP_CONTROL_X_DEREF                    "1.3.6.1.4.1.4203.666.5.16"
 318 #define LDAP_CONTROL_X_WHATFAILED               "1.3.6.1.4.1.4203.666.5.17"
 319
 320 /* LDAP Chaining Behavior Control *//* work in progress */
 321 /* <draft-sermersheim-ldap-chaining>;
 322  * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
 323 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR        "1.3.6.1.4.1.4203.666.11.3"
 324
 325 #define LDAP_CHAINING_PREFERRED                         0
 326 #define LDAP_CHAINING_REQUIRED                          1
 327 #define LDAP_REFERRALS_PREFERRED                        2
 328 #define LDAP_REFERRALS_REQUIRED                         3
 329
 330 /* MS Active Directory controls (for compatibility) */
 331 #define LDAP_CONTROL_X_INCREMENTAL_VALUES       "1.2.840.113556.1.4.802"
 332 #define LDAP_CONTROL_X_DOMAIN_SCOPE                     "1.2.840.113556.1.4.1339"
 333 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY        "1.2.840.113556.1.4.1413"
 334 #define LDAP_CONTROL_X_SEARCH_OPTIONS           "1.2.840.113556.1.4.1340"
 335 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
 336 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
 337 #define LDAP_CONTROL_X_TREE_DELETE              "1.2.840.113556.1.4.805"
 338
 339 /* MS Active Directory controls - not implemented in slapd(8) */
 340 #define LDAP_CONTROL_X_EXTENDED_DN              "1.2.840.113556.1.4.529"
 341
 342 /* <draft-wahl-ldap-session> */
 343 #define LDAP_CONTROL_X_SESSION_TRACKING         "1.3.6.1.4.1.21008.108.63.1"
 344 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
 345                                                 LDAP_CONTROL_X_SESSION_TRACKING ".1"
 346 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
 347                                                 LDAP_CONTROL_X_SESSION_TRACKING ".2"
 348 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
 349                                                 LDAP_CONTROL_X_SESSION_TRACKING ".3"
 350 /* various expired works */
 351
 352 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
 353 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
 354 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
 355 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
 356 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
 357
 358 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
 359 #define LDAP_CONTROL_PERSIST_REQUEST                            "2.16.840.1.113730.3.4.3"
 360 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE        "2.16.840.1.113730.3.4.7"
 361 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD           0x1
 362 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE        0x2
 363 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY        0x4
 364 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME        0x8
 365
 366 /* LDAP VLV */
 367 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 368 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 369
 370 /* LDAP Unsolicited Notifications */
 371 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
 372 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 373
 374 /* LDAP Extended Operations */
 375 #define LDAP_EXOP_START_TLS             "1.3.6.1.4.1.1466.20037"        /* RFC 4511 */
 376
 377 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"       /* RFC 3062 */
 378 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 379 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 380 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 381 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 382
 383 #define LDAP_EXOP_CANCEL                "1.3.6.1.1.8"                                   /* RFC 3909 */
 384 #define LDAP_EXOP_X_CANCEL              LDAP_EXOP_CANCEL
 385
 386 #define LDAP_EXOP_REFRESH               "1.3.6.1.4.1.1466.101.119.1"    /* RFC 2589 */
 387 #define LDAP_TAG_EXOP_REFRESH_REQ_DN    ((ber_tag_t) 0x80U)
 388 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL   ((ber_tag_t) 0x81U)
 389 #define LDAP_TAG_EXOP_REFRESH_RES_TTL   ((ber_tag_t) 0x81U)
 390
 391 #define LDAP_EXOP_VERIFY_CREDENTIALS    "1.3.6.1.4.1.4203.666.6.5"
 392 #define LDAP_EXOP_X_VERIFY_CREDENTIALS  LDAP_EXOP_VERIFY_CREDENTIALS
 393
 394 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_COOKIE  ((ber_tag_t) 0x80U)
 395 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_SCREDS  ((ber_tag_t) 0x81U)
 396 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_CONTROLS ((ber_tag_t) 0xa2U) /* context specific + constructed + 2 */
 397
 398 #define LDAP_EXOP_WHO_AM_I              "1.3.6.1.4.1.4203.1.11.3"               /* RFC 4532 */
 399 #define LDAP_EXOP_X_WHO_AM_I    LDAP_EXOP_WHO_AM_I
 400
 401 /* various works in progress */
 402 #define LDAP_EXOP_TURN          "1.3.6.1.1.19"                          /* RFC 4531 */
 403 #define LDAP_EXOP_X_TURN        LDAP_EXOP_TURN
 404
 405 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
 406 /* a work in progress */
 407 #define LDAP_X_DISTPROC_BASE            "1.3.6.1.4.1.4203.666.11.6"
 408 #define LDAP_EXOP_X_CHAINEDREQUEST      LDAP_X_DISTPROC_BASE ".1"
 409 #define LDAP_FEATURE_X_CANCHAINOPS      LDAP_X_DISTPROC_BASE ".2"
 410 #define LDAP_CONTROL_X_RETURNCONTREF    LDAP_X_DISTPROC_BASE ".3"
 411 #define LDAP_URLEXT_X_LOCALREFOID       LDAP_X_DISTPROC_BASE ".4"
 412 #define LDAP_URLEXT_X_REFTYPEOID        LDAP_X_DISTPROC_BASE ".5"
 413 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
 414                                         LDAP_X_DISTPROC_BASE ".6"
 415 #define LDAP_URLEXT_X_FAILEDNAMEOID     LDAP_X_DISTPROC_BASE ".7"
 416 #define LDAP_URLEXT_X_LOCALREF          "x-localReference"
 417 #define LDAP_URLEXT_X_REFTYPE           "x-referenceType"
 418 #define LDAP_URLEXT_X_SEARCHEDSUBTREE   "x-searchedSubtree"
 419 #define LDAP_URLEXT_X_FAILEDNAME        "x-failedName"
 420
 421 #ifdef LDAP_DEVEL
 422 #define LDAP_X_TXN                                              "1.3.6.1.4.1.4203.666.11.7" /* tmp */
 423 #define LDAP_EXOP_X_TXN_START                   LDAP_X_TXN ".1"
 424 #define LDAP_CONTROL_X_TXN_SPEC                 LDAP_X_TXN ".2"
 425 #define LDAP_EXOP_X_TXN_END                             LDAP_X_TXN ".3"
 426 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE  LDAP_X_TXN ".4"
 427 #endif
 428
 429 /* LDAP Features */
 430 #define LDAP_FEATURE_ALL_OP_ATTRS       "1.3.6.1.4.1.4203.1.5.1"        /* RFC 3673 */
 431 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
 432         "1.3.6.1.4.1.4203.1.5.2" /*  @objectClass - new number to be assigned */
 433 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
 434 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
 435 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 436 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
 437
 438 /* LDAP Experimental (works in progress) Features */
 439 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
 440         "1.3.6.1.4.1.4203.666.8.1" /* "children" */
 441 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
 442
 443 /*
 444  * specific LDAP instantiations of BER types we know about
 445  */
 446
 447 /* Overview of LBER tag construction
 448  *
 449  *      Bits
 450  *      ______
 451  *      8 7 | CLASS
 452  *      0 0 = UNIVERSAL
 453  *      0 1 = APPLICATION
 454  *      1 0 = CONTEXT-SPECIFIC
 455  *      1 1 = PRIVATE
 456  *              _____
 457  *              | 6 | DATA-TYPE
 458  *                0 = PRIMITIVE
 459  *                1 = CONSTRUCTED
 460  *                      ___________
 461  *                      | 5 ... 1 | TAG-NUMBER
 462  */
 463
 464 /* general stuff */
 465 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 466 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 467
 468 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
 469 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
 470
 471 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 472 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 473
 474 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 475
 476 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 477 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 478 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 479 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 480
 481 #define LDAP_TAG_IM_RES_OID   ((ber_tag_t) 0x80U)       /* context specific + primitive */
 482 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U)       /* context specific + primitive */
 483
 484 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 485
 486 /* LDAP Request Messages */
 487 #define LDAP_REQ_BIND           ((ber_tag_t) 0x60U)     /* application + constructed */
 488 #define LDAP_REQ_UNBIND         ((ber_tag_t) 0x42U)     /* application + primitive   */
 489 #define LDAP_REQ_SEARCH         ((ber_tag_t) 0x63U)     /* application + constructed */
 490 #define LDAP_REQ_MODIFY         ((ber_tag_t) 0x66U)     /* application + constructed */
 491 #define LDAP_REQ_ADD            ((ber_tag_t) 0x68U)     /* application + constructed */
 492 #define LDAP_REQ_DELETE         ((ber_tag_t) 0x4aU)     /* application + primitive   */
 493 #define LDAP_REQ_MODDN          ((ber_tag_t) 0x6cU)     /* application + constructed */
 494 #define LDAP_REQ_MODRDN         LDAP_REQ_MODDN
 495 #define LDAP_REQ_RENAME         LDAP_REQ_MODDN
 496 #define LDAP_REQ_COMPARE        ((ber_tag_t) 0x6eU)     /* application + constructed */
 497 #define LDAP_REQ_ABANDON        ((ber_tag_t) 0x50U)     /* application + primitive   */
 498 #define LDAP_REQ_EXTENDED       ((ber_tag_t) 0x77U)     /* application + constructed */
 499
 500 /* LDAP Response Messages */
 501 #define LDAP_RES_BIND           ((ber_tag_t) 0x61U)     /* application + constructed */
 502 #define LDAP_RES_SEARCH_ENTRY   ((ber_tag_t) 0x64U)     /* application + constructed */
 503 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 504 #define LDAP_RES_SEARCH_RESULT  ((ber_tag_t) 0x65U)     /* application + constructed */
 505 #define LDAP_RES_MODIFY         ((ber_tag_t) 0x67U)     /* application + constructed */
 506 #define LDAP_RES_ADD            ((ber_tag_t) 0x69U)     /* application + constructed */
 507 #define LDAP_RES_DELETE         ((ber_tag_t) 0x6bU)     /* application + constructed */
 508 #define LDAP_RES_MODDN          ((ber_tag_t) 0x6dU)     /* application + constructed */
 509 #define LDAP_RES_MODRDN         LDAP_RES_MODDN  /* application + constructed */
 510 #define LDAP_RES_RENAME         LDAP_RES_MODDN  /* application + constructed */
 511 #define LDAP_RES_COMPARE        ((ber_tag_t) 0x6fU)     /* application + constructed */
 512 #define LDAP_RES_EXTENDED       ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 513 #define LDAP_RES_INTERMEDIATE   ((ber_tag_t) 0x79U) /* V3+: application + constructed */
 514
 515 #define LDAP_RES_ANY                    (-1)
 516 #define LDAP_RES_UNSOLICITED    (0)
 517
 518
 519 /* sasl methods */
 520 #define LDAP_SASL_SIMPLE        ((char*)0)
 521 #define LDAP_SASL_NULL          ("")
 522
 523
 524 /* authentication methods available */
 525 #define LDAP_AUTH_NONE   ((ber_tag_t) 0x00U) /* no authentication */
 526 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
 527 #define LDAP_AUTH_SASL   ((ber_tag_t) 0xa3U) /* context specific + constructed */
 528 #define LDAP_AUTH_KRBV4  ((ber_tag_t) 0xffU) /* means do both of the following */
 529 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
 530 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
 531
 532 /* used by the Windows API but not used on the wire */
 533 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
 534
 535 /* filter types */
 536 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 537 #define LDAP_FILTER_OR  ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 538 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 539 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
 540 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
 541 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
 542 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
 543 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive   */
 544 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U)  /* context specific + constructed */
 545 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 546
 547 /* extended filter component types */
 548 #define LDAP_FILTER_EXT_OID             ((ber_tag_t) 0x81U)     /* context specific */
 549 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 550 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 551 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 552
 553 /* substring filter component types */
 554 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 555 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 556 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 557
 558 /* search scopes */
 559 #define LDAP_SCOPE_BASE                 ((ber_int_t) 0x0000)
 560 #define LDAP_SCOPE_BASEOBJECT   LDAP_SCOPE_BASE
 561 #define LDAP_SCOPE_ONELEVEL             ((ber_int_t) 0x0001)
 562 #define LDAP_SCOPE_ONE                  LDAP_SCOPE_ONELEVEL
 563 #define LDAP_SCOPE_SUBTREE              ((ber_int_t) 0x0002)
 564 #define LDAP_SCOPE_SUB                  LDAP_SCOPE_SUBTREE
 565 #define LDAP_SCOPE_SUBORDINATE  ((ber_int_t) 0x0003) /* OpenLDAP extension */
 566 #define LDAP_SCOPE_CHILDREN             LDAP_SCOPE_SUBORDINATE
 567 #define LDAP_SCOPE_DEFAULT              ((ber_int_t) -1)         /* OpenLDAP extension */
 568
 569 /* substring filter component types */
 570 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 571 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 572 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 573
 574 /*
 575  * LDAP Result Codes
 576  */
 577 #define LDAP_SUCCESS                            0x00
 578
 579 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 580
 581 #define LDAP_OPERATIONS_ERROR           0x01
 582 #define LDAP_PROTOCOL_ERROR                     0x02
 583 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 584 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 585 #define LDAP_COMPARE_FALSE                      0x05
 586 #define LDAP_COMPARE_TRUE                       0x06
 587 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 588 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 589 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 590 #define LDAP_STRONGER_AUTH_REQUIRED     LDAP_STRONG_AUTH_REQUIRED
 591 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
 592
 593 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 594 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 595 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 596 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 597 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 598
 599 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 600
 601 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 602 #define LDAP_UNDEFINED_TYPE                     0x11
 603 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 604 #define LDAP_CONSTRAINT_VIOLATION       0x13
 605 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 606 #define LDAP_INVALID_SYNTAX                     0x15
 607
 608 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 609
 610 #define LDAP_NO_SUCH_OBJECT                     0x20
 611 #define LDAP_ALIAS_PROBLEM                      0x21
 612 #define LDAP_INVALID_DN_SYNTAX          0x22
 613 #define LDAP_IS_LEAF                            0x23 /* not LDAPv3 */
 614 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 615
 616 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
 617
 618 #define LDAP_X_PROXY_AUTHZ_FAILURE      0x2F /* LDAPv3 proxy authorization */
 619 #define LDAP_INAPPROPRIATE_AUTH         0x30
 620 #define LDAP_INVALID_CREDENTIALS        0x31
 621 #define LDAP_INSUFFICIENT_ACCESS        0x32
 622
 623 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 624
 625 #define LDAP_BUSY                                       0x33
 626 #define LDAP_UNAVAILABLE                        0x34
 627 #define LDAP_UNWILLING_TO_PERFORM       0x35
 628 #define LDAP_LOOP_DETECT                        0x36
 629
 630 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 631
 632 #define LDAP_NAMING_VIOLATION           0x40
 633 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 634 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 635 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 636 #define LDAP_ALREADY_EXISTS                     0x44
 637 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 638 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 639 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47
 640
 641 #define LDAP_VLV_ERROR                          0x4C
 642
 643 #define LDAP_OTHER                                      0x50
 644
 645 /* LCUP operation codes (113-117) - not implemented */
 646 #define LDAP_CUP_RESOURCES_EXHAUSTED    0x71
 647 #define LDAP_CUP_SECURITY_VIOLATION             0x72
 648 #define LDAP_CUP_INVALID_DATA                   0x73
 649 #define LDAP_CUP_UNSUPPORTED_SCHEME             0x74
 650 #define LDAP_CUP_RELOAD_REQUIRED                0x75
 651
 652 /* Cancel operation codes (118-121) */
 653 #define LDAP_CANCELLED                          0x76
 654 #define LDAP_NO_SUCH_OPERATION          0x77
 655 #define LDAP_TOO_LATE                           0x78
 656 #define LDAP_CANNOT_CANCEL                      0x79
 657
 658 /* Assertion control (122) */
 659 #define LDAP_ASSERTION_FAILED           0x7A
 660
 661 /* Proxied Authorization Denied (123) */
 662 #define LDAP_PROXIED_AUTHORIZATION_DENIED               0x7B
 663
 664 /* Experimental result codes */
 665 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
 666
 667 /* LDAP Sync (4096) */
 668 #define LDAP_SYNC_REFRESH_REQUIRED              0x1000
 669
 670
 671 /* Private Use result codes */
 672 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
 673
 674 #define LDAP_X_SYNC_REFRESH_REQUIRED    0x4100 /* defunct */
 675 #define LDAP_X_ASSERTION_FAILED                 0x410f /* defunct */
 676
 677 /* for the LDAP No-Op control */
 678 #define LDAP_X_NO_OPERATION                             0x410e
 679
 680 /* for the Chaining Behavior control (consecutive result codes requested;
 681  * see <draft-sermersheim-ldap-chaining> ) */
 682 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
 683 #define LDAP_X_NO_REFERRALS_FOUND               0x4110
 684 #define LDAP_X_CANNOT_CHAIN                     0x4111
 685 #endif
 686
 687 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
 688 #ifdef LDAP_X_DISTPROC_BASE
 689 #define LDAP_X_INVALIDREFERENCE                 0x4112
 690 #endif
 691
 692 #ifdef LDAP_X_TXN
 693 #define LDAP_X_TXN_SPECIFY_OKAY         0x4120
 694 #define LDAP_X_TXN_ID_INVALID           0x4121
 695 #endif
 696
 697 /* API Error Codes
 698  *
 699  * Based on draft-ietf-ldap-c-api-xx
 700  * but with new negative code values
 701  */
 702 #define LDAP_API_ERROR(n)               ((n)<0)
 703 #define LDAP_API_RESULT(n)              ((n)<=0)
 704
 705 #define LDAP_SERVER_DOWN                                (-1)
 706 #define LDAP_LOCAL_ERROR                                (-2)
 707 #define LDAP_ENCODING_ERROR                             (-3)
 708 #define LDAP_DECODING_ERROR                             (-4)
 709 #define LDAP_TIMEOUT                                    (-5)
 710 #define LDAP_AUTH_UNKNOWN                               (-6)
 711 #define LDAP_FILTER_ERROR                               (-7)
 712 #define LDAP_USER_CANCELLED                             (-8)
 713 #define LDAP_PARAM_ERROR                                (-9)
 714 #define LDAP_NO_MEMORY                                  (-10)
 715 #define LDAP_CONNECT_ERROR                              (-11)
 716 #define LDAP_NOT_SUPPORTED                              (-12)
 717 #define LDAP_CONTROL_NOT_FOUND                  (-13)
 718 #define LDAP_NO_RESULTS_RETURNED                (-14)
 719 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)   /* Obsolete */
 720 #define LDAP_CLIENT_LOOP                                (-16)
 721 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
 722 #define LDAP_X_CONNECTING                       (-18)
 723
 724
 725 /*
 726  * This structure represents both ldap messages and ldap responses.
 727  * These are really the same, except in the case of search responses,
 728  * where a response has multiple messages.
 729  */
 730
 731 typedef struct ldapmsg LDAPMessage;
 732
 733 /* for modifications */
 734 typedef struct ldapmod {
 735         int             mod_op;
 736
 737 #define LDAP_MOD_OP                     (0x0007)
 738 #define LDAP_MOD_ADD            (0x0000)
 739 #define LDAP_MOD_DELETE         (0x0001)
 740 #define LDAP_MOD_REPLACE        (0x0002)
 741 #define LDAP_MOD_INCREMENT      (0x0003) /* OpenLDAP extension */
 742 #define LDAP_MOD_BVALUES        (0x0080)
 743 /* IMPORTANT: do not use code 0x1000 (or above),
 744  * it is used internally by the backends!
 745  * (see ldap/servers/slapd/slap.h)
 746  */
 747
 748         char            *mod_type;
 749         union mod_vals_u {
 750                 char            **modv_strvals;
 751                 struct berval   **modv_bvals;
 752         } mod_vals;
 753 #define mod_values      mod_vals.modv_strvals
 754 #define mod_bvalues     mod_vals.modv_bvals
 755 } LDAPMod;
 756
 757 /*
 758  * structure representing an ldap session which can
 759  * encompass connections to multiple servers (in the
 760  * face of referrals).
 761  */
 762 typedef struct ldap LDAP;
 763
 764 #define LDAP_DEREF_NEVER                0x00
 765 #define LDAP_DEREF_SEARCHING    0x01
 766 #define LDAP_DEREF_FINDING              0x02
 767 #define LDAP_DEREF_ALWAYS               0x03
 768
 769 #define LDAP_NO_LIMIT                   0
 770
 771 /* how many messages to retrieve results for */
 772 #define LDAP_MSG_ONE                    0x00
 773 #define LDAP_MSG_ALL                    0x01
 774 #define LDAP_MSG_RECEIVED               0x02
 775
 776 /*
 777  * types for ldap URL handling
 778  */
 779 typedef struct ldap_url_desc {
 780         struct ldap_url_desc *lud_next;
 781         char    *lud_scheme;
 782         char    *lud_host;
 783         int             lud_port;
 784         char    *lud_dn;
 785         char    **lud_attrs;
 786         int             lud_scope;
 787         char    *lud_filter;
 788         char    **lud_exts;
 789         int             lud_crit_exts;
 790 } LDAPURLDesc;
 791
 792 #define LDAP_URL_SUCCESS                0x00    /* Success */
 793 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 794 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 795
 796 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 797 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 798 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 799 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 800 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 801 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 802 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 803 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 804
 805 /*
 806  * LDAP sync (RFC4533) API
 807  */
 808
 809 typedef struct ldap_sync_t ldap_sync_t;
 810
 811 typedef enum {
 812         /* these are private - the client should never see them */
 813         LDAP_SYNC_CAPI_NONE             = -1,
 814
 815         LDAP_SYNC_CAPI_PHASE_FLAG       = 0x10U,
 816         LDAP_SYNC_CAPI_IDSET_FLAG       = 0x20U,
 817         LDAP_SYNC_CAPI_DONE_FLAG        = 0x40U,
 818
 819         /* these are passed to ls_search_entry() */
 820         LDAP_SYNC_CAPI_PRESENT          = LDAP_SYNC_PRESENT,
 821         LDAP_SYNC_CAPI_ADD              = LDAP_SYNC_ADD,
 822         LDAP_SYNC_CAPI_MODIFY           = LDAP_SYNC_MODIFY,
 823         LDAP_SYNC_CAPI_DELETE           = LDAP_SYNC_DELETE,
 824
 825         /* these are passed to ls_intermediate() */
 826         LDAP_SYNC_CAPI_PRESENTS         = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
 827         LDAP_SYNC_CAPI_DELETES          = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
 828
 829         LDAP_SYNC_CAPI_PRESENTS_IDSET   = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
 830         LDAP_SYNC_CAPI_DELETES_IDSET    = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
 831
 832         LDAP_SYNC_CAPI_DONE             = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
 833 } ldap_sync_refresh_t;
 834
 835 /*
 836  * Called when an entry is returned by ldap_result().
 837  * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
 838  * the entry has been either added or modified, and thus
 839  * the complete view of the entry should be in the LDAPMessage.
 840  * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
 841  * only the DN should be in the LDAPMessage.
 842  */
 843 typedef int (*ldap_sync_search_entry_f) LDAP_P((
 844         ldap_sync_t                     *ls,
 845         LDAPMessage                     *msg,
 846         struct berval                   *entryUUID,
 847         ldap_sync_refresh_t             phase ));
 848
 849 /*
 850  * Called when a reference is returned; the client should know
 851  * what to do with it.
 852  */
 853 typedef int (*ldap_sync_search_reference_f) LDAP_P((
 854         ldap_sync_t                     *ls,
 855         LDAPMessage                     *msg ));
 856
 857 /*
 858  * Called when specific intermediate/final messages are returned.
 859  * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
 860  * a "presents" or "deletes" phase begins.
 861  * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
 862  * with refreshDone set to "TRUE" has been returned, to indicate
 863  * that the refresh phase of a refreshAndPersist is complete.
 864  * In the above cases, syncUUIDs is NULL.
 865  *
 866  * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
 867  * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
 868  * that are either present or have been deleted.
 869  */
 870 typedef int (*ldap_sync_intermediate_f) LDAP_P((
 871         ldap_sync_t                     *ls,
 872         LDAPMessage                     *msg,
 873         BerVarray                       syncUUIDs,
 874         ldap_sync_refresh_t             phase ));
 875
 876 /*
 877  * Called when a searchResultDone is returned.  In refreshAndPersist,
 878  * this can only occur if the search for any reason is being terminated
 879  * by the server.
 880  */
 881 typedef int (*ldap_sync_search_result_f) LDAP_P((
 882         ldap_sync_t                     *ls,
 883         LDAPMessage                     *msg,
 884         int                             refreshDeletes ));
 885
 886 /*
 887  * This structure contains all information about the persistent search;
 888  * the caller is responsible for connecting, setting version, binding, tls...
 889  */
 890 struct ldap_sync_t {
 891         /* conf search params */
 892         char                            *ls_base;
 893         int                             ls_scope;
 894         char                            *ls_filter;
 895         char                            **ls_attrs;
 896         int                             ls_timelimit;
 897         int                             ls_sizelimit;
 898
 899         /* poll timeout */
 900         int                             ls_timeout;
 901
 902         /* helpers - add as appropriate */
 903         ldap_sync_search_entry_f        ls_search_entry;
 904         ldap_sync_search_reference_f    ls_search_reference;
 905         ldap_sync_intermediate_f        ls_intermediate;
 906         ldap_sync_search_result_f       ls_search_result;
 907
 908         /* set by the caller as appropriate */
 909         void                            *ls_private;
 910
 911         /* conn stuff */
 912         LDAP                            *ls_ld;
 913
 914         /* --- the parameters below are private - do not modify --- */
 915
 916         /* FIXME: make the structure opaque, and provide an interface
 917          * to modify the public values? */
 918
 919         /* result stuff */
 920         int                             ls_msgid;
 921
 922         /* sync stuff */
 923         /* needed by refreshOnly */
 924         int                             ls_reloadHint;
 925
 926         /* opaque - need to pass between sessions, updated by the API */
 927         struct berval                   ls_cookie;
 928
 929         /* state variable - do not modify */
 930         ldap_sync_refresh_t             ls_refreshPhase;
 931 };
 932
 933 /*
 934  * End of LDAP sync (RFC4533) API
 935  */
 936
 937 /*
 938  * Connection callbacks...
 939  */
 940 struct ldap_conncb;
 941 struct sockaddr;
 942
 943 /* Called after a connection is established */
 944 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
 945         struct ldap_conncb *ctx ));
 946 /* Called before a connection is closed */
 947 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
 948
 949 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
 950  * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
 951  */
 952 typedef struct ldap_conncb {
 953         ldap_conn_add_f *lc_add;
 954         ldap_conn_del_f *lc_del;
 955         void *lc_arg;
 956 } ldap_conncb;
 957
 958 /*
 959  * The API draft spec says we should declare (or cause to be declared)
 960  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 961  */
 962 struct timeval;
 963
 964 /*
 965  * in options.c:
 966  */
 967 LDAP_F( int )
 968 ldap_get_option LDAP_P((
 969         LDAP *ld,
 970         int option,
 971         void *outvalue));
 972
 973 LDAP_F( int )
 974 ldap_set_option LDAP_P((
 975         LDAP *ld,
 976         int option,
 977         LDAP_CONST void *invalue));
 978
 979 /* V3 REBIND Function Callback Prototype */
 980 typedef int (LDAP_REBIND_PROC) LDAP_P((
 981         LDAP *ld, LDAP_CONST char *url,
 982         ber_tag_t request, ber_int_t msgid,
 983         void *params ));
 984
 985 LDAP_F( int )
 986 ldap_set_rebind_proc LDAP_P((
 987         LDAP *ld,
 988         LDAP_REBIND_PROC *rebind_proc,
 989         void *params ));
 990
 991 /* V3 referral selection Function Callback Prototype */
 992 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
 993         LDAP *ld, char ***refsp, int *cntp,
 994         void *params ));
 995
 996 LDAP_F( int )
 997 ldap_set_nextref_proc LDAP_P((
 998         LDAP *ld,
 999         LDAP_NEXTREF_PROC *nextref_proc,
1000         void *params ));
1001
1002 /* V3 URLLIST Function Callback Prototype */
1003 typedef int (LDAP_URLLIST_PROC) LDAP_P((
1004         LDAP *ld,
1005         LDAPURLDesc **urllist,
1006         LDAPURLDesc **url,
1007         void *params ));
1008
1009 LDAP_F( int )
1010 ldap_set_urllist_proc LDAP_P((
1011         LDAP *ld,
1012         LDAP_URLLIST_PROC *urllist_proc,
1013         void *params ));
1014
1015 /*
1016  * in controls.c:
1017  */
1018 #if LDAP_DEPRECATED
1019 LDAP_F( int )
1020 ldap_create_control LDAP_P((    /* deprecated, use ldap_control_create */
1021         LDAP_CONST char *requestOID,
1022         BerElement *ber,
1023         int iscritical,
1024         LDAPControl **ctrlp ));
1025
1026 LDAP_F( LDAPControl * )
1027 ldap_find_control LDAP_P((      /* deprecated, use ldap_control_find */
1028         LDAP_CONST char *oid,
1029         LDAPControl **ctrls ));
1030 #endif
1031
1032 LDAP_F( int )
1033 ldap_control_create LDAP_P((
1034         LDAP_CONST char *requestOID,
1035         int iscritical,
1036         struct berval *value,
1037         int dupval,
1038         LDAPControl **ctrlp ));
1039
1040 LDAP_F( LDAPControl * )
1041 ldap_control_find LDAP_P((
1042         LDAP_CONST char *oid,
1043         LDAPControl **ctrls,
1044         LDAPControl ***nextctrlp ));
1045
1046 LDAP_F( void )
1047 ldap_control_free LDAP_P((
1048         LDAPControl *ctrl ));
1049
1050 LDAP_F( void )
1051 ldap_controls_free LDAP_P((
1052         LDAPControl **ctrls ));
1053
1054 LDAP_F( LDAPControl ** )
1055 ldap_controls_dup LDAP_P((
1056         LDAPControl *LDAP_CONST *controls ));
1057
1058 LDAP_F( LDAPControl * )
1059 ldap_control_dup LDAP_P((
1060         LDAP_CONST LDAPControl *c ));
1061
1062 /*
1063  * in dnssrv.c:
1064  */
1065 LDAP_F( int )
1066 ldap_domain2dn LDAP_P((
1067         LDAP_CONST char* domain,
1068         char** dn ));
1069
1070 LDAP_F( int )
1071 ldap_dn2domain LDAP_P((
1072         LDAP_CONST char* dn,
1073         char** domain ));
1074
1075 LDAP_F( int )
1076 ldap_domain2hostlist LDAP_P((
1077         LDAP_CONST char *domain,
1078         char** hostlist ));
1079
1080 /*
1081  * in extended.c:
1082  */
1083 LDAP_F( int )
1084 ldap_extended_operation LDAP_P((
1085         LDAP                    *ld,
1086         LDAP_CONST char *reqoid,
1087         struct berval   *reqdata,
1088         LDAPControl             **serverctrls,
1089         LDAPControl             **clientctrls,
1090         int                             *msgidp ));
1091
1092 LDAP_F( int )
1093 ldap_extended_operation_s LDAP_P((
1094         LDAP                    *ld,
1095         LDAP_CONST char *reqoid,
1096         struct berval   *reqdata,
1097         LDAPControl             **serverctrls,
1098         LDAPControl             **clientctrls,
1099         char                    **retoidp,
1100         struct berval   **retdatap ));
1101
1102 LDAP_F( int )
1103 ldap_parse_extended_result LDAP_P((
1104         LDAP                    *ld,
1105         LDAPMessage             *res,
1106         char                    **retoidp,
1107         struct berval   **retdatap,
1108         int                             freeit ));
1109
1110 LDAP_F( int )
1111 ldap_parse_intermediate LDAP_P((
1112         LDAP                    *ld,
1113         LDAPMessage             *res,
1114         char                    **retoidp,
1115         struct berval   **retdatap,
1116         LDAPControl             ***serverctrls,
1117         int                             freeit ));
1118
1119
1120 /*
1121  * in abandon.c:
1122  */
1123 LDAP_F( int )
1124 ldap_abandon_ext LDAP_P((
1125         LDAP                    *ld,
1126         int                             msgid,
1127         LDAPControl             **serverctrls,
1128         LDAPControl             **clientctrls ));
1129
1130 #if LDAP_DEPRECATED
1131 LDAP_F( int )
1132 ldap_abandon LDAP_P((   /* deprecated, use ldap_abandon_ext */
1133         LDAP *ld,
1134         int msgid ));
1135 #endif
1136
1137 /*
1138  * in add.c:
1139  */
1140 LDAP_F( int )
1141 ldap_add_ext LDAP_P((
1142         LDAP                    *ld,
1143         LDAP_CONST char *dn,
1144         LDAPMod                 **attrs,
1145         LDAPControl             **serverctrls,
1146         LDAPControl             **clientctrls,
1147         int                     *msgidp ));
1148
1149 LDAP_F( int )
1150 ldap_add_ext_s LDAP_P((
1151         LDAP                    *ld,
1152         LDAP_CONST char *dn,
1153         LDAPMod                 **attrs,
1154         LDAPControl             **serverctrls,
1155         LDAPControl             **clientctrls ));
1156
1157 #if LDAP_DEPRECATED
1158 LDAP_F( int )
1159 ldap_add LDAP_P((       /* deprecated, use ldap_add_ext */
1160         LDAP *ld,
1161         LDAP_CONST char *dn,
1162         LDAPMod **attrs ));
1163
1164 LDAP_F( int )
1165 ldap_add_s LDAP_P((     /* deprecated, use ldap_add_ext_s */
1166         LDAP *ld,
1167         LDAP_CONST char *dn,
1168         LDAPMod **attrs ));
1169 #endif
1170
1171
1172 /*
1173  * in sasl.c:
1174  */
1175 LDAP_F( int )
1176 ldap_sasl_bind LDAP_P((
1177         LDAP                    *ld,
1178         LDAP_CONST char *dn,
1179         LDAP_CONST char *mechanism,
1180         struct berval   *cred,
1181         LDAPControl             **serverctrls,
1182         LDAPControl             **clientctrls,
1183         int                             *msgidp ));
1184
1185 /* Interaction flags (should be passed about in a control)
1186  *  Automatic (default): use defaults, prompt otherwise
1187  *  Interactive: prompt always
1188  *  Quiet: never prompt
1189  */
1190 #define LDAP_SASL_AUTOMATIC             0U
1191 #define LDAP_SASL_INTERACTIVE   1U
1192 #define LDAP_SASL_QUIET                 2U
1193
1194 /*
1195  * V3 SASL Interaction Function Callback Prototype
1196  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
1197  *  should likely passed in a control (and provided controls)
1198  */
1199 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1200         LDAP *ld, unsigned flags, void* defaults, void *interact ));
1201
1202 LDAP_F( int )
1203 ldap_sasl_interactive_bind LDAP_P((
1204         LDAP *ld,
1205         LDAP_CONST char *dn, /* usually NULL */
1206         LDAP_CONST char *saslMechanism,
1207         LDAPControl **serverControls,
1208         LDAPControl **clientControls,
1209
1210         /* should be client controls */
1211         unsigned flags,
1212         LDAP_SASL_INTERACT_PROC *proc,
1213         void *defaults,
1214
1215         /* as obtained from ldap_result() */
1216         LDAPMessage *result,
1217
1218         /* returned during bind processing */
1219         const char **rmech,
1220         int *msgid ));
1221
1222 LDAP_F( int )
1223 ldap_sasl_interactive_bind_s LDAP_P((
1224         LDAP *ld,
1225         LDAP_CONST char *dn, /* usually NULL */
1226         LDAP_CONST char *saslMechanism,
1227         LDAPControl **serverControls,
1228         LDAPControl **clientControls,
1229
1230         /* should be client controls */
1231         unsigned flags,
1232         LDAP_SASL_INTERACT_PROC *proc,
1233         void *defaults ));
1234
1235 LDAP_F( int )
1236 ldap_sasl_bind_s LDAP_P((
1237         LDAP                    *ld,
1238         LDAP_CONST char *dn,
1239         LDAP_CONST char *mechanism,
1240         struct berval   *cred,
1241         LDAPControl             **serverctrls,
1242         LDAPControl             **clientctrls,
1243         struct berval   **servercredp ));
1244
1245 LDAP_F( int )
1246 ldap_parse_sasl_bind_result LDAP_P((
1247         LDAP                    *ld,
1248         LDAPMessage             *res,
1249         struct berval   **servercredp,
1250         int                             freeit ));
1251
1252 #if LDAP_DEPRECATED
1253 /*
1254  * in bind.c:
1255  *      (deprecated)
1256  */
1257 LDAP_F( int )
1258 ldap_bind LDAP_P((      /* deprecated, use ldap_sasl_bind */
1259         LDAP *ld,
1260         LDAP_CONST char *who,
1261         LDAP_CONST char *passwd,
1262         int authmethod ));
1263
1264 LDAP_F( int )
1265 ldap_bind_s LDAP_P((    /* deprecated, use ldap_sasl_bind_s */
1266         LDAP *ld,
1267         LDAP_CONST char *who,
1268         LDAP_CONST char *cred,
1269         int authmethod ));
1270
1271 /*
1272  * in sbind.c:
1273  */
1274 LDAP_F( int )
1275 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1276         LDAP *ld,
1277         LDAP_CONST char *who,
1278         LDAP_CONST char *passwd ));
1279
1280 LDAP_F( int )
1281 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1282         LDAP *ld,
1283         LDAP_CONST char *who,
1284         LDAP_CONST char *passwd ));
1285
1286 #endif
1287
1288
1289 /*
1290  * in compare.c:
1291  */
1292 LDAP_F( int )
1293 ldap_compare_ext LDAP_P((
1294         LDAP                    *ld,
1295         LDAP_CONST char *dn,
1296         LDAP_CONST char *attr,
1297         struct berval   *bvalue,
1298         LDAPControl             **serverctrls,
1299         LDAPControl             **clientctrls,
1300         int                     *msgidp ));
1301
1302 LDAP_F( int )
1303 ldap_compare_ext_s LDAP_P((
1304         LDAP                    *ld,
1305         LDAP_CONST char *dn,
1306         LDAP_CONST char *attr,
1307         struct berval   *bvalue,
1308         LDAPControl             **serverctrls,
1309         LDAPControl             **clientctrls ));
1310
1311 #if LDAP_DEPRECATED
1312 LDAP_F( int )
1313 ldap_compare LDAP_P((   /* deprecated, use ldap_compare_ext */
1314         LDAP *ld,
1315         LDAP_CONST char *dn,
1316         LDAP_CONST char *attr,
1317         LDAP_CONST char *value ));
1318
1319 LDAP_F( int )
1320 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1321         LDAP *ld,
1322         LDAP_CONST char *dn,
1323         LDAP_CONST char *attr,
1324         LDAP_CONST char *value ));
1325 #endif
1326
1327
1328 /*
1329  * in delete.c:
1330  */
1331 LDAP_F( int )
1332 ldap_delete_ext LDAP_P((
1333         LDAP                    *ld,
1334         LDAP_CONST char *dn,
1335         LDAPControl             **serverctrls,
1336         LDAPControl             **clientctrls,
1337         int                     *msgidp ));
1338
1339 LDAP_F( int )
1340 ldap_delete_ext_s LDAP_P((
1341         LDAP                    *ld,
1342         LDAP_CONST char *dn,
1343         LDAPControl             **serverctrls,
1344         LDAPControl             **clientctrls ));
1345
1346 #if LDAP_DEPRECATED
1347 LDAP_F( int )
1348 ldap_delete LDAP_P((    /* deprecated, use ldap_delete_ext */
1349         LDAP *ld,
1350         LDAP_CONST char *dn ));
1351
1352 LDAP_F( int )
1353 ldap_delete_s LDAP_P((  /* deprecated, use ldap_delete_ext_s */
1354         LDAP *ld,
1355         LDAP_CONST char *dn ));
1356 #endif
1357
1358
1359 /*
1360  * in error.c:
1361  */
1362 LDAP_F( int )
1363 ldap_parse_result LDAP_P((
1364         LDAP                    *ld,
1365         LDAPMessage             *res,
1366         int                             *errcodep,
1367         char                    **matcheddnp,
1368         char                    **diagmsgp,
1369         char                    ***referralsp,
1370         LDAPControl             ***serverctrls,
1371         int                             freeit ));
1372
1373 LDAP_F( char * )
1374 ldap_err2string LDAP_P((
1375         int err ));
1376
1377 #if LDAP_DEPRECATED
1378 LDAP_F( int )
1379 ldap_result2error LDAP_P((      /* deprecated, use ldap_parse_result */
1380         LDAP *ld,
1381         LDAPMessage *r,
1382         int freeit ));
1383
1384 LDAP_F( void )
1385 ldap_perror LDAP_P((    /* deprecated, use ldap_err2string */
1386         LDAP *ld,
1387         LDAP_CONST char *s ));
1388 #endif
1389
1390
1391 /*
1392  * gssapi.c:
1393  */
1394 LDAP_F( int )
1395 ldap_gssapi_bind LDAP_P((
1396         LDAP *ld,
1397         LDAP_CONST char *dn,
1398         LDAP_CONST char *creds ));
1399
1400 LDAP_F( int )
1401 ldap_gssapi_bind_s LDAP_P((
1402         LDAP *ld,
1403         LDAP_CONST char *dn,
1404         LDAP_CONST char *creds ));
1405
1406
1407 /*
1408  * in modify.c:
1409  */
1410 LDAP_F( int )
1411 ldap_modify_ext LDAP_P((
1412         LDAP                    *ld,
1413         LDAP_CONST char *dn,
1414         LDAPMod                 **mods,
1415         LDAPControl             **serverctrls,
1416         LDAPControl             **clientctrls,
1417         int                     *msgidp ));
1418
1419 LDAP_F( int )
1420 ldap_modify_ext_s LDAP_P((
1421         LDAP                    *ld,
1422         LDAP_CONST char *dn,
1423         LDAPMod                 **mods,
1424         LDAPControl             **serverctrls,
1425         LDAPControl             **clientctrls ));
1426
1427 #if LDAP_DEPRECATED
1428 LDAP_F( int )
1429 ldap_modify LDAP_P((    /* deprecated, use ldap_modify_ext */
1430         LDAP *ld,
1431         LDAP_CONST char *dn,
1432         LDAPMod **mods ));
1433
1434 LDAP_F( int )
1435 ldap_modify_s LDAP_P((  /* deprecated, use ldap_modify_ext_s */
1436         LDAP *ld,
1437         LDAP_CONST char *dn,
1438         LDAPMod **mods ));
1439 #endif
1440
1441
1442 /*
1443  * in modrdn.c:
1444  */
1445 LDAP_F( int )
1446 ldap_rename LDAP_P((
1447         LDAP *ld,
1448         LDAP_CONST char *dn,
1449         LDAP_CONST char *newrdn,
1450         LDAP_CONST char *newSuperior,
1451         int deleteoldrdn,
1452         LDAPControl **sctrls,
1453         LDAPControl **cctrls,
1454         int *msgidp ));
1455
1456 LDAP_F( int )
1457 ldap_rename_s LDAP_P((
1458         LDAP *ld,
1459         LDAP_CONST char *dn,
1460         LDAP_CONST char *newrdn,
1461         LDAP_CONST char *newSuperior,
1462         int deleteoldrdn,
1463         LDAPControl **sctrls,
1464         LDAPControl **cctrls ));
1465
1466 #if LDAP_DEPRECATED
1467 LDAP_F( int )
1468 ldap_rename2 LDAP_P((   /* deprecated, use ldap_rename */
1469         LDAP *ld,
1470         LDAP_CONST char *dn,
1471         LDAP_CONST char *newrdn,
1472         LDAP_CONST char *newSuperior,
1473         int deleteoldrdn ));
1474
1475 LDAP_F( int )
1476 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1477         LDAP *ld,
1478         LDAP_CONST char *dn,
1479         LDAP_CONST char *newrdn,
1480         LDAP_CONST char *newSuperior,
1481         int deleteoldrdn ));
1482
1483 LDAP_F( int )
1484 ldap_modrdn LDAP_P((    /* deprecated, use ldap_rename */
1485         LDAP *ld,
1486         LDAP_CONST char *dn,
1487         LDAP_CONST char *newrdn ));
1488
1489 LDAP_F( int )
1490 ldap_modrdn_s LDAP_P((  /* deprecated, use ldap_rename_s */
1491         LDAP *ld,
1492         LDAP_CONST char *dn,
1493         LDAP_CONST char *newrdn ));
1494
1495 LDAP_F( int )
1496 ldap_modrdn2 LDAP_P((   /* deprecated, use ldap_rename */
1497         LDAP *ld,
1498         LDAP_CONST char *dn,
1499         LDAP_CONST char *newrdn,
1500         int deleteoldrdn ));
1501
1502 LDAP_F( int )
1503 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1504         LDAP *ld,
1505         LDAP_CONST char *dn,
1506         LDAP_CONST char *newrdn,
1507         int deleteoldrdn));
1508 #endif
1509
1510
1511 /*
1512  * in open.c:
1513  */
1514 #if LDAP_DEPRECATED
1515 LDAP_F( LDAP * )
1516 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1517         LDAP_CONST char *host,
1518         int port ));
1519
1520 LDAP_F( LDAP * )
1521 ldap_open LDAP_P((      /* deprecated, use ldap_create or ldap_initialize */
1522         LDAP_CONST char *host,
1523         int port ));
1524 #endif
1525
1526 LDAP_F( int )
1527 ldap_create LDAP_P((
1528         LDAP **ldp ));
1529
1530 LDAP_F( int )
1531 ldap_initialize LDAP_P((
1532         LDAP **ldp,
1533         LDAP_CONST char *url ));
1534
1535 LDAP_F( LDAP * )
1536 ldap_dup LDAP_P((
1537         LDAP *old ));
1538
1539 /*
1540  * in tls.c
1541  */
1542
1543 LDAP_F( int )
1544 ldap_tls_inplace LDAP_P((
1545         LDAP *ld ));
1546
1547 LDAP_F( int )
1548 ldap_start_tls LDAP_P((
1549         LDAP *ld,
1550         LDAPControl **serverctrls,
1551         LDAPControl **clientctrls,
1552         int *msgidp ));
1553
1554 LDAP_F( int )
1555 ldap_install_tls LDAP_P((
1556         LDAP *ld ));
1557
1558 LDAP_F( int )
1559 ldap_start_tls_s LDAP_P((
1560         LDAP *ld,
1561         LDAPControl **serverctrls,
1562         LDAPControl **clientctrls ));
1563
1564 /*
1565  * in messages.c:
1566  */
1567 LDAP_F( LDAPMessage * )
1568 ldap_first_message LDAP_P((
1569         LDAP *ld,
1570         LDAPMessage *chain ));
1571
1572 LDAP_F( LDAPMessage * )
1573 ldap_next_message LDAP_P((
1574         LDAP *ld,
1575         LDAPMessage *msg ));
1576
1577 LDAP_F( int )
1578 ldap_count_messages LDAP_P((
1579         LDAP *ld,
1580         LDAPMessage *chain ));
1581
1582 /*
1583  * in references.c:
1584  */
1585 LDAP_F( LDAPMessage * )
1586 ldap_first_reference LDAP_P((
1587         LDAP *ld,
1588         LDAPMessage *chain ));
1589
1590 LDAP_F( LDAPMessage * )
1591 ldap_next_reference LDAP_P((
1592         LDAP *ld,
1593         LDAPMessage *ref ));
1594
1595 LDAP_F( int )
1596 ldap_count_references LDAP_P((
1597         LDAP *ld,
1598         LDAPMessage *chain ));
1599
1600 LDAP_F( int )
1601 ldap_parse_reference LDAP_P((
1602         LDAP                    *ld,
1603         LDAPMessage             *ref,
1604         char                    ***referralsp,
1605         LDAPControl             ***serverctrls,
1606         int                             freeit));
1607
1608
1609 /*
1610  * in getentry.c:
1611  */
1612 LDAP_F( LDAPMessage * )
1613 ldap_first_entry LDAP_P((
1614         LDAP *ld,
1615         LDAPMessage *chain ));
1616
1617 LDAP_F( LDAPMessage * )
1618 ldap_next_entry LDAP_P((
1619         LDAP *ld,
1620         LDAPMessage *entry ));
1621
1622 LDAP_F( int )
1623 ldap_count_entries LDAP_P((
1624         LDAP *ld,
1625         LDAPMessage *chain ));
1626
1627 LDAP_F( int )
1628 ldap_get_entry_controls LDAP_P((
1629         LDAP                    *ld,
1630         LDAPMessage             *entry,
1631         LDAPControl             ***serverctrls));
1632
1633
1634 /*
1635  * in addentry.c
1636  */
1637 LDAP_F( LDAPMessage * )
1638 ldap_delete_result_entry LDAP_P((
1639         LDAPMessage **list,
1640         LDAPMessage *e ));
1641
1642 LDAP_F( void )
1643 ldap_add_result_entry LDAP_P((
1644         LDAPMessage **list,
1645         LDAPMessage *e ));
1646
1647
1648 /*
1649  * in getdn.c
1650  */
1651 LDAP_F( char * )
1652 ldap_get_dn LDAP_P((
1653         LDAP *ld,
1654         LDAPMessage *entry ));
1655
1656 typedef struct ldap_ava {
1657         struct berval la_attr;
1658         struct berval la_value;
1659         unsigned la_flags;
1660 #define LDAP_AVA_NULL                           0x0000U
1661 #define LDAP_AVA_STRING                         0x0001U
1662 #define LDAP_AVA_BINARY                         0x0002U
1663 #define LDAP_AVA_NONPRINTABLE           0x0004U
1664 #define LDAP_AVA_FREE_ATTR                      0x0010U
1665 #define LDAP_AVA_FREE_VALUE                     0x0020U
1666
1667         void *la_private;
1668 } LDAPAVA;
1669
1670 typedef LDAPAVA** LDAPRDN;
1671 typedef LDAPRDN* LDAPDN;
1672
1673 /* DN formats */
1674 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1675 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1676 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1677 #define LDAP_DN_FORMAT_DCE                      0x0030U
1678 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1679 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1680 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1681 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1682
1683 /* DN flags */
1684 #define LDAP_DN_PRETTY                          0x0100U
1685 #define LDAP_DN_SKIP                            0x0200U
1686 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1687 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1688 #define LDAP_DN_PEDANTIC                        0xF000U
1689
1690 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1691 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1692
1693 LDAP_F( int )
1694 ldap_bv2dn LDAP_P((
1695         struct berval *bv,
1696         LDAPDN *dn,
1697         unsigned flags ));
1698
1699 LDAP_F( int )
1700 ldap_str2dn LDAP_P((
1701         LDAP_CONST char *str,
1702         LDAPDN *dn,
1703         unsigned flags ));
1704
1705 LDAP_F( int )
1706 ldap_dn2bv LDAP_P((
1707         LDAPDN dn,
1708         struct berval *bv,
1709         unsigned flags ));
1710
1711 LDAP_F( int )
1712 ldap_dn2str LDAP_P((
1713         LDAPDN dn,
1714         char **str,
1715         unsigned flags ));
1716
1717 LDAP_F( int )
1718 ldap_bv2rdn LDAP_P((
1719         struct berval *bv,
1720         LDAPRDN *rdn,
1721         char **next,
1722         unsigned flags ));
1723
1724 LDAP_F( int )
1725 ldap_str2rdn LDAP_P((
1726         LDAP_CONST char *str,
1727         LDAPRDN *rdn,
1728         char **next,
1729         unsigned flags ));
1730
1731 LDAP_F( int )
1732 ldap_rdn2bv LDAP_P((
1733         LDAPRDN rdn,
1734         struct berval *bv,
1735         unsigned flags ));
1736
1737 LDAP_F( int )
1738 ldap_rdn2str LDAP_P((
1739         LDAPRDN rdn,
1740         char **str,
1741         unsigned flags ));
1742
1743 LDAP_F( int )
1744 ldap_dn_normalize LDAP_P((
1745         LDAP_CONST char *in, unsigned iflags,
1746         char **out, unsigned oflags ));
1747
1748 LDAP_F( char * )
1749 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1750         LDAP_CONST char *dn ));
1751
1752 LDAP_F( char ** )
1753 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1754         LDAP_CONST char *dn,
1755         int notypes ));
1756
1757 LDAP_F( char ** )
1758 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1759         LDAP_CONST char *rdn,
1760         int notypes ));
1761
1762 typedef int LDAPDN_rewrite_func
1763         LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1764
1765 LDAP_F( int )
1766 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1767         LDAPDN_rewrite_func *func, unsigned flags ));
1768
1769 LDAP_F( char * )
1770 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1771         LDAP_CONST char *dn ));
1772
1773 LDAP_F( char * )
1774 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1775         LDAP_CONST char *dce ));
1776
1777 LDAP_F( char * )
1778 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1779         LDAP_CONST char *dn ));
1780
1781 LDAP_F( int )
1782 ldap_get_dn_ber LDAP_P((
1783         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1784
1785 LDAP_F( int )
1786 ldap_get_attribute_ber LDAP_P((
1787         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1788         struct berval **vals ));
1789
1790 /*
1791  * in getattr.c
1792  */
1793 LDAP_F( char * )
1794 ldap_first_attribute LDAP_P((
1795         LDAP *ld,
1796         LDAPMessage *entry,
1797         BerElement **ber ));
1798
1799 LDAP_F( char * )
1800 ldap_next_attribute LDAP_P((
1801         LDAP *ld,
1802         LDAPMessage *entry,
1803         BerElement *ber ));
1804
1805
1806 /*
1807  * in getvalues.c
1808  */
1809 LDAP_F( struct berval ** )
1810 ldap_get_values_len LDAP_P((
1811         LDAP *ld,
1812         LDAPMessage *entry,
1813         LDAP_CONST char *target ));
1814
1815 LDAP_F( int )
1816 ldap_count_values_len LDAP_P((
1817         struct berval **vals ));
1818
1819 LDAP_F( void )
1820 ldap_value_free_len LDAP_P((
1821         struct berval **vals ));
1822
1823 #if LDAP_DEPRECATED
1824 LDAP_F( char ** )
1825 ldap_get_values LDAP_P((        /* deprecated, use ldap_get_values_len */
1826         LDAP *ld,
1827         LDAPMessage *entry,
1828         LDAP_CONST char *target ));
1829
1830 LDAP_F( int )
1831 ldap_count_values LDAP_P((      /* deprecated, use ldap_count_values_len */
1832         char **vals ));
1833
1834 LDAP_F( void )
1835 ldap_value_free LDAP_P((        /* deprecated, use ldap_value_free_len */
1836         char **vals ));
1837 #endif
1838
1839 /*
1840  * in result.c:
1841  */
1842 LDAP_F( int )
1843 ldap_result LDAP_P((
1844         LDAP *ld,
1845         int msgid,
1846         int all,
1847         struct timeval *timeout,
1848         LDAPMessage **result ));
1849
1850 LDAP_F( int )
1851 ldap_msgtype LDAP_P((
1852         LDAPMessage *lm ));
1853
1854 LDAP_F( int )
1855 ldap_msgid   LDAP_P((
1856         LDAPMessage *lm ));
1857
1858 LDAP_F( int )
1859 ldap_msgfree LDAP_P((
1860         LDAPMessage *lm ));
1861
1862 LDAP_F( int )
1863 ldap_msgdelete LDAP_P((
1864         LDAP *ld,
1865         int msgid ));
1866
1867
1868 /*
1869  * in search.c:
1870  */
1871 LDAP_F( int )
1872 ldap_bv2escaped_filter_value LDAP_P((
1873         struct berval *in,
1874         struct berval *out ));
1875
1876 LDAP_F( int )
1877 ldap_search_ext LDAP_P((
1878         LDAP                    *ld,
1879         LDAP_CONST char *base,
1880         int                             scope,
1881         LDAP_CONST char *filter,
1882         char                    **attrs,
1883         int                             attrsonly,
1884         LDAPControl             **serverctrls,
1885         LDAPControl             **clientctrls,
1886         struct timeval  *timeout,
1887         int                             sizelimit,
1888         int                             *msgidp ));
1889
1890 LDAP_F( int )
1891 ldap_search_ext_s LDAP_P((
1892         LDAP                    *ld,
1893         LDAP_CONST char *base,
1894         int                             scope,
1895         LDAP_CONST char *filter,
1896         char                    **attrs,
1897         int                             attrsonly,
1898         LDAPControl             **serverctrls,
1899         LDAPControl             **clientctrls,
1900         struct timeval  *timeout,
1901         int                             sizelimit,
1902         LDAPMessage             **res ));
1903
1904 #if LDAP_DEPRECATED
1905 LDAP_F( int )
1906 ldap_search LDAP_P((    /* deprecated, use ldap_search_ext */
1907         LDAP *ld,
1908         LDAP_CONST char *base,
1909         int scope,
1910         LDAP_CONST char *filter,
1911         char **attrs,
1912         int attrsonly ));
1913
1914 LDAP_F( int )
1915 ldap_search_s LDAP_P((  /* deprecated, use ldap_search_ext_s */
1916         LDAP *ld,
1917         LDAP_CONST char *base,
1918         int scope,
1919         LDAP_CONST char *filter,
1920         char **attrs,
1921         int attrsonly,
1922         LDAPMessage **res ));
1923
1924 LDAP_F( int )
1925 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1926         LDAP *ld,
1927         LDAP_CONST char *base,
1928         int scope,
1929         LDAP_CONST char *filter,
1930     char **attrs,
1931         int attrsonly,
1932         struct timeval *timeout,
1933         LDAPMessage **res ));
1934 #endif
1935
1936 /*
1937  * in unbind.c
1938  */
1939 LDAP_F( int )
1940 ldap_unbind_ext LDAP_P((
1941         LDAP                    *ld,
1942         LDAPControl             **serverctrls,
1943         LDAPControl             **clientctrls));
1944
1945 LDAP_F( int )
1946 ldap_unbind_ext_s LDAP_P((
1947         LDAP                    *ld,
1948         LDAPControl             **serverctrls,
1949         LDAPControl             **clientctrls));
1950
1951 LDAP_F( int )
1952 ldap_destroy LDAP_P((
1953         LDAP                    *ld));
1954
1955 #if LDAP_DEPRECATED
1956 LDAP_F( int )
1957 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1958         LDAP *ld ));
1959
1960 LDAP_F( int )
1961 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1962         LDAP *ld ));
1963 #endif
1964
1965 /*
1966  * in filter.c
1967  */
1968 LDAP_F( int )
1969 ldap_put_vrFilter LDAP_P((
1970         BerElement *ber,
1971         const char *vrf ));
1972
1973 /*
1974  * in free.c
1975  */
1976
1977 LDAP_F( void * )
1978 ldap_memalloc LDAP_P((
1979         ber_len_t s ));
1980
1981 LDAP_F( void * )
1982 ldap_memrealloc LDAP_P((
1983         void* p,
1984         ber_len_t s ));
1985
1986 LDAP_F( void * )
1987 ldap_memcalloc LDAP_P((
1988         ber_len_t n,
1989         ber_len_t s ));
1990
1991 LDAP_F( void )
1992 ldap_memfree LDAP_P((
1993         void* p ));
1994
1995 LDAP_F( void )
1996 ldap_memvfree LDAP_P((
1997         void** v ));
1998
1999 LDAP_F( char * )
2000 ldap_strdup LDAP_P((
2001         LDAP_CONST char * ));
2002
2003 LDAP_F( void )
2004 ldap_mods_free LDAP_P((
2005         LDAPMod **mods,
2006         int freemods ));
2007
2008
2009 #if LDAP_DEPRECATED
2010 /*
2011  * in sort.c (deprecated, use custom code instead)
2012  */
2013 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
2014         LDAP_CONST char *left,
2015         LDAP_CONST char *right ));
2016
2017 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
2018         LDAP_CONST void *left,
2019         LDAP_CONST void *right ));
2020
2021 LDAP_F( int )   /* deprecated */
2022 ldap_sort_entries LDAP_P(( LDAP *ld,
2023         LDAPMessage **chain,
2024         LDAP_CONST char *attr,
2025         LDAP_SORT_AD_CMP_PROC *cmp ));
2026
2027 LDAP_F( int )   /* deprecated */
2028 ldap_sort_values LDAP_P((
2029         LDAP *ld,
2030         char **vals,
2031         LDAP_SORT_AV_CMP_PROC *cmp ));
2032
2033 LDAP_F( int ) /* deprecated */
2034 ldap_sort_strcasecmp LDAP_P((
2035         LDAP_CONST void *a,
2036         LDAP_CONST void *b ));
2037 #endif
2038
2039 /*
2040  * in url.c
2041  */
2042 LDAP_F( int )
2043 ldap_is_ldap_url LDAP_P((
2044         LDAP_CONST char *url ));
2045
2046 LDAP_F( int )
2047 ldap_is_ldaps_url LDAP_P((
2048         LDAP_CONST char *url ));
2049
2050 LDAP_F( int )
2051 ldap_is_ldapi_url LDAP_P((
2052         LDAP_CONST char *url ));
2053
2054 LDAP_F( int )
2055 ldap_url_parse LDAP_P((
2056         LDAP_CONST char *url,
2057         LDAPURLDesc **ludpp ));
2058
2059 LDAP_F( char * )
2060 ldap_url_desc2str LDAP_P((
2061         LDAPURLDesc *ludp ));
2062
2063 LDAP_F( void )
2064 ldap_free_urldesc LDAP_P((
2065         LDAPURLDesc *ludp ));
2066
2067
2068 /*
2069  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
2070  *  in cancel.c
2071  */
2072 #define LDAP_API_FEATURE_CANCEL 1000
2073
2074 LDAP_F( int )
2075 ldap_cancel LDAP_P(( LDAP *ld,
2076         int cancelid,
2077         LDAPControl             **sctrls,
2078         LDAPControl             **cctrls,
2079         int                             *msgidp ));
2080
2081 LDAP_F( int )
2082 ldap_cancel_s LDAP_P(( LDAP *ld,
2083         int cancelid,
2084         LDAPControl **sctrl,
2085         LDAPControl **cctrl ));
2086
2087 /*
2088  * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2089  *  in turn.c
2090  */
2091 #define LDAP_API_FEATURE_TURN 1000
2092
2093 LDAP_F( int )
2094 ldap_turn LDAP_P(( LDAP *ld,
2095         int mutual,
2096         LDAP_CONST char* identifier,
2097         LDAPControl             **sctrls,
2098         LDAPControl             **cctrls,
2099         int                             *msgidp ));
2100
2101 LDAP_F( int )
2102 ldap_turn_s LDAP_P(( LDAP *ld,
2103         int mutual,
2104         LDAP_CONST char* identifier,
2105         LDAPControl **sctrl,
2106         LDAPControl **cctrl ));
2107
2108 /*
2109  * LDAP Paged Results
2110  *      in pagectrl.c
2111  */
2112 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2113
2114 LDAP_F( int )
2115 ldap_create_page_control_value LDAP_P((
2116         LDAP *ld,
2117         ber_int_t pagesize,
2118         struct berval *cookie,
2119         struct berval *value ));
2120
2121 LDAP_F( int )
2122 ldap_create_page_control LDAP_P((
2123         LDAP *ld,
2124         ber_int_t pagesize,
2125         struct berval *cookie,
2126         int iscritical,
2127         LDAPControl **ctrlp ));
2128
2129 #if LDAP_DEPRECATED
2130 LDAP_F( int )
2131 ldap_parse_page_control LDAP_P((
2132         /* deprecated, use ldap_parse_pageresponse_control */
2133         LDAP *ld,
2134         LDAPControl **ctrls,
2135         ber_int_t *count,
2136         struct berval **cookie ));
2137 #endif
2138
2139 LDAP_F( int )
2140 ldap_parse_pageresponse_control LDAP_P((
2141         LDAP *ld,
2142         LDAPControl *ctrl,
2143         ber_int_t *count,
2144         struct berval *cookie ));
2145
2146 /*
2147  * LDAP Server Side Sort
2148  *      in sortctrl.c
2149  */
2150 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2151
2152 /* structure for a sort-key */
2153 typedef struct ldapsortkey {
2154         char *attributeType;
2155         char *orderingRule;
2156         int reverseOrder;
2157 } LDAPSortKey;
2158
2159 LDAP_F( int )
2160 ldap_create_sort_keylist LDAP_P((
2161         LDAPSortKey ***sortKeyList,
2162         char *keyString ));
2163
2164 LDAP_F( void )
2165 ldap_free_sort_keylist LDAP_P((
2166         LDAPSortKey **sortkeylist ));
2167
2168 LDAP_F( int )
2169 ldap_create_sort_control_value LDAP_P((
2170         LDAP *ld,
2171         LDAPSortKey **keyList,
2172         struct berval *value ));
2173
2174 LDAP_F( int )
2175 ldap_create_sort_control LDAP_P((
2176         LDAP *ld,
2177         LDAPSortKey **keyList,
2178         int iscritical,
2179         LDAPControl **ctrlp ));
2180
2181 LDAP_F( int )
2182 ldap_parse_sortresponse_control LDAP_P((
2183         LDAP *ld,
2184         LDAPControl *ctrl,
2185         ber_int_t *result,
2186         char **attribute ));
2187
2188 /*
2189  * LDAP Virtual List View
2190  *      in vlvctrl.c
2191  */
2192 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2193
2194 /* structure for virtual list */
2195 typedef struct ldapvlvinfo {
2196         ber_int_t ldvlv_version;
2197     ber_int_t ldvlv_before_count;
2198     ber_int_t ldvlv_after_count;
2199     ber_int_t ldvlv_offset;
2200     ber_int_t ldvlv_count;
2201     struct berval *     ldvlv_attrvalue;
2202     struct berval *     ldvlv_context;
2203     void *                      ldvlv_extradata;
2204 } LDAPVLVInfo;
2205
2206 LDAP_F( int )
2207 ldap_create_vlv_control_value LDAP_P((
2208         LDAP *ld,
2209         LDAPVLVInfo *ldvlistp,
2210         struct berval *value));
2211
2212 LDAP_F( int )
2213 ldap_create_vlv_control LDAP_P((
2214         LDAP *ld,
2215         LDAPVLVInfo *ldvlistp,
2216         LDAPControl **ctrlp ));
2217
2218 LDAP_F( int )
2219 ldap_parse_vlvresponse_control LDAP_P((
2220         LDAP          *ld,
2221         LDAPControl   *ctrls,
2222         ber_int_t *target_posp,
2223         ber_int_t *list_countp,
2224         struct berval **contextp,
2225         int           *errcodep ));
2226
2227 /*
2228  * LDAP Verify Credentials
2229  */
2230 #define LDAP_API_FEATURE_VERIFY_CREDENTIALS 1000
2231
2232 LDAP_F( int )
2233 ldap_verify_credentials LDAP_P((
2234         LDAP            *ld,
2235         struct berval   *cookie,
2236         LDAP_CONST char *dn,
2237         LDAP_CONST char *mechanism,
2238         struct berval   *cred,
2239         LDAPControl     **ctrls,
2240         LDAPControl     **serverctrls,
2241         LDAPControl     **clientctrls,
2242         int             *msgidp ));
2243
2244 LDAP_F( int )
2245 ldap_verify_credentials_s LDAP_P((
2246         LDAP            *ld,
2247         struct berval   *cookie,
2248         LDAP_CONST char *dn,
2249         LDAP_CONST char *mechanism,
2250         struct berval   *cred,
2251         LDAPControl     **vcictrls,
2252         LDAPControl     **serverctrls,
2253         LDAPControl     **clientctrls,
2254         int                             *code,
2255         char                    **diagmsgp,
2256         struct berval   **scookie,
2257         struct berval   **servercredp,
2258         LDAPControl     ***vcoctrls));
2259
2260
2261 LDAP_F( int )
2262 ldap_parse_verify_credentials LDAP_P((
2263         LDAP            *ld,
2264         LDAPMessage     *res,
2265         int                     *code,
2266         char                    **diagmsgp,
2267         struct berval   **cookie,
2268         struct berval   **servercredp,
2269         LDAPControl     ***vcctrls));
2270
2271 /* not yet implemented */
2272 /* #define LDAP_API_FEATURE_VERIFY_CREDENTIALS_INTERACTIVE 1000 */
2273 #ifdef LDAP_API_FEATURE_VERIFY_CREDENTIALS_INTERACTIVE
2274 LDAP_F( int )
2275 ldap_verify_credentials_interactive LDAP_P((
2276         LDAP *ld,
2277         LDAP_CONST char *dn, /* usually NULL */
2278         LDAP_CONST char *saslMechanism,
2279         LDAPControl **vcControls,
2280         LDAPControl **serverControls,
2281         LDAPControl **clientControls,
2282
2283         /* should be client controls */
2284         unsigned flags,
2285         LDAP_SASL_INTERACT_PROC *proc,
2286         void *defaults,
2287         void *context,
2288
2289         /* as obtained from ldap_result() */
2290         LDAPMessage *result,
2291
2292         /* returned during bind processing */
2293         const char **rmech,
2294         int *msgid ));
2295 #endif
2296
2297 /*
2298  * LDAP Who Am I?
2299  *      in whoami.c
2300  */
2301 #define LDAP_API_FEATURE_WHOAMI 1000
2302
2303 LDAP_F( int )
2304 ldap_parse_whoami LDAP_P((
2305         LDAP *ld,
2306         LDAPMessage *res,
2307         struct berval **authzid ));
2308
2309 LDAP_F( int )
2310 ldap_whoami LDAP_P(( LDAP *ld,
2311         LDAPControl             **sctrls,
2312         LDAPControl             **cctrls,
2313         int                             *msgidp ));
2314
2315 LDAP_F( int )
2316 ldap_whoami_s LDAP_P((
2317         LDAP *ld,
2318         struct berval **authzid,
2319         LDAPControl **sctrls,
2320         LDAPControl **cctrls ));
2321
2322 /*
2323  * LDAP Password Modify
2324  *      in passwd.c
2325  */
2326 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2327
2328 LDAP_F( int )
2329 ldap_parse_passwd LDAP_P((
2330         LDAP *ld,
2331         LDAPMessage *res,
2332         struct berval *newpasswd ));
2333
2334 LDAP_F( int )
2335 ldap_passwd LDAP_P(( LDAP *ld,
2336         struct berval   *user,
2337         struct berval   *oldpw,
2338         struct berval   *newpw,
2339         LDAPControl             **sctrls,
2340         LDAPControl             **cctrls,
2341         int                             *msgidp ));
2342
2343 LDAP_F( int )
2344 ldap_passwd_s LDAP_P((
2345         LDAP *ld,
2346         struct berval   *user,
2347         struct berval   *oldpw,
2348         struct berval   *newpw,
2349         struct berval *newpasswd,
2350         LDAPControl **sctrls,
2351         LDAPControl **cctrls ));
2352
2353 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2354 /*
2355  * LDAP Password Policy controls
2356  *      in ppolicy.c
2357  */
2358 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2359
2360 typedef enum passpolicyerror_enum {
2361        PP_passwordExpired = 0,
2362        PP_accountLocked = 1,
2363        PP_changeAfterReset = 2,
2364        PP_passwordModNotAllowed = 3,
2365        PP_mustSupplyOldPassword = 4,
2366        PP_insufficientPasswordQuality = 5,
2367        PP_passwordTooShort = 6,
2368        PP_passwordTooYoung = 7,
2369        PP_passwordInHistory = 8,
2370        PP_noError = 65535
2371 } LDAPPasswordPolicyError;
2372
2373 LDAP_F( int )
2374 ldap_create_passwordpolicy_control LDAP_P((
2375         LDAP *ld,
2376         LDAPControl **ctrlp ));
2377
2378 LDAP_F( int )
2379 ldap_parse_passwordpolicy_control LDAP_P((
2380         LDAP *ld,
2381         LDAPControl *ctrl,
2382         ber_int_t *expirep,
2383         ber_int_t *gracep,
2384         LDAPPasswordPolicyError *errorp ));
2385
2386 LDAP_F( const char * )
2387 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2388 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2389
2390 /*
2391  * LDAP Dynamic Directory Services Refresh -- RFC 2589
2392  *      in dds.c
2393  */
2394 #define LDAP_API_FEATURE_REFRESH 1000
2395
2396 LDAP_F( int )
2397 ldap_parse_refresh LDAP_P((
2398         LDAP *ld,
2399         LDAPMessage *res,
2400         ber_int_t *newttl ));
2401
2402 LDAP_F( int )
2403 ldap_refresh LDAP_P(( LDAP *ld,
2404         struct berval   *dn,
2405         ber_int_t ttl,
2406         LDAPControl             **sctrls,
2407         LDAPControl             **cctrls,
2408         int                             *msgidp ));
2409
2410 LDAP_F( int )
2411 ldap_refresh_s LDAP_P((
2412         LDAP *ld,
2413         struct berval   *dn,
2414         ber_int_t ttl,
2415         ber_int_t *newttl,
2416         LDAPControl **sctrls,
2417         LDAPControl **cctrls ));
2418
2419 /*
2420  * LDAP Transactions
2421  */
2422 #ifdef LDAP_X_TXN
2423 LDAP_F( int )
2424 ldap_txn_start LDAP_P(( LDAP *ld,
2425         LDAPControl             **sctrls,
2426         LDAPControl             **cctrls,
2427         int                             *msgidp ));
2428
2429 LDAP_F( int )
2430 ldap_txn_start_s LDAP_P(( LDAP *ld,
2431         LDAPControl **sctrl,
2432         LDAPControl **cctrl,
2433         struct berval **rettxnid ));
2434
2435 LDAP_F( int )
2436 ldap_txn_end LDAP_P(( LDAP *ld,
2437         int     commit,
2438         struct berval   *txnid,
2439         LDAPControl             **sctrls,
2440         LDAPControl             **cctrls,
2441         int                             *msgidp ));
2442
2443 LDAP_F( int )
2444 ldap_txn_end_s LDAP_P(( LDAP *ld,
2445         int     commit,
2446         struct berval *txnid,
2447         LDAPControl **sctrl,
2448         LDAPControl **cctrl,
2449         int *retidp ));
2450 #endif
2451
2452 /*
2453  * in ldap_sync.c
2454  */
2455
2456 /*
2457  * initialize the persistent search structure
2458  */
2459 LDAP_F( ldap_sync_t * )
2460 ldap_sync_initialize LDAP_P((
2461         ldap_sync_t     *ls ));
2462
2463 /*
2464  * destroy the persistent search structure
2465  */
2466 LDAP_F( void )
2467 ldap_sync_destroy LDAP_P((
2468         ldap_sync_t     *ls,
2469         int             freeit ));
2470
2471 /*
2472  * initialize a refreshOnly sync
2473  */
2474 LDAP_F( int )
2475 ldap_sync_init LDAP_P((
2476         ldap_sync_t     *ls,
2477         int             mode ));
2478
2479 /*
2480  * initialize a refreshOnly sync
2481  */
2482 LDAP_F( int )
2483 ldap_sync_init_refresh_only LDAP_P((
2484         ldap_sync_t     *ls ));
2485
2486 /*
2487  * initialize a refreshAndPersist sync
2488  */
2489 LDAP_F( int )
2490 ldap_sync_init_refresh_and_persist LDAP_P((
2491         ldap_sync_t     *ls ));
2492
2493 /*
2494  * poll for new responses
2495  */
2496 LDAP_F( int )
2497 ldap_sync_poll LDAP_P((
2498         ldap_sync_t     *ls ));
2499
2500 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2501
2502 /*
2503  * in stctrl.c
2504  */
2505 LDAP_F( int )
2506 ldap_create_session_tracking_value LDAP_P((
2507         LDAP            *ld,
2508         char            *sessionSourceIp,
2509         char            *sessionSourceName,
2510         char            *formatOID,
2511         struct berval   *sessionTrackingIdentifier,
2512         struct berval   *value ));
2513
2514 LDAP_F( int )
2515 ldap_create_session_tracking_control LDAP_P((
2516         LDAP            *ld,
2517         char            *sessionSourceIp,
2518         char            *sessionSourceName,
2519         char            *formatOID,
2520         struct berval   *sessionTrackingIdentifier,
2521         LDAPControl     **ctrlp ));
2522
2523 LDAP_F( int )
2524 ldap_parse_session_tracking_control LDAP_P((
2525         LDAP *ld,
2526         LDAPControl *ctrl,
2527         struct berval *ip,
2528         struct berval *name,
2529         struct berval *oid,
2530         struct berval *id ));
2531
2532 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2533
2534 /*
2535  * in assertion.c
2536  */
2537 LDAP_F (int)
2538 ldap_create_assertion_control_value LDAP_P((
2539         LDAP            *ld,
2540         char            *assertion,
2541         struct berval   *value ));
2542
2543 LDAP_F( int )
2544 ldap_create_assertion_control LDAP_P((
2545         LDAP            *ld,
2546         char            *filter,
2547         int             iscritical,
2548         LDAPControl     **ctrlp ));
2549
2550 /*
2551  * in deref.c
2552  */
2553
2554 typedef struct LDAPDerefSpec {
2555         char *derefAttr;
2556         char **attributes;
2557 } LDAPDerefSpec;
2558
2559 typedef struct LDAPDerefVal {
2560         char *type;
2561         BerVarray vals;
2562         struct LDAPDerefVal *next;
2563 } LDAPDerefVal;
2564
2565 typedef struct LDAPDerefRes {
2566         char *derefAttr;
2567         struct berval derefVal;
2568         LDAPDerefVal *attrVals;
2569         struct LDAPDerefRes *next;
2570 } LDAPDerefRes;
2571
2572 LDAP_F( int )
2573 ldap_create_deref_control_value LDAP_P((
2574         LDAP *ld,
2575         LDAPDerefSpec *ds,
2576         struct berval *value ));
2577
2578 LDAP_F( int )
2579 ldap_create_deref_control LDAP_P((
2580         LDAP            *ld,
2581         LDAPDerefSpec   *ds,
2582         int             iscritical,
2583         LDAPControl     **ctrlp ));
2584
2585 LDAP_F( void )
2586 ldap_derefresponse_free LDAP_P((
2587         LDAPDerefRes *dr ));
2588
2589 LDAP_F( int )
2590 ldap_parse_derefresponse_control LDAP_P((
2591         LDAP *ld,
2592         LDAPControl *ctrl,
2593         LDAPDerefRes **drp ));
2594
2595 LDAP_F( int )
2596 ldap_parse_deref_control LDAP_P((
2597         LDAP            *ld,
2598         LDAPControl     **ctrls,
2599         LDAPDerefRes    **drp ));
2600
2601 /*
2602  * high level LDIF to LDAP structure support
2603  */
2604 #define LDIF_DEFAULT_ADD  0x01 /* if changetype missing, assume LDAP_ADD */
2605 #define LDIF_ENTRIES_ONLY 0x02 /* ignore changetypes other than add */
2606 #define LDIF_NO_CONTROLS  0x04 /* ignore control specifications */
2607
2608 typedef struct ldifrecord {
2609         ber_tag_t lr_op; /* type of operation - LDAP_REQ_MODIFY, LDAP_REQ_ADD, etc. */
2610         struct berval lr_dn; /* DN of operation */
2611         LDAPControl **lr_ctrls; /* controls specified for operation */
2612         /* some ops such as LDAP_REQ_DELETE require only a DN */
2613         /* other ops require different data - the ldif_ops union
2614            is used to specify the data for each type of operation */
2615         union ldif_ops_u {
2616                 LDAPMod **lr_mods; /* list of mods for LDAP_REQ_MODIFY, LDAP_REQ_ADD */
2617 #define lrop_mods ldif_ops.lr_mods
2618                 struct ldif_op_rename_s {
2619                         struct berval lr_newrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2620 #define lrop_newrdn ldif_ops.ldif_op_rename.lr_newrdn
2621                         struct berval lr_newsuperior; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2622 #define lrop_newsup ldif_ops.ldif_op_rename.lr_newsuperior
2623                         int lr_deleteoldrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2624 #define lrop_delold ldif_ops.ldif_op_rename.lr_deleteoldrdn
2625                 } ldif_op_rename; /* rename/moddn/modrdn */
2626                 /* the following are for future support */
2627                 struct ldif_op_ext_s {
2628                         struct berval lr_extop_oid; /* LDAP_REQ_EXTENDED */
2629 #define lrop_extop_oid ldif_ops.ldif_op_ext.lr_extop_oid
2630                         struct berval lr_extop_data; /* LDAP_REQ_EXTENDED */
2631 #define lrop_extop_data ldif_ops.ldif_op_ext.lr_extop_data
2632                 } ldif_op_ext; /* extended operation */
2633                 struct ldif_op_cmp_s {
2634                         struct berval lr_cmp_attr; /* LDAP_REQ_COMPARE */
2635 #define lrop_cmp_attr ldif_ops.ldif_op_cmp.lr_cmp_attr
2636                         struct berval lr_cmp_bvalue; /* LDAP_REQ_COMPARE */
2637 #define lrop_cmp_bval ldif_ops.ldif_op_cmp.lr_cmp_bvalue
2638                 } ldif_op_cmp; /* compare operation */
2639         } ldif_ops;
2640         /* PRIVATE STUFF - DO NOT TOUCH */
2641         /* for efficiency, the implementation allocates memory */
2642         /* in large blobs, and makes the above fields point to */
2643         /* locations inside those blobs - one consequence is that */
2644         /* you cannot simply free the above allocated fields, nor */
2645         /* assign them to be owned by another memory context which */
2646         /* might free them (unless providing your own mem ctx) */
2647         /* we use the fields below to keep track of those blobs */
2648         /* so we that we can free them later */
2649         void *lr_ctx; /* the memory context or NULL */
2650         int lr_lines;
2651         LDAPMod *lr_lm;
2652         unsigned char *lr_mops;
2653         char *lr_freeval;
2654         struct berval *lr_vals;
2655         struct berval *lr_btype;
2656 } LDIFRecord;
2657
2658 /* free internal fields - does not free the LDIFRecord */
2659 LDAP_F( void )
2660 ldap_ldif_record_done LDAP_P((
2661         LDIFRecord *lr ));
2662
2663 LDAP_F( int )
2664 ldap_parse_ldif_record LDAP_P((
2665         struct berval *rbuf,
2666         unsigned long linenum,
2667         LDIFRecord *lr,
2668         const char *errstr,
2669         unsigned int flags ));
2670
2671 LDAP_END_DECL
2672 #endif /* _LDAP_H */