Apache Portable Runtime: apr_ldap.h Source File

00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
+00002  * contributor license agreements.  See the NOTICE file distributed with
+00003  * this work for additional information regarding copyright ownership.
+00004  * The ASF licenses this file to You under the Apache License, Version 2.0
+00005  * (the "License"); you may not use this file except in compliance with
+00006  * the License.  You may obtain a copy of the License at
+00007  *
+00008  *     http://www.apache.org/licenses/LICENSE-2.0
+00009  *
+00010  * Unless required by applicable law or agreed to in writing, software
+00011  * distributed under the License is distributed on an "AS IS" BASIS,
+00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+00013  * See the License for the specific language governing permissions and
+00014  * limitations under the License.
+00015  */
+00016 
+00017 /*
+00018  * apr_ldap.h is generated from apr_ldap.h.in by configure -- do not edit apr_ldap.h
+00019  */
+00020 /**
+00021  * @file apr_ldap.h
+00022  * @brief  APR-UTIL LDAP 
+00023  */
+00024 #ifndef APU_LDAP_H
+00025 #define APU_LDAP_H
+00026 
+00027 /**
+00028  * @defgroup APR_Util_LDAP LDAP
+00029  * @ingroup APR_Util
+00030  * @{
+00031  */
+00032 
+00033 /* this will be defined if LDAP support was compiled into apr-util */
+00034 #define APR_HAS_LDAP              0
+00035 
+00036 /* identify the LDAP toolkit used */
+00037 #define APR_HAS_NETSCAPE_LDAPSDK  0
+00038 #define APR_HAS_SOLARIS_LDAPSDK   0
+00039 #define APR_HAS_NOVELL_LDAPSDK    0
+00040 #define APR_HAS_MOZILLA_LDAPSDK   0
+00041 #define APR_HAS_OPENLDAP_LDAPSDK  0
+00042 #define APR_HAS_MICROSOFT_LDAPSDK 0
+00043 #define APR_HAS_TIVOLI_LDAPSDK    0
+00044 #define APR_HAS_ZOS_LDAPSDK       0
+00045 #define APR_HAS_OTHER_LDAPSDK     0
+00046 
+00047 
+00048 /*
+00049  * Handle the case when LDAP is enabled
+00050  */
+00051 #if APR_HAS_LDAP
+00052 
+00053 /*
+00054  * The following #defines are DEPRECATED and should not be used for
+00055  * anything. They remain to maintain binary compatibility.
+00056  * The original code defined the OPENLDAP SDK as present regardless
+00057  * of what really was there, which was way bogus. In addition, the
+00058  * apr_ldap_url_parse*() functions have been rewritten specifically for
+00059  * APR, so the APR_HAS_LDAP_URL_PARSE macro is forced to zero.
+00060  */
+00061 #if APR_HAS_TIVOLI_LDAPSDK
+00062 #define APR_HAS_LDAP_SSL 0
+00063 #else
+00064 #define APR_HAS_LDAP_SSL 1
+00065 #endif
+00066 #define APR_HAS_LDAP_URL_PARSE      0
+00067 
+00068 #if APR_HAS_OPENLDAP_LDAPSDK && !defined(LDAP_DEPRECATED) 
+00069 /* Ensure that the "deprecated" interfaces are still exposed
+00070  * with OpenLDAP >= 2.3; these were exposed by default in earlier
+00071  * releases. */
+00072 #define LDAP_DEPRECATED 1
+00073 #endif
+00074 
+00075 /*
+00076  * Include the standard LDAP header files.
+00077  */
+00078 
+00079 
+00080 
+00081 
+00082 
+00083 
+00084 /*
+00085  * Detected standard functions
+00086  */
+00087 #define APR_HAS_LDAPSSL_CLIENT_INIT 0
+00088 #define APR_HAS_LDAPSSL_CLIENT_DEINIT 0
+00089 #define APR_HAS_LDAPSSL_ADD_TRUSTED_CERT 0
+00090 #define APR_HAS_LDAP_START_TLS_S 0
+00091 #define APR_HAS_LDAP_SSLINIT 0
+00092 #define APR_HAS_LDAPSSL_INIT 0
+00093 #define APR_HAS_LDAPSSL_INSTALL_ROUTINES 0
+00094 
+00095 /*
+00096  * Make sure the secure LDAP port is defined
+00097  */
+00098 #ifndef LDAPS_PORT
+00099 #define LDAPS_PORT 636  /* ldaps:/// default LDAP over TLS port */
+00100 #endif
+00101 
+00102 /*
+00103  * For ldap function calls that input a size limit on the number of returned elements
+00104  * Some SDKs do not have the define for LDAP_DEFAULT_LIMIT (-1) or LDAP_NO_LIMIT (0)
+00105  * LDAP_DEFAULT_LIMIT is preferred as it allows inheritance from whatever the SDK
+00106  * or process is configured for.
+00107  */
+00108 #ifdef LDAP_DEFAULT_LIMIT
+00109 #define APR_LDAP_SIZELIMIT LDAP_DEFAULT_LIMIT
+00110 #else
+00111 #ifdef LDAP_NO_LIMIT
+00112 #define APR_LDAP_SIZELIMIT LDAP_NO_LIMIT
+00113 #endif
+00114 #endif
+00115 
+00116 #ifndef APR_LDAP_SIZELIMIT
+00117 #define APR_LDAP_SIZELIMIT 0 /* equivalent to LDAP_NO_LIMIT, and what goes on the wire */
+00118 #endif
+00119 
+00120 /*
+00121  * z/OS is missing some defines
+00122  */
+00123 #ifndef LDAP_VERSION_MAX
+00124 #define LDAP_VERSION_MAX  LDAP_VERSION
+00125 #endif
+00126 #if APR_HAS_ZOS_LDAPSDK
+00127 #define LDAP_VENDOR_NAME "IBM z/OS"
+00128 #endif
+00129 
+00130 /* Note: Macros defining const casting has been removed in APR v1.0,
+00131  * pending real support for LDAP v2.0 toolkits.
+00132  *
+00133  * In the mean time, please use an LDAP v3.0 toolkit.
+00134  */
+00135 #if LDAP_VERSION_MAX <= 2
+00136 #error Support for LDAP v2.0 toolkits has been removed from apr-util. Please use an LDAP v3.0 toolkit.
+00137 #endif 
+00138 
+00139 #ifdef __cplusplus
+00140 extern "C" {
+00141 #endif /* __cplusplus */
+00142 
+00143 /**
+00144  * This structure allows the C LDAP API error codes to be returned
+00145  * along with plain text error messages that explain to us mere mortals
+00146  * what really happened.
+00147  */
+00148 typedef struct apr_ldap_err_t {
+00149     const char *reason;
+00150     const char *msg;
+00151     int rc;
+00152 } apr_ldap_err_t;
+00153 
+00154 #ifdef __cplusplus
+00155 }
+00156 #endif
+00157 
+00158 /* The MS SDK returns LDAP_UNAVAILABLE when the backend has closed the connection
+00159  * between LDAP calls. Protect with APR_HAS_MICROSOFT_LDAPSDK in case someone 
+00160  * manually chooses another SDK on Windows 
+00161  */
+00162 #if APR_HAS_MICROSOFT_LDAPSDK
+00163 #define APR_LDAP_IS_SERVER_DOWN(s)    ((s) == LDAP_SERVER_DOWN \
+00164                                     || (s) == LDAP_UNAVAILABLE)
+00165 #else
+00166 #define APR_LDAP_IS_SERVER_DOWN(s)    ((s) == LDAP_SERVER_DOWN)
+00167 #endif
+00168 
+00169 /* These symbols are not actually exported in a DSO build, but mapped into
+00170  * a private exported function array for apr_ldap_stub to bind dynamically.
+00171  * Rename them appropriately to protect the global namespace.
+00172  */
+00173 #ifdef APU_DSO_LDAP_BUILD
+00174 
+00175 #define apr_ldap_info apr__ldap_info
+00176 #define apr_ldap_init apr__ldap_init
+00177 #define apr_ldap_ssl_init apr__ldap_ssl_init
+00178 #define apr_ldap_ssl_deinit apr__ldap_ssl_deinit
+00179 #define apr_ldap_get_option apr__ldap_get_option
+00180 #define apr_ldap_set_option apr__ldap_set_option
+00181 #define apr_ldap_rebind_init apr__ldap_rebind_init
+00182 #define apr_ldap_rebind_add apr__ldap_rebind_add
+00183 #define apr_ldap_rebind_remove apr__ldap_rebind_remove
+00184 
+00185 #define APU_DECLARE_LDAP(type) type
+00186 #else
+00187 #define APU_DECLARE_LDAP(type) APU_DECLARE(type)
+00188 #endif
+00189 
+00190 #include "apr_ldap_url.h"
+00191 #include "apr_ldap_init.h"
+00192 #include "apr_ldap_option.h"
+00193 #include "apr_ldap_rebind.h"
+00194 
+00195 /** @} */
+00196 #endif /* APR_HAS_LDAP */
+00197 #endif /* APU_LDAP_H */
+

00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
+00002  * contributor license agreements.  See the NOTICE file distributed with
+00003  * this work for additional information regarding copyright ownership.
+00004  * The ASF licenses this file to You under the Apache License, Version 2.0
+00005  * (the "License"); you may not use this file except in compliance with
+00006  * the License.  You may obtain a copy of the License at
+00007  *
+00008  *     http://www.apache.org/licenses/LICENSE-2.0
+00009  *
+00010  * Unless required by applicable law or agreed to in writing, software
+00011  * distributed under the License is distributed on an "AS IS" BASIS,
+00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+00013  * See the License for the specific language governing permissions and
+00014  * limitations under the License.
+00015  */
+00016 
+00017 /**
+00018  * @file apr_ldap_init.h
+00019  * @brief  APR-UTIL LDAP ldap_init() functions
+00020  */
+00021 #ifndef APR_LDAP_INIT_H
+00022 #define APR_LDAP_INIT_H
+00023 
+00024 /**
+00025  * @addtogroup APR_Util_LDAP
+00026  * @{
+00027  */
+00028 
+00029 #include "apr_ldap.h"
+00030 
+00031 #if APR_HAS_LDAP
+00032 
+00033 #ifdef __cplusplus
+00034 extern "C" {
+00035 #endif /* __cplusplus */
+00036 
+00037 
+00038 /**
+00039  * Macro to detect security related return values.
+00040  */
+00041 #if defined(LDAP_INSUFFICIENT_ACCESS)
+00042 #define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_ACCESS
+00043 #elif defined(LDAP_INSUFFICIENT_RIGHTS)
+00044 #define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_RIGHTS
+00045 #elif defined(APR_HAS_MICROSOFT_LDAPSDK)
+00046 /* The macros above fail to contemplate that LDAP_RETCODE values
+00047  * may be represented by an enum.  autoconf tests would be much
+00048  * more robust.
+00049  */
+00050 #define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_RIGHTS
+00051 #else
+00052 #error The security return codes must be added to support this LDAP toolkit.
+00053 #endif
+00054 
+00055 #if defined(LDAP_SECURITY_ERROR)
+00056 #define APU_LDAP_SECURITY_ERROR LDAP_SECURITY_ERROR
+00057 #else
+00058 #define APU_LDAP_SECURITY_ERROR(n)      \
+00059     (LDAP_INAPPROPRIATE_AUTH == n) ? 1 \
+00060     : (LDAP_INVALID_CREDENTIALS == n) ? 1 \
+00061     : (APU_LDAP_INSUFFICIENT_ACCESS == n) ? 1 \
+00062     : 0
+00063 #endif
+00064 
+00065 
+00066 /**
+00067  * APR LDAP SSL Initialise function
+00068  *
+00069  * This function initialises SSL on the underlying LDAP toolkit
+00070  * if this is necessary.
+00071  *
+00072  * If a CA certificate is provided, this is set, however the setting
+00073  * of certificates via this method has been deprecated and will be removed in
+00074  * APR v2.0.
+00075  *
+00076  * The apr_ldap_set_option() function with the APR_LDAP_OPT_TLS_CERT option
+00077  * should be used instead to set certificates.
+00078  *
+00079  * If SSL support is not available on this platform, or a problem
+00080  * was encountered while trying to set the certificate, the function
+00081  * will return APR_EGENERAL. Further LDAP specific error information
+00082  * can be found in result_err.
+00083  * @param pool The pool to use
+00084  * @param cert_auth_file The name of the certificate to use, can be NULL
+00085  * @param cert_file_type The type of certificate specified. See the
+00086  * apr_ldap_set_option() APR_LDAP_OPT_TLS_CERT option for details.
+00087  * @param result_err The returned result
+00088  */
+00089 APU_DECLARE_LDAP(int) apr_ldap_ssl_init(apr_pool_t *pool,
+00090                                         const char *cert_auth_file,
+00091                                         int cert_file_type,
+00092                                         apr_ldap_err_t **result_err);
+00093 
+00094 /**
+00095  * APR LDAP SSL De-Initialise function
+00096  *
+00097  * This function tears down any SSL certificate setup previously
+00098  * set using apr_ldap_ssl_init(). It should be called to clean
+00099  * up if a graceful restart of a service is attempted.
+00100  * @todo currently we do not check whether apr_ldap_ssl_init()
+00101  * has been called first - we probably should.
+00102  */
+00103 APU_DECLARE_LDAP(int) apr_ldap_ssl_deinit(void);
+00104 
+00105 /**
+00106  * APR LDAP initialise function
+00107  *
+00108  * This function is responsible for initialising an LDAP
+00109  * connection in a toolkit independant way. It does the
+00110  * job of ldap_init() from the C api.
+00111  *
+00112  * It handles both the SSL and non-SSL case, and attempts
+00113  * to hide the complexity setup from the user. This function
+00114  * assumes that any certificate setup necessary has already
+00115  * been done.
+00116  *
+00117  * If SSL or STARTTLS needs to be enabled, and the underlying
+00118  * toolkit supports it, the following values are accepted for
+00119  * secure:
+00120  *
+00121  * APR_LDAP_NONE: No encryption
+00122  * APR_LDAP_SSL: SSL encryption (ldaps://)
+00123  * APR_LDAP_STARTTLS: Force STARTTLS on ldap://
+00124  * @remark The Novell toolkit is only able to set the SSL mode via this
+00125  * function. To work around this limitation, set the SSL mode here if no
+00126  * per connection client certificates are present, otherwise set secure
+00127  * APR_LDAP_NONE here, then set the per connection client certificates,
+00128  * followed by setting the SSL mode via apr_ldap_set_option(). As Novell
+00129  * does not support per connection client certificates, this problem is
+00130  * worked around while still being compatible with other LDAP toolkits.
+00131  * @param pool The pool to use
+00132  * @param ldap The LDAP handle
+00133  * @param hostname The name of the host to connect to. This can be either a
+00134  * DNS name, or an IP address.
+00135  * @param portno The port to connect to
+00136  * @param secure The security mode to set
+00137  * @param result_err The returned result
+00138  */
+00139 APU_DECLARE_LDAP(int) apr_ldap_init(apr_pool_t *pool,
+00140                                     LDAP **ldap,
+00141                                     const char *hostname,
+00142                                     int portno,
+00143                                     int secure,
+00144                                     apr_ldap_err_t **result_err);
+00145 
+00146 /**
+00147  * APR LDAP info function
+00148  *
+00149  * This function returns a string describing the LDAP toolkit
+00150  * currently in use. The string is placed inside result_err->reason.
+00151  * @param pool The pool to use
+00152  * @param result_err The returned result
+00153  */
+00154 APU_DECLARE_LDAP(int) apr_ldap_info(apr_pool_t *pool,
+00155                                     apr_ldap_err_t **result_err);
+00156 
+00157 #ifdef __cplusplus
+00158 }
+00159 #endif
+00160 
+00161 #endif /* APR_HAS_LDAP */
+00162 
+00163 /** @} */
+00164 
+00165 #endif /* APR_LDAP_URL_H */
+

00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
+00002  * contributor license agreements.  See the NOTICE file distributed with
+00003  * this work for additional information regarding copyright ownership.
+00004  * The ASF licenses this file to You under the Apache License, Version 2.0
+00005  * (the "License"); you may not use this file except in compliance with
+00006  * the License.  You may obtain a copy of the License at
+00007  *
+00008  *     http://www.apache.org/licenses/LICENSE-2.0
+00009  *
+00010  * Unless required by applicable law or agreed to in writing, software
+00011  * distributed under the License is distributed on an "AS IS" BASIS,
+00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+00013  * See the License for the specific language governing permissions and
+00014  * limitations under the License.
+00015  */
+00016 
+00017 /**
+00018  * @file apr_ldap_option.h
+00019  * @brief  APR-UTIL LDAP ldap_*_option() functions
+00020  */
+00021 #ifndef APR_LDAP_OPTION_H
+00022 #define APR_LDAP_OPTION_H
+00023 
+00024 /**
+00025  * @addtogroup APR_Util_LDAP
+00026  * @{
+00027  */
+00028 
+00029 #include "apr_ldap.h"
+00030 
+00031 #if APR_HAS_LDAP
+00032 
+00033 #ifdef __cplusplus
+00034 extern "C" {
+00035 #endif /* __cplusplus */
+00036 
+00037 /*
+00038  * The following defines handle the different TLS certificate
+00039  * options available. If these options are missing, APR will try and
+00040  * emulate support for this using the deprecated ldap_start_tls_s()
+00041  * function.
+00042  */
+00043 /**
+00044  * Set SSL mode to one of APR_LDAP_NONE, APR_LDAP_SSL, APR_LDAP_STARTTLS
+00045  * or APR_LDAP_STOPTLS.
+00046  */
+00047 #define APR_LDAP_OPT_TLS 0x6fff
+00048 /**
+00049  * Set zero or more CA certificates, client certificates or private
+00050  * keys globally, or per connection (where supported).
+00051  */
+00052 #define APR_LDAP_OPT_TLS_CERT 0x6ffe
+00053 /**
+00054  * Set the LDAP library to no verify the server certificate.  This means
+00055  * all servers are considered trusted.
+00056  */
+00057 #define APR_LDAP_OPT_VERIFY_CERT 0x6ffd
+00058 /**
+00059  * Set the LDAP library to indicate if referrals should be chased during
+00060  * LDAP searches.
+00061  */
+00062 #define APR_LDAP_OPT_REFERRALS 0x6ffc
+00063 /**
+00064  * Set the LDAP library to indicate a maximum number of referral hops to
+00065  * chase before giving up on the search.
+00066  */
+00067 #define APR_LDAP_OPT_REFHOPLIMIT 0x6ffb
+00068 
+00069 /**
+00070  * Structures for the apr_set_option() cases
+00071  */
+00072 
+00073 /**
+00074  * APR_LDAP_OPT_TLS_CERT
+00075  *
+00076  * This structure includes possible options to set certificates on
+00077  * system initialisation. Different SDKs have different certificate
+00078  * requirements, and to achieve this multiple certificates must be
+00079  * specified at once passed as an (apr_array_header_t *).
+00080  *
+00081  * Netscape:
+00082  * Needs the CA cert database (cert7.db), the client cert database (key3.db)
+00083  * and the security module file (secmod.db) set at the system initialisation
+00084  * time. Three types are supported: APR_LDAP_CERT7_DB, APR_LDAP_KEY3_DB and
+00085  * APR_LDAP_SECMOD.
+00086  *
+00087  * To specify a client cert connection, a certificate nickname needs to be
+00088  * provided with a type of APR_LDAP_CERT.
+00089  * int ldapssl_enable_clientauth( LDAP *ld, char *keynickname,
+00090  * char *keypasswd, char *certnickname );
+00091  * keynickname is currently not used, and should be set to ""
+00092  *
+00093  * Novell:
+00094  * Needs CA certificates and client certificates set at system initialisation
+00095  * time. Three types are supported: APR_LDAP_CA*, APR_LDAP_CERT* and
+00096  * APR_LDAP_KEY*.
+00097  *
+00098  * Certificates cannot be specified per connection.
+00099  *
+00100  * The functions used are:
+00101  * ldapssl_add_trusted_cert(serverTrustedRoot, serverTrustedRootEncoding);
+00102  * Clients certs and keys are set at system initialisation time with
+00103  * int ldapssl_set_client_cert (
+00104  *  void   *cert,
+00105  *  int     type
+00106  *  void   *password); 
+00107  * type can be LDAPSSL_CERT_FILETYPE_B64 or LDAPSSL_CERT_FILETYPE_DER
+00108  *  ldapssl_set_client_private_key(clientPrivateKey,
+00109  *                                 clientPrivateKeyEncoding,
+00110  *                                 clientPrivateKeyPassword);
+00111  *
+00112  * OpenSSL:
+00113  * Needs one or more CA certificates to be set at system initialisation time
+00114  * with a type of APR_LDAP_CA*.
+00115  *
+00116  * May have one or more client certificates set per connection with a type of
+00117  * APR_LDAP_CERT*, and keys with APR_LDAP_KEY*.
+00118  */
+00119 /** CA certificate type unknown */
+00120 #define APR_LDAP_CA_TYPE_UNKNOWN    0
+00121 /** binary DER encoded CA certificate */
+00122 #define APR_LDAP_CA_TYPE_DER        1
+00123 /** PEM encoded CA certificate */
+00124 #define APR_LDAP_CA_TYPE_BASE64     2
+00125 /** Netscape/Mozilla cert7.db CA certificate database */
+00126 #define APR_LDAP_CA_TYPE_CERT7_DB   3
+00127 /** Netscape/Mozilla secmod file */
+00128 #define APR_LDAP_CA_TYPE_SECMOD     4
+00129 /** Client certificate type unknown */
+00130 #define APR_LDAP_CERT_TYPE_UNKNOWN  5
+00131 /** binary DER encoded client certificate */
+00132 #define APR_LDAP_CERT_TYPE_DER      6
+00133 /** PEM encoded client certificate */
+00134 #define APR_LDAP_CERT_TYPE_BASE64   7
+00135 /** Netscape/Mozilla key3.db client certificate database */
+00136 #define APR_LDAP_CERT_TYPE_KEY3_DB  8
+00137 /** Netscape/Mozilla client certificate nickname */
+00138 #define APR_LDAP_CERT_TYPE_NICKNAME 9
+00139 /** Private key type unknown */
+00140 #define APR_LDAP_KEY_TYPE_UNKNOWN   10
+00141 /** binary DER encoded private key */
+00142 #define APR_LDAP_KEY_TYPE_DER       11
+00143 /** PEM encoded private key */
+00144 #define APR_LDAP_KEY_TYPE_BASE64    12
+00145 /** PKCS#12 encoded client certificate */
+00146 #define APR_LDAP_CERT_TYPE_PFX      13
+00147 /** PKCS#12 encoded private key */
+00148 #define APR_LDAP_KEY_TYPE_PFX       14
+00149 /** Openldap directory full of base64-encoded cert 
+00150  * authorities with hashes in corresponding .0 directory
+00151  */
+00152 #define APR_LDAP_CA_TYPE_CACERTDIR_BASE64 15
+00153 
+00154 
+00155 /**
+00156  * Certificate structure.
+00157  *
+00158  * This structure is used to store certificate details. An array of
+00159  * these structures is passed to apr_ldap_set_option() to set CA
+00160  * and client certificates.
+00161  * @param type Type of certificate APR_LDAP_*_TYPE_*
+00162  * @param path Path, file or nickname of the certificate
+00163  * @param password Optional password, can be NULL
+00164  */
+00165 typedef struct apr_ldap_opt_tls_cert_t apr_ldap_opt_tls_cert_t;
+00166 struct apr_ldap_opt_tls_cert_t {
+00167     int type;
+00168     const char *path;
+00169     const char *password;
+00170 };
+00171 
+00172 /**
+00173  * APR_LDAP_OPT_TLS
+00174  *
+00175  * This sets the SSL level on the LDAP handle.
+00176  *
+00177  * Netscape/Mozilla:
+00178  * Supports SSL, but not STARTTLS
+00179  * SSL is enabled by calling ldapssl_install_routines().
+00180  *
+00181  * Novell:
+00182  * Supports SSL and STARTTLS.
+00183  * SSL is enabled by calling ldapssl_install_routines(). Note that calling
+00184  * other ldap functions before ldapssl_install_routines() may cause this
+00185  * function to fail.
+00186  * STARTTLS is enabled by calling ldapssl_start_tls_s() after calling
+00187  * ldapssl_install_routines() (check this).
+00188  *
+00189  * OpenLDAP:
+00190  * Supports SSL and supports STARTTLS, but none of this is documented:
+00191  * http://www.openldap.org/lists/openldap-software/200409/msg00618.html
+00192  * Documentation for both SSL support and STARTTLS has been deleted from
+00193  * the OpenLDAP documentation and website.
+00194  */
+00195 
+00196 /** No encryption */
+00197 #define APR_LDAP_NONE 0
+00198 /** SSL encryption (ldaps://) */
+00199 #define APR_LDAP_SSL 1
+00200 /** TLS encryption (STARTTLS) */
+00201 #define APR_LDAP_STARTTLS 2
+00202 /** end TLS encryption (STOPTLS) */
+00203 #define APR_LDAP_STOPTLS 3
+00204 
+00205 /**
+00206  * APR LDAP get option function
+00207  *
+00208  * This function gets option values from a given LDAP session if
+00209  * one was specified. It maps to the native ldap_get_option() function.
+00210  * @param pool The pool to use
+00211  * @param ldap The LDAP handle
+00212  * @param option The LDAP_OPT_* option to return
+00213  * @param outvalue The value returned (if any)
+00214  * @param result_err The apr_ldap_err_t structure contained detailed results
+00215  *        of the operation.
+00216  */
+00217 APU_DECLARE_LDAP(int) apr_ldap_get_option(apr_pool_t *pool,
+00218                                           LDAP *ldap,
+00219                                           int option,
+00220                                           void *outvalue,
+00221                                           apr_ldap_err_t **result_err);
+00222 
+00223 /**
+00224  * APR LDAP set option function
+00225  * 
+00226  * This function sets option values to a given LDAP session if
+00227  * one was specified. It maps to the native ldap_set_option() function.
+00228  * 
+00229  * Where an option is not supported by an LDAP toolkit, this function
+00230  * will try and apply legacy functions to achieve the same effect,
+00231  * depending on the platform.
+00232  * @param pool The pool to use
+00233  * @param ldap The LDAP handle
+00234  * @param option The LDAP_OPT_* option to set
+00235  * @param invalue The value to set
+00236  * @param result_err The apr_ldap_err_t structure contained detailed results
+00237  *        of the operation.
+00238  */
+00239 APU_DECLARE_LDAP(int) apr_ldap_set_option(apr_pool_t *pool,
+00240                                           LDAP *ldap,
+00241                                           int option,
+00242                                           const void *invalue,
+00243                                           apr_ldap_err_t **result_err);
+00244 
+00245 #ifdef __cplusplus
+00246 }
+00247 #endif
+00248 
+00249 #endif /* APR_HAS_LDAP */
+00250 
+00251 /** @} */
+00252 
+00253 #endif /* APR_LDAP_OPTION_H */
+00254 
+

00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
+00002  * contributor license agreements.  See the NOTICE file distributed with
+00003  * this work for additional information regarding copyright ownership.
+00004  * The ASF licenses this file to You under the Apache License, Version 2.0
+00005  * (the "License"); you may not use this file except in compliance with
+00006  * the License.  You may obtain a copy of the License at
+00007  *
+00008  *     http://www.apache.org/licenses/LICENSE-2.0
+00009  *
+00010  * Unless required by applicable law or agreed to in writing, software
+00011  * distributed under the License is distributed on an "AS IS" BASIS,
+00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+00013  * See the License for the specific language governing permissions and
+00014  * limitations under the License.
+00015  */
+00016 
+00017 /**
+00018  * The APR LDAP rebind functions provide an implementation of
+00019  * a rebind procedure that can be used to allow clients to chase referrals,
+00020  * using the same credentials used to log in originally.
+00021  *
+00022  * Use of this implementation is optional.
+00023  *
+00024  * @file apr_ldap_rebind.h
+00025  * @brief Apache LDAP library
+00026  */
+00027 
+00028 #ifndef APU_LDAP_REBIND_H
+00029 #define APU_LDAP_REBIND_H
+00030 
+00031 /**
+00032  * @addtogroup APR_Util_LDAP
+00033  * @{
+00034  **/
+00035 
+00036 #if defined(DOXYGEN)
+00037 #include "apr_ldap.h"
+00038 #endif
+00039 
+00040 /*
+00041  * Handle the case when LDAP is enabled
+00042  */
+00043 #if APR_HAS_LDAP
+00044 
+00045 /**
+00046  * APR LDAP initialize rebind lock
+00047  *
+00048  * This function creates the lock for controlling access to the xref list..
+00049  * @param pool Pool to use when creating the xref_lock.
+00050  */
+00051 APU_DECLARE_LDAP(apr_status_t) apr_ldap_rebind_init(apr_pool_t *pool);
+00052 
+00053 
+00054 /**
+00055  * APR LDAP rebind_add function
+00056  *
+00057  * This function creates a cross reference entry for the specified ldap
+00058  * connection. The rebind callback function will look up this ldap 
+00059  * connection so it can retrieve the bindDN and bindPW for use in any 
+00060  * binds while referrals are being chased.
+00061  *
+00062  * This function will add the callback to the LDAP handle passed in.
+00063  *
+00064  * A cleanup is registered within the pool provided to remove this
+00065  * entry when the pool is removed. Alternatively apr_ldap_rebind_remove()
+00066  * can be called to explicitly remove the entry at will.
+00067  *
+00068  * @param pool The pool to use
+00069  * @param ld The LDAP connectionhandle
+00070  * @param bindDN The bind DN to be used for any binds while chasing 
+00071  *               referrals on this ldap connection.
+00072  * @param bindPW The bind Password to be used for any binds while 
+00073  *               chasing referrals on this ldap connection.
+00074  */
+00075 APU_DECLARE_LDAP(apr_status_t) apr_ldap_rebind_add(apr_pool_t *pool,
+00076                                                    LDAP *ld,
+00077                                                    const char *bindDN,
+00078                                                    const char *bindPW);
+00079 
+00080 /**
+00081  * APR LDAP rebind_remove function
+00082  *
+00083  * This function removes the rebind cross reference entry for the
+00084  * specified ldap connection.
+00085  *
+00086  * If not explicitly removed, this function will be called automatically
+00087  * when the pool is cleaned up.
+00088  *
+00089  * @param ld The LDAP connectionhandle
+00090  */
+00091 APU_DECLARE_LDAP(apr_status_t) apr_ldap_rebind_remove(LDAP *ld);
+00092 
+00093 #endif /* APR_HAS_LDAP */
+00094 
+00095 /** @} */
+00096 
+00097 #endif /* APU_LDAP_REBIND_H */
+00098 
+


Defines
+#define	APR_HAS_LDAP 0
+#define	APR_HAS_NETSCAPE_LDAPSDK 0
+#define	APR_HAS_SOLARIS_LDAPSDK 0
+#define	APR_HAS_NOVELL_LDAPSDK 0
+#define	APR_HAS_MOZILLA_LDAPSDK 0
+#define	APR_HAS_OPENLDAP_LDAPSDK 0
+#define	APR_HAS_MICROSOFT_LDAPSDK 0
+#define	APR_HAS_TIVOLI_LDAPSDK 0
+#define	APR_HAS_ZOS_LDAPSDK 0
+#define	APR_HAS_OTHER_LDAPSDK 0

apr_ldap.h

apr_ldap.h File Reference

Defines

Detailed Description

apr_ldap_init.h

apr_ldap_init.h File Reference

Detailed Description

apr_ldap_option.h

apr_ldap_option.h File Reference

Detailed Description

apr_ldap_rebind.h