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.

Sign up for GitHub

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

cli did create web #263

Merged
merged 7 commits into from
Jul 16, 2024
Merged

cli did create web #263

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
72fea60
cli did create web
Jul 8, 2024
9d60e25
Lint
Jul 8, 2024
5a03e7c
Add did:web constructor to APID
KendallWeihe Jul 9, 2024
86cbc0d
Normalize and encoded url
Jul 11, 2024
906f251
Fix normalization logic
KendallWeihe Jul 16, 2024
c9a8e73
Move normalization and encoding features into native DidWeb::new()
KendallWeihe Jul 16, 2024
497eefb
Fix linting
KendallWeihe Jul 16, 2024
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
38 changes: 32 additions & 6 deletions crates/web5/src/dids/methods/did_web/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
mod resolver;

use super::{MethodError, Result};
use crate::dids::{
data_model::document::Document,
did::Did,
resolution::{
resolution_metadata::{ResolutionMetadata, ResolutionMetadataError},
resolution_result::ResolutionResult,
use crate::{
crypto::jwk::Jwk,
dids::{
data_model::{document::Document, verification_method::VerificationMethod},
did::Did,
resolution::{
resolution_metadata::{ResolutionMetadata, ResolutionMetadataError},
resolution_result::ResolutionResult,
},
},
};
use resolver::Resolver;
Expand All @@ -18,6 +21,29 @@ pub struct DidWeb {
}

impl DidWeb {
pub fn new(domain: &str, public_jwk: Jwk) -> Result<Self> {
let did = format!("did:web:{}", domain);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't quite right because the domain has to be encoded according to the spec. See here and here. Also web5-go as inspiration.

Probably we should use a strongly typed Url here to ensure the passed domain: &str is a valid domain.

I believe also did:web has a requirement of enforcing https over http, but with the caveat that, if the domain is localhost then http is allowed. We're currently setup to handle this in resolution, but here too, we should use a strongly typed Url to ensure the domain is localhost and not something like localhost-neal-example.com. Feel free to improve the resolution code as well in this PR if you think it's appropriate.


let verification_method = VerificationMethod {
id: format!("{}#key-0", did),
KendallWeihe marked this conversation as resolved.
Show resolved Hide resolved
r#type: "JsonWebKey2020".to_string(),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nitro-neal didn't we standardize this to just JsonWebKey?

controller: did.clone(),
public_key_jwk: public_jwk,
};

let document = Document {
id: did.clone(),
context: Some(vec!["https://www.w3.org/ns/did/v1".to_string()]),
verification_method: vec![verification_method],
..Default::default()
};

Ok(DidWeb {
did: Did::new(&did)?,
document,
})
}

pub async fn from_uri(uri: &str) -> Result<Self> {
let resolution_result = DidWeb::resolve(uri);
match resolution_result.document {
Expand Down
26 changes: 23 additions & 3 deletions crates/web5_cli/src/dids/create.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use std::sync::Arc;
use web5::{
crypto::dsa::ed25519::{Ed25519Generator, Ed25519Signer},
dids::{
methods::{did_dht::DidDht, did_jwk::DidJwk},
methods::{did_dht::DidDht, did_jwk::DidJwk, did_web::DidWeb},
portable_did::PortableDid,
},
};
Expand All @@ -17,7 +17,12 @@ pub enum Commands {
json_escape: bool,
},
Web {
#[arg(long)]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#[arg(long)]

The domain is a required parameter, so not an arg (you can just delete the line).

Also, thoughts on calling it URL because it could include the HTTP path such as in Example 5 here. I'm thinking, name it url, and then handle the following use cases:

  1. If they pass in http://some-domain.com then the http would throw an error, b/c needs to be https
  2. With the caveat, http is allowed if the domain name is localhost (or 127.0.0.1)
  3. If they pass in https://some-domain.com then that's fine, but we have to splice off the https://
  4. If they pass in the did.json file name (as the trailing path part), that's fine but it must be spliced off before creating the DID URI
  5. If they pass in the .well-known use case in the url then it's also spliced off

Basically my thinking is, enable the developer to copy/paste exactly the endpoint they're expecting to host the DID Document at but then ensure the DID URI is spec conformant.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a commit to cover these cases

domain: String,
#[arg(long)]
no_indent: bool,
#[arg(long)]
json_escape: bool,
},
Dht {
#[arg(long)]
Expand Down Expand Up @@ -63,8 +68,23 @@ impl Commands {

print_portable_did(portable_did, no_indent, json_escape);
}
Commands::Web { domain: _ } => {
println!("🚧 not currently supported 🚧");
Commands::Web {
domain,
no_indent,
json_escape,
} => {
let private_jwk = Ed25519Generator::generate();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that with did web especially, we should allow people to pass in the own private key / portable did. We can add this as a feature in the future though

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed, on the private key input (portable DID slightly different use case I haven't thought through -- creating a new DID with an existing DID), but yeah not a priority at this moment

let mut public_jwk = private_jwk.clone();
public_jwk.d = None;

let did_web = DidWeb::new(domain, public_jwk).unwrap();
let portable_did = PortableDid {
did_uri: did_web.did.uri,
document: did_web.document,
private_jwks: vec![private_jwk],
};

print_portable_did(portable_did, no_indent, json_escape)
}
Commands::Dht {
no_publish,
Expand Down
Loading