Class encapsulates availble information about current SSL session. More...

#include <ssl.h>

Public Member Functions
virtual	~SSL_information () noexcept
	Destructor.

virtual string_view	protocol () const =0
	The SSL protocol version (e.q. More...

virtual string_view	cipher_name () const =0
	The cipher specification name (e.q. More...

virtual bool	is_cipher_export () const =0
	Returns `true` if the cipher is an export cipher. More...

virtual int	cipher_used_bits () const =0
	Returns number of bits used in the cipher. More...

virtual int	cipher_possible_bits () const =0
	Returns number of bits which could possible be used in the cipher. More...

virtual string_view	compress_method () const =0
	Returns SSL compression method negotiated. More...

virtual string_view	session_id () const =0
	The hex-encoded SSL session id if any available. More...

virtual SSL_SESSION_STATE	session_state () const =0
	Returns the state of the SSL session. More...

virtual const certificate &	client_certificate () const =0
	Returns object containing available information for client certificate. More...

virtual const certificate &	server_certificate () const =0
	Returns object containing available information for server certificate. More...

Detailed Description

Class encapsulates availble information about current SSL session.

If the current request was not made using SSL channel than this object cannot be accessed from servlet.

Note that in order for this information to available in mod_servlet Apache mod_ssl should be configured to enable environment variables. For example:

SSLOptions +StdEnvVars +ExportCertData

For more information on configuration of Apache mod_ssl see "Apache Module mod_ssl" documentation

Member Function Documentation

virtual string_view servlet::SSL_information::cipher_name ( ) const

pure virtual

The cipher specification name (e.q.

ECDHE-RSA-AES128-GCM-SHA256)

Returns: The cipher specification name

virtual int servlet::SSL_information::cipher_possible_bits ( ) const

pure virtual

Returns number of bits which could possible be used in the cipher.

Returns: possible number of bits to be used in the cipher

See Also: cipher_used_bits

virtual int servlet::SSL_information::cipher_used_bits ( ) const

pure virtual

Returns number of bits used in the cipher.

Returns: number of bits used in the cipher

See Also: cipher_possible_bits

virtual const certificate& servlet::SSL_information::client_certificate ( ) const

pure virtual

Returns object containing available information for client certificate.

Returns: client certificate information

virtual string_view servlet::SSL_information::compress_method ( ) const

pure virtual

Returns SSL compression method negotiated.

Returns: SSL compression method negotiated.

virtual bool servlet::SSL_information::is_cipher_export ( ) const

pure virtual

Returns true if the cipher is an export cipher.

Returns: true if the cipher is an export cipher

virtual string_view servlet::SSL_information::protocol ( ) const

pure virtual

The SSL protocol version (e.q.

SSLv3, TLSv1, TLSv1.1, TLSv1.2)

Returns: the SSL protocol version

virtual const certificate& servlet::SSL_information::server_certificate ( ) const

pure virtual

Returns object containing available information for server certificate.

Returns: server certificate information

virtual string_view servlet::SSL_information::session_id ( ) const

pure virtual

The hex-encoded SSL session id if any available.

Returns: The hex-encoded SSL session id

virtual SSL_SESSION_STATE servlet::SSL_information::session_state ( ) const

pure virtual

Returns the state of the SSL session.

It can be eithee INITIAL or RESUMED

Returns: the state of the SSL session

The documentation for this class was generated from the following file:

include/servlet/ssl.h

Public Member Functions

Detailed Description

Member Function Documentation