ereuse
/
pyvckit
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix READMES

This commit is contained in:
Cayo Puigdefabregas 2024-06-03 17:53:58 +02:00
parent 4c876e56c7
commit d0d4ac8d6c
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -25,47 +25,47 @@ The mode of use under the command line would be the following:
## generate a key pair: ## generate a key pair:
```sh ```sh
python did.py -n keys > keypair.json python pyvckit/did.py -n keys > keypair.json
``` ```
## generate a did identifier: ## generate a did identifier:
### did key ### did key
```sh ```sh
python did.py -n did -k keypair.json python pyvckit/did.py -n did -k keypair.json
``` ```
### did web ### did web
```sh ```sh
python did.py -n did -k keypair.json -u https://localhost/user1/dids/ python pyvckit/did.py -n did -k keypair.json -u https://localhost/user1/dids/
``` ```
## generate an example signed credential: ## generate an example signed credential:
An example of a credential is generated, which is the one that appears in the credential_tmpl template in the file [templates.py](templates.py) An example of a credential is generated, which is the one that appears in the credential_tmpl template in the file [templates.py](templates.py)
```sh ```sh
python sign_vc.py -k keypair.json > credential_signed.json python pyvckit/sign_vc.py -k keypair.json > credential_signed.json
``` ```
## verify a signed credential: ## verify a signed credential:
```sh ```sh
python verify_vc.py credential_signed.json python pyvckit/verify_vc.py credential_signed.json
``` ```
## generate a verifiable presentation: ## generate a verifiable presentation:
```sh ```sh
python sign_vp.py -k keypair.json -c credential_signed.json > presentation_signed.json python pyvckit/sign_vp.py -k keypair.json -c credential_signed.json > presentation_signed.json
``` ```
## verify a verifiable presentation: ## verify a verifiable presentation:
```sh ```sh
python verify_vp.py presentation_signed.json python pyvckit/verify_vp.py presentation_signed.json
``` ```
## creation of did document: ## creation of did document:
This command will create a json document and a url path where to place this document. The did must be a web did. This command will create a json document and a url path where to place this document. The did must be a web did.
This document is an example and in production it must be adapted to contain the revoked verifiable credentials. This document is an example and in production it must be adapted to contain the revoked verifiable credentials.
```sh ```sh
python did.py -k keypair.json -g did:web:localhost:did-registry:z6MkiNc8xqJLcG7QR1wzD9HPs5oPQEaWNcVf92QsbppNiB7C python pyvckit/did.py -k keypair.json -g did:web:localhost:did-registry:z6MkiNc8xqJLcG7QR1wzD9HPs5oPQEaWNcVf92QsbppNiB7C
``` ```
# Use as a library # Use as a library

16
README_es.md
View File

@ -25,47 +25,47 @@ El modo de uso bajo la linea de comandos seria el siguiente:
## generar un par de claves: ## generar un par de claves:
```sh ```sh
python did.py -n keys > keypair.json python pyvckit/did.py -n keys > keypair.json
``` ```
## generar un identificador did: ## generar un identificador did:
### did key ### did key
```sh ```sh
python did.py -n did -k keypair.json python pyvckit/did.py -n did -k keypair.json
``` ```
### did web ### did web
```sh ```sh
python did.py -n did -k keypair.json -u https://localhost/user1/dids/ python pyvckit/did.py -n did -k keypair.json -u https://localhost/user1/dids/
``` ```
## generar una credencial firmada de ejemplo: ## generar una credencial firmada de ejemplo:
Se genera un ejemplo de credencial que es el que aparece en la plantilla credential_tmpl del fichero [templates.py](templates.py) Se genera un ejemplo de credencial que es el que aparece en la plantilla credential_tmpl del fichero [templates.py](templates.py)
```sh ```sh
python sign_vc.py -k keypair.json > credential_signed.json python pyvckit/sign_vc.py -k keypair.json > credential_signed.json
``` ```
## verificar una credencial firmada: ## verificar una credencial firmada:
```sh ```sh
python verify_vc.py credential_signed.json python pyvckit/verify_vc.py credential_signed.json
``` ```
## generar una presentación verificable: ## generar una presentación verificable:
```sh ```sh
python sign_vp.py -k keypair.json -c credential_signed.json > presentation_signed.json python pyvckit/sign_vp.py -k keypair.json -c credential_signed.json > presentation_signed.json
``` ```
## verificar una presentación verificable: ## verificar una presentación verificable:
```sh ```sh
python verify_vp.py presentation_signed.json python pyvckit/verify_vp.py presentation_signed.json
``` ```
## creación del documento did: ## creación del documento did:
Este comando creara un documento json y una ruta url donde colocar este documento. El did tiene que ser un did web. Este comando creara un documento json y una ruta url donde colocar este documento. El did tiene que ser un did web.
Este documento es un ejemplo y en producción hay que adaptarlo para contener las credenciales verificables revocadas. Este documento es un ejemplo y en producción hay que adaptarlo para contener las credenciales verificables revocadas.
```sh ```sh
python did.py -k keypair.json -g did:web:localhost:did-registry:z6MkiNc8xqJLcG7QR1wzD9HPs5oPQEaWNcVf92QsbppNiB7C python pyvckit/did.py -k keypair.json -g did:web:localhost:did-registry:z6MkiNc8xqJLcG7QR1wzD9HPs5oPQEaWNcVf92QsbppNiB7C
``` ```
# Uso como librería # Uso como librería