js: getDefaultKey and GenerateKey improvements
[gpgme.git] / lang / js / src / Key.js
1 /* gpgme.js - Javascript integration for gpgme
2  * Copyright (C) 2018 Bundesamt für Sicherheit in der Informationstechnik
3  *
4  * This file is part of GPGME.
5  *
6  * GPGME is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * GPGME is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  * SPDX-License-Identifier: LGPL-2.1+
19  *
20  * Author(s):
21  *     Maximilian Krambach <mkrambach@intevation.de>
22  */
23
24 import { isFingerprint, isLongId } from './Helpers';
25 import { gpgme_error } from './Errors';
26 import { createMessage } from './Message';
27
28 /**
29  * Validates the fingerprint.
30  * @param {String} fingerprint
31  */
32 export function createKey(fingerprint){
33     if (!isFingerprint(fingerprint)){
34         return gpgme_error('PARAM_WRONG');
35     }
36     else return new GPGME_Key(fingerprint);
37 }
38
39 /**
40  * Representing the Keys as stored in GPG
41  * It allows to query almost all information defined in gpgme Key Objects
42  * Refer to validKeyProperties for available information, and the gpgme
43  * documentation on their meaning
44  * (https://www.gnupg.org/documentation/manuals/gpgme/Key-objects.html)
45  *
46  */
47 export class GPGME_Key {
48
49     constructor(fingerprint){
50         this.fingerprint = fingerprint;
51     }
52
53     set fingerprint(fpr){
54         if (isFingerprint(fpr) === true) {
55             if (this._data === undefined) {
56                 this._data = {fingerprint:  fpr};
57             } else {
58                 if (this._data.fingerprint === undefined){
59                     this._data.fingerprint = fpr;
60                 }
61             }
62         }
63     }
64
65     get fingerprint(){
66         if (!this._data || !this._data.fingerprint){
67             return gpgme_error('KEY_INVALID');
68         }
69         return this._data.fingerprint;
70     }
71
72     /**
73      *
74      * @param {Object} data Bulk set data for this key, with the Object as sent
75      * by gpgme-json.
76      * @returns {GPGME_Key|GPGME_Error} The Key object itself after values have
77      * been set
78      */
79     setKeyData(data){
80         if (this._data === undefined) {
81             this._data = {};
82         }
83         if (
84             typeof(data) !== 'object') {
85             return gpgme_error('KEY_INVALID');
86         }
87         if (!this._data.fingerprint && isFingerprint(data.fingerprint)){
88             if (data.fingerprint !== this.fingerprint){
89                 return gpgme_error('KEY_INVALID');
90             }
91             this._data.fingerprint = data.fingerprint;
92         } else if (this._data.fingerprint !== data.fingerprint){
93             return gpgme_error('KEY_INVALID');
94         }
95         let dataKeys = Object.keys(data);
96         for (let i=0; i< dataKeys.length; i++){
97             if (!validKeyProperties.hasOwnProperty(dataKeys[i])){
98                 return gpgme_error('KEY_INVALID');
99             }
100             if (validKeyProperties[dataKeys[i]](data[dataKeys[i]]) !== true ){
101                 return gpgme_error('KEY_INVALID');
102             }
103             switch (dataKeys[i]){
104             case 'subkeys':
105                 this._data.subkeys = [];
106                 for (let i=0; i< data.subkeys.length; i++) {
107                     this._data.subkeys.push(
108                         new GPGME_Subkey(data.subkeys[i]));
109                 }
110                 break;
111             case 'userids':
112                 this._data.userids = [];
113                 for (let i=0; i< data.userids.length; i++) {
114                     this._data.userids.push(
115                         new GPGME_UserId(data.userids[i]));
116                 }
117                 break;
118             case 'last_update':
119                 this._data[dataKeys[i]] = new Date( data[dataKeys[i]] * 1000 );
120                 break;
121             default:
122                 this._data[dataKeys[i]] = data[dataKeys[i]];
123             }
124         }
125         return this;
126     }
127
128     /**
129      * Query any property of the Key list
130      * @param {String} property Key property to be retreived
131      * @param {*} cached (optional) if false, the data will be directly queried
132      * from gnupg.
133      *  @returns {*|Promise<*>} the value, or if not cached, a Promise
134      * resolving on the value
135      */
136     get(property, cached=true) {
137         if (cached === false) {
138             let me = this;
139             return new Promise(function(resolve, reject) {
140                 if (!validKeyProperties.hasOwnProperty(property)){
141                     reject('PARAM_WRONG');
142                 } else if (property === 'armored'){
143                     resolve(me.getArmor());
144                 } else if (property === 'hasSecret'){
145                     resolve(me.getHasSecret());
146                 } else {
147                     me.refreshKey().then(function(key){
148                         resolve(key.get(property, true));
149                     }, function(error){
150                         reject(error);
151                     });
152                 }
153             });
154         } else {
155             if (!validKeyProperties.hasOwnProperty(property)){
156                 return gpgme_error('PARAM_WRONG');
157             }
158             if (!this._data.hasOwnProperty(property)){
159                 return gpgme_error('KEY_NO_INIT');
160             } else {
161                 return (this._data[property]);
162             }
163         }
164     }
165
166     /**
167      * Reloads the Key from gnupg
168      */
169     refreshKey() {
170         let me = this;
171         return new Promise(function(resolve, reject) {
172             if (!me._data.fingerprint){
173                 reject(gpgme_error('KEY_INVALID'));
174             }
175             let msg = createMessage('keylist');
176             msg.setParameter('sigs', true);
177             msg.setParameter('keys', me._data.fingerprint);
178             msg.post().then(function(result){
179                 if (result.keys.length === 1){
180                     me.setKeyData(result.keys[0]);
181                     resolve(me);
182                 } else {
183                     reject(gpgme_error('KEY_NOKEY'));
184                 }
185             }, function (error) {
186                 reject(gpgme_error('GNUPG_ERROR'), error);
187             });
188         });
189     }
190
191     /**
192      * Query the armored block of the non- secret parts of the Key directly
193      * from gpg.
194      * @returns {Promise<String>}
195      * @async
196      */
197     getArmor(){
198         let me = this;
199         return new Promise(function(resolve, reject) {
200             if (!me._data.fingerprint){
201                 reject(gpgme_error('KEY_INVALID'));
202             }
203             let msg = createMessage('export');
204             msg.setParameter('armor', true);
205             msg.setParameter('keys', me._data.fingerprint);
206             msg.post().then(function(result){
207                 me._data.armored = result.data;
208                 resolve(result.data);
209             }, function(error){
210                 reject(error);
211             });
212         });
213     }
214
215     /**
216      * Find out if the Key includes a secret part
217      * @returns {Promise<Boolean>}
218      *
219      * @async
220      */
221     getHasSecret(){
222         let me = this;
223         return new Promise(function(resolve, reject) {
224             if (!me._data.fingerprint){
225                 reject(gpgme_error('KEY_INVALID'));
226             }
227             let msg = createMessage('keylist');
228             msg.setParameter('keys', me._data.fingerprint);
229             msg.setParameter('secret', true);
230             msg.post().then(function(result){
231                 me._data.hasSecret = null;
232                 if (
233                     result.keys &&
234                     result.keys.length === 1 &&
235                     result.keys[0].secret === true
236                 ) {
237                     me._data.hasSecret = true;
238                     resolve(true);
239                 } else {
240                     me._data.hasSecret = false;
241                     resolve(false);
242                 }
243             }, function(error){
244                 reject(error);
245             });
246         });
247     }
248
249     /**
250      * Convenience functions to be directly used as properties of the Key
251      * Notice that these rely on cached info and may be outdated. Use the async
252      * get(property, false) if you need the most current info
253      */
254
255     /**
256      * @returns {String} The armored public Key block
257      */
258     get armored(){
259         return this.get('armored', true);
260     }
261
262     /**
263      * @returns {Boolean} If the key is considered a "private Key",
264      * i.e. owns a secret subkey.
265      */
266     get hasSecret(){
267         return this.get('hasSecret', true);
268     }
269
270     /**
271      * Deletes the public Key from the GPG Keyring. Note that a deletion of a
272      * secret key is not supported by the native backend.
273      * @returns {Promise<Boolean>} Success if key was deleted, rejects with a
274      * GPG error otherwise
275      */
276     delete(){
277         let me = this;
278         return new Promise(function(resolve, reject){
279             if (!me._data.fingerprint){
280                 reject(gpgme_error('KEY_INVALID'));
281             }
282             let msg = createMessage('delete');
283             msg.setParameter('key', me._data.fingerprint);
284             msg.post().then(function(result){
285                 resolve(result.success);
286             }, function(error){
287                 reject(error);
288             });
289         });
290     }
291 }
292
293 /**
294  * The subkeys of a Key. Currently, they cannot be refreshed separately
295  */
296 class GPGME_Subkey {
297
298     constructor(data){
299         let keys = Object.keys(data);
300         for (let i=0; i< keys.length; i++) {
301             this.setProperty(keys[i], data[keys[i]]);
302         }
303     }
304
305     setProperty(property, value){
306         if (!this._data){
307             this._data = {};
308         }
309         if (validSubKeyProperties.hasOwnProperty(property)){
310             if (validSubKeyProperties[property](value) === true) {
311                 if (property === 'timestamp' || property === 'expires'){
312                     this._data[property] = new Date(value * 1000);
313                 } else {
314                     this._data[property] = value;
315                 }
316             }
317         }
318     }
319
320     /**
321      *
322      * @param {String} property Information to request
323      * @returns {String | Number}
324      * TODO: date properties are numbers with Date in seconds
325      */
326     get(property) {
327         if (this._data.hasOwnProperty(property)){
328             return (this._data[property]);
329         }
330     }
331 }
332
333 class GPGME_UserId {
334
335     constructor(data){
336         let keys = Object.keys(data);
337         for (let i=0; i< keys.length; i++) {
338             this.setProperty(keys[i], data[keys[i]]);
339         }
340     }
341
342     setProperty(property, value){
343         if (!this._data){
344             this._data = {};
345         }
346         if (validUserIdProperties.hasOwnProperty(property)){
347             if (validUserIdProperties[property](value) === true) {
348                 if (property === 'last_update'){
349                     this._data[property] = new Date(value*1000);
350                 } else {
351                     this._data[property] = value;
352                 }
353             }
354         }
355
356     }
357
358     /**
359      *
360      * @param {String} property Information to request
361      * @returns {String | Number}
362      * TODO: date properties are numbers with Date in seconds
363      */
364     get(property) {
365         if (this._data.hasOwnProperty(property)){
366             return (this._data[property]);
367         }
368     }
369 }
370
371 const validUserIdProperties = {
372     'revoked': function(value){
373         return typeof(value) === 'boolean';
374     },
375     'invalid':  function(value){
376         return typeof(value) === 'boolean';
377     },
378     'uid': function(value){
379         if (typeof(value) === 'string' || value === ''){
380             return true;
381         }
382         return false;
383     },
384     'validity': function(value){
385         if (typeof(value) === 'string'){
386             return true;
387         }
388         return false;
389     },
390     'name': function(value){
391         if (typeof(value) === 'string' || value === ''){
392             return true;
393         }
394         return false;
395     },
396     'email': function(value){
397         if (typeof(value) === 'string' || value === ''){
398             return true;
399         }
400         return false;
401     },
402     'address': function(value){
403         if (typeof(value) === 'string' || value === ''){
404             return true;
405         }
406         return false;
407     },
408     'comment': function(value){
409         if (typeof(value) === 'string' || value === ''){
410             return true;
411         }
412         return false;
413     },
414     'origin':  function(value){
415         return Number.isInteger(value);
416     },
417     'last_update':  function(value){
418         return Number.isInteger(value);
419     }
420 };
421
422 const validSubKeyProperties = {
423     'invalid': function(value){
424         return typeof(value) === 'boolean';
425     },
426     'can_encrypt': function(value){
427         return typeof(value) === 'boolean';
428     },
429     'can_sign': function(value){
430         return typeof(value) === 'boolean';
431     },
432     'can_certify':  function(value){
433         return typeof(value) === 'boolean';
434     },
435     'can_authenticate':  function(value){
436         return typeof(value) === 'boolean';
437     },
438     'secret': function(value){
439         return typeof(value) === 'boolean';
440     },
441     'is_qualified': function(value){
442         return typeof(value) === 'boolean';
443     },
444     'is_cardkey':  function(value){
445         return typeof(value) === 'boolean';
446     },
447     'is_de_vs':  function(value){
448         return typeof(value) === 'boolean';
449     },
450     'pubkey_algo_name': function(value){
451         return typeof(value) === 'string';
452         // TODO: check against list of known?['']
453     },
454     'pubkey_algo_string': function(value){
455         return typeof(value) === 'string';
456         // TODO: check against list of known?['']
457     },
458     'keyid': function(value){
459         return isLongId(value);
460     },
461     'pubkey_algo': function(value) {
462         return (Number.isInteger(value) && value >= 0);
463     },
464     'length': function(value){
465         return (Number.isInteger(value) && value > 0);
466     },
467     'timestamp': function(value){
468         return (Number.isInteger(value) && value > 0);
469     },
470     'expires': function(value){
471         return (Number.isInteger(value) && value > 0);
472     }
473 };
474 const validKeyProperties = {
475     //TODO better validation?
476     'fingerprint': function(value){
477         return isFingerprint(value);
478     },
479     'armored': function(value){
480         return typeof(value === 'string');
481     },
482     'revoked': function(value){
483         return typeof(value) === 'boolean';
484     },
485     'expired': function(value){
486         return typeof(value) === 'boolean';
487     },
488     'disabled': function(value){
489         return typeof(value) === 'boolean';
490     },
491     'invalid': function(value){
492         return typeof(value) === 'boolean';
493     },
494     'can_encrypt': function(value){
495         return typeof(value) === 'boolean';
496     },
497     'can_sign': function(value){
498         return typeof(value) === 'boolean';
499     },
500     'can_certify': function(value){
501         return typeof(value) === 'boolean';
502     },
503     'can_authenticate': function(value){
504         return typeof(value) === 'boolean';
505     },
506     'secret': function(value){
507         return typeof(value) === 'boolean';
508     },
509     'is_qualified': function(value){
510         return typeof(value) === 'boolean';
511     },
512     'protocol': function(value){
513         return typeof(value) === 'string';
514         //TODO check for implemented ones
515     },
516     'issuer_serial': function(value){
517         return typeof(value) === 'string';
518     },
519     'issuer_name': function(value){
520         return typeof(value) === 'string';
521     },
522     'chain_id': function(value){
523         return typeof(value) === 'string';
524     },
525     'owner_trust': function(value){
526         return typeof(value) === 'string';
527     },
528     'last_update': function(value){
529         return (Number.isInteger(value));
530         //TODO undefined/null possible?
531     },
532     'origin': function(value){
533         return (Number.isInteger(value));
534     },
535     'subkeys': function(value){
536         return (Array.isArray(value));
537     },
538     'userids': function(value){
539         return (Array.isArray(value));
540     },
541     'tofu': function(value){
542         return (Array.isArray(value));
543     },
544     'hasSecret': function(value){
545         return typeof(value) === 'boolean';
546     }
547
548 };