identity_document 1.5.1

// Copyright 2020-2023 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use identity_did::DIDUrl;
use identity_verification::MethodScope;

/// Holds additional options for verifying a JWS with
/// [`CoreDocument::verify_jws`](crate::document::CoreDocument::verify_jws()).
#[non_exhaustive]
#[derive(Default, Debug, serde::Serialize, serde::Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct JwsVerificationOptions {
  /// Verify that the nonce set in the protected header matches this value.
  ///
  /// [More Info](https://tools.ietf.org/html/rfc8555#section-6.5.2)
  pub nonce: Option<String>,
  /// Verify the signing verification method relation matches this.
  pub method_scope: Option<MethodScope>,
  /// The DID URl of the method, whose JWK should be used to verify the JWS.
  /// If unset, the `kid` of the JWS is used as the DID Url.
  pub method_id: Option<DIDUrl>,
}

impl JwsVerificationOptions {
  /// Creates a new [`JwsVerificationOptions`].
  pub fn new() -> Self {
    Self::default()
  }

  /// Set the expected value for the `nonce` parameter of the protected header.
  pub fn nonce(mut self, value: impl Into<String>) -> Self {
    self.nonce = Some(value.into());
    self
  }

  /// Set the scope of the verification methods that may be used to verify the given JWS.
  pub fn method_scope(mut self, value: MethodScope) -> Self {
    self.method_scope = Some(value);
    self
  }

  /// The DID URl of the method, whose JWK should be used to verify the JWS.
  pub fn method_id(mut self, value: DIDUrl) -> Self {
    self.method_id = Some(value);
    self
  }
}