Source: util/command-interest-generator.js

  1. /**
  2.  * Copyright (C) 2014-2018 Regents of the University of California.
  3.  * @author: Jeff Thompson <jefft0@remap.ucla.edu>
  4.  *
  5.  * This program is free software: you can redistribute it and/or modify
  6.  * it under the terms of the GNU Lesser General Public License as published by
  7.  * the Free Software Foundation, either version 3 of the License, or
  8.  * (at your option) any later version.
  9.  *
  10.  * This program is distributed in the hope that it will be useful,
  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13.  * GNU Lesser General Public License for more details.
  14.  *
  15.  * You should have received a copy of the GNU Lesser General Public License
  16.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17.  * A copy of the GNU Lesser General Public License is in the file COPYING.
  18.  */
  20. var WireFormat = require('../encoding/wire-format.js').WireFormat; /** @ignore */
  21. var CommandInterestPreparer = require('../security/command-interest-preparer.js').CommandInterestPreparer;
  23. /**
  24.  * A CommandInterestGenerator keeps track of a timestamp and generates command
  25.  * interests according to the NFD Signed Command Interests protocol:
  26.  * http://redmine.named-data.net/projects/nfd/wiki/Command_Interests
  27.  *
  28.  * Create a new CommandInterestGenerator and initialize the timestamp to now.
  29.  * @constructor
  30.  */
  31. var CommandInterestGenerator = function CommandInterestGenerator()
  32. {
  33.   // Call the base constructor.
  34.   CommandInterestPreparer.call(this);
  35. };
  37. CommandInterestGenerator.prototype = new CommandInterestPreparer();
  38. CommandInterestGenerator.prototype.name = "CommandInterestGenerator";
  40. exports.CommandInterestGenerator = CommandInterestGenerator;
  42. /**
  43.  * Append a timestamp component and a random value component to interest's name.
  44.  * This ensures that the timestamp is greater than the timestamp used in the
  45.  * previous call. Then use keyChain to sign the interest which appends a
  46.  * SignatureInfo component and a component with the signature bits. If the
  47.  * interest lifetime is not set, this sets it.
  48.  * @param {Interest} interest The interest whose name is append with components.
  49.  * @param {KeyChain} keyChain The KeyChain for calling sign.
  50.  * @param {Name} certificateName The certificate name of the key to use for
  51.  * signing.
  52.  * @param {WireFormat} wireFormat (optional) A WireFormat object used to encode
  53.  * the SignatureInfo and to encode interest name for signing. If omitted, use
  54.  * WireFormat.getDefaultWireFormat().
  55.  * @param {function} onComplete (optional) This calls onComplete() when complete.
  56.  * (Some crypto/database libraries only use a callback, so onComplete is
  57.  * required to use these.)
  58.  */
  59. CommandInterestGenerator.prototype.generate = function
  60.   (interest, keyChain, certificateName, wireFormat, onComplete)
  61. {
  62.   onComplete = (typeof wireFormat === "function") ? wireFormat : onComplete;
  63.   wireFormat = (typeof wireFormat === "function" || !wireFormat) ?
  64.     WireFormat.getDefaultWireFormat() : wireFormat;
  66.   this.prepareCommandInterestName(interest, wireFormat);
  67.   keyChain.sign(interest, certificateName, wireFormat, function() {
  68.     if (interest.getInterestLifetimeMilliseconds() == null ||
  69.         interest.getInterestLifetimeMilliseconds() < 0)
  70.       // The caller has not set the interest lifetime, so set it here.
  71.       interest.setInterestLifetimeMilliseconds(1000.0);
  73.     if (onComplete)
  74.       onComplete();
  75.   });
  76. };