Source: encrypt/group-manager-db.js

  1. /**
  2.  * Copyright (C) 2015-2016 Regents of the University of California.
  3.  * @author: Jeff Thompson <jefft0@remap.ucla.edu>
  4.  * @author: From ndn-group-encrypt src/group-manager-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.  * GroupManagerDb is a base class for the storage of data used by the
  26.  * GroupManager. It contains two tables to store Schedules and Members.
  27.  * This is an abstract base class. A subclass must implement the methods.
  28.  * For example, see Sqlite3GroupManagerDb (for Nodejs) or IndexedDbGroupManagerDb
  29.  * (for the browser).
  30.  * @note This class is an experimental feature. The API may change.
  31.  * @constructor
  32.  */
  33. var GroupManagerDb = function GroupManagerDb()
  34. {
  35. };
  37. exports.GroupManagerDb = GroupManagerDb;
  39. /**
  40.  * Create a new GroupManagerDb.Error to report an error using GroupManagerDb
  41.  * methods, wrapping the given error object.
  42.  * Call with: throw new GroupManagerDb.Error(new Error("message")).
  43.  * @constructor
  44.  * @param {Error} error The exception created with new Error.
  45.  */
  46. GroupManagerDb.Error = function GroupManagerDbError(error)
  47. {
  48.   if (error) {
  49.     // Copy lineNumber, etc. from where new Error was called.
  50.     for (var prop in error)
  51.       this[prop] = error[prop];
  52.     // Make sure these are copied.
  53.     this.message = error.message;
  54.     this.stack = error.stack;
  55.   }
  56. }
  58. GroupManagerDb.Error.prototype = new Error();
  59. GroupManagerDb.Error.prototype.name = "GroupManagerDbError";
  61. ////////////////////////////////////////////////////// Schedule management.
  63. /**
  64.  * Check if there is a schedule with the given name.
  65.  * @param {string} name The name of the schedule.
  66.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  67.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  68.  * an async Promise.
  69.  * @return {Promise|SyncPromise} A promise that returns true if there is a
  70.  * schedule (else false), or that is rejected with GroupManagerDb.Error for a
  71.  * database error.
  72.  */
  73. GroupManagerDb.prototype.hasSchedulePromise = function(name, useSync)
  74. {
  75.   return SyncPromise.reject(new Error
  76.     ("GroupManagerDb.hasSchedulePromise is not implemented"));
  77. };
  79. /**
  80.  * List all the names of the schedules.
  81.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  82.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  83.  * an async Promise.
  84.  * @return {Promise|SyncPromise} A promise that returns a new array of string
  85.  * with the names of all schedules, or that is rejected with
  86.  * GroupManagerDb.Error for a database error.
  87.  */
  88. GroupManagerDb.prototype.listAllScheduleNamesPromise = function(useSync)
  89. {
  90.   return SyncPromise.reject(new Error
  91.     ("GroupManagerDb.listAllScheduleNamesPromise is not implemented"));
  92. };
  94. /**
  95.  * Get a schedule with the given name.
  96.  * @param {string} name The name of the schedule.
  97.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  98.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  99.  * an async Promise.
  100.  * @return {Promise|SyncPromise} A promise that returns a new Schedule object,
  101.  * or that is rejected with GroupManagerDb.Error if the schedule does not exist
  102.  * or other database error.
  103.  */
  104. GroupManagerDb.prototype.getSchedulePromise = function(name, useSync)
  105. {
  106.   return SyncPromise.reject(new Error
  107.     ("GroupManagerDb.getSchedulePromise is not implemented"));
  108. };
  110. /**
  111.  * For each member using the given schedule, get the name and public key DER
  112.  * of the member's key.
  113.  * @param {string} name The name of the schedule.
  114.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  115.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  116.  * an async Promise.
  117.  * @return {Promise|SyncPromise} A promise that returns a new array of object
  118.  * (where "keyName" is the Name of the public key and "publicKey" is the Blob of
  119.  * the public key DER), or that is rejected with GroupManagerDb.Error for a
  120.  * database error. Note that the member's identity name is keyName.getPrefix(-1).
  121.  * If the schedule name is not found, the list is empty.
  122.  */
  123. GroupManagerDb.prototype.getScheduleMembersPromise = function
  124.   (name, useSync)
  125. {
  126.   return SyncPromise.reject(new Error
  127.     ("GroupManagerDb.getScheduleMembersPromise is not implemented"));
  128. };
  130. /**
  131.  * Add a schedule with the given name.
  132.  * @param {string} name The name of the schedule. The name cannot be empty.
  133.  * @param {Schedule} schedule The Schedule to add.
  134.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  135.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  136.  * an async Promise.
  137.  * @return {Promise|SyncPromise} A promise that fulfills when the schedule is
  138.  * added, or that is rejected with GroupManagerDb.Error if a schedule with the
  139.  * same name already exists, if the name is empty, or other database error.
  140.  */
  141. GroupManagerDb.prototype.addSchedulePromise = function(name, schedule, useSync)
  142. {
  143.   return SyncPromise.reject(new Error
  144.     ("GroupManagerDb.addSchedulePromise is not implemented"));
  145. };
  147. /**
  148.  * Delete the schedule with the given name. Also delete members which use this
  149.  * schedule. If there is no schedule with the name, then do nothing.
  150.  * @param {string} name The name of the schedule.
  151.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  152.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  153.  * an async Promise.
  154.  * @return {Promise|SyncPromise} A promise that fulfills when the schedule is
  155.  * deleted (or there is no such schedule), or that is rejected with
  156.  * GroupManagerDb.Error for a database error.
  157.  */
  158. GroupManagerDb.prototype.deleteSchedulePromise = function(name, useSync)
  159. {
  160.   return SyncPromise.reject(new Error
  161.     ("GroupManagerDb.deleteSchedulePromise is not implemented"));
  162. };
  164. /**
  165.  * Rename a schedule with oldName to newName.
  166.  * @param {string} oldName The name of the schedule to be renamed.
  167.  * @param {string} newName The new name of the schedule. The name cannot be empty.
  168.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  169.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  170.  * an async Promise.
  171.  * @return {Promise|SyncPromise} A promise that fulfills when the schedule is
  172.  * renamed, or that is rejected with GroupManagerDb.Error if a schedule with
  173.  * newName already exists, if the schedule with oldName does not exist, if
  174.  * newName is empty, or other database error.
  175.  */
  176. GroupManagerDb.prototype.renameSchedulePromise = function
  177.   (oldName, newName, useSync)
  178. {
  179.   return SyncPromise.reject(new Error
  180.     ("GroupManagerDb.renameSchedulePromise is not implemented"));
  181. };
  183. /**
  184.  * Update the schedule with name and replace the old object with the given
  185.  * schedule. Otherwise, if no schedule with name exists, a new schedule
  186.  * with name and the given schedule will be added to database.
  187.  * @param {string} name The name of the schedule. The name cannot be empty.
  188.  * @param {Schedule} schedule The Schedule to update or add.
  189.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  190.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  191.  * an async Promise.
  192.  * @return {Promise|SyncPromise} A promise that fulfills when the schedule is
  193.  * updated, or that is rejected with GroupManagerDb.Error if the name is empty,
  194.  * or other database error.
  195.  */
  196. GroupManagerDb.prototype.updateSchedulePromise = function
  197.   (name, schedule, useSync)
  198. {
  199.   return SyncPromise.reject(new Error
  200.     ("GroupManagerDb.updateSchedulePromise is not implemented"));
  201. };
  203. ////////////////////////////////////////////////////// Member management.
  205. /**
  206.  * Check if there is a member with the given identity name.
  207.  * @param {Name} identity The member's identity name.
  208.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  209.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  210.  * an async Promise.
  211.  * @return {Promise|SyncPromise} A promise that returns true if there is a
  212.  * member (else false), or that is rejected with GroupManagerDb.Error for a
  213.  * database error.
  214.  */
  215. GroupManagerDb.prototype.hasMemberPromise = function(identity, useSync)
  216. {
  217.   return SyncPromise.reject(new Error
  218.     ("GroupManagerDb.hasMemberPromise is not implemented"));
  219. };
  221. /**
  222.  * List all the members.
  223.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  224.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  225.  * an async Promise.
  226.  * @return {Promise|SyncPromise} A promise that returns a new array of Name with
  227.  * the names of all members, or that is rejected with GroupManagerDb.Error for a
  228.  * database error.
  229.  */
  230. GroupManagerDb.prototype.listAllMembersPromise = function(useSync)
  231. {
  232.   return SyncPromise.reject(new Error
  233.     ("GroupManagerDb.listAllMembersPromise is not implemented"));
  234. };
  236. /**
  237.  * Get the name of the schedule for the given member's identity name.
  238.  * @param {Name} identity The member's identity name.
  239.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  240.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  241.  * an async Promise.
  242.  * @return {Promise|SyncPromise} A promise that returns the string schedule name,
  243.  * or that is rejected with GroupManagerDb.Error if there's no member with the
  244.  * given identity name in the database, or other database error.
  245.  */
  246. GroupManagerDb.prototype.getMemberSchedulePromise = function(identity, useSync)
  247. {
  248.   return SyncPromise.reject(new Error
  249.     ("GroupManagerDb.getMemberSchedulePromise is not implemented"));
  250. };
  252. /**
  253.  * Add a new member with the given key named keyName into a schedule named
  254.  * scheduleName. The member's identity name is keyName.getPrefix(-1).
  255.  * @param {string} scheduleName The schedule name.
  256.  * @param {Name} keyName The name of the key.
  257.  * @param {Blob} key A Blob of the public key DER.
  258.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  259.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  260.  * an async Promise.
  261.  * @return {Promise|SyncPromise} A promise that fulfills when the member is
  262.  * added, or that is rejected with GroupManagerDb.Error if there's no schedule
  263.  * named scheduleName, if the member's identity name already exists, or other
  264.  * database error.
  265.  */
  266. GroupManagerDb.prototype.addMemberPromise = function
  267.   (scheduleName, keyName, key, useSync)
  268. {
  269.   return SyncPromise.reject(new Error
  270.     ("GroupManagerDb.addMemberPromise is not implemented"));
  271. };
  273. /**
  274.  * Change the name of the schedule for the given member's identity name.
  275.  * @param {Name} identity The member's identity name.
  276.  * @param {string} scheduleName The new schedule name.
  277.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  278.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  279.  * an async Promise.
  280.  * @return {Promise|SyncPromise} A promise that fulfills when the member is
  281.  * updated, or that is rejected with GroupManagerDb.Error if there's no member
  282.  * with the given identity name in the database, or there's no schedule named
  283.  * scheduleName, or other database error.
  284.  */
  285. GroupManagerDb.prototype.updateMemberSchedulePromise = function
  286.   (identity, scheduleName, useSync)
  287. {
  288.   return SyncPromise.reject(new Error
  289.     ("GroupManagerDb.updateMemberSchedulePromise is not implemented"));
  290. };
  292. /**
  293.  * Delete a member with the given identity name. If there is no member with
  294.  * the identity name, then do nothing.
  295.  * @param {Name} identity The member's identity name.
  296.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  297.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  298.  * an async Promise.
  299.  * @return {Promise|SyncPromise} A promise that fulfills when the member is
  300.  * deleted (or there is no such member), or that is rejected with
  301.  * GroupManagerDb.Error for a database error.
  302.  */
  303. GroupManagerDb.prototype.deleteMemberPromise = function(identity, useSync)
  304. {
  305.   return SyncPromise.reject(new Error
  306.     ("GroupManagerDb.deleteMemberPromise is not implemented"));
  307. };