0 +li~JClqA ˪bѿ O_I|+:/* 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. */ /** * @file http_ssl.h * @brief SSL protocol handling * * @defgroup APACHE_CORE_PROTO SSL Protocol Handling * @ingroup APACHE_CORE * @{ */ #ifndef APACHE_HTTP_SSL_H #define APACHE_HTTP_SSL_H #include "httpd.h" #include "apr_portable.h" #include "apr_mmap.h" #ifdef __cplusplus extern "C" { #endif struct ap_conf_vector_t; /** * This hook allows modules that manage SSL connection to register their * inquiry function for checking if a connection is using SSL from them. * @param c The current connection * @return OK if the connection is using SSL, DECLINED if not. * @ingroup hooks */ AP_DECLARE_HOOK(int,ssl_conn_is_ssl,(conn_rec *c)) /** * Return != 0 iff the connection is encrypted with SSL. * @param c the connection */ AP_DECLARE(int) ap_ssl_conn_is_ssl(conn_rec *c); /** * This hook declares a connection to be outgoing and the configuration that applies to it. * This hook can be called several times in the lifetime of an outgoing connection, e.g. * when it is re-used in different request contexts. It will at least be called after the * connection was created and before the pre-connection hooks is invoked. * All outgoing-connection hooks are run until one returns something other than DECLINE. * if enable_ssl != 0, a hook that sets up SSL for the connection needs to return OK * to prevent subsequent hooks from doing the same. * * @param c The connection on which requests/data are to be sent. * @param dir_conf The directory configuration in which this connection is being used. * @param enable_ssl If != 0, the SSL protocol should be enabled for this connection. * @return DECLINED, OK when ssl was enabled */ AP_DECLARE_HOOK(int, ssl_bind_outgoing, (conn_rec *c, struct ap_conf_vector_t *dir_conf, int enable_ssl)) /** * Assures the connection is marked as outgoing and invokes the ssl_bind_outgoing hook. * This may be called several times on an outgoing connection with varying dir_conf * values. require_ssl is not allowed to change on the same connection. * * @param c The connection on which requests/data are to be sent. * @param dir_conf The directory configuration in which this connection is being used. * @param require_ssl != 0 iff this connection needs to be secured by SSL/TLS protocol. * @return OK iff ssl was required and is enabled, DECLINED otherwise */ AP_DECLARE(int) ap_ssl_bind_outgoing(conn_rec *c, struct ap_conf_vector_t *dir_conf, int require_ssl); /** * Return != 0 iff handlers/hooks for outgoing connections are registered. */ AP_DECLARE(int) ap_ssl_has_outgoing_handlers(void); /** * This hook allows modules to look up SSL related variables for a * server/connection/request, depending on what they inquire. Some * variables will only be available for a connection/request, for example. * @param p The pool to allocate a returned value in, MUST be provided * @param s The server to inquire a value for, maybe NULL * @param c The current connection, maybe NULL * @param r The current request, maybe NULL * @param name The name of the variable to retrieve, MUST be provided * @return value or the variable or NULL if not provided/available * @ingroup hooks */ AP_DECLARE