coolaj86
/
le-store-SPEC.js
1
0
Fork 0
Code Issues 3 Pull Requests Releases Wiki Activity

merge README.md

This commit is contained in:
AJ ONeal 2016-08-13 15:07:41 -06:00
parent e120d2dcc2
commit a0bda23683
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -20,5 +20,22 @@ API
* checkKeypair(opts, cb) * checkKeypair(opts, cb)
* setKeypair(opts, keypair, cb) * setKeypair(opts, keypair, cb)
* check(opts, cb) * check(opts, cb)
* set(opts, reg, cb) * set(opts, certs, cb)
``` ```
Keypairs
--------
For convenience, the keypair object will always contain **both** PEM and JWK
versions of the private and/or public keys when being passed to the `*Keypair` functions.
**set**
`setKeypair` will always be called with `email` and **all three** forms of the keypair:
`privateKeyPem`, `publicKeyPem`, and `privateKeyJwk`. It's easy to generate `publicKeyJwk`
from `privateKeyJwk` because it is just a copy of the public fields `e` and `n`.
**check**
`checkKeypair` may be called with any of `email`, `accountId`, and `keypair` - which will
contain only `publicKeyPem` and `publicKeyJwk`.