Struct actix_tls::accept::openssl::reexports::Ssl

pub struct Ssl(/* private fields */);

Available on crate features accept and openssl only.

The state of an SSL/TLS session.

Ssl objects are created from an SslContext, which provides configuration defaults. These defaults can be overridden on a per-Ssl basis, however.

Implementations

impl Ssl

pub fn new_ex_index<T>() -> Result<Index<Ssl, T>, ErrorStack>

where T: 'static + Sync + Send,

Returns a new extra data index.

Each invocation of this function is guaranteed to return a distinct index. These can be used to store data in the context that can be retrieved later by callbacks, for example.

This corresponds to SSL_get_ex_new_index.

pub fn new(ctx: &SslContextRef) -> Result<Ssl, ErrorStack>

Creates a new Ssl.

This corresponds to SSL_new.

This corresponds to SSL_new.

pub fn connect<S>(self, stream: S) -> Result<SslStream<S>, HandshakeError<S>>

where S: Read + Write,

Initiates a client-side TLS handshake.

This corresponds to SSL_connect.

Warning

OpenSSL’s default configuration is insecure. It is highly recommended to use SslConnector rather than Ssl directly, as it manages that configuration.

This corresponds to SSL_connect.

pub fn accept<S>(self, stream: S) -> Result<SslStream<S>, HandshakeError<S>>

where S: Read + Write,

Initiates a server-side TLS handshake.

This corresponds to SSL_accept.

Warning

OpenSSL’s default configuration is insecure. It is highly recommended to use SslAcceptor rather than Ssl directly, as it manages that configuration.

This corresponds to SSL_accept.

Methods from Deref<Target = SslRef>

pub fn set_connect_state(&mut self)

Configure as an outgoing stream from a client.

This corresponds to SSL_set_connect_state.

pub fn set_accept_state(&mut self)

Configure as an incoming stream to a server.

This corresponds to SSL_set_accept_state.

pub fn set_verify(&mut self, mode: SslVerifyMode)

Like SslContextBuilder::set_verify.

This corresponds to SSL_set_verify.

pub fn verify_mode(&self) -> SslVerifyMode

Returns the verify mode that was set using set_verify.

This corresponds to SSL_set_verify_mode.

pub fn set_verify_callback<F>(&mut self, mode: SslVerifyMode, verify: F)

where F: Fn(bool, &mut X509StoreContextRef) -> bool + 'static + Sync + Send,

Like SslContextBuilder::set_verify_callback.

This corresponds to SSL_set_verify.

pub fn set_tmp_dh(&mut self, dh: &DhRef<Params>) -> Result<(), ErrorStack>

Like SslContextBuilder::set_tmp_dh.

This corresponds to SSL_set_tmp_dh.

pub fn set_tmp_dh_callback<F>(&mut self, callback: F)

where F: Fn(&mut SslRef, bool, u32) -> Result<Dh<Params>, ErrorStack> + 'static + Sync + Send,

Like SslContextBuilder::set_tmp_dh_callback.

This corresponds to SSL_set_tmp_dh_callback.

pub fn set_tmp_ecdh(&mut self, key: &EcKeyRef<Params>) -> Result<(), ErrorStack>

Like SslContextBuilder::set_tmp_ecdh.

This corresponds to SSL_set_tmp_ecdh.

pub fn set_alpn_protos(&mut self, protocols: &[u8]) -> Result<(), ErrorStack>

Available on ossl102 or libressl261 or boringssl only.

Like SslContextBuilder::set_alpn_protos.

Requires BoringSSL or OpenSSL 1.0.2 or LibreSSL 2.6.1 or newer.

This corresponds to SSL_set_alpn_protos.

pub fn current_cipher(&self) -> Option<&SslCipherRef>

Returns the current cipher if the session is active.

This corresponds to SSL_get_current_cipher.

pub fn state_string(&self) -> &'static str

Returns a short string describing the state of the session.

This corresponds to SSL_state_string.

pub fn state_string_long(&self) -> &'static str

Returns a longer string describing the state of the session.

This corresponds to SSL_state_string_long.

pub fn set_hostname(&mut self, hostname: &str) -> Result<(), ErrorStack>

Sets the host name to be sent to the server for Server Name Indication (SNI).

It has no effect for a server-side connection.

This corresponds to SSL_set_tlsext_host_name.

pub fn peer_certificate(&self) -> Option<X509>

Returns the peer’s certificate, if present.

This corresponds to SSL_get_peer_certificate.

pub fn peer_cert_chain(&self) -> Option<&StackRef<X509>>

Returns the certificate chain of the peer, if present.

On the client side, the chain includes the leaf certificate, but on the server side it does not. Fun!

This corresponds to SSL_get_peer_cert_chain.

pub fn verified_chain(&self) -> Option<&StackRef<X509>>

Available on ossl110 only.

Returns the verified certificate chain of the peer, including the leaf certificate.

If verification was not successful (i.e. verify_result does not return X509VerifyResult::OK), this chain may be incomplete or invalid.

Requires OpenSSL 1.1.0 or newer.

This corresponds to SSL_get0_verified_chain.

pub fn certificate(&self) -> Option<&X509Ref>

Like [SslContext::certificate].

This corresponds to SSL_get_certificate.

pub fn private_key(&self) -> Option<&PKeyRef<Private>>

Like SslContext::private_key.

This corresponds to SSL_get_privatekey.

pub fn version(&self) -> &str

👎Deprecated since 0.10.5: renamed to version_str

pub fn version2(&self) -> Option<SslVersion>

Returns the protocol version of the session.

This corresponds to SSL_version.

pub fn version_str(&self) -> &'static str

Returns a string describing the protocol version of the session.

This corresponds to SSL_get_version.

pub fn selected_alpn_protocol(&self) -> Option<&[u8]>

Available on ossl102 or libressl261 or boringssl only.

Returns the protocol selected via Application Layer Protocol Negotiation (ALPN).

The protocol’s name is returned is an opaque sequence of bytes. It is up to the client to interpret it.

Requires BoringSSL or OpenSSL 1.0.2 or LibreSSL 2.6.1 or newer.

This corresponds to SSL_get0_alpn_selected.

pub fn set_tlsext_use_srtp(&mut self, protocols: &str) -> Result<(), ErrorStack>

Enables the DTLS extension “use_srtp” as defined in RFC5764.

This corresponds to SSL_set_tlsext_use_srtp.

This corresponds to SSL_set_tlsext_use_srtp.

pub fn srtp_profiles(&self) -> Option<&StackRef<SrtpProtectionProfile>>

Gets all SRTP profiles that are enabled for handshake via set_tlsext_use_srtp

DTLS extension “use_srtp” as defined in RFC5764 has to be enabled.

This corresponds to SSL_get_srtp_profiles.

This corresponds to SSL_get_srtp_profiles.

pub fn selected_srtp_profile(&self) -> Option<&SrtpProtectionProfileRef>

Gets the SRTP profile selected by handshake.

DTLS extension “use_srtp” as defined in RFC5764 has to be enabled.

This corresponds to SSL_get_selected_srtp_profile.

pub fn pending(&self) -> usize

Returns the number of bytes remaining in the currently processed TLS record.

If this is greater than 0, the next call to read will not call down to the underlying stream.

This corresponds to SSL_pending.

pub fn servername(&self, type_: NameType) -> Option<&str>

Returns the servername sent by the client via Server Name Indication (SNI).

It is only useful on the server side.

Note

While the SNI specification requires that servernames be valid domain names (and therefore ASCII), OpenSSL does not enforce this restriction. If the servername provided by the client is not valid UTF-8, this function will return None. The servername_raw method returns the raw bytes and does not have this restriction.

This corresponds to SSL_get_servername.

pub fn servername_raw(&self, type_: NameType) -> Option<&[u8]>

Returns the servername sent by the client via Server Name Indication (SNI).

It is only useful on the server side.

Note

Unlike servername, this method does not require the name be valid UTF-8.

This corresponds to SSL_get_servername.

pub fn set_ssl_context(&mut self, ctx: &SslContextRef) -> Result<(), ErrorStack>

Changes the context corresponding to the current connection.

It is most commonly used in the Server Name Indication (SNI) callback.

This corresponds to SSL_set_SSL_CTX.

pub fn ssl_context(&self) -> &SslContextRef

Returns the context corresponding to the current connection.

This corresponds to SSL_get_SSL_CTX.

pub fn param_mut(&mut self) -> &mut X509VerifyParamRef

Available on ossl102 or boringssl or libressl261 only.

Returns a mutable reference to the X509 verification configuration.

Requires BoringSSL or OpenSSL 1.0.2 or newer.

This corresponds to SSL_get0_param.

pub fn verify_result(&self) -> X509VerifyResult

Returns the certificate verification result.

This corresponds to SSL_get_verify_result.

pub fn session(&self) -> Option<&SslSessionRef>

Returns a shared reference to the SSL session.

This corresponds to SSL_get_session.

pub fn client_random(&self, buf: &mut [u8]) -> usize

Available on ossl110 or libressl270 only.

Copies the client_random value sent by the client in the TLS handshake into a buffer.

Returns the number of bytes copied, or if the buffer is empty, the size of the client_random value.

Requires OpenSSL 1.1.0 or LibreSSL 2.7.0 or newer.

This corresponds to SSL_get_client_random.

pub fn server_random(&self, buf: &mut [u8]) -> usize

Available on ossl110 or libressl270 only.

Copies the server_random value sent by the server in the TLS handshake into a buffer.

Returns the number of bytes copied, or if the buffer is empty, the size of the server_random value.

Requires OpenSSL 1.1.0 or LibreSSL 2.7.0 or newer.

This corresponds to SSL_get_server_random.

pub fn export_keying_material( &self, out: &mut [u8], label: &str, context: Option<&[u8]> ) -> Result<(), ErrorStack>

Derives keying material for application use in accordance to RFC 5705.

This corresponds to SSL_export_keying_material.

pub fn export_keying_material_early( &self, out: &mut [u8], label: &str, context: &[u8] ) -> Result<(), ErrorStack>

Available on ossl111 only.

Derives keying material for application use in accordance to RFC 5705.

This function is only usable with TLSv1.3, wherein there is no distinction between an empty context and no context. Therefore, unlike export_keying_material, context must always be supplied.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_export_keying_material_early.

pub unsafe fn set_session( &mut self, session: &SslSessionRef ) -> Result<(), ErrorStack>

Sets the session to be used.

This should be called before the handshake to attempt to reuse a previously established session. If the server is not willing to reuse the session, a new one will be transparently negotiated.

Safety

The caller of this method is responsible for ensuring that the session is associated with the same SslContext as this Ssl.

This corresponds to SSL_set_session.

pub fn session_reused(&self) -> bool

Determines if the session provided to set_session was successfully reused.

This corresponds to SSL_session_reused.

pub fn set_status_type(&mut self, type_: StatusType) -> Result<(), ErrorStack>

Sets the status response a client wishes the server to reply with.

This corresponds to SSL_set_tlsext_status_type.

pub fn extms_support(&self) -> Option<bool>

Available on ossl110 only.

Determines if current session used Extended Master Secret

Returns None if the handshake is still in-progress.

This corresponds to SSL_get_extms_support.

pub fn ocsp_status(&self) -> Option<&[u8]>

Available on non-boringssl only.

Returns the server’s OCSP response, if present.

This corresponds to SSL_get_tlsext_status_ocsp_resp.

pub fn set_ocsp_status(&mut self, response: &[u8]) -> Result<(), ErrorStack>

Available on non-boringssl only.

Sets the OCSP response to be returned to the client.

This corresponds to SSL_set_tlsext_status_oscp_resp.

pub fn is_server(&self) -> bool

Determines if this Ssl is configured for server-side or client-side use.

This corresponds to SSL_is_server.

pub fn set_ex_data<T>(&mut self, index: Index<Ssl, T>, data: T)

Sets the extra data at the specified index.

This can be used to provide data to callbacks registered with the context. Use the Ssl::new_ex_index method to create an Index.

This corresponds to SSL_set_ex_data.

pub fn ex_data<T>(&self, index: Index<Ssl, T>) -> Option<&T>

Returns a reference to the extra data at the specified index.

This corresponds to SSL_get_ex_data.

pub fn ex_data_mut<T>(&mut self, index: Index<Ssl, T>) -> Option<&mut T>

Returns a mutable reference to the extra data at the specified index.

This corresponds to SSL_get_ex_data.

pub fn set_max_early_data(&mut self, bytes: u32) -> Result<(), ErrorStack>

Available on ossl111 or libressl340 only.

Sets the maximum amount of early data that will be accepted on this connection.

Requires OpenSSL 1.1.1 or LibreSSL 3.4.0 or newer.

This corresponds to SSL_set_max_early_data.

pub fn max_early_data(&self) -> u32

Available on ossl111 or libressl340 only.

Gets the maximum amount of early data that can be sent on this connection.

Requires OpenSSL 1.1.1 or LibreSSL 3.4.0 or newer.

This corresponds to SSL_get_max_early_data.

pub fn finished(&self, buf: &mut [u8]) -> usize

Copies the contents of the last Finished message sent to the peer into the provided buffer.

The total size of the message is returned, so this can be used to determine the size of the buffer required.

This corresponds to SSL_get_finished.

pub fn peer_finished(&self, buf: &mut [u8]) -> usize

Copies the contents of the last Finished message received from the peer into the provided buffer.

The total size of the message is returned, so this can be used to determine the size of the buffer required.

This corresponds to SSL_get_peer_finished.

pub fn is_init_finished(&self) -> bool

Available on ossl110 only.

Determines if the initial handshake has been completed.

This corresponds to SSL_is_init_finished.

pub fn client_hello_isv2(&self) -> bool

Available on ossl111 only.

Determines if the client’s hello message is in the SSLv2 format.

This can only be used inside of the client hello callback. Otherwise, false is returned.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_client_hello_isv2.

pub fn client_hello_legacy_version(&self) -> Option<SslVersion>

Available on ossl111 only.

Returns the legacy version field of the client’s hello message.

This can only be used inside of the client hello callback. Otherwise, None is returned.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_client_hello_get0_legacy_version.

pub fn client_hello_random(&self) -> Option<&[u8]>

Available on ossl111 only.

Returns the random field of the client’s hello message.

This can only be used inside of the client hello callback. Otherwise, None is returned.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_client_hello_get0_random.

pub fn client_hello_session_id(&self) -> Option<&[u8]>

Available on ossl111 only.

Returns the session ID field of the client’s hello message.

This can only be used inside of the client hello callback. Otherwise, None is returned.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_client_hello_get0_session_id.

pub fn client_hello_ciphers(&self) -> Option<&[u8]>

Available on ossl111 only.

Returns the ciphers field of the client’s hello message.

This can only be used inside of the client hello callback. Otherwise, None is returned.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_client_hello_get0_ciphers.

pub fn bytes_to_cipher_list( &self, bytes: &[u8], isv2format: bool ) -> Result<CipherLists, ErrorStack>

Available on ossl111 only.

Decodes a slice of wire-format cipher suite specification bytes. Unsupported cipher suites are ignored.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_bytes_to_cipher_list.

pub fn client_hello_compression_methods(&self) -> Option<&[u8]>

Available on ossl111 only.

Returns the compression methods field of the client’s hello message.

This can only be used inside of the client hello callback. Otherwise, None is returned.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_client_hello_get0_compression_methods.

pub fn set_mtu(&mut self, mtu: u32) -> Result<(), ErrorStack>

Sets the MTU used for DTLS connections.

This corresponds to SSL_set_mtu.

pub fn psk_identity_hint(&self) -> Option<&[u8]>

Available on non-osslconf="OPENSSL_NO_PSK" only.

Returns the PSK identity hint used during connection setup.

May return None if no PSK identity hint was used during the connection setup.

This corresponds to SSL_get_psk_identity_hint.

pub fn psk_identity(&self) -> Option<&[u8]>

Available on non-osslconf="OPENSSL_NO_PSK" only.

Returns the PSK identity used during connection setup.

This corresponds to SSL_get_psk_identity.

pub fn add_chain_cert(&mut self, chain: X509) -> Result<(), ErrorStack>

Available on ossl102 only.

This corresponds to SSL_add0_chain_cert.

pub fn set_method(&mut self, method: SslMethod) -> Result<(), ErrorStack>

Available on non-boringssl only.

Sets a new default TLS/SSL method for SSL objects

pub fn set_private_key_file<P>( &mut self, path: P, ssl_file_type: SslFiletype ) -> Result<(), ErrorStack>

where P: AsRef<Path>,

Loads the private key from a file.

This corresponds to SSL_use_Private_Key_file.

pub fn set_private_key( &mut self, pkey: &PKeyRef<Private> ) -> Result<(), ErrorStack>

Sets the private key.

This corresponds to SSL_use_PrivateKey.

pub fn set_certificate(&mut self, cert: &X509Ref) -> Result<(), ErrorStack>

Sets the certificate

This corresponds to SSL_use_certificate.

pub fn set_certificate_chain_file<P>( &mut self, path: P ) -> Result<(), ErrorStack>

where P: AsRef<Path>,

Available on ossl110 or libressl332 only.

Loads a certificate chain from a file.

The file should contain a sequence of PEM-formatted certificates, the first being the leaf certificate, and the remainder forming the chain of certificates up to and including the trusted root certificate.

This corresponds to SSL_use_certificate_chain_file.

pub fn add_client_ca(&mut self, cacert: &X509Ref) -> Result<(), ErrorStack>

Sets ca certificate that client trusted

This corresponds to SSL_add_client_CA.

pub fn set_client_ca_list(&mut self, list: Stack<X509Name>)

This corresponds to SSL_set_client_CA_list.

pub fn set_min_proto_version( &mut self, version: Option<SslVersion> ) -> Result<(), ErrorStack>

Available on ossl110 or libressl261 or boringssl only.

Sets the minimum supported protocol version.

A value of None will enable protocol versions down to the lowest version supported by OpenSSL.

Requires BoringSSL or OpenSSL 1.1.0 or LibreSSL 2.6.1 or newer.

This corresponds to SSL_set_min_proto_version.

pub fn set_max_proto_version( &mut self, version: Option<SslVersion> ) -> Result<(), ErrorStack>

Available on ossl110 or libressl261 or boringssl only.

Sets the maximum supported protocol version.

A value of None will enable protocol versions up to the highest version supported by OpenSSL.

Requires BoringSSL or OpenSSL 1.1.0 or or LibreSSL 2.6.1 or newer.

This corresponds to SSL_set_max_proto_version.

pub fn set_ciphersuites(&mut self, cipher_list: &str) -> Result<(), ErrorStack>

Available on ossl111 or libressl340 only.

Sets the list of supported ciphers for the TLSv1.3 protocol.

The set_cipher_list method controls the cipher suites for protocols before TLSv1.3.

The format consists of TLSv1.3 cipher suite names separated by : characters in order of preference.

Requires OpenSSL 1.1.1 or LibreSSL 3.4.0 or newer.

This corresponds to SSL_set_ciphersuites.

pub fn set_cipher_list(&mut self, cipher_list: &str) -> Result<(), ErrorStack>

Sets the list of supported ciphers for protocols before TLSv1.3.

The set_ciphersuites method controls the cipher suites for TLSv1.3.

See ciphers for details on the format.

This corresponds to SSL_set_cipher_list.

pub fn set_verify_cert_store( &mut self, cert_store: X509Store ) -> Result<(), ErrorStack>

Available on ossl102 only.

Set the certificate store used for certificate verification

This corresponds to SSL_set_cert_store.

pub fn set_num_tickets(&mut self, num_tickets: usize) -> Result<(), ErrorStack>

Available on ossl111 only.

Sets the number of TLS 1.3 session tickets that will be sent to a client after a full handshake.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_set_num_tickets.

pub fn num_tickets(&self) -> usize

Available on ossl111 only.

Gets the number of TLS 1.3 session tickets that will be sent to a client after a full handshake.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_get_num_tickets.

pub fn set_security_level(&mut self, level: u32)

Available on ossl110 or libressl360 only.

Set the context’s security level to a value between 0 and 5, inclusive. A security value of 0 allows allows all parameters and algorithms.

Requires OpenSSL 1.1.0 or newer.

This corresponds to SSL_set_security_level.

pub fn security_level(&self) -> u32

Available on ossl110 or libressl360 only.

Get the connection’s security level, which controls the allowed parameters and algorithms.

Requires OpenSSL 1.1.0 or newer.

This corresponds to SSL_get_security_level.

pub fn peer_tmp_key(&self) -> Result<PKey<Public>, ErrorStack>

Available on ossl300 only.

Get the temporary key provided by the peer that is used during key exchange.

This corresponds to SSL_get_peer_tmp_key.

pub fn tmp_key(&self) -> Result<PKey<Private>, ErrorStack>

Available on ossl300 only.

Returns the temporary key from the local end of the connection that is used during key exchange.

This corresponds to SSL_get_tmp_key.

Trait Implementations

impl AsRef<SslRef> for Ssl

fn as_ref(&self) -> &SslRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<SslRef> for Ssl

fn borrow(&self) -> &SslRef

Immutably borrows from an owned value.

impl Debug for Ssl

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for Ssl

type Target = SslRef

The resulting type after dereferencing.

fn deref(&self) -> &SslRef

Dereferences the value.

impl DerefMut for Ssl

fn deref_mut(&mut self) -> &mut SslRef

Mutably dereferences the value.

impl Drop for Ssl

fn drop(&mut self)

Executes the destructor for this type.

impl ForeignType for Ssl

type CType = SSL

The raw C type.

type Ref = SslRef

The type representing a reference to this type.

unsafe fn from_ptr(ptr: *mut SSL) -> Ssl

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut SSL

Returns a raw pointer to the wrapped value.

impl Send for Ssl

impl Sync for Ssl