From 077532ab338bb8c7cdd53e98de2a0abb5375cd74 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Sat, 24 Nov 2018 23:24:46 -0700 Subject: [PATCH] v1.3.3: move CLI to own module --- README.md | 36 +++--------------------------------- package.json | 2 +- 2 files changed, 4 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 7b60057..86636fb 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ ECDSA (elliptic curve) tools. Lightweight. Zero Dependencies. Universal compatib * [x] JWK-to-PEM * [x] SSH "pub" format * [x] CLI + * See [Eckles CLI](https://git.coolaj86.com/coolaj86/eckles-cli.js) * [ ] RSA * **Need RSA tools?** Check out [Rasha.js](https://git.coolaj86.com/coolaj86/rasha.js) @@ -31,6 +32,8 @@ CLI: npm install -g eckles ``` +See [Eckles CLI](https://git.coolaj86.com/coolaj86/eckles-cli.js) + ## Generate EC (ECDSA/ECDH) Key Achieves the *fastest possible key generation* using node's native EC bindings to OpenSSL, @@ -61,17 +64,6 @@ Eckles.generate({ format: 'jwk' }).then(function (keypair) { * A) because they're a senseless waste * B) they have similar, but slightly different formats -#### Generate EC Key CLI - -```bash -# Generate a key in each format -# eckles [format] [curve|encoding] -eckles jwk -eckles sec1 pem -eckles pkcs8 der -eckles ssh P-256 -``` - ## PEM-to-JWK * [x] SEC1/X9.62, PKCS#8, SPKI/PKIX @@ -98,17 +90,6 @@ Eckles.import({ pem: pem }).then(function (jwk) { } ``` -#### EC PEM to JWK CLI - -```bash -# Convert SEC1, PKCS8, SPKI, SSH to JWK -# eckles [keyfile] -eckles node_modules/eckles/fixtures/privkey-ec-p256.sec1.pem -eckles node_modules/eckles/fixtures/privkey-ec-p384.pkcs8.pem -eckles node_modules/eckles/fixtures/pub-ec-p256.spki.pem -eckles node_modules/eckles/fixtures/pub-ec-p384.ssh.pub -``` - ## JWK-to-PEM * [x] SEC1/X9.62, PKCS#8, SPKI/PKIX @@ -133,17 +114,6 @@ yZe7CnFsqeDcpnPbubP6cpYiVcnevNIYyg== -----END EC PRIVATE KEY----- ``` -#### EC PEM to JWK CLI - -```bash -# Convert JWK to SEC1, PKCS8, SPKI, SSH -# eckles [keyfile] [format] -eckles node_modules/eckles/fixtures/privkey-ec-p256.jwk.json sec1 -eckles node_modules/eckles/fixtures/privkey-ec-p384.jwk.json pkcs8 -eckles node_modules/eckles/fixtures/pub-ec-p256.jwk.json spki -eckles node_modules/eckles/fixtures/pub-ec-p384.jwk.json ssh -``` - ### Advanced Options `format: 'pkcs8'`: diff --git a/package.json b/package.json index f21e52c..ada609e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "eckles", - "version": "1.3.2", + "version": "1.3.3", "description": "💯 PEM-to-JWK and JWK-to-PEM (and SSH) for ECDSA keys in a lightweight, zero-dependency library focused on perfect universal compatibility.", "homepage": "https://git.coolaj86.com/coolaj86/eckles.js", "main": "index.js",