Skip to content

Commit

Permalink
fix: README editorials
Browse files Browse the repository at this point in the history
  • Loading branch information
peppelinux committed Jun 12, 2023
1 parent 76c9d6d commit 9411247
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ pyMDOC-CBOR is a
[cbor2](https://github.com/agronholm/cbor2)
and
[pycose](https://github.com/TimothyClaeys/pycose)
wrapper that parses, creates and validates MDOC CBOR encoded binaries,
as defined in ISO 18013-5.
wrapper that parses, creates and validates MDOC CBOR encoded binaries
according to ISO 18013-5.

## Setup

Expand All @@ -41,7 +41,7 @@ pip install git+https://github.com/peppelinux/pyMDL-MDOC.git

### Issue an MDOC CBOR

`MdocCborIssuer` need to be initialized with a private key.
`MdocCborIssuer` must be initialized with a private key.
The method `.new()` gets the user attributes, devicekeyinfo and doctype.

````
Expand Down Expand Up @@ -77,21 +77,21 @@ mdoc
>> returns a python dictionay
mdoc.dump()
>> returns mdoc mso bytes
>> returns mdoc MSO bytes
mdoci.dump()
>> returns bytes
>> returns mdoc bytes
mdoci.dumps()
>> returns AF Binary string representation
>> returns AF Binary mdoc string representation
````

### Issue an MSO alone

MsoIssuer is a class that handles private keys, data processing, digests and signature operations.

The `disclosure_map` is used in the Mdoc `nameSpaces` object for issuance and presentations,
it's carried in the mdoc but outside the MSO, even if it is produced by `MsoIssuer`.
it's carried in the mdoc but outside of the MSO, even if it is produced by `MsoIssuer`.
that's why `MsoIssuer.sign()` returns a pure MSO, while `disclosure_map`
is an attribute of the `MsoIssuer` instance.

Expand Down Expand Up @@ -139,7 +139,7 @@ mdoc.verify()
>> True
mdoc
>> [pymdoccbor.mdoc.verifier.MdocCbor [1 valid documents]]
>> pymdoccbor.mdoc.verifier.MdocCbor [1 valid documents]
mdoc.documents
>> [pymdoccbor.mdoc.verifier.MobileDocument [valid]]
Expand Down

0 comments on commit 9411247

Please sign in to comment.