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 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
use std::collections::BTreeMap;
use iref::IriRefBuf;
use serde::{Deserialize, Serialize};
use crate::{
document::{self, representation, DIDVerificationMethod, InvalidData},
DIDMethod, Document, PrimaryDIDURL, VerificationMethodDIDResolver, DID, DIDURL,
};
mod composition;
mod dereference;
mod static_resolver;
pub use dereference::*;
pub use static_resolver::StaticDIDResolver;
#[cfg(feature = "http")]
mod http;
#[cfg(feature = "http")]
pub use http::*;
/// Pseudo-media-type used when returning a URL from
/// [DID URL dereferencing](DIDResolver::dereference).
pub const MEDIA_TYPE_URL: &str = "text/url";
/// DID resolution error.
///
/// Error raised by the [`DIDResolver::resolve`] method.
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// DID method is not supported by this resolver.
#[error("DID method `{0}` not supported")]
MethodNotSupported(String),
/// DID document could not be found.
#[error("DID document not found")]
NotFound,
/// Resolver doesn't know what representation to use for the DID document.
#[error("no representation specified")]
NoRepresentation,
/// Requested DID document representation is not supported.
#[error("DID representation `{0}` not supported")]
RepresentationNotSupported(String),
/// Invalid data provided to the resolver.
#[error(transparent)]
InvalidData(InvalidData),
/// Invalid method-specific identifier.
#[error("invalid method specific identifier: {0}")]
InvalidMethodSpecificId(String),
/// Invalid resolution options.
#[error("invalid options")]
InvalidOptions,
/// Internal resolver-specific error.
#[error("DID resolver internal error: {0}")]
Internal(String),
}
impl Error {
/// Creates a new internal error.
pub fn internal(error: impl ToString) -> Self {
Self::Internal(error.to_string())
}
/// Returns the error kind.
pub fn kind(&self) -> ErrorKind {
match self {
Self::MethodNotSupported(_) => ErrorKind::MethodNotSupported,
Self::NotFound => ErrorKind::NotFound,
Self::NoRepresentation => ErrorKind::NoRepresentation,
Self::RepresentationNotSupported(_) => ErrorKind::RepresentationNotSupported,
Self::InvalidData(_) => ErrorKind::InvalidData,
Self::InvalidMethodSpecificId(_) => ErrorKind::InvalidMethodSpecificId,
Self::InvalidOptions => ErrorKind::InvalidOptions,
Self::Internal(_) => ErrorKind::Internal,
}
}
}
impl From<representation::Unknown> for Error {
fn from(value: representation::Unknown) -> Self {
Self::RepresentationNotSupported(value.0)
}
}
/// Resolution error kind.
///
/// Each resolution [`Error`] has a kind provided by the [`Error::kind`] method.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum ErrorKind {
MethodNotSupported,
NotFound,
NoRepresentation,
RepresentationNotSupported,
InvalidData,
InvalidMethodSpecificId,
InvalidOptions,
Internal,
}
pub trait DIDResolverByMethod {
type MethodResolver: DIDMethodResolver;
/// Returns a resolver for the given method name, if any.
fn get_method(&self, method_name: &str) -> Option<&Self::MethodResolver>;
fn supports_method(&self, method_name: &str) -> bool {
self.get_method(method_name).is_some()
}
}
impl<T: DIDResolverByMethod> DIDResolver for T {
async fn resolve_representation<'a>(
&'a self,
did: &'a DID,
options: Options,
) -> Result<Output<Vec<u8>>, Error> {
match self.get_method(did.method_name()) {
Some(m) => {
m.resolve_method_representation(did.method_specific_id(), options)
.await
}
None => Err(Error::MethodNotSupported(did.method_name().to_string())),
}
}
}
/// [DID resolver](https://www.w3.org/TR/did-core/#dfn-did-resolvers).
///
/// Any type implementing the [DID Resolution](https://www.w3.org/TR/did-core/#did-resolution)
/// [algorithm](https://w3c-ccg.github.io/did-resolution/#resolving-algorithm)
/// through the [`resolve`](DIDResolver::resolve) method
/// and the [DID URL Dereferencing](https://www.w3.org/TR/did-core/#did-url-dereferencing)
/// algorithm through the [`dereference`](DIDResolver::dereference) method.
///
/// This library provides the [`AnyDidMethod`] that implements this trait
/// by grouping various DID method implementations.
///
/// [`AnyDidMethod`]: <../dids/struct.AnyDidMethod.html>
pub trait DIDResolver {
/// Resolves a DID representation.
///
/// Fetches the DID document representation referenced by the input DID
/// using the given options.
///
/// See: <https://www.w3.org/TR/did-core/#did-resolution>
#[allow(async_fn_in_trait)]
async fn resolve_representation<'a>(
&'a self,
did: &'a DID,
options: Options,
) -> Result<Output<Vec<u8>>, Error>;
/// Resolves a DID with the given options.
///
/// Fetches the DID document referenced by the input DID using the given
/// options.
///
/// See: <https://www.w3.org/TR/did-core/#did-resolution>
#[allow(async_fn_in_trait)]
async fn resolve_with<'a>(&'a self, did: &'a DID, options: Options) -> Result<Output, Error> {
let output = self.resolve_representation(did, options).await?;
match &output.metadata.content_type {
None => Err(Error::NoRepresentation),
Some(ty) => {
let ty: representation::MediaType = ty.parse()?;
output
.try_map(|bytes| Document::from_bytes(ty, &bytes))
.map_err(Error::InvalidData)
}
}
}
/// Resolves a DID.
///
/// Fetches the DID document referenced by the input DID using the default
/// options.
///
/// See: <https://www.w3.org/TR/did-core/#did-resolution>
#[allow(async_fn_in_trait)]
async fn resolve<'a>(&'a self, did: &'a DID) -> Result<Output, Error> {
self.resolve_with(did, Options::default()).await
}
/// Resolves a DID and extracts one of the verification methods it defines.
///
/// This will return the first verification method found, although users
/// should not expect the DID documents to always list verification methods
/// in the same order.
///
/// See: [`Document::into_any_verification_method()`].
#[allow(async_fn_in_trait)]
async fn resolve_into_any_verification_method<'a>(
&'a self,
did: &'a DID,
) -> Result<Option<DIDVerificationMethod>, Error> {
Ok(self
.resolve(did)
.await?
.document
.into_document()
.into_any_verification_method())
}
/// Dereference a DID URL to retrieve the primary content.
///
/// See: <https://www.w3.org/TR/did-core/#did-url-dereferencing>
/// See: <https://w3c-ccg.github.io/did-resolution/#dereferencing-algorithm>
#[allow(async_fn_in_trait)]
async fn dereference_primary<'a>(
&'a self,
primary_did_url: &'a PrimaryDIDURL,
) -> Result<DerefOutput<PrimaryContent>, DerefError> {
self.dereference_primary_with(primary_did_url, Options::default())
.await
}
/// Dereference a DID URL to retrieve the primary content.
///
/// See: <https://www.w3.org/TR/did-core/#did-url-dereferencing>
/// See: <https://w3c-ccg.github.io/did-resolution/#dereferencing-algorithm>
#[allow(async_fn_in_trait)]
async fn dereference_primary_with<'a>(
&'a self,
primary_did_url: &'a PrimaryDIDURL,
mut resolve_options: Options,
) -> Result<DerefOutput<PrimaryContent>, DerefError> {
// 2
resolve_options.extend(match primary_did_url.query() {
Some(query) => serde_urlencoded::from_str(query.as_str()).unwrap(),
None => Options::default(),
});
let parameters = resolve_options.parameters.clone();
let resolution_output = self
.resolve_with(primary_did_url.did(), resolve_options)
.await?;
dereference_primary_resource(self, primary_did_url, parameters, resolution_output).await
}
/// Dereference a DID URL with a path or query to retrieve the primary
/// content.
///
/// This function is called from [`Self::dereference_primary()`] only if
/// the primary DID url has a path and/or query, and the query does not
/// include any service.
/// Users should always call [`Self::dereference_primary()`].
///
/// See: <https://www.w3.org/TR/did-core/#did-url-dereferencing>
/// See: <https://w3c-ccg.github.io/did-resolution/#dereferencing-algorithm>
#[allow(async_fn_in_trait)]
async fn dereference_primary_with_path_or_query<'a>(
&'a self,
_primary_did_url: &'a PrimaryDIDURL,
) -> Result<DerefOutput<PrimaryContent>, DerefError> {
Err(DerefError::NotFound)
}
/// Dereference a DID URL.
///
/// See: <https://www.w3.org/TR/did-core/#did-url-dereferencing>
/// See: <https://w3c-ccg.github.io/did-resolution/#dereferencing-algorithm>
#[allow(async_fn_in_trait)]
async fn dereference_with<'a>(
&'a self,
did_url: &'a DIDURL,
options: Options,
) -> Result<DerefOutput, DerefError> {
let (primary_did_url, fragment) = did_url.without_fragment();
let primary_deref_output = self
.dereference_primary_with(primary_did_url, options)
.await?;
// 4
match fragment {
Some(fragment) => {
dereference_secondary_resource(primary_did_url, fragment, primary_deref_output)
}
None => Ok(primary_deref_output.cast()),
}
}
/// Dereference a DID URL.
///
/// See: <https://www.w3.org/TR/did-core/#did-url-dereferencing>
/// See: <https://w3c-ccg.github.io/did-resolution/#dereferencing-algorithm>
#[allow(async_fn_in_trait)]
async fn dereference<'a>(&'a self, did_url: &'a DIDURL) -> Result<DerefOutput, DerefError> {
self.dereference_with(did_url, Options::default()).await
}
/// Turns this DID resolver into a verification method resolver.
///
/// To resolve a verification method, the output resolver will first
/// resolve the DID using the given `options` then pull the referenced
/// method from the DID document.
fn into_vm_resolver_with<M>(self, options: Options) -> VerificationMethodDIDResolver<Self, M>
where
Self: Sized,
{
VerificationMethodDIDResolver::new_with_options(self, options)
}
/// Turns this DID resolver into a verification method resolver.
///
/// To resolve a verification method, the output resolver will first
/// resolve the DID then pull the referenced method from the DID document.
///
/// This is equivalent to calling
/// [`into_vm_resolver_with`](DIDResolver::into_vm_resolver_with)
/// with the default options.
fn into_vm_resolver<M>(self) -> VerificationMethodDIDResolver<Self, M>
where
Self: Sized,
{
VerificationMethodDIDResolver::new(self)
}
}
pub trait DIDMethodResolver: DIDMethod {
/// Returns the name of the method handled by this resolver.
fn method_name(&self) -> &str {
Self::DID_METHOD_NAME
}
/// Resolves a DID representation using a method specific identifier.
///
/// Fetches the DID document representation referenced by the input method
/// specific identifier using the given options.
///
/// See: <https://www.w3.org/TR/did-core/#did-resolution>
#[allow(async_fn_in_trait)]
async fn resolve_method_representation<'a>(
&'a self,
method_specific_id: &'a str,
options: Options,
) -> Result<Output<Vec<u8>>, Error>;
}
impl<'a, T: DIDMethodResolver> DIDMethodResolver for &'a T {
fn method_name(&self) -> &str {
T::method_name(*self)
}
async fn resolve_method_representation<'b>(
&'b self,
method_specific_id: &'b str,
options: Options,
) -> Result<Output<Vec<u8>>, Error> {
T::resolve_method_representation(*self, method_specific_id, options).await
}
}
impl<T: DIDMethodResolver> DIDResolverByMethod for T {
type MethodResolver = Self;
fn get_method(&self, method_name: &str) -> Option<&Self> {
if self.method_name() == method_name {
Some(self)
} else {
None
}
}
}
#[derive(Debug, Clone)]
pub struct Output<T = document::Represented> {
pub document: T,
pub document_metadata: document::Metadata,
pub metadata: Metadata,
}
impl<T> Output<T> {
pub fn from_content(content: T, content_type: Option<String>) -> Self {
Self::new(
content,
document::Metadata::default(),
Metadata::from_content_type(content_type),
)
}
pub fn new(document: T, document_metadata: document::Metadata, metadata: Metadata) -> Self {
Self {
document,
document_metadata,
metadata,
}
}
pub fn try_map<U, E>(self, f: impl FnOnce(T) -> Result<U, E>) -> Result<Output<U>, E> {
Ok(Output {
document: f(self.document)?,
document_metadata: self.document_metadata,
metadata: self.metadata,
})
}
}
/// Resolution input metadata.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct Options {
/// Preferred Media Type of the resolved DID document.
///
/// [`accept`](https://www.w3.org/TR/did-spec-registries/#accept) resolution option.
#[serde(skip_serializing_if = "Option::is_none")]
pub accept: Option<representation::MediaType>,
/// DID parameters.
#[serde(flatten)]
pub parameters: Parameters,
}
impl Options {
pub fn extend(&mut self, other: Self) {
if let Some(value) = other.accept {
self.accept = Some(value)
}
self.parameters.extend(other.parameters)
}
}
/// DID parameters.
///
/// As specified in DID Core and/or in [DID Specification Registries][1].
///
/// [1]: https://www.w3.org/TR/did-spec-registries/#parameters
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Parameters {
/// Service ID from the DID document.
#[serde(skip_serializing_if = "Option::is_none")]
pub service: Option<String>, // TODO must be an ASCII string.
/// Resource at a service endpoint, which is selected from a
/// DID document by using the service parameter.
#[serde(skip_serializing_if = "Option::is_none", alias = "relative-ref")]
pub relative_ref: Option<IriRefBuf>, // TODO must be an relative URI reference according to <https://www.rfc-editor.org/rfc/rfc3986#section-4.2>.
/// Specific version of a DID document to be resolved (the version ID could
/// be sequential, or a UUID, or method-specific).
#[serde(skip_serializing_if = "Option::is_none")]
pub version_id: Option<String>, // TODO must be an ASCII string.
/// Version timestamp of a DID document to be resolved. That is, the DID
/// document that was valid for a DID at a certain time.
#[serde(skip_serializing_if = "Option::is_none")]
pub version_time: Option<String>, // TODO must be an `xsd:string` literal value.
/// Resource hash of the DID document to add integrity protection, as
/// specified in [HASHLINK](https://www.w3.org/TR/did-core/#bib-hashlink).
///
/// This parameter is non-normative.
#[serde(skip_serializing_if = "Option::is_none")]
pub hl: Option<String>, // TODO must be an ASCII string.
/// Expected public key format (non-standard option).
///
/// Defined by <https://w3c-ccg.github.io/did-method-key>.
#[serde(skip_serializing_if = "Option::is_none")]
pub public_key_format: Option<String>,
/// Additional parameters.
#[serde(flatten)]
pub additional: BTreeMap<String, Parameter>,
}
impl Parameters {
pub fn extend(&mut self, other: Self) {
if let Some(value) = other.service {
self.service = Some(value)
}
if let Some(value) = other.relative_ref {
self.relative_ref = Some(value)
}
if let Some(value) = other.version_id {
self.version_id = Some(value)
}
if let Some(value) = other.version_time {
self.version_time = Some(value)
}
if let Some(value) = other.hl {
self.hl = Some(value)
}
if let Some(value) = other.public_key_format {
self.public_key_format = Some(value)
}
self.additional.extend(other.additional);
}
}
/// Arbitrary DID parameter.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Parameter {
Null,
String(String),
List(Vec<String>),
}
impl Parameter {
pub fn as_string(&self) -> Option<&str> {
match self {
Self::String(s) => Some(s),
_ => None,
}
}
pub fn into_string(self) -> Result<String, Self> {
match self {
Self::String(s) => Ok(s),
other => Err(other),
}
}
}
/// Resolution output metadata.
#[derive(Debug, Default, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Metadata {
pub content_type: Option<String>,
}
impl Metadata {
pub fn from_content_type(content_type: Option<String>) -> Self {
Self { content_type }
}
}