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.

Implementations

impl SslContext

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

Creates a new builder object for an SslContext.

pub fn new_ex_index<T>() -> Result<Index<SslContext, 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_CTX_get_ex_new_index.

Methods from Deref<Target = SslContextRef>

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

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

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

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>

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>

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

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

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

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

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.

pub fn verify_mode(&self) -> SslVerifyMode

Returns the verify mode that was set on this context from SslContextBuilder::set_verify.

This corresponds to SSL_CTX_get_verify_mode.

Trait Implementations

impl AsRef<SslContextRef> for SslContext

fn as_ref(&self) -> &SslContextRef

Performs the conversion.

impl Borrow<SslContextRef> for SslContext

fn borrow(&self) -> &SslContextRef

Immutably borrows from an owned value.

impl Clone for SslContext

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SslContext

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

Formats the value using the given formatter.

impl Deref for SslContext

type Target = SslContextRef

The resulting type after dereferencing.

fn deref(&self) -> &SslContextRef

Dereferences the value.

impl DerefMut for SslContext

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

Mutably dereferences the value.

impl Drop for SslContext

fn drop(&mut self)

Executes the destructor for this type.

impl ForeignType for SslContext

type CType = SSL_CTX

The raw C type.

type Ref = SslContextRef

The type representing a reference to this type.

unsafe fn from_ptr(ptr: *mut SSL_CTX) -> SslContext

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut SSL_CTX

Returns a raw pointer to the wrapped value.

impl Send for SslContext

impl Sync for SslContext