Skip to content

Commit 56c73c9

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents f2c4813 + 00c8448 commit 56c73c9

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var key = new NodeRSA([key], [options]);
3737
**key** - parameters of a generated key or the key in PEM format.<br/>
3838
**options** - additional settings
3939
* **environment** - working environment, `'browser'` or `'node'`. Default autodetect.
40-
* **signingAlgorithm** - hash algorithm used for signing and verifying. Can by `'sha1'`, `'sha256'`, `'md5'`. Default `'sha256'`.
40+
* **signingAlgorithm** - hash algorithm used for signing and verifying. Can be `'sha1'`, `'sha256'`, `'md5'`. Default `'sha256'`.
4141

4242
#### "Empty" key
4343
```js
@@ -78,20 +78,33 @@ key.getPrivatePEM();
7878
key.getPublicPEM();
7979
```
8080

81-
### Test key
81+
### Properties
82+
83+
#### Key testing
8284
```js
8385
key.isPrivate();
8486
key.isPublic([strict]);
8587
```
8688
**strict** - if true method will return false if key pair have private exponent. Default `false`.
8789

90+
#### Key info
91+
```js
92+
key.getKeySize();
93+
```
94+
Return key size in bits.
95+
96+
```js
97+
key.getMaxMessageSize();
98+
```
99+
Return max data size for encrypt in bytes.
100+
88101
### Encrypting/decrypting
89102
```js
90103
key.encrypt(buffer, [encoding], [source_encoding]);
91104
```
92105
Return encrypted data.<br/>
93106
**buffer** - data for encrypting, may be string, Buffer, or any object/array. Arrays and objects will encoded to JSON string first.<br/>
94-
**encoding** - encoding for output result, may be `'buffer'`, `'binary'`, `'hex'` or 'base64'. Default `'buffer'`.
107+
**encoding** - encoding for output result, may be `'buffer'`, `'binary'`, `'hex'` or 'base64'. Default `'buffer'`.<br/>
95108
**source_encoding** - source encoding, works only with string buffer. Can take standard Node.js Buffer encodings (hex, utf8, base64, etc). `'utf8'` by default.<br/>
96109

97110
```js
@@ -124,6 +137,8 @@ Questions, comments, bug reports, and pull requests are all welcome.
124137

125138
### 0.1.50
126139
* Implemented native js signing and verifying for browsers
140+
* `options.signingAlgorithm` now takes only hash-algorithm name
141+
* Added `.getKeySize()` and `.getMaxMessageSize()` methods
127142
* `.loadFromPublicPEM` and `.loadFromPrivatePEM` methods marked as private
128143

129144
### 0.1.40

0 commit comments

Comments
 (0)