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