js: getDefaultKey and verify fix
[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     // TODO: Does not work yet, result is always false
222     getHasSecret(){
223         let me = this;
224         return new Promise(function(resolve, reject) {
225             if (!me._data.fingerprint){
226                 reject(gpgme_error('KEY_INVALID'));
227             }
228             let msg = createMessage('keylist');
229             msg.setParameter('keys', me._data.fingerprint);
230             msg.setParameter('secret', true);
231             msg.post().then(function(result){
232                 me._data.hasSecret = null;
233                 if (result.keys === undefined || result.keys.length < 1) {
234                     me._data.hasSecret = false;
235                     resolve(false);
236                 }
237                 else if (result.keys.length === 1){
238                     let key = result.keys[0];
239                     if (!key.subkeys){
240                         me._data.hasSecret = false;
241                         resolve(false);
242                     } else {
243                         for (let i=0; i < key.subkeys.length; i++) {
244                             if (key.subkeys[i].secret === true) {
245                                 me._data.hasSecret = true;
246                                 resolve(true);
247                                 break;
248                             }
249                             if (i === (key.subkeys.length -1)) {
250                                 me._data.hasSecret = false;
251                                 resolve(false);
252                             }
253                         }
254                     }
255                 } else {
256                     reject(gpgme_error('CONN_UNEXPECTED_ANSWER'));
257                 }
258             }, function(error){
259                 reject(error);
260             });
261         });
262     }
263
264     /**
265      * Convenience functions to be directly used as properties of the Key
266      * Notice that these rely on cached info and may be outdated. Use the async
267      * get(property, false) if you need the most current info
268      */
269
270     /**
271      * @returns {String} The armored public Key block
272      */
273     get armored(){
274         return this.get('armored', true);
275     }
276
277     /**
278      * @returns {Boolean} If the key is considered a "private Key",
279      * i.e. owns a secret subkey.
280      */
281     get hasSecret(){
282         return this.get('hasSecret', true);
283     }
284
285     /**
286      * Deletes the public Key from the GPG Keyring. Note that a deletion of a
287      * secret key is not supported by the native backend.
288      * @returns {Promise<Boolean>} Success if key was deleted, rejects with a
289      * GPG error otherwise
290      */
291     delete(){
292         let me = this;
293         return new Promise(function(resolve, reject){
294             if (!me._data.fingerprint){
295                 reject(gpgme_error('KEY_INVALID'));
296             }
297             let msg = createMessage('delete');
298             msg.setParameter('key', me._data.fingerprint);
299             msg.post().then(function(result){
300                 resolve(result.success);
301             }, function(error){
302                 reject(error);
303             });
304         });
305     }
306 }
307
308 /**
309  * The subkeys of a Key. Currently, they cannot be refreshed separately
310  */
311 class GPGME_Subkey {
312
313     constructor(data){
314         let keys = Object.keys(data);
315         for (let i=0; i< keys.length; i++) {
316             this.setProperty(keys[i], data[keys[i]]);
317         }
318     }
319
320     setProperty(property, value){
321         if (!this._data){
322             this._data = {};
323         }
324         if (validSubKeyProperties.hasOwnProperty(property)){
325             if (validSubKeyProperties[property](value) === true) {
326                 if (property === 'timestamp' || property === 'expires'){
327                     this._data[property] = new Date(value * 1000);
328                 } else {
329                     this._data[property] = value;
330                 }
331             }
332         }
333     }
334
335     /**
336      *
337      * @param {String} property Information to request
338      * @returns {String | Number}
339      * TODO: date properties are numbers with Date in seconds
340      */
341     get(property) {
342         if (this._data.hasOwnProperty(property)){
343             return (this._data[property]);
344         }
345     }
346 }
347
348 class GPGME_UserId {
349
350     constructor(data){
351         let keys = Object.keys(data);
352         for (let i=0; i< keys.length; i++) {
353             this.setProperty(keys[i], data[keys[i]]);
354         }
355     }
356
357     setProperty(property, value){
358         if (!this._data){
359             this._data = {};
360         }
361         if (validUserIdProperties.hasOwnProperty(property)){
362             if (validUserIdProperties[property](value) === true) {
363                 if (property === 'last_update'){
364                     this._data[property] = new Date(value*1000);
365                 } else {
366                     this._data[property] = value;
367                 }
368             }
369         }
370
371     }
372
373     /**
374      *
375      * @param {String} property Information to request
376      * @returns {String | Number}
377      * TODO: date properties are numbers with Date in seconds
378      */
379     get(property) {
380         if (this._data.hasOwnProperty(property)){
381             return (this._data[property]);
382         }
383     }
384 }
385
386 const validUserIdProperties = {
387     'revoked': function(value){
388         return typeof(value) === 'boolean';
389     },
390     'invalid':  function(value){
391         return typeof(value) === 'boolean';
392     },
393     'uid': function(value){
394         if (typeof(value) === 'string' || value === ''){
395             return true;
396         }
397         return false;
398     },
399     'validity': function(value){
400         if (typeof(value) === 'string'){
401             return true;
402         }
403         return false;
404     },
405     'name': function(value){
406         if (typeof(value) === 'string' || value === ''){
407             return true;
408         }
409         return false;
410     },
411     'email': function(value){
412         if (typeof(value) === 'string' || value === ''){
413             return true;
414         }
415         return false;
416     },
417     'address': function(value){
418         if (typeof(value) === 'string' || value === ''){
419             return true;
420         }
421         return false;
422     },
423     'comment': function(value){
424         if (typeof(value) === 'string' || value === ''){
425             return true;
426         }
427         return false;
428     },
429     'origin':  function(value){
430         return Number.isInteger(value);
431     },
432     'last_update':  function(value){
433         return Number.isInteger(value);
434     }
435 };
436
437 const validSubKeyProperties = {
438     'invalid': function(value){
439         return typeof(value) === 'boolean';
440     },
441     'can_encrypt': function(value){
442         return typeof(value) === 'boolean';
443     },
444     'can_sign': function(value){
445         return typeof(value) === 'boolean';
446     },
447     'can_certify':  function(value){
448         return typeof(value) === 'boolean';
449     },
450     'can_authenticate':  function(value){
451         return typeof(value) === 'boolean';
452     },
453     'secret': function(value){
454         return typeof(value) === 'boolean';
455     },
456     'is_qualified': function(value){
457         return typeof(value) === 'boolean';
458     },
459     'is_cardkey':  function(value){
460         return typeof(value) === 'boolean';
461     },
462     'is_de_vs':  function(value){
463         return typeof(value) === 'boolean';
464     },
465     'pubkey_algo_name': function(value){
466         return typeof(value) === 'string';
467         // TODO: check against list of known?['']
468     },
469     'pubkey_algo_string': function(value){
470         return typeof(value) === 'string';
471         // TODO: check against list of known?['']
472     },
473     'keyid': function(value){
474         return isLongId(value);
475     },
476     'pubkey_algo': function(value) {
477         return (Number.isInteger(value) && value >= 0);
478     },
479     'length': function(value){
480         return (Number.isInteger(value) && value > 0);
481     },
482     'timestamp': function(value){
483         return (Number.isInteger(value) && value > 0);
484     },
485     'expires': function(value){
486         return (Number.isInteger(value) && value > 0);
487     }
488 };
489 const validKeyProperties = {
490     //TODO better validation?
491     'fingerprint': function(value){
492         return isFingerprint(value);
493     },
494     'armored': function(value){
495         return typeof(value === 'string');
496     },
497     'revoked': function(value){
498         return typeof(value) === 'boolean';
499     },
500     'expired': function(value){
501         return typeof(value) === 'boolean';
502     },
503     'disabled': function(value){
504         return typeof(value) === 'boolean';
505     },
506     'invalid': function(value){
507         return typeof(value) === 'boolean';
508     },
509     'can_encrypt': function(value){
510         return typeof(value) === 'boolean';
511     },
512     'can_sign': function(value){
513         return typeof(value) === 'boolean';
514     },
515     'can_certify': function(value){
516         return typeof(value) === 'boolean';
517     },
518     'can_authenticate': function(value){
519         return typeof(value) === 'boolean';
520     },
521     'secret': function(value){
522         return typeof(value) === 'boolean';
523     },
524     'is_qualified': function(value){
525         return typeof(value) === 'boolean';
526     },
527     'protocol': function(value){
528         return typeof(value) === 'string';
529         //TODO check for implemented ones
530     },
531     'issuer_serial': function(value){
532         return typeof(value) === 'string';
533     },
534     'issuer_name': function(value){
535         return typeof(value) === 'string';
536     },
537     'chain_id': function(value){
538         return typeof(value) === 'string';
539     },
540     'owner_trust': function(value){
541         return typeof(value) === 'string';
542     },
543     'last_update': function(value){
544         return (Number.isInteger(value));
545         //TODO undefined/null possible?
546     },
547     'origin': function(value){
548         return (Number.isInteger(value));
549     },
550     'subkeys': function(value){
551         return (Array.isArray(value));
552     },
553     'userids': function(value){
554         return (Array.isArray(value));
555     },
556     'tofu': function(value){
557         return (Array.isArray(value));
558     },
559     'hasSecret': function(value){
560         return typeof(value) === 'boolean';
561     }
562
563 };