Struct SslContextRef

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

A borrowed reference to a SslContext.

Implementations

impl SslContextRef

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

Returns the certificate associated with this SslContext, if present.

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.

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

Safety

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

This corresponds to SSL_CTX_add_session.

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.

Safety

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

This corresponds to SSL_CTX_remove_session.

pub fn session_cache_size(&self) -> u64

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.

pub fn set_ech_keys(&self, keys: &SslEchKeys) -> Result<(), ErrorStack>

Registers a list of ECH keys on the context. This list should contain new and old ECHConfigs to allow stale DNS caches to update. Unlike most SSL_CTX APIs, this function is safe to call even after the SSL_CTX has been associated with connections on various threads.

This corresponds to SSL_CTX_set1_ech_keys.

Trait Implementations

impl AsMut<SslContextRef> for SslContext

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

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

impl AsRef<SslContextRef> for SslContext

fn as_ref(&self) -> &SslContextRef

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

impl Borrow<SslContextRef> for SslContext

fn borrow(&self) -> &SslContextRef

Immutably borrows from an owned value.

impl BorrowMut<SslContextRef> for SslContext

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

Mutably borrows from an owned value.

impl ForeignTypeRef for SslContextRef

type CType = ssl_ctx_st

The raw C type.

unsafe fn from_ptr<'a>(ptr: *mut Self::CType) -> &'a Self

Constructs a shared instance of this type from its raw type.

unsafe fn from_ptr_mut<'a>(ptr: *mut Self::CType) -> &'a mut Self

Constructs a mutable reference of this type from its raw type.

fn as_ptr(&self) -> *mut Self::CType

Returns a raw pointer to the wrapped value.

impl ToOwned for SslContextRef

type Owned = SslContext

The resulting type after obtaining ownership.

fn to_owned(&self) -> <SslContextRef as ToOwned>::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Send for SslContextRef

impl Sync for SslContextRef