Skip to content

Commit 9627212

Browse files
rzcoderrzcoder
committed
rename some method
1 parent 1cdd7a9 commit 9627212

File tree

4 files changed

+44
-37
lines changed

4 files changed

+44
-37
lines changed

‎README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,15 +107,15 @@ Also you can use next methods:
107107

108108
```javascript
109109
key.generateKeyPair([bits], [exp]);
110-
key.loadFromPEM(pem_string|buffer_contains_pem);
110+
key.importKey(pem_string|buffer_contains_pem);
111111
```
112112
**bits** - key size in bits. 2048 by default.
113113
**exp** - public exponent. 65537 by default.
114114

115115
### Export keys
116116
```javascript
117-
key.getPrivatePEM();
118-
key.getPublicPEM();
117+
key.exportPrivate();
118+
key.exportPublic();
119119
```
120120

121121
### Properties
@@ -182,15 +182,19 @@ Questions, comments, bug reports, and pull requests are all welcome.
182182
## Changelog
183183

184184
### 0.2.0
185+
* **`.getPublicPEM()` method was renamed to `.exportPublic()`**
186+
* **`.getPrivatePEM()` method was renamed to `.exportPrivate()`**
187+
* **`.loadFromPEM()` method was renamed to `.importKey()`**
185188
* Added PKCS1_OAEP encrypting/decrypting support
186189
* **PKCS1_OAEP now default scheme, you need to specify 'encryptingScheme' option to 'pkcs1' for compatibility with 0.1.x version of NodeRSA**
187190
* Added PSS signing/verifying support
188191
* Signing now supports `'md5'`, `'ripemd160'`, `'sha1'`, `'sha256'`, `'sha512'` hash algorithms in both environments
189192
and additional `'md4'`, `'sha'`, `'sha224'`, `'sha384'` for nodejs env.
190-
* `options.signingAlgorithm` rename to `options.signingScheme`
193+
* **`options.signingAlgorithm` was renamed to `options.signingScheme`**
191194
* Added `encryptingScheme` option
192195
* Property `key.options` now mark as private. Added `key.setOptions(options)` method.
193196

197+
194198
### 0.1.54
195199
* Added support for loading PEM key from Buffer (`fs.readFileSync()` output)
196200
* Added `isEmpty()` method

‎src/NodeRSA.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ module.exports = (function () {
5353
this.$cache = {};
5454

5555
if (Buffer.isBuffer(key) || _.isString(key)) {
56-
this.loadFromPEM(key);
56+
this.importKey(key);
5757
} else if (_.isObject(key)) {
5858
this.generateKeyPair(key.b, key.e);
5959
}
@@ -150,7 +150,7 @@ module.exports = (function () {
150150
* Load key from PEM string
151151
* @param pem {string}
152152
*/
153-
NodeRSA.prototype.loadFromPEM = function (pem) {
153+
NodeRSA.prototype.importKey = function (pem) {
154154
if (Buffer.isBuffer(pem)) {
155155
pem = pem.toString('utf8');
156156
}
@@ -320,14 +320,14 @@ module.exports = (function () {
320320
return this.keyPair.verify(this.$getDataForEcrypt(buffer, source_encoding), signature, signature_encoding);
321321
};
322322

323-
NodeRSA.prototype.getPrivatePEM = function () {
323+
NodeRSA.prototype.exportPrivate = function () {
324324
if (!this.isPrivate()) {
325325
throw Error("It is not private key");
326326
}
327327
return this.$cache.privatePEM;
328328
};
329329

330-
NodeRSA.prototype.getPublicPEM = function () {
330+
NodeRSA.prototype.exportPublic = function () {
331331
if (!this.isPublic()) {
332332
throw Error("It is not public key");
333333
}

‎src/schemes/pkcs1.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ module.exports.makeScheme = function (key, options) {
115115
} else {
116116
var signer = crypt.createSign('RSA-' + hashAlgorithm.toUpperCase());
117117
signer.update(buffer);
118-
return signer.sign(this.options.rsaUtils.getPrivatePEM());
118+
return signer.sign(this.options.rsaUtils.exportPrivate());
119119
}
120120
};
121121

@@ -137,7 +137,7 @@ module.exports.makeScheme = function (key, options) {
137137
} else {
138138
var verifier = crypt.createVerify('RSA-' + hashAlgorithm.toUpperCase());
139139
verifier.update(buffer);
140-
return verifier.verify(this.options.rsaUtils.getPublicPEM(), signature, signature_encoding);
140+
return verifier.verify(this.options.rsaUtils.exportPublic(), signature, signature_encoding);
141141
}
142142
};
143143

‎test/tests.js

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -242,43 +242,46 @@ describe("NodeRSA", function(){
242242
assert(!publicNodeRSA.isPrivate());
243243
});
244244

245-
it(".getPrivatePEM() should return private PEM string", function(){
246-
assert.equal(privateNodeRSA.getPrivatePEM(), privateKeyPEM);
245+
it(".exportPrivate() should return private PEM string", function(){
246+
assert.equal(privateNodeRSA.exportPrivate(), privateKeyPEM);
247247
});
248248

249-
it(".getPublicPEM() from public key should return public PEM string", function(){
250-
assert.equal(publicNodeRSA.getPublicPEM(), publicKeyPEM);
249+
it(".exportPublic() from public key should return public PEM string", function(){
250+
assert.equal(publicNodeRSA.exportPublic(), publicKeyPEM);
251251
});
252252

253-
it(".getPublicPEM() from private key should return public PEM string", function(){
254-
assert.equal(privateNodeRSA.getPublicPEM(), publicKeyPEM);
253+
it(".exportPublic() from private key should return public PEM string", function(){
254+
assert.equal(privateNodeRSA.exportPublic(), publicKeyPEM);
255255
});
256256

257257
it("should create key from buffer/fs.readFileSync output", function(){
258258
var key = new NodeRSA(fs.readFileSync(fileKey));
259-
assert.equal(key.getPrivatePEM(), fileKeyPEM);
259+
assert.equal(key.exportPrivate(), fileKeyPEM);
260+
key = new NodeRSA();
261+
key.importKey(fs.readFileSync(fileKey));
262+
assert.equal(key.exportPrivate(), fileKeyPEM);
260263
});
261264

262265
it("should load PEM from buffer/fs.readFileSync output", function(){
263266
var key = new NodeRSA();
264267
assert.equal(key.isEmpty(), true);
265-
key.loadFromPEM(fs.readFileSync(fileKey));
268+
key.importKey(fs.readFileSync(fileKey));
266269
assert.equal(key.isEmpty(), false);
267-
assert.equal(key.getPrivatePEM(), fileKeyPEM);
270+
assert.equal(key.exportPrivate(), fileKeyPEM);
268271
});
269272
});
270273

271274
describe("Bad cases", function () {
272275
it("not public key", function(){
273276
var key = new NodeRSA();
274-
assert.throw(function(){ key.getPrivatePEM(); }, Error, "It is not private key");
275-
assert.throw(function(){ key.getPublicPEM(); }, Error, "It is not public key");
277+
assert.throw(function(){ key.exportPrivate(); }, Error, "It is not private key");
278+
assert.throw(function(){ key.exportPublic(); }, Error, "It is not public key");
276279
});
277280

278281
it("not private key", function(){
279282
var key = new NodeRSA(publicKeyPEM);
280-
assert.throw(function(){ key.getPrivatePEM(); }, Error, "It is not private key");
281-
assert.doesNotThrow(function(){ key.getPublicPEM(); }, Error, "It is not public key");
283+
assert.throw(function(){ key.exportPrivate(); }, Error, "It is not private key");
284+
assert.doesNotThrow(function(){ key.exportPublic(); }, Error, "It is not public key");
282285
});
283286
});
284287
});
@@ -352,7 +355,7 @@ describe("NodeRSA", function(){
352355
(function (i) {
353356
var suit = dataBundle[i];
354357
it("should sign " + i, function () {
355-
key = new NodeRSA(generatedKeys[generatedKeys.length - 1].getPrivatePEM(), {
358+
key = new NodeRSA(generatedKeys[generatedKeys.length - 1].exportPrivate(), {
356359
signingScheme: scheme + '-sha256',
357360
environment: env
358361
});
@@ -373,7 +376,7 @@ describe("NodeRSA", function(){
373376
for (var alg in signHashAlgorithms[env]) {
374377
(function (alg) {
375378
it("signing with custom algorithm (" + alg + ")", function () {
376-
var key = new NodeRSA(generatedKeys[generatedKeys.length - 1].getPrivatePEM(), {
379+
var key = new NodeRSA(generatedKeys[generatedKeys.length - 1].exportPrivate(), {
377380
signingScheme: scheme + '-' + alg,
378381
environment: env
379382
});
@@ -389,7 +392,7 @@ describe("NodeRSA", function(){
389392

390393
describe("Bad cases" + (envs.length > 1 ? " in " + env + " environment" : ""), function () {
391394
it("incorrect data for verifying", function () {
392-
var key = new NodeRSA(generatedKeys[0].getPrivatePEM(), {
395+
var key = new NodeRSA(generatedKeys[0].exportPrivate(), {
393396
signingScheme: scheme + '-sha256',
394397
environment: env
395398
});
@@ -398,7 +401,7 @@ describe("NodeRSA", function(){
398401
});
399402

400403
it("incorrect key for signing", function () {
401-
var key = new NodeRSA(generatedKeys[0].getPublicPEM(), {
404+
var key = new NodeRSA(generatedKeys[0].exportPublic(), {
402405
signingScheme: scheme + '-sha256',
403406
environment: env
404407
});
@@ -408,11 +411,11 @@ describe("NodeRSA", function(){
408411
});
409412

410413
it("incorrect key for verifying", function () {
411-
var key1 = new NodeRSA(generatedKeys[0].getPrivatePEM(), {
414+
var key1 = new NodeRSA(generatedKeys[0].exportPrivate(), {
412415
signingScheme: scheme + '-sha256',
413416
environment: env
414417
});
415-
var key2 = new NodeRSA(generatedKeys[1].getPublicPEM(), {
418+
var key2 = new NodeRSA(generatedKeys[1].exportPublic(), {
416419
signingScheme: scheme + '-sha256',
417420
environment: env
418421
});
@@ -429,11 +432,11 @@ describe("NodeRSA", function(){
429432
});
430433

431434
it("different algorithms", function () {
432-
var singKey = new NodeRSA(generatedKeys[0].getPrivatePEM(), {
435+
var singKey = new NodeRSA(generatedKeys[0].exportPrivate(), {
433436
signingScheme: scheme + '-md5',
434437
environment: env
435438
});
436-
var verifyKey = new NodeRSA(generatedKeys[0].getPrivatePEM(), {
439+
var verifyKey = new NodeRSA(generatedKeys[0].exportPrivate(), {
437440
signingScheme: scheme + '-sha1',
438441
environment: env
439442
});
@@ -452,11 +455,11 @@ describe("NodeRSA", function(){
452455
for (var alg in signHashAlgorithms['browser']) {
453456
(function (alg) {
454457
it("signing with custom algorithm (" + alg + ") (equal test)", function () {
455-
var nodeKey = new NodeRSA(generatedKeys[5].getPrivatePEM(), {
458+
var nodeKey = new NodeRSA(generatedKeys[5].exportPrivate(), {
456459
signingScheme: scheme + '-' + alg,
457460
environment: 'node'
458461
});
459-
var browserKey = new NodeRSA(generatedKeys[5].getPrivatePEM(), {
462+
var browserKey = new NodeRSA(generatedKeys[5].exportPrivate(), {
460463
signingScheme: scheme + '-' + alg,
461464
environment: 'browser'
462465
});
@@ -465,11 +468,11 @@ describe("NodeRSA", function(){
465468
});
466469

467470
it("sign in node & verify in browser (" + alg + ")", function () {
468-
var nodeKey = new NodeRSA(generatedKeys[5].getPrivatePEM(), {
471+
var nodeKey = new NodeRSA(generatedKeys[5].exportPrivate(), {
469472
signingScheme: scheme + '-' + alg,
470473
environment: 'node'
471474
});
472-
var browserKey = new NodeRSA(generatedKeys[5].getPrivatePEM(), {
475+
var browserKey = new NodeRSA(generatedKeys[5].exportPrivate(), {
473476
signingScheme: scheme + '-' + alg,
474477
environment: 'browser'
475478
});
@@ -478,11 +481,11 @@ describe("NodeRSA", function(){
478481
});
479482

480483
it("sign in browser & verify in node (" + alg + ")", function () {
481-
var nodeKey = new NodeRSA(generatedKeys[5].getPrivatePEM(), {
484+
var nodeKey = new NodeRSA(generatedKeys[5].exportPrivate(), {
482485
signingScheme: scheme + '-' + alg,
483486
environment: 'node'
484487
});
485-
var browserKey = new NodeRSA(generatedKeys[5].getPrivatePEM(), {
488+
var browserKey = new NodeRSA(generatedKeys[5].exportPrivate(), {
486489
signingScheme: scheme + '-' + alg,
487490
environment: 'browser'
488491
});

0 commit comments

Comments
 (0)