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

update readme

This commit is contained in:
AJ ONeal 2016-09-02 14:25:07 -06:00
parent b3102ded8d
commit 861872499e
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -9,7 +9,11 @@ See [Help Wanted: Database Plugins (for saving certs)](https://github.com/Daplie
How to create a custom strategy How to create a custom strategy
=============================== ===============================
Let's say there's some new database AwesomeDB that READ THIS README:
Believe it or not, most of your answers are either right here
or in the comments in the sample code in `index.js`.
Now, let's say there's some new database AwesomeDB that
we want to make a plugin for, here's how we'd start: we want to make a plugin for, here's how we'd start:
```bash ```bash
@ -19,6 +23,7 @@ git clone git@github.com:AwesomeDB/le-store-awesome.git
pushd le-store-awesome pushd le-store-awesome
# IMPORTANT: we pull in the 'template' branch, which has the skeleton code
git pull https://github.com/Daplie/le-store-SPEC.git template git pull https://github.com/Daplie/le-store-SPEC.git template
git push git push
@ -68,7 +73,27 @@ versions of the private and/or public keys when being passed to the `*Keypair` f
`privateKeyPem`, `publicKeyPem`, and `privateKeyJwk`. It's easy to generate `publicKeyJwk` `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`. from `privateKeyJwk` because it is just a copy of the public fields `e` and `n`.
```
// keypair looks like this
{ privateKeyPem: '...'
, publicKeyPem: '...'
, privateKeyJwk: { ... }
}
```
**check** **check**
`checkKeypair` may be called with any of `email`, `accountId`, and `keypair` - which will `checkKeypair` may be called with any of `email`, `accountId`, and `keypair` - which will
contain only `publicKeyPem` and `publicKeyJwk`. contain only `publicKeyPem` and `publicKeyJwk`.
```
// opts looks like this
{
email: '...@...'
, accountId: '...'
, keypair: {
publicKeyPem: '...'
, publicKeyJwk: { ... }
}
}
```