Source: security/tpm/tpm-key-handle.js

  1. /**
  2.  * Copyright (C) 2017-2018 Regents of the University of California.
  3.  * @author: Jeff Thompson <jefft0@remap.ucla.edu>
  4.  * @author: From ndn-cxx security https://github.com/named-data/ndn-cxx/blob/master/src/security/tpm/key-handle.cpp
  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 Name = require('../../name.js').Name; /** @ignore */
  23. var SyncPromise = require('../../util/sync-promise.js').SyncPromise;
  25. /**
  26.  * TpmKeyHandle is an abstract base class for a TPM key handle, which provides
  27.  * an interface to perform cryptographic operations with a key in the TPM.
  28.  * @constructor
  29.  */
  30. var TpmKeyHandle = function TpmKeyHandle()
  31. {
  32.   this.keyName_ = new Name();
  33. };
  35. exports.TpmKeyHandle = TpmKeyHandle;
  37. /**
  38.  * Compute a digital signature from the byte buffer using this key with
  39.  * digestAlgorithm.
  40.  * @param {number} digestAlgorithm The digest algorithm as an int from the
  41.  * DigestAlgorithm enum.
  42.  * @param {Buffer} data The input byte buffer.
  43.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  44.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  45.  * an async Promise.
  46.  * @return {Promise|SyncPromise} A promise which returns the signature Blob (or
  47.  * an isNull Blob for an unrecognized digestAlgorithm), or a promise rejected
  48.  * with TpmBackEnd.Error for an error in signing.
  49.  */
  50. TpmKeyHandle.prototype.signPromise = function(digestAlgorithm, data, useSync)
  51. {
  52.   return this.doSignPromise_(digestAlgorithm, data, useSync);
  53. };
  55. /**
  56.  * Return the plain text which is decrypted from cipherText using this key.
  57.  * @param {Buffer} cipherText The cipher text byte buffer.
  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 which returns the decrypted data Blob,
  62.  * or a promise rejected with TpmPrivateKey.Error for error decrypting.
  63.  */
  64. TpmKeyHandle.prototype.decryptPromise = function(cipherText, useSync)
  65. {
  66.   return this.doDecryptPromise_(cipherText, useSync);
  67. };
  69. /**
  70.  * Get the encoded public key derived from this key.
  71.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  72.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  73.  * an async Promise.
  74.  * @return {Blob} The public key encoding Blob.
  75.  */
  76. TpmKeyHandle.prototype.derivePublicKey = function(useSync)
  77. {
  78.   return this.doDerivePublicKey_(useSync);
  79. };
  81. TpmKeyHandle.prototype.setKeyName = function(keyName)
  82. {
  83.   this.keyName_ = new Name(keyName);
  84. };
  86. TpmKeyHandle.prototype.getKeyName = function() { return this.keyName_; };
  88. /**
  89.  * A protected method to do the work of sign().
  90.  * @param {Buffer} data The input byte buffer.
  91.  * @param {number} digestAlgorithm The digest algorithm as an int from the
  92.  * DigestAlgorithm enum.
  93.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  94.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  95.  * an async Promise.
  96.  * @return {Promise|SyncPromise} A promise which returns the signature Blob (or
  97.  * an isNull Blob for an unrecognized digestAlgorithm), or a promise rejected
  98.  * with TpmBackEnd.Error for an error in signing.
  99.  */
  100. TpmKeyHandle.prototype.doSignPromise_ = function(digestAlgorithm, data, useSync)
  101. {
  102.   return SyncPromise.reject(new Error
  103.     ("TpmKeyHandle.doSignPromise_ is not implemented"));
  104. };
  106. /**
  107.  * A protected method to do the work of decrypt().
  108.  * @param {Buffer} cipherText The cipher text byte buffer.
  109.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  110.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  111.  * an async Promise.
  112.  * @return {Promise|SyncPromise} A promise which returns the decrypted data Blob,
  113.  * or a promise rejected with TpmPrivateKey.Error for error decrypting.
  114.  */
  115. TpmKeyHandle.prototype.doDecryptPromise_ = function(cipherText, useSync)
  116. {
  117.   return SyncPromise.reject(new Error
  118.     ("TpmKeyHandle.doDecryptPromise_ is not implemented"));
  119. };
  121. /**
  122.  * A protected method to do the work of derivePublicKey().
  123.  * @param {boolean} useSync (optional) If true then return a SyncPromise which
  124.  * is already fulfilled. If omitted or false, this may return a SyncPromise or
  125.  * an async Promise.
  126.  * @return {Blob} The public key encoding Blob.
  127.  */
  128. TpmKeyHandle.prototype.doDerivePublicKey_ = function(useSync)
  129. {
  130.   return SyncPromise.reject(new Error
  131.     ("TpmKeyHandle.doDerivePublicKey_ is not implemented"));
  132. };