Struct openssl::ssl::SslContextRef

[+] Show declaration

pub struct SslContextRef(_);

[−] Expand description

Reference to SslContext

Implementations

impl 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[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &SslContextRef[−]

Performs the conversion.

impl Borrow<SslContextRef> for SslContext[+]

[+] Show hidden undocumented items

fn borrow(&self) -> &SslContextRef[−]

Immutably borrows from an owned value.

impl ForeignTypeRef for SslContextRef[+]

[+] Show hidden undocumented items

type CType = SSL_CTX

The raw C type.

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

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

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

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

pub fn as_ptr(&self) -> *mut Self::CType[−]

Returns a raw pointer to the wrapped value.

impl Send for SslContextRef

impl Sync for SslContextRef

impl ToOwned for SslContextRef[+]

[+] Show hidden undocumented items

type Owned = SslContext

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned[−]

Creates owned data from borrowed data, usually by cloning.

pub fn clone_into(&self, target: &mut Self::Owned)[−]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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