Struct X509StoreContextRef 

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

A borrowed reference to a X509StoreContext.

Implementations

impl X509StoreContextRef

pub fn ex_data<T>(&self, index: Index<X509StoreContext, T>) -> Option<&T>

Returns application data pertaining to an X509 store context.

This corresponds to X509_STORE_CTX_get_ex_data.

pub fn ex_data_mut<T>( &mut self, index: Index<X509StoreContext, T>, ) -> Option<&mut T>

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

This corresponds to X509_STORE_CTX_get_ex_data.

pub fn set_ex_data<T>(&mut self, index: Index<X509StoreContext, T>, data: T)

Sets or overwrites 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 X509_STORE_CTX_set_ex_data.

pub fn verify_result(&self) -> Result<(), X509VerifyError>

Returns the verify result of the context.

This corresponds to X509_STORE_CTX_get_error.

pub fn init<F, T>( &mut self, trust: &X509StoreRef, cert: &X509Ref, cert_chain: &StackRef<X509>, with_context: F, ) -> Result<T, ErrorStack>

where F: FnOnce(&mut X509StoreContextRef) -> Result<T, ErrorStack>,

Initializes this context with the given certificate, certificates chain and certificate store. After initializing the context, the with_context closure is called with the prepared context. As long as the closure is running, the context stays initialized and can be used to e.g. verify a certificate. The context will be cleaned up, after the closure finished.

• trust - The certificate store with the trusted certificates.
• cert - The certificate that should be verified.
• cert_chain - The certificates chain.
• with_context - The closure that is called with the initialized context.

Calls X509_STORE_CTX_cleanup after calling with_context.

This corresponds to X509_STORE_CTX_init.

pub fn reset_with_context_data( &mut self, trust: X509Store, cert: X509, cert_chain: Stack<X509>, ) -> Result<(), ErrorStack>

Initializes this context with the given certificate, certificates chain and certificate store.

• trust - The certificate store with the trusted certificates.
• cert - The certificate that should be verified.
• cert_chain - The certificates chain.

This corresponds to X509_STORE_CTX_init.

pub fn verify_param(&mut self) -> &X509VerifyParamRef

Returns a reference to the X509 verification configuration.

This corresponds to X509_STORE_CTX_get0_param.

pub fn verify_param_mut(&mut self) -> &mut X509VerifyParamRef

Returns a mutable reference to the X509 verification configuration.

This corresponds to X509_STORE_CTX_get0_param.

pub fn set_verify_param(&mut self, param: X509VerifyParam)

Sets the X509 verification configuration.

This corresponds to X509_STORE_CTX_set0_param.

pub fn verify_cert(&mut self) -> Result<bool, ErrorStack>

Verifies the stored certificate.

Returns true if verification succeeds. The error method will return the specific validation error if the certificate was not valid.

This will only work inside of a call to init.

This corresponds to X509_verify_cert.

pub fn set_error(&mut self, result: Result<(), X509VerifyError>)

Set the verify result of the context.

This corresponds to X509_STORE_CTX_set_error.

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

Returns a reference to the certificate which caused the error or None if no certificate is relevant to the error.

This corresponds to X509_STORE_CTX_get_current_cert.

pub fn error_depth(&self) -> u32

Returns a non-negative integer representing the depth in the certificate chain where the error occurred. If it is zero it occurred in the end entity certificate, one if it is the certificate which signed the end entity certificate and so on.

This corresponds to X509_STORE_CTX_get_error_depth.

pub fn chain(&self) -> Option<&StackRef<X509>>

Returns a reference to a complete valid X509 certificate chain.

This corresponds to X509_STORE_CTX_get0_chain.

pub fn untrusted(&self) -> Option<&StackRef<X509>>

Returns a reference to the X509 certificates used to initialize the X509StoreContextRef.

This corresponds to X509_STORE_CTX_get0_untrusted.

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

Returns a reference to the certificate being verified. May return None if a raw public key is being verified.

This corresponds to X509_STORE_CTX_get0_cert.

Trait Implementations

impl AsMut<X509StoreContextRef> for X509StoreContext

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

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

impl AsRef<X509StoreContextRef> for X509StoreContext

fn as_ref(&self) -> &X509StoreContextRef

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

impl Borrow<X509StoreContextRef> for X509StoreContext

fn borrow(&self) -> &X509StoreContextRef

Immutably borrows from an owned value.

impl BorrowMut<X509StoreContextRef> for X509StoreContext

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

Mutably borrows from an owned value.

impl ForeignTypeRef for X509StoreContextRef

type CType = x509_store_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 Send for X509StoreContextRef

impl Sync for X509StoreContextRef