Struct rocket::config::TlsConfig[][src]

pub struct TlsConfig { /* fields omitted */ }
Expand description

TLS configuration: a certificate chain and a private key.

Both certs and key can be configured as a path or as raw bytes. certs must be a DER-encoded X.509 TLS certificate chain, while key must be a DER-encoded ASN.1 key in either PKCS#8 or PKCS#1 format.

The following example illustrates manual configuration:

use rocket::Config;

let figment = rocket::Config::figment()
    .merge(("tls.certs", "strings/are/paths/certs.pem"))
    .merge(("tls.key", vec![0; 32]));

let config = rocket::Config::from(figment);
let tls_config = config.tls.as_ref().unwrap();
assert!(tls_config.certs().is_left());
assert!(tls_config.key().is_right());

When a path is configured in a file source, such as Rocket.toml, relative paths are interpreted as being relative to the source file’s directory.

Implementations

impl TlsConfig[src]

pub fn from_paths<C, K>(certs: C, key: K) -> Self where
    C: AsRef<Path>,
    K: AsRef<Path>, 
[src]

Constructs a TlsConfig from paths to a certs certificate-chain a key private-key. This method does no validation; it simply creates a structure suitable for passing into a Config.

Example

use rocket::config::TlsConfig;

let tls_config = TlsConfig::from_paths("/ssl/certs.pem", "/ssl/key.pem");

pub fn from_bytes(certs: &[u8], key: &[u8]) -> Self[src]

Constructs a TlsConfig from byte buffers to a certs certificate-chain a key private-key. This method does no validation; it simply creates a structure suitable for passing into a Config.

Example

use rocket::config::TlsConfig;

let tls_config = TlsConfig::from_bytes(certs_buf, key_buf);

pub fn certs(&self) -> Either<PathBuf, &[u8]>[src]

Returns the value of the certs parameter.

Example

use rocket::Config;

let figment = Config::figment()
    .merge(("tls.certs", vec![0; 32]))
    .merge(("tls.key", "/etc/ssl/key.pem"));

let config = rocket::Config::from(figment);
let tls_config = config.tls.as_ref().unwrap();
let cert_bytes = tls_config.certs().right().unwrap();
assert!(cert_bytes.iter().all(|&b| b == 0));

pub fn key(&self) -> Either<PathBuf, &[u8]>[src]

Returns the value of the key parameter.

Example

use std::path::Path;
use rocket::Config;

let figment = Config::figment()
    .merge(("tls.certs", vec![0; 32]))
    .merge(("tls.key", "/etc/ssl/key.pem"));

let config = rocket::Config::from(figment);
let tls_config = config.tls.as_ref().unwrap();
let key_path = tls_config.key().left().unwrap();
assert_eq!(key_path, Path::new("/etc/ssl/key.pem"));

Trait Implementations

impl Clone for TlsConfig[src]

fn clone(&self) -> TlsConfig[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for TlsConfig[src]

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for TlsConfig[src]

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 
[src]

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<TlsConfig> for TlsConfig[src]

fn eq(&self, other: &TlsConfig) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &TlsConfig) -> bool[src]

This method tests for !=.

impl Serialize for TlsConfig[src]

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer
[src]

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for TlsConfig[src]

Auto Trait Implementations

impl RefUnwindSafe for TlsConfig

impl Send for TlsConfig

impl Sync for TlsConfig

impl Unpin for TlsConfig

impl UnwindSafe for TlsConfig

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

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

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> IntoCollection<T> for T

pub fn into_collection<A>(self) -> SmallVec<A> where
    A: Array<Item = T>, 

Converts self into a collection.

pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
    F: FnMut(T) -> U,
    A: Array<Item = U>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

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.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

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.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]