tap-http 0.7.0

HTTP server for the Transaction Authorization Protocol (TAP)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! Configuration for the TAP HTTP server.

use crate::event::EventLoggerConfig;
use serde::{Deserialize, Serialize};
use std::time::Duration;

/// Configuration for the TAP HTTP server.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TapHttpConfig {
    /// The host address to bind to.
    pub host: String,

    /// The port to bind to.
    pub port: u16,

    /// The endpoint path for receiving DIDComm messages.
    pub didcomm_endpoint: String,

    /// Optional rate limiting configuration.
    pub rate_limit: Option<RateLimitConfig>,

    /// Optional TLS configuration.
    pub tls: Option<TlsConfig>,

    /// Default timeout for outbound HTTP requests in seconds.
    pub request_timeout_secs: u64,

    /// Optional event logger configuration.
    /// If not provided, no event logging will be performed.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub event_logger: Option<EventLoggerConfig>,

    /// Enable the `/.well-known/did.json` endpoint for did:web hosting.
    /// When enabled, the server resolves the HTTP Host header to a `did:web`
    /// DID and serves the corresponding DID document.
    pub enable_web_did: bool,

    /// Maximum number of agents that can be auto-created via the web DID endpoint.
    /// Prevents denial-of-service via unbounded agent creation.
    pub max_agents: usize,
}

/// Configuration for rate limiting.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RateLimitConfig {
    /// Maximum number of requests per window.
    pub max_requests: u32,

    /// Time window in seconds.
    pub window_secs: u64,
}

/// Configuration for TLS.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TlsConfig {
    /// Path to the certificate file.
    pub cert_path: String,

    /// Path to the key file.
    pub key_path: String,
}

impl Default for TapHttpConfig {
    fn default() -> Self {
        Self {
            host: "127.0.0.1".to_string(),
            port: 8000,
            didcomm_endpoint: "/didcomm".to_string(),
            rate_limit: None,
            tls: None,
            request_timeout_secs: 30,
            event_logger: Some(EventLoggerConfig::default()),
            enable_web_did: false,
            max_agents: 100,
        }
    }
}

impl TapHttpConfig {
    /// Returns the full server address as a string (e.g., "127.0.0.1:8000").
    pub fn server_addr(&self) -> String {
        format!("{}:{}", self.host, self.port)
    }

    /// Returns the full URL for the DIDComm endpoint.
    pub fn didcomm_url(&self, secure: bool) -> String {
        let protocol = if secure || self.tls.is_some() {
            "https"
        } else {
            "http"
        };
        format!(
            "{}://{}:{}{}",
            protocol, self.host, self.port, self.didcomm_endpoint
        )
    }

    /// Returns the request timeout as a Duration.
    pub fn request_timeout(&self) -> Duration {
        Duration::from_secs(self.request_timeout_secs)
    }
}