js: change in initialization ancd connection handling
[gpgme.git] / lang / js / src / gpgmejs.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
21 import {Connection} from "./Connection"
22 import {GPGME_Message} from './Message'
23 import {toKeyIdArray} from "./Helpers"
24 import {GPGMEJS_Error as Error, GPGMEJS_Error} from "./Errors"
25 import { GPGME_Keyring } from "./Keyring";
26
27 export class GpgME {
28     /**
29      * initializes GpgME by opening a nativeMessaging port
30      * TODO: add configuration
31      */
32     constructor(connection){
33         this.connection = connection;
34     }
35
36     set connection(connection){
37         if (this._connection instanceof Connection){
38             //TODO Warning: Connection already established
39         }
40         if (connection instanceof Connection){
41             this._connection = connection;
42         }
43     }
44
45     get connection(){
46         if (this._connection instanceof Connection){
47             if (this._connection.isConnected){
48                 return this._connection;
49             }
50             return undefined; //TODO: connection was lost!
51         }
52         return undefined; //TODO: no connection there
53     }
54
55     set Keyring(keyring){
56         if (ring && ring instanceof GPGME_Keyring){
57             this.Keyring = ring;
58         }
59     }
60
61     get Keyring(){
62     }
63
64     /**
65      * @param {String|Uint8Array} data text/data to be encrypted as String/Uint8Array
66      * @param  {GPGME_Key|String|Array<String>|Array<GPGME_Key>} publicKeys Keys used to encrypt the message
67      * @param {Boolean} wildcard (optional) If true, recipient information will not be added to the message
68      */
69     encrypt(data, publicKeys, wildcard=false){
70
71         let msg = new GPGME_Message('encrypt');
72
73         // TODO temporary
74         msg.setParameter('armor', true);
75         msg.setParameter('always-trust', true);
76
77         let pubkeys = toKeyIdArray(publicKeys);
78         msg.setParameter('keys', pubkeys);
79
80         putData(msg, data);
81         if (wildcard === true){msg.setParameter('throw-keyids', true);
82         };
83
84         return (this.connection.post(msg));
85     }
86
87     /**
88     * @param  {String} data TODO Format: base64? String? Message with the encrypted data
89     * @returns {Promise<Object>} decrypted message:
90         data:   The decrypted data.  This may be base64 encoded.
91         base64: Boolean indicating whether data is base64 encoded.
92         mime:   A Boolean indicating whether the data is a MIME object.
93         info:   An optional object with extra information.
94     * @async
95     */
96
97     decrypt(data){
98
99         if (data === undefined){
100             return Promise.reject(new GPGMEJS_Error ('EMPTY_MSG'));
101         }
102         let msg = new GPGME_Message('decrypt');
103         putData(msg, data);
104         return this.connection.post(msg);
105
106     }
107
108     deleteKey(key, delete_secret = false, no_confirm = false){
109         return Promise.reject(new GPGMEJS_Error ('NOT_YET_IMPLEMENTED'));
110         let msg = new GPGME_Message('deletekey');
111         let key_arr = toKeyIdArray(key);
112         if (key_arr.length !== 1){
113             throw('TODO');
114             //should always be ONE key
115         }
116         msg.setParameter('key', key_arr[0]);
117         if (delete_secret === true){
118             msg.setParameter('allow_secret', true); //TBD
119         }
120         if (no_confirm === true){ //TODO: Do we want this hidden deep in the code?
121             msg.setParameter('delete_force', true); //TBD
122         }
123         this.connection.post(msg).then(function(success){
124             //TODO: it seems that there is always errors coming back:
125         }, function(error){
126             switch (error.msg){
127             case 'ERR_NO_ERROR':
128                 return Promise.resolve('okay'); //TBD
129             default:
130                 return Promise.reject(new GPGMEJS_Error);
131                 // INV_VALUE,
132                 // GPG_ERR_NO_PUBKEY,
133                 // GPG_ERR_AMBIGUOUS_NAME,
134                 // GPG_ERR_CONFLICT
135             }
136         });
137     }
138 }
139
140 /**
141  * Sets the data of the message, converting Uint8Array to base64 and setting
142  * the base64 flag
143  * @param {GPGME_Message} message The message where this data will be set
144  * @param {*} data The data to enter
145  * @param {String} propertyname // TODO unchecked still
146  */
147 function putData(message, data){
148     if (!message || !message instanceof GPGME_Message ) {
149         return new GPGMEJS_Error('WRONGPARAM');
150     }
151     if (!data){
152         //TODO Debug only! No data is legitimate
153         console.log('Warning. no data in message');
154         message.setParameter('data', '');
155     } else if (data instanceof Uint8Array){
156         let decoder = new TextDecoder('utf8');
157         message.setParameter('base64', true);
158         message.setParameter ('data', decoder.decode(data));
159     } else if (typeof(data) === 'string') {
160         message.setParameter('base64', false);
161         message.setParameter('data', data);
162     } else {
163         return new GPGMEJS_Error('WRONGPARAM');
164     }
165 }