8923813580
Add jsdoc @module definitions. Fix references to old class names. Make keyring a multiple instance module. Eliminate unit test dependency on running npm test.
193 lines
8.6 KiB
HTML
193 lines
8.6 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: packet/public_key.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: packet/public_key.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source"><code>// GPG4Browsers - An OpenPGP implementation in javascript
|
|
// Copyright (C) 2011 Recurity Labs GmbH
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 2.1 of the License, or (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
/** @module packet/public_key */
|
|
|
|
var util = require('../util'),
|
|
type_mpi = require('../type/mpi.js'),
|
|
type_keyid = require('../type/keyid.js'),
|
|
enums = require('../enums.js'),
|
|
crypto = require('../crypto');
|
|
|
|
/**
|
|
* @class
|
|
* @classdesc Implementation of the Key Material Packet (Tag 5,6,7,14)
|
|
*
|
|
* RFC4480 5.5:
|
|
* A key material packet contains all the information about a public or
|
|
* private key. There are four variants of this packet type, and two
|
|
* major versions. Consequently, this section is complex.
|
|
*/
|
|
module.exports = function packet_public_key() {
|
|
/** Key creation date.
|
|
* @type {Date} */
|
|
this.created = new Date();
|
|
/** A list of multiprecision integers
|
|
* @type {module:type/mpi} */
|
|
this.mpi = [];
|
|
/** Public key algorithm
|
|
* @type {openpgp.publickey} */
|
|
this.algorithm = 'rsa_sign';
|
|
|
|
|
|
/**
|
|
* Internal Parser for public keys as specified in RFC 4880 section
|
|
* 5.5.2 Public-Key Packet Formats
|
|
* called by read_tag&lt;num&gt;
|
|
* @param {String} input Input string to read the packet from
|
|
* @param {Integer} position Start position for the parser
|
|
* @param {Integer} len Length of the packet or remaining length of input
|
|
* @return {Object} This object with attributes set by the parser
|
|
*/
|
|
this.readPublicKey = this.read = function(bytes) {
|
|
// A one-octet version number (3 or 4).
|
|
var version = bytes.charCodeAt(0);
|
|
|
|
if (version == 4) {
|
|
// - A four-octet number denoting the time that the key was created.
|
|
this.created = util.readDate(bytes.substr(1, 4));
|
|
|
|
// - A one-octet number denoting the public-key algorithm of this key.
|
|
this.algorithm = enums.read(enums.publicKey, bytes.charCodeAt(5));
|
|
|
|
var mpicount = crypto.getPublicMpiCount(this.algorithm);
|
|
this.mpi = [];
|
|
|
|
var bmpi = bytes.substr(6);
|
|
var p = 0;
|
|
|
|
for (var i = 0; i < mpicount && p < bmpi.length; i++) {
|
|
|
|
this.mpi[i] = new type_mpi();
|
|
|
|
p += this.mpi[i].read(bmpi.substr(p))
|
|
|
|
if (p > bmpi.length)
|
|
util.print_error("openpgp.packet.keymaterial.js\n" + 'error reading MPI @:' + p);
|
|
}
|
|
|
|
return p + 6;
|
|
} else {
|
|
throw new Error('Version ' + version + ' of the key packet is unsupported.');
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Same as write_private_key, but has less information because of
|
|
* public key.
|
|
* @param {Integer} keyType Follows the OpenPGP algorithm standard,
|
|
* IE 1 corresponds to RSA.
|
|
* @param {RSA.keyObject} key
|
|
* @param timePacket
|
|
* @return {Object} {body: [string]OpenPGP packet body contents,
|
|
* header: [string] OpenPGP packet header, string: [string] header+body}
|
|
*/
|
|
this.writePublicKey = this.write = function() {
|
|
// Version
|
|
var result = String.fromCharCode(4);
|
|
result += util.writeDate(this.created);
|
|
result += String.fromCharCode(enums.write(enums.publicKey, this.algorithm));
|
|
|
|
var mpicount = crypto.getPublicMpiCount(this.algorithm);
|
|
|
|
for (var i = 0; i < mpicount; i++) {
|
|
result += this.mpi[i].write();
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
// Write an old version packet - it's used by some of the internal routines.
|
|
this.writeOld = function() {
|
|
var bytes = this.writePublicKey();
|
|
|
|
return String.fromCharCode(0x99) +
|
|
util.writeNumber(bytes.length, 2) +
|
|
bytes;
|
|
}
|
|
|
|
/**
|
|
* Calculates the key id of the key
|
|
* @return {String} A 8 byte key id
|
|
*/
|
|
this.getKeyId = function() {
|
|
var keyid = new type_keyid();
|
|
keyid.read(this.getFingerprint().substr(12, 8));
|
|
return keyid;
|
|
}
|
|
|
|
/**
|
|
* Calculates the fingerprint of the key
|
|
* @return {String} A string containing the fingerprint
|
|
*/
|
|
this.getFingerprint = function() {
|
|
var toHash = this.writeOld();
|
|
return crypto.hash.sha1(toHash, toHash.length);
|
|
}
|
|
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-cleartext.html">cleartext</a></li><li><a href="config.html">config/config</a></li><li><a href="config_localStorage.html">config/config_localStorage</a></li><li><a href="cfb.html">crypto/cfb</a></li><li><a href="aes.html">crypto/cipher/aes</a></li><li><a href="blowfish.html">crypto/cipher/blowfish</a></li><li><a href="cast5.html">crypto/cipher/cast5</a></li><li><a href="des.html">crypto/cipher/des</a></li><li><a href="twofish.html">crypto/cipher/twofish</a></li><li><a href="crypto.html">crypto/crypto</a></li><li><a href="md5.html">crypto/hash/md5</a></li><li><a href="ripe-md.html">crypto/hash/ripe-md</a></li><li><a href="sha.html">crypto/hash/sha</a></li><li><a href="pkcs1.html">crypto/pkcs1</a></li><li><a href="dsa.html">crypto/public_key/dsa</a></li><li><a href="elgamal.html">crypto/public_key/elgamal</a></li><li><a href="jsbn.html">crypto/public_key/jsbn</a></li><li><a href="rsa.html">crypto/public_key/rsa</a></li><li><a href="random.html">crypto/random</a></li><li><a href="signature.html">crypto/signature</a></li><li><a href="armor.html">encoding/armor</a></li><li><a href="base64.html">encoding/base64</a></li><li><a href="module-key.html">key</a></li><li><a href="keyring.html">keyring/keyring</a></li><li><a href="localstore.html">keyring/localstore</a></li><li><a href="module-message.html">message</a></li><li><a href="module-openpgp.html">openpgp</a></li><li><a href="compressed.html">packet/compressed</a></li><li><a href="literal.html">packet/literal</a></li><li><a href="marker.html">packet/marker</a></li><li><a href="one_pass_signature.html">packet/one_pass_signature</a></li><li><a href="packet.html">packet/packet</a></li><li><a href="packetlist.html">packet/packetlist</a></li><li><a href="public_key.html">packet/public_key</a></li><li><a href="public_key_encrypted_session_key.html">packet/public_key_encrypted_session_key</a></li><li><a href="public_subkey.html">packet/public_subkey</a></li><li><a href="secret_key.html">packet/secret_key</a></li><li><a href="secret_subkey.html">packet/secret_subkey</a></li><li><a href="signature_.html">packet/signature</a></li><li><a href="sym_encrypted_integrity_protected.html">packet/sym_encrypted_integrity_protected</a></li><li><a href="sym_encrypted_session_key.html">packet/sym_encrypted_session_key</a></li><li><a href="symmetrically_encrypted.html">packet/symmetrically_encrypted</a></li><li><a href="user_attribute.html">packet/user_attribute</a></li><li><a href="userid.html">packet/userid</a></li><li><a href="keyid.html">type/keyid</a></li><li><a href="mpi.html">type/mpi</a></li><li><a href="s2k.html">type/s2k</a></li><li><a href="util.html">util/util</a></li></ul><h3>Classes</h3><ul><li><a href="JXG.Util.html">Util</a></li><li><a href="module-cleartext-CleartextMessage.html">CleartextMessage</a></li><li><a href="config-config.html">config</a></li><li><a href="module-key-Key.html">Key</a></li><li><a href="module-message-Message.html">Message</a></li><li><a href="util-Util.html">Util</a></li></ul><h3><a href="global.html">Global</a></h3>
|
|
</nav>
|
|
|
|
<br clear="both">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha2</a> on Sun Dec 22 2013 12:37:01 GMT-0800 (PST)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|