suzanne.soy/fork-openpgpjs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: clarify Key.clone() behaviour (#1589)

Browse Source
This commit is contained in:
larabr 2023-02-09 23:07:27 +01:00 committed by GitHub
parent 50ea1ac889
commit 9175b76887
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/key/key.js
View File

@ -170,13 +170,13 @@ class Key {
} }
/** /**
* Clones the key object * Clones the key object. The copy is shallow, as it references the same packet objects as the original. However, if the top-level API is used, the two key instances are effectively independent.
* @param {Boolean} [deep=false] Whether to return a deep clone * @param {Boolean} [clonePrivateParams=false] Only relevant for private keys: whether the secret key paramenters should be deeply copied. This is needed if e.g. `encrypt()` is to be called either on the clone or the original key.
* @returns {Promise<Key>} Clone of the key. * @returns {Promise<Key>} Clone of the key.
*/ */
clone(deep = false) { clone(clonePrivateParams = false) {
const key = new this.constructor(this.toPacketList()); const key = new this.constructor(this.toPacketList());
if (deep) { if (clonePrivateParams) {
key.getKeys().forEach(k => { key.getKeys().forEach(k => {
// shallow clone the key packets // shallow clone the key packets
k.keyPacket = Object.create( k.keyPacket = Object.create(

20
test/general/key.js
View File

@ -3236,6 +3236,26 @@ module.exports = () => describe('Key', function() {
}); });
}); });
it('clone() - removing users or their signatures does not affect the original key', async function() {
const key = await openpgp.readKey({ armoredKey: priv_key_rsa });
const keyClone = key.clone();
expect(key.users[0].selfCertifications.length > 0).to.be.true;
expect(keyClone.users[0].selfCertifications.length > 0).to.be.true;
keyClone.users[0].selfCertifications = [];
expect(key.users[0].selfCertifications.length > 0).to.be.true;
expect(keyClone.users[0].selfCertifications.length > 0).to.be.false;
});
it('clone() - removing subkeys or their signatures does not affect the original key', async function() {
const key = await openpgp.readKey({ armoredKey: priv_key_rsa });
const keyClone = key.clone(true);
expect(key.subkeys[0].bindingSignatures.length > 0).to.be.true;
expect(keyClone.subkeys[0].bindingSignatures.length > 0).to.be.true;
keyClone.subkeys[0].bindingSignatures = [];
expect(key.subkeys[0].bindingSignatures.length > 0).to.be.true;
expect(keyClone.subkeys[0].bindingSignatures.length > 0).to.be.false;
});
it('revoke() - primary key', async function() { it('revoke() - primary key', async function() {
const privKey = await openpgp.decryptKey({ const privKey = await openpgp.decryptKey({
privateKey: await openpgp.readKey({ armoredKey: priv_key_arm2 }), privateKey: await openpgp.readKey({ armoredKey: priv_key_arm2 }),