Merge pull request #291 from DSRCorporation/anoncreds-w3c-format-changes

Reworked w3c credentials and presentations to use DataIntegrityProof  instead of custom AnonCreds context

Cargo.toml

@@ -27,7 +27,7 @@ vendored = ["anoncreds-clsignatures/openssl_vendored"]
 w3c = ["base64", "chrono"]
 
 [dependencies]
-anoncreds-clsignatures = "0.2.4"
+anoncreds-clsignatures = "0.3.0"
 bs58 = "0.4.0"
 env_logger = { version = "0.9.3", optional = true }
 ffi-support = { version = "0.4.0", optional = true }

docs/design/w3c/w3c-representation.md

@@ -47,16 +47,18 @@ Methods purpose - have to forms of credentials (probably even duplicate in walle
 /// Convert credential in legacy form into W3C AnonCreds credential form
 ///
 /// # Params
-/// cred:       object handle pointing to credential in legacy form to convert
-/// cred_def:   object handle pointing to the credential definition
-/// cred_p:     reference that will contain converted credential (in W3C form) instance pointer
+/// cred:           object handle pointing to credential in legacy form to convert
+/// cred_def:       object handle pointing to the credential definition
+/// w3c_version:    version of w3c verifiable credential specification (1.1 or 2.0) to use
+/// cred_p:         reference that will contain converted credential (in W3C form) instance pointer
 ///
 /// # Returns
 /// Error code
 #[no_mangle]
 pub extern "C" fn anoncreds_credential_to_w3c(
     cred: ObjectHandle,
     cred_def: ObjectHandle,
+    w3c_version: FfiStr,
     cred_p: *mut ObjectHandle,
 ) -> ErrorCode {}
 
@@ -75,90 +77,6 @@ pub extern "C" fn anoncreds_credential_from_w3c(
 ) -> ErrorCode {}
 ```
 
-#### Credential object helper methods
-
-```rust
-/// Add Non-Anoncreds Data Integrity proof signature to W3C AnonCreds credential
-///
-/// # Params
-/// cred -      object handle pointing to W3C AnonCreds credential
-/// proof -     data integrity proof as JSON string
-/// cred_p:     reference that will contain update credential
-///
-/// # Returns
-/// Error code
-#[no_mangle]
-pub extern "C" fn anoncreds_w3c_credential_add_non_anoncreds_integrity_proof(
-    cred: ObjectHandle,
-    proof: FfiStr,
-    cred_p: *mut ObjectHandle,
-) -> ErrorCode {}
-
-/// Add context to W3C AnonCreds credential
-///
-/// # Params
-/// cred -      object handle pointing to W3C AnonCreds credential
-/// context -   context to add into credential
-/// cred_p:     reference that will contain update credential
-///
-/// # Returns
-/// Error code
-#[no_mangle]
-pub extern "C" fn anoncreds_w3c_credential_add_context(
-    cred: ObjectHandle,
-    context: FfiStr,
-    cred_p: *mut ObjectHandle,
-) -> ErrorCode {}
-
-/// Add type to W3C AnonCreds credential
-///
-/// # Params
-/// cred -      object handle pointing to W3C AnonCreds credential
-/// type -      type to add into credential
-/// cred_p:     reference that will contain update credential
-///
-/// # Returns
-/// Error code
-#[no_mangle]
-pub extern "C" fn anoncreds_w3c_credential_add_type(
-    cred: ObjectHandle,
-    type_: FfiStr,
-    cred_p: *mut ObjectHandle,
-) -> ErrorCode {}
-
-/// Set subject id to W3C AnonCreds credential
-///
-/// # Params
-/// cred -      object handle pointing to W3C AnonCreds credential
-/// id -        subject id to add into credential
-/// cred_p:     reference that will contain update credential
-///
-/// # Returns
-/// Error code
-#[no_mangle]
-pub extern "C" fn anoncreds_w3c_credential_set_subject_id(
-    cred: ObjectHandle,
-    id: FfiStr,
-    cred_p: *mut ObjectHandle,
-) -> ErrorCode {}
-
-/// Set id to W3C AnonCreds credential
-///
-/// # Params
-/// cred -      object handle pointing to W3C AnonCreds credential
-/// id -        id to add into credential
-/// cred_p:     reference that will contain update credential
-///
-/// # Returns
-/// Error code
-#[no_mangle]
-pub extern "C" fn anoncreds_w3c_credential_set_id(
-    cred: ObjectHandle,
-    id: FfiStr,
-    cred_p: *mut ObjectHandle,
-) -> ErrorCode {}
-```
-
 #### Flow methods duplication
 
 The idea for this approach to duplicate all issuance/presentation related methods for w3c standard.
@@ -242,6 +160,7 @@ pub extern "C" fn anoncreds_create_w3c_credential_request(
 /// attr_names:            list of attribute names
 /// attr_raw_values:       list of attribute raw values
 /// revocation:            object handle pointing to the credential revocation info
+/// w3c_version:           version of w3c verifiable credential specification (1.1 or 2.0) to use
 /// cred_p:                reference that will contain credential (in W3C form) instance pointer
 ///
 /// # Returns
@@ -255,6 +174,7 @@ pub extern "C" fn anoncreds_create_w3c_credential(
     attr_names: FfiStrList,
     attr_raw_values: FfiStrList,
     revocation: *const FfiCredRevInfo,
+    w3c_version: *const FfiStr,
     cred_p: *mut ObjectHandle,
 ) -> ErrorCode {}
 
@@ -280,20 +200,21 @@ pub extern "C" fn anoncreds_process_w3c_credential(
     cred_p: *mut ObjectHandle,
 ) -> ErrorCode {}
 
-/// Get value of requested credential attribute as string
+/// Get credential signature information required for proof building and verification
+/// This information is aggregated from `anoncredsvc-2023` and `anoncredspresvc-2023` proofs.
+/// It's needed for Holder and Verifier for public entities resolving
+///     {`schema_id`, `cred_def_id`, `rev_reg_id`, `rev_reg_index`, `timestamp`}
 ///
 /// # Params
 /// handle:                object handle pointing to the credential (in W3 form)
-/// name:                  name of attribute to retrieve
-/// result_p:              reference that will contain value of request credential attribute
+/// cred_proof_info_p:     reference that will contain credential information
 ///
 /// # Returns
 /// Error code
 #[no_mangle]
-pub extern "C" fn anoncreds_w3c_credential_get_attribute(
+pub extern "C" fn anoncreds_w3c_credential_get_integrity_proof_details(
     handle: ObjectHandle,
-    name: FfiStr,
-    result_p: *mut *const c_char,
+    cred_proof_info_p: *mut ObjectHandle,
 ) -> ErrorCode {}
 
 /// Create W3C Presentation according to the specification.
@@ -307,6 +228,7 @@ pub extern "C" fn anoncreds_w3c_credential_get_attribute(
 /// schema_ids:             list of schemas ids
 /// cred_defs:              list of credential definitions
 /// cred_def_ids:           list of credential definitions ids
+/// w3c_version:            version of w3c verifiable presentation specification (1.1 or 2.0) to use
 /// presentation_p:         reference that will contain created presentation (in W3C form) instance pointer.
 ///
 /// # Returns
@@ -322,6 +244,7 @@ pub extern "C" fn anoncreds_create_w3c_presentation(
     cred_defs: FfiList<ObjectHandle>,
     cred_def_ids: FfiStrList,
     presentation_p: *mut ObjectHandle,
+    w3c_version: FfiStr,
 ) -> ErrorCode {}
 
 /// Verity W3C styled Presentation

src/data_types/credential.rs

@@ -1,5 +1,4 @@
-use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
-use serde_json::Value;
+use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
 
 #[cfg(feature = "zeroize")]
@@ -74,16 +73,6 @@ impl Validatable for Credential {
     }
 }
 
-#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
-pub struct CredentialInfo {
-    pub referent: String,
-    pub attrs: RawCredentialValues,
-    pub schema_id: SchemaId,
-    pub cred_def_id: CredentialDefinitionId,
-    pub rev_reg_id: Option<RevocationRegistryDefinitionId>,
-    pub cred_rev_id: Option<String>,
-}
-
 #[derive(Clone, Debug, Default, PartialEq, Eq, Deserialize, Serialize)]
 pub struct RawCredentialValues(pub HashMap<String, String>);
 
@@ -126,20 +115,12 @@ impl From<&CredentialValues> for RawCredentialValues {
 }
 
 impl RawCredentialValues {
-    pub fn encode(&self, encoding: &CredentialValuesEncoding) -> Result<CredentialValues, Error> {
-        match encoding {
-            CredentialValuesEncoding::Auto => {
-                let mut cred_values = MakeCredentialValues::default();
-                for (attribute, raw_value) in self.0.iter() {
-                    cred_values.add_raw(attribute, raw_value)?;
-                }
-                Ok(cred_values.into())
-            }
-            encoding => Err(err_msg!(
-                "Credential values encoding {:?} is not supported",
-                encoding
-            )),
+    pub fn encode(&self) -> Result<CredentialValues, Error> {
+        let mut cred_values = MakeCredentialValues::default();
+        for (attribute, raw_value) in self.0.iter() {
+            cred_values.add_raw(attribute, raw_value)?;
         }
+        Ok(cred_values.into())
     }
 }
 
@@ -178,55 +159,3 @@ pub struct AttributeValues {
     pub raw: String,
     pub encoded: String,
 }
-
-#[derive(Debug, Clone, PartialEq, Eq)]
-pub enum CredentialValuesEncoding {
-    Auto,
-    Other(String),
-}
-
-impl ToString for CredentialValuesEncoding {
-    fn to_string(&self) -> String {
-        match self {
-            CredentialValuesEncoding::Auto => "auto".to_string(),
-            CredentialValuesEncoding::Other(other) => other.to_string(),
-        }
-    }
-}
-
-impl From<&str> for CredentialValuesEncoding {
-    fn from(value: &str) -> Self {
-        match value {
-            "auto" => CredentialValuesEncoding::Auto,
-            other => CredentialValuesEncoding::Other(other.to_string()),
-        }
-    }
-}
-
-impl Serialize for CredentialValuesEncoding {
-    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
-    where
-        S: Serializer,
-    {
-        Value::String(self.to_string()).serialize(serializer)
-    }
-}
-
-impl<'de> Deserialize<'de> for CredentialValuesEncoding {
-    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
-    where
-        D: Deserializer<'de>,
-    {
-        Value::deserialize(deserializer)
-            .map_err(de::Error::custom)?
-            .as_str()
-            .map(CredentialValuesEncoding::from)
-            .ok_or_else(|| de::Error::custom("Cannot parse credential value encoding"))
-    }
-}
-
-impl Default for CredentialValuesEncoding {
-    fn default() -> Self {
-        CredentialValuesEncoding::Auto
-    }
-}

src/data_types/pres_request.rs

@@ -185,11 +185,13 @@ pub struct AttributeInfo {
     pub non_revoked: Option<NonRevokedInterval>,
 }
 
+pub type PredicateValue = i32;
+
 #[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
 pub struct PredicateInfo {
     pub name: String,
     pub p_type: PredicateTypes,
-    pub p_value: i32,
+    pub p_value: PredicateValue,
     pub restrictions: Option<Query>,
     pub non_revoked: Option<NonRevokedInterval>,
 }

src/data_types/w3c/constants.rs

@@ -1,36 +1,43 @@
+use crate::data_types::w3c::context::{Context, Contexts};
 use once_cell::sync::Lazy;
+use serde_json::{json, Value};
 use std::collections::HashSet;
 
-use crate::data_types::w3c::credential::{Contexts, Types};
+use crate::data_types::w3c::credential::Types;
 use crate::data_types::w3c::uri::URI;
 
 // Contexts
-pub const W3C_CONTEXT: &str = "https://www.w3.org/2018/credentials/v1";
-pub const W3C_ANONCREDS_CONTEXT: &str = "https://raw.githubusercontent.com/hyperledger/anoncreds-spec/main/data/anoncreds-w3c-context.json";
+pub const W3C_VC_1_1_BASE_CONTEXT: &str = "https://www.w3.org/2018/credentials/v1";
+pub const W3C_VC_2_0_BASE_CONTEXT: &str = "https://www.w3.org/ns/credentials/v2";
+pub const W3C_DATA_INTEGRITY_CONTEXT: &str = "https://w3id.org/security/data-integrity/v2";
 
-// Types
-pub const W3C_CREDENTIAL_TYPE: &str = "VerifiableCredential";
-pub const W3C_PRESENTATION_TYPE: &str = "VerifiablePresentation";
-pub const W3C_ANONCREDS_CREDENTIAL_TYPE: &str = "AnonCredsCredential";
-pub const W3C_ANONCREDS_PRESENTATION_TYPE: &str = "AnonCredsPresentation";
-
-pub(crate) static ANONCREDS_CONTEXTS: Lazy<Contexts> = Lazy::new(|| {
-    Contexts(HashSet::from([
-        URI::from(W3C_CONTEXT),
-        URI::from(W3C_ANONCREDS_CONTEXT),
-    ]))
+pub static ISSUER_DEPENDENT_VOCABULARY: Lazy<Value> = Lazy::new(|| {
+    json!({
+        "@vocab": "https://www.w3.org/ns/credentials/issuer-dependent#"
+    })
 });
 
-pub(crate) static ANONCREDS_CREDENTIAL_TYPES: Lazy<Types> = Lazy::new(|| {
-    Types(HashSet::from([
-        String::from(W3C_CREDENTIAL_TYPE),
-        String::from(W3C_ANONCREDS_CREDENTIAL_TYPE),
-    ]))
+pub(crate) static ANONCREDS_VC_1_1_CONTEXTS: Lazy<Contexts> = Lazy::new(|| {
+    Contexts(vec![
+        Context::URI(URI::from(W3C_VC_1_1_BASE_CONTEXT)),
+        Context::URI(URI::from(W3C_DATA_INTEGRITY_CONTEXT)),
+        Context::Object(ISSUER_DEPENDENT_VOCABULARY.clone()),
+    ])
 });
 
-pub(crate) static ANONCREDS_PRESENTATION_TYPES: Lazy<Types> = Lazy::new(|| {
-    Types(HashSet::from([
-        String::from(W3C_PRESENTATION_TYPE),
-        String::from(W3C_ANONCREDS_PRESENTATION_TYPE),
-    ]))
+pub(crate) static ANONCREDS_VC_2_0_CONTEXTS: Lazy<Contexts> = Lazy::new(|| {
+    Contexts(vec![
+        Context::URI(URI::from(W3C_VC_2_0_BASE_CONTEXT)),
+        Context::Object(ISSUER_DEPENDENT_VOCABULARY.clone()),
+    ])
 });
+
+// Types
+pub const W3C_CREDENTIAL_TYPE: &str = "VerifiableCredential";
+pub const W3C_PRESENTATION_TYPE: &str = "VerifiablePresentation";
+
+pub(crate) static ANONCREDS_CREDENTIAL_TYPES: Lazy<Types> =
+    Lazy::new(|| Types(HashSet::from([String::from(W3C_CREDENTIAL_TYPE)])));
+
+pub(crate) static ANONCREDS_PRESENTATION_TYPES: Lazy<Types> =
+    Lazy::new(|| Types(HashSet::from([String::from(W3C_PRESENTATION_TYPE)])));