util_ldap.h revision 0f60998368b493f90120180a93fc2e1e74490872
1a38107941725211e7c3f051f7a8f5e12199f03acmaeder/* Licensed to the Apache Software Foundation (ASF) under one or more
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly * contributor license agreements. See the NOTICE file distributed with
e9458b1a7a19a63aa4c179f9ab20f4d50681c168Jens Elkner * this work for additional information regarding copyright ownership.
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly * The ASF licenses this file to You under the Apache License, Version 2.0
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly * (the "License"); you may not use this file except in compliance with
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu * the License. You may obtain a copy of the License at
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly * Unless required by applicable law or agreed to in writing, software
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly * distributed under the License is distributed on an "AS IS" BASIS,
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly * See the License for the specific language governing permissions and
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly * limitations under the License.
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder * @brief Apache LDAP library
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder/* APR header files */
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly#define AP_LDAP_IS_SERVER_DOWN(s) ((s) == LDAP_SERVER_DOWN \
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly#define AP_LDAP_IS_SERVER_DOWN(s) ((s) == LDAP_SERVER_DOWN)
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly/* this whole thing disappears if LDAP is not enabled */
1a38107941725211e7c3f051f7a8f5e12199f03acmaeder/* Apache header files */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder/* Create a set of LDAP_DECLARE macros with appropriate export
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * and import tags for the platform
9aeda2b3ae8ce0b018955521e4ca835a8ba8a27bLiam O'Reilly#define LDAP_DECLARE(type) __declspec(dllexport) type __stdcall
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly#define LDAP_DECLARE_NONSTD(type) __declspec(dllexport) type
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder#define LDAP_DECLARE_DATA __declspec(dllexport)
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder#define LDAP_DECLARE(type) __declspec(dllimport) type __stdcall
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder#define LDAP_DECLARE_NONSTD(type) __declspec(dllimport) type
d5833d2ee7bafcbf2fdd2bdfd9a728c769b100c7Christian Maeder#define LDAP_DECLARE_DATA __declspec(dllimport)
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * LDAP Connections
fa373bc327620e08861294716b4454be8d25669fChristian Maeder/* Values that the deref member can have */
fa373bc327620e08861294716b4454be8d25669fChristian Maedertypedef enum {
e8d99f05c231b379be702a1aa8c7dd0b3c666928Liam O'Reilly#define AP_LDAP_DEFAULT_HOPLIMIT 5 /* make sure these two stay */
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder#define AP_LDAP_DEFAULT_HOPLIMIT_STR "5" /* in synch with each other! */
e7cd36335f0f7be9ed5005e71d94c2856b588d62Christian Maeder/* Structure representing an LDAP connection */
e7cd36335f0f7be9ed5005e71d94c2856b588d62Christian Maeder apr_pool_t *pool; /* Pool from which this connection is created */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder apr_thread_mutex_t *lock; /* Lock to indicate this connection is in use */
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder int bound; /* Flag to indicate whether this connection is bound yet */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder const char *host; /* Name of the LDAP server (or space separated list) */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder deref_options deref; /* how to handle alias dereferening */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder const char *binddn; /* DN to bind to server (can be NULL) */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder const char *bindpw; /* Password to bind to server (can be NULL) */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder int secure; /* SSL/TLS mode of the connection */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder apr_array_header_t *client_certs; /* Client certificates on this connection */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder const char *reason; /* Reason for an error failure */
eb48217dfa67ddb87b8fbd846de293d0636bd578Christian Maeder struct util_ldap_state_t *st; /* The LDAP vhost config this connection belongs to */
eb48217dfa67ddb87b8fbd846de293d0636bd578Christian Maeder int keep; /* Will this connection be kept when it's unlocked */
eb48217dfa67ddb87b8fbd846de293d0636bd578Christian Maeder int ChaseReferrals; /* [on|off] (default = AP_LDAP_CHASEREFERRALS_ON)*/
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder int ReferralHopLimit; /* # of referral hops to follow (default = AP_LDAP_DEFAULT_HOPLIMIT) */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder/* LDAP cache state information */
4314e26a12954cb1c9be4dea10aa8103edac5bbbChristian Maeder apr_pool_t *pool; /* pool from which this state is allocated */
ebd23ec61635b0bebf7969d14f65b9d1e39f2b26Liam O'Reilly apr_thread_mutex_t *mutex; /* mutex lock for the connection list */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder apr_size_t cache_bytes; /* Size (in bytes) of shared memory cache */
4314e26a12954cb1c9be4dea10aa8103edac5bbbChristian Maeder long search_cache_ttl; /* TTL for search cache */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder long search_cache_size; /* Size (in entries) of search cache */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder long compare_cache_ttl; /* TTL for compare cache */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder long compare_cache_size; /* Size (in entries) of compare cache */
d5833d2ee7bafcbf2fdd2bdfd9a728c769b100c7Christian Maeder struct util_ldap_connection_t *connections;
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder apr_array_header_t *global_certs; /* Global CA certificates */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder apr_array_header_t *client_certs; /* Client certificates */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder /* cache ald */
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder char *lock_file; /* filename for shm lock mutex */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder/* Used to store arrays of attribute labels/values. */
bcd914850de931848b86d7728192a149f9c0108bChristian Maeder * Open a connection to an LDAP server
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * @param ldc A structure containing the expanded details of the server
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * to connect to. The handle to the LDAP connection is returned
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * as ldc->ldap.
580f1724640a78be687e79d0ec95dd2665e77e91Liam O'Reilly * @tip This function connects to the LDAP server and binds. It does not
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * connect if already connected (ldc->ldap != NULL). Does not bind
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * if already bound.
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @return If successful LDAP_SUCCESS is returned.
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @fn int util_ldap_connection_open(request_rec *r,
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * util_ldap_connection_t *ldc)
f21c7417bdd1c0282025cba0f5cb0ff5bc5c98eeLiam O'ReillyAPR_DECLARE_OPTIONAL_FN(int,uldap_connection_open,(request_rec *r,
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder * Close a connection to an LDAP server
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @param ldc A structure containing the expanded details of the server
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder * that was connected.
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder * @tip This function unbinds from the LDAP server, and clears ldc->ldap.
ee48a7a67da604356b665e51aa7545536a09b737Christian Maeder * It is possible to rebind to this server again using the same ldc
ee48a7a67da604356b665e51aa7545536a09b737Christian Maeder * structure, using apr_ldap_open_connection().
d381ab99d6e2e56e09030577d65d9a118f246d35Christian Maeder * @fn util_ldap_close_connection(util_ldap_connection_t *ldc)
ee48a7a67da604356b665e51aa7545536a09b737Christian MaederAPR_DECLARE_OPTIONAL_FN(void,uldap_connection_close,(util_ldap_connection_t *ldc));
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * Unbind a connection to an LDAP server
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @param ldc A structure containing the expanded details of the server
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * that was connected.
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * @tip This function unbinds the LDAP connection, and disconnects from
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * the server. It is used during error conditions, to bring the LDAP
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * connection back to a known state.
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * @fn apr_status_t util_ldap_connection_unbind(util_ldap_connection_t *ldc)
580f1724640a78be687e79d0ec95dd2665e77e91Liam O'ReillyAPR_DECLARE_OPTIONAL_FN(apr_status_t,uldap_connection_unbind,(void *param));
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * Cleanup a connection to an LDAP server
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @param ldc A structure containing the expanded details of the server
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * that was connected.
7d96b1ef2b8597330aedee6713615ec15508edcfLiam O'Reilly * @tip This functions unbinds and closes the connection to the LDAP server
7d96b1ef2b8597330aedee6713615ec15508edcfLiam O'Reilly * @fn apr_status_t util_ldap_connection_cleanup(util_ldap_connection_t *ldc)
7d96b1ef2b8597330aedee6713615ec15508edcfLiam O'ReillyAPR_DECLARE_OPTIONAL_FN(apr_status_t,uldap_connection_cleanup,(void *param));
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * Find a connection in a list of connections
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * @param r The request record
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * @param host The hostname to connect to (multiple hosts space separated)
f19dc06364e8d6ea36f7c170e1f7a0677de63184Liam O'Reilly * @param port The port to connect to
f19dc06364e8d6ea36f7c170e1f7a0677de63184Liam O'Reilly * @param binddn The DN to bind with
f19dc06364e8d6ea36f7c170e1f7a0677de63184Liam O'Reilly * @param bindpw The password to bind with
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * @param deref The dereferencing behavior
f19dc06364e8d6ea36f7c170e1f7a0677de63184Liam O'Reilly * @param secure use SSL on the connection
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly * @tip Once a connection is found and returned, a lock will be acquired to
f19dc06364e8d6ea36f7c170e1f7a0677de63184Liam O'Reilly * lock that particular connection, so that another thread does not try and
f19dc06364e8d6ea36f7c170e1f7a0677de63184Liam O'Reilly * use this connection while it is busy. Once you are finished with a connection,
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * apr_ldap_connection_close() must be called to release this connection.
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder * @fn util_ldap_connection_t *util_ldap_connection_find(request_rec *r, const char *host, int port,
3d3889e0cefcdce9b3f43c53aaa201943ac2e895Jonathan von Schroeder * const char *binddn, const char *bindpw, deref_options deref,
ee48a7a67da604356b665e51aa7545536a09b737Christian Maeder * int netscapessl, int starttls)
ee48a7a67da604356b665e51aa7545536a09b737Christian MaederAPR_DECLARE_OPTIONAL_FN(util_ldap_connection_t *,uldap_connection_find,(request_rec *r, const char *host, int port,
ee48a7a67da604356b665e51aa7545536a09b737Christian Maeder const char *binddn, const char *bindpw, deref_options deref,
45e2bc90dd11147156ddd7f9651ce8b2ec00f2a1Christian Maeder * Compare two DNs for sameness
45e2bc90dd11147156ddd7f9651ce8b2ec00f2a1Christian Maeder * @param r The request record
ee48a7a67da604356b665e51aa7545536a09b737Christian Maeder * @param ldc The LDAP connection being used.
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @param url The URL of the LDAP connection - used for deciding which cache to use.
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @param dn The first DN to compare.
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @param reqdn The DN to compare the first DN to.
f19dc06364e8d6ea36f7c170e1f7a0677de63184Liam O'Reilly * @param compare_dn_on_server Flag to determine whether the DNs should be checked using
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder * LDAP calls or with a direct string comparision. A direct
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * string comparison is faster, but not as accurate - false
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * negative comparisons are possible.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @tip Two DNs can be equal and still fail a string comparison. Eg "dc=example,dc=com"
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * and "dc=example, dc=com". Use the compare_dn_on_server unless there are serious
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * performance issues.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @fn int util_ldap_cache_comparedn(request_rec *r, util_ldap_connection_t *ldc,
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * const char *url, const char *dn, const char *reqdn,
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * int compare_dn_on_server)
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian MaederAPR_DECLARE_OPTIONAL_FN(int,uldap_cache_comparedn,(request_rec *r, util_ldap_connection_t *ldc,
fa373bc327620e08861294716b4454be8d25669fChristian Maeder const char *url, const char *dn, const char *reqdn,
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * A generic LDAP compare function
b1f12c962a6fb28a298b36cf6a1dcf2ad788fb58Christian Maeder * @param r The request record
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param ldc The LDAP connection being used.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param url The URL of the LDAP connection - used for deciding which cache to use.
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder * @param dn The DN of the object in which we do the compare.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param attrib The attribute within the object we are comparing for.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param value The value of the attribute we are trying to compare for.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @tip Use this function to determine whether an attribute/value pair exists within an
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * object. Typically this would be used to determine LDAP top-level group
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * membership.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @fn int util_ldap_cache_compare(request_rec *r, util_ldap_connection_t *ldc,
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * const char *url, const char *dn, const char *attrib, const char *value)
fa373bc327620e08861294716b4454be8d25669fChristian MaederAPR_DECLARE_OPTIONAL_FN(int,uldap_cache_compare,(request_rec *r, util_ldap_connection_t *ldc,
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder const char *url, const char *dn, const char *attrib, const char *value));
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * An LDAP function that checks if the specified user is a member of a subgroup.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param r The request record
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param ldc The LDAP connection being used.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param url The URL of the LDAP connection - used for deciding which cache to use.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param dn The DN of the object in which we find subgroups to search within.
aa4d26536fffe0153cd81d28925985892ac2f300Christian Maeder * @param attrib The attribute within group objects that identify users.
aa4d26536fffe0153cd81d28925985892ac2f300Christian Maeder * @param value The user attribute value we are trying to compare for.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param subgroupAttrs The attributes within group objects that identify subgroups.
aa4d26536fffe0153cd81d28925985892ac2f300Christian Maeder * Array of strings.
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder * @param subgroupclasses The objectClass values used to identify groups (and
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * subgroups). apr_array_header_t *.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param cur_subgroup_depth Current recursive depth during subgroup processing.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * @param max_subgroup_depth Maximum depth of recursion allowed during subgroup
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * processing.
56899f6457976a2ee20f6a23f088cb5655b15715Liam O'Reilly * @tip Use this function to determine whether an attribute/value pair exists within a
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * starting group object or one of its nested subgroups. Typically this would be
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * used to determine LDAP nested group membership.
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * @deffunc int util_ldap_cache_check_subgroups(request_rec *r, util_ldap_connection_t
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * *ldc, const char *url, const char *dn,
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder * const char *attrib, const char value,
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder * char **subgroupAttrs, apr_array_header_t
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * *subgroupclasses, int cur_subgroup_depth, int
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * max_subgroup_depth )
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian MaederAPR_DECLARE_OPTIONAL_FN(int,uldap_cache_check_subgroups,(request_rec *r, util_ldap_connection_t *ldc,
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder const char *url, const char *dn, const char *attrib, const char *value,
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder char **subgroupAttrs, apr_array_header_t *subgroupclasses,
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder int cur_subgroup_depth, int max_subgroup_depth));
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * Checks a username/password combination by binding to the LDAP server
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * @param r The request record
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * @param ldc The LDAP connection being used.
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder * @param url The URL of the LDAP connection - used for deciding which cache to use.
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * @param basedn The Base DN to search for the user in.
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * @param scope LDAP scope of the search.
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder * @param attrs LDAP attributes to return in search.
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder * @param filter The user to search for in the form of an LDAP filter. This filter must return
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder * exactly one user for the check to be successful.
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder * @param bindpw The user password to bind as.
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder * @param binddn The DN of the user will be returned in this variable.
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder * @param retvals The values corresponding to the attributes requested in the attrs array.
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder * @tip The filter supplied will be searched for. If a single entry is returned, an attempt
ace03c3051e5c5144e43ae78cae73f6a29dde6d5Christian Maeder * is made to bind as that user. If this bind succeeds, the user is not validated.
ace03c3051e5c5144e43ae78cae73f6a29dde6d5Christian Maeder * @fn int util_ldap_cache_checkuserid(request_rec *r, util_ldap_connection_t *ldc,
ace03c3051e5c5144e43ae78cae73f6a29dde6d5Christian Maeder * char *url, const char *basedn, int scope, char **attrs,
ace03c3051e5c5144e43ae78cae73f6a29dde6d5Christian Maeder * char *filter, char *bindpw, char **binddn, char ***retvals)
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian MaederAPR_DECLARE_OPTIONAL_FN(int,uldap_cache_checkuserid,(request_rec *r, util_ldap_connection_t *ldc,
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder const char *url, const char *basedn, int scope, char **attrs,
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder const char *filter, const char *bindpw, const char **binddn, const char ***retvals));
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * Searches for a specified user object in an LDAP directory
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * @param r The request record
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * @param ldc The LDAP connection being used.
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * @param url The URL of the LDAP connection - used for deciding which cache to use.
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * @param basedn The Base DN to search for the user in.
8e9c3881fb6e710b1e08bf5ac8ff9d393df2e74eChristian Maeder * @param scope LDAP scope of the search.
8e9c3881fb6e710b1e08bf5ac8ff9d393df2e74eChristian Maeder * @param attrs LDAP attributes to return in search.
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * @param filter The user to search for in the form of an LDAP filter. This filter must return
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * exactly one user for the check to be successful.
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maeder * @param binddn The DN of the user will be returned in this variable.
d381ab99d6e2e56e09030577d65d9a118f246d35Christian Maeder * @param retvals The values corresponding to the attributes requested in the attrs array.
d381ab99d6e2e56e09030577d65d9a118f246d35Christian Maeder * @tip The filter supplied will be searched for. If a single entry is returned, an attempt
d381ab99d6e2e56e09030577d65d9a118f246d35Christian Maeder * is made to bind as that user. If this bind succeeds, the user is not validated.
580f1724640a78be687e79d0ec95dd2665e77e91Liam O'Reilly * @fn int util_ldap_cache_getuserdn(request_rec *r, util_ldap_connection_t *ldc,
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * char *url, const char *basedn, int scope, char **attrs,
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * char *filter, char **binddn, char ***retvals)
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian MaederAPR_DECLARE_OPTIONAL_FN(int,uldap_cache_getuserdn,(request_rec *r, util_ldap_connection_t *ldc,
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder const char *url, const char *basedn, int scope, char **attrs,
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder const char *filter, const char **binddn, const char ***retvals));
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * Checks if SSL support is available in mod_ldap
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * @fn int util_ldap_ssl_supported(request_rec *r)
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian MaederAPR_DECLARE_OPTIONAL_FN(int,uldap_ssl_supported,(request_rec *r));
bcd914850de931848b86d7728192a149f9c0108bChristian Maeder * Init the LDAP cache
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * @param pool The pool to use to initialise the cache
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * @param reqsize The size of the shared memory segement to request. A size
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * of zero requests the max size possible from
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * apr_shmem_init()
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * @fn void util_ldap_cache_init(apr_pool_t *p, util_ldap_state_t *st)
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * @return The status code returned is the status code of the
a00461fcf7432205a79a0f12dbe6c1ebc58bc000Christian Maeder * apr_smmem_init() call. Regardless of the status, the cache
9e5f4073e948104307d43c3962d624b8416f191fLiam O'Reilly * will be set up at least for in-process or in-thread operation.
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reillyapr_status_t util_ldap_cache_init(apr_pool_t *pool, util_ldap_state_t *st);
bcd914850de931848b86d7728192a149f9c0108bChristian Maeder * Display formatted stats for cache
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * @param The pool to allocate the returned string from
eb48217dfa67ddb87b8fbd846de293d0636bd578Christian Maeder * @tip This function returns a string allocated from the provided pool that describes
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * various stats about the cache.
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * @fn char *util_ald_cache_display(apr_pool_t *pool, util_ldap_state_t *st)
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reillychar *util_ald_cache_display(request_rec *r, util_ldap_state_t *st);
bcd914850de931848b86d7728192a149f9c0108bChristian Maeder#endif /* APR_HAS_LDAP */
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly#endif /* UTIL_LDAP_H */