v1.0.1: update README

This commit is contained in:
AJ ONeal 2018-12-01 22:25:44 -07:00
parent 86ee62e0d3
commit a0e798debd
3 changed files with 21 additions and 5 deletions

View File

@ -1,4 +1,4 @@
# Bluecrypt&trade SSH to JWK (for Browsers) # Bluecrypt SSH to JWK (for Browsers)
A minimal library to parse an SSH public key (`id_rsa.pub`) A minimal library to parse an SSH public key (`id_rsa.pub`)
and convert it into a public JWK using Vanilla JS. and convert it into a public JWK using Vanilla JS.
@ -16,6 +16,7 @@ Works for RSA and ECDSA public keys.
* P-384 (secp384r1) * P-384 (secp384r1)
* [x] node.js version * [x] node.js version
* [ssh-to-jwk.js](https://git.coolaj86.com/coolaj86/ssh-to-jwk.js) * [ssh-to-jwk.js](https://git.coolaj86.com/coolaj86/ssh-to-jwk.js)
* [x] on npm as [bluecrypt-jwk-to-ssh](https://www.npmjs.com/package/bluecrypt-ssh-to-jwk)
### Need SSH Private Keys? ### Need SSH Private Keys?
@ -35,14 +36,24 @@ pushd bluecrypt-ssh-to-jwk.js/
open index.html open index.html
``` ```
# Usage # Install
You can also use it as a library: You can use it as a plain-old javascript library:
```html ```html
<script src="https://git.coolaj86.com/coolaj86/bluecrypt-ssh-to-jwk.js/raw/branch/master/ssh-to-jwk.js"></script> <script src="https://git.coolaj86.com/coolaj86/bluecrypt-ssh-to-jwk.js/raw/branch/master/ssh-to-jwk.js"></script>
``` ```
It's also on npm:
```bash
npm install bluecrypt-ssh-to-jwk
```
# Usage
Very simple:
```js ```js
var pub = 'ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBCE9Uli8bGnD4hOWdeo5KKQJ/P/vOazI4MgqJK54w37emP2JwOAOdMmXuwpxbKng3KZz27mz+nKWIlXJ3rzSGMo= root@localhost'; var pub = 'ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBCE9Uli8bGnD4hOWdeo5KKQJ/P/vOazI4MgqJK54w37emP2JwOAOdMmXuwpxbKng3KZz27mz+nKWIlXJ3rzSGMo= root@localhost';
@ -53,7 +64,7 @@ console.info(ssh.jwk);
# Other Tools in the Bluecrypt Suite # Other Tools in the Bluecrypt Suite
* [Bluecrypt JWK to SSH](https://git.coolaj86.com/coolaj86/jwk-to-ssh.js) (RSA, EC, SSH) * [Bluecrypt JWK to SSH](https://git.coolaj86.com/coolaj86/bluecrypt-jwk-to-ssh.js) (RSA, EC, SSH)
* [Bluecrypt ASN.1 decoder](https://git.coolaj86.com/coolaj86/asn1-parser.js) (x509, RSA, EC, etc) * [Bluecrypt ASN.1 decoder](https://git.coolaj86.com/coolaj86/asn1-parser.js) (x509, RSA, EC, etc)
* [Bluecrypt ASN.1 builder](https://git.coolaj86.com/coolaj86/asn1-packer.js) (x509, RSA, EC, etc) * [Bluecrypt ASN.1 builder](https://git.coolaj86.com/coolaj86/asn1-packer.js) (x509, RSA, EC, etc)
@ -63,3 +74,5 @@ console.info(ssh.jwk);
MPL-2.0 | MPL-2.0 |
[Terms of Use](https://therootcompany.com/legal/#terms) | [Terms of Use](https://therootcompany.com/legal/#terms) |
[Privacy Policy](https://therootcompany.com/legal/#privacy) [Privacy Policy](https://therootcompany.com/legal/#privacy)
Bluecrypt&trade; is owned by AJ ONeal

View File

@ -1,6 +1,6 @@
{ {
"name": "bluecrypt-ssh-to-jwk", "name": "bluecrypt-ssh-to-jwk",
"version": "1.0.0", "version": "1.0.1",
"description": "SSH to JWK in < 150 lines of VanillaJS.", "description": "SSH to JWK in < 150 lines of VanillaJS.",
"homepage": "https://git.coolaj86.com/coolaj86/bluecrypt-ssh-to-jwk.js", "homepage": "https://git.coolaj86.com/coolaj86/bluecrypt-ssh-to-jwk.js",
"main": "ssh-to-jwk.js", "main": "ssh-to-jwk.js",

View File

@ -1,3 +1,6 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
;(function (exports) { ;(function (exports) {
'use strict'; 'use strict';