ap_ldap_rebind.h revision 70fa390b2e3c5cad908ed38289ace42b5c894610
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance/* Licensed to the Apache Software Foundation (ASF) under one or more
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * contributor license agreements. See the NOTICE file distributed with
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * this work for additional information regarding copyright ownership.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * The ASF licenses this file to You under the Apache License, Version 2.0
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * (the "License"); you may not use this file except in compliance with
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * the License. You may obtain a copy of the License at
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * http://www.apache.org/licenses/LICENSE-2.0
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * Unless required by applicable law or agreed to in writing, software
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * distributed under the License is distributed on an "AS IS" BASIS,
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * See the License for the specific language governing permissions and
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * limitations under the License.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * The LDAP rebind functions provide an implementation of
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * a rebind procedure that can be used to allow clients to chase referrals,
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * using the same credentials used to log in originally.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * Use of this implementation is optional.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * @brief Apache LDAP library
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * @addtogroup AP_Util_LDAP
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * Handle the case when LDAP is enabled
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * LDAP initialize rebind lock
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * This function creates the lock for controlling access to the xref list..
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * @param pool Pool to use when creating the xref_lock.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel ManceLDAP_DECLARE(apr_status_t) ap_ldap_rebind_init(apr_pool_t *pool);
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * LDAP rebind_add function
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * This function creates a cross reference entry for the specified ldap
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * connection. The rebind callback function will look up this ldap
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * connection so it can retrieve the bindDN and bindPW for use in any
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * binds while referrals are being chased.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * This function will add the callback to the LDAP handle passed in.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * A cleanup is registered within the pool provided to remove this
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * entry when the pool is removed. Alternatively ap_ldap_rebind_remove()
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * can be called to explicitly remove the entry at will.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * @param pool The pool to use
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * @param ld The LDAP connectionhandle
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * @param bindDN The bind DN to be used for any binds while chasing
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * referrals on this ldap connection.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * @param bindPW The bind Password to be used for any binds while
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * chasing referrals on this ldap connection.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel ManceLDAP_DECLARE(apr_status_t) ap_ldap_rebind_add(apr_pool_t *pool,
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * LDAP rebind_remove function
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * This function removes the rebind cross reference entry for the
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * specified ldap connection.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * If not explicitly removed, this function will be called automatically
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * when the pool is cleaned up.
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance * @param ld The LDAP connectionhandle
137edd3944aacd150d60af8977de962113ead859Felix Gabriel ManceLDAP_DECLARE(apr_status_t) ap_ldap_rebind_remove(LDAP *ld);
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance#endif /* AP_HAS_LDAP */
137edd3944aacd150d60af8977de962113ead859Felix Gabriel Mance#endif /* AP_LDAP_REBIND_H */