Class SSLConf

java/org/apache/tomcat/jni/SSLConf.java:22–132

JNI bindings for OpenSSL SSL_CONF operations.

 * JNI bindings for OpenSSL SSL_CONF operations.
 */
public final class SSLConf {

    /**
     * Default constructor. This class provides only static methods.
     */
    public SSLConf() {
        super();
    }

    /**
     * Create a new SSL_CONF context.
     *
     * @param pool  The pool to use.
     * @param flags The SSL_CONF flags to use. It can be any combination of the following:
     *
     *                  <PRE>
     * {@link SSL#SSL_CONF_FLAG_CMDLINE}
     * {@link SSL#SSL_CONF_FLAG_FILE}
     * {@link SSL#SSL_CONF_FLAG_CLIENT}
     * {@link SSL#SSL_CONF_FLAG_SERVER}
     * {@link SSL#SSL_CONF_FLAG_SHOW_ERRORS}
     * {@link SSL#SSL_CONF_FLAG_CERTIFICATE}
     * </PRE>
     *
     * @return The Java representation of a pointer to the newly created SSL_CONF Context
     *
     * @throws Exception If the SSL_CONF context could not be created
     *
     * @see <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CONF_CTX_new.html">OpenSSL SSL_CONF_CTX_new</a>
     * @see <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CONF_CTX_set_flags.html">OpenSSL
     *          SSL_CONF_CTX_set_flags</a>
     */
    public static native long make(long pool, int flags) throws Exception;

    /**
     * Free the resources used by the context
     *
     * @param cctx SSL_CONF context to free.
     *
     * @see <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CONF_CTX_new.html">OpenSSL SSL_CONF_CTX_free</a>
     */
    public static native void free(long cctx);

    /**
     * Optionally used to check a command with an SSL_CONF context.
     * <p>
     * This call is also used to pass Tomcat specific settings to Tomcat Native. It must be called for for each Tomcat
     * specific setting (e.g. {@link org.apache.tomcat.util.net.openssl.OpenSSLConfCmd#NO_OCSP_CHECK}) before {@link
     * #assign(long, long)} is called.
     *
     * @param cctx  SSL_CONF context to use.
     * @param name  command name.
     * @param value command value.
     *
     * @return The result of the check based on the {@code SSL_CONF_cmd_value_type} call. Unknown types will result in
     *             an exception, as well as file and directory types with invalid file or directory names.
     *
     * @throws Exception If the check fails.