identity_credential/credential/
policy.rs

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
// Copyright 2020-2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use serde::Deserialize;
use serde::Serialize;

use identity_core::common::Object;
use identity_core::common::OneOrMany;
use identity_core::common::Url;

/// Information used to express obligations, prohibitions, and permissions about
/// a [`Credential`][crate::credential::Credential] or [`Presentation`][crate::presentation::Presentation].
///
/// [More Info](https://www.w3.org/TR/vc-data-model/#terms-of-use)
#[derive(Clone, Debug, Default, PartialEq, Eq, Deserialize, Serialize)]
pub struct Policy {
  /// The instance id of the credential terms-of-use.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub id: Option<Url>,
  /// The type(s) of the credential terms-of-use.
  #[serde(rename = "type")]
  pub types: OneOrMany<String>,
  /// Additional properties of the credential terms-of-use.
  #[serde(flatten)]
  pub properties: Object,
}

impl Policy {
  /// Creates a new `Policy` instance.
  pub fn new<T>(types: T) -> Self
  where
    T: Into<OneOrMany<String>>,
  {
    Self {
      id: None,
      types: types.into(),
      properties: Object::new(),
    }
  }

  /// Creates a new `Policy` instance with the given `id`.
  pub fn with_id<T>(types: T, id: Url) -> Self
  where
    T: Into<OneOrMany<String>>,
  {
    Self {
      id: Some(id),
      types: types.into(),
      properties: Object::new(),
    }
  }

  /// Creates a new `Policy` instance with the given `properties`.
  pub fn with_properties<T>(types: T, properties: Object) -> Self
  where
    T: Into<OneOrMany<String>>,
  {
    Self {
      id: None,
      types: types.into(),
      properties,
    }
  }

  /// Creates a new `Policy` instance with the given `id` and `properties`.
  pub fn with_id_and_properties<T>(types: T, id: Url, properties: Object) -> Self
  where
    T: Into<OneOrMany<String>>,
  {
    Self {
      id: Some(id),
      types: types.into(),
      properties,
    }
  }
}

#[cfg(test)]
mod tests {
  use identity_core::convert::FromJson;

  use crate::credential::Policy;

  const JSON1: &str = include_str!("../../tests/fixtures/policy-1.json");
  const JSON2: &str = include_str!("../../tests/fixtures/policy-2.json");

  #[test]
  fn test_from_json() {
    let policy: Policy = Policy::from_json(JSON1).unwrap();
    assert_eq!(policy.id.unwrap(), "http://example.com/policies/credential/4");
    assert_eq!(policy.types.as_slice(), ["IssuerPolicy"]);
    assert_eq!(policy.properties["profile"], "http://example.com/profiles/credential");
    assert_eq!(
      policy.properties["prohibition"][0]["assigner"],
      "https://example.edu/issuers/14"
    );
    assert_eq!(policy.properties["prohibition"][0]["assignee"], "AllVerifiers");
    assert_eq!(
      policy.properties["prohibition"][0]["target"],
      "http://example.edu/credentials/3732"
    );
    assert_eq!(policy.properties["prohibition"][0]["action"][0], "Archival");

    let policy: Policy = Policy::from_json(JSON2).unwrap();
    assert_eq!(policy.id.unwrap(), "http://example.com/policies/credential/6");
    assert_eq!(policy.types.as_slice(), ["HolderPolicy"]);
    assert_eq!(policy.properties["profile"], "http://example.com/profiles/credential");
    assert_eq!(
      policy.properties["prohibition"][0]["assigner"],
      "did:example:ebfeb1f712ebc6f1c276e12ec21"
    );
    assert_eq!(
      policy.properties["prohibition"][0]["assignee"],
      "https://wineonline.example.org/"
    );
    assert_eq!(
      policy.properties["prohibition"][0]["target"],
      "http://example.edu/credentials/3732"
    );
    assert_eq!(policy.properties["prohibition"][0]["action"][0], "3rdPartyCorrelation");
  }
}