Unify core and custom profiles under one type (#26)

* Unify core and custom profiles under one type

* Add doc comments

Author: rschulman

Cargo.toml

@@ -33,6 +33,7 @@ anyhow = "1.0.86"
 sha2 = "0.10.8"
 form_urlencoded = "1.2.1"
 percent-encoding = "2.3.1"
+serde_cbor = "0.11.2"
 
 [dev-dependencies]
 assert-json-diff = "2.0.2"

src/authorization.rs

@@ -116,11 +116,11 @@ mod test {
     use serde_json::json;
 
     use crate::{
-        core::{
+        metadata::AuthorizationServerMetadata,
+        profiles::core::{
             metadata::CredentialIssuerMetadata,
             profiles::{jwt_vc_json, CoreProfilesAuthorizationDetailsObject},
         },
-        metadata::AuthorizationServerMetadata,
         types::CredentialUrl,
     };
 
@@ -193,7 +193,7 @@ mod test {
 
     #[test]
     fn example_authorization_details_multiple() {
-        let _: Vec<crate::core::authorization::AuthorizationDetailsObject> =
+        let _: Vec<crate::profiles::core::authorization::AuthorizationDetailsObject> =
             serde_json::from_value(json!([
                 {
                   "type":"openid_credential",
@@ -238,7 +238,7 @@ mod test {
             AuthUrl::new("https://server.example.com/authorize".into()).unwrap(),
         ));
 
-        let client = crate::core::client::Client::from_issuer_metadata(
+        let client = crate::profiles::core::client::Client::from_issuer_metadata(
             ClientId::new("s6BhdRkqt3".to_string()),
             RedirectUrl::new("https://client.example.org/cb".into()).unwrap(),
             credential_issuer_metadata,
@@ -259,9 +259,10 @@ mod test {
         let authorization_details = vec![AuthorizationDetailsObject {
             r#type: AuthorizationDetailsObjectType::OpenidCredential,
             additional_profile_fields: CoreProfilesAuthorizationDetailsObject::WithFormat {
-                inner: crate::core::profiles::AuthorizationDetailsObjectWithFormat::JwtVcJson(
-                    authorization_detail,
-                ),
+                inner:
+                    crate::profiles::core::profiles::AuthorizationDetailsObjectWithFormat::JwtVcJson(
+                        authorization_detail,
+                    ),
                 _credential_identifier: (),
             },
             locations: vec![],

src/core/profiles/mso_mdoc/credential_response.rs

@@ -453,13 +453,13 @@ pub struct DeferredRequest {
 mod test {
     use serde_json::json;
 
-    use crate::core::profiles::CoreProfilesCredentialResponse;
+    use crate::profiles::core::profiles::CoreProfilesCredentialResponse;
 
     use super::*;
 
     #[test]
     fn example_credential_request_object() {
-        let _: crate::core::credential::Request = serde_json::from_value(json!({
+        let _: crate::profiles::core::credential::Request = serde_json::from_value(json!({
             "format": "jwt_vc_json",
             "credential_definition": {
              "type": [
@@ -480,7 +480,7 @@ mod test {
 
     #[test]
     fn example_credential_request_referenced() {
-        let _: crate::core::credential::Request = serde_json::from_value(json!({
+        let _: crate::profiles::core::credential::Request = serde_json::from_value(json!({
             "credential_identifier": "UniversityDegreeCredential",
             "proof": {
                "proof_type": "jwt",
@@ -496,7 +496,7 @@ mod test {
     #[test]
     fn example_credential_request_deny() {
         assert!(
-            serde_json::from_value::<crate::core::credential::Request>(json!({
+            serde_json::from_value::<crate::profiles::core::credential::Request>(json!({
                 "format": "jwt_vc_json",
                 "credential_identifier": "UniversityDegreeCredential",
                 "proof": {
@@ -545,7 +545,7 @@ mod test {
 
     #[test]
     fn example_batch_request() {
-        let _: crate::core::credential::BatchRequest = serde_json::from_value(json!({
+        let _: crate::profiles::core::credential::BatchRequest = serde_json::from_value(json!({
             "credential_requests":[
               {
                  "format":"jwt_vc_json",

src/credential.rs

@@ -3,11 +3,9 @@ mod macros;
 
 pub mod authorization;
 pub mod client;
-pub mod core;
 pub mod credential;
 pub mod credential_offer;
 pub mod credential_response_encryption;
-pub mod custom;
 mod deny_field;
 mod http_utils;
 pub mod metadata;
@@ -23,15 +21,15 @@ pub use oauth2;
 
 #[cfg(test)]
 mod test {
-    use crate::core::profiles::{
-        jwt_vc_json_ld, ldp_vc, CoreProfilesCredentialConfiguration, CoreProfilesCredentialRequest,
-        CredentialRequestWithFormat,
-    };
-    use crate::core::{client::Client, metadata::CredentialIssuerMetadata};
     use crate::credential_offer::CredentialOffer;
     use crate::metadata::authorization_server::GrantType;
     use crate::metadata::credential_issuer::CredentialConfiguration;
     use crate::metadata::{AuthorizationServerMetadata, MetadataDiscovery};
+    use crate::profiles::core::profiles::{
+        jwt_vc_json_ld, ldp_vc, CoreProfilesCredentialConfiguration, CoreProfilesCredentialRequest,
+        CredentialRequestWithFormat,
+    };
+    use crate::profiles::core::{client::Client, metadata::CredentialIssuerMetadata};
     use crate::types::CredentialOfferRequest;
     use oauth2::{ClientId, RedirectUrl, TokenResponse};
     use url::Url;

src/lib.rs

@@ -269,7 +269,7 @@ impl MetadataBackgroundImage {
 
 #[cfg(test)]
 mod test {
-    use crate::core::profiles::CoreProfilesCredentialConfiguration;
+    use crate::profiles::core::profiles::CoreProfilesCredentialConfiguration;
     use serde_json::json;
 
     use super::*;

src/metadata/credential_issuer.rs

@@ -3,7 +3,8 @@ use std::collections::HashMap;
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    core::profiles::AuthorizationDetailsObjectClaim, profiles::AuthorizationDetailsObjectProfile,
+    profiles::core::profiles::AuthorizationDetailsObjectClaim,
+    profiles::AuthorizationDetailsObjectProfile,
 };
 
 use super::{CredentialSubjectClaims, Format};
@@ -83,7 +84,7 @@ mod test {
 
     use crate::{
         authorization::AuthorizationDetailsObject,
-        core::profiles::CoreProfilesAuthorizationDetailsObject,
+        profiles::core::profiles::CoreProfilesAuthorizationDetailsObject,
     };
 
     #[test]

src/profiles.rs

@@ -3,7 +3,8 @@ use std::collections::HashMap;
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    core::profiles::CredentialConfigurationClaim, profiles::CredentialConfigurationProfile,
+    profiles::core::profiles::CredentialConfigurationClaim,
+    profiles::CredentialConfigurationProfile,
 };
 
 use super::{CredentialSubjectClaims, Format};

src/core/mod.rs src/profiles/core/mod.rs

@@ -51,7 +51,7 @@ impl CredentialRequestProfile for CredentialRequest {
 mod test {
     use serde_json::json;
 
-    use crate::{core::profiles::CoreProfilesCredentialRequest, credential::Request};
+    use crate::{credential::Request, profiles::core::profiles::CoreProfilesCredentialRequest};
 
     #[test]
     fn roundtrip_with_format() {

src/core/profiles/jwt_vc_json/authorization_detail.rs src/profiles/core/profiles/jwt_vc_json/authorization_detail.rs

@@ -5,7 +5,8 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
 use serde_json::Value;
 
 use crate::{
-    core::profiles::AuthorizationDetailsObjectClaim, profiles::AuthorizationDetailsObjectProfile,
+    profiles::core::profiles::AuthorizationDetailsObjectClaim,
+    profiles::AuthorizationDetailsObjectProfile,
 };
 
 use super::CredentialSubjectClaims;
@@ -91,7 +92,7 @@ mod test {
 
     use crate::{
         authorization::AuthorizationDetailsObject,
-        core::profiles::{ldp_vc::Format, CoreProfilesAuthorizationDetailsObject},
+        profiles::core::profiles::{ldp_vc::Format, CoreProfilesAuthorizationDetailsObject},
     };
 
     #[test]

src/core/profiles/jwt_vc_json/credential_configuration.rs src/profiles/core/profiles/jwt_vc_json/credential_configuration.rs

@@ -5,7 +5,8 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
 use serde_json::Value;
 
 use crate::{
-    core::profiles::CredentialConfigurationClaim, profiles::CredentialConfigurationProfile,
+    profiles::core::profiles::CredentialConfigurationClaim,
+    profiles::CredentialConfigurationProfile,
 };
 
 use super::CredentialSubjectClaims;
@@ -65,7 +66,8 @@ mod test {
     use serde_json::json;
 
     use crate::{
-        core::profiles::ldp_vc::Format, metadata::credential_issuer::CredentialConfiguration,
+        metadata::credential_issuer::CredentialConfiguration,
+        profiles::core::profiles::ldp_vc::Format,
     };
 
     #[test]

src/core/profiles/jwt_vc_json/credential_request.rs src/profiles/core/profiles/jwt_vc_json/credential_request.rs

@@ -60,8 +60,8 @@ mod test {
     use serde_json::json;
 
     use crate::{
-        core::profiles::{ldp_vc::Format, CoreProfilesCredentialRequest},
         credential::Request,
+        profiles::core::profiles::{ldp_vc::Format, CoreProfilesCredentialRequest},
     };
 
     #[test]

src/core/profiles/jwt_vc_json/credential_response.rs src/profiles/core/profiles/jwt_vc_json/credential_response.rs

@@ -1,13 +1,13 @@
 use serde::{Deserialize, Serialize};
-use serde_json::Value;
+use ssi::prelude::{AnySuite, DataIntegrity, DataIntegrityDocument};
 
 use crate::profiles::CredentialResponseProfile;
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct CredentialResponse;
 
 impl CredentialResponseProfile for CredentialResponse {
-    type Type = Value;
+    type Type = DataIntegrity<DataIntegrityDocument, AnySuite>;
 }
 
 #[cfg(test)]

src/core/profiles/jwt_vc_json/mod.rs src/profiles/core/profiles/jwt_vc_json/mod.rs

@@ -4,7 +4,8 @@ use isomdl::definitions::device_request::DocType;
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    core::profiles::AuthorizationDetailsObjectClaim, profiles::AuthorizationDetailsObjectProfile,
+    profiles::core::profiles::AuthorizationDetailsObjectClaim,
+    profiles::AuthorizationDetailsObjectProfile,
 };
 
 use super::{Claims, Format};
@@ -60,7 +61,7 @@ mod test {
 
     use crate::{
         authorization::AuthorizationDetailsObject,
-        core::profiles::CoreProfilesAuthorizationDetailsObject,
+        profiles::core::profiles::CoreProfilesAuthorizationDetailsObject,
     };
 
     #[test]

src/core/profiles/jwt_vc_json_ld.rs src/profiles/core/profiles/jwt_vc_json_ld.rs

@@ -2,7 +2,8 @@ use isomdl::definitions::device_request::DocType;
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    core::profiles::CredentialConfigurationClaim, profiles::CredentialConfigurationProfile,
+    profiles::core::profiles::CredentialConfigurationClaim,
+    profiles::CredentialConfigurationProfile,
 };
 
 use super::{Claims, Format};

src/core/profiles/ldp_vc/authorization_detail.rs src/profiles/core/profiles/ldp_vc/authorization_detail.rs

@@ -1,7 +1,9 @@
 use isomdl::definitions::device_request::DocType;
 use serde::{Deserialize, Serialize};
 
-use crate::{core::profiles::CredentialConfigurationClaim, profiles::CredentialRequestProfile};
+use crate::{
+    profiles::core::profiles::CredentialConfigurationClaim, profiles::CredentialRequestProfile,
+};
 
 use super::{Claims, Format};
 
@@ -70,7 +72,7 @@ impl CredentialRequestProfile for CredentialRequest {
 mod test {
     use serde_json::json;
 
-    use crate::{core::profiles::CoreProfilesCredentialRequest, credential::Request};
+    use crate::{credential::Request, profiles::core::profiles::CoreProfilesCredentialRequest};
 
     #[test]
     fn roundtrip_with_format() {

src/core/profiles/ldp_vc/credential_configuration.rs src/profiles/core/profiles/ldp_vc/credential_configuration.rs

@@ -0,0 +1,41 @@
+use isomdl::definitions::IssuerSigned;
+use serde::{Deserialize, Serialize};
+
+use crate::profiles::CredentialResponseProfile;
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct CredentialResponse;
+
+impl CredentialResponseProfile for CredentialResponse {
+    type Type = IsoIssuerSigned;
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct IsoIssuerSigned(#[serde(with = "base64_cbor")] IssuerSigned);
+
+mod base64_cbor {
+    use base64::{engine::general_purpose::URL_SAFE, Engine};
+    use serde::{de::DeserializeOwned, Deserialize, Deserializer, Serialize, Serializer};
+
+    pub fn serialize<T: Sized + Serialize, S: Serializer>(v: &T, s: S) -> Result<S::Ok, S::Error> {
+        let v = match serde_cbor::to_vec(v) {
+            Ok(v) => v,
+            Err(e) => return Err(serde::ser::Error::custom(e)),
+        };
+        let b64 = URL_SAFE.encode(v);
+        String::serialize(&b64, s)
+    }
+
+    pub fn deserialize<'de, T: DeserializeOwned, D: Deserializer<'de>>(
+        d: D,
+    ) -> Result<T, D::Error> {
+        let b64 = String::deserialize(d)?;
+        match URL_SAFE.decode(b64) {
+            Ok(v) => match serde_cbor::from_slice(&v) {
+                Ok(v) => Ok(v),
+                Err(e) => Err(serde::de::Error::custom(e)),
+            },
+            Err(e) => Err(serde::de::Error::custom(e)),
+        }
+    }
+}

src/core/profiles/ldp_vc/credential_request.rs src/profiles/core/profiles/ldp_vc/credential_request.rs

@@ -1,7 +1,7 @@
 use serde::{Deserialize, Serialize};
 
-use crate::{
-    core::profiles::CredentialConfigurationClaim, profiles::AuthorizationDetailsObjectProfile,
+use crate::profiles::custom::profiles::{
+    AuthorizationDetailsObjectProfile, CredentialConfigurationClaim,
 };
 
 use super::{Claims, Format};

src/core/profiles/ldp_vc/credential_response.rs src/profiles/core/profiles/ldp_vc/credential_response.rs

@@ -1,7 +1,8 @@
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    core::profiles::CredentialConfigurationClaim, profiles::CredentialConfigurationProfile,
+    profiles::custom::profiles::CredentialConfigurationClaim,
+    profiles::CredentialConfigurationProfile,
 };
 
 use super::{Claims, Format};