js: Error handling for browser errors
[gpgme.git] / lang / js / src / Signature.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 <https://www.gnu.org/licenses/>.
18  * SPDX-License-Identifier: LGPL-2.1+
19  *
20  * Author(s):
21  *     Maximilian Krambach <mkrambach@intevation.de>
22  */
23 import { gpgme_error } from './Errors';
24
25 /**
26  * Validates an object containing a signature, as sent by the nativeMessaging
27  * interface
28  * @param {Object} sigObject Object as returned by gpgme-json. The definition
29  * of the expected values are to be found in {@link expKeys}, {@link expSum},
30  * {@link expNote}.
31  * @returns {GPGME_Signature|GPGME_Error} Signature Object
32  * @private
33  */
34 export function createSignature (sigObject){
35     if (
36         typeof (sigObject) !=='object' ||
37         !sigObject.hasOwnProperty('summary') ||
38         !sigObject.hasOwnProperty('fingerprint') ||
39         !sigObject.hasOwnProperty('timestamp')
40         // TODO check if timestamp is mandatory in specification
41     ){
42         return gpgme_error('SIG_WRONG');
43     }
44     let keys = Object.keys(sigObject);
45     for (let i=0; i< keys.length; i++){
46         // eslint-disable-next-line no-use-before-define
47         if ( typeof (sigObject[keys[i]]) !== expKeys[keys[i]] ){
48             return gpgme_error('SIG_WRONG');
49         }
50     }
51     let sumkeys = Object.keys(sigObject.summary);
52     for (let i=0; i< sumkeys.length; i++){
53         // eslint-disable-next-line no-use-before-define
54         if ( typeof (sigObject.summary[sumkeys[i]]) !== expSum[sumkeys[i]] ){
55             return gpgme_error('SIG_WRONG');
56         }
57     }
58     if (sigObject.hasOwnProperty('notations')){
59         if (!Array.isArray(sigObject.notations)){
60             return gpgme_error('SIG_WRONG');
61         }
62         for (let i=0; i < sigObject.notations.length; i++){
63             let notation = sigObject.notations[i];
64             let notekeys = Object.keys(notation);
65             for (let j=0; j < notekeys.length; j++){
66                 // eslint-disable-next-line no-use-before-define
67                 if ( typeof (notation[notekeys[j]]) !== expNote[notekeys[j]] ){
68                     return gpgme_error('SIG_WRONG');
69                 }
70             }
71         }
72     }
73     return new GPGME_Signature(sigObject);
74 }
75
76
77 /**
78  * Representing the details of a signature. The full details as given by
79  * gpgme-json can be read from the _rawSigObject.
80  *
81  * Note to reviewers: This class should be read only except via
82  * {@link createSignature}
83  * @protected
84  * @class
85  */
86 class GPGME_Signature {
87
88     constructor (sigObject){
89         this._rawSigObject = sigObject;
90     }
91     /**
92      * @returns {String} the fingerprint of this signature
93      */
94     get fingerprint (){
95         if (!this._rawSigObject.fingerprint){
96             throw gpgme_error('SIG_WRONG');
97         } else {
98             return this._rawSigObject.fingerprint;
99         }
100     }
101
102     /**
103      * The expiration of this Signature as Javascript date, or null if
104      * signature does not expire
105      * @returns {Date | null}
106      */
107     get expiration (){
108         if (!this._rawSigObject.exp_timestamp){
109             return null;
110         }
111         return new Date(this._rawSigObject.exp_timestamp* 1000);
112     }
113
114     /**
115      * The creation date of this Signature in Javascript Date
116      * @returns {Date}
117      */
118     get timestamp (){
119         return new Date(this._rawSigObject.timestamp * 1000);
120     }
121
122     /**
123      * The overall validity of the key. If false, errorDetails may contain
124      * additional information.
125      */
126     get valid () {
127         if (this._rawSigObject.summary.valid === true){
128             return true;
129         } else {
130             return false;
131         }
132     }
133
134     /**
135      * Object with boolean properties giving more information on non-valid
136      * signatures. Refer to the [gpgme docs]{@link https://www.gnupg.org/documentation/manuals/gpgme/Verify.html}
137      * for details on the values.
138      */
139     get errorDetails (){
140         let properties = ['revoked', 'key-expired', 'sig-expired',
141             'key-missing', 'crl-missing', 'crl-too-old', 'bad-policy',
142             'sys-error'];
143         let result = {};
144         for (let i=0; i< properties.length; i++){
145             if ( this._rawSigObject.summary.hasOwnProperty(properties[i]) ){
146                 result[properties[i]] = this._rawSigObject.summary[properties[i]];
147             }
148         }
149         return result;
150     }
151 }
152
153 /**
154  * Expected keys and their value's type for the signature Object
155  * @private
156  */
157 const expKeys = {
158     'wrong_key_usage': 'boolean',
159     'chain_model': 'boolean',
160     'summary': 'object',
161     'is_de_vs': 'boolean',
162     'status_string':'string',
163     'fingerprint':'string',
164     'validity_string': 'string',
165     'pubkey_algo_name':'string',
166     'hash_algo_name':'string',
167     'pka_address':'string',
168     'status_code':'number',
169     'timestamp':'number',
170     'exp_timestamp':'number',
171     'pka_trust':'number',
172     'validity':'number',
173     'validity_reason':'number',
174     'notations': 'object'
175 };
176
177 /**
178  * Keys and their value's type for the summary
179  * @private
180  */
181 const expSum = {
182     'valid': 'boolean',
183     'green': 'boolean',
184     'red': 'boolean',
185     'revoked': 'boolean',
186     'key-expired': 'boolean',
187     'sig-expired': 'boolean',
188     'key-missing': 'boolean',
189     'crl-missing': 'boolean',
190     'crl-too-old': 'boolean',
191     'bad-policy': 'boolean',
192     'sys-error': 'boolean',
193     'sigsum': 'object'
194 };
195
196 /**
197  * Keys and their value's type for notations objects
198  * @private
199  */
200 const expNote = {
201     'human_readable': 'boolean',
202     'critical':'boolean',
203     'name': 'string',
204     'value': 'string',
205     'flags': 'number'
206 };