jsrsasign - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "jsrsasign",
-  "version": "0.0.1",
-  "description": "pure JavaScript cryptographic library",
+  "version": "0.0.2",
+  "description": "pure JavaScript cryptographic library(jsrsasign) and JSON Web Token (JWT) and JSON Web Signature (JWS) library (jsjws) bundle",
   "main": "lib/jsrsasign.js",
@@ -21,3 +21,3 @@ "scripts": {
     "PKCS8",
-    "Hash",
+    "hash function",
     "HMac",
@@ -29,3 +29,9 @@ "ASN.1",
     "signing",
-    "certificate"
+    "certificate",
+    "JSON Web Token",
+    "JSON Web Signature",
+    "JWT",
+    "JWS",
+    "JOSE",
+    "JWA"
   ],
@@ -32,0 +38,0 @@ "author": "Kenji Urushima",

README.md

@@ -9,1 +9,81 @@ jsrsasign
 Your bugfix and pull request contribution are always welcomed :)
+
+DIFFERENCE WITH CRYPTO MODULE
+-----------------------------
+
+Here is the difference between bundled ['Crypto' module](http://nodejs.org/api/crypto.html) 
+and this 'jsrsasign' module.
+
+- Crypto module
+    - fast
+    - works only on Node.js
+    - OpenSSL based
+    - lacking ASN.1 functionality
+    - provides symmetric ciphers
+    - lacking RSAPSS signing
+- jsrsasign module
+    - slow
+    - implemented in pure JavaScript
+    - works on both Node.js(server) and browsers(client)
+    - provides ASN.1 parsing/generation functionality
+    - lacking symmetric ciphers
+    - provides RSAPSS signing
+    - also provides support for JSON Web Signatures (JWS) and JSON Web Token (JWT)
+
+CONCLUDED THRIDPARTY LIBRARIES
+------------------------------
+
+- [CryptoJS](https://code.google.com/p/crypto-js/): for symmetric cipher, hash, mac, PBKDF (BSD License)
+- [BitCoinJS](http://bitcoinjs.org/): for ECDSA (MIT License)
+- [OpenPGP.js](http://openpgpjs.org/): for DSA (LGPL License)
+- [Tom Wu's jsbn](http://www-cs-students.stanford.edu/~tjw/jsbn/): for BigInteger, RSA encryption and EC (BSD License)
+- [Yahoo YUI](http://yuilibrary.com/): for class inheritance (BSD License)
+- [json-sans-eval](https://code.google.com/p/json-sans-eval/): secure JSON parser (Apache License)
+
+AVAILABLE CLASSES AND METHODS
+-----------------------------
+
+Most of the classes and methods defined in jsrsasign and jsjws are
+available in this jsrsasign npm module.
+
+After loading the module,
+
+    > var r = require('jsrsasign');
+
+You can refer name spaces, classes, methods and functions 
+by following variables:
+
+- [r.BigInteger] - BigInteger class
+- [r.RSAKey] - [RSAKey class](http://kjur.github.io/jsrsasign/api/symbols/RSAKey.html)
+- [r.ECDSA] - [KJUR.crypto.ECDSA class](http://kjur.github.io/jsrsasign/api/symbols/KJUR.crypto.ECDSA.html)
+- [r.DSA] - [KJUR.crypto.DSA class](http://kjur.github.io/jsrsasign/api/symbols/KJUR.crypto.DSA.html)
+- [r.Signature] - [KJUR.crypto.Signature class](http://kjur.github.io/jsrsasign/api/symbols/KJUR.crypto.Signature.html)
+- [r.MessageDigest] - [KJUR.crypto.MessageDigest class](http://kjur.github.io/jsrsasign/api/symbols/KJUR.crypto.MessageDigest.html)
+- [r.Mac] - [KJUR.crypto.Mac class](http://kjur.github.io/jsrsasign/api/symbols/KJUR.crypto.Mac.html)
+- [r.KEYUTIL] - [KEYUTIL class](http://kjur.github.io/jsrsasign/api/symbols/KEYUTIL.html)
+- [r.ASN1HEX] - [ASN1HEX class](http://kjur.github.io/jsrsasign/api/symbols/ASN1HEX.html)
+- [r.crypto] - [KJUR.crypto name space](http://kjur.github.io/jsrsasign/api/symbols/KJUR.crypto.html)
+- [r.asn1] - [KJUR.asn1 name space](http://kjur.github.io/jsrsasign/api/symbols/KJUR.asn1.html)
+- [r.jws] - [KJUR.jws name space](http://kjur.github.io/jsjws/api/)
+
+Please see API reference in the above links.
+
+EXAMPLE(1) SIGNATURE
+--------------------
+
+Loading encrypted PKCS#5 private key:
+
+    > var fs = require('fs');
+    > var pem = fs.readFileSync('z1.prv.p5e.pem', 'binary');
+    > var prvKey = a.KEYUTIL.getKey(pem, 'passwd');
+
+Sign string 'aaa' with the loaded private key:
+
+    > var sig = new a.Signature({alg: 'SHA1withRSA'});
+    > sig.init(prvKey);
+    > sig.updateString('aaa');
+    > var sigVal = sig.sign();
+    > sigVal
+    'd764dcacb...'
+
+

No alert changes

Improved metrics

Total package byte prevSize

217628

7.65%

Number of package files

8

14.29%

Lines of code

1003

5.14%

Number of lines in readme file

89

888.89%

No dependency changes