From f436c854828a8b0589a8f89a821f5ac03414982d Mon Sep 17 00:00:00 2001 From: Robert Nelson Date: Sun, 5 Jan 2014 23:10:19 -0800 Subject: [PATCH] Add a bunch of links to documentation --- doc/JXG.Util.html | 4 +- doc/aes.html | 4 +- doc/aes.js.html | 4 +- doc/all_packets.js.html | 22 +- doc/armor.html | 4 +- doc/armor.js.html | 4 +- doc/base64.html | 4 +- doc/base64.js.html | 4 +- doc/blowfish.html | 4 +- doc/blowfish.js.html | 4 +- doc/cast5.html | 4 +- doc/cast5.js.html | 4 +- doc/cfb.html | 8 +- doc/cfb.js.html | 8 +- doc/cipher.html | 4 +- doc/cleartext.js.html | 6 +- doc/compressed-Compressed.html | 4 +- doc/compressed.html | 6 +- doc/compressed.js.html | 6 +- doc/config.html | 4 +- doc/config.js.html | 4 +- doc/crypto.html | 20 +- doc/crypto.js.html | 12 +- doc/des.html | 4 +- doc/des.js.html | 4 +- doc/dsa.html | 4 +- doc/dsa.js.html | 4 +- doc/elgamal.html | 4 +- doc/elgamal.js.html | 4 +- doc/enums.js.html | 12 +- doc/hash.html | 12 +- doc/index.html | 4 +- doc/index.js.html | 4 +- doc/index.js_.html | 4 +- doc/index.js__.html | 4 +- doc/index.js___.html | 8 +- doc/index.js____.html | 4 +- doc/index.js_____.html | 64 ++ doc/jsbn.html | 4 +- doc/jsbn.js.html | 4 +- doc/jxg.js.html | 4 +- doc/key.js.html | 10 +- doc/keyid-Keyid.html | 4 +- doc/keyid.html | 6 +- doc/keyid.js.html | 6 +- doc/keyring-Keyring.html | 4 +- doc/keyring.html | 4 +- doc/keyring.js.html | 4 +- doc/literal-Literal.html | 4 +- doc/literal.html | 6 +- doc/literal.js.html | 6 +- doc/localStorage-LocalStorage.html | 4 +- doc/localStorage.html | 4 +- doc/localStorage.js.html | 4 +- doc/localstore.html | 4 +- doc/localstore.js.html | 4 +- doc/marker-Marker.html | 4 +- doc/marker.html | 6 +- doc/marker.js.html | 6 +- doc/md5.html | 4 +- doc/md5.js.html | 4 +- doc/message.js.html | 6 +- doc/module-armor.html | 4 +- doc/module-cleartext-CleartextMessage.html | 6 +- doc/module-cleartext.html | 4 +- doc/module-config.html | 4 +- doc/module-crypto.html | 4 +- doc/module-enums.html | 12 +- doc/module-key-Key.html | 4 +- doc/module-key-SubKey.html | 4 +- doc/module-key-User.html | 4 +- doc/module-key.html | 10 +- doc/module-keyid.html | 4 +- doc/module-message-Message.html | 6 +- doc/module-message.html | 4 +- doc/module-mpi.html | 4 +- doc/module-openpgp.html | 10 +- doc/module-packet.html | 339 +++++++++- doc/module-s2k.html | 4 +- doc/module-util.html | 4 +- doc/mpi-Mpi.html | 8 +- doc/mpi.html | 6 +- doc/mpi.js.html | 10 +- doc/one_pass_signature-OnePassSignature.html | 10 +- doc/one_pass_signature.html | 7 +- doc/one_pass_signature.js.html | 13 +- doc/openpgp.js.html | 8 +- doc/packet.html | 4 +- doc/packet.js.html | 4 +- doc/packetlist-Packetlist.html | 4 +- doc/packetlist.html | 4 +- doc/packetlist.js.html | 4 +- doc/pkcs1.html | 6 +- doc/pkcs1.js.html | 16 +- doc/public_key-PublicKey.html | 139 +++- doc/public_key.html | 4 +- doc/public_key.js.html | 15 +- doc/public_key_.html | 162 +---- ...sion_key-PublicKeyEncryptedSessionKey.html | 12 +- doc/public_key_encrypted_session_key.html | 6 +- doc/public_key_encrypted_session_key.js.html | 14 +- doc/public_subkey-PublicSubkey.html | 170 +---- doc/public_subkey.html | 4 +- doc/public_subkey.js.html | 4 +- doc/random.html | 4 +- doc/random.js.html | 4 +- doc/ripe-md.html | 4 +- doc/ripe-md.js.html | 4 +- doc/rsa.html | 4 +- doc/rsa.js.html | 4 +- doc/s2k-S2k.html | 6 +- doc/s2k.html | 6 +- doc/s2k.js.html | 8 +- doc/secret_key-SecretKey.html | 625 ++++++++++++++++++ doc/secret_key.html | 253 +------ doc/secret_key.js.html | 12 +- doc/secret_subkey-SecretSubkey.html | 170 +---- doc/secret_subkey.html | 4 +- doc/secret_subkey.js.html | 4 +- doc/sha.html | 4 +- doc/sha.js.html | 4 +- doc/signature-Signature.html | 4 +- doc/signature.html | 16 +- doc/signature.js.html | 12 +- doc/signature.js_.html | 12 +- doc/signature_.html | 12 +- ...tected-SymEncryptedIntegrityProtected.html | 14 +- doc/sym_encrypted_integrity_protected.html | 7 +- doc/sym_encrypted_integrity_protected.js.html | 9 +- ...ed_session_key-SymEncryptedSessionKey.html | 4 +- doc/sym_encrypted_session_key.html | 6 +- doc/sym_encrypted_session_key.js.html | 6 +- ...ally_encrypted-SymmetricallyEncrypted.html | 8 +- doc/symmetrically_encrypted.html | 6 +- doc/symmetrically_encrypted.js.html | 10 +- doc/trust-Trust.html | 4 +- doc/trust.html | 4 +- doc/trust.js.html | 4 +- doc/twofish.html | 4 +- doc/twofish.js.html | 4 +- doc/user_attribute-UserAttribute.html | 4 +- doc/user_attribute.html | 4 +- doc/user_attribute.js.html | 4 +- doc/userid-Userid.html | 4 +- doc/userid.html | 4 +- doc/userid.js.html | 4 +- doc/util.html | 4 +- doc/util.js.html | 4 +- src/cleartext.js | 2 +- src/crypto/cfb.js | 4 +- src/crypto/crypto.js | 8 +- src/crypto/hash/index.js | 4 +- src/crypto/pkcs1.js | 12 +- src/crypto/signature.js | 8 +- src/enums.js | 8 +- src/key.js | 6 +- src/message.js | 2 +- src/openpgp.js | 4 +- src/packet/all_packets.js | 18 +- src/packet/compressed.js | 2 +- src/packet/index.js | 4 + src/packet/literal.js | 2 +- src/packet/marker.js | 2 +- src/packet/one_pass_signature.js | 9 +- src/packet/public_key.js | 11 +- .../public_key_encrypted_session_key.js | 10 +- src/packet/secret_key.js | 8 +- src/packet/signature.js | 8 +- .../sym_encrypted_integrity_protected.js | 5 +- src/packet/sym_encrypted_session_key.js | 2 +- src/packet/symmetrically_encrypted.js | 6 +- src/type/keyid.js | 2 +- src/type/mpi.js | 6 +- src/type/s2k.js | 4 +- 174 files changed, 1687 insertions(+), 1237 deletions(-) create mode 100644 doc/index.js_____.html create mode 100644 doc/secret_key-SecretKey.html diff --git a/doc/JXG.Util.html b/doc/JXG.Util.html index 6a1eb63c..79787762 100644 --- a/doc/JXG.Util.html +++ b/doc/JXG.Util.html @@ -554,13 +554,13 @@ EXAMPLES:
diff --git a/doc/aes.html b/doc/aes.html index 59ee6484..79e76c16 100644 --- a/doc/aes.html +++ b/doc/aes.html @@ -111,13 +111,13 @@
diff --git a/doc/aes.js.html b/doc/aes.js.html index 394dfb9b..6ad3345e 100644 --- a/doc/aes.js.html +++ b/doc/aes.js.html @@ -546,13 +546,13 @@ for (var i in types) {
diff --git a/doc/all_packets.js.html b/doc/all_packets.js.html index 36ccfd48..2a0ad087 100644 --- a/doc/all_packets.js.html +++ b/doc/all_packets.js.html @@ -66,17 +66,27 @@ module.exports = { Signature: require('./signature.js'), /** @see module:packet/trust */ Trust: require('./trust.js'), - + /** + * Allocate a new packet + * @param {String} tag property name from {@link module:enums.packet} + * @returns {Object} new packet object with type based on tag + */ newPacketFromTag: function (tag) { - return new this[packetClassFromTag(tag)](); + return new this[packetClassFromTagName(tag)](); } }; -function packetClassFromTag(tag) { +/** + * Convert tag name to class name + * @param {String} tag property name from {@link module:enums.packet} + * @returns {String} + */ +function packetClassFromTagName(tag) { return tag.substr(0, 1).toUpperCase() + tag.substr(1); } + for (var i in enums.packet) { - var packetClass = module.exports[packetClassFromTag(i)]; + var packetClass = module.exports[packetClassFromTagName(i)]; if (packetClass !== undefined) packetClass.prototype.tag = enums.packet[i]; @@ -91,13 +101,13 @@ for (var i in enums.packet) {
diff --git a/doc/armor.html b/doc/armor.html index e8b4107c..9545418e 100644 --- a/doc/armor.html +++ b/doc/armor.html @@ -1358,13 +1358,13 @@ given base64 encoded checksum
diff --git a/doc/armor.js.html b/doc/armor.js.html index 5f8f97b0..05213549 100644 --- a/doc/armor.js.html +++ b/doc/armor.js.html @@ -413,13 +413,13 @@ module.exports = {
diff --git a/doc/base64.html b/doc/base64.html index 73d80009..252f73ce 100644 --- a/doc/base64.html +++ b/doc/base64.html @@ -387,13 +387,13 @@
diff --git a/doc/base64.js.html b/doc/base64.js.html index 92f2fd83..a37e32f4 100644 --- a/doc/base64.js.html +++ b/doc/base64.js.html @@ -136,13 +136,13 @@ module.exports = {
diff --git a/doc/blowfish.html b/doc/blowfish.html index 54ead50b..47383f36 100644 --- a/doc/blowfish.html +++ b/doc/blowfish.html @@ -105,13 +105,13 @@
diff --git a/doc/blowfish.js.html b/doc/blowfish.js.html index 72c370ac..73f18bb2 100644 --- a/doc/blowfish.js.html +++ b/doc/blowfish.js.html @@ -451,13 +451,13 @@ module.exports.blockSize = BF.prototype.blockSize = 16;
diff --git a/doc/cast5.html b/doc/cast5.html index 2dd7d523..c6de4314 100644 --- a/doc/cast5.html +++ b/doc/cast5.html @@ -105,13 +105,13 @@
diff --git a/doc/cast5.js.html b/doc/cast5.js.html index 9d9bc7f8..920d8284 100644 --- a/doc/cast5.js.html +++ b/doc/cast5.js.html @@ -642,13 +642,13 @@ module.exports.keySize = cast5.prototype.keySize = 16;
diff --git a/doc/cfb.html b/doc/cfb.html index a6a7ebc1..9ea2a11c 100644 --- a/doc/cfb.html +++ b/doc/cfb.html @@ -164,7 +164,7 @@ blockcipher to decrypt a message the algorithm cipher class to decrypt - data in one block_size encryption, @see module:crypto/cipher. + data in one block_size encryption, module:crypto/cipher. @@ -402,7 +402,7 @@ using the specified blockcipher to encrypt a message the algorithm cipher class to encrypt - data in one block_size encryption, @see module:crypto/cipher. + data in one block_size encryption, module:crypto/cipher. @@ -762,13 +762,13 @@ This will be passed to the cipherfn
diff --git a/doc/cfb.js.html b/doc/cfb.js.html index 0ce6b808..2662fa0f 100644 --- a/doc/cfb.js.html +++ b/doc/cfb.js.html @@ -59,7 +59,7 @@ module.exports = { * @param {String} prefixrandom random bytes of block_size length provided * as a string to be used in prefixing the data * @param {String} cipherfn the algorithm cipher class to encrypt - * data in one block_size encryption, @see module:crypto/cipher. + * data in one block_size encryption, {@link module:crypto/cipher}. * @param {String} plaintext data to be encrypted provided as a string * @param {String} key binary string representation of key to be used to encrypt the plaintext. * This will be passed to the cipherfn @@ -201,7 +201,7 @@ module.exports = { * This function decrypts a given plaintext using the specified * blockcipher to decrypt a message * @param {String} cipherfn the algorithm cipher class to decrypt - * data in one block_size encryption, @see module:crypto/cipher. + * data in one block_size encryption, {@link module:crypto/cipher}. * @param {String} key binary string representation of key to be used to decrypt the ciphertext. * This will be passed to the cipherfn * @param {String} ciphertext to be decrypted provided as a string @@ -335,13 +335,13 @@ module.exports = {
diff --git a/doc/cipher.html b/doc/cipher.html index 9a15e5e3..77ee5b53 100644 --- a/doc/cipher.html +++ b/doc/cipher.html @@ -406,13 +406,13 @@
diff --git a/doc/cleartext.js.html b/doc/cleartext.js.html index 60a981b7..3347600d 100644 --- a/doc/cleartext.js.html +++ b/doc/cleartext.js.html @@ -58,7 +58,7 @@ var config = require('./config'), /** * @class * @classdesc Class that represents an OpenPGP cleartext signed message. - * See http://tools.ietf.org/html/rfc4880#section-7 + * See {@link http://tools.ietf.org/html/rfc4880#section-7} * @param {String} text The cleartext of the signed message * @param {module:packet/packetlist} packetlist The packetlist with signature packets or undefined * if message not yet signed @@ -185,13 +185,13 @@ exports.readArmored = readArmored;
diff --git a/doc/compressed-Compressed.html b/doc/compressed-Compressed.html index 2f053989..0727fe45 100644 --- a/doc/compressed-Compressed.html +++ b/doc/compressed-Compressed.html @@ -680,13 +680,13 @@ read by read_packet
diff --git a/doc/compressed.html b/doc/compressed.html index d38dd089..216d2de4 100644 --- a/doc/compressed.html +++ b/doc/compressed.html @@ -40,7 +40,7 @@
Implementation of the Compressed Data Packet (Tag 8)

-RFC4880 5.6: The Compressed Data packet contains compressed data. Typically, +RFC4880 5.6: The Compressed Data packet contains compressed data. Typically, this packet is found as the contents of an encrypted packet, or following a Signature or One-Pass Signature packet, and contains a literal data packet.
@@ -128,13 +128,13 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.
diff --git a/doc/compressed.js.html b/doc/compressed.js.html index 8478a89a..a97dbf41 100644 --- a/doc/compressed.js.html +++ b/doc/compressed.js.html @@ -45,7 +45,7 @@ /** * Implementation of the Compressed Data Packet (Tag 8)<br/> * <br/> - * RFC4880 5.6: The Compressed Data packet contains compressed data. Typically, + * {@link http://tools.ietf.org/html/rfc4880#section-5.6|RFC4880 5.6}: The Compressed Data packet contains compressed data. Typically, * this packet is found as the contents of an encrypted packet, or following * a Signature or One-Pass Signature packet, and contains a literal data packet. * @requires compression/jxg @@ -204,13 +204,13 @@ Compressed.prototype.compress = function () {
diff --git a/doc/config.html b/doc/config.html index 20fded96..d04f488e 100644 --- a/doc/config.html +++ b/doc/config.html @@ -325,13 +325,13 @@
diff --git a/doc/config.js.html b/doc/config.js.html index bf0b0928..01d3ec6d 100644 --- a/doc/config.js.html +++ b/doc/config.js.html @@ -82,13 +82,13 @@ module.exports = {
diff --git a/doc/crypto.html b/doc/crypto.html index 148c59ab..b3e3363f 100644 --- a/doc/crypto.html +++ b/doc/crypto.html @@ -156,7 +156,7 @@ -Integer +module:enums.symmetric @@ -166,7 +166,7 @@ - Algorithm to use (see RFC4880 9.2) + Algorithm to use (see RFC 4880 9.2) @@ -295,7 +295,7 @@ -Integer +module:enums.symmetric @@ -305,7 +305,7 @@ - Algorithm to use (see RFC4880 9.2) + Algorithm to use (see RFC 4880 9.2) @@ -575,7 +575,7 @@ the specified secretMPIs of the private key and the specified algorithm. -Integer +module:enums.publicKey @@ -585,7 +585,7 @@ the specified secretMPIs of the private key and the specified algorithm. - Algorithm to be used (See RFC4880 9.1) + Algorithm to be used (See RFC 4880 9.1) @@ -786,7 +786,7 @@ and the specified algorithm. -Integer +module:enums.publicKey @@ -796,7 +796,7 @@ and the specified algorithm. - Algorithm to be used (See RFC4880 9.1) + Algorithm to be used (See RFC 4880 9.1) @@ -937,13 +937,13 @@ if elgamal encryption an array of two module:type/mpi is returned; otherwise nul
diff --git a/doc/crypto.js.html b/doc/crypto.js.html index 5a1c815d..15b12084 100644 --- a/doc/crypto.js.html +++ b/doc/crypto.js.html @@ -61,7 +61,7 @@ module.exports = { /** * Encrypts data using the specified public key multiprecision integers * and the specified algorithm. - * @param {Integer} algo Algorithm to be used (See RFC4880 9.1) + * @param {module:enums.publicKey} algo Algorithm to be used (See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC 4880 9.1}) * @param {Array<module:type/mpi>} publicMPIs Algorithm dependent multiprecision integers * @param {module:type/mpi} data Data to be encrypted as MPI * @return {Array<module:type/mpi>} if RSA an module:type/mpi; @@ -102,7 +102,7 @@ module.exports = { /** * Decrypts data using the specified public key multiprecision integers of the private key, * the specified secretMPIs of the private key and the specified algorithm. - * @param {Integer} algo Algorithm to be used (See RFC4880 9.1) + * @param {module:enums.publicKey} algo Algorithm to be used (See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC 4880 9.1}) * @param {Array<module:type/mpi>} publicMPIs Algorithm dependent multiprecision integers * of the public key part of the private key * @param {Array<module:type/mpi>} secretMPIs Algorithm dependent multiprecision integers @@ -234,7 +234,7 @@ module.exports = { /** * generate random byte prefix as string for the specified algorithm - * @param {Integer} algo Algorithm to use (see RFC4880 9.2) + * @param {module:enums.symmetric} algo Algorithm to use (see {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC 4880 9.2}) * @return {String} Random bytes with length equal to the block * size of the cipher */ @@ -244,7 +244,7 @@ module.exports = { /** * Generating a session key for the specified symmetric algorithm - * @param {Integer} algo Algorithm to use (see RFC4880 9.2) + * @param {module:enums.symmetric} algo Algorithm to use (see {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC 4880 9.2}) * @return {String} Random bytes as a string to be used as a key */ generateSessionKey: function(algo) { @@ -261,13 +261,13 @@ module.exports = {
diff --git a/doc/des.html b/doc/des.html index 0dfac5e4..719fdf07 100644 --- a/doc/des.html +++ b/doc/des.html @@ -209,13 +209,13 @@
diff --git a/doc/des.js.html b/doc/des.js.html index d3837411..f219fed3 100644 --- a/doc/des.js.html +++ b/doc/des.js.html @@ -444,13 +444,13 @@ module.exports = {
diff --git a/doc/dsa.html b/doc/dsa.html index 2b2e077b..423d2349 100644 --- a/doc/dsa.html +++ b/doc/dsa.html @@ -117,13 +117,13 @@
diff --git a/doc/dsa.js.html b/doc/dsa.js.html index 9e33e53a..ac7de924 100644 --- a/doc/dsa.js.html +++ b/doc/dsa.js.html @@ -206,13 +206,13 @@ module.exports = DSA;
diff --git a/doc/elgamal.html b/doc/elgamal.html index f3f1e27d..26f9f983 100644 --- a/doc/elgamal.html +++ b/doc/elgamal.html @@ -115,13 +115,13 @@
diff --git a/doc/elgamal.js.html b/doc/elgamal.js.html index 34173463..de0ed195 100644 --- a/doc/elgamal.js.html +++ b/doc/elgamal.js.html @@ -95,13 +95,13 @@ module.exports = Elgamal;
diff --git a/doc/enums.js.html b/doc/enums.js.html index e459df97..d00ca3c9 100644 --- a/doc/enums.js.html +++ b/doc/enums.js.html @@ -42,7 +42,7 @@ module.exports = { gnu: 101 }, - /** RFC4880, section 9.1 + /** {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC4880, section 9.1} * @enum {Integer} * @readonly */ @@ -54,7 +54,7 @@ module.exports = { dsa: 17 }, - /** RFC4880, section 9.2 + /** {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC4880, section 9.2} * @enum {Integer} * @readonly */ @@ -71,7 +71,7 @@ module.exports = { twofish: 10 }, - /** RFC4880, section 9.3 + /** {@link http://tools.ietf.org/html/rfc4880#section-9.3|RFC4880, section 9.3} * @enum {Integer} * @readonly */ @@ -84,7 +84,7 @@ module.exports = { bzip2: 3 }, - /** RFC4880, section 9.4 + /** {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC4880, section 9.4} * @enum {Integer} * @readonly */ @@ -352,13 +352,13 @@ module.exports = {
diff --git a/doc/hash.html b/doc/hash.html index 7c3d6bec..fa7ba8c7 100644 --- a/doc/hash.html +++ b/doc/hash.html @@ -553,7 +553,7 @@ -Integer +module:enums.hash @@ -563,7 +563,7 @@ - Hash algorithm type (see RFC4880 9.4) + Hash algorithm type (see RFC 4880 9.4) @@ -715,7 +715,7 @@ -Integer +module:enums.hash @@ -725,7 +725,7 @@ - Hash algorithm type (See RFC4880 9.4) + Hash algorithm type (See RFC 4880 9.4) @@ -819,13 +819,13 @@
diff --git a/doc/index.html b/doc/index.html index e89d0881..f4ae0812 100644 --- a/doc/index.html +++ b/doc/index.html @@ -180,13 +180,13 @@ for extending and developing on top of the base library.
diff --git a/doc/index.js.html b/doc/index.js.html index 68870032..75605fc7 100644 --- a/doc/index.js.html +++ b/doc/index.js.html @@ -74,13 +74,13 @@ module.exports.crypto = require('./crypto');
diff --git a/doc/index.js_.html b/doc/index.js_.html index 842bd1b0..61e571cc 100644 --- a/doc/index.js_.html +++ b/doc/index.js_.html @@ -60,13 +60,13 @@ for (var i in crypto)
diff --git a/doc/index.js__.html b/doc/index.js__.html index 6fd9ad4c..64238e1a 100644 --- a/doc/index.js__.html +++ b/doc/index.js__.html @@ -63,13 +63,13 @@ for (var i in aes) {
diff --git a/doc/index.js___.html b/doc/index.js___.html index 515a5ae0..6c072888 100644 --- a/doc/index.js___.html +++ b/doc/index.js___.html @@ -49,7 +49,7 @@ module.exports = { /** * Create a hash on the specified data using the specified algorithm - * @param {Integer} algo Hash algorithm type (see RFC4880 9.4) + * @param {module:enums.hash} algo Hash algorithm type (see {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC 4880 9.4}) * @param {String} data Data to be hashed * @return {String} hash value */ @@ -83,7 +83,7 @@ module.exports = { /** * Returns the hash size in bytes of the specified hash algorithm type - * @param {Integer} algo Hash algorithm type (See RFC4880 9.4) + * @param {module:enums.hash} algo Hash algorithm type (See {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC 4880 9.4}) * @return {Integer} Size in bytes of the resulting hash */ getHashByteLength: function(algo) { @@ -123,13 +123,13 @@ module.exports = {
diff --git a/doc/index.js____.html b/doc/index.js____.html index d3df77ee..0a3dde33 100644 --- a/doc/index.js____.html +++ b/doc/index.js____.html @@ -49,13 +49,13 @@ module.exports = {
diff --git a/doc/index.js_____.html b/doc/index.js_____.html new file mode 100644 index 00000000..3c70e935 --- /dev/null +++ b/doc/index.js_____.html @@ -0,0 +1,64 @@ + + + + + JSDoc: Source: packet/index.js + + + + + + + + + + +
+ +

Source: packet/index.js

+ + + + + +
+
+ 
var enums = require('../enums.js');
+
+module.exports = {
+  /**
+   * @name module:packet.List
+   * @see module:packet/packetlist
+   */
+  List: require('./packetlist.js')
+};
+
+var packets = require('./all_packets.js');
+
+for (var i in packets)
+  module.exports[i] = packets[i];
+
+
+
+ + + + +
+ + + +
+ + + + + + + diff --git a/doc/jsbn.html b/doc/jsbn.html index 3035335a..d829b5d5 100644 --- a/doc/jsbn.html +++ b/doc/jsbn.html @@ -111,13 +111,13 @@
diff --git a/doc/jsbn.js.html b/doc/jsbn.js.html index 21c4d235..9199233d 100644 --- a/doc/jsbn.js.html +++ b/doc/jsbn.js.html @@ -1745,13 +1745,13 @@ BigInteger.prototype.square = bnSquare;
diff --git a/doc/jxg.js.html b/doc/jxg.js.html index 41d49338..885b88e0 100644 --- a/doc/jxg.js.html +++ b/doc/jxg.js.html @@ -1297,13 +1297,13 @@ module.exports = JXG;
diff --git a/doc/key.js.html b/doc/key.js.html index 485bd68e..2667c07e 100644 --- a/doc/key.js.html +++ b/doc/key.js.html @@ -450,7 +450,7 @@ Key.prototype.verifyPrimaryKey = function() { return enums.keyStatus.expired; } // check for at least one self signature. Self signature of user ID not mandatory - // See http://tools.ietf.org/html/rfc4880#section-11.1 + // See {@link http://tools.ietf.org/html/rfc4880#section-11.1} var selfSigned = false; for (var i = 0; i < this.users.length; i++) { if (this.users[i].userId && this.users[i].selfCertifications) { @@ -735,8 +735,8 @@ function readArmored(armoredText) { /** * Generates a new OpenPGP key. Currently only supports RSA keys. * Primary and subkey will be of same type. - * @param {Integer} keyType to indicate what type of key to make. - * RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1 + * @param {module:enums.publicKey} keyType to indicate what type of key to make. + * RSA is 1. See {@link http://tools.ietf.org/html/rfc4880#section-9.1} * @param {Integer} numBits number of bits for the key creation. * @param {String} userId assumes already in form of "User Name <username@email.com>" * @param {String} passphrase The passphrase used to encrypt the resulting private key @@ -803,13 +803,13 @@ exports.generate = generate;
diff --git a/doc/keyid-Keyid.html b/doc/keyid-Keyid.html index 1d173b1f..d9cccf15 100644 --- a/doc/keyid-Keyid.html +++ b/doc/keyid-Keyid.html @@ -254,13 +254,13 @@
diff --git a/doc/keyid.html b/doc/keyid.html index 370f27f0..b06e027d 100644 --- a/doc/keyid.html +++ b/doc/keyid.html @@ -38,7 +38,7 @@ -
Implementation of type key id (RFC4880 3.3)
+
Implementation of type key id (RFC4880 3.3)

A Key ID is an eight-octet scalar that identifies a key. Implementations SHOULD NOT assume that Key IDs are unique. The @@ -125,13 +125,13 @@ formed.

diff --git a/doc/keyid.js.html b/doc/keyid.js.html index c88d8ffd..f446c21b 100644 --- a/doc/keyid.js.html +++ b/doc/keyid.js.html @@ -43,7 +43,7 @@ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA /** - * Implementation of type key id (RFC4880 3.3)<br/> + * Implementation of type key id ({@link http://tools.ietf.org/html/rfc4880#section-3.3|RFC4880 3.3})<br/> * <br/> * A Key ID is an eight-octet scalar that identifies a key. * Implementations SHOULD NOT assume that Key IDs are unique. The @@ -102,13 +102,13 @@ module.exports.mapToHex = function (keyId) {
diff --git a/doc/keyring-Keyring.html b/doc/keyring-Keyring.html index b6c7f599..7a7c5275 100644 --- a/doc/keyring-Keyring.html +++ b/doc/keyring-Keyring.html @@ -1291,13 +1291,13 @@ keyring from HTML5 local storage and initializes this instance.
diff --git a/doc/keyring.html b/doc/keyring.html index be72c4d5..6b563140 100644 --- a/doc/keyring.html +++ b/doc/keyring.html @@ -822,13 +822,13 @@
diff --git a/doc/keyring.js.html b/doc/keyring.js.html index bef1ee84..eaecfc1f 100644 --- a/doc/keyring.js.html +++ b/doc/keyring.js.html @@ -224,13 +224,13 @@ Keyring.prototype.exportPublicKey = function (index) {
diff --git a/doc/literal-Literal.html b/doc/literal-Literal.html index 795a3e8d..981744c3 100644 --- a/doc/literal-Literal.html +++ b/doc/literal-Literal.html @@ -909,13 +909,13 @@ will be normalized to \r\n and by default text is converted to UTF8
diff --git a/doc/literal.html b/doc/literal.html index 8cd96199..97542f0f 100644 --- a/doc/literal.html +++ b/doc/literal.html @@ -40,7 +40,7 @@
Implementation of the Literal Data Packet (Tag 11)

-RFC4880 5.9: A Literal Data packet contains the body of a message; data that +RFC4880 5.9: A Literal Data packet contains the body of a message; data that is not to be further interpreted.
@@ -125,13 +125,13 @@ is not to be further interpreted.
diff --git a/doc/literal.js.html b/doc/literal.js.html index 87b2248c..588cfed5 100644 --- a/doc/literal.js.html +++ b/doc/literal.js.html @@ -45,7 +45,7 @@ /** * Implementation of the Literal Data Packet (Tag 11)<br/> * <br/> - * RFC4880 5.9: A Literal Data packet contains the body of a message; data that + * {@link http://tools.ietf.org/html/rfc4880#section-5.9|RFC4880 5.9}: A Literal Data packet contains the body of a message; data that * is not to be further interpreted. * @requires enums * @requires util @@ -165,13 +165,13 @@ Literal.prototype.write = function () {
diff --git a/doc/localStorage-LocalStorage.html b/doc/localStorage-LocalStorage.html index 8b22c8e0..eac2232e 100644 --- a/doc/localStorage-LocalStorage.html +++ b/doc/localStorage-LocalStorage.html @@ -277,13 +277,13 @@ if config is null the default config will be used
diff --git a/doc/localStorage.html b/doc/localStorage.html index 06aca0e8..8f68a7b0 100644 --- a/doc/localStorage.html +++ b/doc/localStorage.html @@ -114,13 +114,13 @@
diff --git a/doc/localStorage.js.html b/doc/localStorage.js.html index 0cf92892..568f984e 100644 --- a/doc/localStorage.js.html +++ b/doc/localStorage.js.html @@ -68,13 +68,13 @@ LocalStorage.prototype.write = function () {
diff --git a/doc/localstore.html b/doc/localstore.html index 2c7a3d64..e5c13992 100644 --- a/doc/localstore.html +++ b/doc/localstore.html @@ -113,13 +113,13 @@
diff --git a/doc/localstore.js.html b/doc/localstore.js.html index 895a4526..821c809d 100644 --- a/doc/localstore.js.html +++ b/doc/localstore.js.html @@ -93,13 +93,13 @@ LocalStore.prototype.store = function (keys) {
diff --git a/doc/marker-Marker.html b/doc/marker-Marker.html index b5116492..422c9d90 100644 --- a/doc/marker-Marker.html +++ b/doc/marker-Marker.html @@ -323,13 +323,13 @@
diff --git a/doc/marker.html b/doc/marker.html index 5b46bc54..d4b35d69 100644 --- a/doc/marker.html +++ b/doc/marker.html @@ -40,7 +40,7 @@
Implementation of the strange "Marker packet" (Tag 10)

-RFC4880 5.8: An experimental version of PGP used this packet as the Literal +RFC4880 5.8: An experimental version of PGP used this packet as the Literal packet, but no released version of PGP generated Literal packets with this tag. With PGP 5.x, this packet has been reassigned and is reserved for use as the Marker packet.
@@ -121,13 +121,13 @@ Such a packet MUST be ignored when received.

diff --git a/doc/marker.js.html b/doc/marker.js.html index 037112e0..0adf20a3 100644 --- a/doc/marker.js.html +++ b/doc/marker.js.html @@ -46,7 +46,7 @@ /** * Implementation of the strange "Marker packet" (Tag 10)<br/> * <br/> - * RFC4880 5.8: An experimental version of PGP used this packet as the Literal + * {@link http://tools.ietf.org/html/rfc4880#section-5.8|RFC4880 5.8}: An experimental version of PGP used this packet as the Literal * packet, but no released version of PGP generated Literal packets with this * tag. With PGP 5.x, this packet has been reassigned and is reserved for use as * the Marker packet.<br/> @@ -92,13 +92,13 @@ Marker.prototype.read = function (bytes) {
diff --git a/doc/md5.html b/doc/md5.html index 3ddb9f7c..82f04806 100644 --- a/doc/md5.html +++ b/doc/md5.html @@ -229,13 +229,13 @@
diff --git a/doc/md5.js.html b/doc/md5.js.html index 4193382f..2315dc19 100644 --- a/doc/md5.js.html +++ b/doc/md5.js.html @@ -252,13 +252,13 @@ if (md5('hello') != '5d41402abc4b2a76b9719d911017c592') {
diff --git a/doc/message.js.html b/doc/message.js.html index 7f7b985d..be228262 100644 --- a/doc/message.js.html +++ b/doc/message.js.html @@ -62,7 +62,7 @@ var packet = require('./packet'), * @classdesc Class that represents an OpenPGP message. * Can be an encrypted message, signed message, compressed message or literal message * @param {module:packet/packetlist} packetlist The packets that form this message - * See http://tools.ietf.org/html/rfc4880#section-11.3 + * See {@link http://tools.ietf.org/html/rfc4880#section-11.3} */ function Message(packetlist) { @@ -351,13 +351,13 @@ exports.fromBinary = fromBinary;
diff --git a/doc/module-armor.html b/doc/module-armor.html index 524c15c8..9a9c5943 100644 --- a/doc/module-armor.html +++ b/doc/module-armor.html @@ -112,13 +112,13 @@
diff --git a/doc/module-cleartext-CleartextMessage.html b/doc/module-cleartext-CleartextMessage.html index d04c39de..c18a8586 100644 --- a/doc/module-cleartext-CleartextMessage.html +++ b/doc/module-cleartext-CleartextMessage.html @@ -33,7 +33,7 @@
Class that represents an OpenPGP cleartext signed message. -See http://tools.ietf.org/html/rfc4880#section-7
+See http://tools.ietf.org/html/rfc4880#section-7 @@ -741,13 +741,13 @@ See http://tools.ietf.org/html/rfc4880#section-7
diff --git a/doc/module-cleartext.html b/doc/module-cleartext.html index 29e3df0a..a5338209 100644 --- a/doc/module-cleartext.html +++ b/doc/module-cleartext.html @@ -267,13 +267,13 @@
diff --git a/doc/module-config.html b/doc/module-config.html index edcec2ab..81294689 100644 --- a/doc/module-config.html +++ b/doc/module-config.html @@ -112,13 +112,13 @@
diff --git a/doc/module-crypto.html b/doc/module-crypto.html index a747a9c1..ff77a6f9 100644 --- a/doc/module-crypto.html +++ b/doc/module-crypto.html @@ -515,13 +515,13 @@
diff --git a/doc/module-enums.html b/doc/module-enums.html index d62d740c..6a9669b9 100644 --- a/doc/module-enums.html +++ b/doc/module-enums.html @@ -369,7 +369,7 @@
- RFC4880, section 9.3 + RFC4880, section 9.3
@@ -579,7 +579,7 @@
- RFC4880, section 9.4 + RFC4880, section 9.4
@@ -2182,7 +2182,7 @@
- RFC4880, section 9.1 + RFC4880, section 9.1
@@ -4022,7 +4022,7 @@ document) that cannot include a target subpacket.
- RFC4880, section 9.2 + RFC4880, section 9.2
@@ -4527,13 +4527,13 @@ document) that cannot include a target subpacket.
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:15 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:45 GMT-0800 (PST)
diff --git a/doc/module-key-Key.html b/doc/module-key-Key.html index 2ec2cec1..0143b82e 100644 --- a/doc/module-key-Key.html +++ b/doc/module-key-Key.html @@ -2252,13 +2252,13 @@ and valid self signature
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:16 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:46 GMT-0800 (PST)
diff --git a/doc/module-key-SubKey.html b/doc/module-key-SubKey.html index 95e18f4e..b6887c07 100644 --- a/doc/module-key-SubKey.html +++ b/doc/module-key-SubKey.html @@ -594,13 +594,13 @@ and valid binding signature
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:16 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:46 GMT-0800 (PST)
diff --git a/doc/module-key-User.html b/doc/module-key-User.html index 9627c9e3..77a216d5 100644 --- a/doc/module-key-User.html +++ b/doc/module-key-User.html @@ -676,13 +676,13 @@ and validity of self signature
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:17 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:46 GMT-0800 (PST)
diff --git a/doc/module-key.html b/doc/module-key.html index 8a58ad87..7b31ecab 100644 --- a/doc/module-key.html +++ b/doc/module-key.html @@ -170,7 +170,7 @@ Primary and subkey will be of same type. -Integer +module:enums.publicKey @@ -180,8 +180,8 @@ Primary and subkey will be of same type. - to indicate what type of key to make. - RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1 + to indicate what type of key to make. + RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1 @@ -479,13 +479,13 @@ Primary and subkey will be of same type.
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:16 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:46 GMT-0800 (PST)
diff --git a/doc/module-keyid.html b/doc/module-keyid.html index 21771ad6..c42069d5 100644 --- a/doc/module-keyid.html +++ b/doc/module-keyid.html @@ -112,13 +112,13 @@
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:16 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:46 GMT-0800 (PST)
diff --git a/doc/module-message-Message.html b/doc/module-message-Message.html index cc223196..7792c8e6 100644 --- a/doc/module-message-Message.html +++ b/doc/module-message-Message.html @@ -99,7 +99,7 @@ Can be an encrypted message, signed message, compressed message or literal messa The packets that form this message -See http://tools.ietf.org/html/rfc4880#section-11.3 +See http://tools.ietf.org/html/rfc4880#section-11.3 @@ -1297,13 +1297,13 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:17 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:47 GMT-0800 (PST)
diff --git a/doc/module-message.html b/doc/module-message.html index 181df3c7..3bc04e06 100644 --- a/doc/module-message.html +++ b/doc/module-message.html @@ -547,13 +547,13 @@
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:17 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:46 GMT-0800 (PST)
diff --git a/doc/module-mpi.html b/doc/module-mpi.html index ce51cb60..d1f45b62 100644 --- a/doc/module-mpi.html +++ b/doc/module-mpi.html @@ -112,13 +112,13 @@
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:17 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:47 GMT-0800 (PST)
diff --git a/doc/module-openpgp.html b/doc/module-openpgp.html index 6bcaf0e4..f2c004bd 100644 --- a/doc/module-openpgp.html +++ b/doc/module-openpgp.html @@ -675,7 +675,7 @@ Primary and subkey will be of same type. -Integer +module:enums.publicKey @@ -685,8 +685,8 @@ Primary and subkey will be of same type. - to indicate what type of key to make. - RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1 + to indicate what type of key to make. + RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1 @@ -1358,13 +1358,13 @@ Primary and subkey will be of same type.
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:17 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:47 GMT-0800 (PST)
diff --git a/doc/module-packet.html b/doc/module-packet.html index de5d1e00..33eb590e 100644 --- a/doc/module-packet.html +++ b/doc/module-packet.html @@ -156,6 +156,63 @@ +
+

<static> List

+ + +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + +
See:
+
+ +
+ + + +
+ + + +
+ + +

<static> Literal

@@ -1013,6 +1070,284 @@ +

Methods

+ +
+ +
+

<static> newPacketFromTag(tag) → {Object}

+ + +
+
+ + +
+ Allocate a new packet +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
tag + + +String + + + + property name from module:enums.packet
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ new packet object with type based on tag +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + +
+ + + +
+

<inner> packetClassFromTagName(tag) → {String}

+ + +
+
+ + +
+ Convert tag name to class name +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
tag + + +String + + + + property name from module:enums.packet
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +String + + +
+
+ + + + +
+ +
+ @@ -1027,13 +1362,13 @@
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:17 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:47 GMT-0800 (PST)
diff --git a/doc/module-s2k.html b/doc/module-s2k.html index b48009e3..da0381f1 100644 --- a/doc/module-s2k.html +++ b/doc/module-s2k.html @@ -112,13 +112,13 @@
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:19 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:49 GMT-0800 (PST)
diff --git a/doc/module-util.html b/doc/module-util.html index 81a7c223..a7c67290 100644 --- a/doc/module-util.html +++ b/doc/module-util.html @@ -112,13 +112,13 @@
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:19 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:49 GMT-0800 (PST)
diff --git a/doc/mpi-Mpi.html b/doc/mpi-Mpi.html index 4dfcd177..e77ad0da 100644 --- a/doc/mpi-Mpi.html +++ b/doc/mpi-Mpi.html @@ -190,7 +190,7 @@
- Parsing function for a mpi (RFC 4880 3.2). + Parsing function for a mpi (RFC 4880 3.2).
@@ -329,7 +329,7 @@
- Converts the mpi object to a string as specified in RFC4880 3.2 + Converts the mpi object to a string as specified in RFC4880 3.2
@@ -425,13 +425,13 @@
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:19 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:49 GMT-0800 (PST)
diff --git a/doc/mpi.html b/doc/mpi.html index a4091a7b..c10404c6 100644 --- a/doc/mpi.html +++ b/doc/mpi.html @@ -38,7 +38,7 @@ -
Implementation of type MPI (RFC4880 3.2)
+
Implementation of type MPI (RFC4880 3.2)

Multiprecision integers (also called MPIs) are unsigned integers used to hold large integers such as the ones used in cryptographic @@ -129,13 +129,13 @@ actual integer.

- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:19 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:49 GMT-0800 (PST)
diff --git a/doc/mpi.js.html b/doc/mpi.js.html index bd80004b..154b3f5b 100644 --- a/doc/mpi.js.html +++ b/doc/mpi.js.html @@ -48,7 +48,7 @@ // - MPI = c | d << 8 | e << ((MPI.length -2)*8) | f ((MPI.length -2)*8) /** - * Implementation of type MPI (RFC4880 3.2)<br/> + * Implementation of type MPI ({@link http://tools.ietf.org/html/rfc4880#section-3.2|RFC4880 3.2})<br/> * <br/> * Multiprecision integers (also called MPIs) are unsigned integers used * to hold large integers such as the ones used in cryptographic @@ -75,7 +75,7 @@ function Mpi() { } /** - * Parsing function for a mpi (RFC 4880 3.2). + * Parsing function for a mpi ({@link http://tools.ietf.org/html/rfc4880#section3.2|RFC 4880 3.2}). * @param {String} input Payload of mpi data * @return {Integer} Length of data read */ @@ -113,7 +113,7 @@ Mpi.prototype.byteLength = function () { }; /** - * Converts the mpi object to a string as specified in RFC4880 3.2 + * Converts the mpi object to a string as specified in {@link http://tools.ietf.org/html/rfc4880#section-3.2|RFC4880 3.2} * @return {String} mpi Byte representation */ Mpi.prototype.write = function () { @@ -137,13 +137,13 @@ Mpi.prototype.fromBigInteger = function (bn) {
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:13 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:43 GMT-0800 (PST)
diff --git a/doc/one_pass_signature-OnePassSignature.html b/doc/one_pass_signature-OnePassSignature.html index 19d72aa6..9112cea3 100644 --- a/doc/one_pass_signature-OnePassSignature.html +++ b/doc/one_pass_signature-OnePassSignature.html @@ -78,7 +78,7 @@
Source:
@@ -213,7 +213,7 @@
Source:
@@ -304,7 +304,7 @@
Source:
@@ -367,13 +367,13 @@
diff --git a/doc/one_pass_signature.html b/doc/one_pass_signature.html index 791b023f..ae724103 100644 --- a/doc/one_pass_signature.html +++ b/doc/one_pass_signature.html @@ -40,8 +40,7 @@
Implementation of the One-Pass Signature Packets (Tag 4)

-RFC4880 5.4: -The One-Pass Signature packet precedes the signed data and contains +RFC4880 5.4: The One-Pass Signature packet precedes the signed data and contains enough information to allow the receiver to begin calculating any hashes needed to verify the signature. It allows the Signature packet to be placed at the end of the message, so that the signer @@ -129,13 +128,13 @@ can compute the entire signed message in one pass.

diff --git a/doc/one_pass_signature.js.html b/doc/one_pass_signature.js.html index c3bbfa22..abccca5d 100644 --- a/doc/one_pass_signature.js.html +++ b/doc/one_pass_signature.js.html @@ -45,8 +45,7 @@ /** * Implementation of the One-Pass Signature Packets (Tag 4)<br/> * <br/> - * RFC4880 5.4: - * The One-Pass Signature packet precedes the signed data and contains + * {@link http://tools.ietf.org/html/rfc4880#section-5.4|RFC4880 5.4}: The One-Pass Signature packet precedes the signed data and contains * enough information to allow the receiver to begin calculating any * hashes needed to verify the signature. It allows the Signature * packet to be placed at the end of the message, so that the signer @@ -66,9 +65,9 @@ var enums = require('../enums.js'), */ function OnePassSignature() { this.version = null; // A one-octet version number. The current version is 3. - this.type = null; // A one-octet signature type. Signature types are described in RFC4880 Section 5.2.1. - this.hashAlgorithm = null; // A one-octet number describing the hash algorithm used. (See RFC4880 9.4) - this.publicKeyAlgorithm = null; // A one-octet number describing the public-key algorithm used. (See RFC4880 9.1) + this.type = null; // A one-octet signature type. Signature types are described in {@link http://tools.ietf.org/html/rfc4880#section-5.2.1|RFC4880 Section 5.2.1}. + this.hashAlgorithm = null; // A one-octet number describing the hash algorithm used. (See {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC4880 9.4}) + this.publicKeyAlgorithm = null; // A one-octet number describing the public-key algorithm used. (See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC4880 9.1}) this.signingKeyId = null; // An eight-octet number holding the Key ID of the signing key. this.flags = null; // A one-octet number holding a flag showing whether the signature is nested. A zero value indicates that the next packet is another One-Pass Signature packet that describes another signature to be applied to the same message data. } @@ -132,13 +131,13 @@ OnePassSignature.prototype.write = function () {
diff --git a/doc/openpgp.js.html b/doc/openpgp.js.html index 56afc290..735f5879 100644 --- a/doc/openpgp.js.html +++ b/doc/openpgp.js.html @@ -165,8 +165,8 @@ function verifyClearSignedMessage(publicKeys, message) { /** * Generates a new OpenPGP key pair. Currently only supports RSA keys. * Primary and subkey will be of same type. - * @param {Integer} keyType to indicate what type of key to make. - * RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1 + * @param {module:enums.publicKey} keyType to indicate what type of key to make. + * RSA is 1. See {@link http://tools.ietf.org/html/rfc4880#section-9.1} * @param {Integer} numBits number of bits for the key creation. (should be 1024+, generally) * @param {String} userId assumes already in form of "User Name <username@email.com>" * @param {String} passphrase The passphrase used to encrypt the resulting private key @@ -199,13 +199,13 @@ exports.generateKeyPair = generateKeyPair;
diff --git a/doc/packet.html b/doc/packet.html index bbec64d3..0880a926 100644 --- a/doc/packet.html +++ b/doc/packet.html @@ -768,13 +768,13 @@ string
diff --git a/doc/packet.js.html b/doc/packet.js.html index 1fc690bd..eadc8b2d 100644 --- a/doc/packet.js.html +++ b/doc/packet.js.html @@ -298,13 +298,13 @@ module.exports = {
diff --git a/doc/packetlist-Packetlist.html b/doc/packetlist-Packetlist.html index c11398ec..8185476f 100644 --- a/doc/packetlist-Packetlist.html +++ b/doc/packetlist-Packetlist.html @@ -1036,13 +1036,13 @@ class instance.
diff --git a/doc/packetlist.html b/doc/packetlist.html index 52785214..d803303d 100644 --- a/doc/packetlist.html +++ b/doc/packetlist.html @@ -126,13 +126,13 @@ are stored as numerical indices.
diff --git a/doc/packetlist.js.html b/doc/packetlist.js.html index ce46da62..cb166725 100644 --- a/doc/packetlist.js.html +++ b/doc/packetlist.js.html @@ -212,13 +212,13 @@ Packetlist.prototype.concat = function (packetlist) {
diff --git a/doc/pkcs1.html b/doc/pkcs1.html index 3f64e995..778fac63 100644 --- a/doc/pkcs1.html +++ b/doc/pkcs1.html @@ -117,7 +117,7 @@
- ASN1 object identifiers for hashes (See RFC4880 5.2.2) + ASN1 object identifiers for hashes (See http://tools.ietf.org/html/rfc4880#section-5.2.2)
@@ -179,13 +179,13 @@
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:15 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:45 GMT-0800 (PST)
diff --git a/doc/pkcs1.js.html b/doc/pkcs1.js.html index b9ef35af..efd12d09 100644 --- a/doc/pkcs1.js.html +++ b/doc/pkcs1.js.html @@ -53,7 +53,7 @@ */ /** - * ASN1 object identifiers for hashes (See RFC4880 5.2.2) + * ASN1 object identifiers for hashes (See {@link http://tools.ietf.org/html/rfc4880#section-5.2.2}) */ hash_headers = []; hash_headers[1] = [0x30, 0x20, 0x30, 0x0c, 0x06, 0x08, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x02, 0x05, 0x05, 0x00, 0x04, @@ -83,7 +83,7 @@ var crypto = require('./crypto.js'), module.exports = { eme: { /** - * create a EME-PKCS1-v1_5 padding (See RFC4880 13.1.1) + * create a EME-PKCS1-v1_5 padding (See {@link http://tools.ietf.org/html/rfc4880#section-13.1.1|RFC 4880 13.1.1}) * @param {String} message message to be padded * @param {Integer} length Length to the resulting message * @return {String} EME-PKCS1 padded message @@ -103,9 +103,9 @@ module.exports = { }, /** - * decodes a EME-PKCS1-v1_5 padding (See RFC4880 13.1.2) + * decodes a EME-PKCS1-v1_5 padding (See {@link http://tools.ietf.org/html/rfc4880#section-13.1.2|RFC 4880 13.1.2}) * @param {String} message EME-PKCS1 padded message - * @return {String} decoded message + * @return {String} decoded message */ decode: function(message, len) { if (message.length < len) @@ -122,7 +122,7 @@ module.exports = { emsa: { /** - * create a EMSA-PKCS1-v1_5 padding (See RFC4880 13.1.3) + * create a EMSA-PKCS1-v1_5 padding (See {@link http://tools.ietf.org/html/rfc4880#section-13.1.3|RFC 4880 13.1.3}) * @param {Integer} algo Hash algorithm type used * @param {String} data Data to be hashed * @param {Integer} keylength Key size of the public mpi in bytes @@ -148,7 +148,7 @@ module.exports = { }, /** - * extract the hash out of an EMSA-PKCS1-v1.5 padding (See RFC4880 13.1.3) + * extract the hash out of an EMSA-PKCS1-v1.5 padding (See {@link http://tools.ietf.org/html/rfc4880#section-13.1.3|RFC 4880 13.1.3}) * @param {String} data Hash in pkcs1 encoding * @returns {String} The hash as string */ @@ -180,13 +180,13 @@ module.exports = {
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:13 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:43 GMT-0800 (PST)
diff --git a/doc/public_key-PublicKey.html b/doc/public_key-PublicKey.html index fad04a50..085c79b7 100644 --- a/doc/public_key-PublicKey.html +++ b/doc/public_key-PublicKey.html @@ -305,6 +305,128 @@ + + + + +
+ + + +
+

readPublicKey

+ + +
+
+ +
+ Alias of read() +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + +
See:
+
+ +
+ + + +
+ + + +
+ + + +
+

writePublicKey

+ + +
+
+ +
+ Alias of write() +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + +
See:
+
+ +
+ + +
@@ -361,7 +483,7 @@
Source:
@@ -452,7 +574,7 @@
Source:
@@ -510,8 +632,7 @@
- Internal Parser for public keys as specified in RFC 4880 section -5.5.2 Public-Key Packet Formats + Internal Parser for public keys as specified in RFC 4880 section 5.5.2 Public-Key Packet Formats called by read_tag<num>
@@ -593,7 +714,7 @@ called by read_tag<num>
Source:
@@ -685,7 +806,7 @@ public key.
Source:
@@ -777,7 +898,7 @@ header: [string] OpenPGP packet header, string: [string] header+body}
Source:
@@ -818,13 +939,13 @@ header: [string] OpenPGP packet header, string: [string] header+body}
diff --git a/doc/public_key.html b/doc/public_key.html index 161c219d..d002bfe3 100644 --- a/doc/public_key.html +++ b/doc/public_key.html @@ -290,13 +290,13 @@
diff --git a/doc/public_key.js.html b/doc/public_key.js.html index 89dbdf6d..41e32051 100644 --- a/doc/public_key.js.html +++ b/doc/public_key.js.html @@ -45,7 +45,7 @@ /** * Implementation of the Key Material Packet (Tag 5,6,7,14)<br/> * <br/> - * RFC4480 5.5: + * {@link http://tools.ietf.org/html/rfc4880#section-5.5|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. @@ -84,8 +84,7 @@ function PublicKey() { } /** - * Internal Parser for public keys as specified in RFC 4880 section - * 5.5.2 Public-Key Packet Formats + * Internal Parser for public keys as specified in {@link http://tools.ietf.org/html/rfc4880#section-5.5.2|RFC 4880 section 5.5.2 Public-Key Packet Formats} * called by read_tag<num> * @param {String} input Input string to read the packet from * @return {Object} This object with attributes set by the parser @@ -135,8 +134,7 @@ PublicKey.prototype.read = function (bytes) { /** * Alias of read() - * @function module:packet/public_key#readPublicKey - * @see module:packet/public_key#read + * @see module:packet/public_key~PublicKey#read */ PublicKey.prototype.readPublicKey = PublicKey.prototype.read; @@ -166,8 +164,7 @@ PublicKey.prototype.write = function () { /** * Alias of write() - * @function module:packet/public_key#writePublicKey - * @see module:packet/public_key#write + * @see module:packet/public_key~PublicKey#write */ PublicKey.prototype.writePublicKey = PublicKey.prototype.write; @@ -223,13 +220,13 @@ PublicKey.prototype.getFingerprint = function () {
diff --git a/doc/public_key_.html b/doc/public_key_.html index aa0c1d9b..4e70794a 100644 --- a/doc/public_key_.html +++ b/doc/public_key_.html @@ -40,7 +40,7 @@
Implementation of the Key Material Packet (Tag 5,6,7,14)

-RFC4480 5.5: +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.
@@ -119,162 +119,6 @@ major versions. Consequently, this section is complex. -

Methods

- -
- -
-

readPublicKey()

- - -
-
- - -
- Alias of read() -
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • module:packet/public_key#read
    • -
-
- - - -
- - - - - - - - - - - - - -
- - - -
-

writePublicKey()

- - -
-
- - -
- Alias of write() -
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • module:packet/public_key#write
    • -
-
- - - -
- - - - - - - - - - - - - -
- -
- @@ -289,13 +133,13 @@ major versions. Consequently, this section is complex.
diff --git a/doc/public_key_encrypted_session_key-PublicKeyEncryptedSessionKey.html b/doc/public_key_encrypted_session_key-PublicKeyEncryptedSessionKey.html index c15e508c..e62dd9de 100644 --- a/doc/public_key_encrypted_session_key-PublicKeyEncryptedSessionKey.html +++ b/doc/public_key_encrypted_session_key-PublicKeyEncryptedSessionKey.html @@ -608,7 +608,7 @@ packets (tag 1) -Integer +module:enums.publicKey @@ -618,7 +618,7 @@ packets (tag 1) - The corresponding public key algorithm // See RFC4880 9.1 + The corresponding public key algorithm // See RFC4880 9.1 @@ -631,7 +631,7 @@ packets (tag 1) -Integer +module:enums.symmetric @@ -644,7 +644,7 @@ packets (tag 1) The symmetric cipher algorithm used to encrypt the data within an encrypteddatapacket or encryptedintegrity- protecteddatapacket - following this packet //See RFC4880 9.2 + following this packet //See RFC4880 9.2 @@ -761,13 +761,13 @@ packets (tag 1)
diff --git a/doc/public_key_encrypted_session_key.html b/doc/public_key_encrypted_session_key.html index 448a71be..48daa951 100644 --- a/doc/public_key_encrypted_session_key.html +++ b/doc/public_key_encrypted_session_key.html @@ -40,7 +40,7 @@
Public-Key Encrypted Session Key Packets (Tag 1)

-RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key +RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key used to encrypt a message. Zero or more Public-Key Encrypted Session Key packets and/or Symmetric-Key Encrypted Session Key packets may precede a Symmetrically Encrypted Data Packet, which holds an encrypted message. The @@ -140,13 +140,13 @@ decrypt the message.

diff --git a/doc/public_key_encrypted_session_key.js.html b/doc/public_key_encrypted_session_key.js.html index 84a3754d..44b68f7f 100644 --- a/doc/public_key_encrypted_session_key.js.html +++ b/doc/public_key_encrypted_session_key.js.html @@ -45,7 +45,7 @@ /** * Public-Key Encrypted Session Key Packets (Tag 1)<br/> * <br/> - * RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key + * {@link http://tools.ietf.org/html/rfc4880#section-5.1|RFC4880 5.1}: A Public-Key Encrypted Session Key packet holds the session key * used to encrypt a message. Zero or more Public-Key Encrypted Session Key * packets and/or Symmetric-Key Encrypted Session Key packets may precede a * Symmetrically Encrypted Data Packet, which holds an encrypted message. The @@ -135,13 +135,13 @@ PublicKeyEncryptedSessionKey.prototype.read = function (bytes) { * The public key id corresponding to publicMPIs key as string * @param {Array<module:type/mpi>} publicMPIs * Multiprecision integer objects describing the public key - * @param {Integer} pubalgo - * The corresponding public key algorithm // See RFC4880 9.1 - * @param {Integer} symmalgo + * @param {module:enums.publicKey} pubalgo + * The corresponding public key algorithm // See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC4880 9.1} + * @param {module:enums.symmetric} symmalgo * The symmetric cipher algorithm used to encrypt the data * within an encrypteddatapacket or encryptedintegrity- * protecteddatapacket - * following this packet //See RFC4880 9.2 + * following this packet //See {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC4880 9.2} * @param {String} sessionkey * A string of randombytes representing the session key * @return {String} The string representation @@ -219,13 +219,13 @@ PublicKeyEncryptedSessionKey.prototype.decrypt = function (key) {
diff --git a/doc/public_subkey-PublicSubkey.html b/doc/public_subkey-PublicSubkey.html index 5b29e1f7..01eb9800 100644 --- a/doc/public_subkey-PublicSubkey.html +++ b/doc/public_subkey-PublicSubkey.html @@ -125,172 +125,6 @@ -

Methods

- -
- -
-

readPublicKey()

- - -
-
- - -
- Alias of read() -
- - - - - - - - - -
- - - - - - - -
Inherited From:
-
- - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • module:packet/public_key#read
    • -
-
- - - -
- - - - - - - - - - - - - -
- - - -
-

writePublicKey()

- - -
-
- - -
- Alias of write() -
- - - - - - - - - -
- - - - - - - -
Inherited From:
-
- - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • module:packet/public_key#write
    • -
-
- - - -
- - - - - - - - - - - - - -
- -
- @@ -305,13 +139,13 @@
diff --git a/doc/public_subkey.html b/doc/public_subkey.html index 843a15a5..c6ef9b44 100644 --- a/doc/public_subkey.html +++ b/doc/public_subkey.html @@ -118,13 +118,13 @@
diff --git a/doc/public_subkey.js.html b/doc/public_subkey.js.html index 9f863d5f..5ce5a263 100644 --- a/doc/public_subkey.js.html +++ b/doc/public_subkey.js.html @@ -71,13 +71,13 @@ PublicSubkey.prototype.constructor = PublicSubkey();
diff --git a/doc/random.html b/doc/random.html index bef958de..8597d562 100644 --- a/doc/random.html +++ b/doc/random.html @@ -717,13 +717,13 @@
diff --git a/doc/random.js.html b/doc/random.js.html index 2d181a29..fe188662 100644 --- a/doc/random.js.html +++ b/doc/random.js.html @@ -144,13 +144,13 @@ module.exports = {
diff --git a/doc/ripe-md.html b/doc/ripe-md.html index dd2d3b20..cd4fae90 100644 --- a/doc/ripe-md.html +++ b/doc/ripe-md.html @@ -105,13 +105,13 @@
diff --git a/doc/ripe-md.js.html b/doc/ripe-md.js.html index 3a2faf5c..89a344ae 100644 --- a/doc/ripe-md.js.html +++ b/doc/ripe-md.js.html @@ -332,13 +332,13 @@ module.exports = RMDstring;
diff --git a/doc/rsa.html b/doc/rsa.html index ecb87a23..948d9854 100644 --- a/doc/rsa.html +++ b/doc/rsa.html @@ -115,13 +115,13 @@
diff --git a/doc/rsa.js.html b/doc/rsa.js.html index 29a993aa..fe13f16e 100644 --- a/doc/rsa.js.html +++ b/doc/rsa.js.html @@ -187,13 +187,13 @@ module.exports = RSA;
diff --git a/doc/s2k-S2k.html b/doc/s2k-S2k.html index 065d213d..003c8bee 100644 --- a/doc/s2k-S2k.html +++ b/doc/s2k-S2k.html @@ -461,7 +461,7 @@ hashAlgorithm hash length
- Parsing function for a string-to-key specifier (RFC 4880 3.7). + Parsing function for a string-to-key specifier (RFC 4880 3.7).
@@ -696,13 +696,13 @@ hashAlgorithm hash length
diff --git a/doc/s2k.html b/doc/s2k.html index d6a47590..8dbf2285 100644 --- a/doc/s2k.html +++ b/doc/s2k.html @@ -38,7 +38,7 @@ -
Implementation of the String-to-key specifier (RFC4880 3.7)
+
Implementation of the String-to-key specifier (RFC4880 3.7)

String-to-key (S2K) specifiers are used to convert passphrase strings into symmetric-key encryption/decryption keys. They are used in two @@ -130,13 +130,13 @@ symmetrically encrypted messages.

diff --git a/doc/s2k.js.html b/doc/s2k.js.html index 67de5de1..50f412da 100644 --- a/doc/s2k.js.html +++ b/doc/s2k.js.html @@ -43,7 +43,7 @@ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA /** - * Implementation of the String-to-key specifier (RFC4880 3.7)<br/> + * Implementation of the String-to-key specifier ({@link http://tools.ietf.org/html/rfc4880#section-3.7|RFC4880 3.7})<br/> * <br/> * String-to-key (S2K) specifiers are used to convert passphrase strings * into symmetric-key encryption/decryption keys. They are used in two @@ -85,7 +85,7 @@ S2k.prototype.get_count = function () { }; /** - * Parsing function for a string-to-key specifier (RFC 4880 3.7). + * Parsing function for a string-to-key specifier ({@link http://tools.ietf.org/html/rfc4880#section-3.7|RFC 4880 3.7}). * @param {String} input Payload of string-to-key specifier * @return {Integer} Actual length of the object */ @@ -215,13 +215,13 @@ S2k.prototype.produce_key = function (passphrase, numBytes) {
diff --git a/doc/secret_key-SecretKey.html b/doc/secret_key-SecretKey.html new file mode 100644 index 00000000..aa7066ef --- /dev/null +++ b/doc/secret_key-SecretKey.html @@ -0,0 +1,625 @@ + + + + + JSDoc: Class: SecretKey + + + + + + + + + + +
+ +

Class: SecretKey

+ + + + + +
+ +
+

+ packet/secret_key~ + + SecretKey +

+ +
+ +
+
+ + + + +
+

new SecretKey()

+ + +
+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + +

Methods

+ +
+ +
+

decrypt(str_passphrase) → {Boolean}

+ + +
+
+ + +
+ Decrypts the private key MPIs which are needed to use the key. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
str_passphrase + + +String + + + + The passphrase for this private key +as string
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ True if the passphrase was correct or MPI already + decrypted; false if not +
+ + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + +
+ + + +
+

encrypt(passphrase)

+ + +
+
+ + +
+ Encrypt the payload. By default, we use aes256 and iterated, salted string +to key specifier +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
passphrase + + +String + + + +
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

read(bytes)

+ + +
+
+ + +
+ Internal parser for private keys as specified in RFC 4880 section 5.5.3 +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
bytes + + +String + + + + Input string to read the packet from
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

write() → {String}

+ + +
+
+ + +
+ Creates an OpenPGP key packet for the given key. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ A string of bytes containing the secret key OpenPGP packet +
+ + + +
+
+ Type +
+
+ +String + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/doc/secret_key.html b/doc/secret_key.html index 08126c73..29b0017c 100644 --- a/doc/secret_key.html +++ b/doc/secret_key.html @@ -35,83 +35,17 @@
+ +
Implementation of the Key Material Packet (Tag 5,6,7,14)

-RFC4480 5.5: +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.
-
-

new (require("packet/secret_key"))()

- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - -
- - - - - -
@@ -174,182 +108,23 @@ major versions. Consequently, this section is complex.
- - - - - - -

Methods

+

Classes

- -
-

readPublicKey()

- - -
-
- - -
- Alias of read() -
- - - - - - - - - -
- - - - - - - -
Inherited From:
-
- - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • module:packet/public_key#read
    • -
-
- - - -
- - - - - - - - - - - - - -
- - - -
-

writePublicKey()

- - -
-
- - -
- Alias of write() -
- - - - - - - - - -
- - - - - - - -
Inherited From:
-
- - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • module:packet/public_key#write
    • -
-
- - - -
- - - - - - - - - - - - - -
- +
SecretKey
+
+ + + + + +
@@ -360,13 +135,13 @@ major versions. Consequently, this section is complex.
diff --git a/doc/secret_key.js.html b/doc/secret_key.js.html index 2adff1a8..c33b622f 100644 --- a/doc/secret_key.js.html +++ b/doc/secret_key.js.html @@ -45,7 +45,7 @@ /** * Implementation of the Key Material Packet (Tag 5,6,7,14)<br/> * <br/> - * RFC4480 5.5: + * {@link http://tools.ietf.org/html/rfc4880#section-5.5|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. @@ -58,6 +58,8 @@ * @module packet/secret_key */ +module.exports = SecretKey; + var publicKey = require('./public_key.js'), enums = require('../enums.js'), util = require('../util'), @@ -69,8 +71,6 @@ var publicKey = require('./public_key.js'), * @constructor * @extends module:packet/public_key */ -module.exports = SecretKey; - function SecretKey() { publicKey.call(this); // encrypted secret-key data @@ -143,7 +143,7 @@ function write_cleartext_mpi(hash_algorithm, algorithm, mpi) { // 5.5.3. Secret-Key Packet Formats /** - * Internal parser for private keys as specified in RFC 4880 section 5.5.3 + * Internal parser for private keys as specified in {@link http://tools.ietf.org/html/rfc4880#section-5.5.3|RFC 4880 section 5.5.3} * @param {String} bytes Input string to read the packet from */ SecretKey.prototype.read = function (bytes) { @@ -302,13 +302,13 @@ SecretKey.prototype.generate = function (bits) {
diff --git a/doc/secret_subkey-SecretSubkey.html b/doc/secret_subkey-SecretSubkey.html index 361f45ed..3a185410 100644 --- a/doc/secret_subkey-SecretSubkey.html +++ b/doc/secret_subkey-SecretSubkey.html @@ -125,172 +125,6 @@ -

Methods

- -
- -
-

readPublicKey()

- - -
-
- - -
- Alias of read() -
- - - - - - - - - -
- - - - - - - -
Inherited From:
-
- - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • module:packet/public_key#read
    • -
-
- - - -
- - - - - - - - - - - - - -
- - - -
-

writePublicKey()

- - -
-
- - -
- Alias of write() -
- - - - - - - - - -
- - - - - - - -
Inherited From:
-
- - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • module:packet/public_key#write
    • -
-
- - - -
- - - - - - - - - - - - - -
- -
- @@ -305,13 +139,13 @@
diff --git a/doc/secret_subkey.html b/doc/secret_subkey.html index 39badac9..d3402af0 100644 --- a/doc/secret_subkey.html +++ b/doc/secret_subkey.html @@ -118,13 +118,13 @@
diff --git a/doc/secret_subkey.js.html b/doc/secret_subkey.js.html index 870092aa..078c475f 100644 --- a/doc/secret_subkey.js.html +++ b/doc/secret_subkey.js.html @@ -71,13 +71,13 @@ SecretSubkey.prototype.constructor = SecretSubkey;
diff --git a/doc/sha.html b/doc/sha.html index 5201169c..a28efe2e 100644 --- a/doc/sha.html +++ b/doc/sha.html @@ -454,13 +454,13 @@
diff --git a/doc/sha.js.html b/doc/sha.js.html index 93756caf..2562a03c 100644 --- a/doc/sha.js.html +++ b/doc/sha.js.html @@ -1160,13 +1160,13 @@ module.exports = {
diff --git a/doc/signature-Signature.html b/doc/signature-Signature.html index 4c69ffc5..c02ae4c8 100644 --- a/doc/signature-Signature.html +++ b/doc/signature-Signature.html @@ -812,13 +812,13 @@
diff --git a/doc/signature.html b/doc/signature.html index cc880dfa..cf2596a9 100644 --- a/doc/signature.html +++ b/doc/signature.html @@ -154,7 +154,7 @@ -Integer +module:enums.hash @@ -164,7 +164,7 @@ - hash Algorithm to use (See RFC4880 9.4) + hash Algorithm to use (See RFC 4880 9.4) @@ -177,7 +177,7 @@ -Integer +module:enums.publicKey @@ -187,7 +187,7 @@ - Asymmetric cipher algorithm to use (See RFC4880 9.1) + Asymmetric cipher algorithm to use (See RFC 4880 9.1) @@ -379,7 +379,7 @@ integers which is used to sign the data -Integer +module:enums.publicKey @@ -402,7 +402,7 @@ integers which is used to sign the data -Integer +module:enums.hash @@ -575,13 +575,13 @@ integers which is used to sign the data
diff --git a/doc/signature.js.html b/doc/signature.js.html index 2af0695c..03677875 100644 --- a/doc/signature.js.html +++ b/doc/signature.js.html @@ -38,8 +38,8 @@ var publicKey = require('./public_key'), module.exports = { /** * - * @param {Integer} algo public Key algorithm - * @param {Integer} hash_algo Hash algorithm + * @param {module:enums.publicKey} algo public Key algorithm + * @param {module:enums.hash} hash_algo Hash algorithm * @param {Array<module:type/mpi>} msg_MPIs Signature multiprecision integers * @param {Array<module:type/mpi>} publickey_MPIs Public key multiprecision integers * @param {String} data Data on where the signature was computed on. @@ -89,8 +89,8 @@ module.exports = { /** * Create a signature on data using the specified algorithm - * @param {Integer} hash_algo hash Algorithm to use (See RFC4880 9.4) - * @param {Integer} algo Asymmetric cipher algorithm to use (See RFC4880 9.1) + * @param {module:enums.hash} hash_algo hash Algorithm to use (See {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC 4880 9.4}) + * @param {module:enums.publicKey} algo Asymmetric cipher algorithm to use (See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC 4880 9.1}) * @param {Array<module:type/mpi>} publicMPIs Public key multiprecision integers * of the private key * @param {Array<module:type/mpi>} secretMPIs Private key multiprecision @@ -148,13 +148,13 @@ module.exports = {
diff --git a/doc/signature.js_.html b/doc/signature.js_.html index 4e5a7aa0..0111595b 100644 --- a/doc/signature.js_.html +++ b/doc/signature.js_.html @@ -45,7 +45,7 @@ /** * Implementation of the Signature Packet (Tag 2)<br/> * <br/> - * RFC4480 5.2: + * {@link http://tools.ietf.org/html/rfc4880#section-5.2|RFC4480 5.2}: * A Signature packet describes a binding between some public key and * some data. The most common signatures are a signature of a file or a * block of text, and a signature that is a certification of a User ID. @@ -363,11 +363,11 @@ Signature.prototype.write_all_sub_packets = function () { }; /** - * creates a string representation of a sub signature packet (See RFC 4880 5.2.3.1) + * creates a string representation of a sub signature packet (See {@link http://tools.ietf.org/html/rfc4880#section-5.2.3.1|RFC 4880 5.2.3.1}) * @param {Integer} type subpacket signature type. Signature types as described - * in RFC4880 Section 5.2.3.2 + * in {@link http://tools.ietf.org/html/rfc4880#section-5.2.3.2|RFC4880 Section 5.2.3.2} * @param {String} data data to be included - * @return {String} a string-representation of a sub signature packet (See RFC 4880 5.2.3.1) + * @return {String} a string-representation of a sub signature packet (See {@link http://tools.ietf.org/html/rfc4880#section-5.2.3.1|RFC 4880 5.2.3.1}) */ function write_sub_packet(type, data) { var result = ""; @@ -675,13 +675,13 @@ Signature.prototype.isExpired = function () {
diff --git a/doc/signature_.html b/doc/signature_.html index 917e8717..929a055a 100644 --- a/doc/signature_.html +++ b/doc/signature_.html @@ -40,7 +40,7 @@
Implementation of the Signature Packet (Tag 2)

-RFC4480 5.2: +RFC4480 5.2: A Signature packet describes a binding between some public key and some data. The most common signatures are a signature of a file or a block of text, and a signature that is a certification of a User ID.
@@ -134,7 +134,7 @@ block of text, and a signature that is a certification of a User ID.
- creates a string representation of a sub signature packet (See RFC 4880 5.2.3.1) + creates a string representation of a sub signature packet (See RFC 4880 5.2.3.1)
@@ -185,7 +185,7 @@ block of text, and a signature that is a certification of a User ID. subpacket signature type. Signature types as described -in RFC4880 Section 5.2.3.2 +in RFC4880 Section 5.2.3.2 @@ -264,7 +264,7 @@ in RFC4880 Section 5.2.3.2
- a string-representation of a sub signature packet (See RFC 4880 5.2.3.1) + a string-representation of a sub signature packet (See RFC 4880 5.2.3.1)
@@ -302,13 +302,13 @@ in RFC4880 Section 5.2.3.2
diff --git a/doc/sym_encrypted_integrity_protected-SymEncryptedIntegrityProtected.html b/doc/sym_encrypted_integrity_protected-SymEncryptedIntegrityProtected.html index 6686e458..083fc01f 100644 --- a/doc/sym_encrypted_integrity_protected-SymEncryptedIntegrityProtected.html +++ b/doc/sym_encrypted_integrity_protected-SymEncryptedIntegrityProtected.html @@ -78,7 +78,7 @@
Source:
@@ -158,7 +158,7 @@
Source:
@@ -224,7 +224,7 @@ should be discarded.
Source:
@@ -297,7 +297,7 @@ have been called before -Integer +module:enums.symmetric @@ -361,7 +361,7 @@ have been called before
Source:
@@ -424,13 +424,13 @@ have been called before
diff --git a/doc/sym_encrypted_integrity_protected.html b/doc/sym_encrypted_integrity_protected.html index 613fb3bc..b1752a2d 100644 --- a/doc/sym_encrypted_integrity_protected.html +++ b/doc/sym_encrypted_integrity_protected.html @@ -41,7 +41,8 @@
Implementation of the Sym. Encrypted Integrity Protected Data Packet (Tag 18)

-RFC4880 5.13: The Symmetrically Encrypted Integrity Protected Data packet is +RFC4880 5.13: +The Symmetrically Encrypted Integrity Protected Data packet is a variant of the Symmetrically Encrypted Data packet. It is a new feature created for OpenPGP that addresses the problem of detecting a modification to encrypted data. It is used in combination with a Modification Detection Code @@ -129,13 +130,13 @@ packet.

diff --git a/doc/sym_encrypted_integrity_protected.js.html b/doc/sym_encrypted_integrity_protected.js.html index a373805f..e4f083ae 100644 --- a/doc/sym_encrypted_integrity_protected.js.html +++ b/doc/sym_encrypted_integrity_protected.js.html @@ -46,7 +46,8 @@ * Implementation of the Sym. Encrypted Integrity Protected Data * Packet (Tag 18)<br/> * <br/> - * RFC4880 5.13: The Symmetrically Encrypted Integrity Protected Data packet is + * {@link http://tools.ietf.org/html/rfc4880#section-5.13|RFC4880 5.13}: + * The Symmetrically Encrypted Integrity Protected Data packet is * a variant of the Symmetrically Encrypted Data packet. It is a new feature * created for OpenPGP that addresses the problem of detecting a modification to * encrypted data. It is used in combination with a Modification Detection Code @@ -124,7 +125,7 @@ SymEncryptedIntegrityProtected.prototype.encrypt = function (sessionKeyAlgorithm * Decrypts the encrypted data contained in this object read_packet must * have been called before * - * @param {Integer} sessionKeyAlgorithm + * @param {module:enums.symmetric} sessionKeyAlgorithm * The selected symmetric encryption algorithm to be used * @param {String} key The key of cipher blocksize length to be used * @return {String} The decrypted data of this packet @@ -157,13 +158,13 @@ SymEncryptedIntegrityProtected.prototype.decrypt = function (sessionKeyAlgorithm
diff --git a/doc/sym_encrypted_session_key-SymEncryptedSessionKey.html b/doc/sym_encrypted_session_key-SymEncryptedSessionKey.html index 38254e0a..d52f4b7b 100644 --- a/doc/sym_encrypted_session_key-SymEncryptedSessionKey.html +++ b/doc/sym_encrypted_session_key-SymEncryptedSessionKey.html @@ -415,13 +415,13 @@ packets (tag 1)
diff --git a/doc/sym_encrypted_session_key.html b/doc/sym_encrypted_session_key.html index 4b0c86f6..0e6aba3c 100644 --- a/doc/sym_encrypted_session_key.html +++ b/doc/sym_encrypted_session_key.html @@ -40,7 +40,7 @@
Public-Key Encrypted Session Key Packets (Tag 1)

-RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key +RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key used to encrypt a message. Zero or more Public-Key Encrypted Session Key packets and/or Symmetric-Key Encrypted Session Key packets may precede a Symmetrically Encrypted Data Packet, which holds an encrypted message. The @@ -136,13 +136,13 @@ decrypt the message.

diff --git a/doc/sym_encrypted_session_key.js.html b/doc/sym_encrypted_session_key.js.html index 5472e3f0..43f0be8d 100644 --- a/doc/sym_encrypted_session_key.js.html +++ b/doc/sym_encrypted_session_key.js.html @@ -45,7 +45,7 @@ /** * Public-Key Encrypted Session Key Packets (Tag 1)<br/> * <br/> - * RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key + * {@link http://tools.ietf.org/html/rfc4880#section-5.1|RFC4880 5.1}: A Public-Key Encrypted Session Key packet holds the session key * used to encrypt a message. Zero or more Public-Key Encrypted Session Key * packets and/or Symmetric-Key Encrypted Session Key packets may precede a * Symmetrically Encrypted Data Packet, which holds an encrypted message. The @@ -177,13 +177,13 @@ SymEncryptedSessionKey.prototype.encrypt = function(passphrase) {
diff --git a/doc/symmetrically_encrypted-SymmetricallyEncrypted.html b/doc/symmetrically_encrypted-SymmetricallyEncrypted.html index 3a76d4ca..6ac393f9 100644 --- a/doc/symmetrically_encrypted-SymmetricallyEncrypted.html +++ b/doc/symmetrically_encrypted-SymmetricallyEncrypted.html @@ -240,7 +240,7 @@ -Integer +module:enums.symmetric @@ -250,7 +250,7 @@ - Symmetric key algorithm to use // See RFC4880 9.2 + Symmetric key algorithm to use // See RFC4880 9.2 @@ -346,13 +346,13 @@
diff --git a/doc/symmetrically_encrypted.html b/doc/symmetrically_encrypted.html index bd15c959..a2e811ad 100644 --- a/doc/symmetrically_encrypted.html +++ b/doc/symmetrically_encrypted.html @@ -40,7 +40,7 @@
Implementation of the Symmetrically Encrypted Data Packet (Tag 9)

-RFC4880 5.7: The Symmetrically Encrypted Data packet contains data encrypted +RFC4880 5.7: The Symmetrically Encrypted Data packet contains data encrypted with a symmetric-key algorithm. When it has been decrypted, it contains other packets (usually a literal data packet or compressed data packet, but in theory other Symmetrically Encrypted Data packets or sequences of packets @@ -126,13 +126,13 @@ that form whole OpenPGP messages).

diff --git a/doc/symmetrically_encrypted.js.html b/doc/symmetrically_encrypted.js.html index 3299e661..c7c2ac5a 100644 --- a/doc/symmetrically_encrypted.js.html +++ b/doc/symmetrically_encrypted.js.html @@ -45,7 +45,7 @@ /** * Implementation of the Symmetrically Encrypted Data Packet (Tag 9)<br/> * <br/> - * RFC4880 5.7: The Symmetrically Encrypted Data packet contains data encrypted + * {@link http://tools.ietf.org/html/rfc4880#section-5.7|RFC4880 5.7}: The Symmetrically Encrypted Data packet contains data encrypted * with a symmetric-key algorithm. When it has been decrypted, it contains other * packets (usually a literal data packet or compressed data packet, but in * theory other Symmetrically Encrypted Data packets or sequences of packets @@ -79,8 +79,8 @@ SymmetricallyEncrypted.prototype.write = function () { /** * Symmetrically decrypt the packet data * - * @param {Integer} sessionKeyAlgorithm - * Symmetric key algorithm to use // See RFC4880 9.2 + * @param {module:enums.symmetric} sessionKeyAlgorithm + * Symmetric key algorithm to use // See {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC4880 9.2} * @param {String} key * Key as string with the corresponding length to the * algorithm @@ -108,13 +108,13 @@ SymmetricallyEncrypted.prototype.encrypt = function (algo, key) {
diff --git a/doc/trust-Trust.html b/doc/trust-Trust.html index 356ff365..ae7d8bba 100644 --- a/doc/trust-Trust.html +++ b/doc/trust-Trust.html @@ -133,13 +133,13 @@
diff --git a/doc/trust.html b/doc/trust.html index 91b95d0a..8203a7d5 100644 --- a/doc/trust.html +++ b/doc/trust.html @@ -112,13 +112,13 @@
diff --git a/doc/trust.js.html b/doc/trust.js.html index 58fe327b..80bed661 100644 --- a/doc/trust.js.html +++ b/doc/trust.js.html @@ -46,13 +46,13 @@ function Trust() {
diff --git a/doc/twofish.html b/doc/twofish.html index 2251f994..55b7aeff 100644 --- a/doc/twofish.html +++ b/doc/twofish.html @@ -105,13 +105,13 @@
diff --git a/doc/twofish.js.html b/doc/twofish.js.html index 0990593f..4ecdb7e8 100644 --- a/doc/twofish.js.html +++ b/doc/twofish.js.html @@ -417,13 +417,13 @@ module.exports.blockSize = TF.prototype.blockSize = 16;
diff --git a/doc/user_attribute-UserAttribute.html b/doc/user_attribute-UserAttribute.html index 9359634d..bed1b121 100644 --- a/doc/user_attribute-UserAttribute.html +++ b/doc/user_attribute-UserAttribute.html @@ -254,13 +254,13 @@
diff --git a/doc/user_attribute.html b/doc/user_attribute.html index ac0dc217..38cabb6b 100644 --- a/doc/user_attribute.html +++ b/doc/user_attribute.html @@ -129,13 +129,13 @@ module packet/user_attribute
diff --git a/doc/user_attribute.js.html b/doc/user_attribute.js.html index d08ac87e..8b6d573e 100644 --- a/doc/user_attribute.js.html +++ b/doc/user_attribute.js.html @@ -98,13 +98,13 @@ UserAttribute.prototype.read = function(bytes) {
diff --git a/doc/userid-Userid.html b/doc/userid-Userid.html index f6e65104..1d7b2974 100644 --- a/doc/userid-Userid.html +++ b/doc/userid-Userid.html @@ -414,13 +414,13 @@ John Doe
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:19 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:49 GMT-0800 (PST)
diff --git a/doc/userid.html b/doc/userid.html index 16e61556..8df5bc2d 100644 --- a/doc/userid.html +++ b/doc/userid.html @@ -126,13 +126,13 @@ specifies the length of the User ID.
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:19 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:49 GMT-0800 (PST)
diff --git a/doc/userid.js.html b/doc/userid.js.html index 546814c8..159e63df 100644 --- a/doc/userid.js.html +++ b/doc/userid.js.html @@ -94,13 +94,13 @@ Userid.prototype.write = function () {
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:13 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:43 GMT-0800 (PST)
diff --git a/doc/util.html b/doc/util.html index 7ed3dbba..d3d58dc7 100644 --- a/doc/util.html +++ b/doc/util.html @@ -2000,13 +2000,13 @@ the same as bin2str.
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:19 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:49 GMT-0800 (PST)
diff --git a/doc/util.js.html b/doc/util.js.html index 42cb0bec..ca36f424 100644 --- a/doc/util.js.html +++ b/doc/util.js.html @@ -339,13 +339,13 @@ module.exports = {
- Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 13:32:13 GMT-0800 (PST) + Documentation generated by JSDoc 3.2.0 on Sun Jan 05 2014 23:07:43 GMT-0800 (PST)
diff --git a/src/cleartext.js b/src/cleartext.js index 4d9a4c95..4c1604ae 100644 --- a/src/cleartext.js +++ b/src/cleartext.js @@ -31,7 +31,7 @@ var config = require('./config'), /** * @class * @classdesc Class that represents an OpenPGP cleartext signed message. - * See http://tools.ietf.org/html/rfc4880#section-7 + * See {@link http://tools.ietf.org/html/rfc4880#section-7} * @param {String} text The cleartext of the signed message * @param {module:packet/packetlist} packetlist The packetlist with signature packets or undefined * if message not yet signed diff --git a/src/crypto/cfb.js b/src/crypto/cfb.js index 939d7d24..f28218bf 100644 --- a/src/crypto/cfb.js +++ b/src/crypto/cfb.js @@ -32,7 +32,7 @@ module.exports = { * @param {String} prefixrandom random bytes of block_size length provided * as a string to be used in prefixing the data * @param {String} cipherfn the algorithm cipher class to encrypt - * data in one block_size encryption, @see module:crypto/cipher. + * data in one block_size encryption, {@link module:crypto/cipher}. * @param {String} plaintext data to be encrypted provided as a string * @param {String} key binary string representation of key to be used to encrypt the plaintext. * This will be passed to the cipherfn @@ -174,7 +174,7 @@ module.exports = { * This function decrypts a given plaintext using the specified * blockcipher to decrypt a message * @param {String} cipherfn the algorithm cipher class to decrypt - * data in one block_size encryption, @see module:crypto/cipher. + * data in one block_size encryption, {@link module:crypto/cipher}. * @param {String} key binary string representation of key to be used to decrypt the ciphertext. * This will be passed to the cipherfn * @param {String} ciphertext to be decrypted provided as a string diff --git a/src/crypto/crypto.js b/src/crypto/crypto.js index d6760ba7..8537123e 100644 --- a/src/crypto/crypto.js +++ b/src/crypto/crypto.js @@ -34,7 +34,7 @@ module.exports = { /** * Encrypts data using the specified public key multiprecision integers * and the specified algorithm. - * @param {Integer} algo Algorithm to be used (See RFC4880 9.1) + * @param {module:enums.publicKey} algo Algorithm to be used (See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC 4880 9.1}) * @param {Array} publicMPIs Algorithm dependent multiprecision integers * @param {module:type/mpi} data Data to be encrypted as MPI * @return {Array} if RSA an module:type/mpi; @@ -75,7 +75,7 @@ module.exports = { /** * Decrypts data using the specified public key multiprecision integers of the private key, * the specified secretMPIs of the private key and the specified algorithm. - * @param {Integer} algo Algorithm to be used (See RFC4880 9.1) + * @param {module:enums.publicKey} algo Algorithm to be used (See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC 4880 9.1}) * @param {Array} publicMPIs Algorithm dependent multiprecision integers * of the public key part of the private key * @param {Array} secretMPIs Algorithm dependent multiprecision integers @@ -207,7 +207,7 @@ module.exports = { /** * generate random byte prefix as string for the specified algorithm - * @param {Integer} algo Algorithm to use (see RFC4880 9.2) + * @param {module:enums.symmetric} algo Algorithm to use (see {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC 4880 9.2}) * @return {String} Random bytes with length equal to the block * size of the cipher */ @@ -217,7 +217,7 @@ module.exports = { /** * Generating a session key for the specified symmetric algorithm - * @param {Integer} algo Algorithm to use (see RFC4880 9.2) + * @param {module:enums.symmetric} algo Algorithm to use (see {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC 4880 9.2}) * @return {String} Random bytes as a string to be used as a key */ generateSessionKey: function(algo) { diff --git a/src/crypto/hash/index.js b/src/crypto/hash/index.js index 7086e037..9dcd6a99 100644 --- a/src/crypto/hash/index.js +++ b/src/crypto/hash/index.js @@ -22,7 +22,7 @@ module.exports = { /** * Create a hash on the specified data using the specified algorithm - * @param {Integer} algo Hash algorithm type (see RFC4880 9.4) + * @param {module:enums.hash} algo Hash algorithm type (see {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC 4880 9.4}) * @param {String} data Data to be hashed * @return {String} hash value */ @@ -56,7 +56,7 @@ module.exports = { /** * Returns the hash size in bytes of the specified hash algorithm type - * @param {Integer} algo Hash algorithm type (See RFC4880 9.4) + * @param {module:enums.hash} algo Hash algorithm type (See {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC 4880 9.4}) * @return {Integer} Size in bytes of the resulting hash */ getHashByteLength: function(algo) { diff --git a/src/crypto/pkcs1.js b/src/crypto/pkcs1.js index 330da878..3d70ebe7 100644 --- a/src/crypto/pkcs1.js +++ b/src/crypto/pkcs1.js @@ -26,7 +26,7 @@ */ /** - * ASN1 object identifiers for hashes (See RFC4880 5.2.2) + * ASN1 object identifiers for hashes (See {@link http://tools.ietf.org/html/rfc4880#section-5.2.2}) */ hash_headers = []; hash_headers[1] = [0x30, 0x20, 0x30, 0x0c, 0x06, 0x08, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x02, 0x05, 0x05, 0x00, 0x04, @@ -56,7 +56,7 @@ var crypto = require('./crypto.js'), module.exports = { eme: { /** - * create a EME-PKCS1-v1_5 padding (See RFC4880 13.1.1) + * create a EME-PKCS1-v1_5 padding (See {@link http://tools.ietf.org/html/rfc4880#section-13.1.1|RFC 4880 13.1.1}) * @param {String} message message to be padded * @param {Integer} length Length to the resulting message * @return {String} EME-PKCS1 padded message @@ -76,9 +76,9 @@ module.exports = { }, /** - * decodes a EME-PKCS1-v1_5 padding (See RFC4880 13.1.2) + * decodes a EME-PKCS1-v1_5 padding (See {@link http://tools.ietf.org/html/rfc4880#section-13.1.2|RFC 4880 13.1.2}) * @param {String} message EME-PKCS1 padded message - * @return {String} decoded message + * @return {String} decoded message */ decode: function(message, len) { if (message.length < len) @@ -95,7 +95,7 @@ module.exports = { emsa: { /** - * create a EMSA-PKCS1-v1_5 padding (See RFC4880 13.1.3) + * create a EMSA-PKCS1-v1_5 padding (See {@link http://tools.ietf.org/html/rfc4880#section-13.1.3|RFC 4880 13.1.3}) * @param {Integer} algo Hash algorithm type used * @param {String} data Data to be hashed * @param {Integer} keylength Key size of the public mpi in bytes @@ -121,7 +121,7 @@ module.exports = { }, /** - * extract the hash out of an EMSA-PKCS1-v1.5 padding (See RFC4880 13.1.3) + * extract the hash out of an EMSA-PKCS1-v1.5 padding (See {@link http://tools.ietf.org/html/rfc4880#section-13.1.3|RFC 4880 13.1.3}) * @param {String} data Hash in pkcs1 encoding * @returns {String} The hash as string */ diff --git a/src/crypto/signature.js b/src/crypto/signature.js index 930d7baa..664329be 100644 --- a/src/crypto/signature.js +++ b/src/crypto/signature.js @@ -11,8 +11,8 @@ var publicKey = require('./public_key'), module.exports = { /** * - * @param {Integer} algo public Key algorithm - * @param {Integer} hash_algo Hash algorithm + * @param {module:enums.publicKey} algo public Key algorithm + * @param {module:enums.hash} hash_algo Hash algorithm * @param {Array} msg_MPIs Signature multiprecision integers * @param {Array} publickey_MPIs Public key multiprecision integers * @param {String} data Data on where the signature was computed on. @@ -62,8 +62,8 @@ module.exports = { /** * Create a signature on data using the specified algorithm - * @param {Integer} hash_algo hash Algorithm to use (See RFC4880 9.4) - * @param {Integer} algo Asymmetric cipher algorithm to use (See RFC4880 9.1) + * @param {module:enums.hash} hash_algo hash Algorithm to use (See {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC 4880 9.4}) + * @param {module:enums.publicKey} algo Asymmetric cipher algorithm to use (See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC 4880 9.1}) * @param {Array} publicMPIs Public key multiprecision integers * of the private key * @param {Array} secretMPIs Private key multiprecision diff --git a/src/enums.js b/src/enums.js index b41ca639..f1eb61b1 100644 --- a/src/enums.js +++ b/src/enums.js @@ -15,7 +15,7 @@ module.exports = { gnu: 101 }, - /** RFC4880, section 9.1 + /** {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC4880, section 9.1} * @enum {Integer} * @readonly */ @@ -27,7 +27,7 @@ module.exports = { dsa: 17 }, - /** RFC4880, section 9.2 + /** {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC4880, section 9.2} * @enum {Integer} * @readonly */ @@ -44,7 +44,7 @@ module.exports = { twofish: 10 }, - /** RFC4880, section 9.3 + /** {@link http://tools.ietf.org/html/rfc4880#section-9.3|RFC4880, section 9.3} * @enum {Integer} * @readonly */ @@ -57,7 +57,7 @@ module.exports = { bzip2: 3 }, - /** RFC4880, section 9.4 + /** {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC4880, section 9.4} * @enum {Integer} * @readonly */ diff --git a/src/key.js b/src/key.js index cb9b32f4..9bf95f89 100644 --- a/src/key.js +++ b/src/key.js @@ -423,7 +423,7 @@ Key.prototype.verifyPrimaryKey = function() { return enums.keyStatus.expired; } // check for at least one self signature. Self signature of user ID not mandatory - // See http://tools.ietf.org/html/rfc4880#section-11.1 + // See {@link http://tools.ietf.org/html/rfc4880#section-11.1} var selfSigned = false; for (var i = 0; i < this.users.length; i++) { if (this.users[i].userId && this.users[i].selfCertifications) { @@ -708,8 +708,8 @@ function readArmored(armoredText) { /** * Generates a new OpenPGP key. Currently only supports RSA keys. * Primary and subkey will be of same type. - * @param {Integer} keyType to indicate what type of key to make. - * RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1 + * @param {module:enums.publicKey} keyType to indicate what type of key to make. + * RSA is 1. See {@link http://tools.ietf.org/html/rfc4880#section-9.1} * @param {Integer} numBits number of bits for the key creation. * @param {String} userId assumes already in form of "User Name " * @param {String} passphrase The passphrase used to encrypt the resulting private key diff --git a/src/message.js b/src/message.js index 111c04a2..7fee348c 100644 --- a/src/message.js +++ b/src/message.js @@ -35,7 +35,7 @@ var packet = require('./packet'), * @classdesc Class that represents an OpenPGP message. * Can be an encrypted message, signed message, compressed message or literal message * @param {module:packet/packetlist} packetlist The packets that form this message - * See http://tools.ietf.org/html/rfc4880#section-11.3 + * See {@link http://tools.ietf.org/html/rfc4880#section-11.3} */ function Message(packetlist) { diff --git a/src/openpgp.js b/src/openpgp.js index a3308eac..8fa44259 100644 --- a/src/openpgp.js +++ b/src/openpgp.js @@ -138,8 +138,8 @@ function verifyClearSignedMessage(publicKeys, message) { /** * Generates a new OpenPGP key pair. Currently only supports RSA keys. * Primary and subkey will be of same type. - * @param {Integer} keyType to indicate what type of key to make. - * RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1 + * @param {module:enums.publicKey} keyType to indicate what type of key to make. + * RSA is 1. See {@link http://tools.ietf.org/html/rfc4880#section-9.1} * @param {Integer} numBits number of bits for the key creation. (should be 1024+, generally) * @param {String} userId assumes already in form of "User Name " * @param {String} passphrase The passphrase used to encrypt the resulting private key diff --git a/src/packet/all_packets.js b/src/packet/all_packets.js index 48ed71f3..9f743830 100644 --- a/src/packet/all_packets.js +++ b/src/packet/all_packets.js @@ -39,17 +39,27 @@ module.exports = { Signature: require('./signature.js'), /** @see module:packet/trust */ Trust: require('./trust.js'), - + /** + * Allocate a new packet + * @param {String} tag property name from {@link module:enums.packet} + * @returns {Object} new packet object with type based on tag + */ newPacketFromTag: function (tag) { - return new this[packetClassFromTag(tag)](); + return new this[packetClassFromTagName(tag)](); } }; -function packetClassFromTag(tag) { +/** + * Convert tag name to class name + * @param {String} tag property name from {@link module:enums.packet} + * @returns {String} + */ +function packetClassFromTagName(tag) { return tag.substr(0, 1).toUpperCase() + tag.substr(1); } + for (var i in enums.packet) { - var packetClass = module.exports[packetClassFromTag(i)]; + var packetClass = module.exports[packetClassFromTagName(i)]; if (packetClass !== undefined) packetClass.prototype.tag = enums.packet[i]; diff --git a/src/packet/compressed.js b/src/packet/compressed.js index f0687ed9..3b80e9ba 100644 --- a/src/packet/compressed.js +++ b/src/packet/compressed.js @@ -18,7 +18,7 @@ /** * Implementation of the Compressed Data Packet (Tag 8)
*
- * RFC4880 5.6: The Compressed Data packet contains compressed data. Typically, + * {@link http://tools.ietf.org/html/rfc4880#section-5.6|RFC4880 5.6}: The Compressed Data packet contains compressed data. Typically, * this packet is found as the contents of an encrypted packet, or following * a Signature or One-Pass Signature packet, and contains a literal data packet. * @requires compression/jxg diff --git a/src/packet/index.js b/src/packet/index.js index 2e62eba6..be4e31f2 100644 --- a/src/packet/index.js +++ b/src/packet/index.js @@ -1,6 +1,10 @@ var enums = require('../enums.js'); module.exports = { + /** + * @name module:packet.List + * @see module:packet/packetlist + */ List: require('./packetlist.js') }; diff --git a/src/packet/literal.js b/src/packet/literal.js index 17e76ca6..130f2162 100644 --- a/src/packet/literal.js +++ b/src/packet/literal.js @@ -18,7 +18,7 @@ /** * Implementation of the Literal Data Packet (Tag 11)
*
- * RFC4880 5.9: A Literal Data packet contains the body of a message; data that + * {@link http://tools.ietf.org/html/rfc4880#section-5.9|RFC4880 5.9}: A Literal Data packet contains the body of a message; data that * is not to be further interpreted. * @requires enums * @requires util diff --git a/src/packet/marker.js b/src/packet/marker.js index fd38986e..75ee8a77 100644 --- a/src/packet/marker.js +++ b/src/packet/marker.js @@ -19,7 +19,7 @@ /** * Implementation of the strange "Marker packet" (Tag 10)
*
- * RFC4880 5.8: An experimental version of PGP used this packet as the Literal + * {@link http://tools.ietf.org/html/rfc4880#section-5.8|RFC4880 5.8}: An experimental version of PGP used this packet as the Literal * packet, but no released version of PGP generated Literal packets with this * tag. With PGP 5.x, this packet has been reassigned and is reserved for use as * the Marker packet.
diff --git a/src/packet/one_pass_signature.js b/src/packet/one_pass_signature.js index 33781f07..d5f53a9d 100644 --- a/src/packet/one_pass_signature.js +++ b/src/packet/one_pass_signature.js @@ -18,8 +18,7 @@ /** * Implementation of the One-Pass Signature Packets (Tag 4)
*
- * RFC4880 5.4: - * The One-Pass Signature packet precedes the signed data and contains + * {@link http://tools.ietf.org/html/rfc4880#section-5.4|RFC4880 5.4}: The One-Pass Signature packet precedes the signed data and contains * enough information to allow the receiver to begin calculating any * hashes needed to verify the signature. It allows the Signature * packet to be placed at the end of the message, so that the signer @@ -39,9 +38,9 @@ var enums = require('../enums.js'), */ function OnePassSignature() { this.version = null; // A one-octet version number. The current version is 3. - this.type = null; // A one-octet signature type. Signature types are described in RFC4880 Section 5.2.1. - this.hashAlgorithm = null; // A one-octet number describing the hash algorithm used. (See RFC4880 9.4) - this.publicKeyAlgorithm = null; // A one-octet number describing the public-key algorithm used. (See RFC4880 9.1) + this.type = null; // A one-octet signature type. Signature types are described in {@link http://tools.ietf.org/html/rfc4880#section-5.2.1|RFC4880 Section 5.2.1}. + this.hashAlgorithm = null; // A one-octet number describing the hash algorithm used. (See {@link http://tools.ietf.org/html/rfc4880#section-9.4|RFC4880 9.4}) + this.publicKeyAlgorithm = null; // A one-octet number describing the public-key algorithm used. (See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC4880 9.1}) this.signingKeyId = null; // An eight-octet number holding the Key ID of the signing key. this.flags = null; // A one-octet number holding a flag showing whether the signature is nested. A zero value indicates that the next packet is another One-Pass Signature packet that describes another signature to be applied to the same message data. } diff --git a/src/packet/public_key.js b/src/packet/public_key.js index 1be16ce2..5fa835af 100644 --- a/src/packet/public_key.js +++ b/src/packet/public_key.js @@ -18,7 +18,7 @@ /** * Implementation of the Key Material Packet (Tag 5,6,7,14)
*
- * RFC4480 5.5: + * {@link http://tools.ietf.org/html/rfc4880#section-5.5|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. @@ -57,8 +57,7 @@ function PublicKey() { } /** - * Internal Parser for public keys as specified in RFC 4880 section - * 5.5.2 Public-Key Packet Formats + * Internal Parser for public keys as specified in {@link http://tools.ietf.org/html/rfc4880#section-5.5.2|RFC 4880 section 5.5.2 Public-Key Packet Formats} * called by read_tag<num> * @param {String} input Input string to read the packet from * @return {Object} This object with attributes set by the parser @@ -108,8 +107,7 @@ PublicKey.prototype.read = function (bytes) { /** * Alias of read() - * @function module:packet/public_key#readPublicKey - * @see module:packet/public_key#read + * @see module:packet/public_key~PublicKey#read */ PublicKey.prototype.readPublicKey = PublicKey.prototype.read; @@ -139,8 +137,7 @@ PublicKey.prototype.write = function () { /** * Alias of write() - * @function module:packet/public_key#writePublicKey - * @see module:packet/public_key#write + * @see module:packet/public_key~PublicKey#write */ PublicKey.prototype.writePublicKey = PublicKey.prototype.write; diff --git a/src/packet/public_key_encrypted_session_key.js b/src/packet/public_key_encrypted_session_key.js index 5fc27097..bac2168b 100644 --- a/src/packet/public_key_encrypted_session_key.js +++ b/src/packet/public_key_encrypted_session_key.js @@ -18,7 +18,7 @@ /** * Public-Key Encrypted Session Key Packets (Tag 1)
*
- * RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key + * {@link http://tools.ietf.org/html/rfc4880#section-5.1|RFC4880 5.1}: A Public-Key Encrypted Session Key packet holds the session key * used to encrypt a message. Zero or more Public-Key Encrypted Session Key * packets and/or Symmetric-Key Encrypted Session Key packets may precede a * Symmetrically Encrypted Data Packet, which holds an encrypted message. The @@ -108,13 +108,13 @@ PublicKeyEncryptedSessionKey.prototype.read = function (bytes) { * The public key id corresponding to publicMPIs key as string * @param {Array} publicMPIs * Multiprecision integer objects describing the public key - * @param {Integer} pubalgo - * The corresponding public key algorithm // See RFC4880 9.1 - * @param {Integer} symmalgo + * @param {module:enums.publicKey} pubalgo + * The corresponding public key algorithm // See {@link http://tools.ietf.org/html/rfc4880#section-9.1|RFC4880 9.1} + * @param {module:enums.symmetric} symmalgo * The symmetric cipher algorithm used to encrypt the data * within an encrypteddatapacket or encryptedintegrity- * protecteddatapacket - * following this packet //See RFC4880 9.2 + * following this packet //See {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC4880 9.2} * @param {String} sessionkey * A string of randombytes representing the session key * @return {String} The string representation diff --git a/src/packet/secret_key.js b/src/packet/secret_key.js index 243e9baa..39b7e756 100644 --- a/src/packet/secret_key.js +++ b/src/packet/secret_key.js @@ -18,7 +18,7 @@ /** * Implementation of the Key Material Packet (Tag 5,6,7,14)
*
- * RFC4480 5.5: + * {@link http://tools.ietf.org/html/rfc4880#section-5.5|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. @@ -31,6 +31,8 @@ * @module packet/secret_key */ +module.exports = SecretKey; + var publicKey = require('./public_key.js'), enums = require('../enums.js'), util = require('../util'), @@ -42,8 +44,6 @@ var publicKey = require('./public_key.js'), * @constructor * @extends module:packet/public_key */ -module.exports = SecretKey; - function SecretKey() { publicKey.call(this); // encrypted secret-key data @@ -116,7 +116,7 @@ function write_cleartext_mpi(hash_algorithm, algorithm, mpi) { // 5.5.3. Secret-Key Packet Formats /** - * Internal parser for private keys as specified in RFC 4880 section 5.5.3 + * Internal parser for private keys as specified in {@link http://tools.ietf.org/html/rfc4880#section-5.5.3|RFC 4880 section 5.5.3} * @param {String} bytes Input string to read the packet from */ SecretKey.prototype.read = function (bytes) { diff --git a/src/packet/signature.js b/src/packet/signature.js index c6f15df3..4c6abfc2 100644 --- a/src/packet/signature.js +++ b/src/packet/signature.js @@ -18,7 +18,7 @@ /** * Implementation of the Signature Packet (Tag 2)
*
- * RFC4480 5.2: + * {@link http://tools.ietf.org/html/rfc4880#section-5.2|RFC4480 5.2}: * A Signature packet describes a binding between some public key and * some data. The most common signatures are a signature of a file or a * block of text, and a signature that is a certification of a User ID. @@ -336,11 +336,11 @@ Signature.prototype.write_all_sub_packets = function () { }; /** - * creates a string representation of a sub signature packet (See RFC 4880 5.2.3.1) + * creates a string representation of a sub signature packet (See {@link http://tools.ietf.org/html/rfc4880#section-5.2.3.1|RFC 4880 5.2.3.1}) * @param {Integer} type subpacket signature type. Signature types as described - * in RFC4880 Section 5.2.3.2 + * in {@link http://tools.ietf.org/html/rfc4880#section-5.2.3.2|RFC4880 Section 5.2.3.2} * @param {String} data data to be included - * @return {String} a string-representation of a sub signature packet (See RFC 4880 5.2.3.1) + * @return {String} a string-representation of a sub signature packet (See {@link http://tools.ietf.org/html/rfc4880#section-5.2.3.1|RFC 4880 5.2.3.1}) */ function write_sub_packet(type, data) { var result = ""; diff --git a/src/packet/sym_encrypted_integrity_protected.js b/src/packet/sym_encrypted_integrity_protected.js index 8ca0aa2b..6a6d8c1e 100644 --- a/src/packet/sym_encrypted_integrity_protected.js +++ b/src/packet/sym_encrypted_integrity_protected.js @@ -19,7 +19,8 @@ * Implementation of the Sym. Encrypted Integrity Protected Data * Packet (Tag 18)
*
- * RFC4880 5.13: The Symmetrically Encrypted Integrity Protected Data packet is + * {@link http://tools.ietf.org/html/rfc4880#section-5.13|RFC4880 5.13}: + * The Symmetrically Encrypted Integrity Protected Data packet is * a variant of the Symmetrically Encrypted Data packet. It is a new feature * created for OpenPGP that addresses the problem of detecting a modification to * encrypted data. It is used in combination with a Modification Detection Code @@ -97,7 +98,7 @@ SymEncryptedIntegrityProtected.prototype.encrypt = function (sessionKeyAlgorithm * Decrypts the encrypted data contained in this object read_packet must * have been called before * - * @param {Integer} sessionKeyAlgorithm + * @param {module:enums.symmetric} sessionKeyAlgorithm * The selected symmetric encryption algorithm to be used * @param {String} key The key of cipher blocksize length to be used * @return {String} The decrypted data of this packet diff --git a/src/packet/sym_encrypted_session_key.js b/src/packet/sym_encrypted_session_key.js index bc3686bd..d4ffe624 100644 --- a/src/packet/sym_encrypted_session_key.js +++ b/src/packet/sym_encrypted_session_key.js @@ -18,7 +18,7 @@ /** * Public-Key Encrypted Session Key Packets (Tag 1)
*
- * RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key + * {@link http://tools.ietf.org/html/rfc4880#section-5.1|RFC4880 5.1}: A Public-Key Encrypted Session Key packet holds the session key * used to encrypt a message. Zero or more Public-Key Encrypted Session Key * packets and/or Symmetric-Key Encrypted Session Key packets may precede a * Symmetrically Encrypted Data Packet, which holds an encrypted message. The diff --git a/src/packet/symmetrically_encrypted.js b/src/packet/symmetrically_encrypted.js index 873cdd5f..3c3020fe 100644 --- a/src/packet/symmetrically_encrypted.js +++ b/src/packet/symmetrically_encrypted.js @@ -18,7 +18,7 @@ /** * Implementation of the Symmetrically Encrypted Data Packet (Tag 9)
*
- * RFC4880 5.7: The Symmetrically Encrypted Data packet contains data encrypted + * {@link http://tools.ietf.org/html/rfc4880#section-5.7|RFC4880 5.7}: The Symmetrically Encrypted Data packet contains data encrypted * with a symmetric-key algorithm. When it has been decrypted, it contains other * packets (usually a literal data packet or compressed data packet, but in * theory other Symmetrically Encrypted Data packets or sequences of packets @@ -52,8 +52,8 @@ SymmetricallyEncrypted.prototype.write = function () { /** * Symmetrically decrypt the packet data * - * @param {Integer} sessionKeyAlgorithm - * Symmetric key algorithm to use // See RFC4880 9.2 + * @param {module:enums.symmetric} sessionKeyAlgorithm + * Symmetric key algorithm to use // See {@link http://tools.ietf.org/html/rfc4880#section-9.2|RFC4880 9.2} * @param {String} key * Key as string with the corresponding length to the * algorithm diff --git a/src/type/keyid.js b/src/type/keyid.js index 40cb8d9e..84b3bcdc 100644 --- a/src/type/keyid.js +++ b/src/type/keyid.js @@ -16,7 +16,7 @@ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA /** - * Implementation of type key id (RFC4880 3.3)
+ * Implementation of type key id ({@link http://tools.ietf.org/html/rfc4880#section-3.3|RFC4880 3.3})
*
* A Key ID is an eight-octet scalar that identifies a key. * Implementations SHOULD NOT assume that Key IDs are unique. The diff --git a/src/type/mpi.js b/src/type/mpi.js index 43ddb0f5..fedeb211 100644 --- a/src/type/mpi.js +++ b/src/type/mpi.js @@ -21,7 +21,7 @@ // - MPI = c | d << 8 | e << ((MPI.length -2)*8) | f ((MPI.length -2)*8) /** - * Implementation of type MPI (RFC4880 3.2)
+ * Implementation of type MPI ({@link http://tools.ietf.org/html/rfc4880#section-3.2|RFC4880 3.2})
*
* Multiprecision integers (also called MPIs) are unsigned integers used * to hold large integers such as the ones used in cryptographic @@ -48,7 +48,7 @@ function Mpi() { } /** - * Parsing function for a mpi (RFC 4880 3.2). + * Parsing function for a mpi ({@link http://tools.ietf.org/html/rfc4880#section3.2|RFC 4880 3.2}). * @param {String} input Payload of mpi data * @return {Integer} Length of data read */ @@ -86,7 +86,7 @@ Mpi.prototype.byteLength = function () { }; /** - * Converts the mpi object to a string as specified in RFC4880 3.2 + * Converts the mpi object to a string as specified in {@link http://tools.ietf.org/html/rfc4880#section-3.2|RFC4880 3.2} * @return {String} mpi Byte representation */ Mpi.prototype.write = function () { diff --git a/src/type/s2k.js b/src/type/s2k.js index aa5f8379..53284fe6 100644 --- a/src/type/s2k.js +++ b/src/type/s2k.js @@ -16,7 +16,7 @@ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA /** - * Implementation of the String-to-key specifier (RFC4880 3.7)
+ * Implementation of the String-to-key specifier ({@link http://tools.ietf.org/html/rfc4880#section-3.7|RFC4880 3.7})
*
* String-to-key (S2K) specifiers are used to convert passphrase strings * into symmetric-key encryption/decryption keys. They are used in two @@ -58,7 +58,7 @@ S2k.prototype.get_count = function () { }; /** - * Parsing function for a string-to-key specifier (RFC 4880 3.7). + * Parsing function for a string-to-key specifier ({@link http://tools.ietf.org/html/rfc4880#section-3.7|RFC 4880 3.7}). * @param {String} input Payload of string-to-key specifier * @return {Integer} Actual length of the object */