Class Qpid::Proton::SSL
In: lib/core/ssl.rb
Parent: Object

The SSL support for Transport.

A Transport may be configured ot use SLL for encryption and/or authentication. A Transport can be configured as either the SSL client or the server. An SSL client is the party that proctively establishes a connection to an SSL server. An SSL server is the party that accepts a connection request from the remote SSL client.

If either the client or the server needs to identify itself with the remote node, it must have its SSL certificate configured.

@see SSLDomain#credentials For setting the SSL certificate.

If either the client or the server needs to verify the identify of the remote node, it must have its database of trusted CAs configured.

@see SSLDomain#trusted_ca_db Setting the CA database.

An SSL server connection may allow the remote client to connect without SS (i.e., "in the clear").

@see SSLDomain#allow_unsecured_client Allowing unsecured clients.

The level of verification required of the remote may be configured.

@see SSLDomain#peer_authentication Setting peer authentication.

Support for SSL client session resume is provided as well.

@see SSLDomain @see resume_status

Methods

Included Modules

Util::SwigHelper Util::ErrorHandler

Constants

RESUME_UNKNOWN = Cproton::PN_SSL_RESUME_UNKNOWN   Session resume state is unkonnwn or not supported.
RESUME_NEW = Cproton::PN_SSL_RESUME_NEW   Session renegotiated and not resumed.
RESUME_REUSED = Cproton::PN_SSL_RESUME_REUSED   Session resumed from the previous session.
PROTON_METHOD_PREFIX = "pn_ssl"   @private

Public Class methods

Returns whether SSL is supported.

@return [Boolean] True if SSL support is available.

Public Instance methods

Returns the cipher name that is currently in used.

Gets the text description of the cipher that is currently active, or returns nil if SSL is not active. Note that the cipher in use my change over time due to renegotiation or other changes to the SSL layer.

@return [String, nil] The cipher name.

Gets the peer hostname.

@return [String] The peer hostname.

Returns the name of the SSL protocol that is currently active, or returns nil if SSL is nota ctive. Not that the protocol may change over time due to renegotation.

@return [String, nil] The protocol name.

Checks whether or not the state has resumed.

Used for client session resume. When called on an active session, it indicates wehther the state has been resumed from a previous session.

*NOTE:* This is a best-effort service - there is no guarantee that the remote server will accept the resumed parameters. The remote server may choose to ignore these parameters, and request a renegotation instead.

[Validate]