[][src]Struct openssl::ssl::SslContext

pub struct SslContext(_);

A context object for TLS streams.

Applications commonly configure a single SslContext that is shared by all of its SslStreams.

Methods

impl SslContext[src]

pub fn builder(method: SslMethod) -> Result<SslContextBuilder, ErrorStack>[src]

Creates a new builder object for an SslContext.

pub fn new_ex_index<T>() -> Result<Index<SslContext, T>, ErrorStack> where
    T: 'static + Sync + Send
[src]

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

Methods from Deref<Target = SslContextRef>

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

Returns the certificate associated with this SslContext, if present.

Requires OpenSSL 1.0.2 or newer.

This corresponds to SSL_CTX_get0_certificate.

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

Returns the private key associated with this SslContext, if present.

Requires OpenSSL 1.0.2 or newer.

This corresponds to SSL_CTX_get0_privatekey.

pub fn cert_store(&self) -> &X509StoreRef[src]

Returns a shared reference to the certificate store used for verification.

This corresponds to SSL_CTX_get_cert_store.

pub fn extra_chain_certs(&self) -> &StackRef<X509>[src]

Returns a shared reference to the stack of certificates making up the chain from the leaf.

This corresponds to SSL_CTX_get_extra_chain_certs.

pub fn ex_data<T>(&self, index: Index<SslContext, T>) -> Option<&T>[src]

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

This corresponds to SSL_CTX_get_ex_data.

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

Gets the maximum amount of early data that will be accepted on incoming connections.

Requires OpenSSL 1.1.1 or newer.

This corresponds to SSL_CTX_get_max_early_data.

pub unsafe fn add_session(&self, session: &SslSessionRef) -> bool[src]

Adds a session to the context's cache.

Returns true if the session was successfully added to the cache, and false if it was already present.

This corresponds to SSL_CTX_add_session.

Safety

The caller of this method is responsible for ensuring that the session has never been used with another SslContext than this one.

pub unsafe fn remove_session(&self, session: &SslSessionRef) -> bool[src]

Removes a session from the context's cache and marks it as non-resumable.

Returns true if the session was successfully found and removed, and false otherwise.

This corresponds to SSL_CTX_remove_session.

Safety

The caller of this method is responsible for ensuring that the session has never been used with another SslContext than this one.

pub fn session_cache_size(&self) -> i64[src]

Returns the context's session cache size limit.

A value of 0 means that the cache size is unbounded.

This corresponds to SSL_CTX_sess_get_cache_size.

Trait Implementations

impl AsRef<SslContextRef> for SslContext[src]

impl Borrow<SslContextRef> for SslContext[src]

impl Clone for SslContext[src]

impl Debug for SslContext[src]

impl Deref for SslContext[src]

type Target = SslContextRef

The resulting type after dereferencing.

impl DerefMut for SslContext[src]

impl Drop for SslContext[src]

impl ForeignType for SslContext[src]

type CType = SSL_CTX

The raw C type.

type Ref = SslContextRef

The type representing a reference to this type.

impl Send for SslContext[src]

impl Sync for SslContext[src]

Auto Trait Implementations

impl RefUnwindSafe for SslContext

impl Unpin for SslContext

impl UnwindSafe for SslContext

Blanket Implementations

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

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

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

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

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

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

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.

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.