forked from coolaj86/bluecrypt-keypairs.js
merge working features and add some docs
This commit is contained in:
parent
14c24e3aea
commit
1c0701cd51
49
README.md
49
README.md
|
@ -1,9 +1,46 @@
|
|||
# Bluecrypt™ Keypairs
|
||||
# Bluecrypt™ [Keypairs](https://git.rootprojects.org/root/bluecrypt-keypairs.js) | A [Root](https://rootprojects.org) Project
|
||||
|
||||
A port of [keypairs.js](https://git.coolaj86.com/coolaj86/keypairs.js) to the browser.
|
||||
|
||||
* Keypairs
|
||||
* Eckles (ECDSA)
|
||||
* Rasha (RSA)
|
||||
* X509
|
||||
* ASN1
|
||||
# Features (port in-progress)
|
||||
|
||||
* [x] Keypair generation and encoding
|
||||
* [x] RSA
|
||||
* [x] ECDSA (P-256, P-384)
|
||||
* [x] JWK-to-PEM
|
||||
* [ ] JWK-to-SSH
|
||||
* [ ] PEM-to-JWK
|
||||
* [ ] SSH-to-JWK
|
||||
* [x] ASN1, X509, PEM, DER
|
||||
* [x] SHA256 JWK Thumbprints
|
||||
* [x] Sign JWS
|
||||
* [ ] Create JWTs
|
||||
* [ ] JWK fetching. See [Keyfetch.js](https://npmjs.com/packages/keyfetch/)
|
||||
* [ ] OIDC
|
||||
* [ ] Auth0
|
||||
* [ ] CLI (ee [keypairs-cli](https://npmjs.com/packages/keypairs-cli/))
|
||||
* [ ] Node.js (ee [keypairs.js](https://npmjs.com/packages/keypairs.js))
|
||||
* [ ] [CSR.js](https://git.rootprojects.org/root/bluecrypt-csr.js)
|
||||
* [ ] [ACME.js](https://git.rootprojects.org/root/bluecrypt-acme.js) (Let's Encyrpt)
|
||||
|
||||
# Online Demos
|
||||
|
||||
* Bluecrypt Keypairs.js Demo <https://rootprojects.org/keypairs/>
|
||||
|
||||
# QuickStart
|
||||
|
||||
`bluecrypt-keypairs.js`
|
||||
```html
|
||||
<script src="https://rootprojects.org/keypairs/bluecrypt-keypairs.js"></script>
|
||||
```
|
||||
|
||||
`bluecrypt-keypairs.min.js`
|
||||
```html
|
||||
<script src="https://rootprojects.org/keypairs/bluecrypt-keypairs.min.js"></script>
|
||||
```
|
||||
|
||||
You can see `index.html` and `app.js` in the repo for full example usage.
|
||||
|
||||
# Documentation
|
||||
|
||||
See [keypairs.js](https://git.coolaj86.com/coolaj86/keypairs.js) for documentation.
|
||||
|
|
|
@ -0,0 +1,41 @@
|
|||
#!/bin/bash
|
||||
|
||||
# Development Version
|
||||
cat > bluecrypt-keypairs.js << EOF
|
||||
// Copyright 2015-2019 AJ ONeal. All rights reserved
|
||||
/* 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/. */
|
||||
;
|
||||
EOF
|
||||
cat ./lib/encoding.js \
|
||||
./lib/asn1-packer.js \
|
||||
./lib/x509.js \
|
||||
./lib/ecdsa.js \
|
||||
./lib/rsa.js \
|
||||
./lib/keypairs.js \
|
||||
>> bluecrypt-keypairs.js
|
||||
|
||||
# Gzipped
|
||||
cat > bluecrypt-keypairs.min.js << EOF
|
||||
// Copyright 2015-2019 AJ ONeal. All rights reserved
|
||||
/* 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/. */
|
||||
;
|
||||
EOF
|
||||
uglifyjs bluecrypt-keypairs.js >> bluecrypt-keypairs.min.js
|
||||
gzip bluecrypt-keypairs.min.js
|
||||
|
||||
# Minified Gzipped
|
||||
cat > bluecrypt-keypairs.min.js << EOF
|
||||
// Copyright 2015-2019 AJ ONeal. All rights reserved
|
||||
/* 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/. */
|
||||
;
|
||||
EOF
|
||||
uglifyjs bluecrypt-keypairs.js >> bluecrypt-keypairs.min.js
|
||||
|
||||
rsync -av ./ root@beta.rootprojects.org:~/beta.rootprojects.org/keypairs/
|
||||
rsync -av ./ ubuntu@rootprojects.org:/srv/www/rootprojects.org/keypairs/
|
11
package.json
11
package.json
|
@ -1,13 +1,18 @@
|
|||
{
|
||||
"name": "bluecrypt-keypairs",
|
||||
"name": "@bluecrypt/keypairs",
|
||||
"version": "0.1.1",
|
||||
"description": "Zero-Dependency Native Browser support for ECDSA P-256 and P-384, and RSA 2048/3072/4096 written in VanillaJS",
|
||||
"homepage": "https://rootprojects.org/keypairs/",
|
||||
"files": [
|
||||
"lib",
|
||||
"bluecrypt-keypairs.js",
|
||||
"bluecrypt-keypairs.min.js"
|
||||
]
|
||||
"directories": {
|
||||
"lib": "lib"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "node server.js",
|
||||
"start": "node server.js"
|
||||
"test": "node test.js"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
|
Loading…
Reference in New Issue