include/apr_ldap_option.h

Go to the documentation of this file.

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef APR_LDAP_OPTION_H
#define APR_LDAP_OPTION_H

#include "apr_ldap.h"

#if APR_HAS_LDAP

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/*
 * The following defines handle the different TLS certificate
 * options available. If these options are missing, APR will try and
 * emulate support for this using the deprecated ldap_start_tls_s()
 * function.
 */
#define APR_LDAP_OPT_TLS 0x6fff

#define APR_LDAP_OPT_TLS_CERT 0x6ffe

#define APR_LDAP_OPT_VERIFY_CERT 0x6ffd

#define APR_LDAP_OPT_REFERRALS 0x6ffc

#define APR_LDAP_OPT_REFHOPLIMIT 0x6ffb

#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_CA_TYPE_CACERTDIR_BASE64 15


typedef struct apr_ldap_opt_tls_cert_t apr_ldap_opt_tls_cert_t;
struct apr_ldap_opt_tls_cert_t {
    int type;
    const char *path;
    const char *password;
};

#define APR_LDAP_NONE 0

#define APR_LDAP_SSL 1

#define APR_LDAP_STARTTLS 2

#define APR_LDAP_STOPTLS 3

APU_DECLARE_LDAP(int) apr_ldap_get_option(apr_pool_t *pool,
                                          LDAP *ldap,
                                          int option,
                                          void *outvalue,
                                          apr_ldap_err_t **result_err);

APU_DECLARE_LDAP(int) apr_ldap_set_option(apr_pool_t *pool,
                                          LDAP *ldap,
                                          int option,
                                          const void *invalue,
                                          apr_ldap_err_t **result_err);

#ifdef __cplusplus
}
#endif

#endif /* APR_HAS_LDAP */

#endif /* APR_LDAP_OPTION_H */