# Struct openssl::ssl::ConnectConfiguration [−] [src]

    pub struct ConnectConfiguration { /* fields omitted */ }

A type which allows for configuration of a client-side TLS session before connection.

## Implementations

### `impl ConnectConfiguration` [src]

#### `pub fn use_server_name_indication(self, use_sni: bool) -> ConnectConfiguration` [src]

A builder-style version of `set_use_server_name_indication`.

#### `pub fn set_use_server_name_indication(&mut self, use_sni: bool)` [src]

Configures the use of Server Name Indication (SNI) when connecting.

Defaults to `true`.

#### `pub fn verify_hostname(self, verify_hostname: bool) -> ConnectConfiguration` [src]

A builder-style version of `set_verify_hostname`.

#### `pub fn set_verify_hostname(&mut self, verify_hostname: bool)` [src]

Configures the use of hostname verification when connecting.

Defaults to `true`.

# Warning

You should think very carefully before you use this method. If hostname verification is not used, any valid certificate for any site will be trusted for use from any other. This introduces a significant vulnerability to man-in-the-middle attacks.

#### `pub fn into_ssl(self, domain: &str) -> Result<Ssl, ErrorStack>` [src]

Returns an `Ssl` configured to connect to the provided domain.

The domain is used for SNI and hostname verification if enabled.

#### `pub fn connect<S>(
self,
domain: &str,
stream: S
) -> Result<SslStream<S>, HandshakeError<S>> where
S: Read + Write,` [src]

Initiates a client-side TLS session on a stream.

The domain is used for SNI and hostname verification if enabled.

## Methods from Deref<Target = SslRef>

#### `pub fn set_connect_state(&mut self)` [src]

Configure as an outgoing stream from a client.

This corresponds to `SSL_set_connect_state`.

#### `pub fn set_accept_state(&mut self)` [src]

Configure as an incoming stream to a server.

This corresponds to `SSL_set_accept_state`.

#### `pub fn set_verify(&mut self, mode: SslVerifyMode)` [src]

Like `SslContextBuilder::set_verify`.

This corresponds to `SSL_set_verify`.

#### `pub fn verify_mode(&self) -> SslVerifyMode` [src]

Returns the verify mode that was set using `set_verify`.

This corresponds to `SSL_get_verify_mode`.

#### `pub fn set_verify_callback<F>(&mut self, mode: SslVerifyMode, verify: F) where
F: Fn(bool, &mut X509StoreContextRef) -> bool + 'static + Sync + Send,` [src]

Like `SslContextBuilder::set_verify_callback`.

This corresponds to `SSL_set_verify`.

#### `pub fn set_tmp_dh(&mut self, dh: &DhRef<Params>) -> Result<(), ErrorStack>` [src]

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,` [src]

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>` [src]

Like `SslContextBuilder::set_tmp_ecdh`.

This corresponds to `SSL_set_tmp_ecdh`.

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

Like `SslContextBuilder::set_alpn_protos`.

Requires 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>` [src]

Returns the current cipher if the session is active.

This corresponds to `SSL_get_current_cipher`.

#### `pub fn state_string(&self) -> &'static str` [src]

Returns a short string describing the state of the session.

This corresponds to `SSL_state_string`.

#### `pub fn state_string_long(&self) -> &'static str` [src]

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>` [src]

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>` [src]

Returns the peer’s certificate, if present.

This corresponds to `SSL_get_peer_certificate`.

#### `pub fn peer_cert_chain(&self) -> Option<&StackRef<X509>>` [src]

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>>` [src]

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>` [src]

Like `SslContext::certificate`.

This corresponds to `SSL_get_certificate`.

#### `pub fn private_key(&self) -> Option<&PKeyRef<Private>>` [src]

Like `SslContext::private_key`.

This corresponds to `SSL_get_privatekey`.

#### `pub fn version(&self) -> &str` [src]

👎 Deprecated since 0.10.5:

renamed to `version_str`

#### `pub fn version2(&self) -> Option<SslVersion>` [src]

Returns the protocol version of the session.

This corresponds to `SSL_version`.

#### `pub fn version_str(&self) -> &'static str` [src]

Returns a string describing the protocol version of the session.

This corresponds to `SSL_get_version`.

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

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 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>` [src]

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

This corresponds to `SSL_set_tlsext_use_srtp`.

#### `pub fn srtp_profiles(&self) -> Option<&StackRef<SrtpProtectionProfile>>` [src]

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`.

#### `pub fn selected_srtp_profile(&self) -> Option<&SrtpProtectionProfileRef>` [src]

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` [src]

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>` [src]

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

It is only useful on the server side.

This corresponds to `SSL_get_servername`.

# 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.

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

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

It is only useful on the server side.

This corresponds to `SSL_get_servername`.

# Note

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

#### `pub fn set_ssl_context(&mut self, ctx: &SslContextRef) -> Result<(), ErrorStack>` [src]

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` [src]

Returns the context corresponding to the current connection.

This corresponds to `SSL_get_SSL_CTX`.

#### `pub fn param_mut(&mut self) -> &mut X509VerifyParamRef` [src]

Returns a mutable reference to the X509 verification configuration.

Requires OpenSSL 1.0.2 or newer.

This corresponds to `SSL_get0_param`.

#### `pub fn verify_result(&self) -> X509VerifyResult` [src]

Returns the certificate verification result.

This corresponds to `SSL_get_verify_result`.

#### `pub fn session(&self) -> Option<&SslSessionRef>` [src]

Returns a shared reference to the SSL session.

This corresponds to `SSL_get_session`.

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

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 newer.

This corresponds to `SSL_get_client_random`.

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

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 newer.

This corresponds to `SSL_get_server_random`.

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

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>` [src]

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>` [src]

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.

This corresponds to `SSL_set_session`.

# Safety

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

#### `pub fn session_reused(&self) -> bool` [src]

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>` [src]

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

This corresponds to `SSL_set_tlsext_status_type`.

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

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>` [src]

Sets the OCSP response to be returned to the client.

This corresponds to `SSL_set_tlsext_status_ocsp_resp`.

#### `pub fn is_server(&self) -> bool` [src]

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)` [src]

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>` [src]

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>` [src]

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>` [src]

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

Requires OpenSSL 1.1.1 or newer.

This corresponds to `SSL_set_max_early_data`.

#### `pub fn max_early_data(&self) -> u32` [src]

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

Requires OpenSSL 1.1.1 or newer.

This corresponds to `SSL_get_max_early_data`.

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

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` [src]

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` [src]

Determines if the initial handshake has been completed.

This corresponds to `SSL_is_init_finished`.

#### `pub fn client_hello_isv2(&self) -> bool` [src]

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>` [src]

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]>` [src]

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

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

Requires OpenSSL 1.1.1 or newer.

This corresponds to `SSL_client_hello_get0_random`.

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

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 returend.

Requires OpenSSL 1.1.1 or newer.

This corresponds to `SSL_client_hello_get0_session_id`.

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

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

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

Requires OpenSSL 1.1.1 or newer.

This corresponds to `SSL_client_hello_get0_ciphers`.

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

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 returend.

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>` [src]

Sets the MTU used for DTLS connections.

This corresponds to `SSL_set_mtu`.

## Trait Implementations

### `impl Deref for ConnectConfiguration` [src]

#### `type Target = SslRef`

The resulting type after dereferencing.

#### `fn deref(&self) -> &SslRef` [src]

Dereferences the value.

### `impl DerefMut for ConnectConfiguration` [src]

#### `fn deref_mut(&mut self) -> &mut SslRef` [src]

Mutably dereferences the value.

## Auto Trait Implementations

### `impl RefUnwindSafe for ConnectConfiguration`

### `impl Send for ConnectConfiguration`

### `impl Sync for ConnectConfiguration`

### `impl Unpin for ConnectConfiguration`

### `impl UnwindSafe for ConnectConfiguration`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.