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