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