Source: encrypt/consumer-db.js

  1. /**
  2.  * Copyright (C) 2015-2018 Regents of the University of California.
  3.  * @author: Jeff Thompson <jefft0@remap.ucla.edu>
  4.  * @author: From ndn-group-encrypt src/consumer-db https://github.com/named-data/ndn-group-encrypt
  5.  *
  6.  * This program is free software: you can redistribute it and/or modify
  7.  * it under the terms of the GNU Lesser General Public License as published by
  8.  * the Free Software Foundation, either version 3 of the License, or
  9.  * (at your option) any later version.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU Lesser General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU Lesser General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  * A copy of the GNU Lesser General Public License is in the file COPYING.
  19.  */
  21. /** @ignore */
  22. var SyncPromise = require('../util/sync-promise.js').SyncPromise;
  24. /**
  25.  * ConsumerDb is a base class the storage of decryption keys for the consumer. A
  26.  * subclass must implement the methods. For example, see Sqlite3ConsumerDb (for
  27.  * Nodejs) or IndexedDbConsumerDb (for the browser).
  28.  * @note This class is an experimental feature. The API may change.
  29.  * @constructor
  30.  */
  31. var ConsumerDb = function ConsumerDb()
  32. {
  33. };
  35. exports.ConsumerDb = ConsumerDb;
  37. /**
  38.  * Create a new ConsumerDb.Error to report an error using ConsumerDb
  39.  * methods, wrapping the given error object.
  40.  * Call with: throw new ConsumerDb.Error(new Error("message")).
  41.  * @constructor
  42.  * @param {Error} error The exception created with new Error.
  43.  */
  44. ConsumerDb.Error = function ConsumerDbError(error)
  45. {
  46.   if (error) {
  47.     error.__proto__ = ConsumerDb.Error.prototype;
  48.     return error;
  49.   }
  50. };
  52. ConsumerDb.Error.prototype = new Error();
  53. ConsumerDb.Error.prototype.name = "ConsumerDbError";
  55. /**
  56.  * Get the key with keyName from the database.
  57.  * @param {Name} keyName The key name.
  58.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  59.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  60.  * an async Promise.
  61.  * @return {Promise|SyncPromise} A promise that returns a Blob with the encoded
  62.  * key (or an isNull Blob if cannot find the key with keyName), or that is
  63.  * rejected with ConsumerDb.Error for a database error.
  64.  */
  65. ConsumerDb.prototype.getKeyPromise = function(keyName, useSync)
  66. {
  67.   return SyncPromise.reject(new Error
  68.     ("ConsumerDb.getKeyPromise is not implemented"));
  69. };
  71. /**
  72.  * Add the key with keyName and keyBlob to the database.
  73.  * @param {Name} keyName The key name.
  74.  * @param {Blob} keyBlob The encoded key.
  75.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  76.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  77.  * an async Promise.
  78.  * @return {Promise|SyncPromise} A promise that fulfills when the key is added,
  79.  * or that is rejected with ConsumerDb.Error if a key with the same keyName
  80.  * already exists, or other database error.
  81.  */
  82. ConsumerDb.prototype.addKeyPromise = function(keyName, keyBlob, useSync)
  83. {
  84.   return SyncPromise.reject(new Error
  85.     ("ConsumerDb.addKeyPromise is not implemented"));
  86. };
  88. /**
  89.  * Delete the key with keyName from the database. If there is no key with
  90.  * keyName, do nothing.
  91.  * @param {Name} keyName The key name.
  92.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  93.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  94.  * an async Promise.
  95.  * @return {Promise|SyncPromise} A promise that fulfills when the key is deleted
  96.  * (or there is no such key), or that is rejected with ConsumerDb.Error for a
  97.  * database error.
  98.  */
  99. ConsumerDb.prototype.deleteKeyPromise = function(keyName, useSync)
  100. {
  101.   return SyncPromise.reject(new Error
  102.     ("ConsumerDb.addKeyPromise is not implemented"));
  103. };