granicus.if.org Git - apache/blob - modules/ssl/mod_ssl.h

   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_list() optional function attempts to build an array
  40  * of all the values contained in the named X.509 extension. The
  41  * returned array will be created in the supplied pool.
  42  * The client certificate is used if peer is non-zero; the server
  43  * certificate is used otherwise.
  44  * Extension specifies the extensions to use as a string. This can be
  45  * one of the "known" long or short names, or a numeric OID,
  46  * e.g. "1.2.3.4", 'nsComment' and 'DN' are all valid.
  47  * A pointer to an apr_array_header_t structure is returned if at
  48  * least one matching extension is found, NULL otherwise.
  49  */
  50 APR_DECLARE_OPTIONAL_FN(apr_array_header_t *, ssl_ext_list,
  51                         (apr_pool_t *p, conn_rec *c, int peer,
  52                          const char *extension));
  53
  54 /** An optional function which returns non-zero if the given connection
  55  * is using SSL/TLS. */
  56 APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
  57
  58 /** The ssl_proxy_enable() and ssl_engine_disable() optional functions
  59  * are used by mod_proxy to enable use of SSL for outgoing
  60  * connections. */
  61
  62 APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
  63
  64 APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
  65
  66 #endif /* __MOD_SSL_H__ */
  67 /** @} */