github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/include/mod_ssl.h (about)

     1  /* Licensed to the Apache Software Foundation (ASF) under one or more
     2   * contributor license agreements.  See the NOTICE file distributed with
     3   * this work for additional information regarding copyright ownership.
     4   * The ASF licenses this file to You under the Apache License, Version 2.0
     5   * (the "License"); you may not use this file except in compliance with
     6   * the License.  You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  /**
    18   * @file mod_ssl.h
    19   * @brief SSL extension module for Apache
    20   *
    21   * @defgroup MOD_SSL mod_ssl
    22   * @ingroup  APACHE_MODS
    23   * @{
    24   */
    25  
    26  #ifndef __MOD_SSL_H__
    27  #define __MOD_SSL_H__
    28  
    29  #include "httpd.h"
    30  #include "apr_optional.h"
    31  
    32  /** The ssl_var_lookup() optional function retrieves SSL environment
    33   * variables. */
    34  APR_DECLARE_OPTIONAL_FN(char *, ssl_var_lookup,
    35                          (apr_pool_t *, server_rec *,
    36                           conn_rec *, request_rec *,
    37                           char *));
    38  
    39  /** The ssl_ext_lookup() optional function retrieves the value of a SSL
    40   * certificate X.509 extension.  The client certificate is used if
    41   * peer is non-zero; the server certificate is used otherwise.  The
    42   * oidnum parameter specifies the numeric OID (e.g. "1.2.3.4") of the
    43   * desired extension.  The string value of the extension is returned,
    44   * or NULL on error. */
    45  APR_DECLARE_OPTIONAL_FN(const char *, ssl_ext_lookup,
    46                          (apr_pool_t *p, conn_rec *c, int peer,
    47                           const char *oidnum));
    48  
    49  /** An optional function which returns non-zero if the given connection
    50   * is using SSL/TLS. */
    51  APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
    52  
    53  /** The ssl_proxy_enable() and ssl_engine_disable() optional functions
    54   * are used by mod_proxy to enable use of SSL for outgoing
    55   * connections. */
    56  
    57  APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
    58  
    59  APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
    60  
    61  APR_DECLARE_OPTIONAL_FN(apr_array_header_t *, ssl_extlist_by_oid, (request_rec *r, const char *oidstr));
    62  
    63  #endif /* __MOD_SSL_H__ */
    64  /** @} */