js: Error handling for browser errors
[gpgme.git] / lang / js / src / Errors.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
24 /**
25  * Listing of all possible error codes and messages of a {@link GPGME_Error}.
26  */
27 export const err_list = {
28     // Connection
29     'CONN_NO_CONNECT': {
30         msg:'Connection with the nativeMessaging host could not be'
31             + ' established.',
32         type: 'error'
33     },
34     'CONN_EMPTY_GPG_ANSWER':{
35         msg: 'The nativeMessaging answer was empty.',
36         type: 'error'
37     },
38     'CONN_NO_CONFIG':{
39         msg: 'The browser does not recognize the nativeMessaging host.',
40         type: 'error'
41     },
42     'CONN_NATIVEMESSAGE':{
43         msg: 'The native messaging was not successful.',
44         type: 'error'
45     },
46     'CONN_TIMEOUT': {
47         msg: 'A connection timeout was exceeded.',
48         type: 'error'
49     },
50     'CONN_UNEXPECTED_ANSWER': {
51         msg: 'The answer from gnupg was not as expected.',
52         type: 'error'
53     },
54     'CONN_ALREADY_CONNECTED':{
55         msg: 'A connection was already established.',
56         type: 'warning'
57     },
58     // Message/Data
59     'MSG_INCOMPLETE': {
60         msg: 'The Message did not match the minimum requirements for'
61             + ' the interaction.',
62         type: 'error'
63     },
64     'MSG_EMPTY' : {
65         msg: 'The Message is empty.',
66         type: 'error'
67     },
68     'MSG_WRONG_OP': {
69         msg: 'The operation requested could not be found',
70         type: 'error'
71     },
72     'MSG_NO_KEYS' : {
73         msg: 'There were no valid keys provided.',
74         type: 'warning'
75     },
76     'MSG_NOT_A_FPR': {
77         msg: 'The String is not an accepted fingerprint',
78         type: 'warning'
79     },
80     'KEY_INVALID': {
81         msg:'Key object is invalid',
82         type: 'error'
83     },
84     'KEY_NOKEY': {
85         msg:'This key does not exist in GPG',
86         type: 'error'
87     },
88     'KEY_NO_INIT': {
89         msg:'This property has not been retrieved yet from GPG',
90         type: 'error'
91     },
92     'KEY_ASYNC_ONLY': {
93         msg: 'This property cannot be used in synchronous calls',
94         type: 'error'
95     },
96     'KEY_NO_DEFAULT': {
97         msg:'A default key could not be established. Please check yout gpg ' +
98             'configuration',
99         type: 'error'
100     },
101     'SIG_WRONG': {
102         msg:'A malformed signature was created',
103         type: 'error'
104     },
105     'SIG_NO_SIGS': {
106         msg:'There were no signatures found',
107         type: 'error'
108     },
109     // generic
110     'PARAM_WRONG':{
111         msg: 'Invalid parameter was found',
112         type: 'error'
113     },
114     'DECODE_FAIL': {
115         msg: 'Decoding failed due to unexpected data',
116         type: 'error'
117     },
118     'PARAM_IGNORED': {
119         msg: 'An parameter was set that has no effect in gpgmejs',
120         type: 'warning'
121     },
122     'GENERIC_ERROR': {
123         msg: 'Unspecified error',
124         type: 'error'
125     }
126 };
127
128 /**
129  * Checks the given error code and returns an {@link GPGME_Error} error object
130  * with some information about meaning and origin
131  * @param {String} code Error code as defined in {@link err_list}.
132  * @param {String} info Possible additional error message to pass through.
133  * Currently used for errors sent as answer by gnupg via a native Message port
134  * @returns {GPGME_Error}
135  */
136 export function gpgme_error (code = 'GENERIC_ERROR', info){
137     if (err_list.hasOwnProperty(code)){
138         if (err_list[code].type === 'error'){
139             return new GPGME_Error(code);
140         }
141         if (err_list[code].type === 'warning'){
142             // eslint-disable-next-line no-console
143             // console.warn(code + ': ' + err_list[code].msg);
144         }
145         return null;
146     } else if (code === 'GNUPG_ERROR'){
147         return new GPGME_Error(code, info);
148     }
149     else {
150         return new GPGME_Error('GENERIC_ERROR');
151     }
152 }
153
154 /**
155  * An error class with additional info about the origin of the error, as string
156  * It is created by {@link gpgme_error}, and its' codes are defined in
157  * {@link err_list}.
158  *
159  * @property {String} code Short description of origin and type of the error
160  * @property {String} msg Additional info
161  * @protected
162  * @class
163  * @extends Error
164  */
165 class GPGME_Error extends Error{
166     constructor (code = 'GENERIC_ERROR', msg=''){
167         const verboseErrors = ['GNUPG_ERROR', 'CONN_NATIVEMESSAGE'];
168         if (verboseErrors.includes(code) && typeof (msg) === 'string'){
169             super(msg);
170         } else if (err_list.hasOwnProperty(code)){
171             if (msg){
172                 super(err_list[code].msg + '--' + msg);
173             } else {
174                 super(err_list[code].msg);
175             }
176         } else {
177             super(err_list['GENERIC_ERROR'].msg);
178         }
179         this._code = code;
180     }
181
182     get code (){
183         return this._code;
184     }
185 }