semvec/pypi-packages huggingface dataset:
didself 2.1
A did:self implementation
License: MIT
Requires Python: >=3.6, <4

# A python implementation of did:self
This is a python implementation of the [did:self method](https://github.com/mmlab-aueb/did-self)

# Usage
This library can be used for Creating, Reading, or Updating a 
did:self DID. These operations are supported by an auxiliary script called the
`self registry`.

## Self registry preparation
Before any operation, a did:self a self registry must be configured with the
user's key pair, encoded in JWK. An example of registry initialization is the following

```python
# Generate DID and initial secret key
did_key = jwk.JWK.generate(kty='EC', crv='P-256')
# Initialize registry
owner_registry = registry.DIDSelfRegistry(did_key)
```

## Create
A did:self DID is  is the thumbprint of a JWK as defined in RFC 7638. In order to create a did:self
DID, a user must generate the corresponding key-pair, create a DID document, and
invoke the `create` method of the DID registry. An example of this process follows

```python
did_key_dict = did_key.export_public(as_dict=True)
did = "did:self:" + did_key.thumbprint()
did_document = {
    'id': did,
    'authentication': [{
        'id': '#key1',
        'type': "JsonWebKey2020",
        'publicKeyJwk': did_key_dict
    }],  
}

owner_registry.create(did_document)
```
## Read
By invoking the `read` operation of the registry a user obtains the DID document and 
the `proof`.

## Update
A DID document can be simply updated by invoking the `update` method of the
registry, providing as input the new DID document. For example:

```python
authentication_jwk = jwk.JWK.generate(kty='OKP', crv='Ed25519')
did_document = {
    'id': did,
    'authentication': [{
        'id': did + '#key2',
        'type': "JsonWebKey2020",
        'publicKeyJwk': authentication_jwk.export_public(as_dict=True)
    }]
}
owner_registry.update(did_document)
```