SSLContext (Apache Tomcat 7.0.104 API Documentation)

org.apache.tomcat.jni

## Class SSLContext

- java.lang.Object
- - org.apache.tomcat.jni.SSLContext

-     public final class SSLContext
      extends Object

  SSL Context
  Author:
    Mladen Turk

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `SSLContext()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static void` | `clearOptions(long ctx, int options)` Clears OpenSSL Options.
    `static int` | `free(long ctx)` Free the resources used by the Context
    `static long` | `make(long pool, int protocol, int mode)` Create a new SSL context.
    `static void` | `setBIO(long ctx, long bio, int dir)` Associate BIOCallback for input or output data capture.
    `static boolean` | `setCACertificate(long ctx, String file, String path)` Set File and Directory of concatenated PEM-encoded CA Certificates for Client Auth This directive sets the all-in-one file where you can assemble the Certificates of Certification Authorities (CA) whose clients you deal with.
    `static boolean` | `setCARevocation(long ctx, String file, String path)` Set File of concatenated PEM-encoded CA CRLs or directory of PEM-encoded CA Certificates for Client Auth This directive sets the all-in-one file where you can assemble the Certificate Revocation Lists (CRL) of Certification Authorities (CA) whose clients you deal with.
    `static boolean` | `setCertificate(long ctx, String cert, String key, String password, int idx)` Set Certificate Point setCertificateFile at a PEM encoded certificate.
    `static boolean` | `setCertificateChainFile(long ctx, String file, boolean skipfirst)` Set File of PEM-encoded Server CA Certificates This directive sets the optional all-in-one file where you can assemble the certificates of Certification Authorities (CA) which form the certificate chain of the server certificate.
    `static boolean` | `setCipherSuite(long ctx, String ciphers)` Cipher Suite available for negotiation in SSL handshake.
    `static void` | `setContextId(long ctx, String id)` Set Session context id.
    `static void` | `setOptions(long ctx, int options)` Set OpenSSL Option.
    `static void` | `setQuietShutdown(long ctx, boolean mode)` Sets the "quiet shutdown" flag for ctx to be mode.
    `static void` | `setRandom(long ctx, String file)` Set file for randomness
    `static void` | `setShutdownType(long ctx, int type)` Set SSL connection shutdown type The following levels are available for level: SSL_SHUTDOWN_TYPE_STANDARD SSL_SHUTDOWN_TYPE_UNCLEAN SSL_SHUTDOWN_TYPE_ACCURATE
    `static void` | `setVerify(long ctx, int level, int depth)` Set Type of Client Certificate verification and Maximum depth of CA Certificates in Client Certificate verification.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### SSLContext

          public SSLContext()

  - ### Method Detail

    - #### make

          public static long make(long pool,
                  int protocol,
                  int mode)
                           throws Exception

      Create a new SSL context.
      Parameters:
        `pool` - The pool to use.
        `protocol` - The SSL protocol to use. It can be any combination of the following:

             SSL.SSL_PROTOCOL_SSLV2
             SSL.SSL_PROTOCOL_SSLV3
             SSL.SSL_PROTOCOL_TLSV1
             SSL.SSL_PROTOCOL_TLSV1_1
             SSL.SSL_PROTOCOL_TLSV1_2
             SSL.SSL_PROTOCOL_TLSV1_3
             SSL.SSL_PROTOCOL_ALL ( == all TLS versions, no SSL)

        `mode` - SSL mode to use

             SSL_MODE_CLIENT
             SSL_MODE_SERVER
             SSL_MODE_COMBINED

      Returns:
        The Java representation of a pointer to the newly created SSL Context
      Throws:
        `Exception` - If the SSL Context could not be created

    - #### free

          public static int free(long ctx)

      Free the resources used by the Context
      Parameters:
        `ctx` - Server or Client context to free.
      Returns:
        APR Status code.

    - #### setContextId

          public static void setContextId(long ctx,
                          String id)

      Set Session context id. Usually host:port combination.
      Parameters:
        `ctx` - Context to use.
        `id` - String that uniquely identifies this context.

    - #### setBIO

          public static void setBIO(long ctx,
                    long bio,
                    int dir)

      Associate BIOCallback for input or output data capture.
      First word in the output string will contain error level in the form:

           [ERROR]  -- Critical error messages
           [WARN]   -- Warning messages
           [INFO]   -- Informational messages
           [DEBUG]  -- Debugging messaged

      Callback can use that word to determine application logging level by intercepting write call. If the bio is set to 0 no error messages will be displayed. Default is to use the stderr output stream.
      Parameters:
        `ctx` - Server or Client context to use.
        `bio` - BIO handle to use, created with SSL.newBIO
        `dir` - BIO direction (1 for input 0 for output).

    - #### setOptions

          public static void setOptions(long ctx,
                        int options)

      Set OpenSSL Option.
      Parameters:
        `ctx` - Server or Client context to use.
        `options` - See SSL.SSL_OP_* for option flags.

    - #### clearOptions

          public static void clearOptions(long ctx,
                          int options)

      Clears OpenSSL Options.
      Parameters:
        `ctx` - Server or Client context to use.
        `options` - See SSL.SSL_OP_* for option flags.

    - #### setQuietShutdown

          public static void setQuietShutdown(long ctx,
                              boolean mode)

      Sets the "quiet shutdown" flag for ctx to be mode. SSL objects created from ctx inherit the mode valid at the time and may be 0 or 1.
      Normally when an SSL connection is finished, the parties must send out "close notify" alert messages using L<SSL_shutdown(3)|SSL_shutdown(3)> for a clean shutdown.
      When setting the "quiet shutdown" flag to 1, SSL.shutdown will set the internal flags to SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN. (SSL_shutdown then behaves like called with SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.) The session is thus considered to be shutdown, but no "close notify" alert is sent to the peer. This behaviour violates the TLS standard. The default is normal shutdown behaviour as described by the TLS standard.
      Parameters:
        `ctx` - Server or Client context to use.
        `mode` - True to set the quiet shutdown.

    - #### setCipherSuite

          public static boolean setCipherSuite(long ctx,
                               String ciphers)
                                        throws Exception

      Cipher Suite available for negotiation in SSL handshake.
      This complex directive uses a colon-separated cipher-spec string consisting of OpenSSL cipher specifications to configure the Cipher Suite the client is permitted to negotiate in the SSL handshake phase. Notice that this directive can be used both in per-server and per-directory context. In per-server context it applies to the standard SSL handshake when a connection is established. In per-directory context it forces an SSL renegotiation with the reconfigured Cipher Suite after the HTTP request was read but before the HTTP response is sent.
      Parameters:
        `ctx` - Server or Client context to use.
        `ciphers` - An OpenSSL cipher specification.
      Returns:
        `true` if the operation was successful
      Throws:
        `Exception` - An error occurred

    - #### setCARevocation

          public static boolean setCARevocation(long ctx,
                                String file,
                                String path)
                                         throws Exception

      Set File of concatenated PEM-encoded CA CRLs or directory of PEM-encoded CA Certificates for Client Auth
      This directive sets the all-in-one file where you can assemble the Certificate Revocation Lists (CRL) of Certification Authorities (CA) whose clients you deal with. These are used for Client Authentication. Such a file is simply the concatenation of the various PEM-encoded CRL files, in order of preference.
      The files in this directory have to be PEM-encoded and are accessed through hash filenames. So usually you can't just place the Certificate files there: you also have to create symbolic links named hash-value.N. And you should always make sure this directory contains the appropriate symbolic links. Use the Makefile which comes with mod_ssl to accomplish this task.
      Parameters:
        `ctx` - Server or Client context to use.
        `file` - File of concatenated PEM-encoded CA CRLs for Client Auth.
        `path` - Directory of PEM-encoded CA Certificates for Client Auth.
      Returns:
        `true` if the operation was successful
      Throws:
        `Exception` - An error occurred

    - #### setCertificateChainFile

          public static boolean setCertificateChainFile(long ctx,
                                        String file,
                                        boolean skipfirst)

      Set File of PEM-encoded Server CA Certificates
      This directive sets the optional all-in-one file where you can assemble the certificates of Certification Authorities (CA) which form the certificate chain of the server certificate. This starts with the issuing CA certificate of of the server certificate and can range up to the root CA certificate. Such a file is simply the concatenation of the various PEM-encoded CA Certificate files, usually in certificate chain order.
      But be careful: Providing the certificate chain works only if you are using a single (either RSA or DSA) based server certificate. If you are using a coupled RSA+DSA certificate pair, this will work only if actually both certificates use the same certificate chain. Else the browsers will be confused in this situation.
      Parameters:
        `ctx` - Server or Client context to use.
        `file` - File of PEM-encoded Server CA Certificates.
        `skipfirst` - Skip first certificate if chain file is inside certificate file.
      Returns:
        `true` if the operation was successful

    - #### setCertificate

          public static boolean setCertificate(long ctx,
                               String cert,
                               String key,
                               String password,
                               int idx)
                                        throws Exception

      Set Certificate
      Point setCertificateFile at a PEM encoded certificate. If the certificate is encrypted, then you will be prompted for a pass phrase. Note that a kill -HUP will prompt again. A test certificate can be generated with `make certificate' under built time. Keep in mind that if you've both a RSA and a DSA certificate you can configure both in parallel (to also allow the use of DSA ciphers, etc.)
      If the key is not combined with the certificate, use key param to point at the key file. Keep in mind that if you've both a RSA and a DSA private key you can configure both in parallel (to also allow the use of DSA ciphers, etc.)
      Parameters:
        `ctx` - Server or Client context to use.
        `cert` - Certificate file.
        `key` - Private Key file to use if not in cert.
        `password` - Certificate password. If null and certificate is encrypted, password prompt will be displayed.
        `idx` - Certificate index SSL_AIDX_RSA or SSL_AIDX_DSA.
      Returns:
        `true` if the operation was successful
      Throws:
        `Exception` - An error occurred

    - #### setCACertificate

          public static boolean setCACertificate(long ctx,
                                 String file,
                                 String path)
                                          throws Exception

      Set File and Directory of concatenated PEM-encoded CA Certificates for Client Auth
      This directive sets the all-in-one file where you can assemble the Certificates of Certification Authorities (CA) whose clients you deal with. These are used for Client Authentication. Such a file is simply the concatenation of the various PEM-encoded Certificate files, in order of preference. This can be used alternatively and/or additionally to path.
      The files in this directory have to be PEM-encoded and are accessed through hash filenames. So usually you can't just place the Certificate files there: you also have to create symbolic links named hash-value.N. And you should always make sure this directory contains the appropriate symbolic links. Use the Makefile which comes with mod_ssl to accomplish this task.
      Parameters:
        `ctx` - Server or Client context to use.
        `file` - File of concatenated PEM-encoded CA Certificates for Client Auth.
        `path` - Directory of PEM-encoded CA Certificates for Client Auth.
      Returns:
        `true` if the operation was successful
      Throws:
        `Exception` - An error occurred

    - #### setRandom

          public static void setRandom(long ctx,
                       String file)

      Set file for randomness
      Parameters:
        `ctx` - Server or Client context to use.
        `file` - random file.

    - #### setShutdownType

          public static void setShutdownType(long ctx,
                             int type)

      Set SSL connection shutdown type
      The following levels are available for level:

           SSL_SHUTDOWN_TYPE_STANDARD
           SSL_SHUTDOWN_TYPE_UNCLEAN
           SSL_SHUTDOWN_TYPE_ACCURATE

      Parameters:
        `ctx` - Server or Client context to use.
        `type` - Shutdown type to use.

    - #### setVerify

          public static void setVerify(long ctx,
                       int level,
                       int depth)

      Set Type of Client Certificate verification and Maximum depth of CA Certificates in Client Certificate verification.
      This directive sets the Certificate verification level for the Client Authentication. Notice that this directive can be used both in per-server and per-directory context. In per-server context it applies to the client authentication process used in the standard SSL handshake when a connection is established. In per-directory context it forces an SSL renegotiation with the reconfigured client verification level after the HTTP request was read but before the HTTP response is sent.
      The following levels are available for level:

           SSL_CVERIFY_NONE           - No client Certificate is required at all
           SSL_CVERIFY_OPTIONAL       - The client may present a valid Certificate
           SSL_CVERIFY_REQUIRE        - The client has to present a valid Certificate
           SSL_CVERIFY_OPTIONAL_NO_CA - The client may present a valid Certificate
                                        but it need not to be (successfully) verifiable

      The depth actually is the maximum number of intermediate certificate issuers, i.e. the number of CA certificates which are max allowed to be followed while verifying the client certificate. A depth of 0 means that self-signed client certificates are accepted only, the default depth of 1 means the client certificate can be self-signed or has to be signed by a CA which is directly known to the server (i.e. the CA's certificate is under `setCACertificatePath`), etc.
      Parameters:
        `ctx` - Server or Client context to use.
        `level` - Type of Client Certificate verification.
        `depth` - Maximum depth of CA Certificates in Client Certificate verification.

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.