From 8b7e07e1725c19c0e93ad5cb57b8039de29a52ce Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Tue, 20 Nov 2018 12:07:50 -0700 Subject: [PATCH] v1.1.1: show key examples in docs --- README.md | 19 +++++++++++++++++++ package.json | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e9c059..8fa53db 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,14 @@ eckles.export({ jwk: jwk, format: 'pkcs8' }).then(function (pem) { }); ``` +``` +-----BEGIN EC PRIVATE KEY----- +MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgiYydo27aNGO9DBUW +eGEPD8oNi1LZDqfxPmQlieLBjVShRANCAAQhPVJYvGxpw+ITlnXqOSikCfz/7zms +yODIKiSueMN+3pj9icDgDnTJl7sKcWyp4Nymc9u5s/pyliJVyd680hjK +-----END EC PRIVATE KEY----- +``` + `format: 'ssh'`: Although SSH uses SEC1 for private keys, it uses ts own special non-ASN1 format @@ -93,6 +101,10 @@ eckles.export({ jwk: jwk, format: 'ssh' }).then(function (pub) { }); ``` +``` +ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBCE9Uli8bGnD4hOWdeo5KKQJ/P/vOazI4MgqJK54w37emP2JwOAOdMmXuwpxbKng3KZz27mz+nKWIlXJ3rzSGMo= P-256@localhost +``` + `public: 'true'`: If a private key is used as input, a private key will be output. @@ -106,6 +118,13 @@ eckles.export({ jwk: jwk, public: true }).then(function (pem) { }); ``` +``` +-----BEGIN PUBLIC KEY----- +MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEIT1SWLxsacPiE5Z16jkopAn8/+85 +rMjgyCokrnjDft6Y/YnA4A50yZe7CnFsqeDcpnPbubP6cpYiVcnevNIYyg== +-----END PUBLIC KEY----- +``` + Goals of this project ----- diff --git a/package.json b/package.json index e8ae525..4a6c590 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "eckles", - "version": "1.1.0", + "version": "1.1.1", "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", "main": "index.js",