?HAMA

Navigation

Breadcrumbs

/ / home / byroehnu / easepaybiz.easetack.com / node_modules / node-forge / lib

Create

Create File | Create Folder | Upload Files | Run Command

Edit File Size: 7.00 KB

/home/byroehnu/easepaybiz.easetack.com/node_modules/node-forge/lib/ssh.js

Text Base64

/**
 * Functions to output keys in SSH-friendly formats.
 *
 * This is part of the Forge project which may be used under the terms of
 * either the BSD License or the GNU General Public License (GPL) Version 2.
 *
 * See: https://github.com/digitalbazaar/forge/blob/cbebca3780658703d925b61b2caffb1d263a6c1d/LICENSE
 *
 * @author https://github.com/shellac
 */
var forge = require('./forge');
require('./aes');
require('./hmac');
require('./md5');
require('./sha1');
require('./util');

var ssh = module.exports = forge.ssh = forge.ssh || {};

/**
 * Encodes (and optionally encrypts) a private RSA key as a Putty PPK file.
 *
 * @param privateKey the key.
 * @param passphrase a passphrase to protect the key (falsy for no encryption).
 * @param comment a comment to include in the key file.
 *
 * @return the PPK file as a string.
 */
ssh.privateKeyToPutty = function(privateKey, passphrase, comment) {
  comment = comment || '';
  passphrase = passphrase || '';
  var algorithm = 'ssh-rsa';
  var encryptionAlgorithm = (passphrase === '') ? 'none' : 'aes256-cbc';

var ppk = 'PuTTY-User-Key-File-2: ' + algorithm + '\r\n';
  ppk += 'Encryption: ' + encryptionAlgorithm + '\r\n';
  ppk += 'Comment: ' + comment + '\r\n';

// public key into buffer for ppk
  var pubbuffer = forge.util.createBuffer();
  _addStringToBuffer(pubbuffer, algorithm);
  _addBigIntegerToBuffer(pubbuffer, privateKey.e);
  _addBigIntegerToBuffer(pubbuffer, privateKey.n);

// write public key
  var pub = forge.util.encode64(pubbuffer.bytes(), 64);
  var length = Math.floor(pub.length / 66) + 1; // 66 = 64 + \r\n
  ppk += 'Public-Lines: ' + length + '\r\n';
  ppk += pub;

// private key into a buffer
  var privbuffer = forge.util.createBuffer();
  _addBigIntegerToBuffer(privbuffer, privateKey.d);
  _addBigIntegerToBuffer(privbuffer, privateKey.p);
  _addBigIntegerToBuffer(privbuffer, privateKey.q);
  _addBigIntegerToBuffer(privbuffer, privateKey.qInv);

// optionally encrypt the private key
  var priv;
  if(!passphrase) {
    // use the unencrypted buffer
    priv = forge.util.encode64(privbuffer.bytes(), 64);
  } else {
    // encrypt RSA key using passphrase
    var encLen = privbuffer.length() + 16 - 1;
    encLen -= encLen % 16;

// pad private key with sha1-d data -- needs to be a multiple of 16
    var padding = _sha1(privbuffer.bytes());

padding.truncate(padding.length() - encLen + privbuffer.length());
    privbuffer.putBuffer(padding);

var aeskey = forge.util.createBuffer();
    aeskey.putBuffer(_sha1('\x00\x00\x00\x00', passphrase));
    aeskey.putBuffer(_sha1('\x00\x00\x00\x01', passphrase));

// encrypt some bytes using CBC mode
    // key is 40 bytes, so truncate *by* 8 bytes
    var cipher = forge.aes.createEncryptionCipher(aeskey.truncate(8), 'CBC');
    cipher.start(forge.util.createBuffer().fillWithByte(0, 16));
    cipher.update(privbuffer.copy());
    cipher.finish();
    var encrypted = cipher.output;

// Note: this appears to differ from Putty -- is forge wrong, or putty?
    // due to padding we finish as an exact multiple of 16
    encrypted.truncate(16); // all padding

priv = forge.util.encode64(encrypted.bytes(), 64);
  }

// output private key
  length = Math.floor(priv.length / 66) + 1; // 64 + \r\n
  ppk += '\r\nPrivate-Lines: ' + length + '\r\n';
  ppk += priv;

// MAC
  var mackey = _sha1('putty-private-key-file-mac-key', passphrase);

var macbuffer = forge.util.createBuffer();
  _addStringToBuffer(macbuffer, algorithm);
  _addStringToBuffer(macbuffer, encryptionAlgorithm);
  _addStringToBuffer(macbuffer, comment);
  macbuffer.putInt32(pubbuffer.length());
  macbuffer.putBuffer(pubbuffer);
  macbuffer.putInt32(privbuffer.length());
  macbuffer.putBuffer(privbuffer);

var hmac = forge.hmac.create();
  hmac.start('sha1', mackey);
  hmac.update(macbuffer.bytes());

ppk += '\r\nPrivate-MAC: ' + hmac.digest().toHex() + '\r\n';

return ppk;
};

/**
 * Encodes a public RSA key as an OpenSSH file.
 *
 * @param key the key.
 * @param comment a comment.
 *
 * @return the public key in OpenSSH format.
 */
ssh.publicKeyToOpenSSH = function(key, comment) {
  var type = 'ssh-rsa';
  comment = comment || '';

var buffer = forge.util.createBuffer();
  _addStringToBuffer(buffer, type);
  _addBigIntegerToBuffer(buffer, key.e);
  _addBigIntegerToBuffer(buffer, key.n);

return type + ' ' + forge.util.encode64(buffer.bytes()) + ' ' + comment;
};

/**
 * Encodes a private RSA key as an OpenSSH file.
 *
 * @param key the key.
 * @param passphrase a passphrase to protect the key (falsy for no encryption).
 *
 * @return the public key in OpenSSH format.
 */
ssh.privateKeyToOpenSSH = function(privateKey, passphrase) {
  if(!passphrase) {
    return forge.pki.privateKeyToPem(privateKey);
  }
  // OpenSSH private key is just a legacy format, it seems
  return forge.pki.encryptRsaPrivateKey(privateKey, passphrase,
    {legacy: true, algorithm: 'aes128'});
};

/**
 * Gets the SSH fingerprint for the given public key.
 *
 * @param options the options to use.
 *          [md] the message digest object to use (defaults to forge.md.md5).
 *          [encoding] an alternative output encoding, such as 'hex'
 *            (defaults to none, outputs a byte buffer).
 *          [delimiter] the delimiter to use between bytes for 'hex' encoded
 *            output, eg: ':' (defaults to none).
 *
 * @return the fingerprint as a byte buffer or other encoding based on options.
 */
ssh.getPublicKeyFingerprint = function(key, options) {
  options = options || {};
  var md = options.md || forge.md.md5.create();

var type = 'ssh-rsa';
  var buffer = forge.util.createBuffer();
  _addStringToBuffer(buffer, type);
  _addBigIntegerToBuffer(buffer, key.e);
  _addBigIntegerToBuffer(buffer, key.n);

// hash public key bytes
  md.start();
  md.update(buffer.getBytes());
  var digest = md.digest();
  if(options.encoding === 'hex') {
    var hex = digest.toHex();
    if(options.delimiter) {
      return hex.match(/.{2}/g).join(options.delimiter);
    }
    return hex;
  } else if(options.encoding === 'binary') {
    return digest.getBytes();
  } else if(options.encoding) {
    throw new Error('Unknown encoding "' + options.encoding + '".');
  }
  return digest;
};

/**
 * Adds len(val) then val to a buffer.
 *
 * @param buffer the buffer to add to.
 * @param val a big integer.
 */
function _addBigIntegerToBuffer(buffer, val) {
  var hexVal = val.toString(16);
  // ensure 2s complement +ve
  if(hexVal[0] >= '8') {
    hexVal = '00' + hexVal;
  }
  var bytes = forge.util.hexToBytes(hexVal);
  buffer.putInt32(bytes.length);
  buffer.putBytes(bytes);
}

/**
 * Adds len(val) then val to a buffer.
 *
 * @param buffer the buffer to add to.
 * @param val a string.
 */
function _addStringToBuffer(buffer, val) {
  buffer.putInt32(val.length);
  buffer.putString(val);
}

/**
 * Hashes the arguments into one value using SHA-1.
 *
 * @return the sha1 hash of the provided arguments.
 */
function _sha1() {
  var sha = forge.md.sha1.create();
  var num = arguments.length;
  for (var i = 0; i < num; ++i) {
    sha.update(arguments[i]);
  }
  return sha.digest();
}

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 0 × Files: 50

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
.htaccess	127 B	lr--r--r--	2026-03-14 01:49:12	Edit Download recursive recursive
aes.js	38.11 KB	lrw-r--r--	2026-03-05 00:20:01	Edit Download recursive recursive
aesCipherSuites.js	8.90 KB	lrw-r--r--	2026-03-05 00:20:02	Edit Download recursive recursive
asn1-validator.js	2.24 KB	lrw-r--r--	2026-03-05 00:20:02	Edit Download recursive recursive
asn1.js	44.34 KB	lrw-r--r--	2026-03-05 00:20:03	Edit Download recursive recursive
baseN.js	4.95 KB	lrw-r--r--	2026-03-05 00:20:04	Edit Download recursive recursive
cipher.js	6.51 KB	lrw-r--r--	2026-03-05 00:20:05	Edit Download recursive recursive
cipherModes.js	28.24 KB	lrw-r--r--	2026-03-05 00:20:06	Edit Download recursive recursive
des.js	19.97 KB	lrw-r--r--	2026-03-05 00:20:08	Edit Download recursive recursive
ed25519.js	24.36 KB	lrw-r--r--	2026-03-05 00:20:08	Edit Download recursive recursive
forge.js	200 B	lrw-r--r--	2026-03-05 00:20:10	Edit Download recursive recursive
form.js	3.79 KB	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
hmac.js	3.74 KB	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
http.js	38.15 KB	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
index.all.js	366 B	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
index.js	640 B	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
jsbn.js	34.36 KB	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
kem.js	5.09 KB	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
log.js	9.05 KB	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
md.all.js	251 B	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
md.js	253 B	lrw-r--r--	2026-03-05 00:20:12	Edit Download recursive recursive
md5.js	7.80 KB	lrw-r--r--	2026-03-05 00:20:13	Edit Download recursive recursive
mgf.js	274 B	lrw-r--r--	2026-03-05 00:20:13	Edit Download recursive recursive
mgf1.js	1.61 KB	lrw-r--r--	2026-03-05 00:20:13	Edit Download recursive recursive
oids.js	6.68 KB	lrw-r--r--	2026-03-05 00:20:13	Edit Download recursive recursive
pbe.js	30.27 KB	lrw-r--r--	2026-03-05 00:20:13	Edit Download recursive recursive
pbkdf2.js	5.67 KB	lrw-r--r--	2026-03-05 00:20:13	Edit Download recursive recursive
pem.js	6.54 KB	lrw-r--r--	2026-03-05 00:20:13	Edit Download recursive recursive
pkcs1.js	8.18 KB	lrw-r--r--	2026-03-05 00:20:13	Edit Download recursive recursive
pkcs7.js	38.93 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
pkcs7asn1.js	11.21 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
pkcs12.js	32.78 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
pki.js	2.59 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
prime.js	8.57 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
prime.worker.js	4.69 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
prng.js	12.04 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
pss.js	7.67 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
random.js	5.31 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
rc2.js	11.67 KB	lrw-r--r--	2026-03-05 00:20:14	Edit Download recursive recursive
rsa.js	58.66 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
sha1.js	8.88 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
sha256.js	9.35 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
sha512.js	16.73 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
socket.js	8.13 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
ssh.js	7.00 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
tls.js	129.86 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
tlssocket.js	6.80 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
util.js	68.22 KB	lrw-r--r--	2026-03-05 00:20:15	Edit Download recursive recursive
x509.js	99.41 KB	lrw-r--r--	2026-03-05 00:20:16	Edit Download recursive recursive
xhr.js	21.60 KB	lrw-r--r--	2026-03-05 00:20:16	Edit Download recursive recursive