aboutsummaryrefslogtreecommitdiffstats
path: root/package/cryptoAPI/pgpjs-keystore.jsm
blob: a25e6263ee153f245e1f09058d3f1492525d51a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

"use strict";

/**
 * This module implents key storage for OpenPGP.js
 */

var EXPORTED_SYMBOLS = ["pgpjs_keyStore"];

const EnigmailLog = ChromeUtils.import("chrome://enigmail/content/modules/log.jsm").EnigmailLog;
const EnigmailFuncs = ChromeUtils.import("chrome://enigmail/content/modules/funcs.jsm").EnigmailFuncs;
const getOpenPGPLibrary = ChromeUtils.import("chrome://enigmail/content/modules/stdlib/openpgp-loader.jsm").getOpenPGPLibrary;
const EnigmailTimer = ChromeUtils.import("chrome://enigmail/content/modules/timer.jsm").EnigmailTimer;
const EnigmailOS = ChromeUtils.import("chrome://enigmail/content/modules/os.jsm").EnigmailOS;
const EnigmailFiles = ChromeUtils.import("chrome://enigmail/content/modules/files.jsm").EnigmailFiles;
const Sqlite = ChromeUtils.import("resource://gre/modules/Sqlite.jsm").Sqlite;
const EnigmailLazy = ChromeUtils.import("chrome://enigmail/content/modules/lazy.jsm").EnigmailLazy;
const getArmor = EnigmailLazy.loader("enigmail/armor.jsm", "EnigmailArmor");
const EnigmailTime = ChromeUtils.import("chrome://enigmail/content/modules/time.jsm").EnigmailTime;
const pgpjs_keys = ChromeUtils.import("chrome://enigmail/content/modules/cryptoAPI/pgpjs-keys.jsm").pgpjs_keys;

var pgpjs_keyStore = {

  getKeyFlags: getKeyFlags, // FIXME

  /**
   * Write key(s) into the database.
   *
   * @param {String} keyData: armored or binary key data
   *
   * @return {Promise<Array<String>>} Array of imported fpr
   */
  writeKey: async function(keyData) {
    EnigmailLog.DEBUG("pgpjs-keystore.jsm: writeKey()\n");

    const PgpJS = getOpenPGPLibrary();
    let keys = [];

    if (typeof keyData === "string") {
      if (keyData.search(/-----BEGIN PGP (PUBLIC|PRIVATE) KEY BLOCK-----/) >= 0) {
        let blocks = getArmor().splitArmoredBlocks(keyData);

        for (let b of blocks) {
          let res;
          try {
            res = await PgpJS.readKeys({
              armoredKeys: b
            });
          }
          catch (x) {
            try {
              const SignaturePacket = PgpJS.SignaturePacket;
              const packetData = await PgpJS.unarmor(b);
              const packetList = await PgpJS.PacketList.fromBinary(packetData.data, {
                [SignaturePacket.tag]: SignaturePacket
              });

              res = await appendRevocationCert(packetList);
            }
            catch (x) {
              EnigmailLog.DEBUG(`pgpjs-keystore.jsm: writeKey: error while reading keys: ${x.toString()}\n`);
            }
          }

          if (res) {
            keys = keys.concat(res);
          }
        }
      }
      else {
        let data = stringToUint8Array(keyData);
        let res = await PgpJS.readKeys({
          binaryKeys: data
        });
        keys = res;
      }
    }
    else {
      // we got a Uint8Array
      keys = await PgpJS.readKeys({
        binaryKeys: keyData
      });
    }
    let importedFpr = [];

    let conn = await keyStoreDatabase.openDatabase();
    for (let k of keys) {
      try {
        await conn.executeTransaction(async function _trx() {
          await keyStoreDatabase.writeKeyToDb(k, conn);
        });
        importedFpr.push(k.getFingerprint().toUpperCase());
      }
      catch (x) {
        EnigmailLog.ERROR(`pgpjs-keystore.jsm: writeKey: error ${x.toString()} / ${x.stack}\n`);
      }
    }
    conn.close();
    return importedFpr;
  },

  /**
   * Modify the status of a key (enabled/disabled)
   *
   * @param {String} fpr: fingerprint of the key to change
   * @param {Boolean} enabled: if true, key status is set to "enabled", otherwise to "disabled"
   *
   * @return {Promise<Array<Object>>} found keys:
   *    object that suits as input for keyObj.contructor
   */
  setKeyStatus: async function(fpr, enabled) {
    let conn = await keyStoreDatabase.openDatabase();

    let updObj = {
      status: enabled ? 'enabled' : "disabled",
      fpr: fpr
    };

    await conn.execute("update openpgpkey set status = :status where fpr = :fpr;", updObj);
    conn.close();
  },

  /**
   * Determine the path where the key database is stored
   *
   * @return {String}: full path including file name
   */
  getDatabasePath: function() {
    const DBName = "openpgpkeys.sqlite";
    let path = DBName;
    const env = Cc["@mozilla.org/process/environment;1"].getService(Ci.nsIEnvironment);

    if (env.get("ENIGMAILKEYS").length > 0) {
      path = env.get("ENIGMAILKEYS") + (EnigmailOS.isWin32 ? "\\" : "/") + DBName;
    }
    else {
      if (EnigmailOS.isWin32) {
        path = env.get("APPDATA") + "\\Enigmail\\" + DBName;
      }
      else {
        path = env.get("HOME") + "/.enigmail/" + DBName;
      }
    }

    return path;
  },

  /**
   * Read one or more keys from the key store
   *
   * @param {Array<String>} keyArr: [optional] Array of Fingerprints or keyIDs. If not provided, all keys are returned
   *
   * @return {Promise<Array<Object>>} found keys:
   *    fpr: fingerprint
   *    key: OpenPGP.js Key object
   */
  readKeys: async function(keyArr) {
    const PgpJS = getOpenPGPLibrary();

    let rows = await keyStoreDatabase.readKeysFromDb(keyArr);

    let foundKeys = [];
    for (let i in rows) {
      foundKeys.push({
        fpr: i,
        status: rows[i].status,
        key: (await PgpJS.readKey({
          armoredKey: rows[i].armoredKey
        }))
      });
    }
    return foundKeys;
  },

  /**
   * Read one or more keys from the key store
   *
   * @param {Array<String>} keyArr: [optional] Array of Fingerprints. If not provided, all keys are returned
   *
   * @return {Promise<Array<Object>>} found keys:
   *    object that suits as input for keyObj.contructor
   */
  readKeyMetadata: async function(keyArr = null) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: readKeyMetadata(${keyArr})\n`);

    const PgpJS = getOpenPGPLibrary();
    const now = Date.now() / 1000;

    let rows = await keyStoreDatabase.readKeysFromDb(keyArr);

    let foundKeys = [];
    for (let i in rows) {
      let key = getKeyFromJSON(rows[i].metadata);
      if (rows[i].status === "disabled") {
        key.ownerTrust = 'd';
        key.keyTrust = 'd';
        key.keyUseFor = "";
      }

      // special handling for keys that expired after they were stored in DB
      if (key.expiryTime < now && key.expiryTime > 0) {
        key.keyUseFor = key.keyUseFor.replace(/[CES]/g, "");
        if (key.keyTrust.search(/^[fu]/) === 0) {
          key.keyTrust = "e";
        }
      }

      foundKeys.push(key);
    }
    return foundKeys;
  },

  readPublicKeys: async function(keyArr) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: readPublicKeys(${keyArr})\n`);

    const PgpJS = getOpenPGPLibrary();

    let keyList = await this.readKeys(keyArr);
    let packets = new PgpJS.PacketList();

    for (let i in keyList) {
      let k = await keyList[i].key.toPublic();
      packets = packets.concat(await k.toPacketList());
    }

    return PgpJS.armor(PgpJS.enums.armor.publicKey, packets.write());
  },


  readMinimalPubKey: async function(fpr, email) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: readMinimalPubKey(${fpr})\n`);

    let keyList = await this.readKeys([fpr]);

    let ret = {
      exitCode: 0,
      keyData: "",
      errorMsg: ""
    };

    if (keyList.length > 0) {
      let k = await keyList[0].key.toPublic();
      k.toPacketList();

      if (!email) {
        try {
          email = EnigmailFuncs.stripEmail((await k.getPrimaryUser()).user);
        }
        catch (ex) {}
      }

      let keyBlob = await pgpjs_keys.getStrippedKey(k, email);
      if (keyBlob) {
        ret.keyData = btoa(String.fromCharCode.apply(null, keyBlob));
      }
    }

    return ret;
  },

  /**
   * Export secret key(s) as ASCII armored data
   *
   * @param {String}  keyArr       Specification by fingerprint or keyID, separate mutliple keys with spaces
   * @param {Boolean} minimalKey  if true, reduce key to minimum required
   *
   * @return {Object}:
   *   - {Number} exitCode:  result code (0: OK)
   *   - {String} keyData:   ASCII armored key data material
   *   - {String} errorMsg:  error message in case exitCode !== 0
   */

  readSecretKeys: async function(keyArr, minimalKey) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: readSecretKeys(${keyArr})\n`);

    const PgpJS = getOpenPGPLibrary();

    let keyList = await this.readKeys(keyArr);
    let packets = new PgpJS.PacketList();

    for (let k of keyList) {
      if (k.key.isPrivate()) {
        if (minimalKey) {
          packets = packets.concat(await pgpjs_keys.getStrippedKey(k.key, null, true));
        }
        else {
          packets = packets.concat(await k.key.toPacketList());
        }
      }
    }

    return PgpJS.armor(PgpJS.enums.armor.privateKey, packets.write());
  },

  /**
   * Delete one or more keys from the key store
   *
   * @param {Array<String>} keyArr: Array of Fingerprints
   *
   * @return undefined
   */
  deleteKeys: async function(keyArr) {
    let conn = await keyStoreDatabase.openDatabase();
    let error = null;

    try {
      await conn.executeTransaction(async function _trx() {
        return keyStoreDatabase.deleteKeysFromDb(keyArr, conn);
      });
    }
    catch (ex) {
      error = ex;
    }
    conn.close();

    if (error) throw error;
  },

  /**
   * Write a key to the database. Unlike writeKey(), this function does not merge
   * an existing key with the new key, but replaces an existing key entirely.
   *
   * @param {Object} keyObj: OpenPGP.js key object
   */
  replaceKey: async function(keyObj) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: replaceKey(${keyObj.getFingerprint()})\n`);

    let error = null;
    let conn = await keyStoreDatabase.openDatabase();
    try {
      await conn.executeTransaction(async function _trx() {
        await keyStoreDatabase.deleteKeysFromDb([keyObj.getFingerprint().toUpperCase()], conn);
        await keyStoreDatabase.writeKeyToDb(keyObj, conn);
      });
    }
    catch (ex) {
      error = ex;
    }
    conn.close();

    if (error) throw error;
  },


  /**
   * Retrieve the OpenPGP.js key objects for a given set of keyIds.
   *
   * @param {Boolean} secretKeys:     if true, only return secret keys
   * @param {Array<String>} keyIdArr: keyIDs to look up. If null, then all
   *                                  secret or public keys are retrieved
   * @param {Boolean} includeDisabledPubkeys: if true, include disabled public keys (false by default)
   *                                  Note: secret keys are always returned
   *
   * @return {Array<Object>}: array of the found key objects
   */
  getKeysForKeyIds: async function(secretKeys, keyIdArr = null, includeDisabledPubkeys = false) {
    const PgpJS = getOpenPGPLibrary();
    let findKeyArr = [];

    if (secretKeys) {
      let keys = await pgpjs_keyStore.readKeyMetadata(keyIdArr);

      for (let k of keys) {
        if (k.secretAvailable) {
          findKeyArr.push(k.fpr);
        }
      }
    }
    else {
      findKeyArr = keyIdArr;
    }

    let returnArray = [];
    let keys = await pgpjs_keyStore.readKeys(findKeyArr);
    for (let k of keys) {
      if (!secretKeys) {
        if ((!includeDisabledPubkeys) && k.status === "disabled") {
          continue;
        }
        let pk = k.key.toPublic();
        pk._enigmailKeyStatus = k.status;
        returnArray.push(pk);
      }
      else {
        k.key._enigmailKeyStatus = k.status;
        returnArray.push(k.key);
      }
    }

    returnArray.toPacketList = function() {
      let pktList = new PgpJS.PacketList();

      for (let i = 0; i < this.length; i++) {
        pktList = pktList.concat(this[i].toPacketList());
      }

      return pktList;
    };

    return returnArray;
  },

  /**
   * Write a revocation certificate to its default location
   */
  storeRevocationCert: function(key, certificateData) {
    const fpr = key.getFingerprint().toUpperCase();

    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: storeRevocationCert(${fpr})\n`);
    let dbPathObj = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);

    let dbPath = pgpjs_keyStore.getDatabasePath();

    dbPathObj.initWithPath(dbPath);
    dbPathObj = dbPathObj.parent;
    dbPathObj.append("openpgp-revocs.d");

    EnigmailFiles.ensureWritableDirectory(dbPathObj, 0o700);
    const uid = key.users[0].userID.userID;
    dbPathObj.append(`${fpr}.rev`);

    const data = `This is a revocation certificate for the OpenPGP key:

Key ID:      ${fpr}
uid          ${uid}

A revocation certificate is a kind of "kill switch" to publicly
declare that a key shall not anymore be used.  It is not possible
to retract such a revocation certificate once it has been published.

Use it to revoke this key in case of a compromise or loss of
the secret key.

To avoid an accidental use of this file, a colon has been inserted
before the 5 dashes below.  Remove this colon with a text editor
before importing and publishing this revocation certificate.

:${certificateData}
`;

    EnigmailFiles.writeFileContents(dbPathObj, data);
  },

  /**
   * Determine the key status and return the corresponding code
   *
   * @param {Object} key: OpenPGP.js key object
   *
   * @return {String} status code
   */
  getKeyStatusCode: getKeyStatusCode,

  /**
   * Initialize module
   *
   * @return {Promise<Boolean>} true if successful
   */
  init: function() {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: init()\n`);
    return keyStoreDatabase.checkDatabaseStructure();
  }
};


const keyStoreDatabase = {
  openDatabase: function() {
    EnigmailLog.DEBUG("pgpjs-keystore.jsm: openDatabase()\n");
    return new Promise((resolve, reject) => {
      openDatabaseConn(resolve, reject, 100, Date.now() + 10000);
    });
  },

  checkDatabaseStructure: async function() {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: checkDatabaseStructure()\n`);
    let conn;
    try {
      conn = await this.openDatabase();
      await checkKeysTable(conn);
      conn.close();
      EnigmailLog.DEBUG(`pgpjs-keystore.jsm: checkDatabaseStructure - success\n`);
    }
    catch (ex) {
      EnigmailLog.ERROR(`pgpjs-keystore.jsm: checkDatabaseStructure: ERROR: ${ex}\n`);
      if (conn) {
        conn.close();
        return false;
      }
    }

    return true;
  },

  /**
   * Store a key in the database
   *
   * @param {Object} key: OpenPGP.js Key object
   * @param {Object} connection: [optional] database connection
   *
   * no return value
   */
  writeKeyToDb: async function(key, connection = null) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: writeKeyToDb(${key})\n`);
    const fpr = key.getFingerprint().toUpperCase();
    const now = new Date().toJSON();
    const PgpJS = getOpenPGPLibrary();
    let conn;

    if (connection) {
      conn = connection;
    }
    else {
      conn = await this.openDatabase();
    }

    let rows = await this.readKeysFromDb([fpr], conn);
    let metadata;

    if (fpr in rows) {
      // merge existing key with new key data
      let oldKey = await PgpJS.readKey({
        armoredKey: rows[fpr].armoredKey
      });

      try {
        await key.update(oldKey);
      }
      catch (x) {
        // if the keys can't be merged, try to update the old key with the new one
        try {
          await oldKey.update(key);
          key = oldKey;
        }
        catch (x) {
          // if we have a private key, keep it, otherwise use the new key
          if (oldKey.isPrivate()) key = oldKey;
        }
      }
      metadata = await getKeyMetadata(key);

      let updObj = {
        fpr: fpr,
        now: now,
        metadata: JSON.stringify(metadata),
        data: await key.armor()
      };
      await conn.execute("update openpgpkey set keydata = :data, metadata = :metadata, datm = :now where fpr = :fpr;", updObj);
    }
    else {
      // new key
      metadata = await getKeyMetadata(key);

      let insObj = {
        fpr: fpr,
        now: now,
        metadata: JSON.stringify(metadata),
        data: await key.armor()
      };
      await conn.execute("insert into openpgpkey (keydata, metadata, fpr, datm) values (:data, :metadata, :fpr, :now);", insObj);
    }

    await this.writeKeyIdsToDb(conn, metadata);

    if (!connection) {
      conn.close();
    }

    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: writeKeyToDb: wrote ${fpr}\n`);
  },

  /**
   * Read one or more keys from the database
   *
   * @param {Array<String>} keyArr: [optional] Array of Fingerprints or keyIDs. If not provided, all keys are returned
   * @param {Object} connection: [optional] database connection
   *
   * @return {Array<Key>} List of OpenPGP.js Key objects.
   */
  readKeysFromDb: async function(keyArr = null, connection = null) {
    EnigmailLog.DEBUG("pgpjs-keystore.jsm: readKeysFromDb(" + (keyArr ? keyArr.length : "null") + ")\n");

    let conn;
    let searchStr = "";

    if (connection) {
      conn = connection;
    }
    else {
      conn = await this.openDatabase();
    }

    if (keyArr !== null) {
      searchStr = "select o.fpr, o.keydata, o.metadata, o.status from openpgpkey o inner join keyid_lookup l on l.fpr = o.fpr " +
        "where l.keyid in ('-' ";

      for (let i in keyArr) {
        // make sure search string only contains A-F and 0-9
        let s = keyArr[i].replace(/^0x/, "").replace(/[^A-Fa-f0-9]/g, "").toUpperCase();
        searchStr += `, '${s}'`;
      }
      searchStr += ")";
    }
    else {
      searchStr = "select fpr, keydata, metadata, status from openpgpkey";
    }

    let rows = [];
    await conn.execute(searchStr, null,
      function _onRow(record) {
        rows[record.getResultByName("fpr")] = {
          armoredKey: record.getResultByName("keydata"),
          status: record.getResultByName("status"),
          metadata: record.getResultByName("metadata")
        };
      });

    if (!connection) {
      conn.close();
    }

    return rows;
  },

  /**
   * Fill the keyId lookup table for a given key
   *
   * @param {Object} conn: Database connection
   * @param {Object} keyMetadata: the metadata of the key that is stringified
   */
  writeKeyIdsToDb: async function(conn, keyMetadata) {
    try {
      let delObj = {
        fpr: keyMetadata.fpr
      };
      let keyIds = [];
      keyIds[keyMetadata.keyId] = 1;
      keyIds[keyMetadata.fpr] = 1;

      for (let k of keyMetadata.subKeys) {
        keyIds[k.keyId] = 1;
      }
      await conn.execute("delete from keyid_lookup where fpr = :fpr;", delObj);

      for (let k in keyIds) {
        let insObj = {
          fpr: keyMetadata.fpr,
          keyId: k
        };

        await conn.execute("insert into keyid_lookup (fpr, keyid) values(:fpr, :keyId);", insObj);
      }
    }
    catch (x) {
      EnigmailLog.DEBUG(`pgpjs-keystore.jsm: writeKeyIdsToDb: error with ${keyMetadata.fpr}: ${x.toString()}\n`);
    }
  },

  /*select o.fpr, keydata from keyid_lookup l inner join openpgpkey o on o.fpr = l.fpr
    where l.keyid = 'B6EF9CA3B9670465'; */

  /**
   * Delete one or more keys from the database
   *
   * @param {Array<String>} keyArr: Array of Fingerprints
   * @param {Object} connection: [optional] database connection
   */
  deleteKeysFromDb: async function(keyArr = [], connection = null) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: deleteKeysFromDb(${keyArr})\n`);
    let conn;
    let searchStr = "";

    if (connection) {
      conn = connection;
    }
    else {
      conn = await this.openDatabase();
    }

    for (let i in keyArr) {
      // make sure search string only contains A-F and 0-9
      let s = keyArr[i].replace(/^0x/, "").replace(/[^A-Fa-f0-9]/g, "").toUpperCase();
      searchStr += `, '${s}'`;
    }

    await conn.execute(`delete from openpgpkey where fpr in ('-' ${searchStr});`, null);
    await conn.execute(`delete from keyid_lookup where fpr in ('-' ${searchStr});`, null);

    if (!connection) {
      conn.close();
    }
  },

  /**
   * Enable or disable Keys
   *
   * @param {Array<String>} keyArr: Array of Fingerprints
   * @param {Boolean} enable: true: enable key(s) / false: disable key(s)
   * @param {Object} connection: [optional] database connection
   */
  enableKeys: async function(keyArr, enable, connection = null) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: enableKeys(${keyArr})\n`);

    if (!keyArr || keyArr.length === 0) return;

    let conn;
    let searchStr = "";

    if (connection) {
      conn = connection;
    }
    else {
      conn = await this.openDatabase();
    }

    for (let i in keyArr) {
      // make sure search string only contains A-F and 0-9
      let s = keyArr[i].replace(/^0x/, "").replace(/[^A-Fa-f0-9]/g, "").toUpperCase();
      searchStr += `, '${s}'`;
    }

    let updateObj = {
      newStat: enable ? "enabled" : "disabled"
    };

    await conn.execute(`update openpgpkey set status = ':newStat' where fpr in ('-' ${searchStr});`, updateObj);

    if (!connection) {
      conn.close();
    }
  }
};


/**
 * use a promise to open the openpgpkey database.
 *
 * it's possible that there will be an NS_ERROR_STORAGE_BUSY
 * so we're willing to retry for a little while.
 *
 * @param {function} resolve: function to call when promise succeeds
 * @param {function} reject:  function to call when promise fails
 * @param {Number}   waitms:  Integer - number of milliseconds to wait before trying again in case of NS_ERROR_STORAGE_BUSY
 * @param {Number}   maxtime: Integer - unix epoch (in milliseconds) of the point at which we should give up.
 */
async function openDatabaseConn(resolve, reject, waitms, maxtime) {
  EnigmailLog.DEBUG("pgpjs-keystore.jsm: openDatabaseConn()\n");
  let dbPathObj = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);

  let dbPath = pgpjs_keyStore.getDatabasePath();
  EnigmailLog.DEBUG(`pgpjs-keystore.jsm: openDatabaseConn: path=${dbPath}\n`);

  dbPathObj.initWithPath(dbPath);
  let r = EnigmailFiles.ensureWritableDirectory(dbPathObj.parent, 0o700);

  EnigmailLog.DEBUG(`pgpjs-keystore.jsm: openDatabaseConn: directory OK: ${r}\n`);

  if (r !== 0) {
    throw "Cannot write directory";
  }

  Sqlite.openConnection({
    path: dbPath,
    sharedMemoryCache: false
  }).
  then(connection => {
    resolve(connection);
  }).
  catch(error => {
    let now = Date.now();
    if (now > maxtime) {
      reject(error);
      return;
    }
    EnigmailTimer.setTimeout(function() {
      openDatabaseConn(resolve, reject, waitms, maxtime);
    }, waitms);
  });
}


/**
 * Ensure that the database structure matches the latest version
 * (table is available)
 *
 * @param connection: Object - SQLite connection
 *
 * @return {Promise<Boolean>}
 */
async function checkKeysTable(connection) {
  try {
    let exists = await connection.tableExists("openpgpkey");
    EnigmailLog.DEBUG("pgpjs-keystore.jsm: checkKeysTable - success\n");
    if (!exists) {
      await createKeysTable(connection);
    }

    exists = await connection.tableExists("keyid_lookup");
    EnigmailLog.DEBUG("pgpjs-keystore.jsm: keyid_lookup - success\n");
    if (!exists) {
      await createKeysIdsTable(connection);
    }

  }
  catch (error) {
    EnigmailLog.DEBUG(`pgpjs-keystore.jsm: checkKeysTable - error ${error}\n`);
    throw error;
  }

  return true;
}


/**
 * Create the "autocrypt_keydata" table and the corresponding index
 *
 * @param connection: Object - SQLite connection
 *
 * @return {Promise}
 */
async function createKeysTable(connection) {
  EnigmailLog.DEBUG("pgpjs-keystore.jsm: createKeysTable()\n");

  await connection.execute("create table openpgpkey (" +
    "keydata text not null, " + // ASCII armored key
    "metadata text not null, " + // key metadata (JSON)
    "fpr text not null, " + // fingerprint of key
    "datm text not null, " + // timestamp of last modification
    "status text not null default 'enabled'" + // status (enabled/disabled)
    ");"
  );

  EnigmailLog.DEBUG("pgpjs-keystore.jsm: createKeysTable - index\n");
  await connection.execute("create unique index openpgpkey_i1 on openpgpkey(fpr)");

  return null;
}

async function createKeysIdsTable(connection) {
  EnigmailLog.DEBUG("pgpjs-keystore.jsm: createKeysIdsTable()\n");

  await connection.execute("create table keyid_lookup (" +
    "fpr text not null, " + // fingerprint of key
    "keyid text not null " + // keyid for lokup
    ");"
  );

  EnigmailLog.DEBUG("pgpjs-keystore.jsm: createKeysTable - index\n");
  await connection.execute("create unique index keyid_i1 on keyid_lookup(keyid)");

  return null;
}

/**
 * Read data from a stream and return a Uint8Array
 *
 * @param {ReadableStream} s: the stream from where to read data
 *
 * @return {Promise<Uint8Array>} the data
 */

function readFromStream(s) {
  return new Promise((resolve, reject) => {
    let result = new Uint8Array();

    function processText({
      done,
      value
    }) {
      // Result objects contain two properties:
      // done  - true if the stream has already given you all its data.
      // value - some data. Always undefined when done is true.
      if (done) {
        resolve(result);
        return null;
      }

      // value for fetching stream data is a Uint8Array

      let tmpArr = new Uint8Array(result.length + value.length);
      tmpArr.set(result);
      tmpArr.set(value, result.length);
      result = tmpArr;

      // Read some more, and call this function again
      return s.read().then(processText);
    }

    s.read().then(processText);
  });
}

function stringToUint8Array(str) {
  return Uint8Array.from(Array.from(str).map(x => {
    return x.charCodeAt(0);
  }));
}


/**
 * Create a keyObj object as specified in EnigmailKeyObj.constructor
 *
 * @param {Object} key: OpenPGP.js key
 *
 * @return {Promise<keyObj>}
 */
async function getKeyMetadata(key) {
  let keyObj = {};
  let uatNum = 0;

  keyObj.keyId = key.getKeyID().toHex().toUpperCase();
  keyObj.secretAvailable = key.isPrivate();

  try {
    keyObj.expiryTime = (await key.getExpirationTime()).getTime() / 1000;
  }
  catch (x) {
    keyObj.expiryTime = 0;
  }

  keyObj.keyCreated = key.getCreationTime().getTime() / 1000;
  keyObj.created = EnigmailTime.getDateTime(keyObj.keyCreated, true, false);
  keyObj.type = "pub";

  keyObj.keyTrust = await getKeyStatusCode(key);
  if (keyObj.keyTrust === "f" && keyObj.secretAvailable) keyObj.keyTrust = "u";

  let keyIsValid = (keyObj.keyTrust.search(/^[uf]$/) === 0);

  let prim = null;

  try {
    prim = (await key.getPrimaryUser()).user;
  }
  catch (ex) {
    if (key.users.length > 0) {
      prim = key.users[0];
    }
  }

  const keyUse = await getKeyFlags(key);
  keyObj.keyUseFor = (keyUse.cert ? "c" : "") +
    (keyUse.certValid ? "C" : "") +
    (keyUse.sign ? "s" : "") +
    (keyUse.signValid ? "S" : "") +
    (keyUse.enc ? "e" : "") +
    (keyUse.encValid ? "E" : "");

  keyObj.ownerTrust = (keyObj.secretAvailable ? "u" : "f");
  keyObj.algoSym = getAlgorithmDesc(key.getAlgorithmInfo().algorithm);
  keyObj.keySize = key.getAlgorithmInfo().bits;
  keyObj.fpr = key.getFingerprint().toUpperCase();
  keyObj.userId = prim ? prim.userID.userID : "n/a";
  keyObj.photoAvailable = false;

  keyObj.userIds = [];

  for (let i in key.users) {
    let trustLevel = "f";
    if (keyIsValid) {
      try {
        trustLevel = await getUserStatusCode(key.users[i], key);
      }
      catch (x) {}
    }
    else {
      trustLevel = keyObj.keyTrust;
    }

    if (key.users[i].userAttribute !== null) {
      keyObj.photoAvailable = true;
      keyObj.userIds.push({
        userId: "JPEG",
        keyTrust: trustLevel,
        uidFpr: "",
        type: "uat",
        uatNum: uatNum
      });
      ++uatNum;
    }
    else {
      keyObj.userIds.push({
        userId: key.users[i].userID.userID,
        keyTrust: trustLevel,
        uidFpr: "",
        type: "uid"
      });
    }
  }

  keyObj.subKeys = [];

  let sk = key.getSubkeys();
  for (let i in sk) {
    let exp = 0;
    try {
      exp = (await sk[i].getExpirationTime()).getTime() / 1000;
    }
    catch (x) {}

    let keyTrust = "f";
    if (keyIsValid) {
      try {
        keyTrust = await getSubKeyStatusCode(sk[i]);
        if (keyTrust === "f" && keyObj.secretAvailable) keyTrust = "u";
      }
      catch (x) {}
    }
    else {
      keyTrust = keyObj.keyTrust;
    }

    keyObj.subKeys.push({
      keyId: sk[i].getKeyID().toHex().toUpperCase(),
      expiry: EnigmailTime.getDateTime(exp, true, false),
      expiryTime: exp,
      keyTrust: keyTrust,
      // FIXME:
      keyUseFor: (sk[i].getAlgorithmInfo().algorithm.search(/sign/i) ? "s" : "") +
        (sk[i].getAlgorithmInfo().algorithm.search(/encrypt/i) ? "e" : ""),
      keySize: sk[i].getAlgorithmInfo().bits,
      algoSym: getAlgorithmDesc(sk[i].getAlgorithmInfo().algorithm),
      created: EnigmailTime.getDateTime(sk[i].getCreationTime() / 1000, true, false),
      keyCreated: sk[i].getCreationTime() / 1000,
      type: "sub"
    });
  }

  return keyObj;
}


/**
 * Parse a JSON string and create a key object. Additionally, determine if the key
 * or some subkey(s) have expired since the metadata were last updated.
 *
 * @param {String} jsonStr: JSON string to parse
 *
 * @return {Object} keyObj object
 */
function getKeyFromJSON(jsonStr) {
  let keyObj = JSON.parse(jsonStr);
  const now = new Date().getTime() / 1000;
  let keyIsValid = (keyObj.keyTrust.search(/^[uf]$/) === 0);

  if (keyIsValid) {
    // determine if key has expired
    if (keyObj.expiryTime > 0 && keyObj.expiryTime < now) {
      keyObj.keyTrust = "e";

      for (let i in keyObj.subKeys) {
        keyObj.subKeys[i].keyTrust = "e";
      }
      for (let i in keyObj.userIds) {
        keyObj.userIds[i].keyTrust = "e";
      }
    }
    else {
      // determine if a subkey has expired
      for (let i in keyObj.subKeys) {
        if (keyObj.subKeys[i].expiryTime > 0 && keyObj.subKeys[i].expiryTime < now) {
          keyObj.subKeys[i].keyTrust = "e";
        }
      }
    }
  }

  return keyObj;
}


async function appendRevocationCert(packetList) {
  EnigmailLog.DEBUG("pgpjs-keystore.jsm: appendRevocationCert()\n");

  const PgpJS = getOpenPGPLibrary();
  const revCert = packetList.findPacket(PgpJS.SignaturePacket.tag);

  if (revCert.signatureType !== PgpJS.enums.signature.keyRevocation) {
    return null;
  }

  let keyId = getFprFromArray(revCert.issuerFingerprint);
  if (!keyId) {
    keyId = revCert.issuerKeyID.toHex().toUpperCase();
  }

  let foundKeys = await pgpjs_keyStore.getKeysForKeyIds(false, [keyId]);

  if (foundKeys.length === 1) {
    return [await foundKeys[0].applyRevocationCertificate(await PgpJS.armor(PgpJS.enums.armor.signature, packetList.write()))];
  }

  return null;

}


function getFprFromArray(arr) {
  const HEX_TABLE = "0123456789ABCDEF";

  if (!arr) return null;

  let hex = '';

  for (let j = 0; j < arr.length; j++) {
    hex += HEX_TABLE.charAt((arr[j] & 0xf0) >> 4) +
      HEX_TABLE.charAt((arr[j] & 0x0f));
  }

  return hex;
}


async function getKeyStatusCode(key) {
  let now = new Date();

  try {
    if (await key.isRevoked(null, null, now)) {
      return "r";
    }
    else if (!key.users.some(user => user.userID && user.selfCertifications.length)) {
      return "i";
    }
    else {
      const {
        user,
        selfCertification
      } = await key.getPrimaryUser(now, {}) || {};

      if (!user) return "i";

      // check for expiration time
      if (isDataExpired(key.keyPacket, selfCertification, now)) {
        return "e";
      }
    }
  }
  catch (x) {
    return "i";
  }

  return "f";
}

async function getUserStatusCode(user, key) {
  try {
    if (!user.selfCertifications.length) {
      return "i";
    }

    const results = ["i"].concat(
      await Promise.all(user.selfCertifications.map(async function(selfCertification) {

        if (selfCertification.revoked || await user.isRevoked(key.keyPacket, selfCertification)) {
          return "r";
        }

        if (!(await user.verifyCertificate(selfCertification, [key]))) {
          return "i";
        }

        if (selfCertification.isExpired()) {
          return "e";
        }

        return "f";
      })));

    return results.some(status => status === "f") ? "f" : results.pop();
  }
  catch (x) {}

  return "i";
}

async function getSubKeyStatusCode(key) {
  const dataToVerify = {
    key: null,
    bind: key.keyPacket
  };
  const now = new Date();

  // check subkey binding signatures
  const bindingSignature = getLatestSignature(key.bindingSignatures, now);

  // check binding signature is verified
  if (!(bindingSignature.verified || await bindingSignature.verify(key.keyPacket, dataToVerify))) {
    return "i";
  }

  // check binding signature is not revoked
  if (bindingSignature.revoked || await key.isRevoked(key.keyPacket, bindingSignature, null, now)) {
    return "r";
  }

  // check binding signature is not expired (ie, check for V4 expiration time)
  if (bindingSignature.isExpired(now)) {
    return "e";
  }

  return "f"; // binding signature passed all checks
}


function getLatestSignature(signatures, date = new Date()) {
  let signature = signatures[0];

  for (let i = 1; i < signatures.length; i++) {

    if (signatures[i].created >= signature.created &&
      (signatures[i].created <= date || date === null)) {
      signature = signatures[i];
    }
  }

  return signature;
}


function isDataExpired(keyPacket, signature, date = new Date()) {
  const normDate = normalizeDate(date);

  if (normDate !== null) {
    const expirationTime = getExpirationTime(keyPacket, signature);

    return !(keyPacket.created <= normDate && normDate < expirationTime) ||
      (signature && signature.isExpired(date));
  }

  return false;
}

function getExpirationTime(keyPacket, signature) {
  let expirationTime;
  try {
    // check V4 expiration time
    if (signature.keyNeverExpires === false) {
      expirationTime = keyPacket.created.getTime() + signature.keyExpirationTime * 1000;
    }

    return expirationTime ? new Date(expirationTime) : Infinity;
  }
  catch (ex) {
    return Infinity;
  }
}

function normalizeDate(time = Date.now()) {
  return time === null ? time : new Date(Math.floor(Number(time) / 1000) * 1000);
}


async function getKeyFlags(key) {
  const PgpJS = getOpenPGPLibrary();

  const keyUse = {
    sign: 0,
    signValid: 0,
    enc: 0,
    encValid: 0,
    cert: 0,
    certValid: 0
  };

  function determineFlags(inputFlags, isVerified) {
    try {

      if (inputFlags & PgpJS.enums.keyFlags.certifyKeys) ++keyUse.cert;
      if (inputFlags & PgpJS.enums.keyFlags.signData) ++keyUse.sign;
      if (inputFlags & PgpJS.enums.keyFlags.encryptCommunication) ++keyUse.enc;
      if (inputFlags & PgpJS.enums.keyFlags.encryptStorage) ++keyUse.enc;
      if (isVerified) {
        if (inputFlags & PgpJS.enums.keyFlags.certifyKeys) ++keyUse.certValid;
        if (inputFlags & PgpJS.enums.keyFlags.signData) ++keyUse.signValid;
        if (inputFlags & PgpJS.enums.keyFlags.encryptCommunication) ++keyUse.encValid;
        if (inputFlags & PgpJS.enums.keyFlags.encryptStorage) ++keyUse.encValid;
      }
    }
    catch (x) {}
  }

  try {
    await key.verifyPrimaryKey();
    await key.verifyAllUsers();
  }
  catch (x) {}

  let keyStatusCode = await getKeyStatusCode(key);

  for (let sk of key.getSubkeys()) {
    try {
      await sk.verify(key.primaryKey);
    }
    catch (x) {}

    for (let sig in sk.bindingSignatures) {
      let skNotExp = !isDataExpired(sk, sk.bindingSignatures[sig]);
      for (let flg in sk.bindingSignatures[sig].keyFlags) {
        determineFlags(sk.bindingSignatures[sig].keyFlags[flg], sk.bindingSignatures[sig].verified && skNotExp && keyStatusCode === "f");
      }
    }
  }

  for (let usr of key.users) {
    for (let sig in usr.selfCertifications) {
      for (let flg in usr.selfCertifications[sig].keyFlags) {
        determineFlags(usr.selfCertifications[sig].keyFlags[flg], usr.selfCertifications[sig].verified && keyStatusCode === "f");
      }
    }
  }

  for (let sig in key.directSignatures) {
    for (let flg in key.directSignatures[sig].keyFlags) {
      determineFlags(key.directSignatures[sig].keyFlags[flg], key.directSignatures[sig].verified && keyStatusCode === "f");
    }
  }

  return keyUse;
}


function getAlgorithmDesc(algorithm) {
  algorithm = algorithm.toUpperCase();

  if (algorithm.search(/^RSA/) === 0) {
    algorithm = "RSA";
  }

  return algorithm;
}