Struct Authenticator 

pub struct Authenticator { /* private fields */ }

Implementations

impl Authenticator

pub const ALPN: &'static [u8] = crate::ALPN

pub fn new<S: IntoSecret>(secret: S) -> Self

Examples found in repository

examples/basic.rs (line 20)

async fn main() -> Result<(), String> {
    // 1. Create the authenticator with a shared secret
    let auth = Authenticator::new("my-super-secret-password");

    // 2. Build the endpoint with the auth hooks
    let endpoint = Endpoint::builder(iroh::endpoint::presets::N0)
        .hooks(auth.clone())
        .bind()
        .await.map_err(|e| e.to_string())?;

    // 3. The authenticator needs a reference to the bound endpoint 
    // to initiate authentication handshakes.
    auth.set_endpoint(&endpoint).await;

    // 4. Register the auth protocol handler
    let router = Router::builder(endpoint)
        .accept(iroh_auth::ALPN, auth.clone())

        // Register your actual application protocols here
        .accept(b"/my-app/1.0", MyProtocolHandler)
        .spawn();
    
    // ... run your application
    router.shutdown().await.map_err(|e| e.to_string())?;
    Ok(())
}

pub async fn set_endpoint(&self, endpoint: &Endpoint)

Examples found in repository

examples/basic.rs (line 30)

async fn main() -> Result<(), String> {
    // 1. Create the authenticator with a shared secret
    let auth = Authenticator::new("my-super-secret-password");

    // 2. Build the endpoint with the auth hooks
    let endpoint = Endpoint::builder(iroh::endpoint::presets::N0)
        .hooks(auth.clone())
        .bind()
        .await.map_err(|e| e.to_string())?;

    // 3. The authenticator needs a reference to the bound endpoint 
    // to initiate authentication handshakes.
    auth.set_endpoint(&endpoint).await;

    // 4. Register the auth protocol handler
    let router = Router::builder(endpoint)
        .accept(iroh_auth::ALPN, auth.clone())

        // Register your actual application protocols here
        .accept(b"/my-app/1.0", MyProtocolHandler)
        .spawn();
    
    // ... run your application
    router.shutdown().await.map_err(|e| e.to_string())?;
    Ok(())
}

pub async fn is_authenticated(&self, id: &PublicKey) -> bool

Trait Implementations

impl Clone for Authenticator

fn clone(&self) -> Authenticator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Authenticator

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

Formats the value using the given formatter.

impl EndpointHooks for Authenticator

async fn after_handshake<'a>( &'a self, conn: &'a Connection, ) -> AfterHandshakeOutcome

Intercept both incoming and outgoing connections once the TLS handshake has completed.

async fn before_connect<'a>( &'a self, remote_addr: &'a EndpointAddr, alpn: &'a [u8], ) -> BeforeConnectOutcome

Intercept outgoing connections before they are started.

impl ProtocolHandler for Authenticator

async fn accept(&self, connection: Connection) -> Result<(), AcceptError>

Handle an incoming connection.

fn on_accepting( &self, accepting: Accepting, ) -> impl Future<Output = Result<Connection, AcceptError>> + Send

Optional interception point to handle the Accepting state.

fn shutdown(&self) -> impl Future<Output = ()> + Send

Called when the router shuts down.