Skip to main content

AlpnHandlerConfig

Struct AlpnHandlerConfig 

Source
pub struct AlpnHandlerConfig {
Show 24 fields pub allowed_hosts: Vec<HostPattern>, pub public_ip_addresses: Vec<IpAddr>, pub verify_dns_before_issuance: bool, pub dns_servers: Option<Vec<DnsServer>>, pub cert_store_directory: PathBuf, pub cert_store: Option<Arc<dyn CertStore>>, pub acme_endpoint: AcmeEndpoint, pub acme_contacts: Vec<String>, pub renew_days_before_expiry: u32, pub renew_check_interval_secs: u64, pub renew_check_max_interval_secs: u64, pub client_hello_timeout_secs: u64, pub issuance_attempt_timeout_secs: u64, pub initial_connection_wait_timeout_secs: u64, pub dns_lookup_timeout_secs: u64, pub pebble_startup_timeout_secs: u64, pub local_fallback_enabled: bool, pub local_leaf_validity_days: u32, pub events: EventOutput, pub event_handler: Option<Arc<dyn Fn(&Event) + Send + Sync + 'static>>, pub event_channel_capacity: usize, pub event_history_capacity: usize, pub allow_non_443_listener: bool, pub application_alpn_protocols: Vec<Vec<u8>>,
}

Fields§

§allowed_hosts: Vec<HostPattern>§public_ip_addresses: Vec<IpAddr>§verify_dns_before_issuance: bool§dns_servers: Option<Vec<DnsServer>>§cert_store_directory: PathBuf§cert_store: Option<Arc<dyn CertStore>>§acme_endpoint: AcmeEndpoint§acme_contacts: Vec<String>§renew_days_before_expiry: u32§renew_check_interval_secs: u64§renew_check_max_interval_secs: u64§client_hello_timeout_secs: u64§issuance_attempt_timeout_secs: u64§initial_connection_wait_timeout_secs: u64§dns_lookup_timeout_secs: u64§pebble_startup_timeout_secs: u64§local_fallback_enabled: bool§local_leaf_validity_days: u32§events: EventOutput§event_handler: Option<Arc<dyn Fn(&Event) + Send + Sync + 'static>>§event_channel_capacity: usize§event_history_capacity: usize§allow_non_443_listener: bool§application_alpn_protocols: Vec<Vec<u8>>

Implementations§

Source§

impl AlpnHandlerConfig

Source

pub fn for_host(host: impl AsRef<str>) -> Result<Self>

Create a configuration for the common single-host case.

Advanced users can replace allowed_hosts with exact and wildcard HostPattern values after construction.

Examples found in repository?
examples/pebble_local.rs (line 11)
9async fn main() -> Result<(), Box<dyn std::error::Error>> {
10    let listener = TcpListener::bind("127.0.0.1:8443").await?;
11    let mut config = AlpnHandlerConfig::for_host("api.test")?;
12    config.public_ip_addresses = vec!["127.0.0.1".parse()?];
13    config.verify_dns_before_issuance = false;
14    config.cert_store_directory = PathBuf::from("./certs");
15    config.acme_endpoint = AcmeEndpoint::Pebble(ManagedPebbleConfig {
16            pebble_bind: "127.0.0.1:14000".parse::<SocketAddr>()?,
17            pebble_executable: None,
18            working_directory: None,
19            state_directory: Some(PathBuf::from("./certs/pebble-state")),
20        });
21    config.events = EventOutput::Stderr;
22    config.allow_non_443_listener = true;
23    config.local_fallback_enabled = true;
24    let mut listener = register_alpn_handler(listener, Some(config)).await?;
25    while let Some(connection) = listener.accept().await? { tokio::spawn(async move { drop(connection.into_stream()); }); }
26    Ok(())
27}
More examples
Hide additional examples
examples/letsencrypt_prod.rs (line 15)
11async fn main() -> Result<(), Box<dyn std::error::Error>> {
12    let host = "api.example.com";
13    let public_ip: IpAddr = "203.0.113.10".parse()?;
14    let listener = TcpListener::bind("0.0.0.0:443").await?;
15    let mut config = AlpnHandlerConfig::for_host(&host)?;
16    config.public_ip_addresses = vec![public_ip];
17    config.dns_servers = Some(vec!["udp://1.1.1.1:53".parse::<DnsServer>()?, "udp://8.8.8.8:53".parse::<DnsServer>()?]);
18    config.verify_dns_before_issuance = true;
19    config.cert_store_directory = PathBuf::from("./certs");
20    config.acme_endpoint = AcmeEndpoint::LetsEncrypt(LetsEncryptAcmeProfile::Production);
21    config.acme_contacts = vec!["mailto:ops@example.com".into()];
22    config.events = EventOutput::Stderr;
23    config.local_fallback_enabled = true;
24    let mut listener = register_alpn_handler(listener, Some(config)).await?;
25    while let Some(connection) = listener.accept().await? {
26        tokio::spawn(async move { drop(connection.into_stream()); });
27    }
28    Ok(())
29}
examples/letsencrypt_staging.rs (line 15)
11async fn main() -> Result<(), Box<dyn std::error::Error>> {
12    let host = "api.example.com";
13    let public_ip: IpAddr = "203.0.113.10".parse()?;
14    let listener = TcpListener::bind("0.0.0.0:443").await?;
15    let mut config = AlpnHandlerConfig::for_host(&host)?;
16    config.public_ip_addresses = vec![public_ip];
17    config.dns_servers = Some(vec!["udp://1.1.1.1:53".parse::<DnsServer>()?, "udp://8.8.8.8:53".parse::<DnsServer>()?]);
18    config.verify_dns_before_issuance = true;
19    config.cert_store_directory = PathBuf::from("./certs");
20    config.acme_endpoint = AcmeEndpoint::LetsEncrypt(LetsEncryptAcmeProfile::Staging);
21    config.acme_contacts = vec!["mailto:ops@example.com".into()];
22    config.events = EventOutput::Subscribe;
23    config.local_fallback_enabled = true;
24    let mut listener = register_alpn_handler(listener, Some(config)).await?;
25    let mut events = subscribe_events()?;
26    tokio::spawn(async move { while let Ok(Some(event)) = events.recv().await { eprintln!("staging event: {event}"); } });
27    while let Some(connection) = listener.accept().await? { tokio::spawn(async move { drop(connection.into_stream()); }); }
28    Ok(())
29}
Source

pub fn for_hosts<I, S>(hosts: I) -> Result<Self>
where I: IntoIterator<Item = S>, S: AsRef<str>,

Create a configuration for one or more exact or *. single-label hosts.

Source

pub fn builder() -> AlpnHandlerConfigBuilder

Trait Implementations§

Source§

impl Clone for AlpnHandlerConfig

Source§

fn clone(&self) -> AlpnHandlerConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AlpnHandlerConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AlpnHandlerConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more