Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Web5 test vectors #284

Merged
merged 10 commits into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions bindings/web5_uniffi/src/web5.udl
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ enum ResolutionMetadataError {
"RepresentationNotSupported",
"MethodNotSupported",
"InvalidDidDocument",
"InvalidPublicKey",
"InvalidDidDocumentLength",
"InternalError",
};
Expand Down
1 change: 1 addition & 0 deletions bound/kt/src/main/kotlin/web5/sdk/rust/UniFFI.kt
Original file line number Diff line number Diff line change
Expand Up @@ -6483,6 +6483,7 @@ enum class ResolutionMetadataError {
REPRESENTATION_NOT_SUPPORTED,
METHOD_NOT_SUPPORTED,
INVALID_DID_DOCUMENT,
INVALID_PUBLIC_KEY,
INVALID_DID_DOCUMENT_LENGTH,
INTERNAL_ERROR;
companion object
Expand Down
66 changes: 64 additions & 2 deletions crates/web5/src/dids/methods/did_dht/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ impl DidDht {
});
}
let identity_key = zbase32::decode_full_bytes_str(&did.id)
.map_err(|_| ResolutionMetadataError::InvalidDid)?;
.map_err(|_| ResolutionMetadataError::InvalidPublicKey)?;
let identity_key = ed25519::public_jwk_from_bytes(&identity_key)
.map_err(|_| ResolutionMetadataError::InvalidDid)?;
.map_err(|_| ResolutionMetadataError::InvalidPublicKey)?;

// construct http endpoint from gateway url and last part of did_uri
let url = format!(
Expand Down Expand Up @@ -311,3 +311,65 @@ mod tests {
assert_eq!(resolved_document, did_dht.document)
}
}

#[cfg(test)]
mod web5_test_vectors_did_dht {
use crate::dids::resolution::resolution_metadata::ResolutionMetadataError;
use crate::{
dids::resolution::resolution_metadata::ResolutionMetadata, test_helpers::TestVectorFile,
};

#[derive(Debug, PartialEq, serde::Deserialize)]
struct VectorInput {
#[serde(rename = "didUri")]
did_uri: String,
}

#[derive(Debug, PartialEq, serde::Deserialize)]
struct VectorOutput {
#[serde(rename = "didResolutionMetadata")]
did_resolution_metadata: ResolutionMetadata,
}

#[test]
fn resolve() {
let path = "did_dht/resolve.json";
let vectors: TestVectorFile<VectorInput, VectorOutput> =
TestVectorFile::load_from_path(path);

for vector in vectors.vectors {
let vector_input = vector.input;
let vector_output = &vector.output;

// As a replay attack protection protocol, if the same DID is doing a GET request within 5 minutes of each other, instead of a 404 it will start returning a 429.
// to get around this for our test we just create a new DID that is not published to get a fresh 404 for this error code
if let Some(ResolutionMetadataError::NotFound) =
vector_output.did_resolution_metadata.error
{
// TODO: According to the did dht spec a 404 should be returned when trying to resolve a DID that does not exists. Currently it incorrectly returns a 429 even on the first call.
// Uncomment this code block when resolved - https://github.com/TBD54566975/web5-rs/issues/286
continue;

// let private_jwk = Ed25519Generator::generate();
// let identity_key = ed25519::to_public_jwk(&private_jwk);
// let did_dht =
// DidDht::from_identity_key(identity_key.clone()).expect("Should create did:dht");
//
// vector_input = VectorInput{
// did_uri: did_dht.did.uri,
// };
}

let resolution_result = super::DidDht::resolve(&vector_input.did_uri);

let metadata_error = resolution_result.resolution_metadata.error.as_ref();
let expected_error = vector_output.did_resolution_metadata.error.as_ref();

assert_eq!(
metadata_error, expected_error,
"Document resolution metadata does not match. Expected '{:?}' but got '{:?}'.",
expected_error, metadata_error
);
}
}
}
4 changes: 2 additions & 2 deletions crates/web5/src/dids/methods/did_jwk.rs
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ impl DidJwk {
}

#[cfg(test)]
mod tests {
mod web5_test_vectors_did_jwk {
use crate::{
dids::{
data_model::document::Document,
Expand All @@ -141,7 +141,7 @@ mod tests {
}

#[test]
fn test_web5_spec_did_jwk_test_vectors() {
fn resolve() {
let path = "did_jwk/resolve.json";
let vectors: TestVectorFile<String, VectorOutput> = TestVectorFile::load_from_path(path);

Expand Down
3 changes: 3 additions & 0 deletions crates/web5/src/dids/resolution/resolution_metadata.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ pub enum ResolutionMetadataError {
#[error("The DID Document was found but did not represent a conformant document.")]
#[serde(rename = "invalidDidDocument")]
InvalidDidDocument,
#[error("The DID Document does not have a valid public key.")]
#[serde(rename = "invalidPublicKey")]
InvalidPublicKey,
#[error("The size of the DID Document was not within the method's acceptable limit.")]
#[serde(rename = "invalidDidDocumentLength")]
InvalidDidDocumentLength,
Expand Down
Loading