js: set expiry of generatedKey to seconds from now
[gpgme.git] / lang / js / src / Keyring.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
25 import { createMessage } from './Message';
26 import { createKey } from './Key';
27 import { isFingerprint } from './Helpers';
28 import { gpgme_error } from './Errors';
29
30 /**
31  * This class offers access to the gnupg keyring
32  */
33 export class GPGME_Keyring {
34
35     /**
36      * Queries Keys (all Keys or a subset) from gnupg.
37      *
38      * @param {String | Array<String>} pattern (optional) A pattern to
39      * search for in userIds or KeyIds.
40      * @param {Boolean} prepare_sync (optional) if set to true, most data
41      * (with the exception of armored Key blocks) will be cached for the
42      * Keys. This enables direct, synchronous use of these properties for
43      * all keys. It does not check for changes on the backend. The cached
44      * information can be updated with the {@link Key.refresh} method.
45      * @param {Boolean} search (optional) retrieve Keys from external
46      * servers with the method(s) defined in gnupg (e.g. WKD/HKP lookup)
47      * @returns {Promise<Array<GPGME_Key>>}
48      * @static
49      * @async
50      */
51     getKeys (pattern, prepare_sync=false, search=false){
52         return new Promise(function (resolve, reject) {
53             let msg = createMessage('keylist');
54             if (pattern !== undefined && pattern !== null){
55                 msg.setParameter('keys', pattern);
56             }
57             msg.setParameter('sigs', true);
58             if (search === true){
59                 msg.setParameter('locate', true);
60             }
61             msg.post().then(function (result){
62                 let resultset = [];
63                 if (result.keys.length === 0){
64                     resolve([]);
65                 } else {
66                     let secondrequest;
67                     if (prepare_sync === true) {
68                         secondrequest = function () {
69                             let msg2 = createMessage('keylist');
70                             msg2.setParameter('keys', pattern);
71                             msg2.setParameter('secret', true);
72                             return msg2.post();
73                         };
74                     } else {
75                         secondrequest = function () {
76                             return Promise.resolve(true);
77                         };
78                     }
79                     secondrequest().then(function (answer) {
80                         for (let i=0; i < result.keys.length; i++){
81                             if (prepare_sync === true){
82                                 if (answer && answer.keys) {
83                                     for (let j=0;
84                                         j < answer.keys.length; j++ ){
85                                         const a = answer.keys[j];
86                                         const b = result.keys[i];
87                                         if (
88                                             a.fingerprint === b.fingerprint
89                                         ) {
90                                             if (a.secret === true){
91                                                 b.hasSecret = true;
92                                             } else {
93                                                 b.hasSecret = false;
94                                             }
95                                             break;
96                                         }
97                                     }
98                                 }
99                             }
100                             let k = createKey(result.keys[i].fingerprint,
101                                 !prepare_sync, result.keys[i]);
102                             resultset.push(k);
103                         }
104                         resolve(resultset);
105                     }, function (error){
106                         reject(error);
107                     });
108                 }
109             });
110         });
111     }
112
113     /**
114      * @typedef {Object} exportResult The result of a getKeysArmored
115      * operation.
116      * @property {String} armored The public Key(s) as armored block. Note
117      * that the result is one armored block, and not a block per key.
118      * @property {Array<String>} secret_fprs (optional) list of
119      * fingerprints for those Keys that also have a secret Key available in
120      * gnupg. The secret key will not be exported, but the fingerprint can
121      * be used in operations needing a secret key.
122      */
123
124     /**
125      * Fetches the armored public Key blocks for all Keys matching the
126      * pattern (if no pattern is given, fetches all keys known to gnupg).
127      * @param {String|Array<String>} pattern (optional) The Pattern to
128      * search for
129      * @param {Boolean} with_secret_fpr (optional) also return a list of
130      * fingerprints for the keys that have a secret key available
131      * @returns {Promise<exportResult|GPGME_Error>} Object containing the
132      * armored Key(s) and additional information.
133      * @static
134      * @async
135      */
136     getKeysArmored (pattern, with_secret_fpr) {
137         return new Promise(function (resolve, reject) {
138             let msg = createMessage('export');
139             msg.setParameter('armor', true);
140             if (with_secret_fpr === true) {
141                 msg.setParameter('with-sec-fprs', true);
142             }
143             if (pattern !== undefined && pattern !== null){
144                 msg.setParameter('keys', pattern);
145             }
146             msg.post().then(function (answer){
147                 const result = { armored: answer.data };
148                 if (with_secret_fpr === true
149                     && answer.hasOwnProperty('sec-fprs')
150                 ) {
151                     result.secret_fprs = answer['sec-fprs'];
152                 }
153                 resolve(result);
154             }, function (error){
155                 reject(error);
156             });
157         });
158     }
159
160     /**
161      * Returns the Key used by default in gnupg.
162      * (a.k.a. 'primary Key or 'main key').
163      * It looks up the gpg configuration if set, or the first key that
164      * contains a secret key.
165      *
166      * @returns {Promise<GPGME_Key|GPGME_Error>}
167      * @async
168      * @static
169      */
170     getDefaultKey (prepare_sync = false) {
171         let me = this;
172         return new Promise(function (resolve, reject){
173             let msg = createMessage('config_opt');
174             msg.setParameter('component', 'gpg');
175             msg.setParameter('option', 'default-key');
176             msg.post().then(function (resp){
177                 if (resp.option !== undefined
178                     && resp.option.hasOwnProperty('value')
179                     && resp.option.value.length === 1
180                     && resp.option.value[0].hasOwnProperty('string')
181                     && typeof (resp.option.value[0].string) === 'string'){
182                     me.getKeys(resp.option.value[0].string, true).then(
183                         function (keys){
184                             if (keys.length === 1){
185                                 resolve(keys[0]);
186                             } else {
187                                 reject(gpgme_error('KEY_NO_DEFAULT'));
188                             }
189                         }, function (error){
190                             reject(error);
191                         });
192                 } else {
193                     let msg = createMessage('keylist');
194                     msg.setParameter('secret', true);
195                     msg.post().then(function (result){
196                         if (result.keys.length === 0){
197                             reject(gpgme_error('KEY_NO_DEFAULT'));
198                         } else {
199                             for (let i=0; i< result.keys.length; i++ ) {
200                                 if (result.keys[i].invalid === false) {
201                                     let k = createKey(
202                                         result.keys[i].fingerprint,
203                                         !prepare_sync,
204                                         result.keys[i]);
205                                     resolve(k);
206                                     break;
207                                 } else if (i === result.keys.length - 1){
208                                     reject(gpgme_error('KEY_NO_DEFAULT'));
209                                 }
210                             }
211                         }
212                     }, function (error){
213                         reject(error);
214                     });
215                 }
216             }, function (error){
217                 reject(error);
218             });
219         });
220     }
221
222     /**
223      * @typedef {Object} importResult The result of a Key update
224      * @property {Object} summary Numerical summary of the result. See the
225      * feedbackValues variable for available Keys values and the gnupg
226      * documentation.
227      * https://www.gnupg.org/documentation/manuals/gpgme/Importing-Keys.html
228      * for details on their meaning.
229      * @property {Array<importedKeyResult>} Keys Array of Object containing
230      * GPGME_Keys with additional import information
231      *
232      */
233
234     /**
235      * @typedef {Object} importedKeyResult
236      * @property {GPGME_Key} key The resulting key
237      * @property {String} status:
238      *  'nochange' if the Key was not changed,
239      *  'newkey' if the Key was imported in gpg, and did not exist
240      *    previously,
241      *  'change' if the key existed, but details were updated. For details,
242      *    Key.changes is available.
243      * @property {Boolean} changes.userId Changes in userIds
244      * @property {Boolean} changes.signature Changes in signatures
245      * @property {Boolean} changes.subkey Changes in subkeys
246      */
247
248     /**
249      * Import an armored Key block into gnupg. Note that this currently
250      * will not succeed on private Key blocks.
251      * @param {String} armored Armored Key block of the Key(s) to be
252      * imported into gnupg
253      * @param {Boolean} prepare_sync prepare the keys for synched use
254      * (see {@link getKeys}).
255      * @returns {Promise<importResult>} A summary and Keys considered.
256      * @async
257      * @static
258      */
259     importKey (armored, prepare_sync) {
260         let feedbackValues = ['considered', 'no_user_id', 'imported',
261             'imported_rsa', 'unchanged', 'new_user_ids', 'new_sub_keys',
262             'new_signatures', 'new_revocations', 'secret_read',
263             'secret_imported', 'secret_unchanged', 'skipped_new_keys',
264             'not_imported', 'skipped_v3_keys'];
265         if (!armored || typeof (armored) !== 'string'){
266             return Promise.reject(gpgme_error('PARAM_WRONG'));
267         }
268         let me = this;
269         return new Promise(function (resolve, reject){
270             let msg = createMessage('import');
271             msg.setParameter('data', armored);
272             msg.post().then(function (response){
273                 let infos = {};
274                 let fprs = [];
275                 let summary = {};
276                 for (let i=0; i < feedbackValues.length; i++ ){
277                     summary[feedbackValues[i]] =
278                         response.result[feedbackValues[i]];
279                 }
280                 if (!response.result.hasOwnProperty('imports') ||
281                     response.result.imports.length === 0
282                 ){
283                     resolve({ Keys:[],summary: summary });
284                     return;
285                 }
286                 for (let res=0; res<response.result.imports.length; res++){
287                     let result = response.result.imports[res];
288                     let status = '';
289                     if (result.status === 0){
290                         status = 'nochange';
291                     } else if ((result.status & 1) === 1){
292                         status = 'newkey';
293                     } else {
294                         status = 'change';
295                     }
296                     let changes = {};
297                     changes.userId = (result.status & 2) === 2;
298                     changes.signature = (result.status & 4) === 4;
299                     changes.subkey = (result.status & 8) === 8;
300                     // 16 new secret key: not implemented
301
302                     fprs.push(result.fingerprint);
303                     infos[result.fingerprint] = {
304                         changes: changes,
305                         status: status
306                     };
307                 }
308                 let resultset = [];
309                 if (prepare_sync === true){
310                     me.getKeys(fprs, true).then(function (result){
311                         for (let i=0; i < result.length; i++) {
312                             resultset.push({
313                                 key: result[i],
314                                 changes:
315                                     infos[result[i].fingerprint].changes,
316                                 status: infos[result[i].fingerprint].status
317                             });
318                         }
319                         resolve({ Keys:resultset,summary: summary });
320                     }, function (error){
321                         reject(error);
322                     });
323                 } else {
324                     for (let i=0; i < fprs.length; i++) {
325                         resultset.push({
326                             key: createKey(fprs[i]),
327                             changes: infos[fprs[i]].changes,
328                             status: infos[fprs[i]].status
329                         });
330                     }
331                     resolve({ Keys:resultset,summary:summary });
332                 }
333
334             }, function (error){
335                 reject(error);
336             });
337
338
339         });
340
341
342     }
343
344     /**
345      * Convenience function for deleting a Key. See {@link Key.delete} for
346      * further information about the return values.
347      * @param {String} fingerprint
348      * @returns {Promise<Boolean|GPGME_Error>}
349      * @async
350      * @static
351      */
352     deleteKey (fingerprint){
353         if (isFingerprint(fingerprint) === true) {
354             let key = createKey(fingerprint);
355             return key.delete();
356         } else {
357             return Promise.reject(gpgme_error('KEY_INVALID'));
358         }
359     }
360
361     /**
362      * Generates a new Key pair directly in gpg, and returns a GPGME_Key
363      * representing that Key. Please note that due to security concerns,
364      * secret Keys can not be deleted or exported from inside gpgme.js.
365      *
366      * @param {String} userId The user Id, e.g. 'Foo Bar <foo@bar.baz>'
367      * @param {String} algo (optional) algorithm (and optionally key size)
368      * to be used. See {@link supportedKeyAlgos} below for supported
369      * values. If ommitted, 'default' is used.
370      * @param {Number} expires (optional) Expiration time in seconds from now.
371      * If not set or set to 0, expiration will be 'never'
372      * @param {String} subkey_algo (optional) algorithm of the encryption
373      * subkey. If ommited the same as algo is used.
374      *
375      * @return {Promise<Key|GPGME_Error>}
376      * @async
377      */
378     generateKey (userId, algo = 'default', expires, subkey_algo){
379         if (
380             typeof (userId) !== 'string' ||
381             // eslint-disable-next-line no-use-before-define
382             supportedKeyAlgos.indexOf(algo) < 0 ||
383             (expires && !( Number.isInteger(expires) || expires < 0 ))
384         ){
385             return Promise.reject(gpgme_error('PARAM_WRONG'));
386         }
387         // eslint-disable-next-line no-use-before-define
388         if (subkey_algo && supportedKeyAlgos.indexOf(subkey_algo) < 0 ){
389             return Promise.reject(gpgme_error('PARAM_WRONG'));
390         }
391         let me = this;
392         return new Promise(function (resolve, reject){
393             let msg = createMessage('createkey');
394             msg.setParameter('userid', userId);
395             msg.setParameter('algo', algo );
396             if (subkey_algo) {
397                 msg.setParameter('subkey-algo', subkey_algo );
398             }
399             if (expires){
400                 msg.setParameter('expires', expires);
401             } else {
402                 msg.setParameter('expires', 0);
403             }
404             msg.post().then(function (response){
405                 me.getKeys(response.fingerprint, true).then(
406                     // TODO prepare_sync?
407                     function (result){
408                         resolve(result);
409                     }, function (error){
410                         reject(error);
411                     });
412             }, function (error) {
413                 reject(error);
414             });
415         });
416     }
417 }
418
419
420 /**
421  * List of algorithms supported for key generation. Please refer to the gnupg
422  * documentation for details
423  */
424 const supportedKeyAlgos = [
425     'default',
426     'rsa', 'rsa2048', 'rsa3072', 'rsa4096',
427     'dsa', 'dsa2048', 'dsa3072', 'dsa4096',
428     'elg', 'elg2048', 'elg3072', 'elg4096',
429     'ed25519',
430     'cv25519',
431     'brainpoolP256r1', 'brainpoolP384r1', 'brainpoolP512r1',
432     'NIST P-256', 'NIST P-384', 'NIST P-521'
433 ];