Tomcat 10.1.19 · org.apache.tomcat.jni.SSL · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final int	SSL_AIDX_DSA
public static final int	SSL_AIDX_ECC
public static final int	SSL_AIDX_MAX
public static final int	SSL_AIDX_RSA
public static final int	SSL_ALGO_ALL
public static final int	SSL_ALGO_DSA
public static final int	SSL_ALGO_RSA
public static final int	SSL_ALGO_UNKNOWN
public static final int	SSL_CONF_FLAG_CERTIFICATE
public static final int	SSL_CONF_FLAG_CLIENT
public static final int	SSL_CONF_FLAG_CMDLINE
public static final int	SSL_CONF_FLAG_FILE
public static final int	SSL_CONF_FLAG_SERVER
public static final int	SSL_CONF_FLAG_SHOW_ERRORS
public static final int	SSL_CONF_TYPE_DIR
public static final int	SSL_CONF_TYPE_FILE
public static final int	SSL_CONF_TYPE_STRING
public static final int	SSL_CONF_TYPE_UNKNOWN
public static final int	SSL_CRT_FORMAT_ASN1
public static final int	SSL_CRT_FORMAT_ENGINE
public static final int	SSL_CRT_FORMAT_NETSCAPE
public static final int	SSL_CRT_FORMAT_PEM
public static final int	SSL_CRT_FORMAT_PKCS12
public static final int	SSL_CRT_FORMAT_SMIME
public static final int	SSL_CRT_FORMAT_TEXT
public static final int	SSL_CRT_FORMAT_UNDEF
public static final int	SSL_CVERIFY_NONE
public static final int	SSL_CVERIFY_OPTIONAL
public static final int	SSL_CVERIFY_OPTIONAL_NO_CA
public static final int	SSL_CVERIFY_REQUIRE
public static final int	SSL_CVERIFY_UNSET
public static final int	SSL_ERROR_NONE
public static final int	SSL_ERROR_SSL
public static final int	SSL_ERROR_SYSCALL
public static final int	SSL_ERROR_WANT_ACCEPT
public static final int	SSL_ERROR_WANT_CONNECT
public static final int	SSL_ERROR_WANT_READ
public static final int	SSL_ERROR_WANT_WRITE
public static final int	SSL_ERROR_WANT_X509_LOOKUP
public static final int	SSL_ERROR_ZERO_RETURN
public static final int	SSL_INFO_CIPHER
public static final int	SSL_INFO_CIPHER_ALGKEYSIZE
public static final int	SSL_INFO_CIPHER_DESCRIPTION
public static final int	SSL_INFO_CIPHER_USEKEYSIZE
public static final int	SSL_INFO_CIPHER_VERSION
public static final int	SSL_INFO_CLIENT_A_KEY
public static final int	SSL_INFO_CLIENT_A_SIG
public static final int	SSL_INFO_CLIENT_CERT
public static final int	SSL_INFO_CLIENT_CERT_CHAIN
public static final int	SSL_INFO_CLIENT_I_DN
public static final int	SSL_INFO_CLIENT_M_SERIAL
public static final int	SSL_INFO_CLIENT_M_VERSION
public static final int	SSL_INFO_CLIENT_S_DN
public static final int	SSL_INFO_CLIENT_V_END
public static final int	SSL_INFO_CLIENT_V_REMAIN
public static final int	SSL_INFO_CLIENT_V_START
public static final int	SSL_INFO_DN_COMMONNAME
public static final int	SSL_INFO_DN_COUNTRYNAME
public static final int	SSL_INFO_DN_DESCRIPTION
public static final int	SSL_INFO_DN_EMAILADDRESS
public static final int	SSL_INFO_DN_GIVENNAME
public static final int	SSL_INFO_DN_INITIALS
public static final int	SSL_INFO_DN_LOCALITYNAME
public static final int	SSL_INFO_DN_ORGANIZATIONALUNITNAME
public static final int	SSL_INFO_DN_ORGANIZATIONNAME
public static final int	SSL_INFO_DN_STATEORPROVINCENAME
public static final int	SSL_INFO_DN_SURNAME
public static final int	SSL_INFO_DN_TITLE
public static final int	SSL_INFO_DN_UNIQUEIDENTIFIER
public static final int	SSL_INFO_PROTOCOL
public static final int	SSL_INFO_SERVER_A_KEY
public static final int	SSL_INFO_SERVER_A_SIG
public static final int	SSL_INFO_SERVER_CERT
public static final int	SSL_INFO_SERVER_I_DN
public static final int	SSL_INFO_SERVER_M_SERIAL
public static final int	SSL_INFO_SERVER_M_VERSION
public static final int	SSL_INFO_SERVER_S_DN
public static final int	SSL_INFO_SERVER_V_END
public static final int	SSL_INFO_SERVER_V_START
public static final int	SSL_INFO_SESSION_ID
public static final int	SSL_MODE_CLIENT
public static final int	SSL_MODE_COMBINED
public static final int	SSL_MODE_SERVER
public static final int	SSL_OP_ALL
public static final int	SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
public static final int	SSL_OP_CIPHER_SERVER_PREFERENCE
public static final int	SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
public static final int	SSL_OP_EPHEMERAL_RSA
public static final int	SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
public static final int	SSL_OP_MICROSOFT_SESS_ID_BUG
public static final int	SSL_OP_MSIE_SSLV2_RSA_PADDING
public static final int	SSL_OP_NETSCAPE_CA_DN_BUG
public static final int	SSL_OP_NETSCAPE_CHALLENGE_BUG
public static final int	SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG
public static final int	SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
public static final int	SSL_OP_NO_COMPRESSION
public static final int	SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
public static final int	SSL_OP_NO_SSLv2
public static final int	SSL_OP_NO_SSLv3
public static final int	SSL_OP_NO_TICKET
public static final int	SSL_OP_NO_TLSv1
public static final int	SSL_OP_NO_TLSv1_1
public static final int	SSL_OP_NO_TLSv1_2
public static final int	SSL_OP_SINGLE_DH_USE
public static final int	SSL_OP_SINGLE_ECDH_USE
public static final int	SSL_OP_SSLEAY_080_CLIENT_DH_BUG
public static final int	SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
public static final int	SSL_OP_TLS_BLOCK_PADDING_BUG
public static final int	SSL_OP_TLS_D5_BUG
public static final int	SSL_OP_TLS_ROLLBACK_BUG
public static final int	SSL_OPT_ALL
public static final int	SSL_OPT_EXPORTCERTDATA
public static final int	SSL_OPT_FAKEBASICAUTH
public static final int	SSL_OPT_NONE
public static final int	SSL_OPT_OPTRENEGOTIATE
public static final int	SSL_OPT_RELSET
public static final int	SSL_OPT_STDENVVARS
public static final int	SSL_OPT_STRICTREQUIRE
public static final int	SSL_PROTOCOL_ALL
public static final int	SSL_PROTOCOL_NONE
public static final int	SSL_PROTOCOL_SSLV2
public static final int	SSL_PROTOCOL_SSLV3
public static final int	SSL_PROTOCOL_TLSV1
public static final int	SSL_PROTOCOL_TLSV1_1
public static final int	SSL_PROTOCOL_TLSV1_2
public static final int	SSL_PROTOCOL_TLSV1_3
public static final int	SSL_RECEIVED_SHUTDOWN
public static final int	SSL_SELECTOR_FAILURE_CHOOSE_MY_LAST_PROTOCOL
public static final int	SSL_SELECTOR_FAILURE_NO_ADVERTISE
public static final int	SSL_SENT_SHUTDOWN
public static final long	SSL_SESS_CACHE_OFF
public static final long	SSL_SESS_CACHE_SERVER
public static final int	SSL_SHUTDOWN_TYPE_ACCURATE
public static final int	SSL_SHUTDOWN_TYPE_STANDARD
public static final int	SSL_SHUTDOWN_TYPE_UNCLEAN
public static final int	SSL_SHUTDOWN_TYPE_UNSET
public static final int	SSL_TMP_KEY_DH_1024
public static final int	SSL_TMP_KEY_DH_2048
public static final int	SSL_TMP_KEY_DH_4096
public static final int	SSL_TMP_KEY_DH_512
public static final int	SSL_TMP_KEY_MAX
public static final int	SSL_TMP_KEY_RSA_1024
public static final int	SSL_TMP_KEY_RSA_2048
public static final int	SSL_TMP_KEY_RSA_4096
public static final int	SSL_TMP_KEY_RSA_512
public static final int	SSL_VERIFY_CLIENT_ONCE
public static final int	SSL_VERIFY_FAIL_IF_NO_PEER_CERT
public static final int	SSL_VERIFY_NONE
public static final int	SSL_VERIFY_PEER
public static final int	SSL_VERIFY_PEER_STRICT
public static final int	UNSET

Access	Constructor and Description
public	SSL()

Method Summary

Modifier and Type	Method and Description
public static native int	Returns: the handshake status doHandshake(long the SSL instance (SSL *) ssl) SSL_do_handshake
public static native int	Returns: FIPS_mode return code. It is `0` if OpenSSL is not in FIPS mode, `1` if OpenSSL is in FIPS Mode. fipsModeGet() Get the status of FIPS Mode.
public static native int	Returns: FIPS_mode_set return code fipsModeSet(int 1 - enable, 0 - disable mode) Enable/Disable FIPS Mode.
public static native void	freeBIO(long BIO pointer bio) BIO_free
public static native void	freeSSL(long the SSL instance (SSL *) ssl) SSL_free
public static native String	Returns: the ALPN protocol negotiated getAlpnSelected(long the SSL instance (SSL *) ssl) SSL_get0_alpn_selected
public static native String	Returns: the cipher name getCipherForSSL(long the SSL instance (SSL *) ssl) SSL_get_cipher.
public static native String[]	Returns: ciphers getCiphers(long the SSL instance (SSL *) ssl) Returns all cipher suites that are enabled for negotiation in an SSL handshake.
public static native String	Returns: an error message getErrorString(long The error code errorNumber) Get the error number representing for the given `errorNumber`.
public static native int	Returns: the count getHandshakeCount(long SSL pointer ssl) Return the handshake completed count.
public static native int	Returns: the last error number getLastErrorNumber() Get the error number representing the last error OpenSSL encountered on this thread.
public static native int	Returns: options See SSL.SSL_OP_* for option flags. getOptions(long the SSL instance (SSL *) ssl) Get OpenSSL Option.
public static native byte[][]	Returns: the certificate chain bytes getPeerCertChain(long the SSL instance (SSL *) ssl) Get the peer certificate chain or `null` if non was send.
public static native byte[]	Returns: the certificate bytes getPeerCertificate(long the SSL instance (SSL *) ssl) Get the peer certificate or `null` if non was send.
public static native int	Returns: the operation status getPostHandshakeAuthInProgress(long the SSL instance (SSL *) ssl) Is post handshake authentication in progress on this connection?
public static native byte[]	Returns: the session as byte array representation obtained via SSL_SESSION_get_id. getSessionId(long the SSL instance (SSL *) ssl) Returns the ID of the session as byte array representation.
public static native int	Returns: the operation status getShutdown(long the SSL instance (SSL *) ssl) SSL_get_shutdown
public static native long	Returns: returns the time at which the session ssl was established. The time is given in seconds since the Epoch getTime(long the SSL instance (SSL *) ssl) SSL_get_time
public static native String	Returns: the SSL version in use getVersion(long the SSL instance (SSL *) ssl) SSL_get_version
public static native int	Returns: APR status code initialize(String Support for external a Crypto Device ("engine"), usually a hardware accelerator card for crypto operations. engine) Initialize OpenSSL support.
public static native int	Returns: the status isInInit(long the SSL instance (SSL *) ssl) SSL_in_init.
public static native long	Returns: pointer to the Network BIO (BIO ) makeNetworkBIO(long the SSL instance (SSL ) ssl) Wire up internal and network BIOs for the given SSL instance.
public static native long	Returns: pointer to SSL instance (SSL *) newSSL(long Server or Client context to use. ctx, boolean if true configure SSL instance to use accept handshake routines if false configure SSL instance to use connect handshake routines server) SSL_new
public static native int	Returns: the pending bytes count pendingReadableBytesInSSL(long SSL pointer (SSL *) ssl) SSL_pending.
public static native int	Returns: the pending bytes count pendingWrittenBytesInBIO(long BIO pointer (BIO *) bio) BIO_ctrl_pending.
public static native void	randSet(String Filename to use. If set it will be used for SSL initialization and all contexts where explicitly not set. filename) Sets global random filename.
public static native int	Returns: the bytes count read readFromBIO(long BIO pointer bio, long Buffer pointer rbuf, int Read length rlen) BIO_read.
public static native int	Returns: the bytes count read readFromSSL(long the SSL instance (SSL *) ssl, long Buffer pointer rbuf, int Read length rlen) SSL_read
public static native int	Returns: the operation status renegotiate(long the SSL instance (SSL *) ssl) SSL_renegotiate
public static native int	Returns: the operation status renegotiatePending(long the SSL instance (SSL *) ssl) SSL_renegotiate_pending
public static native boolean	Returns: `true` if the operation was successful setCipherSuites(long the SSL instance (SSL *) ssl, String an SSL cipher specification ciphers) Returns the cipher suites available for negotiation in SSL handshake.
public static native void	setOptions(long the SSL instance (SSL ) ssl, int See SSL.SSL_OP_ for option flags. options) Set OpenSSL Option.
public static native void	setVerify(long the SSL instance (SSL *) ssl, int Type of Client Certificate verification. level, int Maximum depth of CA Certificates in Client Certificate verification. depth) Set Type of Client Certificate verification and Maximum depth of CA Certificates in Client Certificate verification.
public static native int	Returns: the operation status shutdownSSL(long the SSL instance (SSL *) ssl) SSL_shutdown
public static native int	Returns: the operation status verifyClientPostHandshake(long the SSL instance (SSL *) ssl) SSL_verify_client_post_handshake
public static native int	version()
public static native String	versionString()
public static native int	Returns: the bytes count written writeToBIO(long BIO pointer bio, long Buffer pointer wbuf, int Write length wlen) BIO_write.
public static native int	Returns: the bytes count written writeToSSL(long the SSL instance (SSL *) ssl, long Buffer pointer wbuf, int Write length wlen) SSL_write.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public final Class SSL

Field Summary

Constructor Summary

Method Summary