Source: sha256-with-ecdsa-signature.js

  1. /**
  2.  * This class represents an NDN Data Signature object.
  3.  * Copyright (C) 2016-2018 Regents of the University of California.
  4.  * @author: Jeff Thompson <jefft0@remap.ucla.edu>
  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 Blob = require('./util/blob.js').Blob; /** @ignore */
  23. var ChangeCounter = require('./util/change-counter.js').ChangeCounter; /** @ignore */
  24. var KeyLocator = require('./key-locator.js').KeyLocator; /** @ignore */
  25. var ValidityPeriod = require('./security/validity-period.js').ValidityPeriod;
  27. /**
  28.  * Create a new Sha256WithEcdsaSignature object, possibly copying values from
  29.  * another object.
  30.  *
  31.  * @param {Sha256WithEcdsaSignature} value (optional) If value is a
  32.  * Sha256WithEcdsaSignature, copy its values.  If value is omitted, the
  33.  * keyLocator is the default with unspecified values and the signature is
  34.  * unspecified.
  35.  * @constructor
  36.  */
  37. var Sha256WithEcdsaSignature = function Sha256WithEcdsaSignature(value)
  38. {
  39.   if (typeof value === 'object' && value instanceof Sha256WithEcdsaSignature) {
  40.     // Copy the values.
  41.     this.keyLocator_ = new ChangeCounter(new KeyLocator(value.getKeyLocator()));
  42.     this.validityPeriod_ = new ChangeCounter(new ValidityPeriod
  43.       (value.getValidityPeriod()));
  44.     this.signature_ = value.signature_;
  45.   }
  46.   else {
  47.     this.keyLocator_ = new ChangeCounter(new KeyLocator());
  48.     this.validityPeriod_ = new ChangeCounter(new ValidityPeriod());
  49.     this.signature_ = new Blob();
  50.   }
  52.   this.changeCount_ = 0;
  53. };
  55. exports.Sha256WithEcdsaSignature = Sha256WithEcdsaSignature;
  57. /**
  58.  * Create a new Sha256WithEcdsaSignature which is a copy of this object.
  59.  * @return {Sha256WithEcdsaSignature} A new object which is a copy of this
  60.  * object.
  61.  */
  62. Sha256WithEcdsaSignature.prototype.clone = function()
  63. {
  64.   return new Sha256WithEcdsaSignature(this);
  65. };
  67. /**
  68.  * Get the key locator.
  69.  * @return {KeyLocator} The key locator.
  70.  */
  71. Sha256WithEcdsaSignature.prototype.getKeyLocator = function()
  72. {
  73.   return this.keyLocator_.get();
  74. };
  76. /**
  77.  * Get the validity period.
  78.  * @return {ValidityPeriod} The validity period.
  79.  */
  80. Sha256WithEcdsaSignature.prototype.getValidityPeriod = function()
  81. {
  82.   return this.validityPeriod_.get();
  83. };
  85. /**
  86.  * Get the data packet's signature bytes.
  87.  * @return {Blob} The signature bytes. If not specified, the value isNull().
  88.  */
  89. Sha256WithEcdsaSignature.prototype.getSignature = function()
  90. {
  91.   return this.signature_;
  92. };
  94. /**
  95.  * Set the key locator to a copy of the given keyLocator.
  96.  * @param {KeyLocator} keyLocator The KeyLocator to copy.
  97.  */
  98. Sha256WithEcdsaSignature.prototype.setKeyLocator = function(keyLocator)
  99. {
  100.   this.keyLocator_.set(typeof keyLocator === 'object' &&
  101.                        keyLocator instanceof KeyLocator ?
  102.     new KeyLocator(keyLocator) : new KeyLocator());
  103.   ++this.changeCount_;
  104. };
  106. /**
  107.  * Set the validity period to a copy of the given ValidityPeriod.
  108.  * @param {ValidityPeriod} validityPeriod The ValidityPeriod which is copied.
  109.  */
  110. Sha256WithEcdsaSignature.prototype.setValidityPeriod = function(validityPeriod)
  111. {
  112.   this.validityPeriod_.set(typeof validityPeriod === 'object' &&
  113.                            validityPeriod instanceof ValidityPeriod ?
  114.     new ValidityPeriod(validityPeriod) : new ValidityPeriod());
  115.   ++this.changeCount_;
  116. };
  118. /**
  119.  * Set the data packet's signature bytes.
  120.  * @param {Blob} signature
  121.  */
  122. Sha256WithEcdsaSignature.prototype.setSignature = function(signature)
  123. {
  124.   this.signature_ = typeof signature === 'object' && signature instanceof Blob ?
  125.     signature : new Blob(signature);
  126.   ++this.changeCount_;
  127. };
  129. /**
  130.  * Get the change count, which is incremented each time this object (or a child
  131.  * object) is changed.
  132.  * @return {number} The change count.
  133.  */
  134. Sha256WithEcdsaSignature.prototype.getChangeCount = function()
  135. {
  136.   // Make sure each of the checkChanged is called.
  137.   var changed = this.keyLocator_.checkChanged();
  138.   changed = this.validityPeriod_.checkChanged() || changed;
  139.   if (changed)
  140.     // A child object has changed, so update the change count.
  141.     ++this.changeCount_;
  143.   return this.changeCount_;
  144. };