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