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 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
//! # ids-daps
//!
//! The `ids-daps` crate provides a rust client for the Dynamic Attribute Token Service (DAPS) of
//! the Reference Architecture Model 4 (RAM 4) of the International Data Spaces Association (IDSA).
//!
//! ## Usage
//!
//! ```
//! use ids_daps_client::{DapsConfigBuilder, DapsClient, ReqwestDapsClient};
//! # use testcontainers::runners::AsyncRunner;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! # // Let's start a DAPS for test purposes
//! # let image = testcontainers::GenericImage::new("ghcr.io/ids-basecamp/daps", "test");
//! # let container = image
//! # .with_exposed_port(4567.into()) // will default to TCP protocol
//! # .with_wait_for(testcontainers::core::WaitFor::message_on_stdout(
//! # "Listening on 0.0.0.0:4567, CTRL+C to stop",
//! # ))
//! # .start()
//! # .await
//! # .expect("Failed to start DAPS container");
//! #
//! # // Retrieve the host port mapped to the container's internal port 4567
//! # let host = container.get_host().await.expect("Failed to get host");
//! # let host_port = container
//! # .get_host_port_ipv4(4567)
//! # .await
//! # .expect("Failed to get port");
//! #
//! # // Construct URLs using the dynamically retrieved host and host_port
//! # let certs_url = format!("http://{host}:{host_port}/jwks.json");
//! # let token_url = format!("http://{host}:{host_port}/token");
//! #
//! // Create a DAPS client configuration
//! let config = DapsConfigBuilder::default()
//! .certs_url(certs_url)
//! .token_url(token_url)
//! .private_key(std::path::Path::new("./testdata/connector-certificate.p12"))
//! .private_key_password(Some(std::borrow::Cow::from("Password1")))
//! .scope(std::borrow::Cow::from("idsc:IDS_CONNECTORS_ALL"))
//! .certs_cache_ttl(1)
//! .build()
//! .expect("Failed to build DAPS-Config");
//!
//! // Create DAPS client
//! let client: ReqwestDapsClient<'_> = DapsClient::new(&config);
//!
//! // Request a DAT token
//! let dat = client.request_dat().await?;
//! println!("DAT Token: {:?}", dat);
//!
//! // Validate the DAT token
//! if client.validate_dat(&dat).await.is_ok() {
//! println!("Validation successful");
//! }
//!
//! Ok(())
//! }
#![deny(unsafe_code, rust_2018_idioms, clippy::unwrap_used)]
#![warn(rust_2024_compatibility, clippy::pedantic)]
#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub mod cert;
mod http_client;
use std::borrow::Cow;
/// The type of the audience field in the DAT token. It can be a single string or a list of strings.
#[derive(Debug, serde::Deserialize, Clone)]
#[serde(untagged)]
#[allow(dead_code)]
enum Audience {
Single(String),
Multiple(Vec<String>),
}
#[derive(Debug, serde::Serialize, Clone)]
struct TokenClaims {
#[serde(rename = "@type")]
type_: String,
#[serde(rename = "@context")]
context_: String,
iss: String,
sub: String,
id: String,
jti: String,
aud: String,
iat: i64,
exp: i64,
nbf: i64,
}
/// Token response from the DAPS.
#[derive(Debug, serde::Deserialize, Clone)]
pub struct TokenResponse {
pub access_token: String,
pub token_type: String,
pub expires_in: u64,
pub scope: Option<String>,
}
/// Claims within the DAT token.
#[derive(Debug, serde::Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
#[allow(dead_code)]
pub struct DatClaims {
#[serde(rename = "@type")]
type_: String,
#[serde(rename = "@context")]
context_: String,
referring_connector: String,
security_profile: String,
#[serde(rename = "iat")]
issued_at: i64,
#[serde(rename = "exp")]
expires_at: i64,
#[serde(rename = "nbf")]
not_before: i64,
#[serde(rename = "sub")]
subject: String,
#[serde(rename = "aud")]
audience: Audience,
#[serde(rename = "iss")]
issuer: String,
#[serde(rename = "jti")]
jwt_id: String,
}
#[derive(thiserror::Error, Debug)]
pub enum DapsError {
#[error("http client error: {0}")]
DapsHttpClient(#[from] http_client::DapsHttpClientError),
#[error("jwt error")]
InvalidToken,
}
/// Configuration for the DAPS client.
#[derive(Debug, derive_builder::Builder)]
#[builder(setter(into), build_fn(validate = "Self::validate"))]
pub struct DapsConfig<'a> {
/// The URL for the request of a DAPS token.
token_url: Cow<'a, str>,
/// The URL for the request of the certificates for validation.
certs_url: Cow<'a, str>,
/// The local path to the private key file.
private_key: Cow<'a, std::path::Path>,
/// The password for the private key file.
private_key_password: Option<Cow<'a, str>>,
/// The scope for the DAPS token.
scope: Cow<'a, str>,
/// The time-to-live for the certificates cache in seconds.
certs_cache_ttl: i64,
}
impl DapsConfigBuilder<'_> {
/// Validates the configuration.
pub fn validate(&self) -> Result<(), String> {
if self.token_url.is_none() {
return Err("Token URL is empty".to_string());
} else if let Some(token_url) = self.token_url.clone() {
token_url
.parse::<url::Url>()
.map_err(|e| format!("Token URL is invalid: {e}"))?;
}
if self.certs_url.is_none() {
return Err("Certs URL is empty".to_string());
} else if let Some(certs_url) = self.certs_url.clone() {
certs_url
.parse::<url::Url>()
.map_err(|e| format!("Certs URL is invalid: {e}"))?;
}
if self.private_key.is_none() {
return Err("Private key path is empty".to_string());
}
if self.private_key_password.is_none() {
return Err("Private key password is empty".to_string());
}
if self.scope.is_none() {
return Err("Scope is empty".to_string());
}
Ok(())
}
}
/// A cache for the certificates of the DAPS.
struct CertificatesCache {
stored: chrono::DateTime<chrono::Utc>,
jwks: jsonwebtoken::jwk::JwkSet,
}
/// An alias for the DAPS client using the Reqwest HTTP client.
pub type ReqwestDapsClient<'a> = DapsClient<'a, http_client::reqwest_client::ReqwestDapsClient>;
/// The main struct of this crate. It provides the functionality to request and validate DAT tokens
/// from a DAPS.
pub struct DapsClient<'a, C> {
/// The HTTP client to use for requests. It is generic over the actual implementation.
client: C,
/// The subject of the client.
sub: Cow<'a, str>,
/// The URL for the request of the certificates for validation.
certs_url: String,
/// The URL for the request of a DAPS token.
token_url: String,
/// The scope for the DAPS token.
scope: String,
/// The encoding key for the JWT.
encoding_key: jsonwebtoken::EncodingKey,
/// The UUID context for the JWT. To generate ordered UUIDs (v7).
uuid_context: uuid::ContextV7,
/// A cache for the certificates of the DAPS.
certs_cache: async_lock::RwLock<CertificatesCache>,
/// TTL for the cache.
cache_ttl: chrono::Duration,
}
impl<C> DapsClient<'_, C>
where
C: http_client::DapsClientRequest,
{
/// Creates a new DAPS client based on the given configuration.
#[must_use]
pub fn new(config: &DapsConfig<'_>) -> Self {
// Read sub and private key from file
let (ski_aki, private_key) = cert::ski_aki_and_private_key_from_file(
config.private_key.as_ref(),
config.private_key_password.as_deref().unwrap_or(""),
)
.expect("Reading SKI:AKI failed");
// Use private key to create the encoding key
let encoding_key = jsonwebtoken::EncodingKey::from_rsa_der(private_key.as_ref());
Self {
client: C::default(),
sub: ski_aki,
scope: config.scope.to_string(),
certs_url: config.certs_url.to_string(),
token_url: config.token_url.to_string(),
encoding_key,
uuid_context: uuid::ContextV7::new(),
certs_cache: async_lock::RwLock::new(CertificatesCache {
stored: chrono::DateTime::from_timestamp(0, 0).expect("This is a valid timestamp"),
jwks: jsonwebtoken::jwk::JwkSet { keys: Vec::new() },
}),
cache_ttl: chrono::Duration::seconds(config.certs_cache_ttl),
}
}
/// Validates a DAT token against the DAPS.
pub async fn validate_dat(
&self,
token: &str,
) -> Result<jsonwebtoken::TokenData<DatClaims>, DapsError> {
// Get JWKS from DAPS
let jwks = self.get_certs().await?;
// Set up validation configuration
let mut validation = jsonwebtoken::Validation::new(jsonwebtoken::Algorithm::RS256);
validation.sub = Some(self.sub.to_string());
validation.set_audience(&["idsc:IDS_CONNECTORS_ALL"]);
validation.set_required_spec_claims(&["exp", "nbf", "aud", "iss", "sub"]);
// Decode against all keys
let validation_results: Vec<jsonwebtoken::TokenData<_>> = jwks
.keys
.iter()
.filter_map(|jwk| {
if let Ok(jwk) = jsonwebtoken::DecodingKey::from_jwk(jwk) {
let result = jsonwebtoken::decode(token, &jwk, &validation);
tracing::debug!("Validation result: {:?}", result);
result.ok()
} else {
None
}
})
.collect();
// Return first positive validation result
validation_results
.first()
.ok_or(DapsError::InvalidToken)
.cloned()
}
/// Requests a DAT token from the DAPS.
pub async fn request_dat(&self) -> Result<String, DapsError> {
// Get the current timestamp for the claims
let now = chrono::Utc::now();
let now_secs = now.timestamp();
let now_subsec_nanos = now.timestamp_subsec_nanos();
#[allow(clippy::cast_sign_loss)]
let uuid_timestamp =
uuid::Timestamp::from_unix(&self.uuid_context, now_secs as u64, now_subsec_nanos);
// Create a JWT for the client assertion
let header = jsonwebtoken::Header::new(jsonwebtoken::Algorithm::RS256);
let claims = TokenClaims {
context_: "https://w3id.org/idsa/contexts/context.jsonld".to_string(),
type_: "ids:DatRequestToken".to_string(),
jti: uuid::Uuid::new_v7(uuid_timestamp).hyphenated().to_string(),
iss: self.sub.to_string(),
sub: self.sub.to_string(),
id: self.sub.to_string(),
aud: self.scope.clone(),
iat: now_secs,
exp: now_secs + 3600,
nbf: now_secs,
};
// Encode token
let token = jsonwebtoken::encode(&header, &claims, &self.encoding_key)
.expect("Token signing failed. There must be something wrong with the private key.");
tracing::debug!("Issued TokenRequest (requestDAT): {}", token);
let response = self
.client
.request_token(
self.token_url.as_ref(),
&[
("grant_type", "client_credentials"),
("scope", "idsc:IDS_CONNECTOR_ATTRIBUTES_ALL"),
(
"client_assertion_type",
"urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
),
("client_assertion", &token),
],
)
.await?;
Ok(response.access_token)
}
/// Updates the certificate cache with the Certificates requested from the DAPS.
async fn update_cert_cache(&self) -> Result<jsonwebtoken::jwk::JwkSet, DapsError> {
let jwks = self.client.get_certs(self.certs_url.as_ref()).await?;
let mut cache = self.certs_cache.write().await;
cache.jwks = jwks;
cache.stored = chrono::Utc::now();
tracing::debug!("Cache updated");
Ok(cache.jwks.clone())
}
/// Returns the certificates from the cache or updates the cache if it is outdated.
async fn get_certs(&self) -> Result<jsonwebtoken::jwk::JwkSet, DapsError> {
let now = chrono::Utc::now();
tracing::debug!("Checking cache...");
let cache = self.certs_cache.read().await;
if cache.stored + self.cache_ttl < now {
tracing::info!("Cache is outdated, updating...");
// Cache is outdated, drop lock
drop(cache);
// Update cache & return jwks
self.update_cert_cache().await
} else {
tracing::debug!("Cache is up-to-date");
Ok(cache.jwks.clone())
}
}
}
#[cfg(test)]
mod test {
use super::*;
#[tokio::test]
async fn integration_test() {
use testcontainers::runners::AsyncRunner;
// Setting up logger to debug issues
tracing_subscriber::fmt()
.with_env_filter(tracing_subscriber::EnvFilter::new("ids_daps=DEBUG"))
.init();
// Starting the test DAPS
let image = testcontainers::GenericImage::new("ghcr.io/ids-basecamp/daps", "test");
let container = image
.with_exposed_port(4567.into()) // will default to TCP protocol
.with_wait_for(testcontainers::core::WaitFor::message_on_stdout(
"Listening on 0.0.0.0:4567, CTRL+C to stop",
))
.start()
.await
.expect("Failed to start DAPS container");
// Retrieve the host port mapped to the container's internal port 4567
let host = container.get_host().await.expect("Failed to get host");
let host_port = container
.get_host_port_ipv4(4567)
.await
.expect("Failed to get port");
// Construct URLs using the dynamically retrieved host and host_port
let certs_url = format!("http://{host}:{host_port}/jwks.json");
let token_url = format!("http://{host}:{host_port}/token");
// Create DAPS config
let config = DapsConfigBuilder::create_empty()
.certs_url(certs_url)
.token_url(token_url)
.private_key(std::path::Path::new("./testdata/connector-certificate.p12"))
.private_key_password(Some(Cow::from("Password1")))
.scope(Cow::from("idsc:IDS_CONNECTORS_ALL"))
.certs_cache_ttl(1)
.build()
.expect("Failed to build DAPS-Config");
// Create DAPS client
let client: ReqwestDapsClient<'_> = DapsClient::new(&config);
// Now the test really starts...
// Request a DAT token
let dat = client.request_dat().await.unwrap();
tracing::info!("DAT Token: {:?}", dat);
// Validate the DAT token
let cache1_start = std::time::Instant::now();
if let Err(err) = client.validate_dat(&dat).await {
tracing::error!("Validation failed: {:?}", err);
panic!("Validation failed");
} else {
assert!(client.validate_dat(&dat).await.is_ok());
}
tracing::debug!("First validation took {:?}", cache1_start.elapsed());
// Checking again to use cache
let cache2_start = std::time::Instant::now();
assert!(client.validate_dat(&dat).await.is_ok());
tracing::debug!("Second validation took {:?}", cache2_start.elapsed());
// Wait for cache to expire
tokio::time::sleep(std::time::Duration::from_secs(2)).await;
// Now the cache should be outdated
let cache3_start = std::time::Instant::now();
assert!(client.validate_dat(&dat).await.is_ok());
tracing::debug!("Third validation took {:?}", cache3_start.elapsed());
}
}