Data Structures | |
struct | apr_ldap_err_t |
struct | apr_ldap_opt_tls_cert_t |
Defines | |
#define | APR_HAS_LDAP 1 |
#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 1 |
#define | APR_HAS_MICROSOFT_LDAPSDK 0 |
#define | APR_HAS_OTHER_LDAPSDK 0 |
#define | APR_HAS_LDAP_SSL 1 |
#define | APR_HAS_LDAP_URL_PARSE 0 |
#define | LDAP_DEPRECATED 1 |
#define | APR_HAS_LDAPSSL_CLIENT_INIT 0 |
#define | APR_HAS_LDAPSSL_CLIENT_DEINIT 0 |
#define | APR_HAS_LDAPSSL_ADD_TRUSTED_CERT 0 |
#define | APR_HAS_LDAP_START_TLS_S 1 |
#define | APR_HAS_LDAP_SSLINIT 0 |
#define | APR_HAS_LDAPSSL_INIT 0 |
#define | APR_HAS_LDAPSSL_INSTALL_ROUTINES 0 |
#define | LDAPS_PORT 636 |
#define | APR_LDAP_OPT_TLS 0x6fff |
#define | APR_LDAP_OPT_TLS_CERT 0x6ffe |
#define | APR_LDAP_OPT_VERIFY_CERT 0x6ffd |
#define | APR_LDAP_CA_TYPE_UNKNOWN 0 |
#define | APR_LDAP_CA_TYPE_DER 1 |
#define | APR_LDAP_CA_TYPE_BASE64 2 |
#define | APR_LDAP_CA_TYPE_CERT7_DB 3 |
#define | APR_LDAP_CA_TYPE_SECMOD 4 |
#define | APR_LDAP_CERT_TYPE_UNKNOWN 5 |
#define | APR_LDAP_CERT_TYPE_DER 6 |
#define | APR_LDAP_CERT_TYPE_BASE64 7 |
#define | APR_LDAP_CERT_TYPE_KEY3_DB 8 |
#define | APR_LDAP_CERT_TYPE_NICKNAME 9 |
#define | APR_LDAP_KEY_TYPE_UNKNOWN 10 |
#define | APR_LDAP_KEY_TYPE_DER 11 |
#define | APR_LDAP_KEY_TYPE_BASE64 12 |
#define | APR_LDAP_CERT_TYPE_PFX 13 |
#define | APR_LDAP_KEY_TYPE_PFX 14 |
#define | APR_LDAP_NONE 0 |
#define | APR_LDAP_SSL 1 |
#define | APR_LDAP_STARTTLS 2 |
#define | APR_LDAP_STOPTLS 3 |
Typedefs | |
typedef apr_ldap_opt_tls_cert_t | apr_ldap_opt_tls_cert_t |
Functions | |
int | apr_ldap_ssl_init (apr_pool_t *pool, const char *cert_auth_file, int cert_file_type, apr_ldap_err_t **result_err) |
int | apr_ldap_ssl_deinit (void) |
int | apr_ldap_init (apr_pool_t *pool, LDAP **ldap, const char *hostname, int portno, int secure, apr_ldap_err_t **result_err) |
int | apr_ldap_info (apr_pool_t *pool, apr_ldap_err_t **result_err) |
int | apr_ldap_get_option (apr_pool_t *pool, LDAP *ldap, int option, void *outvalue, apr_ldap_err_t **result_err) |
int | apr_ldap_set_option (apr_pool_t *pool, LDAP *ldap, int option, const void *invalue, apr_ldap_err_t **result_err) |
#define APR_LDAP_CA_TYPE_BASE64 2 |
PEM encoded CA certificate
#define APR_LDAP_CA_TYPE_CERT7_DB 3 |
Netscape/Mozilla cert7.db CA certificate database
#define APR_LDAP_CA_TYPE_DER 1 |
binary DER encoded CA certificate
#define APR_LDAP_CA_TYPE_SECMOD 4 |
Netscape/Mozilla secmod file
#define APR_LDAP_CA_TYPE_UNKNOWN 0 |
CA certificate type unknown
#define APR_LDAP_CERT_TYPE_BASE64 7 |
PEM encoded client certificate
#define APR_LDAP_CERT_TYPE_DER 6 |
binary DER encoded client certificate
#define APR_LDAP_CERT_TYPE_KEY3_DB 8 |
Netscape/Mozilla key3.db client certificate database
#define APR_LDAP_CERT_TYPE_NICKNAME 9 |
Netscape/Mozilla client certificate nickname
#define APR_LDAP_CERT_TYPE_PFX 13 |
PKCS#12 encoded client certificate
#define APR_LDAP_CERT_TYPE_UNKNOWN 5 |
Client certificate type unknown
#define APR_LDAP_KEY_TYPE_BASE64 12 |
PEM encoded private key
#define APR_LDAP_KEY_TYPE_DER 11 |
binary DER encoded private key
#define APR_LDAP_KEY_TYPE_PFX 14 |
PKCS#12 encoded private key
#define APR_LDAP_KEY_TYPE_UNKNOWN 10 |
Private key type unknown
#define APR_LDAP_NONE 0 |
No encryption
#define APR_LDAP_OPT_TLS 0x6fff |
Set SSL mode to one of APR_LDAP_NONE, APR_LDAP_SSL, APR_LDAP_STARTTLS or APR_LDAP_STOPTLS.
#define APR_LDAP_OPT_TLS_CERT 0x6ffe |
Set zero or more CA certificates, client certificates or private keys globally, or per connection (where supported).
#define APR_LDAP_OPT_VERIFY_CERT 0x6ffd |
Set the LDAP library to no verify the server certificate. This means all servers are considered trusted.
#define APR_LDAP_SSL 1 |
SSL encryption (ldaps://)
#define APR_LDAP_STARTTLS 2 |
TLS encryption (STARTTLS)
#define APR_LDAP_STOPTLS 3 |
end TLS encryption (STOPTLS)
typedef struct apr_ldap_opt_tls_cert_t apr_ldap_opt_tls_cert_t |
Certificate structure.
This structure is used to store certificate details. An array of these structures is passed to apr_ldap_set_option() to set CA and client certificates.
type | Type of certificate APR_LDAP_*_TYPE_* | |
path | Path, file or nickname of the certificate | |
password | Optional password, can be NULL |
int apr_ldap_get_option | ( | apr_pool_t * | pool, | |
LDAP * | ldap, | |||
int | option, | |||
void * | outvalue, | |||
apr_ldap_err_t ** | result_err | |||
) |
APR LDAP get option function
This function gets option values from a given LDAP session if one was specified. It maps to the native ldap_get_option() function.
pool | The pool to use | |
ldap | The LDAP handle | |
option | The LDAP_OPT_* option to return | |
outvalue | The value returned (if any) | |
result_err | The apr_ldap_err_t structure contained detailed results of the operation. |
int apr_ldap_info | ( | apr_pool_t * | pool, | |
apr_ldap_err_t ** | result_err | |||
) |
APR LDAP info function
This function returns a string describing the LDAP toolkit currently in use. The string is placed inside result_err->reason.
pool | The pool to use | |
result_err | The returned result |
int apr_ldap_init | ( | apr_pool_t * | pool, | |
LDAP ** | ldap, | |||
const char * | hostname, | |||
int | portno, | |||
int | secure, | |||
apr_ldap_err_t ** | result_err | |||
) |
APR LDAP initialise function
This function is responsible for initialising an LDAP connection in a toolkit independant way. It does the job of ldap_init() from the C api.
It handles both the SSL and non-SSL case, and attempts to hide the complexity setup from the user. This function assumes that any certificate setup necessary has already been done.
If SSL or STARTTLS needs to be enabled, and the underlying toolkit supports it, the following values are accepted for secure:
APR_LDAP_NONE: No encryption APR_LDAP_SSL: SSL encryption (ldaps://) APR_LDAP_STARTTLS: Force STARTTLS on ldap://
pool | The pool to use | |
ldap | The LDAP handle | |
hostname | The name of the host to connect to. This can be either a DNS name, or an IP address. | |
portno | The port to connect to | |
secure | The security mode to set | |
result_err | The returned result |
int apr_ldap_set_option | ( | apr_pool_t * | pool, | |
LDAP * | ldap, | |||
int | option, | |||
const void * | invalue, | |||
apr_ldap_err_t ** | result_err | |||
) |
APR LDAP set option function
This function sets option values to a given LDAP session if one was specified. It maps to the native ldap_set_option() function.
Where an option is not supported by an LDAP toolkit, this function will try and apply legacy functions to achieve the same effect, depending on the platform.
pool | The pool to use | |
ldap | The LDAP handle | |
option | The LDAP_OPT_* option to set | |
invalue | The value to set | |
result_err | The apr_ldap_err_t structure contained detailed results of the operation. |
int apr_ldap_ssl_deinit | ( | void | ) |
APR LDAP SSL De-Initialise function
This function tears down any SSL certificate setup previously set using apr_ldap_ssl_init(). It should be called to clean up if a graceful restart of a service is attempted.
int apr_ldap_ssl_init | ( | apr_pool_t * | pool, | |
const char * | cert_auth_file, | |||
int | cert_file_type, | |||
apr_ldap_err_t ** | result_err | |||
) |
APR LDAP SSL Initialise function
This function initialises SSL on the underlying LDAP toolkit if this is necessary.
If a CA certificate is provided, this is set, however the setting of certificates via this method has been deprecated and will be removed in APR v2.0.
The apr_ldap_set_option() function with the APR_LDAP_OPT_TLS_CERT option should be used instead to set certificates.
If SSL support is not available on this platform, or a problem was encountered while trying to set the certificate, the function will return APR_EGENERAL. Further LDAP specific error information can be found in result_err.
pool | The pool to use | |
cert_auth_file | The name of the certificate to use, can be NULL | |
cert_file_type | The type of certificate specified. See the apr_ldap_set_option() APR_LDAP_OPT_TLS_CERT option for details. | |
result_err | The returned result |