/**
+ * @requires enums
+ * @module packet
+ */
+var enums = require('../enums.js');
+
+// This is pretty ugly, but browserify needs to have the requires explicitly written.
+
+module.exports = {
+ /** @see module:packet/compressed */
+ compressed: require('./compressed.js'),
+ /** @see module:packet/sym_encrypted_integrity_protected */
+ sym_encrypted_integrity_protected: require('./sym_encrypted_integrity_protected.js'),
+ /** @see module:packet/public_key_encrypted_session_key */
+ public_key_encrypted_session_key: require('./public_key_encrypted_session_key.js'),
+ /** @see module:packet/sym_encrypted_session_key */
+ sym_encrypted_session_key: require('./sym_encrypted_session_key.js'),
+ /** @see module:packet/literal */
+ literal: require('./literal.js'),
+ /** @see module:packet/public_key */
+ public_key: require('./public_key.js'),
+ /** @see module:packet/symmetrically_encrypted */
+ symmetrically_encrypted: require('./symmetrically_encrypted.js'),
+ /** @see module:packet/marker */
+ marker: require('./marker.js'),
+ /** @see module:packet/public_subkey */
+ public_subkey: require('./public_subkey.js'),
+ /** @see module:packet/user_attribute */
+ user_attribute: require('./user_attribute.js'),
+ /** @see module:packet/one_pass_signature */
+ one_pass_signature: require('./one_pass_signature.js'),
+ /** @see module:packet/secret_key */
+ secret_key: require('./secret_key.js'),
+ /** @see module:packet/userid */
+ userid: require('./userid.js'),
+ /** @see module:packet/secret_subkey */
+ secret_subkey: require('./secret_subkey.js'),
+ /** @see module:packet/signature */
+ signature: require('./signature.js'),
+ /** @see module:packet/trust */
+ trust: require('./trust.js')
+}
+
+for (var i in enums.packet) {
+ var packetClass = module.exports[i];
+
+ if (packetClass != undefined)
+ packetClass.prototype.tag = enums.packet[i];
+}
+<inner> armor(messagetype, body, partindex, parttotal) → {String}
+<static> armor(messagetype, body, partindex, parttotal) → {String}
<inner> armor_addheader() → {String}
- - -
- Add additional information to the armor version of an OpenPGP binary
-packet block.
-
-
-
-
-
-
-
-
-
-
--
-
-
-
-
- Version: -
- 2011-12-16
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
- - encoding/armor.js, line 88 -
-
-
-
-
-
-
-
-
Returns:
- - -
- The header information
-
-
-
-
--
-
- - Type - -
- - -String - - - -
<inner> dearmor(text) → {Object}
+<static> dearmor(text) → {Object}
<inner> get_type(text) → {Integer}
+<inner> addheader() → {String}
- Finds out which Ascii Armoring type is used. This is an internal function
+ Add additional information to the armor version of an OpenPGP binary
+packet block.
@@ -617,60 +526,15 @@ an attribute "data" containing the bytes and "type" for the ASCII armor type
- Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
text |
-
-
- - - -String - - - - | - - - - - -[String] ascii armored text | -
-
+
- Version: +
- 2011-12-16
+
@@ -679,6 +543,13 @@ an attribute "data" containing the bytes and "type" for the ASCII armor type
+
+
+
@@ -689,7 +560,7 @@ an attribute "data" containing the bytes and "type" for the ASCII armor type
- Source:
- @@ -714,13 +585,7 @@ an attribute "data" containing the bytes and "type" for the ASCII armor type
- -Integer +String @@ -834,7 +699,7 @@ an attribute "data" containing the bytes and "type" for the ASCII armor type
- Source:
- @@ -884,7 +749,152 @@ an attribute "data" containing the bytes and "type" for the ASCII armor type
-
-
<inner> split_checksum(text) → {Boolean|Object}
+<inner> getType(text) → {Integer}
+ + +
+ -
+
+
+ + Finds out which Ascii Armoring type is used. This is an internal function ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +text+ + +String + + + + + + + + + +[String] ascii armored text +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + encoding/armor.js, line 40 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ 0 = MESSAGE PART n of m + 1 = MESSAGE PART n + 2 = SIGNED MESSAGE + 3 = PGP MESSAGE + 4 = PUBLIC KEY BLOCK + 5 = PRIVATE KEY BLOCK + null = unknown ++ + + +-
+
- + Type + +
- + +Integer + + + +
+
+
+
+ -
+
<inner> splitChecksum(text) → {Boolean|Object}
@@ -973,7 +983,7 @@ an attribute "data" containing the bytes and "type" for the ASCII armor type
- Source:
- @@ -1028,7 +1038,7 @@ and an attribute "checksum" containing the checksum.
-
-
<inner> split_headers(text) → {Boolean|Object}
+<inner> splitHeaders(text) → {Boolean|Object}
@@ -1117,7 +1127,7 @@ and an attribute "checksum" containing the checksum.
- Source:
- @@ -1285,7 +1295,7 @@ given base64 encoded checksum
- Source:
- @@ -1348,13 +1358,13 @@ given base64 encoded checksum
- Source:
- @@ -91,6 +91,288 @@ +
-
+
<static> r2s(t) → {string}
+ + +
+ -
+
+
+ + Convert radix-64 to binary string ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +t+ + +String + + + + + + + + + +radix-64 string to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ binary version of input string ++ + + +-
+
- + Type + +
- + +string + + + +
+
+
+
+ -
+
<static> s2r(t) → {string}
+ + +
+ -
+
+
+ + Convert binary string to radix-64 ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +t+ + +String + + + + + + + + + +binary string to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ radix-64 version of input string ++ + + +-
+
- + Type + +
- + +string + + + +
+
+ - Source:
- @@ -105,13 +105,13 @@
- Source:
- @@ -83,6 +83,14 @@ +
- module:crypto/cipher + +
- module:util +
-
-
<static> decrypt(blockcipherfn, block_size, plaintext, key, resync) → {String}
+<static> decrypt(cipherfn, key, ciphertext, resync) → {String}
@@ -139,54 +147,7 @@ blockcipher to decrypt a message
- Source:
- @@ -333,7 +318,7 @@ blockcipher to decrypt a message
-
-
<static> encrypt(prefixrandom, blockcipherfn, block_size, plaintext, key, resync) → {String}
+<static> encrypt(prefixrandom, cipherfn, plaintext, key, resync) → {String}
@@ -400,13 +385,13 @@ using the specified blockcipher to encrypt a message
- Source:
- @@ -594,7 +556,7 @@ using the specified blockcipher to encrypt a message
-
-
<static> mdc(block_size, key, ciphertext) → {String}
+<static> mdc(key, ciphertext) → {String}
@@ -642,7 +604,7 @@ using the specified blockcipher to encrypt a message
- Source:
- +
- See: +
-
+
-
+
- module:crypto/cipher. +
+
- Source: +
- + + + + + + + +
- module:crypto/cipher/aes + +
- module:crypto/cipher/blowfish + +
- module:crypto/cipher/cast5 + +
- module:crypto/cipher/twofish +
-
+
<static> blowfish
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> cast5
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> des
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> originalDes
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> twofish
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+ -
-
new require("packet/compressed")()
+new (require("packet/compressed"))()
@@ -74,7 +81,7 @@
- Source:
- @@ -148,6 +155,16 @@ +
- module:compression/jxg + +
- module:encoding/base64 + +
- module:enums +
-
+ + Compression algorithm ++
Type:
@@ -201,7 +222,71 @@ - Source:
- + + + + + + + + + + + + + + + +
-
+
compressed :String
+ + +
+ -
+
+ + Compressed packet data ++ + + +
Type:
+-
+
- + +String + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -225,6 +310,10 @@
-
+ + List of packets ++
Type:
@@ -261,7 +350,7 @@ - Source:
- @@ -285,7 +374,7 @@
-
-
compress(type, data) → {String}
+compress()
@@ -302,6 +391,145 @@
+
+
+ - Source: +
- + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
decompress()
+ + +
+ -
+
+
+ + Decompression method for decompressing the compressed data +read by read_packet ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
read(bytes)
+ + +
+ -
+
+
+ + Parsing function for the packet. ++ + + + + + +
Parameters:
@@ -327,30 +555,7 @@- - - - -type- - -Integer - - - - - - - - - -Algorithm to be used // See RFC 4880 9.3 -- - @@ -397,7 +602,7 @@databytes@@ -366,7 +571,7 @@ - Data to be compressed +Payload of a tag 8 packet - Source:
- @@ -418,28 +623,6 @@ -
- - Type - -
- - -String - - - -
-
-
decompress() → {String}
+write() → {String}
@@ -455,8 +638,7 @@
-
-
read(input, position, len) → {module:packet/compressed}
- - -
- -
-
-
- - Parsing function for the packet. -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -input- - -String - - - - - - - - - -Payload of a tag 8 packet -- - - - - -position- - -Integer - - - - - - - - - -Position to start reading from the input string -- - - - - -len- - -Integer - - - - - - - - - -length of the packet or the remaining length of -input at position --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -- Object representation -- - - --
-
- - Type - -
- - -module:packet/compressed - - - -
@@ -738,13 +734,13 @@ input at position
-
-
new config()
- - -
- -
-
-
- - This object contains configuration values and implements -storing and retrieving configuration them from HTML5 local storage. - -This object can be accessed after calling openpgp.init() -using openpgp.config -Stored config parameters can be accessed using -openpgp.config.config -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - config/config.js, line 34 -
-
-
-
-
-
-
-
-
-
-
- -
-
debug
- - -
- -
-
- - If enabled, debug messages will be printed -- - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - config/config.js, line 58 -
-
-
-
-
-
-
-
-
-
-
-
- -
-
prefer_hash_algorithm
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - config/config.js, line 44 -
-
-
-
-
-
-
-
-
Properties:
- --
-
-
- -
- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -prefer_hash_algorithm- - -Integer - - - - - - - - - -- - - - - - -encryption_cipher- - -Integer - - - - - - - - - -- - - - - - -compression- - -Integer - - - - - - - - - -- - - - - - -show_version- - -Boolean - - - - - - - - - -- - - - - - -show_comment- - -Boolean - - - - - - - - - -- - - - - - -integrity_protect- - -Boolean - - - - - - - - - -- - - - - - -keyserver- - -String - - - - - - - - - --
-
- - config - -
- module:enums +
-
-
new require("config/config_localStorage")()
- - -
- -
-
-
- - This object storing and retrieving configuration from HTML5 local storage. - -This object can be accessed after calling openpgp.init() -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
-
-
-
-
- - Source: -
- - - - - - - - -
-
-
<inner> read()
- - -
- -
-
-
- - Reads the config out of the HTML5 local storage -and initializes the object config. -if config is null the default config will be used -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
- -
-
<inner> write()
- - -
- -
-
-
- - Writes the config to HTML5 local storage -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
- - Source:
- @@ -324,7 +336,7 @@
- Source:
- @@ -464,7 +476,7 @@ size of the cipher
- Source:
- @@ -675,7 +687,7 @@ of the private key used
- Source:
- @@ -861,7 +873,7 @@ and the specified algorithm.
- Source:
- @@ -925,13 +937,13 @@ if elgamal encryption an array of two module:type/mpi is returned; otherwise nul
-
+
<static> des
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<static> originalDes
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+ -
-
module:util/util
- - -
- -
-
- - an instance that should be used. -- - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 318 -
-
-
-
-
-
-
-
-
-
- -
-
openpgp_block_cipher_fn(block, key) → {openpgp_byte_array}
- - -
- -
-
-
- - Block cipher function -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -block- - -openpgp_byte_array - - - - - - - - - -A block to perform operations on -- - - - - -key- - -openpgp_byte_array - - - - - - - - - -to use in encryption/decryption --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - crypto/cfb.js, line 30 -
-
-
-
-
-
-
-
-
Returns:
- - -- Encrypted/decrypted block -- - - --
-
- - Type - -
- - -openpgp_byte_array - - - -
-
-
-
- -
-
openpgp_byte_array
- - -
- -
-
- - An array of bytes, that is integers with values from 0 to 255 -- - - -
Type:
--
-
- - -Array -| - -Uint8Array - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - crypto/cfb.js, line 25 -
-
-
-
-
-
-
-
-
-
- - Source: +
- + + + + + + + +
-
+
<static> md5
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> ripemd
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> sha1
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> sha224
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> sha256
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> sha384
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> sha512
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+ -
+
<static> digest(algo, data) → {String}
+ + +
+ -
+
+
+ + Create a hash on the specified data using the specified algorithm ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +algo+ + +Integer + + + + + + + + + +Hash algorithm type (see RFC4880 9.4) ++ + + + + +data+ + +String + + + + + + + + + +Data to be hashed +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ hash value ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> getHashByteLength(algo) → {Integer}
+ + +
+ -
+
+
+ + Returns the hash size in bytes of the specified hash algorithm type ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +algo+ + +Integer + + + + + + + + + +Hash algorithm type (See RFC4880 9.4) +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ Size in bytes of the resulting hash ++ + + +-
+
- + Type + +
- + +Integer + + + +
+
+ - Source:
- @@ -83,6 +83,12 @@ +
- module:util +
-
-
new require("type/keyid")()
+new (require("type/keyid"))()
@@ -74,7 +82,7 @@
- Source:
- @@ -148,6 +156,12 @@ +
- module:util +
-
-
read(input, position) → {module:type/keyid}
+read(input)
@@ -223,30 +237,6 @@
-
- - Source:
- @@ -295,28 +285,6 @@ id from input -
- - Type - -
- - -module:type/keyid - - - -
-
-
new require("keyring/keyring")()
+new (require("keyring/keyring"))(storeHandler)
-
+ + Initialization routine for the keyring. This method reads the +keyring from HTML5 local storage and initializes this instance. ++ +
Parameters:
+ + ++ +
++ + + + + + + +Name + + +Type + + +Argument + + + + +Description ++ + + + + +storeHandler+ + +class + + + + + + ++ + <optional> + + + + +
+ + + + + +class implementing load() and store() methods +-
@@ -74,7 +142,7 @@
- Source:
- @@ -148,6 +216,12 @@ +
- module:openpgp +
-
+
clear()
+ + +
+ -
+
+
+ + Clear the keyring - erase all the keys ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
exportKey(index) → {String}
+ + +
+ -
+
+
+ + returns the armored message representation of the key at key ring index ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +index+ + +Integer + + + + + + + + + +the index of the key within the array +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ armored message representing the key object ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
exportPublicKey(index) → {String}
+ + +
+ -
+
+
+ + returns the armored message representation of the public key portion of the key at key ring index ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +index+ + +Integer + + + + + + + + + +the index of the key within the array +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ armored message representing the public key object ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
getKeysForKeyId(keyId) → {Array.<module:key~Key>}
+ + +
+ -
+
+
+ + Searches the keyring for public keys having the specified key id ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +keyId+ + +String + + + + + + + + + +provided as string of hex number (lowercase) +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ public keys found ++ + + +-
+
- + Type + +
- + +Array.<module:key~Key> + + + +
+
+
+
+ -
+
getPrivateKeyForAddress(email) → {Array.<module:key~Key>}
+ + +
+ -
+
+
+ + Searches the keyring for a private key containing the specified email address ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +email+ + +String + + + + + + + + + +email address to search for +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ private keys found ++ + + +-
+
- + Type + +
- + +Array.<module:key~Key> + + + +
+
+
+
-
getPublicKeyForAddress(email) → {Array.<module:key~Key>}
@@ -250,7 +949,7 @@- Source:
- @@ -300,634 +999,7 @@
-
-
init()
- - -
- -
-
-
- - Initialization routine for the keyring. This method reads the -keyring from HTML5 local storage and initializes this instance. -This method is called by openpgp.init(). -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
- -
-
<inner> exportKey(index) → {String}
- - -
- -
-
-
- - returns the armored message representation of the key at key ring index -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -index- - -Integer - - - - - - - - - -the index of the key within the array --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -- armored message representing the key object -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
<inner> exportPublicKey(index) → {String}
- - -
- -
-
-
- - returns the armored message representation of the public key portion of the key at key ring index -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -index- - -Integer - - - - - - - - - -the index of the key within the array --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -- armored message representing the public key object -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
<inner> getKeysForKeyId(keyId) → {Array.<module:key~Key>}
- - -
- -
-
-
- - Searches the keyring for public keys having the specified key id -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -keyId- - -String - - - - - - - - - -provided as string of hex number (lowercase) --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -- public keys found -- - - --
-
- - Type - -
- - -Array.<module:key~Key> - - - -
-
-
-
- -
-
<inner> getPrivateKeyForAddress(email) → {Array.<module:key~Key>}
- - -
- -
-
-
- - Searches the keyring for a private key containing the specified email address -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -email- - -String - - - - - - - - - -email address to search for --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -- private keys found -- - - --
-
- - Type - -
- - -Array.<module:key~Key> - - - -
-
-
-
- -
-
<inner> importKey(armored)
+importKey(armored)
@@ -1016,7 +1088,7 @@ This method is called by openpgp.init().
- Source:
- @@ -1044,7 +1116,7 @@ This method is called by openpgp.init().
-
-
<inner> removeKey(index) → {module:key~Key}
+removeKey(index) → {module:key~Key}
@@ -1133,7 +1205,7 @@ This method is called by openpgp.init().
- Source:
- @@ -1178,12 +1250,779 @@ This method is called by openpgp.init(). +
Requires
+ +-
+
-
+
+
+
+
+ -
+
store()
+ + +
+ -
+
+
+ + Calls the storeHandler to save the keys ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<inner> checkForIdentityAndKeyTypeMatch(keys, identityFunction, identityInput, keyType) → {Array.<module:key~Key>}
+ + +
+ -
+
+
+ + searches all public keys in the keyring matching the address or address part of the user ids ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +keys+ + +Array.<module:key~Key> + + + + + + + + + +array of keys to search ++ + + + + +identityFunction+ + +module:keyring/keyring.checkCallback + + + + + + + + + +callback function which checks for a match ++ + + + + +identityInput+ + +String + + + + + + + + + +input to check against ++ + + + + +keyType+ + +module:enums.packet + + + + + + + + + +packet types of keys to check +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ array of keys which match ++ + + +-
+
- + Type + +
- + +Array.<module:key~Key> + + + +
+
+
+
+ -
+
<inner> emailCheck(email, key) → {Boolean}
+ + +
+ -
+
+
+ + Checks a key to see if it matches the specified email address ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +email+ + +String + + + + + + + + + +email address to search for ++ + + + + +key+ + +module:key~Key + + + + + + + + + +The key to be checked. +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ True if the email address is defined in the specified key ++ + + +-
+
- + Type + +
- + +Boolean + + + +
+
+
+
+ -
+
<inner> idCheck(id, key) → {Boolean}
+ + +
+ -
+
+
+ + Checks a key to see if it matches the specified keyid ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +id+ + +String + + + + + + + + + +hex string keyid to search for ++ + + + + +key+ + +module:key~Key + + + + + + + + + +the key to be checked. +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ true if the email address is defined in the specified key ++ + + +-
+
- + Type + +
- + +Boolean + + + +
+ -
+
checkCallback(input, key) → {Boolean}
+ + +
+ -
+
+
+ + Callback to check if a key matches the input ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +input+ + +String + + + + + + + + + +input to search for ++ + + + + +key+ + +module:key~Key + + + + + + + + + +The key to be checked. +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ True if the input matches the specified key ++ + + +-
+
- + Type + +
- + +Boolean + + + +
+
+ -
-
new require("packet/literal")()
+new (require("packet/literal"))()
@@ -74,7 +80,7 @@
- Source:
- @@ -148,6 +154,14 @@ +
- module:enums + +
- module:util +
- Source:
- @@ -294,7 +308,7 @@ with normalized end of line to \n
- Source:
- @@ -480,7 +494,7 @@ with normalized end of line to \n
- Source:
- @@ -648,7 +662,7 @@ with normalized end of line to \n
- Source:
- @@ -766,7 +780,7 @@ will be normalized to \r\n and by default text is converted to UTF8
- Source:
- @@ -883,7 +897,7 @@ will be normalized to \r\n and by default text is converted to UTF8
- Source:
- @@ -946,13 +960,13 @@ will be normalized to \r\n and by default text is converted to UTF8
-
+
new (require("config/localStorage"))()
+ + +
+ -
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+
+
+
+
+ - Source: +
- + + + + + + + +
-
+
read()
+ + +
+ -
+
+
+ + Reads the config out of the HTML5 local storage +and initializes the object config. +if config is null the default config will be used ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
write()
+ + +
+ -
+
+
+ + Writes the config to HTML5 local storage ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+ -
-
new require("keyring/localstore")()
-
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
-
+ - module:openpgp +
-
-
init()
+<static> load() → {Array.<module:key~Key>}
@@ -169,9 +112,7 @@
- Source:
- @@ -225,6 +166,28 @@ This method is called by openpgp.init(). +
- + Type + +
- + +Array.<module:key~Key> + + + +
-
-
store()
+<static> store(keys)
@@ -250,6 +213,54 @@ The privateKeys array and publicKeys array gets Stringified using JSON
+ -
-
new require("packet/marker")()
+new (require("packet/marker"))()
@@ -74,7 +84,7 @@
- Source:
- @@ -127,7 +137,7 @@
- Source:
- @@ -297,7 +307,7 @@
- Source:
- @@ -360,13 +370,13 @@
-
+
require("crypto/hash/md5")(entree)
+ + +
+ -
+
+
+ + MD5 hash ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +entree+ + +String + + + + + + + + + +string to hash +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
@@ -62,7 +180,7 @@
- Source:
- @@ -83,6 +201,12 @@ +
- module:util +
- Source: +
- + + + + + +
- See: +
- + + + + + +
- Source:
- @@ -240,7 +240,7 @@ See http://tools.ietf.org/html/rfc4880#section-7
- Source:
- @@ -331,7 +331,7 @@ See http://tools.ietf.org/html/rfc4880#section-7
- Source:
- @@ -422,7 +422,7 @@ See http://tools.ietf.org/html/rfc4880#section-7
- Source:
- @@ -561,7 +561,7 @@ See http://tools.ietf.org/html/rfc4880#section-7
- Source:
- @@ -678,7 +678,7 @@ See http://tools.ietf.org/html/rfc4880#section-7
- Source:
- @@ -741,13 +741,13 @@ See http://tools.ietf.org/html/rfc4880#section-7
- module:config + +
- module:encoding/armor + +
- module:enums + +
- module:packet +
-
-
<inner> readArmored(armoredText) → {module:cleartext~CleartextMessage}
+<static> readArmored(armoredText) → {module:cleartext~CleartextMessage}
@@ -192,7 +204,7 @@
- Source:
- @@ -255,13 +267,13 @@
- Source: +
- + + + + + +
- See: +
- + + + + + +
- Source: +
- + crypto/index.js, line 1 +
+
+
+
+
+
+ - See: +
- + + + + + +
-
+
<static> cfb
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + crypto/index.js, line 11 +
+
+
+
+
+
+ - See: +
- + + + + + +
+
+
+
+ -
+
<static> cipher
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + crypto/index.js, line 7 +
+
+
+
+
+
+ - See: +
- + + + + + +
+
+
+
+ -
+
<static> hash
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + crypto/index.js, line 9 +
+
+
+
+
+
+ - See: +
- + + + + + +
+
+
+
+ -
+
<static> pkcs1
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + crypto/index.js, line 19 +
+
+
+
+
+
+ - See: +
- + + + + + +
+
+
+
+ -
+
<static> publicKey
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + crypto/index.js, line 13 +
+
+
+
+
+
+ - See: +
- + + + + + +
+
+
+
+ -
+
<static> random
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + crypto/index.js, line 17 +
+
+
+
+
+
+ - See: +
- + + + + + +
+
+
+
+ -
+
<static> signature
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + crypto/index.js, line 15 +
+
+
+
+
+
+ - See: +
- + + + + + +
+
+ -
+
<static, readonly> armor :Integer
+ + +
+ -
+
+ + Armor type ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +multipart_section+ + +Integer + + + + + + + + ++ + 0 + + + + ++ + + + + + +multipart_last+ + +Integer + + + + + + + + ++ + 1 + + + + ++ + + + + + +signed+ + +Integer + + + + + + + + ++ + 2 + + + + ++ + + + + + +message+ + +Integer + + + + + + + + ++ + 3 + + + + ++ + + + + + +public_key+ + +Integer + + + + + + + + ++ + 4 + + + + ++ + + + + + +private_key+ + +Integer + + + + + + + + ++ + 5 + + + + ++
+
+
+
+ -
+
<static, readonly> compression :Integer
+ + +
+ -
+
+ + RFC4880, section 9.3 ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +uncompressed+ + +Integer + + + + + + + + ++ + 0 + + + + ++ + + + + + +zip+ + +Integer + + + + + + + + ++ + 1 + + + + +RFC1951 ++ + + + + +zlib+ + +Integer + + + + + + + + ++ + 2 + + + + +RFC1950 ++ + + + + +bzip2+ + +Integer + + + + + + + + ++ + 3 + + + + ++
+
+
+
+ -
+
<static, readonly> hash :Integer
+ + +
+ -
+
+ + RFC4880, section 9.4 ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +md5+ + +Integer + + + + + + + + ++ + 1 + + + + ++ + + + + + +sha1+ + +Integer + + + + + + + + ++ + 2 + + + + ++ + + + + + +ripemd+ + +Integer + + + + + + + + ++ + 3 + + + + ++ + + + + + +sha256+ + +Integer + + + + + + + + ++ + 8 + + + + ++ + + + + + +sha384+ + +Integer + + + + + + + + ++ + 9 + + + + ++ + + + + + +sha512+ + +Integer + + + + + + + + ++ + 10 + + + + ++ + + + + + +sha224+ + +Integer + + + + + + + + ++ + 11 + + + + ++
+
+
+
+ -
+
<static, readonly> keyFlags :Integer
+ + +
+ -
+
+ + Key flags ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +certify_keys+ + +Integer + + + + + + + + ++ + 1 + + + + +0x01 - This key may be used to certify other keys. ++ + + + + +sign_data+ + +Integer + + + + + + + + ++ + 2 + + + + +0x02 - This key may be used to sign data. ++ + + + + +encrypt_communication+ + +Integer + + + + + + + + ++ + 4 + + + + +0x04 - This key may be used to encrypt communications. ++ + + + + +encrypt_storage+ + +Integer + + + + + + + + ++ + 8 + + + + +0x08 - This key may be used to encrypt storage. ++ + + + + +split_private_key+ + +Integer + + + + + + + + ++ + 16 + + + + +0x10 - The private component of this key may have been split + by a secret-sharing mechanism. ++ + + + + +authentication+ + +Integer + + + + + + + + ++ + 32 + + + + +0x20 - This key may be used for authentication. ++ + + + + +shared_private_key+ + +Integer + + + + + + + + ++ + 128 + + + + +0x80 - The private component of this key may be in the + possession of more than one person. +
+
+
+
+ -
+
<static, readonly> keyStatus :Integer
+ + +
+ -
+
+ + Key status ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +invalid+ + +Integer + + + + + + + + ++ + 0 + + + + ++ + + + + + +expired+ + +Integer + + + + + + + + ++ + 1 + + + + ++ + + + + + +revoked+ + +Integer + + + + + + + + ++ + 2 + + + + ++ + + + + + +valid+ + +Integer + + + + + + + + ++ + 3 + + + + ++ + + + + + +no_self_cert+ + +Integer + + + + + + + + ++ + 4 + + + + ++
+
+
+
+ -
+
<static, readonly> literal :Integer
+ + +
+ -
+
+ + Data types in the literal packet ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +binary+ + +Integer + + + + + + + + ++ + CALL + + + + +Binary data 'b' ++ + + + + +text+ + +Integer + + + + + + + + ++ + CALL + + + + +Text data 't' ++ + + + + +utf8+ + +Integer + + + + + + + + ++ + CALL + + + + +Utf8 data 'u' +
+
+
+
+ -
+
<static, readonly> packet :Integer
+ + +
+ -
+
+ + A list of packet types and numeric tags associated with them. ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +public_key_encrypted_session_key+ + +Integer + + + + + + + + ++ + 1 + + + + ++ + + + + + +signature+ + +Integer + + + + + + + + ++ + 2 + + + + ++ + + + + + +sym_encrypted_session_key+ + +Integer + + + + + + + + ++ + 3 + + + + ++ + + + + + +one_pass_signature+ + +Integer + + + + + + + + ++ + 4 + + + + ++ + + + + + +secret_key+ + +Integer + + + + + + + + ++ + 5 + + + + ++ + + + + + +public_key+ + +Integer + + + + + + + + ++ + 6 + + + + ++ + + + + + +secret_subkey+ + +Integer + + + + + + + + ++ + 7 + + + + ++ + + + + + +compressed+ + +Integer + + + + + + + + ++ + 8 + + + + ++ + + + + + +symmetrically_encrypted+ + +Integer + + + + + + + + ++ + 9 + + + + ++ + + + + + +marker+ + +Integer + + + + + + + + ++ + 10 + + + + ++ + + + + + +literal+ + +Integer + + + + + + + + ++ + 11 + + + + ++ + + + + + +trust+ + +Integer + + + + + + + + ++ + 12 + + + + ++ + + + + + +userid+ + +Integer + + + + + + + + ++ + 13 + + + + ++ + + + + + +public_subkey+ + +Integer + + + + + + + + ++ + 14 + + + + ++ + + + + + +user_attribute+ + +Integer + + + + + + + + ++ + 17 + + + + ++ + + + + + +sym_encrypted_integrity_protected+ + +Integer + + + + + + + + ++ + 18 + + + + ++ + + + + + +modification_detection_code+ + +Integer + + + + + + + + ++ + 19 + + + + ++
+
+
+
+ -
+
<static, readonly> publicKey :Integer
+ + +
+ -
+
+ + RFC4880, section 9.1 ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +rsa_encrypt_sign+ + +Integer + + + + + + + + ++ + 1 + + + + ++ + + + + + +rsa_encrypt+ + +Integer + + + + + + + + ++ + 2 + + + + ++ + + + + + +rsa_sign+ + +Integer + + + + + + + + ++ + 3 + + + + ++ + + + + + +elgamal+ + +Integer + + + + + + + + ++ + 16 + + + + ++ + + + + + +dsa+ + +Integer + + + + + + + + ++ + 17 + + + + ++
+
+
+
+ -
+
<static, readonly> s2k :Integer
+ + +
+ -
+
+ + A string to key specifier type ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +simple+ + +Integer + + + + + + + + ++ + 0 + + + + ++ + + + + + +salted+ + +Integer + + + + + + + + ++ + 1 + + + + ++ + + + + + +iterated+ + +Integer + + + + + + + + ++ + 3 + + + + ++ + + + + + +gnu+ + +Integer + + + + + + + + ++ + 101 + + + + ++
+
+
+
+ -
+
<static, readonly> signature :Integer
+ + +
+ -
+
+ + One pass signature packet type ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +binary+ + +Integer + + + + + + + + ++ + 0 + + + + +0x00: Signature of a binary document. ++ + + + + +text+ + +Integer + + + + + + + + ++ + 1 + + + + +0x01: Signature of a canonical text document. +
+Canonicalyzing the document by converting line endings.+ + + + + +standalone+ + +Integer + + + + + + + + ++ + 2 + + + + +0x02: Standalone signature. +
+This signature is a signature of only its own subpacket contents. +It is calculated identically to a signature over a zero-lengh +binary document. Note that it doesn't make sense to have a V3 +standalone signature.+ + + + + +cert_generic+ + +Integer + + + + + + + + ++ + 16 + + + + +0x10: Generic certification of a User ID and Public-Key packet. +
+The issuer of this certification does not make any particular +assertion as to how well the certifier has checked that the owner +of the key is in fact the person described by the User ID.+ + + + + +cert_persona+ + +Integer + + + + + + + + ++ + 17 + + + + +0x11: Persona certification of a User ID and Public-Key packet. +
+The issuer of this certification has not done any verification of +the claim that the owner of this key is the User ID specified.+ + + + + +cert_casual+ + +Integer + + + + + + + + ++ + 18 + + + + +0x12: Casual certification of a User ID and Public-Key packet. +
+The issuer of this certification has done some casual +verification of the claim of identity.+ + + + + +cert_positive+ + +Integer + + + + + + + + ++ + 19 + + + + +0x13: Positive certification of a User ID and Public-Key packet. +
+The issuer of this certification has done substantial +verification of the claim of identity.
+
+Most OpenPGP implementations make their "key signatures" as 0x10 +certifications. Some implementations can issue 0x11-0x13 +certifications, but few differentiate between the types.+ + + + + +cert_revocation+ + +Integer + + + + + + + + ++ + 48 + + + + +0x30: Certification revocation signature +
+This signature revokes an earlier User ID certification signature +(signature class 0x10 through 0x13) or direct-key signature +(0x1F). It should be issued by the same key that issued the +revoked signature or an authorized revocation key. The signature +is computed over the same data as the certificate that it +revokes, and should have a later creation date than that +certificate.+ + + + + +subkey_binding+ + +Integer + + + + + + + + ++ + 24 + + + + +0x18: Subkey Binding Signature +
+This signature is a statement by the top-level signing key that +indicates that it owns the subkey. This signature is calculated +directly on the primary key and subkey, and not on any User ID or +other packets. A signature that binds a signing subkey MUST have +an Embedded Signature subpacket in this binding signature that +contains a 0x19 signature made by the signing subkey on the +primary key and subkey.+ + + + + +key_binding+ + +Integer + + + + + + + + ++ + 25 + + + + +0x19: Primary Key Binding Signature +
+This signature is a statement by a signing subkey, indicating +that it is owned by the primary key and subkey. This signature +is calculated the same way as a 0x18 signature: directly on the +primary key and subkey, and not on any User ID or other packets.
+
+When a signature is made over a key, the hash data starts with the +octet 0x99, followed by a two-octet length of the key, and then body +of the key packet. (Note that this is an old-style packet header for +a key packet with two-octet length.) A subkey binding signature +(type 0x18) or primary key binding signature (type 0x19) then hashes +the subkey using the same format as the main key (also using 0x99 as +the first octet).+ + + + + +key+ + +Integer + + + + + + + + ++ + 31 + + + + +0x1F: Signature directly on a key +
+This signature is calculated directly on a key. It binds the +information in the Signature subpackets to the key, and is +appropriate to be used for subpackets that provide information +about the key, such as the Revocation Key subpacket. It is also +appropriate for statements that non-self certifiers want to make +about the key itself, rather than the binding between a key and a +name.+ + + + + +key_revocation+ + +Integer + + + + + + + + ++ + 32 + + + + +0x20: Key revocation signature +
+The signature is calculated directly on the key being revoked. A +revoked key is not to be used. Only revocation signatures by the +key being revoked, or by an authorized revocation key, should be +considered valid revocation signatures.a+ + + + + +subkey_revocation+ + +Integer + + + + + + + + ++ + 40 + + + + +0x28: Subkey revocation signature +
+The signature is calculated directly on the subkey being revoked. +A revoked subkey is not to be used. Only revocation signatures +by the top-level signature key that is bound to this subkey, or +by an authorized revocation key, should be considered valid +revocation signatures.
+
+Key revocation signatures (types 0x20 and 0x28) +hash only the key being revoked.+ + + + + +timestamp+ + +Integer + + + + + + + + ++ + 64 + + + + +0x40: Timestamp signature. +
+This signature is only meaningful for the timestamp contained in +it.+ + + + + +third_party+ + +Integer + + + + + + + + ++ + 80 + + + + +0x50: Third-Party Confirmation signature. +
+This signature is a signature over some other OpenPGP Signature +packet(s). It is analogous to a notary seal on the signed data. +A third-party signature SHOULD include Signature Target +subpacket(s) to give easy identification. Note that we really do +mean SHOULD. There are plausible uses for this (such as a blind +party that only sees the signature, not the key or source +document) that cannot include a target subpacket.
+
+
+
+ -
+
<static, readonly> signatureSubpacket :Integer
+ + +
+ -
+
+ + Signature subpacket type ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +signature_creation_time+ + +Integer + + + + + + + + ++ + 2 + + + + ++ + + + + + +signature_expiration_time+ + +Integer + + + + + + + + ++ + 3 + + + + ++ + + + + + +exportable_certification+ + +Integer + + + + + + + + ++ + 4 + + + + ++ + + + + + +trust_signature+ + +Integer + + + + + + + + ++ + 5 + + + + ++ + + + + + +regular_expression+ + +Integer + + + + + + + + ++ + 6 + + + + ++ + + + + + +revocable+ + +Integer + + + + + + + + ++ + 7 + + + + ++ + + + + + +key_expiration_time+ + +Integer + + + + + + + + ++ + 9 + + + + ++ + + + + + +placeholder_backwards_compatibility+ + +Integer + + + + + + + + ++ + 10 + + + + ++ + + + + + +preferred_symmetric_algorithms+ + +Integer + + + + + + + + ++ + 11 + + + + ++ + + + + + +revocation_key+ + +Integer + + + + + + + + ++ + 12 + + + + ++ + + + + + +issuer+ + +Integer + + + + + + + + ++ + 16 + + + + ++ + + + + + +notation_data+ + +Integer + + + + + + + + ++ + 20 + + + + ++ + + + + + +preferred_hash_algorithms+ + +Integer + + + + + + + + ++ + 21 + + + + ++ + + + + + +preferred_compression_algorithms+ + +Integer + + + + + + + + ++ + 22 + + + + ++ + + + + + +key_server_preferences+ + +Integer + + + + + + + + ++ + 23 + + + + ++ + + + + + +preferred_key_server+ + +Integer + + + + + + + + ++ + 24 + + + + ++ + + + + + +primary_user_id+ + +Integer + + + + + + + + ++ + 25 + + + + ++ + + + + + +policy_uri+ + +Integer + + + + + + + + ++ + 26 + + + + ++ + + + + + +key_flags+ + +Integer + + + + + + + + ++ + 27 + + + + ++ + + + + + +signers_user_id+ + +Integer + + + + + + + + ++ + 28 + + + + ++ + + + + + +reason_for_revocation+ + +Integer + + + + + + + + ++ + 29 + + + + ++ + + + + + +features+ + +Integer + + + + + + + + ++ + 30 + + + + ++ + + + + + +signature_target+ + +Integer + + + + + + + + ++ + 31 + + + + ++ + + + + + +embedded_signature+ + +Integer + + + + + + + + ++ + 32 + + + + ++
+
+
+
+ -
+
<static, readonly> symmetric :Integer
+ + +
+ -
+
+ + RFC4880, section 9.2 ++ + + +
Type:
+-
+
- + +Integer + + + +
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
+ + + + + + + +Name + + +Type + + + + +Default + + +Description ++ + + + + +plaintext+ + +Integer + + + + + + + + ++ + 0 + + + + ++ + + + + + +idea+ + +Integer + + + + + + + + ++ + 1 + + + + +Not implemented! ++ + + + + +tripledes+ + +Integer + + + + + + + + ++ + 2 + + + + ++ + + + + + +cast5+ + +Integer + + + + + + + + ++ + 3 + + + + ++ + + + + + +blowfish+ + +Integer + + + + + + + + ++ + 4 + + + + ++ + + + + + +aes128+ + +Integer + + + + + + + + ++ + 7 + + + + ++ + + + + + +aes192+ + +Integer + + + + + + + + ++ + 8 + + + + ++ + + + + + +aes256+ + +Integer + + + + + + + + ++ + 9 + + + + ++ + + + + + +twofish+ + +Integer + + + + + + + + ++ + 10 + + + + ++
+
+ -
+
<static> read()
+ + +
+ -
+
+
+ + Converts from an integer to string. ++ + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
-
+
<static> write()
+ + +
+ -
+
+
+ + Asserts validity and converts from string/integer to integer. ++ + + + + + + + + + + + + + + + + + + + + + + +
+
+
- Source:
- @@ -216,7 +216,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -355,7 +355,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -517,7 +517,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -567,7 +567,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
-
-
getAllKeyPackets() → {Array.<(module:packet/public_subkey|module:packet/secret_subkey|module:packet/secret_key|module:packet/public_key)>}
+getAllKeyPackets() → {Array.<(module:packet/public_subkey|module:packet/secret_subkey|module:packet/secret_key|module:packet/public_key)>}
@@ -608,7 +608,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -640,7 +640,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- -Array.<(module:packet/public_subkey|module:packet/secret_subkey|module:packet/secret_key|module:packet/public_key)> +Array.<(module:packet/public_subkey|module:packet/secret_subkey|module:packet/secret_key|module:packet/public_key)> @@ -654,7 +654,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
-
-
getEncryptionKeyPacket() → {module:packet/public_subkey|module:packet/secret_subkey|module:packet/secret_key|module:packet/public_key|null}
+getEncryptionKeyPacket() → {module:packet/public_subkey|module:packet/secret_subkey|module:packet/secret_key|module:packet/public_key|null}
@@ -695,7 +695,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -740,7 +740,7 @@ Can contain additional subkeys, signatures, user ids, user attributes. module:packet/secret_key | -module:packet/public_key +module:packet/public_key | null @@ -798,7 +798,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -844,7 +844,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
-
-
getKeyPacket() → {module:packet/secret_key|module:packet/public_key|null}
+getKeyPacket() → {module:packet/secret_key|module:packet/public_key|null}
@@ -885,7 +885,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -920,7 +920,7 @@ Can contain additional subkeys, signatures, user ids, user attributes. module:packet/secret_key | -module:packet/public_key +module:packet/public_key | null @@ -978,7 +978,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1067,7 +1067,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1206,7 +1206,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1258,7 +1258,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
-
-
getPublicKeyPacket(keyIds) → {module:packet/public_subkey|module:packet/public_key|null}
+getPublicKeyPacket(keyIds) → {module:packet/public_subkey|module:packet/public_key|null}
@@ -1347,7 +1347,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1382,7 +1382,7 @@ Can contain additional subkeys, signatures, user ids, user attributes. module:packet/public_subkey | -module:packet/public_key +module:packet/public_key | null @@ -1440,7 +1440,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1537,7 +1537,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1624,7 +1624,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1715,7 +1715,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1802,7 +1802,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -1937,7 +1937,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -2006,7 +2006,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -2097,7 +2097,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
- Source:
- @@ -2189,7 +2189,7 @@ and valid self signature
- Source:
- @@ -2252,13 +2252,13 @@ and valid self signature
- Source:
- @@ -177,7 +177,7 @@ module:packet/secret_key | -module:packet/public_key +module:packet/public_key @@ -218,7 +218,7 @@
- Source:
- @@ -315,7 +315,7 @@ module:packet/secret_key | -module:packet/public_key +module:packet/public_key @@ -356,7 +356,7 @@
- Source:
- @@ -443,7 +443,7 @@
- Source:
- @@ -531,7 +531,7 @@ and valid binding signature
- Source:
- @@ -594,13 +594,13 @@ and valid binding signature
- Source:
- @@ -177,7 +177,7 @@ module:packet/secret_key | -module:packet/public_key +module:packet/public_key @@ -218,7 +218,7 @@
- Source:
- @@ -342,7 +342,7 @@ module:packet/secret_key | -module:packet/public_key +module:packet/public_key @@ -383,7 +383,7 @@
- Source:
- @@ -474,7 +474,7 @@
- Source:
- @@ -572,7 +572,7 @@ and validity of self signature module:packet/secret_key | -module:packet/public_key +module:packet/public_key @@ -613,7 +613,7 @@ and validity of self signature
- Source:
- @@ -676,13 +676,13 @@ and validity of self signature
- module:config + +
- module:encoding/armor + +
- module:enums + +
- module:packet +
-
-
<inner> generate(keyType, numBits, userId, passphrase) → {module:key~Key}
+<static> generate(keyType, numBits, userId, passphrase) → {module:key~Key}
@@ -269,7 +281,7 @@ Primary and subkey will be of same type.
- Source:
- @@ -315,7 +327,7 @@ Primary and subkey will be of same type.
-
-
<inner> readArmored(armoredText) → {Object}
+<static> readArmored(armoredText) → {Object}
@@ -404,7 +416,7 @@ Primary and subkey will be of same type.
- Source:
- @@ -467,13 +479,13 @@ Primary and subkey will be of same type.
- Source: +
- + + + + + +
- See: +
- + + + + + +
- Source:
- - message.js, line 35 + message.js, line 41
@@ -217,7 +217,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 256 + message.js, line 262
@@ -356,7 +356,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 82 + message.js, line 88
@@ -495,7 +495,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 136 + message.js, line 142
@@ -586,7 +586,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 46 + message.js, line 52
@@ -677,7 +677,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 113 + message.js, line 119
@@ -771,7 +771,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 59 + message.js, line 65
@@ -862,7 +862,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 122 + message.js, line 128
@@ -1004,7 +1004,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 173 + message.js, line 179
@@ -1095,7 +1095,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 243 + message.js, line 249
@@ -1234,7 +1234,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- Source:
- - message.js, line 218 + message.js, line 224
@@ -1297,13 +1297,13 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
- module:config + +
- module:crypto + +
- module:encoding/armor + +
- module:enums + +
- module:packet +
-
-
<inner> fromBinary(bytes) → {module:message~Message}
+<static> fromBinary(bytes) → {module:message~Message}
@@ -192,7 +206,7 @@
- Source:
- - message.js, line 295 + message.js, line 304
@@ -242,7 +256,7 @@
-
-
<inner> fromText(text) → {module:message~Message}
+<static> fromText(text) → {module:message~Message}
@@ -331,7 +345,7 @@
- Source:
- - message.js, line 280 + message.js, line 288
@@ -381,7 +395,7 @@
-
-
<inner> readArmored(armoredText) → {module:message~Message}
+<static> readArmored(armoredText) → {module:message~Message}
@@ -470,7 +484,7 @@
- Source:
- - message.js, line 265 + message.js, line 272
@@ -533,13 +547,13 @@
- Source: +
- + + + + + +
- See: +
-
+
-
+
- module:type/mpi +
+
+
+
+ - Source:
- - openpgp.js, line 24 + openpgp.js, line 20
@@ -83,6 +83,22 @@
+ - module:cleartext + +
- module:config + +
- module:encoding/armor + +
- module:enums + +
- module:message + +
- module:packet +
-
-
<inner> decryptAndVerifyMessage(privateKey, publicKeys, message) → {Object}
+<static> decryptAndVerifyMessage(privateKey, publicKeys, message) → {Object}
@@ -231,7 +247,7 @@
- Source:
- - openpgp.js, line 84 + openpgp.js, line 96
@@ -282,7 +298,7 @@
-
-
<inner> decryptMessage(privateKey, message) → {String|null}
+<static> decryptMessage(privateKey, message) → {String|null}
@@ -394,7 +410,7 @@
- Source:
- - openpgp.js, line 70 + openpgp.js, line 81
@@ -448,7 +464,7 @@
-
-
<inner> encryptMessage(keys, text) → {String}
+<static> encryptMessage(keys, text) → {String}
@@ -560,7 +576,7 @@
- Source:
- - openpgp.js, line 41 + openpgp.js, line 50
@@ -610,7 +626,7 @@
-
-
<inner> generateKeyPair(keyType, numBits, userId, passphrase) → {Object}
+<static> generateKeyPair(keyType, numBits, userId, passphrase) → {Object}
@@ -770,7 +786,7 @@ Primary and subkey will be of same type.
- Source:
- - openpgp.js, line 134 + openpgp.js, line 149
@@ -820,7 +836,7 @@ Primary and subkey will be of same type.
-
-
<inner> signAndEncryptMessage(publicKeys, privateKey, text) → {String}
+<static> signAndEncryptMessage(publicKeys, privateKey, text) → {String}
@@ -955,7 +971,7 @@ Primary and subkey will be of same type.
- Source:
- - openpgp.js, line 55 + openpgp.js, line 65
@@ -1005,7 +1021,7 @@ Primary and subkey will be of same type.
-
-
<inner> signClearMessage(privateKeys, text) → {String}
+<static> signClearMessage(privateKeys, text) → {String}
@@ -1117,7 +1133,7 @@ Primary and subkey will be of same type.
- Source:
- - openpgp.js, line 101 + openpgp.js, line 114
@@ -1167,7 +1183,7 @@ Primary and subkey will be of same type.
-
-
<inner> verifyClearSignedMessage(publicKeys, message) → {Object}
+<static> verifyClearSignedMessage(publicKeys, message) → {Object}
@@ -1279,7 +1295,7 @@ Primary and subkey will be of same type.
- Source:
- - openpgp.js, line 114 + openpgp.js, line 128
@@ -1342,13 +1358,13 @@ Primary and subkey will be of same type.
- Source: +
- + + + + + + + +
- module:enums +
-
+
<static> compressed
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> literal
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> marker
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> one_pass_signature
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> public_key
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> public_key_encrypted_session_key
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> public_subkey
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> secret_key
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> secret_subkey
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> signature
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> sym_encrypted_integrity_protected
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> sym_encrypted_session_key
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> symmetrically_encrypted
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> trust
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> user_attribute
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
<static> userid
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+ - Source: +
- + + + + + +
- See: +
-
+
-
+
- module:type/s2k +
+
+
+
+ - Source: +
- + + + + + +
- See: +
-
+
-
+
- module:util/util +
+
+
+
+ -
-
new require("type/mpi")()
+new (require("type/mpi"))()
@@ -74,7 +84,7 @@
- Source:
- - type/mpi.js, line 38 + type/mpi.js, line 43
@@ -148,6 +158,14 @@
+ - Source:
- - type/mpi.js, line 40 + type/mpi.js, line 45
@@ -219,7 +237,7 @@
-
-
read(input, position, len) → {module:type/mpi}
+read(input) → {Integer}
@@ -281,54 +299,6 @@
-
- - Source:
- - type/mpi.js, line 51 + type/mpi.js, line 52
@@ -381,7 +351,7 @@ input at position
- -module:type/mpi +Integer @@ -447,7 +417,7 @@ input at position
- Source:
- - type/mpi.js, line 88 + type/mpi.js, line 89
@@ -510,13 +480,13 @@ input at position
-
-
new require("packet/one_pass_signature")()
+new (require("packet/one_pass_signature"))()
@@ -74,7 +84,7 @@
- Source:
- @@ -148,6 +158,14 @@ +
- module:enums + +
- module:type/keyid +
- Source:
- @@ -341,7 +359,7 @@
- Source:
- @@ -404,13 +422,13 @@
- module:enums + +
- module:util +
- Source:
- @@ -394,7 +402,7 @@ string
- Source:
- @@ -557,7 +565,7 @@ string
- Source:
- @@ -697,7 +705,7 @@ string
- Source:
- @@ -760,13 +768,13 @@ string
-
-
new require("packet/packetlist")()
+new (require("packet/packetlist"))()
@@ -74,7 +79,7 @@
- Source:
- @@ -148,6 +153,16 @@ +
- module:enums + +
- module:packet + +
- module:packet/packet +
- Source:
- @@ -270,7 +285,7 @@
- Source:
- @@ -339,7 +354,7 @@
- Source:
- @@ -408,7 +423,7 @@
- Source:
- @@ -525,7 +540,7 @@
- Source:
- @@ -615,7 +630,7 @@
- Source:
- @@ -684,7 +699,7 @@
- Source:
- @@ -754,7 +769,7 @@ writing to packetlist[i] directly will result in an error.
- Source:
- @@ -782,7 +797,7 @@ writing to packetlist[i] directly will result in an error.
-
-
read(An)
+read(A)
@@ -824,13 +839,13 @@ writing to packetlist[i] directly will result in an error.
- Source:
- @@ -940,7 +955,7 @@ writing to packetlist[i] directly will result in an error.
- Source:
- @@ -968,7 +983,7 @@ writing to packetlist[i] directly will result in an error.
-
-
write() → {openpgp_byte_array}
+write() → {String}
@@ -1010,7 +1025,7 @@ class instance.
- Source:
- @@ -1035,7 +1050,7 @@ class instance.
- -openpgp_byte_array +String @@ -1073,13 +1088,13 @@ class instance.
- module:crypto/crypto + +
- module:crypto/hash + +
- module:crypto/public_key/jsbn + +
- module:crypto/random + +
- module:util +
- Source:
- @@ -163,13 +179,13 @@
-
-
new require("packet/public_key")()
- - -
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
@@ -127,7 +62,7 @@
- Source:
- @@ -148,6 +83,16 @@ +
- module:crypto/public_key/dsa + +
- module:crypto/public_key/elgamal + +
- module:crypto/public_key/rsa +
-
-
algorithm :openpgp.publickey
+<static> dsa
-
- - Public key algorithm -- -
Type:
--
-
- - -openpgp.publickey - - - -
-
@@ -205,13 +136,20 @@
- Source:
- +
- See: +
- + + +
-
-
created :Date
+<static> elgamal
-
- - Key creation date. -- -
Type:
--
-
- - -Date - - - -
-
@@ -269,13 +193,20 @@
- Source:
- +
- See: +
- + + +
-
-
mpi :module:type/mpi
+<static> rsa
-
- - A list of multiprecision integers -+ + + + +
-
+
+
-
- Source: +
- + + + + + +
- See: +
-
-
-
- - -module:type/mpi - - - +
- module:crypto/public_key/rsa
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
- -
-
readPublicKey
- - -
- -
-
- - Internal Parser for public keys as specified in RFC 4880 section -5.5.2 Public-Key Packet Formats -called by read_tag<num> -- - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - +
@@ -408,192 +276,6 @@ called by read_tag<num>
- -
-
getFingerprint() → {String}
- - -
- -
-
-
- - Calculates the fingerprint of the key -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -- A string containing the fingerprint -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
getKeyId() → {String}
- - -
- -
-
-
- - Calculates the key id of the key -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -- A 8 byte key id -- - - --
-
- - Type - -
- - -String - - - -
-
-
Type:
+ + + + + + + + + + + + + + +Methods
- --
-
-
-
+
new (require("packet/public_key"))()
+ + +
+ -
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+
+
+
+
+ - Source: +
- + + + + + + + +
- module:crypto + +
- module:enums + +
- module:type/keyid + +
- module:type/mpi + +
- module:util +
-
+
algorithm :module:enums.publicKey
+ + +
+ -
+
+ + Public key algorithm ++ + + +
Type:
+-
+
- + +module:enums.publicKey + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
created :Date
+ + +
+ -
+
+ + Key creation date. ++ + + +
Type:
+-
+
- + +Date + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
mpi :module:type/mpi
+ + +
+ -
+
+ + A list of multiprecision integers ++ + + +
Type:
+-
+
- + +module:type/mpi + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+ -
+
getFingerprint() → {String}
+ + +
+ -
+
+
+ + Calculates the fingerprint of the key ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ A string containing the fingerprint ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
getKeyId() → {String}
+ + +
+ -
+
+
+ + Calculates the key id of the key ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ A 8 byte key id ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
read(input) → {Object}
+ + +
+ -
+
+
+ + Internal Parser for public keys as specified in RFC 4880 section +5.5.2 Public-Key Packet Formats +called by read_tag<num> ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +input+ + +String + + + + + + + + + +Input string to read the packet from +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ This object with attributes set by the parser ++ + + +-
+
- + Type + +
- + +Object + + + +
+
+
+
+ -
+
readPublicKey()
+ + +
+ -
+
+
+ + Alias of read() ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
write() → {Object}
+ + +
+ -
+
+
+ + Same as write_private_key, but has less information because of +public key. ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + ++ {body: [string]OpenPGP packet body contents, +header: [string] OpenPGP packet header, string: [string] header+body} ++ + + +-
+
- + Type + +
- + +Object + + + +
+
+
+
+ -
+
writeOld()
+ + +
+ -
+
+
+ + Write an old version packet - it's used by some of the internal routines. ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
writePublicKey()
+ + +
+ -
+
+
+ + Alias of write() ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+ -
-
new require("packet/public_key_encrypted_session_key")()
+new (require("packet/public_key_encrypted_session_key"))()
@@ -74,7 +89,7 @@
- Source:
- @@ -148,6 +163,20 @@ +
- module:crypto + +
- module:enums + +
- module:type/keyid + +
- module:type/mpi + +
- module:util +
- Source:
- @@ -315,7 +344,7 @@ packets (tag 1)
- Source:
- @@ -501,7 +530,7 @@ packets (tag 1)
- Source:
- @@ -735,7 +764,7 @@ packets (tag 1)
- Source:
- @@ -798,13 +827,13 @@ packets (tag 1)
-
+
new (require("packet/public_subkey"))()
+ + +
+ -
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
@@ -83,6 +149,11 @@
+ -
+
algorithm :module:enums.publicKey
+ + +
+ -
+
+ + Public key algorithm ++ + + +
Type:
+-
+
- + +module:enums.publicKey + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+
+
+ -
+
created :Date
+ + +
+ -
+
+ + Key creation date. ++ + + +
Type:
+-
+
- + +Date + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+
+
+ -
+
mpi :module:type/mpi
+ + +
+ -
+
+ + A list of multiprecision integers ++ + + +
Type:
+-
+
- + +module:type/mpi + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+ -
+
getFingerprint() → {String}
+ + +
+ -
+
+
+ + Calculates the fingerprint of the key ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Returns:
+ + ++ A string containing the fingerprint ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
getKeyId() → {String}
+ + +
+ -
+
+
+ + Calculates the key id of the key ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Returns:
+ + ++ A 8 byte key id ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
read(input) → {Object}
+ + +
+ -
+
+
+ + Internal Parser for public keys as specified in RFC 4880 section +5.5.2 Public-Key Packet Formats +called by read_tag<num> ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +input+ + +String + + + + + + + + + +Input string to read the packet from +-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Returns:
+ + ++ This object with attributes set by the parser ++ + + +-
+
- + Type + +
- + +Object + + + +
+
+
+
+ -
+
readPublicKey()
+ + +
+ -
+
+
+ + Alias of read() ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
write() → {Object}
+ + +
+ -
+
+
+ + Same as write_private_key, but has less information because of +public key. ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Returns:
+ + ++ {body: [string]OpenPGP packet body contents, +header: [string] OpenPGP packet header, string: [string] header+body} ++ + + +-
+
- + Type + +
- + +Object + + + +
+
+
+
+ -
+
writeOld()
+ + +
+ -
+
+
+ + Write an old version packet - it's used by some of the internal routines. ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+
+
+ -
+
writePublicKey()
+ + +
+ -
+
+
+ + Alias of write() ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+ - module:type/mpi +
- Source:
- @@ -347,7 +353,7 @@
- Source:
- @@ -486,7 +492,7 @@
- Source:
- @@ -648,7 +654,7 @@
- Source:
- @@ -711,13 +717,13 @@
- Source:
- @@ -105,13 +105,13 @@
-
-
new require("type/s2k")()
+new (require("type/s2k"))()
@@ -74,7 +83,7 @@
- Source:
- - type/s2k.js, line 33 + type/s2k.js, line 39
@@ -148,6 +157,16 @@
+ - module:crypto + +
- module:enums + +
- module:util +
-
-
algorithm :openpgp.hash
+algorithm :module:enums.hash
@@ -171,7 +190,7 @@
- -openpgp.hash +module:enums.hash @@ -201,7 +220,7 @@
- Source:
- - type/s2k.js, line 35 + type/s2k.js, line 41
@@ -219,14 +238,14 @@
-
-
salt :openpgp_byte_array
+salt :String
-
- Eight bytes of salt. + Eight bytes of salt in a binary string.@@ -235,7 +254,7 @@
- -openpgp_byte_array +String @@ -265,7 +284,7 @@
- Source:
- - type/s2k.js, line 42 + type/s2k.js, line 48
@@ -283,7 +302,7 @@
-
-
type :module:type/s2k
+type :module:enums.s2k
@@ -295,7 +314,7 @@
- -module:type/s2k +module:enums.s2k @@ -325,7 +344,7 @@
- Source:
- - type/s2k.js, line 37 + type/s2k.js, line 43
@@ -439,7 +458,7 @@ hashAlgorithm
- Source:
- @@ -579,7 +598,7 @@ hashAlgorithm hash length
- Source:
- - type/s2k.js, line 57 + type/s2k.js, line 63
@@ -670,7 +689,7 @@ hashAlgorithm hash length
- Source:
- @@ -733,13 +752,13 @@ hashAlgorithm hash length
-
-
new require("packet/secret_key")()
+new (require("packet/secret_key"))()
@@ -74,7 +82,7 @@
- Source:
- @@ -148,6 +156,22 @@ +
- module:crypto + +
- module:enums + +
- module:packet/public_key + +
- module:type/mpi + +
- module:type/s2k + +
- module:util +
-
-
algorithm :openpgp.publickey :openpgp.publickey
+algorithm :module:enums.publicKey
@@ -175,7 +199,7 @@
- -openpgp.publickey +module:enums.publicKey @@ -193,7 +217,7 @@
- Inherited From:
- @@ -210,7 +234,7 @@
- Source:
- @@ -228,7 +252,7 @@
-
-
created :Date :Date
+created :Date
@@ -262,7 +286,7 @@
- Inherited From:
- @@ -279,137 +303,7 @@
- Source:
- - - - - - - - -
-
-
mpi :module:type/mpi :module:type/mpi
- - -
- -
-
- - A list of multiprecision integers -- - - -
Type:
--
-
- - -module:type/mpi - - - -
-
-
-
-
-
-
-
-
-
- Inherited From: -
- - - - - - - - - - - - - - -
- Source: -
- - - - - - - - -
-
-
-
- -
-
readPublicKey
- - -
- -
-
- - Internal Parser for public keys as specified in RFC 4880 section -5.5.2 Public-Key Packet Formats -called by read_tag<num> -- - - - - -
-
-
-
-
-
-
-
-
-
- Inherited From: -
- - - - - - - - - - - - - - -
- Source: -
- @@ -442,9 +336,6 @@ called by read_tag<num>
- Source:
- @@ -667,7 +558,7 @@ to key specifier
- Source:
- @@ -695,7 +586,7 @@ to key specifier
-
-
getFingerprint() → {String}() → {String}
+getFingerprint() → {String}
@@ -724,7 +615,7 @@ to key specifier
- Inherited From:
- @@ -741,7 +632,7 @@ to key specifier
- Source:
- @@ -791,7 +682,7 @@ to key specifier
-
-
getKeyId() → {String}() → {String}
+getKeyId() → {String}
@@ -820,7 +711,7 @@ to key specifier
- Inherited From:
- @@ -837,7 +728,7 @@ to key specifier
- Source:
- @@ -976,7 +867,7 @@ to key specifier
- Source:
- @@ -999,6 +890,87 @@ to key specifier +
Decrypts the private key MPIs which are needed to use the key. -openpgp_packet_keymaterial.hasUnencryptedSecretKeyData should be -false otherwise -a call to this function is not needed@@ -526,7 +417,7 @@ as string
+
+
+
+ -
+
readPublicKey()
+ + +
+ -
+
+
+ + Alias of read() ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + +
- See: +
- + + + + + +
@@ -1045,7 +1017,7 @@ to key specifier
- Source:
- @@ -1090,6 +1062,161 @@ to key specifier + + + + +
-
+
writeOld()
+ + +
+ -
+
+
+ + Write an old version packet - it's used by some of the internal routines. ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+
+
+ -
+
writePublicKey()
+ + +
+ -
+
+
+ + Alias of write() ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + +
- See: +
- + + + + + +
@@ -1108,13 +1235,13 @@ to key specifier
-
+
new (require("packet/secret_subkey"))()
+ + +
+ -
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
@@ -83,6 +149,11 @@
+ -
+
algorithm :module:enums.publicKey
+ + +
+ -
+
+ + Public key algorithm ++ + + +
Type:
+-
+
- + +module:enums.publicKey + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+
+
+ -
+
created :Date
+ + +
+ -
+
+ + Key creation date. ++ + + +
Type:
+-
+
- + +Date + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+ -
+
decrypt(str_passphrase) → {Boolean}
+ + +
+ -
+
+
+ + Decrypts the private key MPIs which are needed to use the key. ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str_passphrase+ + +String + + + + + + + + + +The passphrase for this private key +as string +-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- 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:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +passphrase+ + +String + + + + + + + + + ++ -
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+
+
+ -
+
getFingerprint() → {String}
+ + +
+ -
+
+
+ + Calculates the fingerprint of the key ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Returns:
+ + ++ A string containing the fingerprint ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
getKeyId() → {String}
+ + +
+ -
+
+
+ + Calculates the key id of the key ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Returns:
+ + ++ A 8 byte key id ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
read(bytes)
+ + +
+ -
+
+
+ + Internal parser for private keys as specified in RFC 4880 section 5.5.3 ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +bytes+ + +String + + + + + + + + + +Input string to read the packet from +-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+
+
+ -
+
readPublicKey()
+ + +
+ -
+
+
+ + Alias of read() ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+
+
+ -
+
write() → {String}
+ + +
+ -
+
+
+ + Creates an OpenPGP key packet for the given key. ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Returns:
+ + ++ A string of bytes containing the secret key OpenPGP packet ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
writeOld()
+ + +
+ -
+
+
+ + Write an old version packet - it's used by some of the internal routines. ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
+
+
+
+ -
+
writePublicKey()
+ + +
+ -
+
+
+ + Alias of write() ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + +
- See: +
- + + + + + +
+
+ - Source:
- @@ -91,6 +91,355 @@ +
-
+
<static> sha1()
+ + +
+ -
+
+
+ + SHA1 hash ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<static> sha224()
+ + +
+ -
+
+
+ + SHA224 hash ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<static> sha256()
+ + +
+ -
+
+
+ + SHA256 hash ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<static> sha384()
+ + +
+ -
+
+
+ + SHA384 hash ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<static> sha512()
+ + +
+ -
+
+
+ + SHA512 hash ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+ - Source:
- @@ -502,7 +512,7 @@ integers which is used to sign the data
- Source:
- @@ -565,13 +575,13 @@ integers which is used to sign the data
-
-
new require("packet/signature")()
+new (require("packet/signature"))()
@@ -74,7 +82,7 @@
- Source:
- @@ -148,6 +156,22 @@ +
- module:crypto + +
- module:enums + +
- module:packet/packet + +
- module:type/keyid + +
- module:type/mpi + +
- module:util +
- Source:
- @@ -387,7 +411,7 @@
- Source:
- @@ -549,7 +573,7 @@
- Source:
- @@ -654,7 +678,7 @@ module:packet/public_subkey | -module:packet/public_key +module:packet/public_key @@ -695,7 +719,7 @@
- Source:
- @@ -786,7 +810,7 @@
- Source:
- @@ -831,169 +855,6 @@ - - - - -
-
-
<inner> write_sub_packet(type, data) → {String}
- - -
- -
-
-
- - creates a string representation of a sub signature packet (See RFC 4880 5.2.3.1) -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -type- - -Integer - - - - - - - - - -subpacket signature type. Signature types as described -in RFC4880 Section 5.2.3.2 -- - - - - -data- - -String - - - - - - - - - -data to be included --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -- a string-representation of a sub signature packet (See RFC 4880 5.2.3.1) -- - - --
-
- - Type - -
- - -String - - - -
@@ -1012,13 +873,13 @@ in RFC4880 Section 5.2.3.2
-
-
new require("packet/sym_encrypted_integrity_protected")()
+new (require("packet/sym_encrypted_integrity_protected"))()
@@ -74,7 +84,7 @@
- Source:
- @@ -148,6 +158,14 @@ +
- module:crypto + +
- module:util +
- Source:
- @@ -261,7 +279,7 @@ should be discarded.
- Source:
- @@ -398,7 +416,7 @@ have been called before
- Source:
- @@ -461,13 +479,13 @@ have been called before
-
-
new require("packet/sym_encrypted_session_key")()
+new (require("packet/sym_encrypted_session_key"))()
@@ -74,7 +89,7 @@
- Source:
- @@ -148,6 +163,16 @@ +
- module:crypto + +
- module:enums + +
- module:type/s2k +
- Source:
- @@ -389,7 +414,7 @@ packets (tag 1)
- Source:
- @@ -452,13 +477,13 @@ packets (tag 1)
-
-
new require("packet/symmetrically_encrypted")()
+new (require("packet/symmetrically_encrypted"))()
@@ -74,7 +83,7 @@
- Source:
- @@ -148,6 +157,12 @@ +
- module:crypto +
- Source:
- @@ -342,7 +357,7 @@
- Source:
- @@ -363,16 +378,6 @@ -
-
+
new (require("packet/trust"))()
+ + +
+ -
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + packet/trust.js, line 8 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source: +
- + packet/trust.js, line 1 +
+
+
+
+
+
+
+
+- Source:
- @@ -105,13 +105,13 @@
-
-
new require("packet/user_attribute")()
+new (require("packet/user_attribute"))()
@@ -74,7 +92,7 @@
- Source:
- @@ -161,7 +179,7 @@
-
-
read(input, position, len) → {module:packet/user_attribute}
+read(input)
@@ -223,52 +241,6 @@
-
- - Source:
- @@ -317,28 +289,6 @@ -
- - Type - -
- - -module:packet/user_attribute - - - -
-
-
new require("packet/userid")()
+new (require("packet/userid"))()
@@ -74,7 +83,7 @@
- Source:
- @@ -148,6 +157,12 @@ +
- module:util +
- Source:
- @@ -230,7 +245,7 @@ John Doe
-
-
read(input, position, len) → {module:packet/userid}
+read(input)
@@ -292,53 +307,6 @@ John Doe - - Type - -
- - -module:packet/userid - - - -
-
-
write(user_id) → {String}
+write() → {String}
@@ -433,54 +379,6 @@ at position
- - Source:
- @@ -568,13 +466,13 @@ at position
-
-
new Util()
- - -
- -
-
-
- - This object contains utility functions -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 29 -
-
-
-
-
-
-
-
-
-
-
- -
-
bin2str
- - -
- -
-
- - Convert an array of integers(0.255) to a string -- - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 193 -
-
-
-
-
-
-
-
-
-
-
-
- -
-
Uint8Array2str
- - -
- -
-
- - Convert a Uint8Array to a string. This currently functions -the same as bin2str. -- - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 210 -
-
-
-
-
-
-
-
-
-
- -
-
calc_checksum(text) → {Integer}
- - -
- -
-
-
- - Calculates a 16bit sum of a string by adding each character -codes modulus 65535 -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -text- - -String - - - - - - - - - -String to create a sum of --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 219 -
-
-
-
-
-
-
-
-
Returns:
- - -- An integer containing the sum of all character -codes % 65535 -- - - --
-
- - Type - -
- - -Integer - - - -
-
-
-
- -
-
decode_utf8(utf8) → {String}
- - -
- -
-
-
- - Convert a string of utf8 bytes to a native javascript string -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -utf8- - -String - - - - - - - - - -A valid squence of utf8 bytes --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 152 -
-
-
-
-
-
-
-
-
Returns:
- - -- A native javascript string -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
encode_utf8(str) → {String}
- - -
- -
-
-
- - Convert a native javascript string to a string of utf8 bytes -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -str- - -String - - - - - - - - - -The string to convert --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 143 -
-
-
-
-
-
-
-
-
Returns:
- - -- A valid squence of utf8 bytes -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
get_hashAlgorithmString() → {String}
- - -
- -
-
-
- - Return the algorithm type as string -- - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 292 -
-
-
-
-
-
-
-
-
Returns:
- - -- String representing the message type -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
hex2bin(str) → {String}
- - -
- -
-
-
- - Create binary string from a hex encoded string -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -str- - -String - - - - - - - - - -Hex string to convert --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 112 -
-
-
-
-
-
-
-
-
Returns:
- - -- String containing the binary values -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
hexidump(str) → {String}
- - -
- -
-
-
- - Creating a hex string from an binary array of integers (0..255) -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -str- - -String - - - - - - - - - -Array of bytes to convert --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 124 -
-
-
-
-
-
-
-
-
Returns:
- - -- Hexadecimal representation of the array -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
hexstrdump(str) → {String}
- - -
- -
-
-
- - Create hexstring from a binary -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -str- - -String - - - - - - - - - -String to convert --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 92 -
-
-
-
-
-
-
-
-
Returns:
- - -- String containing the hexadecimal values -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
print_debug(str)
- - -
- -
-
-
- - Helper function to print a debug message. Debug -messages are only printed if -openpgp.config.debug is set to true. -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -str- - -String - - - - - - - - - -String of the debug message --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 238 -
-
-
-
-
-
-
-
-
-
-
-
- -
-
print_debug_hexstr_dump(str)
- - -
- -
-
-
- - Helper function to print a debug message. Debug -messages are only printed if -openpgp.config.debug is set to true. -Different than print_debug because will call hexstrdump iff necessary. -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -str- - -String - - - - - - - - - -String of the debug message --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 251 -
-
-
-
-
-
-
-
-
-
-
-
- -
-
shiftRight(value, bitcount) → {String}
- - -
- -
-
-
- - Shifting a string to n bits right -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -value- - -String - - - - - - - - - -The string to shift -- - - - - -bitcount- - -Integer - - - - - - - - - -Amount of bits to shift (MUST be smaller -than 9) --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 274 -
-
-
-
-
-
-
-
-
Returns:
- - -- Resulting string. -- - - --
-
- - Type - -
- - -String - - - -
-
-
-
- -
-
str2bin(str) → {Array.<Integer>}
- - -
- -
-
-
- - Convert a string to an array of integers(0.255) -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -str- - -String - - - - - - - - - -String to convert --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 183 -
-
-
-
-
-
-
-
-
Returns:
- - -- An array of (binary) integers -- - - --
-
- - Type - -
- - -Array.<Integer> - - - -
-
-
-
- -
-
str2Uint8Array(str) → {Uint8Array}
- - -
- -
-
-
- - Convert a string to a Uint8Array -- - - - - - - -
Parameters:
- - -- -
- - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -str- - -String - - - - - - - - - -String to convert --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - util/util.js, line 200 -
-
-
-
-
-
-
-
-
Returns:
- - -- The array of (binary) integers -- - - --
-
- - Type - -
- - -Uint8Array - - - -
-
- - module:config +
- Util - + +
-
+
<static> bin2str(bin) → {String}
+ + +
+ -
+
+
+ + Convert an array of integers(0.255) to a string ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +bin+ + +Array.<Integer> + + + + + + + + + +An array of (binary) integers to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 157 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ The string representation of the array ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> calc_checksum(text) → {Integer}
+ + +
+ -
+
+
+ + Calculates a 16bit sum of a string by adding each character +codes modulus 65535 ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +text+ + +String + + + + + + + + + +String to create a sum of +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 212 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ An integer containing the sum of all character +codes % 65535 ++ + + +-
+
- + Type + +
- + +Integer + + + +
+
+
+
+ -
+
<static> decode_utf8(utf8) → {String}
+ + +
+ -
+
+
+ + Convert a string of utf8 bytes to a native javascript string ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +utf8+ + +String + + + + + + + + + +A valid squence of utf8 bytes +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 144 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ A native javascript string ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> encode_utf8(str) → {String}
+ + +
+ -
+
+
+ + Convert a native javascript string to a string of utf8 bytes ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str+ + +String + + + + + + + + + +The string to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 135 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ A valid squence of utf8 bytes ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> get_hashAlgorithmString() → {String}
+ + +
+ -
+
+
+ + Return the algorithm type as string ++ + + + + + + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 285 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ String representing the message type ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> hex2bin(str) → {String}
+ + +
+ -
+
+
+ + Create binary string from a hex encoded string ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str+ + +String + + + + + + + + + +Hex string to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 104 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ String containing the binary values ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> hexidump(str) → {String}
+ + +
+ -
+
+
+ + Creating a hex string from an binary array of integers (0..255) ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str+ + +String + + + + + + + + + +Array of bytes to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 116 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ Hexadecimal representation of the array ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> hexstrdump(str) → {String}
+ + +
+ -
+
+
+ + Create hexstring from a binary ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str+ + +String + + + + + + + + + +String to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 84 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ String containing the hexadecimal values ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> print_debug(str)
+ + +
+ -
+
+
+ + Helper function to print a debug message. Debug +messages are only printed if ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str+ + +String + + + + + + + + + +String of the debug message +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 231 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
<static> print_debug_hexstr_dump(str)
+ + +
+ -
+
+
+ + Helper function to print a debug message. Debug +messages are only printed if ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str+ + +String + + + + + + + + + +String of the debug message +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 244 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
<static> shiftRight(value, bitcount) → {String}
+ + +
+ -
+
+
+ + Shifting a string to n bits right ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +value+ + +String + + + + + + + + + +The string to shift ++ + + + + +bitcount+ + +Integer + + + + + + + + + +Amount of bits to shift (MUST be smaller +than 9) +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 267 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ Resulting string. ++ + + +-
+
- + Type + +
- + +String + + + +
+
+
+
+ -
+
<static> str2bin(str) → {Array.<Integer>}
+ + +
+ -
+
+
+ + Convert a string to an array of integers(0.255) ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str+ + +String + + + + + + + + + +String to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 180 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ An array of (binary) integers ++ + + +-
+
- + Type + +
- + +Array.<Integer> + + + +
+
+
+
+ -
+
<static> str2Uint8Array(str) → {Uint8Array}
+ + +
+ -
+
+
+ + Convert a string to a Uint8Array ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +str+ + +String + + + + + + + + + +String to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 190 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ The array of (binary) integers ++ + + +-
+
- + Type + +
- + +Uint8Array + + + +
+
+
+
+ -
+
<static> Uint8Array2str(bin) → {String}
+ + +
+ -
+
+
+ + Convert a Uint8Array to a string. This currently functions +the same as bin2str. ++ + + + + + + +
Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +bin+ + +Uint8Array + + + + + + + + + +An array of (binary) integers to convert +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + util/util.js, line 194 +
+
+
+
+
+
+
+
+
Returns:
+ + ++ String representation of the array ++ + + +-
+
- + Type + +
- + +String + + + +
+
- 0 = MESSAGE PART n of m
- 1 = MESSAGE PART n
- 2 = SIGNED MESSAGE
- 3 = PGP MESSAGE
- 4 = PUBLIC KEY BLOCK
- 5 = PRIVATE KEY BLOCK
- null = unknown
+ The header information
@@ -731,7 +596,7 @@ an attribute "data" containing the bytes and "type" for the ASCII armor type
diff --git a/doc/armor.js.html b/doc/armor.js.html index 2e88ab77..f3d3ffe5 100644 --- a/doc/armor.js.html +++ b/doc/armor.js.html @@ -42,11 +42,16 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module encoding/armor */ +/** + * @requires encoding/base64 + * @requires enums + * @requires config + * @module encoding/armor + */ -var base64 = require('./base64.js'); -var enums = require('../enums.js'); -var config = require('../config'); +var base64 = require('./base64.js'), + enums = require('../enums.js'), + config = require('../config'); /** * Finds out which Ascii Armoring type is used. This is an internal function @@ -59,7 +64,7 @@ var config = require('../config'); * 5 = PRIVATE KEY BLOCK * null = unknown */ -function get_type(text) { +function getType(text) { var reHeader = /^-----([^-]+)-----$\n/m; var header = text.match(reHeader); @@ -112,7 +117,7 @@ function get_type(text) { * @version 2011-12-16 * @returns {String} The header information */ -function armor_addheader() { +function addheader() { var result = ""; if (config.show_version) { result += "Version: " + config.versionstring + '\r\n'; @@ -134,8 +139,8 @@ function armor_addheader() { function getCheckSum(data) { var c = createcrc24(data); var str = "" + String.fromCharCode(c >> 16) + - String.fromCharCode((c >> 8) & 0xFF) + - String.fromCharCode(c & 0xFF); + String.fromCharCode((c >> 8) & 0xFF) + + String.fromCharCode(c & 0xFF); return base64.encode(str); } @@ -149,7 +154,7 @@ function getCheckSum(data) { function verifyCheckSum(data, checksum) { var c = getCheckSum(data); var d = checksum; - return c[0] == d[0] && c[1] == d[1] && c[2] == d[2]; + return c[0] == d[0] && c[1] == d[1] && c[2] == d[2]; } /** * Internal function to calculate a CRC-24 checksum over a given string (data) @@ -196,29 +201,29 @@ function createcrc24(input) { var index = 0; while ((input.length - index) > 16) { - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 1)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 2)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 3)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 4)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 5)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 6)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 7)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 8)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 9)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 10)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 11)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 12)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 13)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 14)) & 0xff]; - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 15)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 1)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 2)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 3)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 4)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 5)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 6)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 7)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 8)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 9)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 10)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 11)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 12)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 13)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 14)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index + 15)) & 0xff]; index += 16; } for (var j = index; j < input.length; j++) { - crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index++)) & 0xff]; + crc = (crc << 8) ^ crc_table[((crc >> 16) ^ input.charCodeAt(index++)) & 0xff]; } - return crc & 0xffffff; + return crc & 0xffffff; } /** @@ -228,7 +233,7 @@ function createcrc24(input) { * or an object with attribute "headers" containing the headers and * and an attribute "body" containing the body. */ -function split_headers(text) { +function splitHeaders(text) { var reEmptyLine = /^[\t ]*\n/m; var headers = ""; var body = text; @@ -250,7 +255,7 @@ function split_headers(text) { * or an object with attribute "body" containing the body * and an attribute "checksum" containing the checksum. */ -function split_checksum(text) { +function splitChecksum(text) { var reChecksumStart = /^=/m; var body = text; var checksum = ""; @@ -271,13 +276,14 @@ function split_checksum(text) { * @param {String} text OpenPGP armored message * @returns {Object} An object with attribute "text" containing the message text, * an attribute "data" containing the bytes and "type" for the ASCII armor type + * @static */ function dearmor(text) { var reSplit = /^-----[^-]+-----$\n/m; text = text.replace(/\r/g, ''); - var type = get_type(text); + var type = getType(text); if (!type) { throw new Error('Unknow ASCII armor type'); } @@ -296,8 +302,8 @@ function dearmor(text) { } if (type != 2) { - var msg = split_headers(splittext[indexBase]); - var msg_sum = split_checksum(msg.body); + var msg = splitHeaders(splittext[indexBase]); + var msg_sum = splitChecksum(msg.body); result = { data: base64.decode(msg_sum.body), @@ -307,9 +313,9 @@ function dearmor(text) { checksum = msg_sum.checksum; } else { // Reverse dash-escaping for msg and remove trailing whitespace at end of line - var msg = split_headers(splittext[indexBase].replace(/^- /mg, '').replace(/[\t ]+\n/g, "\n")); - var sig = split_headers(splittext[indexBase + 1].replace(/^- /mg, '')); - var sig_sum = split_checksum(sig.body); + var msg = splitHeaders(splittext[indexBase].replace(/^- /mg, '').replace(/[\t ]+\n/g, "\n")); + var sig = splitHeaders(splittext[indexBase + 1].replace(/^- /mg, '')); + var sig_sum = splitChecksum(sig.body); result = { text: msg.body.replace(/\n$/, '').replace(/\n/g, "\r\n"), @@ -338,20 +344,21 @@ function dearmor(text) { * @param {Integer} partindex * @param {Integer} parttotal * @returns {String} Armored text + * @static */ function armor(messagetype, body, partindex, parttotal) { var result = ""; switch (messagetype) { case enums.armor.multipart_section: result += "-----BEGIN PGP MESSAGE, PART " + partindex + "/" + parttotal + "-----\r\n"; - result += armor_addheader(); + result += addheader(); result += base64.encode(body); result += "\r\n=" + getCheckSum(body) + "\r\n"; result += "-----END PGP MESSAGE, PART " + partindex + "/" + parttotal + "-----\r\n"; break; case enums.armor.mutlipart_last: result += "-----BEGIN PGP MESSAGE, PART " + partindex + "-----\r\n"; - result += armor_addheader(); + result += addheader(); result += base64.encode(body); result += "\r\n=" + getCheckSum(body) + "\r\n"; result += "-----END PGP MESSAGE, PART " + partindex + "-----\r\n"; @@ -361,28 +368,28 @@ function armor(messagetype, body, partindex, parttotal) { result += "Hash: " + body.hash + "\r\n\r\n"; result += body.text.replace(/\n-/g, "\n- -"); result += "\r\n-----BEGIN PGP SIGNATURE-----\r\n"; - result += armor_addheader(); + result += addheader(); result += base64.encode(body.data); result += "\r\n=" + getCheckSum(body.data) + "\r\n"; result += "-----END PGP SIGNATURE-----\r\n"; break; case enums.armor.message: result += "-----BEGIN PGP MESSAGE-----\r\n"; - result += armor_addheader(); + result += addheader(); result += base64.encode(body); result += "\r\n=" + getCheckSum(body) + "\r\n"; result += "-----END PGP MESSAGE-----\r\n"; break; case enums.armor.public_key: result += "-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n"; - result += armor_addheader(); + result += addheader(); result += base64.encode(body); result += "\r\n=" + getCheckSum(body) + "\r\n"; result += "-----END PGP PUBLIC KEY BLOCK-----\r\n\r\n"; break; case enums.armor.private_key: result += "-----BEGIN PGP PRIVATE KEY BLOCK-----\r\n"; - result += armor_addheader(); + result += addheader(); result += base64.encode(body); result += "\r\n=" + getCheckSum(body) + "\r\n"; result += "-----END PGP PRIVATE KEY BLOCK-----\r\n"; @@ -406,13 +413,13 @@ module.exports = {
diff --git a/doc/base64.html b/doc/base64.html index 7b2a87e3..2982ade0 100644 --- a/doc/base64.html +++ b/doc/base64.html @@ -62,7 +62,7 @@
Methods
+ +-
+
+
diff --git a/doc/base64.js.html b/doc/base64.js.html index 95a414e4..62b552cb 100644 --- a/doc/base64.js.html +++ b/doc/base64.js.html @@ -38,10 +38,18 @@ * provided with the application or distribution. */ -/** @module encoding/base64 */ +/** + * @module encoding/base64 + */ var b64s = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'; +/** + * Convert binary string to radix-64 + * @param {String} t binary string to convert + * @returns {string} radix-64 version of input string + * @static + */ function s2r(t) { var a, c, n; var r = '', @@ -52,17 +60,17 @@ function s2r(t) { for (n = 0; n < tl; n++) { c = t.charCodeAt(n); if (s == 0) { - r += b64s.charAt((c >> 2) & 63); - a = (c & 3) << 4; + r += b64s.charAt((c >> 2) & 63); + a = (c & 3) << 4; } else if (s == 1) { - r += b64s.charAt((a | (c >> 4) & 15)); - a = (c & 15) << 2; + r += b64s.charAt((a | (c >> 4) & 15)); + a = (c & 15) << 2; } else if (s == 2) { - r += b64s.charAt(a | ((c >> 6) & 3)); + r += b64s.charAt(a | ((c >> 6) & 3)); l += 1; if ((l % 60) == 0) r += "\n"; - r += b64s.charAt(c & 63); + r += b64s.charAt(c & 63); } l += 1; if ((l % 60) == 0) @@ -89,6 +97,12 @@ function s2r(t) { return r; } +/** + * Convert radix-64 to binary string + * @param {String} t radix-64 string to convert + * @returns {string} binary version of input string + * @static + */ function r2s(t) { var c, n; var r = '', @@ -100,9 +114,9 @@ function r2s(t) { c = b64s.indexOf(t.charAt(n)); if (c >= 0) { if (s) - r += String.fromCharCode(a | (c >> (6 - s)) & 255); - s = (s + 2) & 7; - a = (c << s) & 255; + r += String.fromCharCode(a | (c >> (6 - s)) & 255); + s = (s + 2) & 7; + a = (c << s) & 255; } } return r; @@ -122,13 +136,13 @@ module.exports = {
diff --git a/doc/blowfish.html b/doc/blowfish.html index 9f4925fc..72cd907b 100644 --- a/doc/blowfish.html +++ b/doc/blowfish.html @@ -62,7 +62,7 @@
diff --git a/doc/blowfish.js.html b/doc/blowfish.js.html index ce9bc865..9b6df5ca 100644 --- a/doc/blowfish.js.html +++ b/doc/blowfish.js.html @@ -30,7 +30,9 @@ * Originally written by nklein software (nklein.com) */ -/** @module crypto/cipher/blowfish */ +/** + * @module crypto/cipher/blowfish + */ /* * Javascript implementation based on Bruce Schneier's reference implementation. @@ -250,13 +252,13 @@ Blowfish.prototype.NN = 16; //* //* This function is needed to get rid of problems //* with the high-bit getting set. If we don't do -//* this, then sometimes ( aa & 0x00FFFFFFFF ) is not -//* equal to ( bb & 0x00FFFFFFFF ) even when they +//* this, then sometimes ( aa & 0x00FFFFFFFF ) is not +//* equal to ( bb & 0x00FFFFFFFF ) even when they //* agree bit-for-bit for the first 32 bits. //* Blowfish.prototype._clean = function(xx) { if (xx < 0) { - var yy = xx & 0x7FFFFFFF; + var yy = xx & 0x7FFFFFFF; xx = yy + 0x80000000; } return xx; @@ -272,13 +274,13 @@ Blowfish.prototype._F = function(xx) { var dd; var yy; - dd = xx & 0x00FF; + dd = xx & 0x00FF; xx >>>= 8; - cc = xx & 0x00FF; + cc = xx & 0x00FF; xx >>>= 8; - bb = xx & 0x00FF; + bb = xx & 0x00FF; xx >>>= 8; - aa = xx & 0x00FF; + aa = xx & 0x00FF; yy = this.sboxes[0][aa] + this.sboxes[1][bb]; yy = yy ^ this.sboxes[2][cc]; @@ -327,16 +329,16 @@ Blowfish.prototype.encrypt_block = function(vector) { var vals = [0, 0]; var off = this.BLOCKSIZE / 2; for (ii = 0; ii < this.BLOCKSIZE / 2; ++ii) { - vals[0] = (vals[0] << 8) | (vector[ii + 0] & 0x00FF); - vals[1] = (vals[1] << 8) | (vector[ii + off] & 0x00FF); + vals[0] = (vals[0] << 8) | (vector[ii + 0] & 0x00FF); + vals[1] = (vals[1] << 8) | (vector[ii + off] & 0x00FF); } this._encrypt_block(vals); var ret = []; for (ii = 0; ii < this.BLOCKSIZE / 2; ++ii) { - ret[ii + 0] = (vals[0] >>> (24 - 8 * (ii)) & 0x00FF); - ret[ii + off] = (vals[1] >>> (24 - 8 * (ii)) & 0x00FF); + ret[ii + 0] = (vals[0] >>> (24 - 8 * (ii)) & 0x00FF); + ret[ii + off] = (vals[1] >>> (24 - 8 * (ii)) & 0x00FF); // vals[ 0 ] = ( vals[ 0 ] >>> 8 ); // vals[ 1 ] = ( vals[ 1 ] >>> 8 ); } @@ -383,7 +385,7 @@ Blowfish.prototype.init = function(key) { var data = 0x00000000; var kk; for (kk = 0; kk < 4; ++kk) { - data = (data << 8) | (key[jj] & 0x00FF); + data = (data << 8) | (key[jj] & 0x00FF); if (++jj >= key.length) { jj = 0; } @@ -449,13 +451,13 @@ module.exports.blockSize = BF.prototype.blockSize = 16;
diff --git a/doc/cast5.html b/doc/cast5.html index 7e0f5e64..43e26396 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 f9beac23..2803f34b 100644 --- a/doc/cast5.js.html +++ b/doc/cast5.js.html @@ -134,14 +134,14 @@ function openpgp_symenc_cast5() { r = l ^ f1(r, this.masking[15], this.rotate[15]); l = t; - dst[i] = (r >>> 24) & 255; - dst[i + 1] = (r >>> 16) & 255; - dst[i + 2] = (r >>> 8) & 255; - dst[i + 3] = r & 255; - dst[i + 4] = (l >>> 24) & 255; - dst[i + 5] = (l >>> 16) & 255; - dst[i + 6] = (l >>> 8) & 255; - dst[i + 7] = l & 255; + dst[i] = (r >>> 24) & 255; + dst[i + 1] = (r >>> 16) & 255; + dst[i + 2] = (r >>> 8) & 255; + dst[i + 3] = r & 255; + dst[i + 4] = (l >>> 24) & 255; + dst[i + 5] = (l >>> 16) & 255; + dst[i + 6] = (l >>> 8) & 255; + dst[i + 7] = l & 255; } return dst; @@ -207,14 +207,14 @@ function openpgp_symenc_cast5() { r = l ^ f1(r, this.masking[0], this.rotate[0]); l = t; - dst[i] = (r >>> 24) & 255; - dst[i + 1] = (r >>> 16) & 255; - dst[i + 2] = (r >>> 8) & 255; - dst[i + 3] = r & 255; - dst[i + 4] = (l >>> 24) & 255; - dst[i + 5] = (l >> 16) & 255; - dst[i + 6] = (l >> 8) & 255; - dst[i + 7] = l & 255; + dst[i] = (r >>> 24) & 255; + dst[i + 1] = (r >>> 16) & 255; + dst[i + 2] = (r >>> 8) & 255; + dst[i + 3] = r & 255; + dst[i + 4] = (l >>> 24) & 255; + dst[i + 5] = (l >> 16) & 255; + dst[i + 6] = (l >> 8) & 255; + dst[i + 7] = l & 255; } return dst; @@ -293,22 +293,22 @@ function openpgp_symenc_cast5() { var a = scheduleA[round][j]; var w = t[a[1]]; - w ^= sBox[4][(t[a[2] >>> 2] >>> (24 - 8 * (a[2] & 3))) & 0xff]; - w ^= sBox[5][(t[a[3] >>> 2] >>> (24 - 8 * (a[3] & 3))) & 0xff]; - w ^= sBox[6][(t[a[4] >>> 2] >>> (24 - 8 * (a[4] & 3))) & 0xff]; - w ^= sBox[7][(t[a[5] >>> 2] >>> (24 - 8 * (a[5] & 3))) & 0xff]; - w ^= sBox[x[j]][(t[a[6] >>> 2] >>> (24 - 8 * (a[6] & 3))) & 0xff]; + w ^= sBox[4][(t[a[2] >>> 2] >>> (24 - 8 * (a[2] & 3))) & 0xff]; + w ^= sBox[5][(t[a[3] >>> 2] >>> (24 - 8 * (a[3] & 3))) & 0xff]; + w ^= sBox[6][(t[a[4] >>> 2] >>> (24 - 8 * (a[4] & 3))) & 0xff]; + w ^= sBox[7][(t[a[5] >>> 2] >>> (24 - 8 * (a[5] & 3))) & 0xff]; + w ^= sBox[x[j]][(t[a[6] >>> 2] >>> (24 - 8 * (a[6] & 3))) & 0xff]; t[a[0]] = w; } for (var j = 0; j < 4; j++) { var b = scheduleB[round][j]; - var w = sBox[4][(t[b[0] >>> 2] >>> (24 - 8 * (b[0] & 3))) & 0xff]; + var w = sBox[4][(t[b[0] >>> 2] >>> (24 - 8 * (b[0] & 3))) & 0xff]; - w ^= sBox[5][(t[b[1] >>> 2] >>> (24 - 8 * (b[1] & 3))) & 0xff]; - w ^= sBox[6][(t[b[2] >>> 2] >>> (24 - 8 * (b[2] & 3))) & 0xff]; - w ^= sBox[7][(t[b[3] >>> 2] >>> (24 - 8 * (b[3] & 3))) & 0xff]; - w ^= sBox[4 + j][(t[b[4] >>> 2] >>> (24 - 8 * (b[4] & 3))) & 0xff]; + w ^= sBox[5][(t[b[1] >>> 2] >>> (24 - 8 * (b[1] & 3))) & 0xff]; + w ^= sBox[6][(t[b[2] >>> 2] >>> (24 - 8 * (b[2] & 3))) & 0xff]; + w ^= sBox[7][(t[b[3] >>> 2] >>> (24 - 8 * (b[3] & 3))) & 0xff]; + w ^= sBox[4 + j][(t[b[4] >>> 2] >>> (24 - 8 * (b[4] & 3))) & 0xff]; k[ki] = w; ki++; } @@ -317,7 +317,7 @@ function openpgp_symenc_cast5() { for (var i = 0; i < 16; i++) { this.masking[i] = k[i]; - this.rotate[i] = k[16 + i] & 0x1f; + this.rotate[i] = k[16 + i] & 0x1f; } }; @@ -326,19 +326,19 @@ function openpgp_symenc_cast5() { function f1(d, m, r) { var t = m + d; var I = (t << r) | (t >>> (32 - r)); - return ((sBox[0][I >>> 24] ^ sBox[1][(I >>> 16) & 255]) - sBox[2][(I >>> 8) & 255]) + sBox[3][I & 255]; + return ((sBox[0][I >>> 24] ^ sBox[1][(I >>> 16) & 255]) - sBox[2][(I >>> 8) & 255]) + sBox[3][I & 255]; } function f2(d, m, r) { var t = m ^ d; var I = (t << r) | (t >>> (32 - r)); - return ((sBox[0][I >>> 24] - sBox[1][(I >>> 16) & 255]) + sBox[2][(I >>> 8) & 255]) ^ sBox[3][I & 255]; + return ((sBox[0][I >>> 24] - sBox[1][(I >>> 16) & 255]) + sBox[2][(I >>> 8) & 255]) ^ sBox[3][I & 255]; } function f3(d, m, r) { var t = m - d; var I = (t << r) | (t >>> (32 - r)); - return ((sBox[0][I >>> 24] + sBox[1][(I >>> 16) & 255]) ^ sBox[2][(I >>> 8) & 255]) - sBox[3][I & 255]; + return ((sBox[0][I >>> 24] + sBox[1][(I >>> 16) & 255]) ^ sBox[2][(I >>> 8) & 255]) - sBox[3][I & 255]; } var sBox = new Array(8); @@ -640,13 +640,13 @@ module.exports.keySize = cast5.prototype.keySize = 16;
diff --git a/doc/cfb.html b/doc/cfb.html index 238b1e77..89145bed 100644 --- a/doc/cfb.html +++ b/doc/cfb.html @@ -62,7 +62,7 @@
Requires
+ +-
+
blockcipherfnblock_sizeplaintextcipherfnciphertextblockcipherfncipherfnblock_sizeblock_sizediff --git a/doc/cfb.js.html b/doc/cfb.js.html index 658567e1..15be6066 100644 --- a/doc/cfb.js.html +++ b/doc/cfb.js.html @@ -42,40 +42,28 @@ * materials provided with the application or distribution. */ -/** @module crypto/cfb */ +/** + * @requires crypto/cipher + * @requires util + * @module crypto/cfb + */ var util = require('../util'), cipher = require('./cipher'); module.exports = { - /** - * An array of bytes, that is integers with values from 0 to 255 - * @typedef {(Array|Uint8Array)} openpgp_byte_array - */ - - /** - * Block cipher function - * @callback openpgp_block_cipher_fn - * @param {openpgp_byte_array} block A block to perform operations on - * @param {openpgp_byte_array} key to use in encryption/decryption - * @return {openpgp_byte_array} Encrypted/decrypted block - */ - - - // -------------------------------------- /** * This function encrypts a given with the specified prefixrandom * using the specified blockcipher to encrypt a message * @param {String} prefixrandom random bytes of block_size length provided * as a string to be used in prefixing the data - * @param {openpgp_block_cipher_fn} blockcipherfn the algorithm encrypt function to encrypt - * data in one block_size encryption. - * @param {Integer} block_size the block size in bytes of the algorithm used + * @param {String} cipherfn the algorithm cipher class to encrypt + * data in one block_size encryption, @see module:crypto/cipher. * @param {String} plaintext data to be encrypted provided as a string - * @param {openpgp_byte_array} key key to be used to encrypt the data. This will be passed to the - * blockcipherfn - * @param {Boolean} resync a boolean value specifying if a resync of the + * @param {String} key binary string representation of key to be used to encrypt the plaintext. + * This will be passed to the cipherfn + * @param {Boolean} resync a boolean value specifying if a resync of the * IV should be used or not. The encrypteddatapacket uses the * "old" style with a resync. Encryption within an * encryptedintegrityprotecteddata packet is not resyncing the IV. @@ -178,9 +166,10 @@ module.exports = { /** * Decrypts the prefixed data for the Modification Detection Code (MDC) computation - * @param {openpgp_block_cipher_fn} cipherfn.encrypt Cipher function to use - * @param {Integer} block_size Blocksize of the algorithm - * @param {openpgp_byte_array} key The key for encryption + * @param {String} cipherfn.encrypt Cipher function to use, + * @see module:crypto/cipher. + * @param {String} key binary string representation of key to be used to check the mdc + * This will be passed to the cipherfn * @param {String} ciphertext The encrypted data * @return {String} plaintext Data of D(ciphertext) with blocksize length +2 */ @@ -211,13 +200,12 @@ module.exports = { /** * This function decrypts a given plaintext using the specified * blockcipher to decrypt a message - * @param {openpgp_block_cipher_fn} blockcipherfn The algorithm _encrypt_ function to encrypt - * data in one block_size encryption. - * @param {Integer} block_size the block size in bytes of the algorithm used - * @param {String} plaintext ciphertext to be decrypted provided as a string - * @param {openpgp_byte_array} key key to be used to decrypt the ciphertext. This will be passed to the - * blockcipherfn - * @param {Boolean} resync a boolean value specifying if a resync of the + * @param {String} cipherfn the algorithm cipher class to decrypt + * data in one block_size encryption, @see 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 + * @param {Boolean} resync a boolean value specifying if a resync of the * IV should be used or not. The encrypteddatapacket uses the * "old" style with a resync. Decryption within an * encryptedintegrityprotecteddata packet is not resyncing the IV. @@ -262,7 +250,7 @@ module.exports = { for (n = block_size + 2; n < ciphertext.length; n += block_size) { ablock = cipherfn.encrypt(iblock); - for (i = 0; i < block_size && i + n < ciphertext.length; i++) { + for (i = 0; i < block_size && i + n < ciphertext.length; i++) { iblock[i] = ciphertext.charCodeAt(n + i); text.push(String.fromCharCode(ablock[i] ^ iblock[i])); } @@ -271,7 +259,7 @@ module.exports = { for (i = 0; i < block_size; i++) iblock[i] = ciphertext.charCodeAt(i); for (n = block_size; n < ciphertext.length; n += block_size) { ablock = cipherfn.encrypt(iblock); - for (i = 0; i < block_size && i + n < ciphertext.length; i++) { + for (i = 0; i < block_size && i + n < ciphertext.length; i++) { iblock[i] = ciphertext.charCodeAt(n + i); text.push(String.fromCharCode(ablock[i] ^ iblock[i])); } @@ -346,13 +334,13 @@ module.exports = {
diff --git a/doc/cipher.html b/doc/cipher.html new file mode 100644 index 00000000..170d25ee --- /dev/null +++ b/doc/cipher.html @@ -0,0 +1,421 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: crypto/cipher
+ + + + + ++ crypto/cipher +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Requires
+ +-
+
Members
+ +-
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/cleartext.js.html b/doc/cleartext.js.html index c7e9b9c8..d2f4b8bc 100644 --- a/doc/cleartext.js.html +++ b/doc/cleartext.js.html @@ -42,12 +42,18 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module cleartext */ +/** + * @requires config + * @requires encoding/armor + * @requires enums + * @requires packet + * @module cleartext + */ -var config = require('./config'); -var packet = require('./packet'); -var enums = require('./enums.js'); -var armor = require('./encoding/armor.js'); +var config = require('./config'), + packet = require('./packet'), + enums = require('./enums.js'), + armor = require('./encoding/armor.js'); /** * @class @@ -154,6 +160,7 @@ CleartextMessage.prototype.armor = function() { * reads an OpenPGP cleartext signed message and returns a CleartextMessage object * @param {String} armoredText text to be parsed * @return {module:cleartext~CleartextMessage} new cleartext message object + * @static */ function readArmored(armoredText) { var input = armor.decode(armoredText); @@ -178,13 +185,13 @@ exports.readArmored = readArmored;
diff --git a/doc/compressed.html b/doc/compressed.html index 68d273b0..08cf71d8 100644 --- a/doc/compressed.html +++ b/doc/compressed.html @@ -36,8 +36,15 @@
+
Implementation of the Compressed Data Packet (Tag 8)
+
+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.
+
+
+
+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
+ +-
+
Returns:
- - -
- The compressed data stored in attribute compressedData
-
-
-
-
--
-
- Decompression method for decompressing the compressed data
-read by read_packet
+ Return the compressed packet.
@@ -514,7 +696,7 @@ read by read_packet
- The decompressed data
+ binary compressed packet
@@ -534,192 +716,6 @@ read by read_packet
-
-
-
-
-diff --git a/doc/compressed.js.html b/doc/compressed.js.html index 2838d321..dd8ac616 100644 --- a/doc/compressed.js.html +++ b/doc/compressed.js.html @@ -42,38 +42,47 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/compressed */ +/** + * Implementation of the Compressed Data Packet (Tag 8)<br/> + * <br/> + * 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 + * @requires encoding/base64 + * @requires enums + * @module packet/compressed + */ var enums = require('../enums.js'), JXG = require('../compression/jxg.js'), base64 = require('../encoding/base64.js'); /** - * @class - * @classdesc Implementation of the Compressed Data Packet (Tag 8) - * - * 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. + * @constructor */ -module.exports = function packet_compressed() { - /** @type {module:packet/packetlist} */ - this.packets; - /** @type {compression} */ +module.exports = function () { + /** + * List of packets + * @type {module:packet/packetlist} + */ + this.packets = null; + /** + * Compression algorithm + * @type {compression} + */ this.algorithm = 'uncompressed'; + /** + * Compressed packet data + * @type {String} + */ this.compressed = null; /** * Parsing function for the packet. - * @param {String} input Payload of a tag 8 packet - * @param {Integer} position Position to start reading from the input string - * @param {Integer} len length of the packet or the remaining length of - * input at position - * @return {module:packet/compressed} Object representation + * @param {String} bytes Payload of a tag 8 packet */ this.read = function(bytes) { // One octet that gives the algorithm used to compress the packet. @@ -87,6 +96,10 @@ module.exports = function packet_compressed() { + /** + * Return the compressed packet. + * @return {String} binary compressed packet + */ this.write = function() { if (this.compressed == null) this.compress(); @@ -98,7 +111,6 @@ module.exports = function packet_compressed() { /** * Decompression method for decompressing the compressed data * read by read_packet - * @return {String} The decompressed data */ this.decompress = function() { var decompressed; @@ -155,9 +167,6 @@ module.exports = function packet_compressed() { /** * Compress the packet data (member decompressedData) - * @param {Integer} type Algorithm to be used // See RFC 4880 9.3 - * @param {String} data Data to be compressed - * @return {String} The compressed data stored in attribute compressedData */ this.compress = function() { switch (this.algorithm) { @@ -200,13 +209,13 @@ module.exports = function packet_compressed() {
diff --git a/doc/config-config.html b/doc/config-config.html deleted file mode 100644 index eb8dc336..00000000 --- a/doc/config-config.html +++ /dev/null @@ -1,457 +0,0 @@ - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class: config
- - - - - -- config/config~ - - config -
- -Implementation of the GPG4Browsers config object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Members
- --
-
-
- - - - - - - \ No newline at end of file diff --git a/doc/config.html b/doc/config.html index abc43742..97f2f3a1 100644 --- a/doc/config.html +++ b/doc/config.html @@ -38,11 +38,225 @@ +
This object contains configuration values.
+
-
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
prefer_hash_algorithm |
+
+
+ + + +Integer + + + + | + + + + + ++ |
encryption_cipher |
+
+
+ + + +Integer + + + + | + + + + + ++ |
compression |
+
+
+ + + +Integer + + + + | + + + + + ++ |
show_version |
+
+
+ + + +Boolean + + + + | + + + + + ++ |
show_comment |
+
+
+ + + +Boolean + + + + | + + + + + ++ |
integrity_protect |
+
+
+ + + +Boolean + + + + | + + + + + ++ |
keyserver |
+
+
+ + + +String + + + + | + + + + + ++ |
debug |
+
+
+ + + +Boolean + + + + | + + + + + +If enabled, debug messages will be printed | +
Classes
+Requires
--
-
-
+
diff --git a/doc/config.js.html b/doc/config.js.html index 10bed3cf..f8a79b34 100644 --- a/doc/config.js.html +++ b/doc/config.js.html @@ -42,51 +42,36 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module config/config */ +/** + * This object contains configuration values. + * @requires enums + * @property {Integer} prefer_hash_algorithm + * @property {Integer} encryption_cipher + * @property {Integer} compression + * @property {Boolean} show_version + * @property {Boolean} show_comment + * @property {Boolean} integrity_protect + * @property {String} keyserver + * @property {Boolean} debug If enabled, debug messages will be printed + * @module config/config + */ var enums = require('../enums.js'); -/** - * - * This object contains configuration values and implements - * storing and retrieving configuration them from HTML5 local storage. - * - * This object can be accessed after calling openpgp.init() - * using openpgp.config - * Stored config parameters can be accessed using - * openpgp.config.config - * @class - * @classdesc Implementation of the GPG4Browsers config object - */ -var config = function() { - /** - * @property {Integer} prefer_hash_algorithm - * @property {Integer} encryption_cipher - * @property {Integer} compression - * @property {Boolean} show_version - * @property {Boolean} show_comment - * @property {Boolean} integrity_protect - * @property {String} keyserver - */ - this.prefer_hash_algorithm = enums.hash.sha256; - this.encryption_cipher = enums.symmetric.aes256; - this.compression = enums.compression.zip; - this.show_version = true; - this.show_comment = true; - this.integrity_protect = true; - this.keyserver = "keyserver.linux.it"; // "pgp.mit.edu:11371" +module.exports = { + prefer_hash_algorithm: enums.hash.sha256, + encryption_cipher: enums.symmetric.aes256, + compression: enums.compression.zip, + show_version: true, + show_comment: true, + integrity_protect: true, + keyserver: "keyserver.linux.it", // "pgp.mit.edu:11371" - this.versionstring = "OpenPGP.js VERSION"; - this.commentstring = "http://openpgpjs.org"; - - /** - * If enabled, debug messages will be printed - */ - this.debug = false; + versionstring: "OpenPGP.js VERSION", + commentstring: "http://openpgpjs.org", + debug: false }; - -module.exports = new config(); @@ -97,13 +82,13 @@ module.exports = new config();
diff --git a/doc/config.localStorage.js.html b/doc/config.localStorage.js.html deleted file mode 100644 index e86a3283..00000000 --- a/doc/config.localStorage.js.html +++ /dev/null @@ -1,86 +0,0 @@ - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source: config/config.localStorage.js
- - - - - -/** @module config/config_localStorage */
-
-/**
- *
- * This object storing and retrieving configuration from HTML5 local storage.
- *
- * This object can be accessed after calling openpgp.init()
- * @class
- * @classdesc Implementation of the config handler for localstorage
- */
-module.exports = function () {
-
- /**
- * Reads the config out of the HTML5 local storage
- * and initializes the object config.
- * if config is null the default config will be used
- */
- function read() {
- var cf = JSON.parse(window.localStorage.getItem("config"));
- if (cf === null) {
- this.config = this.default_config;
- this.write();
- } else
- this.config = cf;
- }
-
- /**
- * Writes the config to HTML5 local storage
- */
- function write() {
- window.localStorage.setItem("config", JSON.stringify(this.config));
- }
-
- this.read = read;
- this.write = write;
-}
-- - - - - - - diff --git a/doc/config_localStorage.html b/doc/config_localStorage.html deleted file mode 100644 index 88b2f9ba..00000000 --- a/doc/config_localStorage.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module: config/config_localStorage
- - - - - -- config/config_localStorage -
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Methods
- --
-
-
- - - - - - - \ No newline at end of file diff --git a/doc/crypto.html b/doc/crypto.html index f1580f98..f6f34280 100644 --- a/doc/crypto.html +++ b/doc/crypto.html @@ -83,6 +83,18 @@ +
Requires
+ + + @@ -185,7 +197,7 @@diff --git a/doc/crypto.js.html b/doc/crypto.js.html index ba190d29..15419cf6 100644 --- a/doc/crypto.js.html +++ b/doc/crypto.js.html @@ -44,7 +44,13 @@ // The GPG4Browsers crypto interface -/** @module crypto/crypto */ +/** + * @requires crypto/cipher + * @requires crypto/public_key + * @requires crypto/random + * @requires type/mpi + * @module crypto/crypto + */ var random = require('./random.js'), cipher = require('./cipher'), @@ -240,8 +246,7 @@ module.exports = { */ generateSessionKey: function(algo) { return random.getRandomBytes(cipher[algo].keySize); - }, - + } }; @@ -253,13 +258,13 @@ module.exports = {
diff --git a/doc/des.html b/doc/des.html index 42f3cd7b..e509398d 100644 --- a/doc/des.html +++ b/doc/des.html @@ -89,6 +89,110 @@ +
Members
+ +-
+
+
diff --git a/doc/des.js.html b/doc/des.js.html index e7214352..2f064edf 100644 --- a/doc/des.js.html +++ b/doc/des.js.html @@ -48,9 +48,9 @@ //des //this takes the key, the message, and whether to encrypt or decrypt -/** @module crypto/cipher/des */ - - +/** + * @module crypto/cipher/des + */ function des(keys, message, encrypt, mode, iv, padding) { @@ -158,19 +158,19 @@ function des(keys, message, encrypt, mode, iv, padding) { } //first each 64 but chunk of the message must be permuted according to IP - temp = ((left >>> 4) ^ right) & 0x0f0f0f0f; + temp = ((left >>> 4) ^ right) & 0x0f0f0f0f; right ^= temp; left ^= (temp << 4); - temp = ((left >>> 16) ^ right) & 0x0000ffff; + temp = ((left >>> 16) ^ right) & 0x0000ffff; right ^= temp; left ^= (temp << 16); - temp = ((right >>> 2) ^ left) & 0x33333333; + temp = ((right >>> 2) ^ left) & 0x33333333; left ^= temp; right ^= (temp << 2); - temp = ((right >>> 8) ^ left) & 0x00ff00ff; + temp = ((right >>> 8) ^ left) & 0x00ff00ff; left ^= temp; right ^= (temp << 8); - temp = ((left >>> 1) ^ right) & 0x55555555; + temp = ((left >>> 1) ^ right) & 0x55555555; right ^= temp; left ^= (temp << 1); @@ -188,9 +188,9 @@ function des(keys, message, encrypt, mode, iv, padding) { //the result is attained by passing these bytes through the S selection functions temp = left; left = right; - right = temp ^ (spfunction2[(right1 >>> 24) & 0x3f] | spfunction4[(right1 >>> 16) & 0x3f] | spfunction6[(right1 >>> - 8) & 0x3f] | spfunction8[right1 & 0x3f] | spfunction1[(right2 >>> 24) & 0x3f] | spfunction3[(right2 >>> 16) & - 0x3f] | spfunction5[(right2 >>> 8) & 0x3f] | spfunction7[right2 & 0x3f]); + right = temp ^ (spfunction2[(right1 >>> 24) & 0x3f] | spfunction4[(right1 >>> 16) & 0x3f] | spfunction6[(right1 >>> + 8) & 0x3f] | spfunction8[right1 & 0x3f] | spfunction1[(right2 >>> 24) & 0x3f] | spfunction3[(right2 >>> 16) & + 0x3f] | spfunction5[(right2 >>> 8) & 0x3f] | spfunction7[right2 & 0x3f]); } temp = left; left = right; @@ -202,19 +202,19 @@ function des(keys, message, encrypt, mode, iv, padding) { right = ((right >>> 1) | (right << 31)); //now perform IP-1, which is IP in the opposite direction - temp = ((left >>> 1) ^ right) & 0x55555555; + temp = ((left >>> 1) ^ right) & 0x55555555; right ^= temp; left ^= (temp << 1); - temp = ((right >>> 8) ^ left) & 0x00ff00ff; + temp = ((right >>> 8) ^ left) & 0x00ff00ff; left ^= temp; right ^= (temp << 8); - temp = ((right >>> 2) ^ left) & 0x33333333; + temp = ((right >>> 2) ^ left) & 0x33333333; left ^= temp; right ^= (temp << 2); - temp = ((left >>> 16) ^ right) & 0x0000ffff; + temp = ((left >>> 16) ^ right) & 0x0000ffff; right ^= temp; left ^= (temp << 16); - temp = ((left >>> 4) ^ right) & 0x0f0f0f0f; + temp = ((left >>> 4) ^ right) & 0x0f0f0f0f; right ^= temp; left ^= (temp << 4); @@ -228,8 +228,8 @@ function des(keys, message, encrypt, mode, iv, padding) { right ^= cbcright2; } } - tempresult += String.fromCharCode((left >>> 24), ((left >>> 16) & 0xff), ((left >>> 8) & 0xff), (left & 0xff), ( - right >>> 24), ((right >>> 16) & 0xff), ((right >>> 8) & 0xff), (right & 0xff)); + tempresult += String.fromCharCode((left >>> 24), ((left >>> 16) & 0xff), ((left >>> 8) & 0xff), (left & 0xff), ( + right >>> 24), ((right >>> 16) & 0xff), ((right >>> 8) & 0xff), (right & 0xff)); chunk += 8; if (chunk == 512) { @@ -301,32 +301,32 @@ function des_createKeys(key) { left = (key.charCodeAt(m++) << 24) | (key.charCodeAt(m++) << 16) | (key.charCodeAt(m++) << 8) | key.charCodeAt(m++); right = (key.charCodeAt(m++) << 24) | (key.charCodeAt(m++) << 16) | (key.charCodeAt(m++) << 8) | key.charCodeAt(m++); - temp = ((left >>> 4) ^ right) & 0x0f0f0f0f; + temp = ((left >>> 4) ^ right) & 0x0f0f0f0f; right ^= temp; left ^= (temp << 4); - temp = ((right >>> -16) ^ left) & 0x0000ffff; + temp = ((right >>> -16) ^ left) & 0x0000ffff; left ^= temp; right ^= (temp << -16); - temp = ((left >>> 2) ^ right) & 0x33333333; + temp = ((left >>> 2) ^ right) & 0x33333333; right ^= temp; left ^= (temp << 2); - temp = ((right >>> -16) ^ left) & 0x0000ffff; + temp = ((right >>> -16) ^ left) & 0x0000ffff; left ^= temp; right ^= (temp << -16); - temp = ((left >>> 1) ^ right) & 0x55555555; + temp = ((left >>> 1) ^ right) & 0x55555555; right ^= temp; left ^= (temp << 1); - temp = ((right >>> 8) ^ left) & 0x00ff00ff; + temp = ((right >>> 8) ^ left) & 0x00ff00ff; left ^= temp; right ^= (temp << 8); - temp = ((left >>> 1) ^ right) & 0x55555555; + temp = ((left >>> 1) ^ right) & 0x55555555; right ^= temp; left ^= (temp << 1); //the right side needs to be shifted and to get the last four bits of the left side - temp = (left << 8) | ((right >>> 20) & 0x000000f0); + temp = (left << 8) | ((right >>> 20) & 0x000000f0); //left needs to be put upside down - left = (right << 24) | ((right << 8) & 0xff0000) | ((right >>> 8) & 0xff00) | ((right >>> 24) & 0xf0); + left = (right << 24) | ((right << 8) & 0xff0000) | ((right >>> 8) & 0xff00) | ((right >>> 24) & 0xf0); right = temp; //now go through and perform these shifts on the left and right keys @@ -339,20 +339,20 @@ function des_createKeys(key) { left = (left << 1) | (left >>> 27); right = (right << 1) | (right >>> 27); } - left &= -0xf; - right &= -0xf; + left &= -0xf; + right &= -0xf; //now apply PC-2, in such a way that E is easier when encrypting or decrypting //this conversion will look like PC-2 except only the last 6 bits of each byte are used //rather than 48 consecutive bits and the order of lines will be according to //how the S selection functions will be applied: S2, S4, S6, S8, S1, S3, S5, S7 - lefttemp = pc2bytes0[left >>> 28] | pc2bytes1[(left >>> 24) & 0xf] | pc2bytes2[(left >>> 20) & 0xf] | pc2bytes3[( - left >>> 16) & 0xf] | pc2bytes4[(left >>> 12) & 0xf] | pc2bytes5[(left >>> 8) & 0xf] | pc2bytes6[(left >>> 4) & + lefttemp = pc2bytes0[left >>> 28] | pc2bytes1[(left >>> 24) & 0xf] | pc2bytes2[(left >>> 20) & 0xf] | pc2bytes3[( + left >>> 16) & 0xf] | pc2bytes4[(left >>> 12) & 0xf] | pc2bytes5[(left >>> 8) & 0xf] | pc2bytes6[(left >>> 4) & 0xf]; - righttemp = pc2bytes7[right >>> 28] | pc2bytes8[(right >>> 24) & 0xf] | pc2bytes9[(right >>> 20) & 0xf] | - pc2bytes10[(right >>> 16) & 0xf] | pc2bytes11[(right >>> 12) & 0xf] | pc2bytes12[(right >>> 8) & 0xf] | - pc2bytes13[(right >>> 4) & 0xf]; - temp = ((righttemp >>> 16) ^ lefttemp) & 0x0000ffff; + righttemp = pc2bytes7[right >>> 28] | pc2bytes8[(right >>> 24) & 0xf] | pc2bytes9[(right >>> 20) & 0xf] | + pc2bytes10[(right >>> 16) & 0xf] | pc2bytes11[(right >>> 12) & 0xf] | pc2bytes12[(right >>> 8) & 0xf] | + pc2bytes13[(right >>> 4) & 0xf]; + temp = ((righttemp >>> 16) ^ lefttemp) & 0x0000ffff; keys[n++] = lefttemp ^ temp; keys[n++] = righttemp ^ (temp << 16); } @@ -364,12 +364,12 @@ function des_createKeys(key) { function des_addPadding(message, padding) { var padLength = 8 - (message.length % 8); - if ((padding == 2) && (padLength < 8)) { //pad the message with spaces + if ((padding == 2) && (padLength < 8)) { //pad the message with spaces message += " ".substr(0, padLength); } else if (padding == 1) { //PKCS7 padding message += String.fromCharCode(padLength, padLength, padLength, padLength, padLength, padLength, padLength, padLength).substr(0, padLength); - } else if (!padding && (padLength < 8)) { //pad the message out with null bytes + } else if (!padding && (padLength < 8)) { //pad the message out with null bytes message += "\0\0\0\0\0\0\0\0".substr(0, padLength); } return message; @@ -429,7 +429,9 @@ function OriginalDes(key) { } module.exports = { + /** @static */ des: Des, + /** @static */ originalDes: OriginalDes } @@ -442,13 +444,13 @@ module.exports = {
diff --git a/doc/dsa.html b/doc/dsa.html index 0a03af33..5e5413a6 100644 --- a/doc/dsa.html +++ b/doc/dsa.html @@ -83,6 +83,18 @@ +
Requires
+ + + @@ -105,13 +117,13 @@diff --git a/doc/dsa.js.html b/doc/dsa.js.html index 9cb81bf1..b9a283a8 100644 --- a/doc/dsa.js.html +++ b/doc/dsa.js.html @@ -44,12 +44,19 @@ // // A Digital signature algorithm implementation -/** @module crypto/public_key/dsa */ +/** + * @requires crypto/hash + * @requires crypto/public_key/jsbn + * @requires crypto/random + * @requires util + * @module crypto/public_key/dsa + */ var BigInteger = require('./jsbn.js'), random = require('../random.js'), hashModule = require('../hash'), - util = require('../../util'); + util = require('../../util'), + config = require('../../config'); function DSA() { // s1 = ((g**s) mod p) mod q @@ -72,7 +79,7 @@ function DSA() { } function select_hash_algorithm(q) { - var usersetting = openpgp.config.config.prefer_hash_algorithm; + var usersetting = config.prefer_hash_algorithm; /* * 1024-bit key, 160-bit q, SHA-1, SHA-224, SHA-256, SHA-384, or SHA-512 hash * 2048-bit key, 224-bit q, SHA-224, SHA-256, SHA-384, or SHA-512 hash @@ -82,21 +89,21 @@ function DSA() { switch (Math.round(q.bitLength() / 8)) { case 20: // 1024 bit - if (usersetting != 2 && - usersetting > 11 && - usersetting != 10 && + if (usersetting != 2 && + usersetting > 11 && + usersetting != 10 && usersetting < 8) return 2; // prefer sha1 return usersetting; case 28: // 2048 bit - if (usersetting > 11 && + if (usersetting > 11 && usersetting < 8) return 11; return usersetting; case 32: // 4096 bit // prefer sha224 - if (usersetting > 10 && + if (usersetting > 10 && usersetting < 8) return 8; // prefer sha256 return usersetting; @@ -135,7 +142,7 @@ function DSA() { var xi; do { xi = new BigInteger(q.bitCount(), rand); - } while (x.compareTo(BigInteger.ZERO) != 1 && x.compareTo(q) != -1); + } while (x.compareTo(BigInteger.ZERO) != 1 && x.compareTo(q) != -1); var yi = g.modPow(x, p); return {x: xi, q: qi, p: pi, g: gi, y: yi}; } @@ -160,7 +167,7 @@ function DSA() { var gTemp; do { gTemp = randomfn(bitlength); - } while (gTemp.compareTo(aux) != -1 && gTemp.compareTo(BigInteger.ONE) != 1); + } while (gTemp.compareTo(aux) != -1 && gTemp.compareTo(BigInteger.ONE) != 1); return gTemp.modPow(pow, p); } @@ -168,7 +175,7 @@ function DSA() { var tempK; do { tempK = randomfn(bitlength, false); - } while (tempK.compareTo(q) != -1 && tempK.compareTo(BigInteger.ZERO) != 1); + } while (tempK.compareTo(q) != -1 && tempK.compareTo(BigInteger.ZERO) != 1); return tempK; } @@ -199,13 +206,13 @@ module.exports = DSA;
diff --git a/doc/elgamal.html b/doc/elgamal.html index 9979f43b..1bafd57d 100644 --- a/doc/elgamal.html +++ b/doc/elgamal.html @@ -83,6 +83,16 @@ +
Requires
+ + + @@ -105,13 +115,13 @@diff --git a/doc/elgamal.js.html b/doc/elgamal.js.html index dd12a997..01f752b9 100644 --- a/doc/elgamal.js.html +++ b/doc/elgamal.js.html @@ -44,7 +44,12 @@ // // ElGamal implementation -/** @module crypto/public_key/elgamal */ +/** + * @requires crypto/public_key/jsbn + * @requires crypto/random + * @requires util + * @module crypto/public_key/elgamal + */ var BigInteger = require('./jsbn.js'), random = require('../random.js'), @@ -90,13 +95,13 @@ module.exports = Elgamal;
diff --git a/doc/enums.js.html b/doc/enums.js.html index f09e8e9d..63a74eb8 100644 --- a/doc/enums.js.html +++ b/doc/enums.js.html @@ -25,12 +25,15 @@
/** @module enums */
+ /**
+ * @module enums
+ */
module.exports = {
/** A string to key specifier type
* @enum {Integer}
+ * @readonly
*/
s2k: {
simple: 0,
@@ -41,6 +44,7 @@ module.exports = {
/** RFC4880, section 9.1
* @enum {Integer}
+ * @readonly
*/
publicKey: {
rsa_encrypt_sign: 1,
@@ -52,6 +56,7 @@ module.exports = {
/** RFC4880, section 9.2
* @enum {Integer}
+ * @readonly
*/
symmetric: {
plaintext: 0,
@@ -68,6 +73,7 @@ module.exports = {
/** RFC4880, section 9.3
* @enum {Integer}
+ * @readonly
*/
compression: {
uncompressed: 0,
@@ -80,6 +86,7 @@ module.exports = {
/** RFC4880, section 9.4
* @enum {Integer}
+ * @readonly
*/
hash: {
md5: 1,
@@ -91,9 +98,9 @@ module.exports = {
sha224: 11
},
-
/** A list of packet types and numeric tags associated with them.
* @enum {Integer}
+ * @readonly
*/
packet: {
public_key_encrypted_session_key: 1,
@@ -115,9 +122,9 @@ module.exports = {
modification_detection_code: 19
},
-
/** Data types in the literal packet
* @enum {Integer}
+ * @readonly
*/
literal: {
/** Binary data 'b' */
@@ -131,41 +138,42 @@ module.exports = {
/** One pass signature packet type
* @enum {Integer}
+ * @readonly
*/
signature: {
/** 0x00: Signature of a binary document. */
binary: 0,
- /** 0x01: Signature of a canonical text document.
+ /** 0x01: Signature of a canonical text document.<br/>
* Canonicalyzing the document by converting line endings. */
text: 1,
- /** 0x02: Standalone signature.
+ /** 0x02: Standalone signature.<br/>
* This signature is a signature of only its own subpacket contents.
* It is calculated identically to a signature over a zero-lengh
* binary document. Note that it doesn't make sense to have a V3
* standalone signature. */
standalone: 2,
- /** 0x10: Generic certification of a User ID and Public-Key packet.
+ /** 0x10: Generic certification of a User ID and Public-Key packet.<br/>
* The issuer of this certification does not make any particular
* assertion as to how well the certifier has checked that the owner
* of the key is in fact the person described by the User ID. */
cert_generic: 16,
- /** 0x11: Persona certification of a User ID and Public-Key packet.
+ /** 0x11: Persona certification of a User ID and Public-Key packet.<br/>
* The issuer of this certification has not done any verification of
* the claim that the owner of this key is the User ID specified. */
cert_persona: 17,
- /** 0x12: Casual certification of a User ID and Public-Key packet.
+ /** 0x12: Casual certification of a User ID and Public-Key packet.<br/>
* The issuer of this certification has done some casual
* verification of the claim of identity. */
cert_casual: 18,
- /** 0x13: Positive certification of a User ID and Public-Key packet.
+ /** 0x13: Positive certification of a User ID and Public-Key packet.<br/>
* The issuer of this certification has done substantial
- * verification of the claim of identity.
- *
+ * verification of the claim of identity.<br/>
+ * <br/>
* Most OpenPGP implementations make their "key signatures" as 0x10
* certifications. Some implementations can issue 0x11-0x13
* certifications, but few differentiate between the types. */
cert_positive: 19,
- /** 0x30: Certification revocation signature
+ /** 0x30: Certification revocation signature<br/>
* This signature revokes an earlier User ID certification signature
* (signature class 0x10 through 0x13) or direct-key signature
* (0x1F). It should be issued by the same key that issued the
@@ -174,7 +182,7 @@ module.exports = {
* revokes, and should have a later creation date than that
* certificate. */
cert_revocation: 48,
- /** 0x18: Subkey Binding Signature
+ /** 0x18: Subkey Binding Signature<br/>
* This signature is a statement by the top-level signing key that
* indicates that it owns the subkey. This signature is calculated
* directly on the primary key and subkey, and not on any User ID or
@@ -183,12 +191,12 @@ module.exports = {
* contains a 0x19 signature made by the signing subkey on the
* primary key and subkey. */
subkey_binding: 24,
- /** 0x19: Primary Key Binding Signature
+ /** 0x19: Primary Key Binding Signature<br/>
* This signature is a statement by a signing subkey, indicating
* that it is owned by the primary key and subkey. This signature
* is calculated the same way as a 0x18 signature: directly on the
- * primary key and subkey, and not on any User ID or other packets.
-
+ * primary key and subkey, and not on any User ID or other packets.<br/>
+ * <br/>
* When a signature is made over a key, the hash data starts with the
* octet 0x99, followed by a two-octet length of the key, and then body
* of the key packet. (Note that this is an old-style packet header for
@@ -197,7 +205,7 @@ module.exports = {
* the subkey using the same format as the main key (also using 0x99 as
* the first octet). */
key_binding: 25,
- /** 0x1F: Signature directly on a key
+ /** 0x1F: Signature directly on a key<br/>
* This signature is calculated directly on a key. It binds the
* information in the Signature subpackets to the key, and is
* appropriate to be used for subpackets that provide information
@@ -206,26 +214,27 @@ module.exports = {
* about the key itself, rather than the binding between a key and a
* name. */
key: 31,
- /** 0x20: Key revocation signature
+ /** 0x20: Key revocation signature<br/>
* The signature is calculated directly on the key being revoked. A
* revoked key is not to be used. Only revocation signatures by the
* key being revoked, or by an authorized revocation key, should be
* considered valid revocation signatures.a */
key_revocation: 32,
- /** 0x28: Subkey revocation signature
+ /** 0x28: Subkey revocation signature<br/>
* The signature is calculated directly on the subkey being revoked.
* A revoked subkey is not to be used. Only revocation signatures
* by the top-level signature key that is bound to this subkey, or
* by an authorized revocation key, should be considered valid
- * revocation signatures.
+ * revocation signatures.<br/>
+ * <br/>
* Key revocation signatures (types 0x20 and 0x28)
* hash only the key being revoked. */
subkey_revocation: 40,
- /** 0x40: Timestamp signature.
+ /** 0x40: Timestamp signature.<br/>
* This signature is only meaningful for the timestamp contained in
* it. */
timestamp: 64,
- /** 0x50: Third-Party Confirmation signature.
+ /** 0x50: Third-Party Confirmation signature.<br/>
* This signature is a signature over some other OpenPGP Signature
* packet(s). It is analogous to a notary seal on the signed data.
* A third-party signature SHOULD include Signature Target
@@ -238,6 +247,7 @@ module.exports = {
/** Signature subpacket type
* @enum {Integer}
+ * @readonly
*/
signatureSubpacket: {
signature_creation_time: 2,
@@ -268,28 +278,30 @@ module.exports = {
/** Key flags
* @enum {Integer}
+ * @readonly
*/
keyFlags: {
- // 0x01 - This key may be used to certify other keys.
+ /** 0x01 - This key may be used to certify other keys. */
certify_keys: 1,
- // 0x02 - This key may be used to sign data.
+ /** 0x02 - This key may be used to sign data. */
sign_data: 2,
- // 0x04 - This key may be used to encrypt communications.
+ /** 0x04 - This key may be used to encrypt communications. */
encrypt_communication: 4,
- // 0x08 - This key may be used to encrypt storage.
+ /** 0x08 - This key may be used to encrypt storage. */
encrypt_storage: 8,
- // 0x10 - The private component of this key may have been split
- // by a secret-sharing mechanism.
+ /** 0x10 - The private component of this key may have been split
+ * by a secret-sharing mechanism. */
split_private_key: 16,
- // 0x20 - This key may be used for authentication.
+ /** 0x20 - This key may be used for authentication. */
authentication: 32,
- // 0x80 - The private component of this key may be in the
- // possession of more than one person.
+ /** 0x80 - The private component of this key may be in the
+ * possession of more than one person. */
shared_private_key: 128
},
/** Key status
* @enum {Integer}
+ * @readonly
*/
keyStatus: {
invalid: 0,
@@ -301,6 +313,7 @@ module.exports = {
/** Armor type
* @enum {Integer}
+ * @readonly
*/
armor: {
multipart_section: 0,
@@ -339,13 +352,13 @@ module.exports = {
diff --git a/doc/global.html b/doc/global.html
deleted file mode 100644
index f44c208b..00000000
--- a/doc/global.html
+++ /dev/null
@@ -1,406 +0,0 @@
-
-
-
-
- JSDoc: Global
-
-
-
-
-
-
-
-
-
-
-
-
- Global
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Members
-
-
-
-
-
-
-
-
-
- Type Definitions
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc/hash.html b/doc/hash.html
new file mode 100644
index 00000000..8a51fe04
--- /dev/null
+++ b/doc/hash.html
@@ -0,0 +1,834 @@
+
+
+
+
+ JSDoc: Module: crypto/hash
+
+
+
+
+
+
+
+
+
+
+
+
+ Module: crypto/hash
+
+
+
+
+
+
+
+
+
+ crypto/hash
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Requires
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/index.html b/doc/index.html
index 02a23fea..805791ca 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -40,6 +40,48 @@
+
+ [](http://travis-ci.org/openpgpjs/openpgpjs)
+
+What is OpenPGP.js?
+
+OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.
+
+How do I use it?
+
+As a developer, the best place to start is in the resources/ directory. Within this you will find a basic example implementation and the "binary" files for this library. It is likely that you will want to use resources/openpgp.min.js on your site, this is a minified version of our library.
+
+I need some help
+
+Mailing List
+
+You can sign up for our mailing list and ask for help there. We've recently worked on getting our archive up and running.
+
+Documentation
+
+A jsdoc build of our code comments is available at doc/index.html. Public calls should generally be made through the OpenPGP object doc/openpgp.html.
+
+How do I get involved?
+
+You want to help, great! Go ahead and fork our repo, make your changes and make a pull request. Please be sure that you run make minify from the root directory to concatenate and minify the library into the resources/ directory.
+
+It is extra awesome if you write tests for the code you change. Our test coverage is relatively weak, so if you can add cases that is great.
+
+What License do you use?
+
+GNU Lesser General Public License (2.1). Please take a look at the LICENSE file for more information.
+
+What are the requirements to use it?
+
+OpenPGP.js currently only fully supports Chrome. Firefox support should be coming soon with the advent of Firefox 23 with native javascript support for window.crypto.getRandomValues. If you can help us support more browsers and situations, please chip in!
+
+Resources
+
+Below is a collection of resources, many of these were projects that were in someway a precursor to the current OpenPGP.js project. If you'd like to add your link here, please do so in a pull request or email to the list.
+
+
+
@@ -51,7 +93,7 @@
- openpgp.js
+ src/openpgp.js
@@ -133,13 +175,13 @@ for extending and developing on top of the base library.
diff --git a/doc/index.js.html b/doc/index.js.html
index e09de35b..21667983 100644
--- a/doc/index.js.html
+++ b/doc/index.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: crypto/hash/index.js
+ JSDoc: Source: index.js
@@ -17,7 +17,7 @@
- Source: crypto/hash/index.js
+ Source: index.js
@@ -25,84 +25,45 @@
- var sha = require('./sha.js');
+
+module.exports = require('./openpgp.js');
-module.exports = {
- md5: require('./md5.js'),
- sha1: sha.sha1,
- sha256: sha.sha256,
- sha224: sha.sha224,
- sha384: sha.sha384,
- sha512: sha.sha512,
- ripemd: require('./ripe-md.js'),
-
- /**
- * Create a hash on the specified data using the specified algorithm
- * @param {Integer} algo Hash algorithm type (see RFC4880 9.4)
- * @param {String} data Data to be hashed
- * @return {String} hash value
- */
- digest: function(algo, data) {
- switch (algo) {
- case 1:
- // - MD5 [HAC]
- return this.md5(data);
- case 2:
- // - SHA-1 [FIPS180]
- return this.sha1(data);
- case 3:
- // - RIPE-MD/160 [HAC]
- return this.ripemd(data);
- case 8:
- // - SHA256 [FIPS180]
- return this.sha256(data);
- case 9:
- // - SHA384 [FIPS180]
- return this.sha384(data);
- case 10:
- // - SHA512 [FIPS180]
- return this.sha512(data);
- case 11:
- // - SHA224 [FIPS180]
- return this.sha224(data);
- default:
- throw new Error('Invalid hash function.');
- }
- },
-
- /**
- * Returns the hash size in bytes of the specified hash algorithm type
- * @param {Integer} algo Hash algorithm type (See RFC4880 9.4)
- * @return {Integer} Size in bytes of the resulting hash
- */
- getHashByteLength: function(algo) {
- switch (algo) {
- case 1:
- // - MD5 [HAC]
- return 16;
- case 2:
- // - SHA-1 [FIPS180]
- case 3:
- // - RIPE-MD/160 [HAC]
- return 20;
- case 8:
- // - SHA256 [FIPS180]
- return 32;
- case 9:
- // - SHA384 [FIPS180]
- return 48
- case 10:
- // - SHA512 [FIPS180]
- return 64;
- case 11:
- // - SHA224 [FIPS180]
- return 28;
- default:
- throw new Error('Invalid hash algorithm.');
- }
- }
-
-}
+module.exports.key = require('./key.js');
+module.exports.message = require('./message.js');
+module.exports.cleartext = require('./cleartext.js');
+/**
+ * @see module:util/util
+ * @module util
+ */
+module.exports.util = require('./util/util.js');
+module.exports.packet = require('./packet');
+/**
+ * @see module:type/mpi
+ * @module mpi
+ */
+module.exports.mpi = require('./type/mpi.js');
+/**
+ * @see module:type/s2k
+ * @module s2k
+ */
+module.exports.s2k = require('./type/s2k.js');
+/**
+ * @see module:type/keyid
+ * @module keyid
+ */
+module.exports.keyid = require('./type/keyid.js');
+/**
+ * @see module:encoding/armor
+ * @module armor
+ */
+module.exports.armor = require('./encoding/armor.js');
+module.exports.enums = require('./enums.js');
+/**
+ * @see module:config/config
+ * @module config
+ */
+module.exports.config = require('./config/config.js');
+module.exports.crypto = require('./crypto');
@@ -113,13 +74,13 @@ module.exports = {
diff --git a/doc/index.js_.html b/doc/index.js_.html
new file mode 100644
index 00000000..a024d27f
--- /dev/null
+++ b/doc/index.js_.html
@@ -0,0 +1,76 @@
+
+
+
+
+ JSDoc: Source: crypto/index.js
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: crypto/index.js
+
+
+
+
+
+
+
+ /**
+ * @see module:crypto/crypto
+ * @module crypto
+ */
+module.exports = {
+ /** @see module:crypto/cipher */
+ cipher: require('./cipher'),
+ /** @see module:crypto/hash */
+ hash: require('./hash'),
+ /** @see module:crypto/cfb */
+ cfb: require('./cfb.js'),
+ /** @see module:crypto/public_key */
+ publicKey: require('./public_key'),
+ /** @see module:crypto/signature */
+ signature: require('./signature.js'),
+ /** @see module:crypto/random */
+ random: require('./random.js'),
+ /** @see module:crypto/pkcs1 */
+ pkcs1: require('./pkcs1.js')
+
+}
+
+var crypto = require('./crypto.js');
+
+for (var i in crypto)
+ module.exports[i] = crypto[i];
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/index.js__.html b/doc/index.js__.html
new file mode 100644
index 00000000..cfea5ffb
--- /dev/null
+++ b/doc/index.js__.html
@@ -0,0 +1,78 @@
+
+
+
+
+ JSDoc: Source: crypto/cipher/index.js
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: crypto/cipher/index.js
+
+
+
+
+
+
+
+ /**
+ * @requires crypto/cipher/aes
+ * @requires crypto/cipher/blowfish
+ * @requires crypto/cipher/cast5
+ * @requires crypto/cipher/twofish
+ * @module crypto/cipher
+ */
+
+var desModule = require('./des.js');
+
+module.exports = {
+ /** @see module:crypto/cipher/des.des */
+ des: desModule['des'],
+ /** @see module:crypto/cipher/des.originalDes */
+ originalDes: desModule['originalDes'],
+ /** @see module:crypto/cipher/cast5 */
+ cast5: require('./cast5.js'),
+ /** @see module:crypto/cipher/twofish */
+ twofish: require('./twofish.js'),
+ /** @see module:crypto/cipher/blowfish */
+ blowfish: require('./blowfish.js')
+}
+
+var aes = require('./aes.js');
+
+for (var i in aes) {
+ module.exports['aes' + i] = aes[i];
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/index.js___.html b/doc/index.js___.html
new file mode 100644
index 00000000..9cda7640
--- /dev/null
+++ b/doc/index.js___.html
@@ -0,0 +1,138 @@
+
+
+
+
+ JSDoc: Source: crypto/hash/index.js
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: crypto/hash/index.js
+
+
+
+
+
+
+
+ /**
+ * @requires crypto/hash/sha
+ * @module crypto/hash
+ */
+var sha = require('./sha.js');
+
+module.exports = {
+ /** @see module:crypto/hash/md5 */
+ md5: require('./md5.js'),
+ /** @see module:crypto/hash/sha.sha1 */
+ sha1: sha.sha1,
+ /** @see module:crypto/hash/sha.sha224 */
+ sha224: sha.sha224,
+ /** @see module:crypto/hash/sha.sha256 */
+ sha256: sha.sha256,
+ /** @see module:crypto/hash/sha.sha384 */
+ sha384: sha.sha384,
+ /** @see module:crypto/hash/sha.sha512 */
+ sha512: sha.sha512,
+ /** @see module:crypto/hash/ripe-md */
+ ripemd: require('./ripe-md.js'),
+
+ /**
+ * Create a hash on the specified data using the specified algorithm
+ * @param {Integer} algo Hash algorithm type (see RFC4880 9.4)
+ * @param {String} data Data to be hashed
+ * @return {String} hash value
+ */
+ digest: function(algo, data) {
+ switch (algo) {
+ case 1:
+ // - MD5 [HAC]
+ return this.md5(data);
+ case 2:
+ // - SHA-1 [FIPS180]
+ return this.sha1(data);
+ case 3:
+ // - RIPE-MD/160 [HAC]
+ return this.ripemd(data);
+ case 8:
+ // - SHA256 [FIPS180]
+ return this.sha256(data);
+ case 9:
+ // - SHA384 [FIPS180]
+ return this.sha384(data);
+ case 10:
+ // - SHA512 [FIPS180]
+ return this.sha512(data);
+ case 11:
+ // - SHA224 [FIPS180]
+ return this.sha224(data);
+ default:
+ throw new Error('Invalid hash function.');
+ }
+ },
+
+ /**
+ * Returns the hash size in bytes of the specified hash algorithm type
+ * @param {Integer} algo Hash algorithm type (See RFC4880 9.4)
+ * @return {Integer} Size in bytes of the resulting hash
+ */
+ getHashByteLength: function(algo) {
+ switch (algo) {
+ case 1:
+ // - MD5 [HAC]
+ return 16;
+ case 2:
+ // - SHA-1 [FIPS180]
+ case 3:
+ // - RIPE-MD/160 [HAC]
+ return 20;
+ case 8:
+ // - SHA256 [FIPS180]
+ return 32;
+ case 9:
+ // - SHA384 [FIPS180]
+ return 48
+ case 10:
+ // - SHA512 [FIPS180]
+ return 64;
+ case 11:
+ // - SHA224 [FIPS180]
+ return 28;
+ default:
+ throw new Error('Invalid hash algorithm.');
+ }
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/index.js____.html b/doc/index.js____.html
new file mode 100644
index 00000000..0c22b381
--- /dev/null
+++ b/doc/index.js____.html
@@ -0,0 +1,64 @@
+
+
+
+
+ JSDoc: Source: crypto/public_key/index.js
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: crypto/public_key/index.js
+
+
+
+
+
+
+
+ /**
+ * @requires crypto/public_key/dsa
+ * @requires crypto/public_key/elgamal
+ * @requires crypto/public_key/rsa
+ * @module crypto/public_key
+ */
+module.exports = {
+ /** @see module:crypto/public_key/rsa */
+ rsa: require('./rsa.js'),
+ /** @see module:crypto/public_key/elgamal */
+ elgamal: require('./elgamal.js'),
+ /** @see module:crypto/public_key/dsa */
+ dsa: require('./dsa.js')
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/jsbn.html b/doc/jsbn.html
index 3ad49fab..61b26ed6 100644
--- a/doc/jsbn.html
+++ b/doc/jsbn.html
@@ -62,7 +62,7 @@
Requires
+
+
+
+
@@ -105,13 +111,13 @@
diff --git a/doc/jsbn.js.html b/doc/jsbn.js.html
index cf1f4c41..9c817157 100644
--- a/doc/jsbn.js.html
+++ b/doc/jsbn.js.html
@@ -59,7 +59,10 @@
*/
-/** @module crypto/public_key/jsbn */
+/**
+ * @requires util
+ * @module crypto/public_key/jsbn
+ */
var util = require('../../util');
@@ -70,14 +73,14 @@ var dbits;
// JavaScript engine analysis
var canary = 0xdeadbeefcafe;
-var j_lm = ((canary & 0xffffff) == 0xefcafe);
+var j_lm = ((canary & 0xffffff) == 0xefcafe);
// (public) Constructor
function BigInteger(a, b, c) {
if (a != null)
if ("number" == typeof a) this.fromNumber(a, b, c);
- else if (b == null && "string" != typeof a) this.fromString(a, 256);
+ else if (b == null && "string" != typeof a) this.fromString(a, 256);
else this.fromString(a, b);
}
@@ -100,7 +103,7 @@ function am1(i, x, w, j, c, n) {
while (--n >= 0) {
var v = x * this[i++] + w[j] + c;
c = Math.floor(v / 0x4000000);
- w[j++] = v & 0x3ffffff;
+ w[j++] = v & 0x3ffffff;
}
return c;
}
@@ -109,15 +112,15 @@ function am1(i, x, w, j, c, n) {
// on values up to 2*hdvalue^2-hdvalue-1 (< 2^31)
function am2(i, x, w, j, c, n) {
- var xl = x & 0x7fff,
+ var xl = x & 0x7fff,
xh = x >> 15;
while (--n >= 0) {
- var l = this[i] & 0x7fff;
+ var l = this[i] & 0x7fff;
var h = this[i++] >> 15;
var m = xh * l + h * xl;
- l = xl * l + ((m & 0x7fff) << 15) + w[j] + (c & 0x3fffffff);
+ l = xl * l + ((m & 0x7fff) << 15) + w[j] + (c & 0x3fffffff);
c = (l >>> 30) + (m >>> 15) + xh * h + (c >>> 30);
- w[j++] = l & 0x3fffffff;
+ w[j++] = l & 0x3fffffff;
}
return c;
}
@@ -125,24 +128,24 @@ function am2(i, x, w, j, c, n) {
// browsers slow down when dealing with 32-bit numbers.
function am3(i, x, w, j, c, n) {
- var xl = x & 0x3fff,
+ var xl = x & 0x3fff,
xh = x >> 14;
while (--n >= 0) {
- var l = this[i] & 0x3fff;
+ var l = this[i] & 0x3fff;
var h = this[i++] >> 14;
var m = xh * l + h * xl;
- l = xl * l + ((m & 0x3fff) << 14) + w[j] + c;
+ l = xl * l + ((m & 0x3fff) << 14) + w[j] + c;
c = (l >> 28) + (m >> 14) + xh * h;
- w[j++] = l & 0xfffffff;
+ w[j++] = l & 0xfffffff;
}
return c;
}
-/*if(j_lm && (navigator != undefined &&
+/*if(j_lm && (navigator != undefined &&
navigator.appName == "Microsoft Internet Explorer")) {
BigInteger.prototype.am = am2;
dbits = 30;
}
-else if(j_lm && (navigator != undefined && navigator.appName != "Netscape")) {*/
+else if(j_lm && (navigator != undefined && navigator.appName != "Netscape")) {*/
BigInteger.prototype.am = am1;
dbits = 26;
/*}
@@ -226,7 +229,7 @@ function bnpFromString(s, b) {
mi = false,
sh = 0;
while (--i >= 0) {
- var x = (k == 8) ? s[i] & 0xff : intAt(s, i);
+ var x = (k == 8) ? s[i] & 0xff : intAt(s, i);
if (x < 0) {
if (s.charAt(i) == "-") mi = true;
continue;
@@ -235,14 +238,14 @@ function bnpFromString(s, b) {
if (sh == 0)
this[this.t++] = x;
else if (sh + k > this.DB) {
- this[this.t - 1] |= (x & ((1 << (this.DB - sh)) - 1)) << sh;
+ this[this.t - 1] |= (x & ((1 << (this.DB - sh)) - 1)) << sh;
this[this.t++] = (x >> (this.DB - sh));
} else
this[this.t - 1] |= x << sh;
sh += k;
if (sh >= this.DB) sh -= this.DB;
}
- if (k == 8 && (s[0] & 0x80) != 0) {
+ if (k == 8 && (s[0] & 0x80) != 0) {
this.s = -1;
if (sh > 0) this[this.t - 1] |= ((1 << (this.DB - sh)) - 1) << sh;
}
@@ -253,8 +256,8 @@ function bnpFromString(s, b) {
// (protected) clamp off excess high words
function bnpClamp() {
- var c = this.s & this.DM;
- while (this.t > 0 && this[this.t - 1] == c)--this.t;
+ var c = this.s & this.DM;
+ while (this.t > 0 && this[this.t - 1] == c)--this.t;
}
// (public) return string representation in given radix
@@ -274,16 +277,16 @@ function bnToString(b) {
i = this.t;
var p = this.DB - (i * this.DB) % k;
if (i-- > 0) {
- if (p < this.DB && (d = this[i] >> p) > 0) {
+ if (p < this.DB && (d = this[i] >> p) > 0) {
m = true;
r = int2char(d);
}
while (i >= 0) {
if (p < k) {
- d = (this[i] & ((1 << p) - 1)) << (k - p);
+ d = (this[i] & ((1 << p) - 1)) << (k - p);
d |= this[--i] >> (p += this.DB - k);
} else {
- d = (this[i] >> (p -= k)) & km;
+ d = (this[i] >> (p -= k)) & km;
if (p <= 0) {
p += this.DB;
--i;
@@ -354,7 +357,7 @@ function nbits(x) {
function bnBitLength() {
if (this.t <= 0) return 0;
- return this.DB * (this.t - 1) + nbits(this[this.t - 1] ^ (this.s & this.DM));
+ return this.DB * (this.t - 1) + nbits(this[this.t - 1] ^ (this.s & this.DM));
}
// (protected) r = this << n*DB
@@ -382,11 +385,11 @@ function bnpLShiftTo(n, r) {
var cbs = this.DB - bs;
var bm = (1 << cbs) - 1;
var ds = Math.floor(n / this.DB),
- c = (this.s << bs) & this.DM,
+ c = (this.s << bs) & this.DM,
i;
for (i = this.t - 1; i >= 0; --i) {
r[i + ds + 1] = (this[i] >> cbs) | c;
- c = (this[i] & bm) << bs;
+ c = (this[i] & bm) << bs;
}
for (i = ds - 1; i >= 0; --i) r[i] = 0;
r[ds] = c;
@@ -409,10 +412,10 @@ function bnpRShiftTo(n, r) {
var bm = (1 << bs) - 1;
r[0] = this[ds] >> bs;
for (var i = ds + 1; i < this.t; ++i) {
- r[i - ds - 1] |= (this[i] & bm) << cbs;
+ r[i - ds - 1] |= (this[i] & bm) << cbs;
r[i - ds] = this[i] >> bs;
}
- if (bs > 0) r[this.t - ds - 1] |= (this.s & bm) << cbs;
+ if (bs > 0) r[this.t - ds - 1] |= (this.s & bm) << cbs;
r.t = this.t - ds;
r.clamp();
}
@@ -425,14 +428,14 @@ function bnpSubTo(a, r) {
m = Math.min(a.t, this.t);
while (i < m) {
c += this[i] - a[i];
- r[i++] = c & this.DM;
+ r[i++] = c & this.DM;
c >>= this.DB;
}
if (a.t < this.t) {
c -= a.s;
while (i < this.t) {
c += this[i];
- r[i++] = c & this.DM;
+ r[i++] = c & this.DM;
c >>= this.DB;
}
c += this.s;
@@ -440,7 +443,7 @@ function bnpSubTo(a, r) {
c += this.s;
while (i < a.t) {
c -= a[i];
- r[i++] = c & this.DM;
+ r[i++] = c & this.DM;
c >>= this.DB;
}
c -= a.s;
@@ -551,7 +554,7 @@ function bnpDivRemTo(m, q, r) {
function bnMod(a) {
var r = nbi();
this.abs().divRemTo(a, null, r);
- if (this.s < 0 && r.compareTo(BigInteger.ZERO) > 0) a.subTo(r, r);
+ if (this.s < 0 && r.compareTo(BigInteger.ZERO) > 0) a.subTo(r, r);
return r;
}
@@ -604,11 +607,11 @@ Classic.prototype.sqrTo = cSqrTo;
function bnpInvDigit() {
if (this.t < 1) return 0;
var x = this[0];
- if ((x & 1) == 0) return 0;
- var y = x & 3; // y == 1/x mod 2^2
- y = (y * (2 - (x & 0xf) * y)) & 0xf; // y == 1/x mod 2^4
- y = (y * (2 - (x & 0xff) * y)) & 0xff; // y == 1/x mod 2^8
- y = (y * (2 - (((x & 0xffff) * y) & 0xffff))) & 0xffff; // y == 1/x mod 2^16
+ if ((x & 1) == 0) return 0;
+ var y = x & 3; // y == 1/x mod 2^2
+ y = (y * (2 - (x & 0xf) * y)) & 0xf; // y == 1/x mod 2^4
+ y = (y * (2 - (x & 0xff) * y)) & 0xff; // y == 1/x mod 2^8
+ y = (y * (2 - (((x & 0xffff) * y) & 0xffff))) & 0xffff; // y == 1/x mod 2^16
// last step - calculate inverse mod DV directly;
// assumes 16 < DB <= 32 and assumes ability to handle 48-bit ints
y = (y * (2 - x * y % this.DV)) % this.DV; // y == 1/x mod 2^dbits
@@ -621,7 +624,7 @@ function bnpInvDigit() {
function Montgomery(m) {
this.m = m;
this.mp = m.invDigit();
- this.mpl = this.mp & 0x7fff;
+ this.mpl = this.mp & 0x7fff;
this.mph = this.mp >> 15;
this.um = (1 << (m.DB - 15)) - 1;
this.mt2 = 2 * m.t;
@@ -633,7 +636,7 @@ function montConvert(x) {
var r = nbi();
x.abs().dlShiftTo(this.m.t, r);
r.divRemTo(this.m, null, r);
- if (x.s < 0 && r.compareTo(BigInteger.ZERO) > 0) this.m.subTo(r, r);
+ if (x.s < 0 && r.compareTo(BigInteger.ZERO) > 0) this.m.subTo(r, r);
return r;
}
@@ -653,8 +656,8 @@ function montReduce(x) {
x[x.t++] = 0;
for (var i = 0; i < this.m.t; ++i) {
// faster way of calculating u0 = x[i]*mp mod DV
- var j = x[i] & 0x7fff;
- var u0 = (j * this.mpl + (((j * this.mph + (x[i] >> 15) * this.mpl) & this.um) << 15)) & x.DM;
+ var j = x[i] & 0x7fff;
+ var u0 = (j * this.mpl + (((j * this.mph + (x[i] >> 15) * this.mpl) & this.um) << 15)) & x.DM;
// use am to combine the multiply-shift-add into one call
j = i + this.m.t;
x[j] += this.m.am(0, u0, x, i, 0, this.m.t);
@@ -692,7 +695,7 @@ Montgomery.prototype.sqrTo = montSqrTo;
// (protected) true iff this is even
function bnpIsEven() {
- return ((this.t > 0) ? (this[0] & 1) : this.s) == 0;
+ return ((this.t > 0) ? (this[0] & 1) : this.s) == 0;
}
// (protected) this^e, e < 2^32, doing sqr and mul with "r" (HAC 14.79)
@@ -706,7 +709,7 @@ function bnpExp(e, z) {
g.copyTo(r);
while (--i >= 0) {
z.sqrTo(r, r2);
- if ((e & (1 << i)) > 0) z.mulTo(r2, g, r);
+ if ((e & (1 << i)) > 0) z.mulTo(r2, g, r);
else {
var t = r;
r = r2;
@@ -830,7 +833,7 @@ function bnIntValue() {
} else if (this.t == 1) return this[0];
else if (this.t == 0) return 0;
// assumes 16 < DB < 32
- return ((this[1] & ((1 << (32 - this.DB)) - 1)) << this.DB) | this[0];
+ return ((this[1] & ((1 << (32 - this.DB)) - 1)) << this.DB) | this[0];
}
// (public) return value as byte
@@ -855,7 +858,7 @@ function bnpChunkSize(r) {
function bnSigNum() {
if (this.s < 0) return -1;
- else if (this.t <= 0 || (this.t == 1 && this[0] <= 0)) return 0;
+ else if (this.t <= 0 || (this.t == 1 && this[0] <= 0)) return 0;
else return 1;
}
@@ -891,7 +894,7 @@ function bnpFromRadix(s, b) {
for (var i = 0; i < s.length; ++i) {
var x = intAt(s, i);
if (x < 0) {
- if (s.charAt(i) == "-" && this.signum() == 0) mi = true;
+ if (s.charAt(i) == "-" && this.signum() == 0) mi = true;
continue;
}
w = b * w + x;
@@ -928,10 +931,10 @@ function bnpFromNumber(a, b, c) {
} else {
// new BigInteger(int,RNG)
var x = new Array(),
- t = a & 7;
+ t = a & 7;
x.length = (a >> 3) + 1;
b.nextBytes(x);
- if (t > 0) x[0] &= ((1 << t) - 1);
+ if (t > 0) x[0] &= ((1 << t) - 1);
else x[0] = 0;
this.fromString(x, 256);
}
@@ -946,21 +949,21 @@ function bnToByteArray() {
var p = this.DB - (i * this.DB) % 8,
d, k = 0;
if (i-- > 0) {
- if (p < this.DB && (d = this[i] >> p) != (this.s & this.DM) >> p)
+ if (p < this.DB && (d = this[i] >> p) != (this.s & this.DM) >> p)
r[k++] = d | (this.s << (this.DB - p));
while (i >= 0) {
if (p < 8) {
- d = (this[i] & ((1 << p) - 1)) << (8 - p);
+ d = (this[i] & ((1 << p) - 1)) << (8 - p);
d |= this[--i] >> (p += this.DB - 8);
} else {
- d = (this[i] >> (p -= 8)) & 0xff;
+ d = (this[i] >> (p -= 8)) & 0xff;
if (p <= 0) {
p += this.DB;
--i;
}
}
- //if((d&0x80) != 0) d |= -256;
- //if(k == 0 && (this.s&0x80) != (d&0x80)) ++k;
+ //if((d&0x80) != 0) d |= -256;
+ //if(k == 0 && (this.s&0x80) != (d&0x80)) ++k;
if (k > 0 || d != this.s) r[k++] = d;
}
}
@@ -985,11 +988,11 @@ function bnpBitwiseTo(a, op, r) {
var i, f, m = Math.min(a.t, this.t);
for (i = 0; i < m; ++i) r[i] = op(this[i], a[i]);
if (a.t < this.t) {
- f = a.s & this.DM;
+ f = a.s & this.DM;
for (i = m; i < this.t; ++i) r[i] = op(this[i], f);
r.t = this.t;
} else {
- f = this.s & this.DM;
+ f = this.s & this.DM;
for (i = m; i < a.t; ++i) r[i] = op(f, a[i]);
r.t = a.t;
}
@@ -997,10 +1000,10 @@ function bnpBitwiseTo(a, op, r) {
r.clamp();
}
-// (public) this & a
+// (public) this & a
function op_and(x, y) {
- return x & y;
+ return x & y;
}
function bnAnd(a) {
@@ -1033,10 +1036,10 @@ function bnXor(a) {
return r;
}
-// (public) this & ~a
+// (public) this & ~a
function op_andnot(x, y) {
- return x & ~y;
+ return x & ~y;
}
function bnAndNot(a) {
@@ -1049,7 +1052,7 @@ function bnAndNot(a) {
function bnNot() {
var r = nbi();
- for (var i = 0; i < this.t; ++i) r[i] = this.DM & ~this[i];
+ for (var i = 0; i < this.t; ++i) r[i] = this.DM & ~this[i];
r.t = this.t;
r.s = ~this.s;
return r;
@@ -1078,23 +1081,23 @@ function bnShiftRight(n) {
function lbit(x) {
if (x == 0) return -1;
var r = 0;
- if ((x & 0xffff) == 0) {
+ if ((x & 0xffff) == 0) {
x >>= 16;
r += 16;
}
- if ((x & 0xff) == 0) {
+ if ((x & 0xff) == 0) {
x >>= 8;
r += 8;
}
- if ((x & 0xf) == 0) {
+ if ((x & 0xf) == 0) {
x >>= 4;
r += 4;
}
- if ((x & 3) == 0) {
+ if ((x & 3) == 0) {
x >>= 2;
r += 2;
}
- if ((x & 1) == 0)++r;
+ if ((x & 1) == 0)++r;
return r;
}
@@ -1112,7 +1115,7 @@ function bnGetLowestSetBit() {
function cbit(x) {
var r = 0;
while (x != 0) {
- x &= x - 1;
+ x &= x - 1;
++r;
}
return r;
@@ -1122,7 +1125,7 @@ function cbit(x) {
function bnBitCount() {
var r = 0,
- x = this.s & this.DM;
+ x = this.s & this.DM;
for (var i = 0; i < this.t; ++i) r += cbit(this[i] ^ x);
return r;
}
@@ -1132,7 +1135,7 @@ function bnBitCount() {
function bnTestBit(n) {
var j = Math.floor(n / this.DB);
if (j >= this.t) return (this.s != 0);
- return ((this[j] & (1 << (n % this.DB))) != 0);
+ return ((this[j] & (1 << (n % this.DB))) != 0);
}
// (protected) this op (1<<n)
@@ -1149,7 +1152,7 @@ function bnSetBit(n) {
return this.changeBit(n, op_or);
}
-// (public) this & ~(1<<n)
+// (public) this & ~(1<<n)
function bnClearBit(n) {
return this.changeBit(n, op_andnot);
@@ -1169,14 +1172,14 @@ function bnpAddTo(a, r) {
m = Math.min(a.t, this.t);
while (i < m) {
c += this[i] + a[i];
- r[i++] = c & this.DM;
+ r[i++] = c & this.DM;
c >>= this.DB;
}
if (a.t < this.t) {
c += a.s;
while (i < this.t) {
c += this[i];
- r[i++] = c & this.DM;
+ r[i++] = c & this.DM;
c >>= this.DB;
}
c += this.s;
@@ -1184,7 +1187,7 @@ function bnpAddTo(a, r) {
c += this.s;
while (i < a.t) {
c += a[i];
- r[i++] = c & this.DM;
+ r[i++] = c & this.DM;
c >>= this.DB;
}
c += a.s;
@@ -1431,14 +1434,14 @@ function bnModPow(e, m) {
t;
i = nbits(e[j]) - 1;
while (j >= 0) {
- if (i >= k1) w = (e[j] >> (i - k1)) & km;
+ if (i >= k1) w = (e[j] >> (i - k1)) & km;
else {
- w = (e[j] & ((1 << (i + 1)) - 1)) << (k1 - i);
+ w = (e[j] & ((1 << (i + 1)) - 1)) << (k1 - i);
if (j > 0) w |= e[j - 1] >> (this.DB + i - k1);
}
n = k;
- while ((w & 1) == 0) {
+ while ((w & 1) == 0) {
w >>= 1;
--n;
}
@@ -1464,7 +1467,7 @@ function bnModPow(e, m) {
z.mulTo(r2, g[w], r);
}
- while (j >= 0 && (e[j] & (1 << i)) == 0) {
+ while (j >= 0 && (e[j] & (1 << i)) == 0) {
z.sqrTo(r, r2);
t = r;
r = r2;
@@ -1527,7 +1530,7 @@ function bnpModInt(n) {
function bnModInverse(m) {
var ac = m.isEven();
- if ((this.isEven() && ac) || m.signum() == 0) return BigInteger.ZERO;
+ if ((this.isEven() && ac) || m.signum() == 0) return BigInteger.ZERO;
var u = m.clone(),
v = this.clone();
var a = nbv(1),
@@ -1590,7 +1593,7 @@ var lplim = (1 << 26) / lowprimes[lowprimes.length - 1];
function bnIsProbablePrime(t) {
var i, x = this.abs();
- if (x.t == 1 && x[0] <= lowprimes[lowprimes.length - 1]) {
+ if (x.t == 1 && x[0] <= lowprimes[lowprimes.length - 1]) {
for (i = 0; i < lowprimes.length; ++i)
if (x[0] == lowprimes[i]) return true;
return false;
@@ -1600,7 +1603,7 @@ function bnIsProbablePrime(t) {
while (i < lowprimes.length) {
var m = lowprimes[i],
j = i + 1;
- while (j < lowprimes.length && m < lplim) m *= lowprimes[j++];
+ while (j < lowprimes.length && m < lplim) m *= lowprimes[j++];
m = x.modInt(m);
while (i < j) if (m % lowprimes[i++] == 0) return false;
}
@@ -1639,8 +1642,8 @@ function bnToMPI() {
var ba = this.toByteArray();
var size = (ba.length - 1) * 8 + nbits(ba[0]);
var result = "";
- result += String.fromCharCode((size & 0xFF00) >> 8);
- result += String.fromCharCode(size & 0xFF);
+ result += String.fromCharCode((size & 0xFF00) >> 8);
+ result += String.fromCharCode(size & 0xFF);
result += util.bin2str(ba);
return result;
}
@@ -1665,9 +1668,9 @@ function bnpMillerRabin(t) {
bases.push(j);
a.fromInt(j);
var y = a.modPow(r, this);
- if (y.compareTo(BigInteger.ONE) != 0 && y.compareTo(n1) != 0) {
+ if (y.compareTo(BigInteger.ONE) != 0 && y.compareTo(n1) != 0) {
var j = 1;
- while (j++ < k && y.compareTo(n1) != 0) {
+ while (j++ < k && y.compareTo(n1) != 0) {
y = y.modPowInt(2, this);
if (y.compareTo(BigInteger.ONE) == 0) return false;
}
@@ -1742,13 +1745,13 @@ BigInteger.prototype.square = bnSquare;
diff --git a/doc/jxg.js.html b/doc/jxg.js.html
index 1ad13b53..4f7a3268 100644
--- a/doc/jxg.js.html
+++ b/doc/jxg.js.html
@@ -178,11 +178,11 @@ JXG.Util.Unzip = function(barray) {
function readBit() {
var carry;
bits++;
- carry = (bb & 1);
+ carry = (bb & 1);
bb >>= 1;
if (bb == 0) {
bb = readByte();
- carry = (bb & 1);
+ carry = (bb & 1);
bb = (bb >> 1) | 0x80;
}
return carry;
@@ -329,13 +329,13 @@ JXG.Util.Unzip = function(barray) {
var tmp;
for(tmp=currentTree;tmp<Places;tmp++) {
fprintf(stdout, "0x%03x 0x%03x (0x%04x)",tmp-currentTree, tmp->jump?tmp->jump-currentTree:0,(tmp->jump?tmp->jump-currentTree:0)*6+0xcf0);
- if(!(tmp.b0 & 0x8000)) {
- //fprintf(stdout, " 0x%03x (%c)", tmp->b0,(tmp->b0<256 && isprint(tmp->b0))?tmp->b0:'�');
+ if(!(tmp.b0 & 0x8000)) {
+ //fprintf(stdout, " 0x%03x (%c)", tmp->b0,(tmp->b0<256 && isprint(tmp->b0))?tmp->b0:'�');
}
- if(!(tmp.b1 & 0x8000)) {
- if((tmp.b0 & 0x8000))
+ if(!(tmp.b1 & 0x8000)) {
+ if((tmp.b0 & 0x8000))
fprintf(stdout, " ");
- fprintf(stdout, " 0x%03x (%c)", tmp->b1,(tmp->b1<256 && isprint(tmp->b1))?tmp->b1:'�');
+ fprintf(stdout, " 0x%03x (%c)", tmp->b1,(tmp->b1<256 && isprint(tmp->b1))?tmp->b1:'�');
}
fprintf(stdout, "\n");
}
@@ -355,7 +355,7 @@ JXG.Util.Unzip = function(barray) {
if (debug)
document.write("b=" + b);
if (b) {
- if (!(X.b1 & 0x8000)) {
+ if (!(X.b1 & 0x8000)) {
if (debug)
document.write("ret1");
return X.b1; /* If leaf node, return data */
@@ -370,7 +370,7 @@ JXG.Util.Unzip = function(barray) {
}
//xtreepos++;
} else {
- if (!(X.b0 & 0x8000)) {
+ if (!(X.b0 & 0x8000)) {
if (debug)
document.write("ret2");
return X.b0; /* If leaf node, return data */
@@ -427,7 +427,7 @@ JXG.Util.Unzip = function(barray) {
cSum = readByte();
cSum |= (readByte() << 8);
- if (((blockLen ^ ~cSum) & 0xffff)) {
+ if (((blockLen ^ ~cSum) & 0xffff)) {
document.write("BlockLen checksum mismatch\n");
}
while (blockLen--) {
@@ -497,7 +497,7 @@ JXG.Util.Unzip = function(barray) {
/*fprintf(errfp, "@%d (l%02x,d%04x)\n", SIZE, len, dist);*/
for (j = 0; j < len; j++) {
- var c = buf32k[(bIdx - dist) & 0x7fff];
+ var c = buf32k[(bIdx - dist) & 0x7fff];
addBuffer(c);
}
}
@@ -585,7 +585,7 @@ JXG.Util.Unzip = function(barray) {
}
/*for(j=0; j<literalCodes+distCodes; j++) {
//fprintf(errfp, "%d ", ll[j]);
- if ((j&7)==7)
+ if ((j&7)==7)
fprintf(errfp, "\n");
}
fprintf(errfp, "\n");*/
@@ -634,7 +634,7 @@ JXG.Util.Unzip = function(barray) {
if (bIdx - dist < 0) {
break outer;
}
- var c = buf32k[(bIdx - dist) & 0x7fff];
+ var c = buf32k[(bIdx - dist) & 0x7fff];
addBuffer(c);
}
} else {
@@ -710,7 +710,7 @@ JXG.Util.Unzip = function(barray) {
tmp[1] = readByte();
if (debug)
alert("type: " + tmp[0] + " " + tmp[1]);
- if (tmp[0] == parseInt("78", 16) && tmp[1] == parseInt("da", 16)) { //GZIP
+ if (tmp[0] == parseInt("78", 16) && tmp[1] == parseInt("da", 16)) { //GZIP
if (debug)
alert("GEONExT-GZIP");
DeflateLoop();
@@ -721,7 +721,7 @@ JXG.Util.Unzip = function(barray) {
unzipped[files][1] = "geonext.gxt";
files++;
}
- if (tmp[0] == parseInt("78", 16) && tmp[1] == parseInt("9c", 16)) { //ZLIB
+ if (tmp[0] == parseInt("78", 16) && tmp[1] == parseInt("9c", 16)) { //ZLIB
if (debug)
alert("ZLIB");
DeflateLoop();
@@ -732,7 +732,7 @@ JXG.Util.Unzip = function(barray) {
unzipped[files][1] = "ZLIB";
files++;
}
- if (tmp[0] == parseInt("1f", 16) && tmp[1] == parseInt("8b", 16)) { //GZIP
+ if (tmp[0] == parseInt("1f", 16) && tmp[1] == parseInt("8b", 16)) { //GZIP
if (debug)
alert("GZIP");
//DeflateLoop();
@@ -744,11 +744,11 @@ JXG.Util.Unzip = function(barray) {
unzipped[files][1] = "file";
files++;
}
- if (tmp[0] == parseInt("50", 16) && tmp[1] == parseInt("4b", 16)) { //ZIP
+ if (tmp[0] == parseInt("50", 16) && tmp[1] == parseInt("4b", 16)) { //ZIP
modeZIP = true;
tmp[2] = readByte();
tmp[3] = readByte();
- if (tmp[2] == parseInt("3", 16) && tmp[3] == parseInt("4", 16)) {
+ if (tmp[2] == parseInt("3", 16) && tmp[3] == parseInt("4", 16)) {
//MODE_ZIP
tmp[0] = readByte();
tmp[1] = readByte();
@@ -821,7 +821,7 @@ JXG.Util.Unzip = function(barray) {
CRC = 0xffffffff;
SIZE = 0;
- if (size == 0 && fileOut.charAt(fileout.length - 1) == "/") {
+ if (size == 0 && fileOut.charAt(fileout.length - 1) == "/") {
//skipdir
if (debug)
alert("skipdir");
@@ -846,15 +846,15 @@ JXG.Util.Unzip = function(barray) {
tmp = [],
compSize, size, os, i, c;
- if ((gpflags & 8)) {
+ if ((gpflags & 8)) {
tmp[0] = readByte();
tmp[1] = readByte();
tmp[2] = readByte();
tmp[3] = readByte();
- if (tmp[0] == parseInt("50", 16) &&
- tmp[1] == parseInt("4b", 16) &&
- tmp[2] == parseInt("07", 16) &&
+ if (tmp[0] == parseInt("50", 16) &&
+ tmp[1] == parseInt("4b", 16) &&
+ tmp[2] == parseInt("07", 16) &&
tmp[3] == parseInt("08", 16)) {
crc = readByte();
crc |= (readByte() << 8);
@@ -890,7 +890,7 @@ JXG.Util.Unzip = function(barray) {
gpflags = readByte();
if (debug) {
- if ((gpflags & ~(parseInt("1f", 16))))
+ if ((gpflags & ~(parseInt("1f", 16))))
alert("Unknown flags set!");
}
@@ -902,7 +902,7 @@ JXG.Util.Unzip = function(barray) {
readByte();
os = readByte();
- if ((gpflags & 4)) {
+ if ((gpflags & 4)) {
tmp[0] = readByte();
tmp[2] = readByte();
len = tmp[0] + 256 * tmp[1];
@@ -912,7 +912,7 @@ JXG.Util.Unzip = function(barray) {
readByte();
}
- if ((gpflags & 8)) {
+ if ((gpflags & 8)) {
i = 0;
nameBuf = [];
while (c = readByte()) {
@@ -926,13 +926,13 @@ JXG.Util.Unzip = function(barray) {
alert("original file name: " + nameBuf);
}
- if ((gpflags & 16)) {
+ if ((gpflags & 16)) {
while (c = readByte()) {
//FILE COMMENT
}
}
- if ((gpflags & 2)) {
+ if ((gpflags & 2)) {
readByte();
readByte();
}
@@ -980,9 +980,9 @@ JXG.Util.Base64 = {
chr3 = input.charCodeAt(i++);
enc1 = chr1 >> 2;
- enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
- enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
- enc4 = chr3 & 63;
+ enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
+ enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
+ enc4 = chr3 & 63;
if (isNaN(chr2)) {
enc3 = enc4 = 64;
@@ -1017,8 +1017,8 @@ JXG.Util.Base64 = {
enc4 = this._keyStr.indexOf(input.charAt(i++));
chr1 = (enc1 << 2) | (enc2 >> 4);
- chr2 = ((enc2 & 15) << 4) | (enc3 >> 2);
- chr3 = ((enc3 & 3) << 6) | enc4;
+ chr2 = ((enc2 & 15) << 4) | (enc3 >> 2);
+ chr3 = ((enc3 & 3) << 6) | enc4;
output.push(String.fromCharCode(chr1));
@@ -1050,13 +1050,13 @@ JXG.Util.Base64 = {
if (c < 128) {
utftext += String.fromCharCode(c);
- } else if ((c > 127) && (c < 2048)) {
+ } else if ((c > 127) && (c < 2048)) {
utftext += String.fromCharCode((c >> 6) | 192);
- utftext += String.fromCharCode((c & 63) | 128);
+ utftext += String.fromCharCode((c & 63) | 128);
} else {
utftext += String.fromCharCode((c >> 12) | 224);
- utftext += String.fromCharCode(((c >> 6) & 63) | 128);
- utftext += String.fromCharCode((c & 63) | 128);
+ utftext += String.fromCharCode(((c >> 6) & 63) | 128);
+ utftext += String.fromCharCode((c & 63) | 128);
}
}
@@ -1077,14 +1077,14 @@ JXG.Util.Base64 = {
if (c < 128) {
string.push(String.fromCharCode(c));
i++;
- } else if ((c > 191) && (c < 224)) {
+ } else if ((c > 191) && (c < 224)) {
c2 = utftext.charCodeAt(i + 1);
- string.push(String.fromCharCode(((c & 31) << 6) | (c2 & 63)));
+ string.push(String.fromCharCode(((c & 31) << 6) | (c2 & 63)));
i += 2;
} else {
c2 = utftext.charCodeAt(i + 1);
c3 = utftext.charCodeAt(i + 2);
- string.push(String.fromCharCode(((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63)));
+ string.push(String.fromCharCode(((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63)));
i += 3;
}
}
@@ -1241,14 +1241,14 @@ JXG.Util.utf8Decode = function(utftext) {
if (c < 128) {
string.push(String.fromCharCode(c));
i++;
- } else if ((c > 191) && (c < 224)) {
+ } else if ((c > 191) && (c < 224)) {
c2 = utftext.charCodeAt(i + 1);
- string.push(String.fromCharCode(((c & 31) << 6) | (c2 & 63)));
+ string.push(String.fromCharCode(((c & 31) << 6) | (c2 & 63)));
i += 2;
} else {
c2 = utftext.charCodeAt(i + 1);
c3 = utftext.charCodeAt(i + 2);
- string.push(String.fromCharCode(((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63)));
+ string.push(String.fromCharCode(((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63)));
i += 3;
}
};
@@ -1281,9 +1281,9 @@ JXG.Util.genUUID = function() {
uuid[i] = '4';
} else {
if (rnd <= 0x02) rnd = 0x2000000 + (Math.random() * 0x1000000) | 0;
- r = rnd & 0xf;
+ r = rnd & 0xf;
rnd = rnd >> 4;
- uuid[i] = chars[(i == 19) ? (r & 0x3) | 0x8 : r];
+ uuid[i] = chars[(i == 19) ? (r & 0x3) | 0x8 : r];
}
}
@@ -1302,13 +1302,13 @@ module.exports = JXG;
diff --git a/doc/key.js.html b/doc/key.js.html
index 5bdae82e..336bafa9 100644
--- a/doc/key.js.html
+++ b/doc/key.js.html
@@ -42,12 +42,18 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-/** @module key */
+/**
+ * @requires config
+ * @requires encoding/armor
+ * @requires enums
+ * @requires packet
+ * @module key
+ */
-var packet = require('./packet');
-var enums = require('./enums.js');
-var armor = require('./encoding/armor.js');
-var config = require('./config');
+var packet = require('./packet'),
+ enums = require('./enums.js'),
+ armor = require('./encoding/armor.js'),
+ config = require('./config');
/**
* @class
@@ -317,7 +323,7 @@ Key.prototype.getSigningKeyPacket = function() {
throw new Error('Need private key for signing');
}
var primaryUser = this.getPrimaryUser();
- if (primaryUser &&
+ if (primaryUser &&
isValidSigningKeyPacket(this.primaryKey, primaryUser.selfCertificate)) {
return this.primaryKey;
}
@@ -337,25 +343,25 @@ Key.prototype.getSigningKeyPacket = function() {
*/
Key.prototype.getPreferredHashAlgorithm = function() {
var primaryUser = this.getPrimaryUser();
- if (primaryUser && primaryUser.selfCertificate.preferredHashAlgorithms) {
+ if (primaryUser && primaryUser.selfCertificate.preferredHashAlgorithms) {
return primaryUser.selfCertificate.preferredHashAlgorithms[0];
}
return config.prefer_hash_algorithm;
};
function isValidEncryptionKeyPacket(keyPacket, signature) {
- return keyPacket.algorithm !== enums.read(enums.publicKey, enums.publicKey.dsa) &&
- keyPacket.algorithm !== enums.read(enums.publicKey, enums.publicKey.rsa_sign) &&
- ((signature.keyFlags & enums.keyFlags.encrypt_communication) !== 0 ||
- (signature.keyFlags & enums.keyFlags.encrypt_storage) !== 0 ||
+ return keyPacket.algorithm !== enums.read(enums.publicKey, enums.publicKey.dsa) &&
+ keyPacket.algorithm !== enums.read(enums.publicKey, enums.publicKey.rsa_sign) &&
+ ((signature.keyFlags & enums.keyFlags.encrypt_communication) !== 0 ||
+ (signature.keyFlags & enums.keyFlags.encrypt_storage) !== 0 ||
!signature.keyFlags);
};
function isValidSigningKeyPacket(keyPacket, signature) {
return (keyPacket.algorithm == enums.read(enums.publicKey, enums.publicKey.dsa) ||
keyPacket.algorithm == enums.read(enums.publicKey, enums.publicKey.rsa_sign) ||
- keyPacket.algorithm == enums.read(enums.publicKey, enums.publicKey.rsa_encrypt_sign)) &&
- ((signature.keyFlags & enums.keyFlags.sign_data) !== 0 ||
+ keyPacket.algorithm == enums.read(enums.publicKey, enums.publicKey.rsa_encrypt_sign)) &&
+ ((signature.keyFlags & enums.keyFlags.sign_data) !== 0 ||
!signature.keyFlags);
};
@@ -375,7 +381,7 @@ Key.prototype.getEncryptionKeyPacket = function() {
}
// if no valid subkey for encryption, evaluate primary key
var primaryUser = this.getPrimaryUser();
- if (primaryUser &&
+ if (primaryUser &&
isValidEncryptionKeyPacket(this.primaryKey, primaryUser.selfCertificate)) {
return this.primaryKey;
}
@@ -431,13 +437,13 @@ Key.prototype.decryptKeyPacket = function(keyIds, passphrase) {
*/
Key.prototype.verifyPrimaryKey = function() {
// check revocation signature
- if (this.revocationSignature && !this.revocationSignature.isExpired() &&
+ if (this.revocationSignature && !this.revocationSignature.isExpired() &&
(this.revocationSignature.verified ||
this.revocationSignature.verify(this.primaryKey, {key: this.primaryKey}))) {
return enums.keyStatus.revoked;
}
// check V3 expiration time
- if (this.primaryKey.version == 3 && this.primaryKey.expirationTimeV3 !== 0 &&
+ if (this.primaryKey.version == 3 && this.primaryKey.expirationTimeV3 !== 0 &&
Date.now() > (this.primaryKey.created.getTime() + this.primaryKey.expirationTimeV3*24*3600*1000)) {
return enums.keyStatus.expired;
}
@@ -445,7 +451,7 @@ Key.prototype.verifyPrimaryKey = function() {
// See 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) {
+ if (this.users[i].userId && this.users[i].selfCertifications) {
selfSigned = true;
}
}
@@ -458,7 +464,7 @@ Key.prototype.verifyPrimaryKey = function() {
return enums.keyStatus.invalid;
}
// check V4 expiration time
- if (this.primaryKey.version == 4 && primaryUser.selfCertificate.keyNeverExpires === false &&
+ if (this.primaryKey.version == 4 && primaryUser.selfCertificate.keyNeverExpires === false &&
Date.now() > (primaryUser.selfCertificate.created.getTime() + primaryUser.selfCertificate.keyExpirationTime*1000)) {
return enums.keyStatus.expired;
}
@@ -483,7 +489,7 @@ Key.prototype.getPrimaryUser = function() {
continue;
}
if (!user ||
- !userSelfCert.isPrimaryUserID && selfCert.isPrimaryUserID ||
+ !userSelfCert.isPrimaryUserID && selfCert.isPrimaryUserID ||
userSelfCert.created < selfCert.created) {
user = this.users[i];
userSelfCert = selfCert;
@@ -535,8 +541,8 @@ User.prototype.isRevoked = function(certificate, primaryKey) {
if (this.revocationCertifications) {
var that = this;
return this.revocationCertifications.some(function(revCert) {
- return revCert.issuerKeyId.equals(certificate.issuerKeyId) &&
- !revCert.isExpired() &&
+ return revCert.issuerKeyId.equals(certificate.issuerKeyId) &&
+ !revCert.isExpired() &&
(revCert.verified ||
revCert.verify(primaryKey, {userid: that.userId || that.userAttribute, key: primaryKey}));
});
@@ -559,7 +565,7 @@ User.prototype.getValidSelfCertificate = function(primaryKey) {
if (this.isRevoked(this.selfCertifications[i], primaryKey)) {
continue;
}
- if (!this.selfCertifications[i].isExpired() &&
+ if (!this.selfCertifications[i].isExpired() &&
(this.selfCertifications[i].verified ||
this.selfCertifications[i].verify(primaryKey, {userid: this.userId || this.userAttribute, key: primaryKey}))) {
validCert.push(this.selfCertifications[i]);
@@ -636,7 +642,7 @@ SubKey.prototype.toPacketlist = function() {
* @return {Boolean}
*/
SubKey.prototype.isValidEncryptionKey = function(primaryKey) {
- return this.verify(primaryKey) == enums.keyStatus.valid &&
+ return this.verify(primaryKey) == enums.keyStatus.valid &&
isValidEncryptionKeyPacket(this.subKey, this.bindingSignature);
};
@@ -646,7 +652,7 @@ SubKey.prototype.isValidEncryptionKey = function(primaryKey) {
* @return {Boolean}
*/
SubKey.prototype.isValidSigningKey = function(primaryKey) {
- return this.verify(primaryKey) == enums.keyStatus.valid &&
+ return this.verify(primaryKey) == enums.keyStatus.valid &&
isValidSigningKeyPacket(this.subKey, this.bindingSignature);
};
@@ -657,13 +663,13 @@ SubKey.prototype.isValidSigningKey = function(primaryKey) {
*/
SubKey.prototype.verify = function(primaryKey) {
// check subkey revocation signature
- if (this.revocationSignature && !this.revocationSignature.isExpired() &&
+ if (this.revocationSignature && !this.revocationSignature.isExpired() &&
(this.revocationSignature.verified ||
this.revocationSignature.verify(primaryKey, {key: this.subKey}))) {
return enums.keyStatus.revoked;
}
// check V3 expiration time
- if (this.subKey.version == 3 && this.subKey.expirationTimeV3 !== 0 &&
+ if (this.subKey.version == 3 && this.subKey.expirationTimeV3 !== 0 &&
Date.now() > (this.subKey.created.getTime() + this.subKey.expirationTimeV3*24*3600*1000)) {
return enums.keyStatus.expired;
}
@@ -679,8 +685,8 @@ SubKey.prototype.verify = function(primaryKey) {
return enums.keyStatus.invalid;
}
// check V4 expiration time
- if (this.subKey.version == 4 &&
- this.bindingSignature.keyNeverExpires === false &&
+ if (this.subKey.version == 4 &&
+ this.bindingSignature.keyNeverExpires === false &&
Date.now() > (this.subKey.created.getTime() + this.bindingSignature.keyExpirationTime*1000)) {
return enums.keyStatus.expired;
}
@@ -691,6 +697,7 @@ SubKey.prototype.verify = function(primaryKey) {
* Reads an OpenPGP armored text and returns one or multiple key objects
* @param {String} armoredText text to be parsed
* @return {{keys: Array<module:key~Key>, err: (Array<Error>|null)}} result object with key and error arrays
+ * @static
*/
function readArmored(armoredText) {
var result = {};
@@ -732,6 +739,7 @@ function readArmored(armoredText) {
* @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
* @return {module:key~Key}
+ * @static
*/
function generate(keyType, numBits, userId, passphrase) {
var packetlist = new packet.list();
@@ -793,13 +801,13 @@ exports.generate = generate;
diff --git a/doc/keyid.html b/doc/keyid.html
index b92ca530..49762552 100644
--- a/doc/keyid.html
+++ b/doc/keyid.html
@@ -36,8 +36,16 @@
+ 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
+section "Enhanced Key Formats" below describes how Key IDs are
+formed.
+
+
Requires
+
+
+
+
@@ -161,7 +175,7 @@
-
- position
-
-
-integer
-
-
-
-
-
-
-
-
-
- Position where to start reading the key
-id from input
-
-
-
@@ -274,7 +264,7 @@ id from input
Returns:
-
-
-
- This object
-
-
-
-
-
-
-
-
@@ -337,13 +305,13 @@ id from input
diff --git a/doc/keyid.js.html b/doc/keyid.js.html
index f5344d76..a11e9ee4 100644
--- a/doc/keyid.js.html
+++ b/doc/keyid.js.html
@@ -42,19 +42,23 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-/** @module type/keyid */
+/**
+ * Implementation of type key id (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
+ * section "Enhanced Key Formats" below describes how Key IDs are
+ * formed.
+ * @requires util
+ * @module type/keyid
+ */
var util = require('../util');
/**
- * @class
- * @classdesc 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
- section "Enhanced Key Formats" below describes how Key IDs are
- formed.
+ * @constructor
*/
-module.exports = function keyid() {
+module.exports = function () {
this.bytes = '';
@@ -62,30 +66,27 @@ module.exports = function keyid() {
/**
* Parsing method for a key id
* @param {String} input Input to read the key id from
- * @param {integer} position Position where to start reading the key
- * id from input
- * @return {module:type/keyid} This object
*/
this.read = function(bytes) {
this.bytes = bytes.substr(0, 8);
- }
+ };
this.write = function() {
return this.bytes;
- }
+ };
this.toHex = function() {
return util.hexstrdump(this.bytes);
- }
+ };
this.equals = function(keyid) {
return this.bytes == keyid.bytes;
- }
+ };
this.isNull = function() {
return this.bytes === '';
- }
-}
+ };
+};
module.exports.mapToHex = function(keyId) {
return keyId.toHex();
@@ -100,13 +101,13 @@ module.exports.mapToHex = function(keyId) {
diff --git a/doc/keyring.html b/doc/keyring.html
index 9e3db82b..9cbff110 100644
--- a/doc/keyring.html
+++ b/doc/keyring.html
@@ -36,20 +36,88 @@
+ The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage.
+
+
Type Definitions
+
+
+
+
+
@@ -1196,13 +2035,13 @@ This method is called by openpgp.init().
diff --git a/doc/keyring.js.html b/doc/keyring.js.html
index bf4019f4..4979f779 100644
--- a/doc/keyring.js.html
+++ b/doc/keyring.js.html
@@ -42,36 +42,55 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-/** @module keyring/keyring */
+/**
+ * The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage.
+ * @requires openpgp
+ * @module keyring/keyring
+ */
var openpgp = require('openpgp');
/**
- * @class
- * @classdesc The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage.
+ * Callback to check if a key matches the input
+ * @callback module:keyring/keyring.checkCallback
+ * @param {String} input input to search for
+ * @param {module:key~Key} key The key to be checked.
+ * @return {Boolean} True if the input matches the specified key
*/
-module.exports = function() {
- this.keys = [];
+
+/**
+ * Initialization routine for the keyring. This method reads the
+ * keyring from HTML5 local storage and initializes this instance.
+ * @constructor
+ * @param {class} [storeHandler] class implementing load() and store() methods
+ */
+module.exports = function(storeHandler) {
+ if (!storeHandler) {
+ storeHandler = new (require('./localstore.js'))();
+ }
+ this.storeHandler = storeHandler;
+ this.keys = this.storeHandler.load();
/**
- * Initialization routine for the keyring. This method reads the
- * keyring from HTML5 local storage and initializes this instance.
- * This method is called by openpgp.init().
+ * Calls the storeHandler to save the keys
*/
- this.init = function (storeHandler) {
- if (!storeHandler) {
- var localstore = require('./localstore.js');
- storeHandler = new localstore();
- }
- this.storeHandler = storeHandler;
- this.keys = [];
- this.storeHandler.init(this.keys);
- }
-
this.store = function () {
this.storeHandler.store(this.keys);
- }
+ };
+ /**
+ * Clear the keyring - erase all the keys
+ */
+ this.clear = function() {
+ this.keys = [];
+ };
+
+ /**
+ * Checks a key to see if it matches the specified email address
+ * @param {String} email email address to search for
+ * @param {module:key~Key} key The key to be checked.
+ * @return {Boolean} True if the email address is defined in the specified key
+ */
function emailCheck(email, key) {
email = email.toLowerCase();
var keyEmails = key.getUserIds();
@@ -85,6 +104,13 @@ module.exports = function() {
return false;
}
+ /**
+ * Checks a key to see if it matches the specified keyid
+ * @param {String} id hex string keyid to search for
+ * @param {module:key~Key} key the key to be checked.
+ * @return {Boolean} true if the email address is defined in the specified key
+ * @inner
+ */
function idCheck(id, key) {
var keyids = key.getKeyIds();
for (var i = 0; i < keyids.length; i++) {
@@ -95,18 +121,26 @@ module.exports = function() {
return false;
}
+ /**
+ * searches all public keys in the keyring matching the address or address part of the user ids
+ * @param {Array<module:key~Key>} keys array of keys to search
+ * @param {module:keyring/keyring.checkCallback} identityFunction callback function which checks for a match
+ * @param {String} identityInput input to check against
+ * @param {module:enums.packet} keyType packet types of keys to check
+ * @return {Array<module:key~Key>} array of keys which match
+ */
function checkForIdentityAndKeyTypeMatch(keys, identityFunction, identityInput, keyType) {
var results = [];
for (var p = 0; p < keys.length; p++) {
var key = keys[p];
switch (keyType) {
case openpgp.enums.packet.public_key:
- if (key.isPublic() && identityFunction(identityInput, key)) {
+ if (key.isPublic() && identityFunction(identityInput, key)) {
results.push(key);
}
break;
case openpgp.enums.packet.private_key:
- if (key.isPrivate() && identityFunction(identityInput, key)) {
+ if (key.isPrivate() && identityFunction(identityInput, key)) {
results.push(key);
}
break;
@@ -114,7 +148,6 @@ module.exports = function() {
}
return results;
}
- this.checkForIdentityAndKeyTypeMatch = checkForIdentityAndKeyTypeMatch;
/**
* searches all public keys in the keyring matching the address or address part of the user ids
@@ -123,71 +156,64 @@ module.exports = function() {
*/
this.getPublicKeyForAddress = function (email) {
return checkForIdentityAndKeyTypeMatch(this.keys, emailCheck, email, openpgp.enums.packet.public_key);
- }
+ };
/**
* Searches the keyring for a private key containing the specified email address
* @param {String} email email address to search for
* @return {Array<module:key~Key>} private keys found
*/
- function getPrivateKeyForAddress(email) {
+ this.getPrivateKeyForAddress = function (email) {
return checkForIdentityAndKeyTypeMatch(this.keys, emailCheck, email, openpgp.enums.packet.secret_key);
- }
- this.getPrivateKeyForAddress = getPrivateKeyForAddress;
+ };
/**
* Searches the keyring for public keys having the specified key id
* @param {String} keyId provided as string of hex number (lowercase)
* @return {Array<module:key~Key>} public keys found
*/
- function getKeysForKeyId(keyId) {
- return this.checkForIdentityAndKeyTypeMatch(this.keys, idCheck, keyId, openpgp.enums.packet.public_key);
- }
- this.getKeysForKeyId = getKeysForKeyId;
+ this.getKeysForKeyId = function (keyId) {
+ return checkForIdentityAndKeyTypeMatch(this.keys, idCheck, keyId, openpgp.enums.packet.public_key);
+ };
/**
* Imports a key from an ascii armored message
* @param {String} armored message to read the keys/key from
*/
- function importKey(armored) {
+ this.importKey = function (armored) {
this.keys = this.keys.concat(openpgp.key.readArmored(armored).keys);
return true;
- }
- this.importKey = importKey;
+ };
/**
* returns the armored message representation of the key at key ring index
* @param {Integer} index the index of the key within the array
* @return {String} armored message representing the key object
*/
- function exportKey(index) {
+ this.exportKey = function (index) {
return this.keys[index].armor();
- }
- this.exportKey = exportKey;
+ };
/**
- * Removes a public key from the public key keyring at the specified index
+ * Removes a public key from the public key keyring at the specified index
* @param {Integer} index the index of the public key within the publicKeys array
* @return {module:key~Key} The public key object which has been removed
*/
- function removeKey(index) {
+ this.removeKey = function (index) {
var removed = this.keys.splice(index, 1);
return removed;
- }
- this.removeKey = removeKey;
+ };
/**
* returns the armored message representation of the public key portion of the key at key ring index
* @param {Integer} index the index of the key within the array
* @return {String} armored message representing the public key object
*/
- function exportPublicKey(index) {
+ this.exportPublicKey = function (index) {
return this.keys[index].toPublic().armor();
- }
- this.exportPublicKey = exportPublicKey;
-
+ };
};
diff --git a/doc/literal.html b/doc/literal.html index 83f13043..7dd06758 100644 --- a/doc/literal.html +++ b/doc/literal.html @@ -36,8 +36,14 @@
+
Implementation of the Literal Data Packet (Tag 11)
+
+RFC4880 5.9: A Literal Data packet contains the body of a message; data that +is not to be further interpreted.
+
+
+
+RFC4880 5.9: A Literal Data packet contains the body of a message; data that +is not to be further interpreted.
Requires
+ +-
+
diff --git a/doc/literal.js.html b/doc/literal.js.html index 545dbf66..8819d053 100644 --- a/doc/literal.js.html +++ b/doc/literal.js.html @@ -42,19 +42,23 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/literal */ +/** + * 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 + * is not to be further interpreted. + * @requires enums + * @requires util + * @module packet/literal + */ var util = require('../util'), enums = require('../enums.js'); /** - * @class - * @classdesc Implementation of the Literal Data Packet (Tag 11) - * - * RFC4880 5.9: A Literal Data packet contains the body of a message; data that - * is not to be further interpreted. + * @constructor */ -module.exports = function packet_literal() { +module.exports = function () { this.format = 'utf8'; // default format for literal data packets this.data = ''; // literal data representation as native JavaScript string or bytes this.date = new Date(); @@ -160,13 +164,13 @@ module.exports = function packet_literal() {
diff --git a/doc/localStorage.html b/doc/localStorage.html new file mode 100644 index 00000000..5ef99a0c --- /dev/null +++ b/doc/localStorage.html @@ -0,0 +1,332 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: config/localStorage
+ + + + + ++ config/localStorage +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This object storing and retrieving configuration from HTML5 local storage.
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods
+ +-
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/localStorage.js.html b/doc/localStorage.js.html new file mode 100644 index 00000000..92239422 --- /dev/null +++ b/doc/localStorage.js.html @@ -0,0 +1,81 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+Source: config/localStorage.js
+ + + + + +/**
+ * This object storing and retrieving configuration from HTML5 local storage.
+ * @module config/localStorage
+ */
+
+/**
+ * @constructor
+ */
+module.exports = function () {
+
+ /**
+ * Reads the config out of the HTML5 local storage
+ * and initializes the object config.
+ * if config is null the default config will be used
+ */
+ this.read = function () {
+ var cf = JSON.parse(window.localStorage.getItem("config"));
+ if (cf === null) {
+ this.config = this.default_config;
+ this.write();
+ } else
+ this.config = cf;
+ }
+
+ /**
+ * Writes the config to HTML5 local storage
+ */
+ this.write = function () {
+ window.localStorage.setItem("config", JSON.stringify(this.config));
+ }
+}
++ + + + + + + diff --git a/doc/localstore.html b/doc/localstore.html index 09f19cd5..4163ad35 100644 --- a/doc/localstore.html +++ b/doc/localstore.html @@ -35,73 +35,10 @@
-
-
The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage.
@@ -148,6 +85,12 @@
+ Requires
+ +-
+
- Initialization routine for the keyring. This method reads the
-keyring from HTML5 local storage and initializes this instance.
-This method is called by openpgp.init().
+ Load the keyring from HTML5 local storage and initializes this instance.
@@ -204,7 +145,7 @@ This method is called by openpgp.init().
Returns:
+ + +
+ array of keys retrieved from localstore
+
+
+
+
+-
+
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
keys |
+
+
+ + + +Array.<module:key~Key> + + + + | + + + + + +array of keys to save in localstore | +
-
@@ -315,13 +326,13 @@ The privateKeys array and publicKeys array gets Stringified using JSON
diff --git a/doc/localstore.js.html b/doc/localstore.js.html index 4317deb6..554dfd54 100644 --- a/doc/localstore.js.html +++ b/doc/localstore.js.html @@ -42,36 +42,36 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module keyring/localstore */ +/** + * The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage. + * @requires openpgp + * @module keyring/localstore + */ var openpgp = require('openpgp'); -/** - * @class - * @classdesc The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage. - */ module.exports = function () { /** - * Initialization routine for the keyring. This method reads the - * keyring from HTML5 local storage and initializes this instance. - * This method is called by openpgp.init(). + * Load the keyring from HTML5 local storage and initializes this instance. + * @return {Array<module:key~Key>} array of keys retrieved from localstore */ - this.init = function (keys) { + this.load = function () { var armoredKeys = JSON.parse(window.localStorage.getItem("armoredKeys")); - if (armoredKeys !== null && armoredKeys.length === 0) { + var keys = []; + if (armoredKeys !== null && armoredKeys.length !== 0) { var key; for (var i = 0; i < armoredKeys.length; i++) { key = openpgp.key.readArmored(armoredKeys[i]); keys.push(key); } - } else { - this.keys = []; } + return keys; } /** * Saves the current state of the keyring to HTML5 local storage. * The privateKeys array and publicKeys array gets Stringified using JSON + * @param {Array<module:key~Key>} keys array of keys to save in localstore */ this.store = function (keys) { var armoredKeys = []; @@ -91,13 +91,13 @@ module.exports = function () {
diff --git a/doc/marker.html b/doc/marker.html index af2d684a..3cbb6d14 100644 --- a/doc/marker.html +++ b/doc/marker.html @@ -36,8 +36,18 @@
+
Implementation of the strange "Marker packet" (Tag 10)
+
+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.
+
+Such a packet MUST be ignored when received.
+
+
+
+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.
+
+Such a packet MUST be ignored when received.
diff --git a/doc/marker.js.html b/doc/marker.js.html index fc39cffe..2e235959 100644 --- a/doc/marker.js.html +++ b/doc/marker.js.html @@ -42,18 +42,21 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/marker */ /** - * @class - * @classdesc Implementation of the strange "Marker packet" (Tag 10) - * + * Implementation of the strange "Marker packet" (Tag 10)<br/> + * <br/> * 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. - * + * the Marker packet.<br/> + * <br/> * Such a packet MUST be ignored when received. + * @module packet/marker + */ + +/** + * @constructor */ module.exports = function () { /** @@ -68,8 +71,8 @@ module.exports = function () { * @return {module:packet/marker} Object representation */ this.read = function(bytes) { - if (bytes.charCodeAt(0) == 0x50 && // P - bytes.charCodeAt(1) == 0x47 && // G + if (bytes.charCodeAt(0) == 0x50 && // P + bytes.charCodeAt(1) == 0x47 && // G bytes.charCodeAt(2) == 0x50) // P return true; // marker packet does not contain "PGP" @@ -86,13 +89,13 @@ module.exports = function () {
diff --git a/doc/md5.html b/doc/md5.html index b7625cc9..e42c4ad3 100644 --- a/doc/md5.html +++ b/doc/md5.html @@ -35,6 +35,124 @@
+
+
+
Requires
+ +-
+
diff --git a/doc/md5.js.html b/doc/md5.js.html index 7a1fb033..5e260d4e 100644 --- a/doc/md5.js.html +++ b/doc/md5.js.html @@ -39,11 +39,18 @@ * warranty of any kind. */ -/** @module crypto/hash/md5 */ +/** + * @requires util + * @module crypto/hash/md5 + */ -var util = require('../../util/util.js'); +var util = require('../../util'); -function MD5(entree) { +/** + * MD5 hash + * @param {String} entree string to hash + */ +module.exports = function (entree) { var hex = md5(entree); var bin = util.hex2bin(hex); return bin; @@ -136,11 +143,11 @@ function cmn(q, a, b, x, s, t) { } function ff(a, b, c, d, x, s, t) { - return cmn((b & c) | ((~b) & d), a, b, x, s, t); + return cmn((b & c) | ((~b) & d), a, b, x, s, t); } function gg(a, b, c, d, x, s, t) { - return cmn((b & d) | (c & (~d)), a, b, x, s, t); + return cmn((b & d) | (c & (~d)), a, b, x, s, t); } function hh(a, b, c, d, x, s, t) { @@ -204,7 +211,7 @@ function rhex(n) { var s = '', j = 0; for (; j < 4; j++) - s += hex_chr[(n >> (j * 8 + 4)) & 0x0F] + hex_chr[(n >> (j * 8)) & 0x0F]; + s += hex_chr[(n >> (j * 8 + 4)) & 0x0F] + hex_chr[(n >> (j * 8)) & 0x0F]; return s; } @@ -225,18 +232,16 @@ need the idiotic second function, generated by an if clause. */ function add32(a, b) { - return (a + b) & 0xFFFFFFFF; + return (a + b) & 0xFFFFFFFF; } if (md5('hello') != '5d41402abc4b2a76b9719d911017c592') { function add32(x, y) { - var lsw = (x & 0xFFFF) + (y & 0xFFFF), + var lsw = (x & 0xFFFF) + (y & 0xFFFF), msw = (x >> 16) + (y >> 16) + (lsw >> 16); - return (msw << 16) | (lsw & 0xFFFF); + return (msw << 16) | (lsw & 0xFFFF); } } - -module.exports = MD5
diff --git a/doc/message.js.html b/doc/message.js.html index 2bcd3764..88f1d507 100644 --- a/doc/message.js.html +++ b/doc/message.js.html @@ -42,14 +42,20 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module message */ +/** + * @requires config + * @requires crypto + * @requires encoding/armor + * @requires enums + * @requires packet + * @module message + */ -var packet = require('./packet'); -var enums = require('./enums.js'); -var armor = require('./encoding/armor.js'); -var config = require('./config'); -var crypto = require('./crypto'); -var util = require('./util'); +var packet = require('./packet'), + enums = require('./enums.js'), + armor = require('./encoding/armor.js'), + config = require('./config'), + crypto = require('./crypto'); /** * @class @@ -139,7 +145,7 @@ Message.prototype.decrypt = function(privateKey) { */ Message.prototype.getLiteralData = function() { var literal = this.packets.findPacket(enums.packet.literal); - return literal && literal.data || null; + return literal && literal.data || null; }; /** @@ -288,6 +294,7 @@ Message.prototype.armor = function() { * reads an OpenPGP armored message and returns a message object * @param {String} armoredText text to be parsed * @return {module:message~Message} new message object + * @static */ function readArmored(armoredText) { //TODO how do we want to handle bad text? Exception throwing @@ -303,6 +310,7 @@ function readArmored(armoredText) { * creates new message object from text * @param {String} text * @return {module:message~Message} new message object + * @static */ function fromText(text) { var literalDataPacket = new packet.literal(); @@ -318,6 +326,7 @@ function fromText(text) { * creates new message object from binary data * @param {String} bytes * @return {module:message~Message} new message object + * @static */ function fromBinary(bytes) { var literalDataPacket = new packet.literal(); @@ -342,13 +351,13 @@ exports.fromBinary = fromBinary;
diff --git a/doc/module-armor.html b/doc/module-armor.html new file mode 100644 index 00000000..dae971d4 --- /dev/null +++ b/doc/module-armor.html @@ -0,0 +1,127 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: armor
+ + + + + ++ armor +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/module-cleartext-CleartextMessage.html b/doc/module-cleartext-CleartextMessage.html index 60f6adc9..6a36c71b 100644 --- a/doc/module-cleartext-CleartextMessage.html +++ b/doc/module-cleartext-CleartextMessage.html @@ -153,7 +153,7 @@ See http://tools.ietf.org/html/rfc4880#section-7
diff --git a/doc/module-cleartext.html b/doc/module-cleartext.html index 8d9609b3..b647874a 100644 --- a/doc/module-cleartext.html +++ b/doc/module-cleartext.html @@ -83,6 +83,18 @@ +
Requires
+ +-
+
Classes
@@ -103,7 +115,7 @@diff --git a/doc/module-config.html b/doc/module-config.html new file mode 100644 index 00000000..d12852ab --- /dev/null +++ b/doc/module-config.html @@ -0,0 +1,127 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: config
+ + + + + ++ config +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/module-crypto.html b/doc/module-crypto.html new file mode 100644 index 00000000..9fee91f4 --- /dev/null +++ b/doc/module-crypto.html @@ -0,0 +1,530 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: crypto
+ + + + + ++ crypto +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Members
+ +-
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/module-enums.html b/doc/module-enums.html new file mode 100644 index 00000000..d7317d05 --- /dev/null +++ b/doc/module-enums.html @@ -0,0 +1,4542 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: enums
+ + + + + ++ enums +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+ +-
+
+
Methods
+ +-
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/module-key-Key.html b/doc/module-key-Key.html index 59b7fac0..7e863ae8 100644 --- a/doc/module-key-Key.html +++ b/doc/module-key-Key.html @@ -129,7 +129,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.
diff --git a/doc/module-key-SubKey.html b/doc/module-key-SubKey.html index 7571bff2..b15da579 100644 --- a/doc/module-key-SubKey.html +++ b/doc/module-key-SubKey.html @@ -80,7 +80,7 @@
diff --git a/doc/module-key-User.html b/doc/module-key-User.html index 38859e31..186eb2e9 100644 --- a/doc/module-key-User.html +++ b/doc/module-key-User.html @@ -80,7 +80,7 @@
diff --git a/doc/module-key.html b/doc/module-key.html index 7c2459bb..2a381775 100644 --- a/doc/module-key.html +++ b/doc/module-key.html @@ -83,6 +83,18 @@ +
Requires
+ +-
+
Classes
@@ -109,7 +121,7 @@diff --git a/doc/module-keyid.html b/doc/module-keyid.html new file mode 100644 index 00000000..06d81306 --- /dev/null +++ b/doc/module-keyid.html @@ -0,0 +1,127 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: keyid
+ + + + + ++ keyid +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/module-message-Message.html b/doc/module-message-Message.html index 26231aa9..958e1511 100644 --- a/doc/module-message-Message.html +++ b/doc/module-message-Message.html @@ -130,7 +130,7 @@ See http://tools.ietf.org/html/rfc4880#section-11.3
diff --git a/doc/module-message.html b/doc/module-message.html index a43135e8..9625eb55 100644 --- a/doc/module-message.html +++ b/doc/module-message.html @@ -83,6 +83,20 @@ +
Requires
+ +-
+
Classes
@@ -103,7 +117,7 @@diff --git a/doc/module-mpi.html b/doc/module-mpi.html new file mode 100644 index 00000000..254e23dc --- /dev/null +++ b/doc/module-mpi.html @@ -0,0 +1,127 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: mpi
+ + + + + ++ mpi +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/module-openpgp.html b/doc/module-openpgp.html index 219a655c..3d26f5c8 100644 --- a/doc/module-openpgp.html +++ b/doc/module-openpgp.html @@ -62,7 +62,7 @@
Requires
+ +-
+
diff --git a/doc/module-packet.html b/doc/module-packet.html new file mode 100644 index 00000000..f04a3120 --- /dev/null +++ b/doc/module-packet.html @@ -0,0 +1,1042 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: packet
+ + + + + ++ packet +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Requires
+ +-
+
Members
+ +-
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/module-s2k.html b/doc/module-s2k.html new file mode 100644 index 00000000..eeecdf81 --- /dev/null +++ b/doc/module-s2k.html @@ -0,0 +1,127 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: s2k
+ + + + + ++ s2k +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/module-util.html b/doc/module-util.html new file mode 100644 index 00000000..82c3a1b6 --- /dev/null +++ b/doc/module-util.html @@ -0,0 +1,127 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: util
+ + + + + ++ util +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/mpi.html b/doc/mpi.html index 73e12ad5..41e0f435 100644 --- a/doc/mpi.html +++ b/doc/mpi.html @@ -36,8 +36,18 @@
+
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 +calculations. +An MPI consists of two pieces: a two-octet scalar that is the length +of the MPI in bits followed by a string of octets that contain the +actual integer.
+
+
+
+Multiprecision integers (also called MPIs) are unsigned integers used +to hold large integers such as the ones used in cryptographic +calculations. +An MPI consists of two pieces: a two-octet scalar that is the length +of the MPI in bits followed by a string of octets that contain the +actual integer.
Requires
+ + + @@ -195,7 +213,7 @@positionlen
- Object representation
+ Length of data read
@@ -392,7 +362,7 @@ input at position
diff --git a/doc/mpi.js.html b/doc/mpi.js.html index 554a983e..05483c27 100644 --- a/doc/mpi.js.html +++ b/doc/mpi.js.html @@ -47,20 +47,25 @@ // - MPI size: (a << 8) | b // - MPI = c | d << 8 | e << ((MPI.length -2)*8) | f ((MPI.length -2)*8) -/** @module type/mpi */ - -var BigInteger = require('../crypto/public_key/jsbn.js'), - util = require('../util'); - /** - * @class - * @classdescImplementation of type MPI (RFC4880 3.2) + * Implementation of type MPI (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 * calculations. * An MPI consists of two pieces: a two-octet scalar that is the length * of the MPI in bits followed by a string of octets that contain the * actual integer. + * @requires crypto/public_key/jsbn + * @requires util + * @module type/mpi + */ + +var BigInteger = require('../crypto/public_key/jsbn.js'), + util = require('../util'); + +/** + * @constructor */ module.exports = function mpi() { /** An implementation dependent integer */ @@ -69,11 +74,7 @@ module.exports = function mpi() { /** * Parsing function for a mpi (RFC 4880 3.2). * @param {String} input Payload of mpi data - * @param {Integer} position Position to start reading from the input - * string - * @param {Integer} len Length of the packet or the remaining length of - * input at position - * @return {module:type/mpi} Object representation + * @return {Integer} Length of data read */ this.read = function(bytes) { var bits = (bytes.charCodeAt(0) << 8) | bytes.charCodeAt(1); @@ -94,19 +95,19 @@ module.exports = function mpi() { this.fromBytes(raw); return 2 + bytelen; - } + }; this.fromBytes = function(bytes) { this.data = new BigInteger(util.hexstrdump(bytes), 16); - } + }; this.toBytes = function() { return this.write().substr(2); - } + }; this.byteLength = function() { return this.toBytes().length; - } + }; /** * Converts the mpi object to a string as specified in RFC4880 3.2 @@ -114,15 +115,15 @@ module.exports = function mpi() { */ this.write = function() { return this.data.toMPI(); - } + }; this.toBigInteger = function() { return this.data.clone(); - } + }; this.fromBigInteger = function(bn) { this.data = bn.clone(); - } + }; } @@ -134,13 +135,13 @@ module.exports = function mpi() {
diff --git a/doc/one_pass_signature.html b/doc/one_pass_signature.html index 73556e70..77d877de 100644 --- a/doc/one_pass_signature.html +++ b/doc/one_pass_signature.html @@ -36,8 +36,18 @@
+
Implementation of the One-Pass Signature Packets (Tag 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 +can compute the entire signed message in one pass.
+
+
+
+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 +can compute the entire signed message in one pass.
Requires
+ +-
+
diff --git a/doc/one_pass_signature.js.html b/doc/one_pass_signature.js.html index d6f4f1f0..c77a071b 100644 --- a/doc/one_pass_signature.js.html +++ b/doc/one_pass_signature.js.html @@ -42,24 +42,27 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/one_pass_signature */ - -var enums = require('../enums.js'), - type_keyid = require('../type/keyid.js'); - /** - * @class - * @classdesc Implementation of the One-Pass Signature Packets (Tag 4) - * + * 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 * 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 * can compute the entire signed message in one pass. - */ + * @requires enums + * @requires type/keyid + * @module packet/one_pass_signature +*/ -module.exports = function one_pass_signature() { +var enums = require('../enums.js'), + type_keyid = require('../type/keyid.js'); + +/** + * @constructor + */ +module.exports = function () { 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) @@ -127,13 +130,13 @@ module.exports = function one_pass_signature() {
diff --git a/doc/openpgp.js.html b/doc/openpgp.js.html index ca66d135..d9c27f61 100644 --- a/doc/openpgp.js.html +++ b/doc/openpgp.js.html @@ -48,15 +48,23 @@ * for extending and developing on top of the base library. */ -/** @module openpgp */ +/** + * @requires cleartext + * @requires config + * @requires encoding/armor + * @requires enums + * @requires message + * @requires packet + * @module openpgp + */ -var armor = require('./encoding/armor.js'); -var packet = require('./packet'); -var enums = require('./enums.js'); -var config = require('./config'); -var message = require('./message.js'); -var cleartext = require('./cleartext.js'); -var key = require('./key.js'); +var armor = require('./encoding/armor.js'), + packet = require('./packet'), + enums = require('./enums.js'), + config = require('./config'), + message = require('./message.js'), + cleartext = require('./cleartext.js'), + key = require('./key.js'); /** @@ -64,6 +72,7 @@ var key = require('./key.js'); * @param {Array<module:key~Key>} keys array of keys, used to encrypt the message * @param {String} text message as native JavaScript string * @return {String} encrypted ASCII armored message + * @static */ function encryptMessage(keys, text) { var msg = message.fromText(text); @@ -78,6 +87,7 @@ function encryptMessage(keys, text) { * @param {module:key~Key} privateKey private key with decrypted secret key data for signing * @param {String} text message as native JavaScript string * @return {String} encrypted ASCII armored message + * @static */ function signAndEncryptMessage(publicKeys, privateKey, text) { var msg = message.fromText(text); @@ -93,6 +103,7 @@ function signAndEncryptMessage(publicKeys, privateKey, text) { * @param {module:message~Message} message the message object with the encrypted data * @return {(String|null)} decrypted message as as native JavaScript string * or null if no literal data found + * @static */ function decryptMessage(privateKey, message) { message = message.decrypt(privateKey); @@ -107,6 +118,7 @@ function decryptMessage(privateKey, message) { * @return {{text: String, signatures: Array<{keyid: module:type/keyid, valid: Boolean}>}} * decrypted message as as native JavaScript string * with verified signatures or null if no literal data found + * @static */ function decryptAndVerifyMessage(privateKey, publicKeys, message) { var result = {}; @@ -124,6 +136,7 @@ function decryptAndVerifyMessage(privateKey, publicKeys, message) { * @param {Array<module:key~Key>} privateKeys private key with decrypted secret key data to sign cleartext * @param {String} text cleartext * @return {String} ASCII armored message + * @static */ function signClearMessage(privateKeys, text) { var cleartextMessage = new cleartext.CleartextMessage(text); @@ -137,6 +150,7 @@ function signClearMessage(privateKeys, text) { * @param {module:cleartext~CleartextMessage} message cleartext message object with signatures * @return {{text: String, signatures: Array<{keyid: module:type/keyid, valid: Boolean}>}} * cleartext with status of verified signatures + * @static */ function verifyClearSignedMessage(publicKeys, message) { var result = {}; @@ -157,6 +171,7 @@ function verifyClearSignedMessage(publicKeys, message) { * @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 * @return {Object} {key: Array<module:key~Key>, privateKeyArmored: Array<String>, publicKeyArmored: Array<String>} + * @static */ function generateKeyPair(keyType, numBits, userId, passphrase) { var result = {}; @@ -184,13 +199,13 @@ exports.generateKeyPair = generateKeyPair;
diff --git a/doc/packet.html b/doc/packet.html index fdc9b6c7..8d1498aa 100644 --- a/doc/packet.html +++ b/doc/packet.html @@ -83,6 +83,14 @@ +
Requires
+ +-
+
diff --git a/doc/packet.js.html b/doc/packet.js.html index 13e2c333..876a0844 100644 --- a/doc/packet.js.html +++ b/doc/packet.js.html @@ -42,7 +42,11 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/packet */ +/** + * @requires enums + * @requires util + * @module packet/packet + */ var enums = require('../enums.js'), util = require('../util'); @@ -83,13 +87,13 @@ module.exports = { var result = ""; if (length < 192) { result += String.fromCharCode(length); - } else if (length > 191 && length < 8384) { + } else if (length > 191 && length < 8384) { /* * let a = (total data packet length) - 192 let bc = two octet * representation of a let d = b + 192 */ result += String.fromCharCode(((length - 192) >> 8) + 192); - result += String.fromCharCode((length - 192) & 0xFF); + result += String.fromCharCode((length - 192) & 0xFF); } else { result += String.fromCharCode(255); result += util.writeNumber(length, 4); @@ -146,7 +150,7 @@ module.exports = { */ read: function(input, position, len) { // some sanity checks - if (input == null || input.length <= position || input.substring(position).length < 2 || (input.charCodeAt(position) & + if (input == null || input.length <= position || input.substring(position).length < 2 || (input.charCodeAt(position) & 0x80) == 0) { throw new Error("Error during parsing. This message / key is probably not containing a valid OpenPGP format."); } @@ -156,18 +160,18 @@ module.exports = { var packet_length; format = 0; // 0 = old format; 1 = new format - if ((input.charCodeAt(mypos) & 0x40) != 0) { + if ((input.charCodeAt(mypos) & 0x40) != 0) { format = 1; } var packet_length_type; if (format) { // new format header - tag = input.charCodeAt(mypos) & 0x3F; // bit 5-0 + tag = input.charCodeAt(mypos) & 0x3F; // bit 5-0 } else { // old format header - tag = (input.charCodeAt(mypos) & 0x3F) >> 2; // bit 5-2 - packet_length_type = input.charCodeAt(mypos) & 0x03; // bit 1-0 + tag = (input.charCodeAt(mypos) & 0x3F) >> 2; // bit 5-2 + packet_length_type = input.charCodeAt(mypos) & 0x03; // bit 1-0 } // header octet parsing done @@ -220,12 +224,12 @@ module.exports = { packet_length = input.charCodeAt(mypos++); util.print_debug("1 byte length:" + packet_length); // 4.2.2.2. Two-Octet Lengths - } else if (input.charCodeAt(mypos) >= 192 && input.charCodeAt(mypos) < 224) { + } else if (input.charCodeAt(mypos) >= 192 && input.charCodeAt(mypos) < 224) { packet_length = ((input.charCodeAt(mypos++) - 192) << 8) + (input.charCodeAt(mypos++)) + 192; util.print_debug("2 byte length:" + packet_length); // 4.2.2.4. Partial Body Lengths - } else if (input.charCodeAt(mypos) > 223 && input.charCodeAt(mypos) < 255) { - packet_length = 1 << (input.charCodeAt(mypos++) & 0x1F); + } else if (input.charCodeAt(mypos) > 223 && input.charCodeAt(mypos) < 255) { + packet_length = 1 << (input.charCodeAt(mypos++) & 0x1F); util.print_debug("4 byte length:" + packet_length); // EEEK, we're reading the full data here... var mypos2 = mypos + packet_length; @@ -237,14 +241,14 @@ module.exports = { bodydata += input.substring(mypos2, mypos2 + tmplen); mypos2 += tmplen; break; - } else if (input.charCodeAt(mypos2) >= 192 && input.charCodeAt(mypos2) < 224) { + } else if (input.charCodeAt(mypos2) >= 192 && input.charCodeAt(mypos2) < 224) { var tmplen = ((input.charCodeAt(mypos2++) - 192) << 8) + (input.charCodeAt(mypos2++)) + 192; packet_length += tmplen; bodydata += input.substring(mypos2, mypos2 + tmplen); mypos2 += tmplen; break; - } else if (input.charCodeAt(mypos2) > 223 && input.charCodeAt(mypos2) < 255) { - var tmplen = 1 << (input.charCodeAt(mypos2++) & 0x1F); + } else if (input.charCodeAt(mypos2) > 223 && input.charCodeAt(mypos2) < 255) { + var tmplen = 1 << (input.charCodeAt(mypos2++) & 0x1F); packet_length += tmplen; bodydata += input.substring(mypos2, mypos2 + tmplen); mypos2 += tmplen; @@ -294,13 +298,13 @@ module.exports = {
diff --git a/doc/packetlist.html b/doc/packetlist.html index 1f113361..4fede89a 100644 --- a/doc/packetlist.html +++ b/doc/packetlist.html @@ -36,8 +36,13 @@
+
-
-openpgp_byte_array
+String
@@ -840,7 +855,7 @@ writing to packetlist[i] directly will result in an error.
- array of bytes.
+ binary string of bytes.
@@ -871,7 +886,7 @@ writing to packetlist[i] directly will result in an error.
This class represents a list of openpgp packets.
+Take care when iterating over it - the packets themselves
+are stored as numerical indices.
+
+
Requires
+ +-
+
AnA
- An array of bytes containing valid openpgp packets.
+ A binary string of bytes containing valid openpgp packets.
@@ -1046,7 +1061,7 @@ class instance.
diff --git a/doc/packetlist.js.html b/doc/packetlist.js.html index 26129b97..dfdeb987 100644 --- a/doc/packetlist.js.html +++ b/doc/packetlist.js.html @@ -25,19 +25,24 @@
/** @module packet/packetlist */
+ /**
+ * This class represents a list of openpgp packets.
+ * Take care when iterating over it - the packets themselves
+ * are stored as numerical indices.
+ * @requires enums
+ * @requires packet
+ * @requires packet/packet
+ * @module packet/packetlist
+ */
var packetParser = require('./packet.js'),
packets = require('./all_packets.js'),
enums = require('../enums.js');
/**
- * @class
- * @classdesc This class represents a list of openpgp packets.
- * Take care when iterating over it - the packets themselves
- * are stored as numerical indices.
+ * @constructor
*/
-module.exports = function packetlist() {
+module.exports = packetlist = function () {
/** The number of packets contained within the list.
* @readonly
* @type {Integer} */
@@ -45,7 +50,7 @@ module.exports = function packetlist() {
/**
* Reads a stream of binary data and interprents it as a list of packets.
- * @param {openpgp_byte_array} An array of bytes.
+ * @param {String} A binary string of bytes.
*/
this.read = function(bytes) {
var i = 0;
@@ -66,7 +71,7 @@ module.exports = function packetlist() {
/**
* Creates a binary representation of openpgp objects contained within the
* class instance.
- * @returns {openpgp_byte_array} An array of bytes containing valid openpgp packets.
+ * @returns {String} A binary string of bytes containing valid openpgp packets.
*/
this.write = function() {
var bytes = '';
@@ -207,13 +212,13 @@ module.exports = function packetlist() {
diff --git a/doc/pkcs1.html b/doc/pkcs1.html
index e91f2011..a4887724 100644
--- a/doc/pkcs1.html
+++ b/doc/pkcs1.html
@@ -38,6 +38,8 @@
+ PKCS1 encoding
+
@@ -83,6 +85,20 @@
+ Requires
+
+
+
+
@@ -130,7 +146,7 @@
diff --git a/doc/pkcs1.js.html b/doc/pkcs1.js.html
index ab2e75db..0cd1a255 100644
--- a/doc/pkcs1.js.html
+++ b/doc/pkcs1.js.html
@@ -42,7 +42,15 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-/** @module crypto/pkcs1 */
+/**
+ * PKCS1 encoding
+ * @requires crypto/crypto
+ * @requires crypto/hash
+ * @requires crypto/public_key/jsbn
+ * @requires crypto/random
+ * @requires util
+ * @module crypto/pkcs1
+ */
/**
* ASN1 object identifiers for hashes (See RFC4880 5.2.2)
@@ -51,8 +59,8 @@ hash_headers = new Array();
hash_headers[1] = [0x30, 0x20, 0x30, 0x0c, 0x06, 0x08, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x02, 0x05, 0x05, 0x00, 0x04,
0x10
];
-hash_headers[3] = [0x30, 0x21, 0x30, 0x09, 0x06, 0x05, 0x2B, 0x24, 0x03, 0x02, 0x01, 0x05, 0x00, 0x04, 0x14];
hash_headers[2] = [0x30, 0x21, 0x30, 0x09, 0x06, 0x05, 0x2b, 0x0e, 0x03, 0x02, 0x1a, 0x05, 0x00, 0x04, 0x14];
+hash_headers[3] = [0x30, 0x21, 0x30, 0x09, 0x06, 0x05, 0x2B, 0x24, 0x03, 0x02, 0x01, 0x05, 0x00, 0x04, 0x14];
hash_headers[8] = [0x30, 0x31, 0x30, 0x0d, 0x06, 0x09, 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, 0x05, 0x00,
0x04, 0x20
];
@@ -66,7 +74,6 @@ hash_headers[11] = [0x30, 0x31, 0x30, 0x0d, 0x06, 0x09, 0x60, 0x86, 0x48, 0x01,
0x00, 0x04, 0x1C
];
-
var crypto = require('./crypto.js'),
random = require('./random.js'),
util = require('../util'),
@@ -106,10 +113,10 @@ module.exports = {
if (message.length < 12 || message.charCodeAt(0) != 0 || message.charCodeAt(1) != 2)
return -1;
var i = 2;
- while (message.charCodeAt(i) != 0 && message.length > i)
+ while (message.charCodeAt(i) != 0 && message.length > i)
i++;
return message.substring(i + 1, message.length);
- },
+ }
},
emsa: {
@@ -153,7 +160,7 @@ module.exports = {
while (data.charCodeAt(i) == 0xFF) i++;
if (data.charCodeAt(i++) != 0) return -1;
var j = 0;
- for (j = 0; j < hash_headers[algo].length && j + i < data.length; j++) {
+ for (j = 0; j < hash_headers[algo].length && j + i < data.length; j++) {
if (data.charCodeAt(j + i) != hash_headers[algo][j]) return -1;
}
i += j;
@@ -172,13 +179,13 @@ module.exports = {
diff --git a/doc/public_key.html b/doc/public_key.html
index 10f2b122..8da964dd 100644
--- a/doc/public_key.html
+++ b/doc/public_key.html
@@ -2,7 +2,7 @@
- JSDoc: Module: packet/public_key
+ JSDoc: Module: crypto/public_key
@@ -17,7 +17,7 @@
- Module: packet/public_key
+ Module: crypto/public_key
@@ -27,7 +27,7 @@
- packet/public_key
+ crypto/public_key
@@ -35,71 +35,6 @@
-
-Requires
+
+
+
+
@@ -159,28 +104,14 @@
diff --git a/doc/public_key.js.html b/doc/public_key.js.html
index f9952bcd..211bb6f0 100644
--- a/doc/public_key.js.html
+++ b/doc/public_key.js.html
@@ -42,7 +42,20 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-/** @module packet/public_key */
+/**
+ * Implementation of the Key Material Packet (Tag 5,6,7,14)<br/>
+ * <br/>
+ * 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.
+ * @requires crypto
+ * @requires enums
+ * @requires type/keyid
+ * @requires type/mpi
+ * @requires util
+ * @module packet/public_key
+ */
var util = require('../util'),
type_mpi = require('../type/mpi.js'),
@@ -51,15 +64,9 @@ var util = require('../util'),
crypto = require('../crypto');
/**
- * @class
- * @classdesc Implementation of the Key Material Packet (Tag 5,6,7,14)
- *
- * RFC4480 5.5:
- * A key material packet contains all the information about a public or
- * private key. There are four variants of this packet type, and two
- * major versions. Consequently, this section is complex.
+ * @constructor
*/
-module.exports = function packet_public_key() {
+module.exports = function () {
this.version = 4;
/** Key creation date.
* @type {Date} */
@@ -68,7 +75,7 @@ module.exports = function packet_public_key() {
* @type {module:type/mpi} */
this.mpi = [];
/** Public key algorithm
- * @type {openpgp.publickey} */
+ * @type {module:enums.publicKey} */
this.algorithm = 'rsa_sign';
// time in days (V3 only)
this.expirationTimeV3 = 0;
@@ -77,13 +84,11 @@ module.exports = function packet_public_key() {
/**
* Internal Parser for public keys as specified in RFC 4880 section
* 5.5.2 Public-Key Packet Formats
- * called by read_tag<num>
+ * called by read_tag<num>
* @param {String} input Input string to read the packet from
- * @param {Integer} position Start position for the parser
- * @param {Integer} len Length of the packet or remaining length of input
* @return {Object} This object with attributes set by the parser
*/
- this.readPublicKey = this.read = function(bytes) {
+ this.read = function(bytes) {
var pos = 0;
// A one-octet version number (3 or 4).
this.version = bytes.charCodeAt(pos++);
@@ -109,7 +114,7 @@ module.exports = function packet_public_key() {
var bmpi = bytes.substr(pos);
var p = 0;
- for (var i = 0; i < mpicount && p < bmpi.length; i++) {
+ for (var i = 0; i < mpicount && p < bmpi.length; i++) {
this.mpi[i] = new type_mpi();
@@ -124,19 +129,22 @@ module.exports = function packet_public_key() {
} else {
throw new Error('Version ' + version + ' of the key packet is unsupported.');
}
- }
+ };
- /*
+ /**
+ * Alias of read()
+ * @function module:packet/public_key#readPublicKey
+ * @see module:packet/public_key#read
+ */
+ this.readPublicKey = this.read;
+
+ /**
* Same as write_private_key, but has less information because of
* public key.
- * @param {Integer} keyType Follows the OpenPGP algorithm standard,
- * IE 1 corresponds to RSA.
- * @param {RSA.keyObject} key
- * @param timePacket
- * @return {Object} {body: [string]OpenPGP packet body contents,
+ * @return {Object} {body: [string]OpenPGP packet body contents,
* header: [string] OpenPGP packet header, string: [string] header+body}
*/
- this.writePublicKey = this.write = function() {
+ this.write = function() {
// Version
var result = String.fromCharCode(this.version);
result += util.writeDate(this.created);
@@ -152,16 +160,25 @@ module.exports = function packet_public_key() {
}
return result;
- }
+ };
- // Write an old version packet - it's used by some of the internal routines.
+ /**
+ * Alias of write()
+ * @function module:packet/public_key#writePublicKey
+ * @see module:packet/public_key#write
+ */
+ this.writePublicKey = this.write;
+
+ /**
+ * Write an old version packet - it's used by some of the internal routines.
+ */
this.writeOld = function() {
var bytes = this.writePublicKey();
return String.fromCharCode(0x99) +
util.writeNumber(bytes.length, 2) +
bytes;
- }
+ };
/**
* Calculates the key id of the key
@@ -175,7 +192,7 @@ module.exports = function packet_public_key() {
keyid.read(this.mpi[0].write().substr(-8));
}
return keyid;
- }
+ };
/**
* Calculates the fingerprint of the key
@@ -193,9 +210,8 @@ module.exports = function packet_public_key() {
}
return crypto.hash.md5(toHash)
}
- }
-
-}
+ };
+};
@@ -206,13 +222,13 @@ module.exports = function packet_public_key() {
diff --git a/doc/public_key_.html b/doc/public_key_.html
new file mode 100644
index 00000000..9ed3fe29
--- /dev/null
+++ b/doc/public_key_.html
@@ -0,0 +1,1044 @@
+
+
+
+
+ JSDoc: Module: packet/public_key
+
+
+
+
+
+
+
+
+
+
+
+
+ Module: packet/public_key
+
+
+
+
+
+
+
+
+
+ packet/public_key
+
+
+
+
+
+
+
+
+ Implementation of the Key Material Packet (Tag 5,6,7,14)
+
+RFC4480 5.5:
+A key material packet contains all the information about a public or
+private key. There are four variants of this packet type, and two
+major versions. Consequently, this section is complex.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Requires
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/public_key_encrypted_session_key.html b/doc/public_key_encrypted_session_key.html
index bed1f62c..229d0198 100644
--- a/doc/public_key_encrypted_session_key.html
+++ b/doc/public_key_encrypted_session_key.html
@@ -36,8 +36,23 @@
+ Public-Key Encrypted Session Key Packets (Tag 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
+message is encrypted with the session key, and the session key is itself
+encrypted and stored in the Encrypted Session Key packet(s). The
+Symmetrically Encrypted Data Packet is preceded by one Public-Key Encrypted
+Session Key packet for each OpenPGP key to which the message is encrypted.
+The recipient of the message finds a session key that is encrypted to their
+public key, decrypts the session key, and then uses the session key to
+decrypt the message.
+
+
Requires
+
+
+
+
@@ -201,7 +230,7 @@
diff --git a/doc/public_key_encrypted_session_key.js.html b/doc/public_key_encrypted_session_key.js.html
index f5d2b39a..90667288 100644
--- a/doc/public_key_encrypted_session_key.js.html
+++ b/doc/public_key_encrypted_session_key.js.html
@@ -42,19 +42,9 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-/** @module packet/public_key_encrypted_session_key */
-
-var type_keyid = require('../type/keyid.js'),
- util = require('../util'),
- type_mpi = require('../type/mpi.js'),
- enums = require('../enums.js'),
- crypto = require('../crypto');
-
-
/**
- * @class
- * @classdesc Public-Key Encrypted Session Key Packets (Tag 1)
- *
+ * Public-Key Encrypted Session Key Packets (Tag 1)<br/>
+ * <br/>
* 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
@@ -66,8 +56,24 @@ var type_keyid = require('../type/keyid.js'),
* The recipient of the message finds a session key that is encrypted to their
* public key, decrypts the session key, and then uses the session key to
* decrypt the message.
+ * @requires crypto
+ * @requires enums
+ * @requires type/keyid
+ * @requires type/mpi
+ * @requires util
+ * @module packet/public_key_encrypted_session_key
*/
-module.exports = function packet_public_key_encrypted_session_key() {
+
+var type_keyid = require('../type/keyid.js'),
+ util = require('../util'),
+ type_mpi = require('../type/mpi.js'),
+ enums = require('../enums.js'),
+ crypto = require('../crypto');
+
+/**
+ * @constructor
+ */
+module.exports = function () {
this.version = 3;
this.publicKeyId = new type_keyid();
@@ -117,7 +123,7 @@ module.exports = function packet_public_key_encrypted_session_key() {
i += mpi.read(bytes.substr(i));
this.encrypted.push(mpi);
}
- }
+ };
/**
* Create a string representation of a tag 1 packet
@@ -149,7 +155,7 @@ module.exports = function packet_public_key_encrypted_session_key() {
}
return result;
- }
+ };
this.encrypt = function(key) {
var data = String.fromCharCode(
@@ -168,7 +174,7 @@ module.exports = function packet_public_key_encrypted_session_key() {
this.publicKeyAlgorithm,
key.mpi,
mpi);
- }
+ };
/**
* Decrypts the session key (only for public key encrypted session key
@@ -199,7 +205,7 @@ module.exports = function packet_public_key_encrypted_session_key() {
this.sessionKeyAlgorithm =
enums.read(enums.symmetric, decoded.charCodeAt(0));
}
- }
+ };
};
diff --git a/doc/public_subkey.html b/doc/public_subkey.html index 2e8a55ce..b9d550d3 100644 --- a/doc/public_subkey.html +++ b/doc/public_subkey.html @@ -35,6 +35,72 @@
+
+
+
Requires
+ + @@ -90,6 +161,894 @@ +Members
+ +-
+
+
Methods
+ +-
+
+
diff --git a/doc/public_subkey.js.html b/doc/public_subkey.js.html index 2efe8642..8db82c72 100644 --- a/doc/public_subkey.js.html +++ b/doc/public_subkey.js.html @@ -42,12 +42,19 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/public_subkey */ +/** + * @requires packet/public_key + * @module packet/public_subkey + */ -var public_key = require('./public_key.js'); +var publicKey = require('./public_key.js'); -module.exports = function public_subkey() { - public_key.call(this); +/** + * @constructor + * @extends module:packet/public_key + */ +module.exports = function () { + publicKey.call(this); }
diff --git a/doc/random.html b/doc/random.html index 038d06ad..5a84681c 100644 --- a/doc/random.html +++ b/doc/random.html @@ -83,6 +83,12 @@ +
Requires
+ +-
+
diff --git a/doc/random.js.html b/doc/random.js.html index e3e31f86..15e0af07 100644 --- a/doc/random.js.html +++ b/doc/random.js.html @@ -44,7 +44,10 @@ // The GPG4Browsers crypto interface -/** @module crypto/random */ +/** + * @requires type/mpi + * @module crypto/random + */ var type_mpi = require('../type/mpi.js'); @@ -82,15 +85,15 @@ module.exports = { var buf = new Uint32Array(1); window.crypto.getRandomValues(buf); var bits = ((to - from)).toString(2).length; - while ((buf[0] & (Math.pow(2, bits) - 1)) > (to - from)) + while ((buf[0] & (Math.pow(2, bits) - 1)) > (to - from)) window.crypto.getRandomValues(buf); - return from + (Math.abs(buf[0] & (Math.pow(2, bits) - 1))); + return from + (Math.abs(buf[0] & (Math.pow(2, bits) - 1))); }, getSecureRandomOctet: function() { var buf = new Uint32Array(1); window.crypto.getRandomValues(buf); - return buf[0] & 0xFF; + return buf[0] & 0xFF; }, /** @@ -108,7 +111,7 @@ module.exports = { if (bits % 8 > 0) { randomBits = String.fromCharCode( - (Math.pow(2, bits % 8) - 1) & + (Math.pow(2, bits % 8) - 1) & randomBits.charCodeAt(0)) + randomBits.substring(1); } @@ -141,13 +144,13 @@ module.exports = {
diff --git a/doc/ripe-md.html b/doc/ripe-md.html index b6c469d4..bab1c333 100644 --- a/doc/ripe-md.html +++ b/doc/ripe-md.html @@ -62,7 +62,7 @@
diff --git a/doc/ripe-md.js.html b/doc/ripe-md.js.html index ed6ff528..c055997d 100644 --- a/doc/ripe-md.js.html +++ b/doc/ripe-md.js.html @@ -47,7 +47,9 @@ /* Modified by Recurity Labs GmbH */ -/** @module crypto/hash/ripe-md */ +/** + * @module crypto/hash/ripe-md + */ var RMDsize = 160; var X = new Array(); @@ -61,7 +63,7 @@ function F(x, y, z) { } function G(x, y, z) { - return new Number((x & y) | (~x & z)); + return new Number((x & y) | (~x & z)); } function H(x, y, z) { @@ -69,7 +71,7 @@ function H(x, y, z) { } function I(x, y, z) { - return new Number((x & z) | (y & ~z)); + return new Number((x & z) | (y & ~z)); } function J(x, y, z) { @@ -117,11 +119,11 @@ function mixOneRound(a, b, c, d, e, x, s, roundNumber) { a = ROL(a, s) + e; c = ROL(c, 10); - a &= 0xffffffff; - b &= 0xffffffff; - c &= 0xffffffff; - d &= 0xffffffff; - e &= 0xffffffff; + a &= 0xffffffff; + b &= 0xffffffff; + c &= 0xffffffff; + d &= 0xffffffff; + e &= 0xffffffff; var retBlock = new Array(); retBlock[0] = a; @@ -245,13 +247,13 @@ function MDfinish(MDbuf, strptr, lswlen, mswlen) { zeroX(X); var j = 0; - for (var i = 0; i < (lswlen & 63); i++) { - X[i >>> 2] ^= (strptr.charCodeAt(j++) & 255) << (8 * (i & 3)); + for (var i = 0; i < (lswlen & 63); i++) { + X[i >>> 2] ^= (strptr.charCodeAt(j++) & 255) << (8 * (i & 3)); } - X[(lswlen >>> 2) & 15] ^= 1 << (8 * (lswlen & 3) + 7); + X[(lswlen >>> 2) & 15] ^= 1 << (8 * (lswlen & 3) + 7); - if ((lswlen & 63) > 55) { + if ((lswlen & 63) > 55) { compress(MDbuf, X); var X = new Array(16); zeroX(X); @@ -264,10 +266,10 @@ function MDfinish(MDbuf, strptr, lswlen, mswlen) { } function BYTES_TO_DWORD(fourChars) { - var tmp = (fourChars.charCodeAt(3) & 255) << 24; - tmp |= (fourChars.charCodeAt(2) & 255) << 16; - tmp |= (fourChars.charCodeAt(1) & 255) << 8; - tmp |= (fourChars.charCodeAt(0) & 255); + var tmp = (fourChars.charCodeAt(3) & 255) << 24; + tmp |= (fourChars.charCodeAt(2) & 255) << 16; + tmp |= (fourChars.charCodeAt(1) & 255) << 8; + tmp |= (fourChars.charCodeAt(0) & 255); return tmp; } @@ -296,10 +298,10 @@ function RMD(message) { MDfinish(MDbuf, message.substr(j), length, 0); for (var i = 0; i < RMDsize / 8; i += 4) { - hashcode[i] = MDbuf[i >>> 2] & 255; - hashcode[i + 1] = (MDbuf[i >>> 2] >>> 8) & 255; - hashcode[i + 2] = (MDbuf[i >>> 2] >>> 16) & 255; - hashcode[i + 3] = (MDbuf[i >>> 2] >>> 24) & 255; + hashcode[i] = MDbuf[i >>> 2] & 255; + hashcode[i + 1] = (MDbuf[i >>> 2] >>> 8) & 255; + hashcode[i + 2] = (MDbuf[i >>> 2] >>> 16) & 255; + hashcode[i + 3] = (MDbuf[i >>> 2] >>> 24) & 255; } return hashcode; @@ -328,13 +330,13 @@ module.exports = RMDstring;
diff --git a/doc/rsa.html b/doc/rsa.html index bf4bec6c..eab856db 100644 --- a/doc/rsa.html +++ b/doc/rsa.html @@ -83,6 +83,16 @@ +
Requires
+ + + @@ -105,13 +115,13 @@diff --git a/doc/rsa.js.html b/doc/rsa.js.html index 160db3dc..f938e5e0 100644 --- a/doc/rsa.js.html +++ b/doc/rsa.js.html @@ -44,7 +44,12 @@ // // RSA implementation -/** @module crypto/public_key/rsa */ +/** + * @requires crypto/public_key/jsbn + * @requires crypto/random + * @requires util + * @module crypto/public_key/rsa + */ var BigInteger = require('./jsbn.js'), util = require('../../util'), @@ -135,12 +140,12 @@ function RSA() { for (;;) { for (;;) { key.p = new BigInteger(B - qs, 1, rng); - if (key.p.subtract(BigInteger.ONE).gcd(key.ee).compareTo(BigInteger.ONE) == 0 && key.p.isProbablePrime(10)) + if (key.p.subtract(BigInteger.ONE).gcd(key.ee).compareTo(BigInteger.ONE) == 0 && key.p.isProbablePrime(10)) break; } for (;;) { key.q = new BigInteger(qs, 1, rng); - if (key.q.subtract(BigInteger.ONE).gcd(key.ee).compareTo(BigInteger.ONE) == 0 && key.q.isProbablePrime(10)) + if (key.q.subtract(BigInteger.ONE).gcd(key.ee).compareTo(BigInteger.ONE) == 0 && key.q.isProbablePrime(10)) break; } if (key.p.compareTo(key.q) <= 0) { @@ -182,13 +187,13 @@ module.exports = RSA;
diff --git a/doc/s2k.html b/doc/s2k.html index 8f660876..75526b45 100644 --- a/doc/s2k.html +++ b/doc/s2k.html @@ -36,8 +36,17 @@
+
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 +places, currently: to encrypt the secret part of private keys in the +private keyring, and to convert passphrases to encryption keys for +symmetrically encrypted messages.
+
+
+
+String-to-key (S2K) specifiers are used to convert passphrase strings +into symmetric-key encryption/decryption keys. They are used in two +places, currently: to encrypt the secret part of private keys in the +private keyring, and to convert passphrases to encryption keys for +symmetrically encrypted messages.
Requires
+ +-
+
diff --git a/doc/s2k.js.html b/doc/s2k.js.html index b5cffd65..045b5c00 100644 --- a/doc/s2k.js.html +++ b/doc/s2k.js.html @@ -42,39 +42,45 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module type/s2k */ +/** + * Implementation of the String-to-key specifier (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 + * places, currently: to encrypt the secret part of private keys in the + * private keyring, and to convert passphrases to encryption keys for + * symmetrically encrypted messages. + * @requires crypto + * @requires enums + * @requires util + * @module type/s2k + */ var enums = require('../enums.js'), util = require('../util'), crypto = require('../crypto'); /** - * @class - * @classdesc 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 - places, currently: to encrypt the secret part of private keys in the - private keyring, and to convert passphrases to encryption keys for - symmetrically encrypted messages. + * @constructor */ module.exports = function s2k() { - /** @type {openpgp.hash} */ + /** @type {module:enums.hash} */ this.algorithm = 'sha256'; - /** @type {module:type/s2k} */ + /** @type {module:enums.s2k} */ this.type = 'iterated'; this.c = 96; - /** Eight bytes of salt. - * @type {openpgp_byte_array} + /** Eight bytes of salt in a binary string. + * @type {String} */ this.salt = crypto.random.getRandomBytes(8); - // Exponen bias, defined in RFC4880 + // Exponent bias, defined in RFC4880 var expbias = 6; this.get_count = function() { - return (16 + (this.c & 15)) << ((this.c >> 4) + expbias); - } + return (16 + (this.c & 15)) << ((this.c >> 4) + expbias); + }; /** * Parsing function for a string-to-key specifier (RFC 4880 3.7). @@ -124,7 +130,7 @@ module.exports = function s2k() { } return i; - } + }; /** @@ -145,10 +151,10 @@ module.exports = function s2k() { bytes += this.salt; bytes += String.fromCharCode(this.c); break; - }; + } return bytes; - } + }; /** * Produces a key using the specified passphrase and the defined @@ -185,7 +191,7 @@ module.exports = function s2k() { isp = isp.substr(0, count); return crypto.hash.digest(algorithm, prefix + isp); - }; + } } var result = '', @@ -197,8 +203,8 @@ module.exports = function s2k() { } return result.substr(0, numBytes); - } -} + }; +};
diff --git a/doc/scripts/linenumber.js b/doc/scripts/linenumber.js index 613865d0..a0c570d5 100644 --- a/doc/scripts/linenumber.js +++ b/doc/scripts/linenumber.js @@ -9,7 +9,7 @@ numbered = source.innerHTML.split('\n'); numbered = numbered.map(function(item) { counter++; - return '' + item; + return '' + item; }); source.innerHTML = numbered.join('\n'); diff --git a/doc/secret_key.html b/doc/secret_key.html index 3bc9a900..da6797f8 100644 --- a/doc/secret_key.html +++ b/doc/secret_key.html @@ -36,8 +36,16 @@
+
Implementation of the Key Material Packet (Tag 5,6,7,14)
+
+RFC4480 5.5: +A key material packet contains all the information about a public or +private key. There are four variants of this packet type, and two +major versions. Consequently, this section is complex.
+
+
+
+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.
Requires
+ +-
+
diff --git a/doc/secret_key.js.html b/doc/secret_key.js.html index ba482499..32337674 100644 --- a/doc/secret_key.js.html +++ b/doc/secret_key.js.html @@ -42,7 +42,21 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/secret_key */ +/** + * Implementation of the Key Material Packet (Tag 5,6,7,14)<br/> + * <br/> + * 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. + * @requires crypto + * @requires enums + * @requires packet/public_key + * @requires type/mpi + * @requires type/s2k + * @requires util + * @module packet/secret_key + */ var publicKey = require('./public_key.js'), enums = require('../enums.js'), @@ -52,14 +66,8 @@ var publicKey = require('./public_key.js'), type_s2k = require('../type/s2k.js'); /** - * @class - * @classdesc Implementation of the Key Material Packet (Tag 5,6,7,14) + * @constructor * @extends module:packet/public_key - * - * RFC4480 5.5: - * A key material packet contains all the information about a public or - * private key. There are four variants of this packet type, and two - * major versions. Consequently, this section is complex. */ module.exports = function () { publicKey.call(this); @@ -104,7 +112,7 @@ module.exports = function () { var j = 0; var mpi = []; - for (var i = 0; i < mpis && j < cleartext.length; i++) { + for (var i = 0; i < mpis && j < cleartext.length; i++) { mpi[i] = new type_mpi(); j += mpi[i].read(cleartext.substr(j)); } @@ -212,9 +220,8 @@ module.exports = function () { /** * Decrypts the private key MPIs which are needed to use the key. - * openpgp_packet_keymaterial.hasUnencryptedSecretKeyData should be - * false otherwise - * a call to this function is not needed + * @link module:packet/secret_key.isDecrypted should be + * false otherwise a call to this function is not needed * * @param {String} str_passphrase The passphrase for this private key * as string @@ -294,13 +301,13 @@ module.exports.prototype = new publicKey();
diff --git a/doc/secret_subkey.html b/doc/secret_subkey.html index 1d3abde5..d4ca274e 100644 --- a/doc/secret_subkey.html +++ b/doc/secret_subkey.html @@ -35,6 +35,72 @@
+
+
+
Requires
+ + @@ -90,6 +161,1068 @@ +Members
+ +-
+
+
Methods
+ +-
+
+
diff --git a/doc/secret_subkey.js.html b/doc/secret_subkey.js.html index 25b1b216..a29289cc 100644 --- a/doc/secret_subkey.js.html +++ b/doc/secret_subkey.js.html @@ -42,12 +42,19 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/secret_subkey */ +/** + * @requires packet/secret_key + * @module packet/secret_subkey + */ -var secret_key = require('./secret_key.js'); +var secretKey = require('./secret_key.js'); -module.exports = function secret_subkey() { - secret_key.call(this); +/** + * @constructor + * @extends module:packet/secret_key + */ +module.exports = function () { + secretKey.call(this); }
diff --git a/doc/sha.html b/doc/sha.html index 5c33e529..3d73616c 100644 --- a/doc/sha.html +++ b/doc/sha.html @@ -62,7 +62,7 @@
Methods
+ +-
+
+
diff --git a/doc/sha.js.html b/doc/sha.js.html index 2674980e..2f563c4d 100644 --- a/doc/sha.js.html +++ b/doc/sha.js.html @@ -48,7 +48,9 @@ * - str_sha512 */ -/** @module crypto/hash/sha */ +/** + * @module crypto/hash/sha + */ var jsSHA = (function() { @@ -89,7 +91,7 @@ var jsSHA = (function() { i; for (i = 0; i < length; i += charSize) { - bin[i >> 5] |= (str.charCodeAt(i / charSize) & mask) << + bin[i >> 5] |= (str.charCodeAt(i / charSize) & mask) << (32 - charSize - (i % 32)); } @@ -135,8 +137,8 @@ var jsSHA = (function() { for (i = 0; i < length; i += 1) { srcByte = binarray[i >> 2] >> ((3 - (i % 4)) * 8); - str += hex_tab.charAt((srcByte >> 4) & 0xF) + - hex_tab.charAt(srcByte & 0xF); + str += hex_tab.charAt((srcByte >> 4) & 0xF) + + hex_tab.charAt(srcByte & 0xF); } return str; @@ -159,12 +161,12 @@ var jsSHA = (function() { triplet; for (i = 0; i < length; i += 3) { - triplet = (((binarray[i >> 2] >> 8 * (3 - i % 4)) & 0xFF) << 16) | - (((binarray[i + 1 >> 2] >> 8 * (3 - (i + 1) % 4)) & 0xFF) << 8) | - ((binarray[i + 2 >> 2] >> 8 * (3 - (i + 2) % 4)) & 0xFF); + triplet = (((binarray[i >> 2] >> 8 * (3 - i % 4)) & 0xFF) << 16) | + (((binarray[i + 1 >> 2] >> 8 * (3 - (i + 1) % 4)) & 0xFF) << 8) | + ((binarray[i + 2 >> 2] >> 8 * (3 - (i + 2) % 4)) & 0xFF); for (j = 0; j < 4; j += 1) { if (i * 8 + j * 6 <= binarray.length * 32) { - str += tab.charAt((triplet >> 6 * (3 - j)) & 0x3F); + str += tab.charAt((triplet >> 6 * (3 - j)) & 0x3F); } else { str += b64pad; } @@ -180,7 +182,7 @@ var jsSHA = (function() { var str = ""; var mask = (1 << 8) - 1; for (var i = 0; i < bin.length * 32; i += 8) - str += String.fromCharCode((bin[i >> 5] >>> (24 - i % 32)) & mask); + str += String.fromCharCode((bin[i >> 5] >>> (24 - i % 32)) & mask); return str; }, /* @@ -280,7 +282,7 @@ var jsSHA = (function() { * @return The NIST specified output of the function */ ch_32 = function(x, y, z) { - return (x & y) ^ (~x & z); + return (x & y) ^ (~x & z); }, /* @@ -294,7 +296,7 @@ var jsSHA = (function() { */ ch_64 = function(x, y, z) { return new Int_64( - (x.highOrder & y.highOrder) ^ (~x.highOrder & z.highOrder), (x.lowOrder & y.lowOrder) ^ (~x.lowOrder & z.lowOrder)); + (x.highOrder & y.highOrder) ^ (~x.highOrder & z.highOrder), (x.lowOrder & y.lowOrder) ^ (~x.lowOrder & z.lowOrder)); }, /* @@ -307,7 +309,7 @@ var jsSHA = (function() { * @return The NIST specified output of the function */ maj_32 = function(x, y, z) { - return (x & y) ^ (x & z) ^ (y & z); + return (x & y) ^ (x & z) ^ (y & z); }, /* @@ -321,11 +323,11 @@ var jsSHA = (function() { */ maj_64 = function(x, y, z) { return new Int_64( - (x.highOrder & y.highOrder) ^ - (x.highOrder & z.highOrder) ^ - (y.highOrder & z.highOrder), (x.lowOrder & y.lowOrder) ^ - (x.lowOrder & z.lowOrder) ^ - (y.lowOrder & z.lowOrder)); + (x.highOrder & y.highOrder) ^ + (x.highOrder & z.highOrder) ^ + (y.highOrder & z.highOrder), (x.lowOrder & y.lowOrder) ^ + (x.lowOrder & z.lowOrder) ^ + (y.lowOrder & z.lowOrder)); }, /* @@ -450,10 +452,10 @@ var jsSHA = (function() { * @return The sum of x + y */ safeAdd_32_2 = function(x, y) { - var lsw = (x & 0xFFFF) + (y & 0xFFFF), + var lsw = (x & 0xFFFF) + (y & 0xFFFF), msw = (x >>> 16) + (y >>> 16) + (lsw >>> 16); - return ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + return ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); }, /* @@ -468,11 +470,11 @@ var jsSHA = (function() { * @return The sum of a + b + c + d */ safeAdd_32_4 = function(a, b, c, d) { - var lsw = (a & 0xFFFF) + (b & 0xFFFF) + (c & 0xFFFF) + (d & 0xFFFF), + var lsw = (a & 0xFFFF) + (b & 0xFFFF) + (c & 0xFFFF) + (d & 0xFFFF), msw = (a >>> 16) + (b >>> 16) + (c >>> 16) + (d >>> 16) + (lsw >>> 16); - return ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + return ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); }, /* @@ -488,12 +490,12 @@ var jsSHA = (function() { * @return The sum of a + b + c + d + e */ safeAdd_32_5 = function(a, b, c, d, e) { - var lsw = (a & 0xFFFF) + (b & 0xFFFF) + (c & 0xFFFF) + (d & 0xFFFF) + - (e & 0xFFFF), + var lsw = (a & 0xFFFF) + (b & 0xFFFF) + (c & 0xFFFF) + (d & 0xFFFF) + + (e & 0xFFFF), msw = (a >>> 16) + (b >>> 16) + (c >>> 16) + (d >>> 16) + (e >>> 16) + (lsw >>> 16); - return ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + return ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); }, /* @@ -508,13 +510,13 @@ var jsSHA = (function() { safeAdd_64_2 = function(x, y) { var lsw, msw, lowOrder, highOrder; - lsw = (x.lowOrder & 0xFFFF) + (y.lowOrder & 0xFFFF); + lsw = (x.lowOrder & 0xFFFF) + (y.lowOrder & 0xFFFF); msw = (x.lowOrder >>> 16) + (y.lowOrder >>> 16) + (lsw >>> 16); - lowOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + lowOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); - lsw = (x.highOrder & 0xFFFF) + (y.highOrder & 0xFFFF) + (msw >>> 16); + lsw = (x.highOrder & 0xFFFF) + (y.highOrder & 0xFFFF) + (msw >>> 16); msw = (x.highOrder >>> 16) + (y.highOrder >>> 16) + (lsw >>> 16); - highOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + highOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); return new Int_64(highOrder, lowOrder); }, @@ -533,17 +535,17 @@ var jsSHA = (function() { safeAdd_64_4 = function(a, b, c, d) { var lsw, msw, lowOrder, highOrder; - lsw = (a.lowOrder & 0xFFFF) + (b.lowOrder & 0xFFFF) + - (c.lowOrder & 0xFFFF) + (d.lowOrder & 0xFFFF); + lsw = (a.lowOrder & 0xFFFF) + (b.lowOrder & 0xFFFF) + + (c.lowOrder & 0xFFFF) + (d.lowOrder & 0xFFFF); msw = (a.lowOrder >>> 16) + (b.lowOrder >>> 16) + (c.lowOrder >>> 16) + (d.lowOrder >>> 16) + (lsw >>> 16); - lowOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + lowOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); - lsw = (a.highOrder & 0xFFFF) + (b.highOrder & 0xFFFF) + - (c.highOrder & 0xFFFF) + (d.highOrder & 0xFFFF) + (msw >>> 16); + lsw = (a.highOrder & 0xFFFF) + (b.highOrder & 0xFFFF) + + (c.highOrder & 0xFFFF) + (d.highOrder & 0xFFFF) + (msw >>> 16); msw = (a.highOrder >>> 16) + (b.highOrder >>> 16) + (c.highOrder >>> 16) + (d.highOrder >>> 16) + (lsw >>> 16); - highOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + highOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); return new Int_64(highOrder, lowOrder); }, @@ -563,21 +565,21 @@ var jsSHA = (function() { safeAdd_64_5 = function(a, b, c, d, e) { var lsw, msw, lowOrder, highOrder; - lsw = (a.lowOrder & 0xFFFF) + (b.lowOrder & 0xFFFF) + - (c.lowOrder & 0xFFFF) + (d.lowOrder & 0xFFFF) + - (e.lowOrder & 0xFFFF); + lsw = (a.lowOrder & 0xFFFF) + (b.lowOrder & 0xFFFF) + + (c.lowOrder & 0xFFFF) + (d.lowOrder & 0xFFFF) + + (e.lowOrder & 0xFFFF); msw = (a.lowOrder >>> 16) + (b.lowOrder >>> 16) + (c.lowOrder >>> 16) + (d.lowOrder >>> 16) + (e.lowOrder >>> 16) + (lsw >>> 16); - lowOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + lowOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); - lsw = (a.highOrder & 0xFFFF) + (b.highOrder & 0xFFFF) + - (c.highOrder & 0xFFFF) + (d.highOrder & 0xFFFF) + - (e.highOrder & 0xFFFF) + (msw >>> 16); + lsw = (a.highOrder & 0xFFFF) + (b.highOrder & 0xFFFF) + + (c.highOrder & 0xFFFF) + (d.highOrder & 0xFFFF) + + (e.highOrder & 0xFFFF) + (msw >>> 16); msw = (a.highOrder >>> 16) + (b.highOrder >>> 16) + (c.highOrder >>> 16) + (d.highOrder >>> 16) + (e.highOrder >>> 16) + (lsw >>> 16); - highOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); + highOrder = ((msw & 0xFFFF) << 16) | (lsw & 0xFFFF); return new Int_64(highOrder, lowOrder); }, @@ -1082,12 +1084,12 @@ var jsSHA = (function() { /* For all variants, the block size is bigger than the output * size so there will never be a useful byte at the end of the * string */ - keyToUse[lastArrayIndex] &= 0xFFFFFF00; + keyToUse[lastArrayIndex] &= 0xFFFFFF00; } else if (blockByteSize > (keyBinLen / 8)) { /* If the blockByteSize is greater than the key length, there * will always be at LEAST one "useless" byte at the end of the * string */ - keyToUse[lastArrayIndex] &= 0xFFFFFF00; + keyToUse[lastArrayIndex] &= 0xFFFFFF00; } /* Create ipad and opad */ @@ -1121,23 +1123,28 @@ var jsSHA = (function() { }()); module.exports = { + /** SHA1 hash */ sha1: function(str) { var shaObj = new jsSHA(str, "ASCII"); return shaObj.getHash("SHA-1", "ASCII"); }, + /** SHA224 hash */ sha224: function(str) { var shaObj = new jsSHA(str, "ASCII"); return shaObj.getHash("SHA-224", "ASCII"); }, + /** SHA256 hash */ sha256: function(str) { var shaObj = new jsSHA(str, "ASCII"); return shaObj.getHash("SHA-256", "ASCII"); }, + /** SHA384 hash */ sha384: function(str) { var shaObj = new jsSHA(str, "ASCII"); return shaObj.getHash("SHA-384", "ASCII"); }, + /** SHA512 hash */ sha512: function(str) { var shaObj = new jsSHA(str, "ASCII"); return shaObj.getHash("SHA-512", "ASCII"); @@ -1153,13 +1160,13 @@ module.exports = {
diff --git a/doc/signature.html b/doc/signature.html index 3db5c64e..92d9df80 100644 --- a/doc/signature.html +++ b/doc/signature.html @@ -83,6 +83,16 @@ +
Requires
+ + + @@ -279,7 +289,7 @@ integers which is used to sign the datadiff --git a/doc/signature.js.html b/doc/signature.js.html index 28c1fe17..1feb2ec5 100644 --- a/doc/signature.js.html +++ b/doc/signature.js.html @@ -25,7 +25,11 @@
/** @module crypto/signature */
+ /**
+ * @requires crypto/hash
+ * @requires crypto/pkcs1
+ * @requires crypto/public_key
+ * @module crypto/signature */
var publicKey = require('./public_key'),
pkcs1 = require('./pkcs1.js'),
@@ -142,13 +146,13 @@ module.exports = {
diff --git a/doc/signature.js_.html b/doc/signature.js_.html
index 578ce06f..7649ed5d 100644
--- a/doc/signature.js_.html
+++ b/doc/signature.js_.html
@@ -42,7 +42,21 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-/** @module packet/signature */
+/**
+ * Implementation of the Signature Packet (Tag 2)<br/>
+ * <br/>
+ * 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.
+ * @requires crypto
+ * @requires enums
+ * @requires packet/packet
+ * @requires type/keyid
+ * @requires type/mpi
+ * @requires util
+ * @module packet/signature
+ */
var util = require('../util'),
packet = require('./packet.js'),
@@ -52,15 +66,9 @@ var util = require('../util'),
type_keyid = require('../type/keyid.js');
/**
- * @class
- * @classdesc Implementation of the Signature Packet (Tag 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.
+ * @constructor
*/
-module.exports = function packet_signature() {
+module.exports = packetSignature = function () {
this.version = 4;
this.signatureType = null;
@@ -121,7 +129,7 @@ module.exports = function packet_signature() {
case 3:
// One-octet length of following hashed material. MUST be 5.
if (bytes.charCodeAt(i++) != 5)
- util.print_debug("openpgp.packet.signature.js\n" +
+ util.print_debug("packet/signature.js\n" +
'invalid One-octet length of following hashed material.' +
'MUST be 5. @:' + (i - 1));
@@ -381,7 +389,7 @@ module.exports = function packet_signature() {
}
// The leftwost bit denotes a "critical" packet, but we ignore it.
- var type = bytes.charCodeAt(mypos++) & 0x7F;
+ var type = bytes.charCodeAt(mypos++) & 0x7F;
// subpacket type
switch (type) {
@@ -518,7 +526,7 @@ module.exports = function packet_signature() {
break;
case 32:
// Embedded Signature
- this.embeddedSignature = new packet_signature();
+ this.embeddedSignature = new packetSignature();
this.embeddedSignature.read(bytes.substr(mypos));
break;
default:
@@ -624,7 +632,7 @@ module.exports = function packet_signature() {
var mpicount = 0;
// Algorithm-Specific Fields for RSA signatures:
// - multiprecision number (MPI) of RSA signature value m**d mod n.
- if (publicKeyAlgorithm > 0 && publicKeyAlgorithm < 4)
+ if (publicKeyAlgorithm > 0 && publicKeyAlgorithm < 4)
mpicount = 1;
// Algorithm-Specific Fields for DSA signatures:
// - MPI of DSA value r.
@@ -667,13 +675,13 @@ module.exports = function packet_signature() {
diff --git a/doc/signature_.html b/doc/signature_.html
index 87ad7583..00466098 100644
--- a/doc/signature_.html
+++ b/doc/signature_.html
@@ -36,8 +36,16 @@
+ Implementation of the Signature Packet (Tag 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.
+
+
Requires
+
+
+
+
@@ -202,7 +226,7 @@
diff --git a/doc/styles/jsdoc-default.css b/doc/styles/jsdoc-default.css
index 7afd6850..ea49f607 100644
--- a/doc/styles/jsdoc-default.css
+++ b/doc/styles/jsdoc-default.css
@@ -195,14 +195,12 @@ h6
font-family: Consolas, "Lucida Console", Monaco, monospace;
}
-.details { margin-top: 14px; border-left: 2px solid #DDD; }
-.details dt { width:100px; float:left; padding-left: 10px; padding-top: 6px; }
+.details { margin-top: 14px; }
+.details dt { width:100px; float:left; border-left: 2px solid #DDD; padding-left: 10px; padding-top: 6px; }
.details dd { margin-left: 50px; }
.details ul { margin: 0; }
.details ul { list-style-type: none; }
.details li { margin-left: 30px; padding-top: 6px; }
-.details pre.prettyprint { margin: 0 }
-.details .object-value { padding-top: 0; }
.description {
margin-bottom: 1em;
@@ -242,11 +240,6 @@ h6
border-left: 3px #ddd solid;
}
-.prettyprint code span.line
-{
- display: inline-block;
-}
-
.params, .props
{
border-spacing: 0;
diff --git a/doc/sym_encrypted_integrity_protected.html b/doc/sym_encrypted_integrity_protected.html
index c3097a68..872cd42b 100644
--- a/doc/sym_encrypted_integrity_protected.html
+++ b/doc/sym_encrypted_integrity_protected.html
@@ -36,8 +36,18 @@
+ Implementation of the Sym. Encrypted Integrity Protected Data
+Packet (Tag 18)
+
+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
+packet.
+
+
Requires
+
+
+
+
@@ -195,7 +213,7 @@
diff --git a/doc/sym_encrypted_integrity_protected.js.html b/doc/sym_encrypted_integrity_protected.js.html
index dd342cff..aac06879 100644
--- a/doc/sym_encrypted_integrity_protected.js.html
+++ b/doc/sym_encrypted_integrity_protected.js.html
@@ -42,24 +42,27 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-/** @module packet/sym_encrypted_integrity_protected */
-
-var util = require('../util'),
- crypto = require('../crypto');
-
/**
- * @class
- * @classdesc Implementation of the Sym. Encrypted Integrity Protected Data
- * Packet (Tag 18)
- *
+ * Implementation of the Sym. Encrypted Integrity Protected Data
+ * Packet (Tag 18)<br/>
+ * <br/>
* 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
* packet.
+ * @requires crypto
+ * @requires util
+ * @module packet/sym_encrypted_integrity_protected
*/
-module.exports = function packet_sym_encrypted_integrity_protected() {
+var util = require('../util'),
+ crypto = require('../crypto');
+
+/**
+ * @constructor
+ */
+module.exports = function () {
/** The encrypted payload. */
this.encrypted = null; // string
/**
@@ -69,12 +72,11 @@ module.exports = function packet_sym_encrypted_integrity_protected() {
* @type {Boolean}
*/
this.modification = false;
- this.packets;
+ this.packets = null;
this.read = function(bytes) {
- // - A one-octet version number. The only currently defined value is
- // 1.
+ // - A one-octet version number. The only currently defined value is 1.
var version = bytes.charCodeAt(0);
if (version != 1) {
@@ -85,13 +87,13 @@ module.exports = function packet_sym_encrypted_integrity_protected() {
// operating in Cipher Feedback mode with shift amount equal to the
// block size of the cipher (CFB-n where n is the block size).
this.encrypted = bytes.substr(1);
- }
+ };
this.write = function() {
return String.fromCharCode(1) // Version
+ this.encrypted;
- }
+ };
this.encrypt = function(sessionKeyAlgorithm, key) {
var bytes = this.packets.write()
@@ -114,7 +116,7 @@ module.exports = function packet_sym_encrypted_integrity_protected() {
this.encrypted = crypto.cfb.encrypt(prefixrandom,
sessionKeyAlgorithm, tohash, key, false).substring(0,
prefix.length + tohash.length);
- }
+ };
/**
* Decrypts the encrypted data contained in this object read_packet must
@@ -142,7 +144,7 @@ module.exports = function packet_sym_encrypted_integrity_protected() {
throw new Error('Modification detected.');
} else
this.packets.read(decrypted.substr(0, decrypted.length - 22));
- }
+ };
};
diff --git a/doc/sym_encrypted_session_key.html b/doc/sym_encrypted_session_key.html index 1b594253..1174e921 100644 --- a/doc/sym_encrypted_session_key.html +++ b/doc/sym_encrypted_session_key.html @@ -36,8 +36,23 @@
+
Public-Key Encrypted Session Key Packets (Tag 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 +message is encrypted with the session key, and the session key is itself +encrypted and stored in the Encrypted Session Key packet(s). The +Symmetrically Encrypted Data Packet is preceded by one Public-Key Encrypted +Session Key packet for each OpenPGP key to which the message is encrypted. +The recipient of the message finds a session key that is encrypted to their +public key, decrypts the session key, and then uses the session key to +decrypt the message.
+
+
+
+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 +message is encrypted with the session key, and the session key is itself +encrypted and stored in the Encrypted Session Key packet(s). The +Symmetrically Encrypted Data Packet is preceded by one Public-Key Encrypted +Session Key packet for each OpenPGP key to which the message is encrypted. +The recipient of the message finds a session key that is encrypted to their +public key, decrypts the session key, and then uses the session key to +decrypt the message.
Requires
+ +-
+
diff --git a/doc/sym_encrypted_session_key.js.html b/doc/sym_encrypted_session_key.js.html index fa983e91..e862fe3c 100644 --- a/doc/sym_encrypted_session_key.js.html +++ b/doc/sym_encrypted_session_key.js.html @@ -42,16 +42,9 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/sym_encrypted_session_key */ - -var type_s2k = require('../type/s2k.js'), - enums = require('../enums.js'), - crypto = require('../crypto'); - /** - * @class - * @classdesc Public-Key Encrypted Session Key Packets (Tag 1) - * + * Public-Key Encrypted Session Key Packets (Tag 1)<br/> + * <br/> * 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 @@ -63,8 +56,20 @@ var type_s2k = require('../type/s2k.js'), * The recipient of the message finds a session key that is encrypted to their * public key, decrypts the session key, and then uses the session key to * decrypt the message. + * @requires crypto + * @requires enums + * @requires type/s2k + * @module packet/sym_encrypted_session_key */ -module.exports = function packet_sym_encrypted_session_key() { + +var type_s2k = require('../type/s2k.js'), + enums = require('../enums.js'), + crypto = require('../crypto'); + +/** + * @constructor + */ +module.exports = function () { this.tag = 3; this.sessionKeyEncryptionAlgorithm = null; this.sessionKeyAlgorithm = 'aes256'; @@ -100,7 +105,7 @@ module.exports = function packet_sym_encrypted_session_key() { this.sessionKeyEncryptionAlgorithm = algo } else this.sessionKeyAlgorithm = algo; - } + }; this.write = function() { var algo = this.encrypted == null ? @@ -114,7 +119,7 @@ module.exports = function packet_sym_encrypted_session_key() { if (this.encrypted != null) bytes += this.encrypted; return bytes; - } + }; /** * Decrypts the session key (only for public key encrypted session key @@ -143,7 +148,7 @@ module.exports = function packet_sym_encrypted_session_key() { this.sessionKey = decrypted.substr(1); } - } + }; this.encrypt = function(passphrase) { var length = crypto.getKeyLength(this.sessionKeyEncryptionAlgorithm); @@ -158,7 +163,7 @@ module.exports = function packet_sym_encrypted_session_key() { this.encrypted = crypto.cfb.encrypt( crypto.getPrefixRandom(this.sessionKeyEncryptionAlgorithm), this.sessionKeyEncryptionAlgorithm, key, private_key, true); - } + }; }; @@ -170,13 +175,13 @@ module.exports = function packet_sym_encrypted_session_key() {
diff --git a/doc/symmetrically_encrypted.html b/doc/symmetrically_encrypted.html index 1d0112a8..6dee336e 100644 --- a/doc/symmetrically_encrypted.html +++ b/doc/symmetrically_encrypted.html @@ -36,8 +36,17 @@
+
Implementation of the Symmetrically Encrypted Data Packet (Tag 9)
+
+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 +that form whole OpenPGP messages).
+
+
+
+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 +that form whole OpenPGP messages).
Requires
+ +-
+
Returns:
- - -
- The decrypted data;
-
-
-
-
-
@@ -393,13 +398,13 @@
diff --git a/doc/symmetrically_encrypted.js.html b/doc/symmetrically_encrypted.js.html index f99eccc1..61d75397 100644 --- a/doc/symmetrically_encrypted.js.html +++ b/doc/symmetrically_encrypted.js.html @@ -42,34 +42,36 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/symmetrically_encrypted */ - -var crypto = require('../crypto'); - /** - * @class - * @classdesc Implementation of the Symmetrically Encrypted Data Packet (Tag 9) - * + * Implementation of the Symmetrically Encrypted Data Packet (Tag 9)<br/> + * <br/> * 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 * that form whole OpenPGP messages). + * @requires crypto + * @module packet/symmetrically_encrypted */ -module.exports = function packet_symmetrically_encrypted() { +var crypto = require('../crypto'); + +/** + * @constructor + */ +module.exports = function () { this.encrypted = null; /** Decrypted packets contained within. * @type {module:packet/packetlist} */ - this.packets; + this.packets = null; this.read = function(bytes) { this.encrypted = bytes; - } + }; this.write = function() { return this.encrypted; - } + }; /** * Symmetrically decrypt the packet data @@ -79,21 +81,20 @@ module.exports = function packet_symmetrically_encrypted() { * @param {String} key * Key as string with the corresponding length to the * algorithm - * @return The decrypted data; */ this.decrypt = function(sessionKeyAlgorithm, key) { var decrypted = crypto.cfb.decrypt( sessionKeyAlgorithm, key, this.encrypted, true); this.packets.read(decrypted); - } + }; this.encrypt = function(algo, key) { var data = this.packets.write(); this.encrypted = crypto.cfb.encrypt( crypto.getPrefixRandom(algo), algo, data, key, true); - } + }; }; @@ -105,13 +106,13 @@ module.exports = function packet_symmetrically_encrypted() {
diff --git a/doc/trust.html b/doc/trust.html new file mode 100644 index 00000000..28644f1c --- /dev/null +++ b/doc/trust.html @@ -0,0 +1,186 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Module: packet/trust
+ + + + + ++ packet/trust +
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/doc/trust.js.html b/doc/trust.js.html new file mode 100644 index 00000000..e24da700 --- /dev/null +++ b/doc/trust.js.html @@ -0,0 +1,60 @@ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+Source: packet/trust.js
+ + + + + +/**
+ * @module packet/trust
+ */
+
+/**
+ * @constructor
+ */
+module.exports = function () {
+
+};
++ + + + + + + diff --git a/doc/twofish.html b/doc/twofish.html index cdb2f681..f6ac21a9 100644 --- a/doc/twofish.html +++ b/doc/twofish.html @@ -62,7 +62,7 @@
diff --git a/doc/twofish.js.html b/doc/twofish.js.html index d02a9bc7..4dc9ad8d 100644 --- a/doc/twofish.js.html +++ b/doc/twofish.js.html @@ -45,7 +45,9 @@ * */ -/** @module crypto/cipher/twofish */ +/** + * @module crypto/cipher/twofish + */ @@ -56,11 +58,11 @@ var MAXINT = 0xFFFFFFFF; function rotb(b, n) { - return (b << n | b >>> (8 - n)) & 0xFF; + return (b << n | b >>> (8 - n)) & 0xFF; } function rotw(w, n) { - return (w << n | w >>> (32 - n)) & MAXINT; + return (w << n | w >>> (32 - n)) & MAXINT; } function getW(a, i) { @@ -68,15 +70,15 @@ function getW(a, i) { } function setW(a, i, w) { - a.splice(i, 4, w & 0xFF, (w >>> 8) & 0xFF, (w >>> 16) & 0xFF, (w >>> 24) & 0xFF); + a.splice(i, 4, w & 0xFF, (w >>> 8) & 0xFF, (w >>> 16) & 0xFF, (w >>> 24) & 0xFF); } function setWInv(a, i, w) { - a.splice(i, 4, (w >>> 24) & 0xFF, (w >>> 16) & 0xFF, (w >>> 8) & 0xFF, w & 0xFF); + a.splice(i, 4, (w >>> 24) & 0xFF, (w >>> 16) & 0xFF, (w >>> 8) & 0xFF, w & 0xFF); } function getB(x, n) { - return (x >>> (n * 8)) & 0xFF; + return (x >>> (n * 8)) & 0xFF; } function getNrBits(i) { @@ -160,26 +162,26 @@ function createTwofish() { ]; function ffm5b(x) { - return x ^ (x >> 2) ^ [0, 90, 180, 238][x & 3]; + return x ^ (x >> 2) ^ [0, 90, 180, 238][x & 3]; } function ffmEf(x) { - return x ^ (x >> 1) ^ (x >> 2) ^ [0, 238, 180, 90][x & 3]; + return x ^ (x >> 1) ^ (x >> 2) ^ [0, 238, 180, 90][x & 3]; } function mdsRem(p, q) { var i, t, u; for (i = 0; i < 8; i++) { t = q >>> 24; - q = ((q << 8) & MAXINT) | p >>> 24; - p = (p << 8) & MAXINT; + q = ((q << 8) & MAXINT) | p >>> 24; + p = (p << 8) & MAXINT; u = t << 1; - if (t & 128) { + if (t & 128) { u ^= 333; } q ^= t ^ (u << 16); u ^= t >>> 1; - if (t & 1) { + if (t & 1) { u ^= 166; } q ^= u << 24 | u << 8; @@ -190,7 +192,7 @@ function createTwofish() { function qp(n, x) { var a, b, c, d; a = x >> 4; - b = x & 15; + b = x & 15; c = q0[n][a ^ b]; d = q1[n][ror4[b] ^ ashx[a]]; return q3[n][ror4[d] ^ ashx[c]] << 4 | q2[n][c ^ d]; @@ -223,7 +225,7 @@ function createTwofish() { keyBytes = keyBytes.slice(0, 32); i = keyBytes.length; - while (i != 16 && i != 24 && i != 32) + while (i != 16 && i != 24 && i != 32) keyBytes[i++] = 0; for (i = 0; i < keyBytes.length; i += 4) { @@ -259,7 +261,7 @@ function createTwofish() { b = a + 0x1010101; a = hFun(a, meKey); b = rotw(hFun(b, moKey), 8); - tfsKey[i] = (a + b) & MAXINT; + tfsKey[i] = (a + b) & MAXINT; tfsKey[i + 1] = rotw(a + 2 * b, 9); } for (i = 0; i < 256; i++) { @@ -295,23 +297,23 @@ function createTwofish() { function tfsFrnd(r, blk) { var a = tfsG0(blk[0]); var b = tfsG1(blk[1]); - blk[2] = rotw(blk[2] ^ (a + b + tfsKey[4 * r + 8]) & MAXINT, 31); - blk[3] = rotw(blk[3], 1) ^ (a + 2 * b + tfsKey[4 * r + 9]) & MAXINT; + blk[2] = rotw(blk[2] ^ (a + b + tfsKey[4 * r + 8]) & MAXINT, 31); + blk[3] = rotw(blk[3], 1) ^ (a + 2 * b + tfsKey[4 * r + 9]) & MAXINT; a = tfsG0(blk[2]); b = tfsG1(blk[3]); - blk[0] = rotw(blk[0] ^ (a + b + tfsKey[4 * r + 10]) & MAXINT, 31); - blk[1] = rotw(blk[1], 1) ^ (a + 2 * b + tfsKey[4 * r + 11]) & MAXINT; + blk[0] = rotw(blk[0] ^ (a + b + tfsKey[4 * r + 10]) & MAXINT, 31); + blk[1] = rotw(blk[1], 1) ^ (a + 2 * b + tfsKey[4 * r + 11]) & MAXINT; } function tfsIrnd(i, blk) { var a = tfsG0(blk[0]); var b = tfsG1(blk[1]); - blk[2] = rotw(blk[2], 1) ^ (a + b + tfsKey[4 * i + 10]) & MAXINT; - blk[3] = rotw(blk[3] ^ (a + 2 * b + tfsKey[4 * i + 11]) & MAXINT, 31); + blk[2] = rotw(blk[2], 1) ^ (a + b + tfsKey[4 * i + 10]) & MAXINT; + blk[3] = rotw(blk[3] ^ (a + 2 * b + tfsKey[4 * i + 11]) & MAXINT, 31); a = tfsG0(blk[2]); b = tfsG1(blk[3]); - blk[0] = rotw(blk[0], 1) ^ (a + b + tfsKey[4 * i + 8]) & MAXINT; - blk[1] = rotw(blk[1] ^ (a + 2 * b + tfsKey[4 * i + 9]) & MAXINT, 31); + blk[0] = rotw(blk[0], 1) ^ (a + b + tfsKey[4 * i + 8]) & MAXINT; + blk[1] = rotw(blk[1] ^ (a + 2 * b + tfsKey[4 * i + 9]) & MAXINT, 31); } function tfsClose() { @@ -415,13 +417,13 @@ module.exports.blockSize = TF.prototype.blockSize = 16;
diff --git a/doc/user_attribute.html b/doc/user_attribute.html index c099a400..991ada72 100644 --- a/doc/user_attribute.html +++ b/doc/user_attribute.html @@ -36,8 +36,26 @@
+
Implementation of the User Attribute Packet (Tag 17)
+
+The User Attribute packet is a variation of the User ID packet. It +is capable of storing more types of data than the User ID packet, +which is limited to text. Like the User ID packet, a User Attribute +packet may be certified by the key owner ("self-signed") or any other +key owner who cares to certify it. Except as noted, a User Attribute +packet may be used anywhere that a User ID packet may be used. +
+While User Attribute packets are not a required part of the OpenPGP +standard, implementations SHOULD provide at least enough +compatibility to properly handle a certification signature on the +User Attribute packet. A simple way to do this is by treating the +User Attribute packet as a User ID packet with opaque contents, but +an implementation may use any method desired. +module packet/user_attribute
+
+
+
+The User Attribute packet is a variation of the User ID packet. It +is capable of storing more types of data than the User ID packet, +which is limited to text. Like the User ID packet, a User Attribute +packet may be certified by the key owner ("self-signed") or any other +key owner who cares to certify it. Except as noted, a User Attribute +packet may be used anywhere that a User ID packet may be used. +
+While User Attribute packets are not a required part of the OpenPGP +standard, implementations SHOULD provide at least enough +compatibility to properly handle a certification signature on the +User Attribute packet. A simple way to do this is by treating the +User Attribute packet as a User ID packet with opaque contents, but +an implementation may use any method desired. +module packet/user_attribute
positionlenReturns:
- - -
- object representation
-
-
-
-
--
-
diff --git a/doc/user_attribute.js.html b/doc/user_attribute.js.html index ef800115..96b21b57 100644 --- a/doc/user_attribute.js.html +++ b/doc/user_attribute.js.html @@ -42,46 +42,50 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/user_attribute */ - -/** - * @class - * @classdesc Implementation of the User Attribute Packet (Tag 17) - * The User Attribute packet is a variation of the User ID packet. It - * is capable of storing more types of data than the User ID packet, - * which is limited to text. Like the User ID packet, a User Attribute - * packet may be certified by the key owner ("self-signed") or any other - * key owner who cares to certify it. Except as noted, a User Attribute - * packet may be used anywhere that a User ID packet may be used. - * - * While User Attribute packets are not a required part of the OpenPGP - * standard, implementations SHOULD provide at least enough - * compatibility to properly handle a certification signature on the - * User Attribute packet. A simple way to do this is by treating the - * User Attribute packet as a User ID packet with opaque contents, but - * an implementation may use any method desired. +/** + * Implementation of the User Attribute Packet (Tag 17)<br/> + * <br/> + * The User Attribute packet is a variation of the User ID packet. It + * is capable of storing more types of data than the User ID packet, + * which is limited to text. Like the User ID packet, a User Attribute + * packet may be certified by the key owner ("self-signed") or any other + * key owner who cares to certify it. Except as noted, a User Attribute + * packet may be used anywhere that a User ID packet may be used. + * <br/> + * While User Attribute packets are not a required part of the OpenPGP + * standard, implementations SHOULD provide at least enough + * compatibility to properly handle a certification signature on the + * User Attribute packet. A simple way to do this is by treating the + * User Attribute packet as a User ID packet with opaque contents, but + * an implementation may use any method desired. + * module packet/user_attribute + * @module packet/user_attribute */ -module.exports = function packet_user_attribute() { + +var util = require('../util'), + packet = require('./packet.js'); + +/** + * @constructor + */ +module.exports = function () { this.tag = 17; this.attributes = []; /** * parsing function for a user attribute packet (tag 17). * @param {String} input payload of a tag 17 packet - * @param {Integer} position position to start reading from the input string - * @param {Integer} len length of the packet or the remaining length of input at position - * @return {module:packet/user_attribute} object representation */ this.read = function(bytes) { var i = 0; while (i < bytes.length) { - var len = openpgp_packet.read_simple_length(bytes); - + var len = packet.readSimpleLength(bytes.substr(i)); i += len.offset; + this.attributes.push(bytes.substr(i, len.len)); i += len.len; } - } + }; }; @@ -93,13 +97,13 @@ module.exports = function packet_user_attribute() {
diff --git a/doc/userid.html b/doc/userid.html index dc20c46d..2c44854d 100644 --- a/doc/userid.html +++ b/doc/userid.html @@ -36,8 +36,17 @@
+
Implementation of the User ID Packet (Tag 13)
+
+A User ID packet consists of UTF-8 text that is intended to represent +the name and email address of the key holder. By convention, it +includes an RFC 2822 [RFC2822] mail name-addr, but there are no +restrictions on its content. The packet length in the header +specifies the length of the User ID.
+
+
+
+A User ID packet consists of UTF-8 text that is intended to represent +the name and email address of the key holder. By convention, it +includes an RFC 2822 [RFC2822] mail name-addr, but there are no +restrictions on its content. The packet length in the header +specifies the length of the User ID.
Requires
+ +-
+
positionlenReturns:
- - -
- object representation
-
-
-
-
--
-
Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
user_id |
-
-
- - - -String - - - - | - - - - - -the user id as string ("John Doe |
-
@@ -505,7 +403,7 @@ at position
diff --git a/doc/userid.js.html b/doc/userid.js.html index 92011b23..d2f1f378 100644 --- a/doc/userid.js.html +++ b/doc/userid.js.html @@ -42,20 +42,24 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module packet/userid */ - -var util = require('../util'); - /** - * @class - * @classdesc Implementation of the User ID Packet (Tag 13) + * Implementation of the User ID Packet (Tag 13)<br/> + * <br/> * A User ID packet consists of UTF-8 text that is intended to represent * the name and email address of the key holder. By convention, it * includes an RFC 2822 [RFC2822] mail name-addr, but there are no * restrictions on its content. The packet length in the header - * specifies the length of the User ID. + * specifies the length of the User ID. + * @requires util + * @module packet/userid */ -module.exports = function packet_userid() { + +var util = require('../util'); + +/** + * @constructor + */ +module.exports = function () { /** A string containing the user id. Usually in the form * John Doe <john@example.com> * @type {String} @@ -66,23 +70,18 @@ module.exports = function packet_userid() { /** * Parsing function for a user id packet (tag 13). * @param {String} input payload of a tag 13 packet - * @param {Integer} position position to start reading from the input string - * @param {Integer} len length of the packet or the remaining length of input - * at position - * @return {module:packet/userid} object representation */ - this.read = function(bytes) { + this.read = function (bytes) { this.userid = util.decode_utf8(bytes); - } + }; /** * Creates a string representation of the user id packet - * @param {String} user_id the user id as string ("John Doe <john.doe@mail.us") * @return {String} string representation */ - this.write = function() { + this.write = function () { return util.encode_utf8(this.userid); - } + }; } @@ -94,13 +93,13 @@ module.exports = function packet_userid() {
diff --git a/doc/util-Util.html b/doc/util-Util.html deleted file mode 100644 index f9c33a54..00000000 --- a/doc/util-Util.html +++ /dev/null @@ -1,1878 +0,0 @@ - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class: Util
- - - - - -- module:util/util~ - - Util -
- -Implementation of the util object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Members
- --
-
-
Methods
- --
-
-
- - - - - - - \ No newline at end of file diff --git a/doc/util.html b/doc/util.html index 250527e3..b0df71d4 100644 --- a/doc/util.html +++ b/doc/util.html @@ -38,6 +38,8 @@ +
This object contains utility functions
+
-
@@ -83,25 +85,1911 @@
+
Requires
+ +-
+
Classes
+ + + + + + + +Methods
-
-
diff --git a/doc/util.js.html b/doc/util.js.html index 395920ac..1bd92d6c 100644 --- a/doc/util.js.html +++ b/doc/util.js.html @@ -42,20 +42,16 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -/** @module util/util */ +/** + * This object contains utility functions + * @requires config + * @module util/util + */ var config = require('../config'); -/** - * - * This object contains utility functions - * - * @class - * @classdesc Implementation of the util object - */ -var Util = function() { - - this.readNumber = function(bytes) { +module.exports = { + readNumber: function (bytes) { var n = 0; for (var i = 0; i < bytes.length; i++) { @@ -64,37 +60,33 @@ var Util = function() { } return n; - }; + }, - this.writeNumber = function(n, bytes) { + writeNumber: function (n, bytes) { var b = ''; for (var i = 0; i < bytes; i++) { - b += String.fromCharCode((n >> (8 * (bytes - i - 1))) & 0xFF); + b += String.fromCharCode((n >> (8 * (bytes - i - 1))) & 0xFF); } return b; - }; + }, - - - this.readDate = function(bytes) { + readDate: function (bytes) { var n = this.readNumber(bytes); var d = new Date(); d.setTime(n * 1000); return d; - }; + }, - this.writeDate = function(time) { + writeDate: function (time) { var numeric = Math.round(time.getTime() / 1000); return this.writeNumber(numeric, 4); - }; + }, - this.emailRegEx = /^[+a-zA-Z0-9_.-]+@([a-zA-Z0-9-]+\.)+[a-zA-Z0-9]{2,6}$/; + emailRegEx: /^[+a-zA-Z0-9_.-]+@([a-zA-Z0-9-]+\.)+[a-zA-Z0-9]{2,6}$/, - this.debug = false; - - this.hexdump = function(str) { + hexdump: function (str) { var r = []; var e = str.length; var c = 0; @@ -109,14 +101,14 @@ var Util = function() { r.push("\n "); } return r.join(''); - }; + }, /** * Create hexstring from a binary * @param {String} str String to convert * @return {String} String containing the hexadecimal values */ - this.hexstrdump = function(str) { + hexstrdump: function (str) { if (str == null) return ""; var r = []; @@ -129,26 +121,26 @@ var Util = function() { r.push("" + h); } return r.join(''); - }; + }, /** * Create binary string from a hex encoded string * @param {String} str Hex string to convert * @return {String} String containing the binary values */ - this.hex2bin = function(hex) { + hex2bin: function (hex) { var str = ''; for (var i = 0; i < hex.length; i += 2) str += String.fromCharCode(parseInt(hex.substr(i, 2), 16)); return str; - }; + }, /** * Creating a hex string from an binary array of integers (0..255) * @param {String} str Array of bytes to convert * @return {String} Hexadecimal representation of the array */ - this.hexidump = function(str) { + hexidump: function (str) { var r = []; var e = str.length; var c = 0; @@ -159,7 +151,7 @@ var Util = function() { r.push("" + h); } return r.join(''); - }; + }, /** @@ -167,32 +159,29 @@ var Util = function() { * @param {String} str The string to convert * @return {String} A valid squence of utf8 bytes */ - this.encode_utf8 = function(str) { + encode_utf8: function (str) { return unescape(encodeURIComponent(str)); - }; + }, /** * Convert a string of utf8 bytes to a native javascript string * @param {String} utf8 A valid squence of utf8 bytes * @return {String} A native javascript string */ - this.decode_utf8 = function(utf8) { + decode_utf8: function (utf8) { try { return decodeURIComponent(escape(utf8)); } catch (e) { return utf8; } - }; + }, - var str2bin = function(str, result) { - for (var i = 0; i < str.length; i++) { - result[i] = str.charCodeAt(i); - } - - return result; - }; - - var bin2str = function(bin) { + /** + * Convert an array of integers(0.255) to a string + * @param {Array<Integer>} bin An array of (binary) integers to convert + * @return {String} The string representation of the array + */ + bin2str: function (bin) { var result = []; for (var i = 0; i < bin.length; i++) { @@ -200,53 +189,57 @@ var Util = function() { } return result.join(''); - }; + }, + + _str2bin: function (str, result) { + for (var i = 0; i < str.length; i++) { + result[i] = str.charCodeAt(i); + } + + return result; + }, /** * Convert a string to an array of integers(0.255) * @param {String} str String to convert * @return {Array<Integer>} An array of (binary) integers */ - this.str2bin = function(str) { - return str2bin(str, new Array(str.length)); - }; + str2bin: function (str) { + return this._str2bin(str, new Array(str.length)); + }, - /** - * Convert an array of integers(0.255) to a string - * @param {Array<Integer>} bin An array of (binary) integers to convert - * @return {String} The string representation of the array - */ - this.bin2str = bin2str; - /** * Convert a string to a Uint8Array * @param {String} str String to convert * @return {Uint8Array} The array of (binary) integers */ - this.str2Uint8Array = function(str) { - return str2bin(str, new Uint8Array(new ArrayBuffer(str.length))); - }; + str2Uint8Array: function (str) { + return this._str2bin(str, new Uint8Array(new ArrayBuffer(str.length))); + }, /** * Convert a Uint8Array to a string. This currently functions - * the same as bin2str. + * the same as bin2str. + * @function module:util/util.Uint8Array2str * @param {Uint8Array} bin An array of (binary) integers to convert * @return {String} String representation of the array */ - this.Uint8Array2str = bin2str; + Uint8Array2str: function (bin) { + return this.bin2str(bin); + }, /** - * Calculates a 16bit sum of a string by adding each character + * Calculates a 16bit sum of a string by adding each character * codes modulus 65535 * @param {String} text String to create a sum of - * @return {Integer} An integer containing the sum of all character + * @return {Integer} An integer containing the sum of all character * codes % 65535 */ - this.calc_checksum = function(text) { + calc_checksum: function (text) { var checksum = { s: 0, - add: function(sadd) { + add: function (sadd) { this.s = (this.s + sadd) % 65536; } }; @@ -254,42 +247,42 @@ var Util = function() { checksum.add(text.charCodeAt(i)); } return checksum.s; - }; + }, /** * Helper function to print a debug message. Debug * messages are only printed if - * openpgp.config.debug is set to true. + * @link module:config/config.debug is set to true. * @param {String} str String of the debug message */ - this.print_debug = function(str) { + print_debug: function (str) { if (config.debug) { console.log(str); } - }; + }, /** * Helper function to print a debug message. Debug * messages are only printed if - * openpgp.config.debug is set to true. + * @link module:config/config.debug is set to true. * Different than print_debug because will call hexstrdump iff necessary. * @param {String} str String of the debug message */ - this.print_debug_hexstr_dump = function(str, strToHex) { + print_debug_hexstr_dump: function (str, strToHex) { if (config.debug) { str = str + this.hexstrdump(strToHex); console.log(str); } - }; + }, - this.getLeftNBits = function(string, bitcount) { + getLeftNBits: function (string, bitcount) { var rest = bitcount % 8; if (rest == 0) return string.substring(0, bitcount / 8); var bytes = (bitcount - rest) / 8 + 1; var result = string.substring(0, bytes); - return this.shiftRight(result, 8 - rest); // +String.fromCharCode(string.charCodeAt(bytes -1) << (8-rest) & 0xFF); - }; + return this.shiftRight(result, 8 - rest); // +String.fromCharCode(string.charCodeAt(bytes -1) << (8-rest) & 0xFF); + }, /** * Shifting a string to n bits right @@ -298,25 +291,25 @@ var Util = function() { * than 9) * @return {String} Resulting string. */ - this.shiftRight = function(value, bitcount) { + shiftRight: function (value, bitcount) { var temp = util.str2bin(value); if (bitcount % 8 != 0) { for (var i = temp.length - 1; i >= 0; i--) { temp[i] >>= bitcount % 8; if (i > 0) - temp[i] |= (temp[i - 1] << (8 - (bitcount % 8))) & 0xFF; + temp[i] |= (temp[i - 1] << (8 - (bitcount % 8))) & 0xFF; } } else { return value; } return util.bin2str(temp); - }; + }, /** * Return the algorithm type as string * @return {String} String representing the message type */ - this.get_hashAlgorithmString = function(algo) { + get_hashAlgorithmString: function (algo) { switch (algo) { case 1: return "MD5"; @@ -334,15 +327,8 @@ var Util = function() { return "SHA224"; } return "unknown"; - }; - + } }; - -/** - * an instance that should be used. - */ - -module.exports = new Util(); @@ -353,13 +339,13 @@ module.exports = new Util();
diff --git a/jsdoc.template/README.md b/jsdoc.template/README.md new file mode 100644 index 00000000..a7bd96bf --- /dev/null +++ b/jsdoc.template/README.md @@ -0,0 +1 @@ +The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://documentcloud.github.com/underscore/#template). diff --git a/jsdoc.template/publish.js b/jsdoc.template/publish.js new file mode 100644 index 00000000..ad23b506 --- /dev/null +++ b/jsdoc.template/publish.js @@ -0,0 +1,565 @@ +/*global env: true */ +var template = require('jsdoc/template'), + fs = require('jsdoc/fs'), + path = require('jsdoc/path'), + taffy = require('taffydb').taffy, + handle = require('jsdoc/util/error').handle, + helper = require('jsdoc/util/templateHelper'), + htmlsafe = helper.htmlsafe, + linkto = helper.linkto, + resolveAuthorLinks = helper.resolveAuthorLinks, + scopeToPunc = helper.scopeToPunc, + hasOwnProp = Object.prototype.hasOwnProperty, + data, + view, + outdir = env.opts.destination; + + +function find(spec) { + return helper.find(data, spec); +} + +function tutoriallink(tutorial) { + return helper.toTutorial(tutorial, null, { tag: 'em', classname: 'disabled', prefix: 'Tutorial: ' }); +} + +function getAncestorLinks(doclet) { + return helper.getAncestorLinks(data, doclet); +} + +function hashToLink(doclet, hash) { + if ( !/^(#.+)/.test(hash) ) { return hash; } + + var url = helper.createLink(doclet); + + url = url.replace(/(#.+|$)/, hash); + return '' + hash + ''; +} + +function needsSignature(doclet) { + var needsSig = false; + + // function and class definitions always get a signature + if (doclet.kind === 'function' || doclet.kind === 'class') { + needsSig = true; + } + // typedefs that contain functions get a signature, too + else if (doclet.kind === 'typedef' && doclet.type && doclet.type.names && + doclet.type.names.length) { + for (var i = 0, l = doclet.type.names.length; i < l; i++) { + if (doclet.type.names[i].toLowerCase() === 'function') { + needsSig = true; + break; + } + } + } + + return needsSig; +} + +function addSignatureParams(f) { + var params = helper.getSignatureParams(f, 'optional'); + + f.signature = (f.signature || '') + '('+params.join(', ')+')'; +} + +function addSignatureReturns(f) { + var returnTypes = helper.getSignatureReturns(f); + + f.signature = ''+(f.signature || '') + '' + ''+(returnTypes.length? ' → {'+returnTypes.join('|')+'}' : '')+''; +} + +function addSignatureTypes(f) { + var types = helper.getSignatureTypes(f); + + f.signature = (f.signature || '') + ''+(types.length? ' :'+types.join('|') : '')+''; +} + +function addAttribs(f) { + var attribs = helper.getAttribs(f); + + f.attribs = ''+htmlsafe(attribs.length? '<'+attribs.join(', ')+'> ' : '')+''; +} + +function shortenPaths(files, commonPrefix) { + // always use forward slashes + var regexp = new RegExp('\\\\', 'g'); + + Object.keys(files).forEach(function(file) { + files[file].shortened = files[file].resolved.replace(commonPrefix, '') + .replace(regexp, '/'); + }); + + return files; +} + +function resolveSourcePath(filepath) { + return path.resolve(process.cwd(), filepath); +} + +function getPathFromDoclet(doclet) { + if (!doclet.meta) { + return; + } + + var filepath = doclet.meta.path && doclet.meta.path !== 'null' ? + doclet.meta.path + '/' + doclet.meta.filename : + doclet.meta.filename; + + return filepath; +} + +function generate(title, docs, filename, resolveLinks) { + resolveLinks = resolveLinks === false ? false : true; + + var docData = { + title: title, + docs: docs + }; + + var outpath = path.join(outdir, filename), + html = view.render('container.tmpl', docData); + + if (resolveLinks) { + html = helper.resolveLinks(html); // turn {@link foo} into foo + } + + fs.writeFileSync(outpath, html, 'utf8'); +} + +function generateSourceFiles(sourceFiles) { + Object.keys(sourceFiles).forEach(function(file) { + var source; + // links are keyed to the shortened path in each doclet's `meta.filename` property + var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened); + helper.registerLink(sourceFiles[file].shortened, sourceOutfile); + + try { + source = { + kind: 'source', + code: helper.htmlsafe( fs.readFileSync(sourceFiles[file].resolved, 'utf8') ) + }; + } + catch(e) { + handle(e); + } + + generate('Source: ' + sourceFiles[file].shortened, [source], sourceOutfile, + false); + }); +} + +/** + * Look for classes or functions with the same name as modules (which indicates that the module + * exports only that class or function), then attach the classes or functions to the `module` + * property of the appropriate module doclets. The name of each class or function is also updated + * for display purposes. This function mutates the original arrays. + * + * @private + * @param {Array.