-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for
did:jwk
resolution (#1404)
* did:jwk implementation & resolution * did:jwk WASM bindings * wasm did jwk test * cargo fmt * add missing license header * Update identity_did/src/did_jwk.rs Co-authored-by: wulfraem <[email protected]> * Update identity_did/src/did_jwk.rs Co-authored-by: wulfraem <[email protected]> --------- Co-authored-by: wulfraem <[email protected]>
- Loading branch information
Showing
12 changed files
with
602 additions
and
105 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
// Copyright 2020-2024 IOTA Stiftung | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
use identity_iota::did::DIDJwk; | ||
use identity_iota::did::DID as _; | ||
use wasm_bindgen::prelude::*; | ||
|
||
use super::wasm_core_did::get_core_did_clone; | ||
use super::IToCoreDID; | ||
use super::WasmCoreDID; | ||
use crate::error::Result; | ||
use crate::error::WasmResult; | ||
use crate::jose::WasmJwk; | ||
|
||
/// `did:jwk` DID. | ||
#[wasm_bindgen(js_name = DIDJwk)] | ||
pub struct WasmDIDJwk(pub(crate) DIDJwk); | ||
|
||
#[wasm_bindgen(js_class = DIDJwk)] | ||
impl WasmDIDJwk { | ||
#[wasm_bindgen(constructor)] | ||
/// Creates a new {@link DIDJwk} from a {@link CoreDID}. | ||
/// | ||
/// ### Errors | ||
/// Throws an error if the given did is not a valid `did:jwk` DID. | ||
pub fn new(did: IToCoreDID) -> Result<WasmDIDJwk> { | ||
let did = get_core_did_clone(&did).0; | ||
DIDJwk::try_from(did).wasm_result().map(Self) | ||
} | ||
/// Parses a {@link DIDJwk} from the given `input`. | ||
/// | ||
/// ### Errors | ||
/// | ||
/// Throws an error if the input is not a valid {@link DIDJwk}. | ||
#[wasm_bindgen] | ||
pub fn parse(input: &str) -> Result<WasmDIDJwk> { | ||
DIDJwk::parse(input).wasm_result().map(Self) | ||
} | ||
|
||
/// Returns the JSON WEB KEY (JWK) encoded inside this `did:jwk`. | ||
#[wasm_bindgen] | ||
pub fn jwk(&self) -> WasmJwk { | ||
self.0.jwk().into() | ||
} | ||
|
||
// =========================================================================== | ||
// DID trait | ||
// =========================================================================== | ||
|
||
/// Returns the {@link CoreDID} scheme. | ||
/// | ||
/// E.g. | ||
/// - `"did:example:12345678" -> "did"` | ||
/// - `"did:iota:smr:12345678" -> "did"` | ||
#[wasm_bindgen] | ||
pub fn scheme(&self) -> String { | ||
self.0.scheme().to_owned() | ||
} | ||
|
||
/// Returns the {@link CoreDID} authority: the method name and method-id. | ||
/// | ||
/// E.g. | ||
/// - `"did:example:12345678" -> "example:12345678"` | ||
/// - `"did:iota:smr:12345678" -> "iota:smr:12345678"` | ||
#[wasm_bindgen] | ||
pub fn authority(&self) -> String { | ||
self.0.authority().to_owned() | ||
} | ||
|
||
/// Returns the {@link CoreDID} method name. | ||
/// | ||
/// E.g. | ||
/// - `"did:example:12345678" -> "example"` | ||
/// - `"did:iota:smr:12345678" -> "iota"` | ||
#[wasm_bindgen] | ||
pub fn method(&self) -> String { | ||
self.0.method().to_owned() | ||
} | ||
|
||
/// Returns the {@link CoreDID} method-specific ID. | ||
/// | ||
/// E.g. | ||
/// - `"did:example:12345678" -> "12345678"` | ||
/// - `"did:iota:smr:12345678" -> "smr:12345678"` | ||
#[wasm_bindgen(js_name = methodId)] | ||
pub fn method_id(&self) -> String { | ||
self.0.method_id().to_owned() | ||
} | ||
|
||
/// Returns the {@link CoreDID} as a string. | ||
#[allow(clippy::inherent_to_string)] | ||
#[wasm_bindgen(js_name = toString)] | ||
pub fn to_string(&self) -> String { | ||
self.0.to_string() | ||
} | ||
|
||
// Only intended to be called internally. | ||
#[wasm_bindgen(js_name = toCoreDid, skip_typescript)] | ||
pub fn to_core_did(&self) -> WasmCoreDID { | ||
WasmCoreDID(self.0.clone().into()) | ||
} | ||
} | ||
|
||
impl_wasm_json!(WasmDIDJwk, DIDJwk); | ||
impl_wasm_clone!(WasmDIDJwk, DIDJwk); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
// Copyright 2020-2024 IOTA Stiftung | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
use std::fmt::Debug; | ||
use std::fmt::Display; | ||
use std::str::FromStr; | ||
|
||
use identity_jose::jwk::Jwk; | ||
use identity_jose::jwu::decode_b64_json; | ||
|
||
use crate::CoreDID; | ||
use crate::Error; | ||
use crate::DID; | ||
|
||
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, serde::Deserialize, serde::Serialize)] | ||
#[repr(transparent)] | ||
#[serde(into = "CoreDID", try_from = "CoreDID")] | ||
/// A type representing a `did:jwk` DID. | ||
pub struct DIDJwk(CoreDID); | ||
|
||
impl DIDJwk { | ||
/// [`DIDJwk`]'s method. | ||
pub const METHOD: &'static str = "jwk"; | ||
|
||
/// Tries to parse a [`DIDJwk`] from a string. | ||
pub fn parse(s: &str) -> Result<Self, Error> { | ||
s.parse() | ||
} | ||
|
||
/// Returns the JWK encoded inside this did:jwk. | ||
pub fn jwk(&self) -> Jwk { | ||
decode_b64_json(self.method_id()).expect("did:jwk encodes a valid JWK") | ||
} | ||
} | ||
|
||
impl AsRef<CoreDID> for DIDJwk { | ||
fn as_ref(&self) -> &CoreDID { | ||
&self.0 | ||
} | ||
} | ||
|
||
impl From<DIDJwk> for CoreDID { | ||
fn from(value: DIDJwk) -> Self { | ||
value.0 | ||
} | ||
} | ||
|
||
impl<'a> TryFrom<&'a str> for DIDJwk { | ||
type Error = Error; | ||
fn try_from(value: &'a str) -> Result<Self, Self::Error> { | ||
value.parse() | ||
} | ||
} | ||
|
||
impl Display for DIDJwk { | ||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
write!(f, "{}", self.0) | ||
} | ||
} | ||
|
||
impl FromStr for DIDJwk { | ||
type Err = Error; | ||
fn from_str(s: &str) -> Result<Self, Self::Err> { | ||
s.parse::<CoreDID>().and_then(TryFrom::try_from) | ||
} | ||
} | ||
|
||
impl From<DIDJwk> for String { | ||
fn from(value: DIDJwk) -> Self { | ||
value.to_string() | ||
} | ||
} | ||
|
||
impl TryFrom<CoreDID> for DIDJwk { | ||
type Error = Error; | ||
fn try_from(value: CoreDID) -> Result<Self, Self::Error> { | ||
let Self::METHOD = value.method() else { | ||
return Err(Error::InvalidMethodName); | ||
}; | ||
decode_b64_json::<Jwk>(value.method_id()) | ||
.map(|_| Self(value)) | ||
.map_err(|_| Error::InvalidMethodId) | ||
} | ||
} | ||
|
||
#[cfg(test)] | ||
mod tests { | ||
use identity_core::convert::FromJson; | ||
|
||
use super::*; | ||
|
||
#[test] | ||
fn test_valid_deserialization() -> Result<(), Error> { | ||
"did:jwk:eyJrdHkiOiJPS1AiLCJjcnYiOiJYMjU1MTkiLCJ1c2UiOiJlbmMiLCJ4IjoiM3A3YmZYdDl3YlRUVzJIQzdPUTFOei1EUThoYmVHZE5yZngtRkctSUswOCJ9".parse::<DIDJwk>()?; | ||
"did:jwk:eyJjcnYiOiJQLTI1NiIsImt0eSI6IkVDIiwieCI6ImFjYklRaXVNczNpOF91c3pFakoydHBUdFJNNEVVM3l6OTFQSDZDZEgyVjAiLCJ5IjoiX0tjeUxqOXZXTXB0bm1LdG00NkdxRHo4d2Y3NEk1TEtncmwyR3pIM25TRSJ9".parse::<DIDJwk>()?; | ||
|
||
Ok(()) | ||
} | ||
|
||
#[test] | ||
fn test_jwk() { | ||
let did = DIDJwk::parse("did:jwk:eyJrdHkiOiJPS1AiLCJjcnYiOiJYMjU1MTkiLCJ1c2UiOiJlbmMiLCJ4IjoiM3A3YmZYdDl3YlRUVzJIQzdPUTFOei1EUThoYmVHZE5yZngtRkctSUswOCJ9").unwrap(); | ||
let target_jwk = Jwk::from_json_value(serde_json::json!({ | ||
"kty":"OKP","crv":"X25519","use":"enc","x":"3p7bfXt9wbTTW2HC7OQ1Nz-DQ8hbeGdNrfx-FG-IK08" | ||
})) | ||
.unwrap(); | ||
|
||
assert_eq!(did.jwk(), target_jwk); | ||
} | ||
|
||
#[test] | ||
fn test_invalid_deserialization() { | ||
assert!( | ||
"did:iota:0xf4d6f08f5a1b80dd578da7dc1b49c886d580acd4cf7d48119dfeb82b538ad88a" | ||
.parse::<DIDJwk>() | ||
.is_err() | ||
); | ||
assert!("did:jwk:".parse::<DIDJwk>().is_err()); | ||
assert!("did:jwk:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp" | ||
.parse::<DIDJwk>() | ||
.is_err()); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.