SSLValve (Apache Tomcat 11.0.24 API Documentation)
Description: declaration: package: org.apache.catalina.valves, class: SSLValve

# Class SSLValve

java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
org.apache.catalina.valves.ValveBase
org.apache.catalina.valves.SSLValve

All Implemented Interfaces:
  `MBeanRegistration, Contained, JmxEnabled, Lifecycle, Valve`

public class SSLValve extends ValveBase
When using mod_proxy_http, the client SSL information is not included in the protocol (unlike mod_jk and mod_proxy_ajp). To make the client SSL information available to Tomcat, some additional configuration is required. In httpd, mod_headers is used to add the SSL information as HTTP headers. In Tomcat, this valve is used to read the information from the HTTP headers and insert it into the request.

Note: Ensure that the headers are always set by httpd for all requests to prevent a client spoofing SSL information by sending fake headers.

In httpd.conf add the following:

    <IfModule ssl_module>
      RequestHeader set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s"
      RequestHeader set SSL_SECURE_PROTOCOL "%{SSL_PROTOCOL}s"
      RequestHeader set SSL_CIPHER "%{SSL_CIPHER}s"
      RequestHeader set SSL_SESSION_ID "%{SSL_SESSION_ID}s"
      RequestHeader set SSL_CIPHER_USEKEYSIZE "%{SSL_CIPHER_USEKEYSIZE}s"
    </IfModule>

In server.xml, configure this valve under the Engine element in server.xml:

    <Engine ...>
      <Valve className="org.apache.catalina.valves.SSLValve" />
      <Host ... />
    </Engine>

- ## Nested Class Summary

  ### Nested classes/interfaces inherited from interface Lifecycle

  `Lifecycle.SingleUse`

- ## Field Summary

  ### Fields inherited from class ValveBase

  `asyncSupported, container, containerLog, next, sm`

  ### Fields inherited from interface Lifecycle

  `AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SSLValve()`
  Default constructor.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getSslCipherHeader()`
  Returns the header name used to retrieve the cipher suite.
  `String`
  `getSslCipherUserKeySizeHeader()`
  Returns the header name used to retrieve the cipher key size.
  `String`
  `getSslClientCertHeader()`
  Returns the header name used to retrieve the client certificate.
  `String`
  `getSslClientEscapedCertHeader()`
  Returns the header name used to retrieve the escaped client certificate.
  `String`
  `getSslSecureProtocolHeader()`
  Returns the header name used to retrieve the secure protocol.
  `String`
  `getSslSessionIdHeader()`
  Returns the header name used to retrieve the SSL session ID.
  `void`
  `invoke(Request request, Response response)`
  Perform request processing as required by this Valve.
  `String`
  `mygetHeader(Request request, String header)`
  Retrieves the value of the specified header from the request, handling null and "(null)" values.
  `void`
  `setSslCipherHeader(String sslCipherHeader)`
  Sets the header name used to retrieve the cipher suite.
  `void`
  `setSslCipherUserKeySizeHeader(String sslCipherUserKeySizeHeader)`
  Sets the header name used to retrieve the cipher key size.
  `void`
  `setSslClientCertHeader(String sslClientCertHeader)`
  Sets the header name used to retrieve the client certificate.
  `void`
  `setSslClientEscapedCertHeader(String sslClientEscapedCertHeader)`
  Sets the header name used to retrieve the escaped client certificate.
  `void`
  `setSslSecureProtocolHeader(String sslSecureProtocolHeader)`
  Sets the header name used to retrieve the secure protocol.
  `void`
  `setSslSessionIdHeader(String sslSessionIdHeader)`
  Sets the header name used to retrieve the SSL session ID.

  ### Methods inherited from class ValveBase

  `backgroundProcess, getContainer, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setContainer, setNext, startInternal, stopInternal, toString`

  ### Methods inherited from class LifecycleMBeanBase

  `destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister`

  ### Methods inherited from class LifecycleBase

  `addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop`

  ### Methods inherited from class Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### SSLValve

    public SSLValve()
    Default constructor.

- ## Method Details

  - ### getSslClientCertHeader

    public String getSslClientCertHeader()
    Returns the header name used to retrieve the client certificate.
    Returns:
      The client certificate header name

  - ### setSslClientCertHeader

    public void setSslClientCertHeader(String sslClientCertHeader)
    Sets the header name used to retrieve the client certificate.
    Parameters:
      `sslClientCertHeader` - The client certificate header name

  - ### getSslClientEscapedCertHeader

    public String getSslClientEscapedCertHeader()
    Returns the header name used to retrieve the escaped client certificate.
    Returns:
      The escaped client certificate header name

  - ### setSslClientEscapedCertHeader

    public void setSslClientEscapedCertHeader(String sslClientEscapedCertHeader)
    Sets the header name used to retrieve the escaped client certificate.
    Parameters:
      `sslClientEscapedCertHeader` - The escaped client certificate header name

  - ### getSslSecureProtocolHeader

    public String getSslSecureProtocolHeader()
    Returns the header name used to retrieve the secure protocol.
    Returns:
      The secure protocol header name

  - ### setSslSecureProtocolHeader

    public void setSslSecureProtocolHeader(String sslSecureProtocolHeader)
    Sets the header name used to retrieve the secure protocol.
    Parameters:
      `sslSecureProtocolHeader` - The secure protocol header name

  - ### getSslCipherHeader

    public String getSslCipherHeader()
    Returns the header name used to retrieve the cipher suite.
    Returns:
      The cipher header name

  - ### setSslCipherHeader

    public void setSslCipherHeader(String sslCipherHeader)
    Sets the header name used to retrieve the cipher suite.
    Parameters:
      `sslCipherHeader` - The cipher header name

  - ### getSslSessionIdHeader

    public String getSslSessionIdHeader()
    Returns the header name used to retrieve the SSL session ID.
    Returns:
      The session ID header name

  - ### setSslSessionIdHeader

    public void setSslSessionIdHeader(String sslSessionIdHeader)
    Sets the header name used to retrieve the SSL session ID.
    Parameters:
      `sslSessionIdHeader` - The session ID header name

  - ### getSslCipherUserKeySizeHeader

    public String getSslCipherUserKeySizeHeader()
    Returns the header name used to retrieve the cipher key size.
    Returns:
      The cipher key size header name

  - ### setSslCipherUserKeySizeHeader

    public void setSslCipherUserKeySizeHeader(String sslCipherUserKeySizeHeader)
    Sets the header name used to retrieve the cipher key size.
    Parameters:
      `sslCipherUserKeySizeHeader` - The cipher key size header name

  - ### mygetHeader

    public String mygetHeader(Request request, String header)
    Retrieves the value of the specified header from the request, handling null and "(null)" values.
    Parameters:
      `request` - The request object
      `header` - The header name to retrieve
    Returns:
      The header value, or null if not present or equal to "(null)"

  - ### invoke

    public void invoke(Request request, Response response) throws IOException, ServletException
    Description copied from interface: `Valve`

    Perform request processing as required by this Valve.

    An individual Valve MAY perform the following actions, in the specified order:

    - Examine and/or modify the properties of the specified Request and Response.
    - Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller.
    - Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on.
    - If the corresponding Response was not generated (and control was not returned), call the next Valve in the pipeline (if there is one) by executing `getNext().invoke()`.
    - Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve or Container).

    A Valve MUST NOT do any of the following things:

    - Change request properties that have already been used to direct the flow of processing control for this request (for instance, trying to change the virtual host to which a Request should be sent from a pipeline attached to a Host or Context in the standard implementation).
    - Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline.
    - Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on.
    - Modify the HTTP headers included with the Response after the `getNext().invoke()` method has returned.
    - Perform any actions on the output stream associated with the specified Response after the `getNext().invoke()` method has returned.
    Parameters:
      `request` - The servlet request to be processed
      `response` - The servlet response to be created
    Throws:
      `IOException` - if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet
      `ServletException` - if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet