forked from coolaj86/eckles.js
		
	v0.7.2: update docs
This commit is contained in:
		
							parent
							
								
									882cc4b859
								
							
						
					
					
						commit
						ea13bda056
					
				
							
								
								
									
										38
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										38
									
								
								README.md
									
									
									
									
									
								
							| @ -3,16 +3,13 @@ eckles.js | |||||||
| 
 | 
 | ||||||
| ECDSA tools. Lightweight. Zero Dependencies. Universal compatibility. | ECDSA tools. Lightweight. Zero Dependencies. Universal compatibility. | ||||||
| 
 | 
 | ||||||
| > I _just_ cleaned up the PEM-to-JWK functionality enough to publish. | * [x] PEM-to-JWK | ||||||
| > I also have the JWK-to-PEM functionality _mostly_ built, but not enough to publish. | * [ ] JWK-to-PEM (partial) | ||||||
| 
 | 
 | ||||||
| * P-256 (prime256v1, secp256r1) | ### PEM-to-JWK | ||||||
| * P-384 (secp384r1) | 
 | ||||||
| * SPKI/PKIX | * [x] SEC1/X9.62, PKCS#8, SPKI/PKIX | ||||||
| * PKCS#8 | * [x] P-256 (prime256v1, secp256r1), P-384 (secp384r1) | ||||||
| * SEC1/X9.62 |  | ||||||
| * PEM-to-JWK |  | ||||||
| * JWK-to-PEM |  | ||||||
| 
 | 
 | ||||||
| ```js | ```js | ||||||
| var eckles = require('eckles'); | var eckles = require('eckles'); | ||||||
| @ -20,7 +17,10 @@ var pem = require('fs').readFileSync('./fixtures/privkey-ec-p256.sec1.pem', 'asc | |||||||
| 
 | 
 | ||||||
| eckles.import({ pem: pem }).then(function (jwk) { | eckles.import({ pem: pem }).then(function (jwk) { | ||||||
|   console.log(jwk); |   console.log(jwk); | ||||||
|   /* | }); | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | ```js | ||||||
| { | { | ||||||
|   "kty": "EC", |   "kty": "EC", | ||||||
|   "crv": "P-256", |   "crv": "P-256", | ||||||
| @ -28,17 +28,29 @@ eckles.import({ pem: pem }).then(function (jwk) { | |||||||
|   "x": "IT1SWLxsacPiE5Z16jkopAn8_-85rMjgyCokrnjDft4", |   "x": "IT1SWLxsacPiE5Z16jkopAn8_-85rMjgyCokrnjDft4", | ||||||
|   "y": "mP2JwOAOdMmXuwpxbKng3KZz27mz-nKWIlXJ3rzSGMo" |   "y": "mP2JwOAOdMmXuwpxbKng3KZz27mz-nKWIlXJ3rzSGMo" | ||||||
| } | } | ||||||
|   */ |  | ||||||
| }); |  | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | ### JWK-to-PEM | ||||||
|  | 
 | ||||||
|  | * [x] SEC1/X9.62 | ||||||
|  | * [x] P-256 (prime256v1, secp256r1), P-384 (secp384r1) | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
| ```js | ```js | ||||||
| eckles.export({ jwk: jwk }).then(function (pem) { | eckles.export({ jwk: jwk }).then(function (pem) { | ||||||
|   // PEM in pkcs#8 format |   // PEM in sec1 (x9.62) format | ||||||
|   console.log(pem); |   console.log(pem); | ||||||
| }); | }); | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | ``` | ||||||
|  | -----BEGIN EC PRIVATE KEY----- | ||||||
|  | MHcCAQEEIImMnaNu2jRjvQwVFnhhDw/KDYtS2Q6n8T5kJYniwY1UoAoGCCqGSM49 | ||||||
|  | AwEHoUQDQgAEIT1SWLxsacPiE5Z16jkopAn8/+85rMjgyCokrnjDft6Y/YnA4A50 | ||||||
|  | yZe7CnFsqeDcpnPbubP6cpYiVcnevNIYyg== | ||||||
|  | -----END EC PRIVATE KEY----- | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
| <!-- | <!-- | ||||||
| ```js | ```js | ||||||
| eckles.exportSEC1(jwk).then(function (pem) { | eckles.exportSEC1(jwk).then(function (pem) { | ||||||
|  | |||||||
| @ -1,6 +1,6 @@ | |||||||
| { | { | ||||||
|   "name": "eckles", |   "name": "eckles", | ||||||
|   "version": "0.7.1", |   "version": "0.7.2", | ||||||
|   "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", | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user