coolaj86/eckles.js
1
2
Fork 1
Code Issues Pull Requests Releases Wiki Activity

v1.0.1: update README

Browse Source
This commit is contained in:
AJ ONeal 2018-11-19 23:31:03 -07:00
parent 130a98677c
commit a2bfbf2308
2 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,11 +1,19 @@
eckles.js eckles.js
========= =========
Sponsored by [Root](https://therootcompany.com).
Built for [ACME.js](https://git.coolaj86.com/coolaj86/acme.js)
and [Greenlock.js](https://git.coolaj86.com/coolaj86/greenlock.js)
ECDSA (elliptic curve) tools. Lightweight. Zero Dependencies. Universal compatibility. ECDSA (elliptic curve) tools. Lightweight. Zero Dependencies. Universal compatibility.
* [x] PEM-to-JWK * [x] PEM-to-JWK
* [x] JWK-to-PEM * [x] JWK-to-PEM
This project is fully functional and tested (and the code is pretty clean).
It is considered to be complete, but if you find a bug please open an issue.
## PEM-to-JWK ## PEM-to-JWK
* [x] SEC1/X9.62, PKCS#8, SPKI/PKIX * [x] SEC1/X9.62, PKCS#8, SPKI/PKIX
@ -13,7 +21,8 @@ ECDSA (elliptic curve) tools. Lightweight. Zero Dependencies. Universal compatib
```js ```js
var eckles = require('eckles'); var eckles = require('eckles');
var pem = require('fs').readFileSync('eckles/fixtures/privkey-ec-p256.sec1.pem', 'ascii'); var pem = require('fs')
.readFileSync('./node_modles/eckles/fixtures/privkey-ec-p256.sec1.pem', 'ascii');
eckles.import({ pem: pem }).then(function (jwk) { eckles.import({ pem: pem }).then(function (jwk) {
console.log(jwk); console.log(jwk);
@ -53,7 +62,7 @@ yZe7CnFsqeDcpnPbubP6cpYiVcnevNIYyg==
-----END EC PRIVATE KEY----- -----END EC PRIVATE KEY-----
``` ```
#### Advanced ### Advanced Options
`format: 'pkcs8'`: `format: 'pkcs8'`:
@ -80,10 +89,18 @@ eckles.export({ jwk: jwk, public: true }).then(function (pem) {
}); });
``` ```
Goals Goals of this project
----- -----
* Zero Dependencies * Zero Dependencies
* Focused support for P-256 and P-384, which are already universally supported. * Focused support for P-256 and P-384, which are already universally supported.
* Convert both ways * Convert both ways
* Browser support as well * Browser support as well (TODO)
Legal
-----
Licensed MPL-2.0
[Terms of Use](https://therootcompany.com/legal/#terms) |
[Privacy Policy](https://therootcompany.com/legal/#privacy)

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "eckles", "name": "eckles",
"version": "1.0.0", "version": "1.0.1",
"description": "PEM-to-JWK and JWK-to-PEM for ECDSA keys in a lightweight, zero-dependency library focused on perfect universal compatibility.", "description": "PEM-to-JWK and JWK-to-PEM for ECDSA keys in a lightweight, zero-dependency library focused on perfect universal compatibility.",
"homepage": "https://git.coolaj86.com/coolaj86/eckles.js", "homepage": "https://git.coolaj86.com/coolaj86/eckles.js",
"main": "index.js", "main": "index.js",