Mirroristas/openpgpjs
2
0
Fork 0
mirror of https://github.com/openpgpjs/openpgpjs.git synced 2025-03-30 15:08:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates to documentation. Most all classes should now be jsdoc compliant.

Browse Source
This commit is contained in:
Sean Colyer 2012-09-11 21:54:42 -04:00
parent 01ddec6431
commit 7aa4a83474
46 changed files with 12415 additions and 1680 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/JXG.Util.html
View File

File diff suppressed because one or more lines are too long

737
doc/_openpgp_packet.html Normal file
View File

File diff suppressed because one or more lines are too long

1188
doc/global.html
View File

File diff suppressed because one or more lines are too long

10
doc/index.html
View File

File diff suppressed because one or more lines are too long

22
doc/openpgp.html
View File

File diff suppressed because one or more lines are too long

392
doc/openpgp_config.html Normal file
View File

File diff suppressed because one or more lines are too long

4
doc/openpgp_keyring.html
View File

File diff suppressed because one or more lines are too long

16
doc/openpgp_msg_message.html
View File

File diff suppressed because one or more lines are too long

4
doc/openpgp_msg_privatekey.html
View File

File diff suppressed because one or more lines are too long

14
doc/openpgp_msg_publickey.html
View File

File diff suppressed because one or more lines are too long

771
doc/openpgp_packet_compressed.html Normal file
View File

File diff suppressed because one or more lines are too long

624
doc/openpgp_packet_encrypteddata.html Normal file
View File

File diff suppressed because one or more lines are too long

610
doc/openpgp_packet_encryptedintegrityprotecteddata.html Normal file
View File

File diff suppressed because one or more lines are too long

925
doc/openpgp_packet_encryptedsessionkey.html Normal file
View File

File diff suppressed because one or more lines are too long

1643
doc/openpgp_packet_keymaterial.html Normal file
View File

File diff suppressed because one or more lines are too long

522
doc/openpgp_packet_literaldata.html Normal file
View File

File diff suppressed because one or more lines are too long

399
doc/openpgp_packet_marker.html Normal file
View File

File diff suppressed because one or more lines are too long

400
doc/openpgp_packet_modificationdetectioncode.html Normal file
View File

File diff suppressed because one or more lines are too long

611
doc/openpgp_packet_onepasssignature.html Normal file
View File

File diff suppressed because one or more lines are too long

1024
doc/openpgp_packet_signature.html Normal file
View File

File diff suppressed because one or more lines are too long

594
doc/openpgp_packet_userattribute.html Normal file
View File

File diff suppressed because one or more lines are too long

1016
doc/openpgp_packet_userid.html Normal file
View File

File diff suppressed because one or more lines are too long

362
doc/openpgp_type_keyid.html Normal file
View File

File diff suppressed because one or more lines are too long

751
doc/openpgp_type_mpi.html Normal file
View File

File diff suppressed because one or more lines are too long

499
doc/openpgp_type_s2k.html Normal file
View File

File diff suppressed because one or more lines are too long

472
resources/openpgp.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the One-Pass Signature Packets (Tag 4)
* @class
* @classdesc Implementation of the One-Pass Signature Packets (Tag 4)
*
* RFC4880 5.4:
* The One-Pass Signature packet precedes the signed data and contains
@ -36,10 +37,10 @@ function openpgp_packet_onepasssignature() {
/**
* parsing function for a one-pass signature packet (tag 4).
* @param input [string] payload of a tag 4 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_encrypteddata] object representation
* @param {string} input payload of a tag 4 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 {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.packetLength = len;
@ -71,14 +72,14 @@ function openpgp_packet_onepasssignature() {
/**
* creates a string representation of a one-pass signature packet
* @param type [integer] Signature types as described in RFC4880 Section 5.2.1.
* @param hashalgorithm [integer] the hash algorithm used within the signature
* @param privatekey [openpgp_msg_privatekey] the private key used to generate the signature
* @param length [integer] length of data to be signed
* @param nested [boolean] boolean showing whether the signature is nested.
* @param {integer} type Signature types as described in RFC4880 Section 5.2.1.
* @param {integer} hashalgorithm the hash algorithm used within the signature
* @param {openpgp_msg_privatekey} privatekey the private key used to generate the signature
* @param {integer} length length of data to be signed
* @param {boolean} nested boolean showing whether the signature is nested.
* "true" indicates that the next packet is another One-Pass Signature packet
* that describes another signature to be applied to the same message data.
* @return [String] a string representation of a one-pass signature packet
* @return {String} a string representation of a one-pass signature packet
*/
function write_packet(type, hashalgorithm, privatekey,length, nested) {
var result ="";
@ -99,7 +100,7 @@ function openpgp_packet_onepasssignature() {
/**
* generates debug output (pretty print)
* @return String which gives some information about the one-pass signature packet
* @return {string} String which gives some information about the one-pass signature packet
*/
function toString() {
return '5.4. One-Pass Signature Packets (Tag 4)\n'+
@ -115,7 +116,8 @@ function openpgp_packet_onepasssignature() {
this.read_packet = read_packet;
this.toString = toString;
this.write_packet = write_packet;
};// GPG4Browsers - An OpenPGP implementation in javascript
};
// GPG4Browsers - An OpenPGP implementation in javascript
// Copyright (C) 2011 Recurity Labs GmbH
//
// This library is free software; you can redistribute it and/or
@ -133,7 +135,8 @@ function openpgp_packet_onepasssignature() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the strange "Marker packet" (Tag 10)
* @class
* @classdesc 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
@ -147,14 +150,13 @@ function openpgp_packet_marker() {
/**
* parsing function for a literal data packet (tag 10).
*
* @param input
* [string] payload of a tag 10 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 10 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.packetLength = 3;
@ -169,7 +171,7 @@ function openpgp_packet_marker() {
/**
* Generates Debug output
*
* @return String which gives some information about the keymaterial
* @return {string} String which gives some information about the keymaterial
*/
function toString() {
return "5.8. Marker Packet (Obsolete Literal Packet) (Tag 10)\n"
@ -178,7 +180,8 @@ function openpgp_packet_marker() {
this.read_packet = read_packet;
this.toString = toString;
}// GPG4Browsers - An OpenPGP implementation in javascript
}
// GPG4Browsers - An OpenPGP implementation in javascript
// Copyright (C) 2011 Recurity Labs GmbH
//
// This library is free software; you can redistribute it and/or
@ -196,7 +199,8 @@ function openpgp_packet_marker() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Signature Packet (Tag 2)
* @class
* @classdesc Implementation of the Signature Packet (Tag 2)
*
* RFC4480 5.2:
* A Signature packet describes a binding between some public key and
@ -248,10 +252,10 @@ function openpgp_packet_signature() {
/**
* parsing function for a signature packet (tag 2).
* @param input [string] payload of a tag 2 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_encrypteddata] object representation
* @param {string} input payload of a tag 2 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 {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.data = input.substring (position, position+len);
@ -388,10 +392,10 @@ function openpgp_packet_signature() {
/**
* creates a string representation of a message signature packet (tag 2).
* This can be only used on text data
* @param signature_type [integer] should be 1 (one)
* @param data [String] data to be signed
* @param privatekey [openpgp_msg_privatekey] private key used to sign the message. (secMPIs MUST be unlocked)
* @return string representation of a signature packet
* @param {integer} signature_type should be 1 (one)
* @param {String} data data to be signed
* @param {openpgp_msg_privatekey} privatekey private key used to sign the message. (secMPIs MUST be unlocked)
* @return {string} string representation of a signature packet
*/
function write_message_signature(signature_type, data, privatekey) {
var publickey = privatekey.privateKeyPacket.publicKey;
@ -434,9 +438,9 @@ function openpgp_packet_signature() {
}
/**
* creates a string representation of a sub signature packet (See RFC 4880 5.2.3.1)
* @param type [integer] subpacket signature type. Signature types as described in RFC4880 Section 5.2.3.2
* @param data [String] data to be included
* @return [String] a string-representation of a sub signature packet (See RFC 4880 5.2.3.1)
* @param {integer} type subpacket signature type. Signature types as described in RFC4880 Section 5.2.3.2
* @param {String} data data to be included
* @return {String} a string-representation of a sub signature packet (See RFC 4880 5.2.3.1)
*/
function write_sub_signature_packet(type, data) {
var result = "";
@ -842,7 +846,7 @@ function openpgp_packet_signature() {
}
/**
* generates debug output (pretty print)
* @return String which gives some information about the signature packet
* @return {string} String which gives some information about the signature packet
*/
function toString () {
@ -901,7 +905,7 @@ function openpgp_packet_signature() {
/**
* gets the issuer key id of this signature
* @return [String] issuer key id as string (8bytes)
* @return {String} issuer key id as string (8bytes)
*/
function getIssuer() {
if (this.version == 4)
@ -951,7 +955,8 @@ function openpgp_packet_signature() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Sym. Encrypted Integrity Protected Data Packet (Tag 18)
* @class
* @classdesc 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
@ -970,14 +975,12 @@ function openpgp_packet_encryptedintegrityprotecteddata() {
/**
* parsing function for the packet.
*
* @param input
* [string] payload of a tag 18 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 18 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 [openpgp_packet_encryptedintegrityprotecteddata] object
* @return {openpgp_packet_encryptedintegrityprotecteddata} object
* representation
*/
function read_packet(input, position, len) {
@ -1008,11 +1011,9 @@ function openpgp_packet_encryptedintegrityprotecteddata() {
* Creates a string representation of a Sym. Encrypted Integrity Protected
* Data Packet (tag 18) (see RFC4880 5.13)
*
* @param symmetric_algorithm
* [integer] the selected symmetric encryption algorithm to be
* used
* @param key
* [String] the key of cipher blocksize length to be used
* @param {integer} symmetric_algorithm
* the selected symmetric encryption algorithm to be used
* @param {String} key the key of cipher blocksize length to be used
* @param data
* plaintext data to be encrypted within the packet
* @return a string representation of the packet
@ -1045,11 +1046,9 @@ function openpgp_packet_encryptedintegrityprotecteddata() {
* Decrypts the encrypted data contained in this object read_packet must
* have been called before
*
* @param symmetric_algorithm_type
* [integer] the selected symmetric encryption algorithm to be
* used
* @param key
* [String] the key of cipher blocksize length to be used
* @param {integer} symmetric_algorithm_type
* the selected symmetric encryption algorithm to be used
* @param {String} key the key of cipher blocksize length to be used
* @return the decrypted data of this packet
*/
function decrypt(symmetric_algorithm_type, key) {
@ -1110,7 +1109,8 @@ function openpgp_packet_encryptedintegrityprotecteddata() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Modification Detection Code Packet (Tag 19)
* @class
* @classdesc Implementation of the Modification Detection Code Packet (Tag 19)
*
* RFC4880 5.14: The Modification Detection Code packet contains a SHA-1 hash of
* plaintext data, which is used to detect message modification. It is only used
@ -1126,14 +1126,13 @@ function openpgp_packet_modificationdetectioncode() {
/**
* parsing function for a modification detection code packet (tag 19).
*
* @param input
* [String] payload of a tag 19 packet
* @param position
* [Integer] position to start reading from the input string
* @param len
* [Integer] length of the packet or the remaining length of
* @param {String} input payload of a tag 19 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.packetLength = len;
@ -1161,7 +1160,7 @@ function openpgp_packet_modificationdetectioncode() {
/**
* generates debug output (pretty print)
*
* @return String which gives some information about the modification
* @return {string} String which gives some information about the modification
* detection code
*/
function toString() {
@ -1189,6 +1188,8 @@ function openpgp_packet_modificationdetectioncode() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* @class
* @classdesc 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
@ -1205,10 +1206,10 @@ function openpgp_packet_userid() {
/**
* parsing function for a user id packet (tag 13).
* @param input [string] payload of a tag 13 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_encrypteddata] object representation
* @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 {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.text = '';
@ -1222,8 +1223,8 @@ function openpgp_packet_userid() {
/**
* creates a string representation of the user id packet
* @param user_id [String] the user id as string ("John Doe <john.doe@mail.us")
* @return [String] string representation
* @param {String} user_id the user id as string ("John Doe <john.doe@mail.us")
* @return {String} string representation
*/
function write_packet(user_id) {
this.text = user_id;
@ -1234,11 +1235,11 @@ function openpgp_packet_userid() {
/**
* Continue parsing packets belonging to the userid packet such as signatures
* @param parent_node [openpgp_*] the parent object
* @param input [String] input string to read the packet(s) from
* @param position [integer] start position for the parser
* @param len [integer] length of the packet(s) or remaining length of input
* @return [integer] length of nodes read
* @param {openpgp_*} parent_node the parent object
* @param {String} input input string to read the packet(s) from
* @param {integer} position start position for the parser
* @param {integer} len length of the packet(s) or remaining length of input
* @return {integer} length of nodes read
*/
function read_nodes(parent_node, input, position, len) {
if (parent_node.tagType == 6) { // public key
@ -1318,7 +1319,7 @@ function openpgp_packet_userid() {
/**
* generates debug output (pretty print)
* @return String which gives some information about the user id packet
* @return {string} String which gives some information about the user id packet
*/
function toString() {
var result = ' 5.11. User ID Packet (Tag 13)\n' + ' text ('
@ -1337,7 +1338,7 @@ function openpgp_packet_userid() {
/**
* lookup function to find certification revocation signatures
* @param keyId string containing the key id of the issuer of this signature
* @param {string} keyId string containing the key id of the issuer of this signature
* @return a CertificationRevocationSignature if found; otherwise null
*/
function hasCertificationRevocationSignature(keyId) {
@ -1523,7 +1524,8 @@ function openpgp_packet_userid() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Public-Key Encrypted Session Key Packets (Tag 1)
* @class
* @classdesc 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
@ -1542,14 +1544,11 @@ function openpgp_packet_encryptedsessionkey() {
/**
* parsing function for a publickey encrypted session key packet (tag 1).
*
* @param input
* [string] payload of a tag 1 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 1 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_pub_key_packet(input, position, len) {
this.tagType = 1;
@ -1594,23 +1593,19 @@ function openpgp_packet_encryptedsessionkey() {
/**
* create a string representation of a tag 1 packet
*
* @param publicKeyId
* [String] the public key id corresponding to publicMPIs key as
* string
* @param publicMPIs
* [Array[openpgp_type_mpi]] multiprecision integer objects
* describing the public key
* @param pubalgo
* [integer] the corresponding public key algorithm // See
* RFC4880 9.1
* @param symmalgo
* [integer] the symmetric cipher algorithm used to encrypt the
* data within an encrypteddatapacket or
* encryptedintegrityprotecteddatapacket following this packet //
* See RFC4880 9.2
* @param sessionkey
* [String] a string of randombytes representing the session key
* @return [String] the string representation
* @param {String} publicKeyId
* the public key id corresponding to publicMPIs key as string
* @param {Array[openpgp_type_mpi]} publicMPIs
* multiprecision integer objects describing the public key
* @param {integer} pubalgo
* the corresponding public key algorithm // See RFC4880 9.1
* @param {integer} symmalgo
* the symmetric cipher algorithm used to encrypt the data within
* an encrypteddatapacket or encryptedintegrityprotecteddatapacket
* following this packet //See RFC4880 9.2
* @param {String} sessionkey
* a string of randombytes representing the session key
* @return {String} the string representation
*/
function write_pub_key_packet(publicKeyId, publicMPIs, pubalgo, symmalgo,
sessionkey) {
@ -1636,14 +1631,12 @@ function openpgp_packet_encryptedsessionkey() {
/**
* parsing function for a symmetric encrypted session key packet (tag 3).
*
* @param input
* [string] payload of a tag 1 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 1 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_symmetric_key_packet(input, position, len) {
this.tagType = 3;
@ -1671,12 +1664,11 @@ function openpgp_packet_encryptedsessionkey() {
* Decrypts the session key (only for public key encrypted session key
* packets (tag 1)
*
* @param msg
* [openpgp_msg_message] the message object (with member
* encryptedData
* @param key
* [openpgp_msg_privatekey] private key with secMPIs unlocked
* @return [String] the unencrypted session key
* @param {openpgp_msg_message} msg
* the message object (with member encryptedData
* @param {openpgp_msg_privatekey} key
* private key with secMPIs unlocked
* @return {String} the unencrypted session key
*/
function decrypt(msg, key) {
if (this.tagType == 1) {
@ -1757,7 +1749,8 @@ function openpgp_packet_encryptedsessionkey() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Literal Data Packet (Tag 11)
* @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.
@ -1768,14 +1761,13 @@ function openpgp_packet_literaldata() {
/**
* parsing function for a literal data packet (tag 11).
*
* @param input
* [string] payload of a tag 11 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 11 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.packetLength = len;
@ -1794,9 +1786,8 @@ function openpgp_packet_literaldata() {
/**
* Creates a string representation of the packet
*
* @param data
* [String] the data to be inserted as body
* @return [String] string-representation of the packet
* @param {String} data the data to be inserted as body
* @return {String} string-representation of the packet
*/
function write_packet(data) {
data = data.replace(/\r\n/g, "\n").replace(/\n/g, "\r\n");
@ -1824,7 +1815,7 @@ function openpgp_packet_literaldata() {
/**
* generates debug output (pretty print)
*
* @return String which gives some information about the keymaterial
* @return {string} String which gives some information about the keymaterial
*/
function toString() {
return '5.9. Literal Data Packet (Tag 11)\n' + ' length: '
@ -1856,7 +1847,8 @@ function openpgp_packet_literaldata() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Symmetrically Encrypted Data Packet (Tag 9)
* @class
* @classdesc 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
@ -1874,14 +1866,11 @@ function openpgp_packet_encrypteddata() {
/**
* parsing function for the packet.
*
* @param input
* [string] payload of a tag 9 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 9 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
var mypos = position;
@ -1895,10 +1884,10 @@ function openpgp_packet_encrypteddata() {
/**
* symmetrically decrypt the packet data
*
* @param symmetric_algorithm_type
* [integer] symmetric key algorithm to use // See RFC4880 9.2
* @param key
* [String] key as string with the corresponding length to the
* @param {integer} symmetric_algorithm_type
* symmetric key algorithm to use // See RFC4880 9.2
* @param {String} key
* key as string with the corresponding length to the
* algorithm
* @return the decrypted data;
*/
@ -1913,14 +1902,11 @@ function openpgp_packet_encrypteddata() {
/**
* Creates a string representation of the packet
*
* @param algo
* [Integer] symmetric key algorithm to use // See RFC4880 9.2
* @param key
* [String] key as string with the corresponding length to the
* @param {Integer} algo symmetric key algorithm to use // See RFC4880 9.2
* @param {String} key key as string with the corresponding length to the
* algorithm
* @param data
* [String] data to be
* @return [String] string-representation of the packet
* @param {String} data data to be
* @return {String} string-representation of the packet
*/
function write_packet(algo, key, data) {
var result = "";
@ -1960,6 +1946,8 @@ function openpgp_packet_encrypteddata() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* @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
@ -1983,10 +1971,10 @@ function openpgp_packet_userattribute() {
/**
* parsing function for a user attribute packet (tag 17).
* @param input [string] payload of a tag 17 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_encrypteddata] object representation
* @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 {openpgp_packet_encrypteddata} object representation
*/
function read_packet (input, position, len) {
var total_len = 0;
@ -2031,7 +2019,7 @@ function openpgp_packet_userattribute() {
/**
* generates debug output (pretty print)
* @return String which gives some information about the user attribute packet
* @return {string} String which gives some information about the user attribute packet
*/
function toString() {
var result = '5.12. User Attribute Packet (Tag 17)\n'+
@ -2044,11 +2032,11 @@ function openpgp_packet_userattribute() {
/**
* Continue parsing packets belonging to the user attribute packet such as signatures
* @param parent_node [openpgp_*] the parent object
* @param input [String] input string to read the packet(s) from
* @param position [integer] start position for the parser
* @param len [integer] length of the packet(s) or remaining length of input
* @return [integer] length of nodes read
* @param {openpgp_*} parent_node the parent object
* @param {String} input input string to read the packet(s) from
* @param {integer} position start position for the parser
* @param {integer} len length of the packet(s) or remaining length of input
* @return {integer} length of nodes read
*/
function read_nodes(parent_node, input, position, len) {
@ -2094,7 +2082,8 @@ function openpgp_packet_userattribute() {
this.read_nodes = read_nodes;
this.toString = toString;
};// GPG4Browsers - An OpenPGP implementation in javascript
};
// GPG4Browsers - An OpenPGP implementation in javascript
// Copyright (C) 2011 Recurity Labs GmbH
//
// This library is free software; you can redistribute it and/or
@ -2111,14 +2100,18 @@ function openpgp_packet_userattribute() {
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* @class
* @classdesc Parent openpgp packet class. Operations focus on determining packet types
* and packet header.
*/
function _openpgp_packet() {
/**
* Encodes a given integer of length to the openpgp length specifier to a
* string
*
* @param length
* [Integer] of the length to encode
* @return string with openpgp length representation
* @param {Integer} length of the length to encode
* @return {string} string with openpgp length representation
*/
function encode_length(length) {
result = "";
@ -2146,11 +2139,9 @@ function _openpgp_packet() {
* Writes a packet header version 4 with the given tag_type and length to a
* string
*
* @param tag_type
* integer of tag type
* @param length
* integer length of the payload
* @return string of the header
* @param {integer} tag_type tag type
* @param {integer} length length of the payload
* @return {string} string of the header
*/
function write_packet_header(tag_type, length) {
/* we're only generating v4 packet headers here */
@ -2164,11 +2155,9 @@ function _openpgp_packet() {
* Writes a packet header Version 3 with the given tag_type and length to a
* string
*
* @param tag_type
* integer of tag type
* @param length
* integer length of the payload
* @return string of the header
* @param {integer} tag_type tag type
* @param {integer} length length of the payload
* @return {string} string of the header
*/
function write_old_packet_header(tag_type, length) {
var result = "";
@ -2193,13 +2182,10 @@ function _openpgp_packet() {
/**
* Generic static Packet Parser function
*
* @param input
* [String] input stream as string
* @param position
* [integer] position to start parsing
* @param len
* [integer] length of the input from position on
* @return [openpgp_packet_*] returns a parsed openpgp_packet
* @param {String} input input stream as string
* @param {integer} position position to start parsing
* @param {integer} len length of the input from position on
* @return {openpgp_packet_*} returns a parsed openpgp_packet
*/
function read_packet(input, position, len) {
// some sanity checks
@ -2521,7 +2507,8 @@ var openpgp_packet = new _openpgp_packet();
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Compressed Data Packet (Tag 8)
* @class
* @classdesc Implementation of the Compressed Data Packet (Tag 8)
*
* RFC4880 5.6:
* The Compressed Data packet contains compressed data. Typically, this
@ -2534,10 +2521,10 @@ function openpgp_packet_compressed() {
/**
* parsing function for the packet.
* @param input [string] payload of a tag 8 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_compressed] object representation
* @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 {openpgp_packet_compressed} object representation
*/
function read_packet (input, position, len) {
this.packetLength = len;
@ -2551,7 +2538,7 @@ function openpgp_packet_compressed() {
/**
* decompression method for decompressing the compressed data
* read by read_packet
* @return [String] the decompressed data
* @return {String} the decompressed data
*/
function decompress() {
if (this.decompressedData != null)
@ -2605,9 +2592,9 @@ function openpgp_packet_compressed() {
/**
* Compress the packet data (member decompressedData)
* @param type [integer] algorithm to be used // See RFC 4880 9.3
* @param data [String] data to be compressed
* @return [String] The compressed data stored in attribute compressedData
* @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
*/
function compress(type, data) {
this.type = type;
@ -2637,9 +2624,9 @@ function openpgp_packet_compressed() {
/**
* creates a string representation of the packet
* @param algorithm [integer] algorithm to be used // See RFC 4880 9.3
* @param data [String] data to be compressed
* @return [String] string-representation of the packet
* @param {integer} algorithm algorithm to be used // See RFC 4880 9.3
* @param {String} data data to be compressed
* @return {String} string-representation of the packet
*/
function write_packet(algorithm, data) {
this.decompressedData = data;
@ -2652,7 +2639,7 @@ function openpgp_packet_compressed() {
/**
* pretty printing the packet (useful for debug purposes)
* @return [String]
* @return {String}
*/
function toString() {
return '5.6. Compressed Data Packet (Tag 8)\n'+
@ -2685,7 +2672,8 @@ function openpgp_packet_compressed() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Key Material Packet (Tag 5,6,7,14)
* @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
@ -3214,11 +3202,11 @@ function openpgp_packet_keymaterial() {
/**
* Continue parsing packets belonging to the key material such as signatures
* @param parent_node [openpgp_*] the parent object
* @param input [String] input string to read the packet(s) from
* @param position [integer] start position for the parser
* @param len [integer] length of the packet(s) or remaining length of input
* @return [integer] length of nodes read
* @param {openpgp_*} parent_node the parent object
* @param {String} input input string to read the packet(s) from
* @param {integer} position start position for the parser
* @param {integer} len length of the packet(s) or remaining length of input
* @return {integer} length of nodes read
*/
function read_nodes(parent_node, input, position, len) {
this.parentNode = parent_node;
@ -3326,7 +3314,7 @@ function openpgp_packet_keymaterial() {
/**
* calculates the key id of they key
* @return [String] a 8 byte key id
* @return {String} a 8 byte key id
*/
function getKeyId() {
if (this.version == 4) {
@ -3341,7 +3329,7 @@ function openpgp_packet_keymaterial() {
/**
* calculates the fingerprint of the key
* @return [String] a string containing the fingerprint
* @return {String} a string containing the fingerprint
*/
function getFingerprint() {
if (this.version == 4) {
@ -3356,8 +3344,12 @@ function openpgp_packet_keymaterial() {
/*
* creates an OpenPGP key packet for the given key. much TODO in regards to s2k, subkeys.
* @param keyType [int] follows the OpenPGP algorithm standard, IE 1 corresponds to RSA.
* @param key [RSA.keyObject]
* @param {int} keyType follows the OpenPGP algorithm standard, IE 1 corresponds to RSA.
* @param {RSA.keyObject} key
* @param password
* @param s2kHash
* @param symmetricEncryptionAlgorithm
* @param timePacket
* @return {body: [string]OpenPGP packet body contents, header: [string] OpenPGP packet header, string: [string] header+body}
*/
function write_private_key(keyType, key, password, s2kHash, symmetricEncryptionAlgorithm, timePacket){
@ -3433,8 +3425,9 @@ function openpgp_packet_keymaterial() {
/*
* same as write_private_key, but has less information because of public key.
* @param keyType [int] follows the OpenPGP algorithm standard, IE 1 corresponds to RSA.
* @param key [RSA.keyObject]
* @param {int} keyType follows the OpenPGP algorithm standard, IE 1 corresponds to RSA.
* @param {RSA.keyObject} key
* @param timePacket
* @return {body: [string]OpenPGP packet body contents, header: [string] OpenPGP packet header, string: [string] header+body}
*/
function write_public_key(keyType, key, timePacket){
@ -9569,6 +9562,12 @@ function openpgp_crypto_generateKeyPair(keyType, numBits, passphrase, s2kHash, s
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* @fileoverview The openpgp base class should provide all of the functionality
* to consume the openpgp.js library. All additional classes are documented
* for extending and developing on top of the base library.
*/
/**
* GPG4Browsers Core interface. A single instance is hold
* from the beginning. To use this library call "openpgp.init()"
@ -10237,7 +10236,6 @@ function openpgp_msg_publickey() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the GPG4Browsers config object
*
* This object contains configuration values and implements
* storing and retrieving configuration them from HTML5 local storage.
@ -10246,6 +10244,8 @@ function openpgp_msg_publickey() {
* using openpgp.config
* Stored config parameters can be accessed using
* openpgp.config.config
* @class
* @classdesc Implementation of the GPG4Browsers config object
*/
function openpgp_config() {
this.config = null;
@ -10265,7 +10265,7 @@ function openpgp_config() {
keyserver: "keyserver.linux.it" // "pgp.mit.edu:11371"
};
this.versionstring ="OpenPGP.js v.1.20120905";
this.versionstring ="OpenPGP.js v.1.20120911";
this.commentstring ="http://openpgpjs.org";
/**
* reads the config out of the HTML5 local storage
@ -10971,12 +10971,9 @@ JXG.decompress = function(str) {return unescape((new JXG.Util.Unzip(JXG.Util.Bas
*/
/**
* @fileoverview Utilities for uncompressing and base64 decoding
*/
/**
* @class Util class
* @classdesc Utilities for uncompressing and base64 decoding
* Class for gunzipping, unzipping and base64 decoding of files.
* It is used for reading GEONExT, Geogebra and Intergeo files.
*
@ -12360,13 +12357,14 @@ function openpgp_msg_message() {
// - MPI = c | d << 8 | e << ((MPI.length -2)*8) | f ((MPI.length -2)*8)
/**
* 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.
* @class
* @classdescImplementation 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.
*/
function openpgp_type_mpi() {
this.MPI = null;
@ -12375,10 +12373,10 @@ function openpgp_type_mpi() {
this.data = null;
/**
* parsing function for a mpi (RFC 4880 3.2).
* @param input [string] payload of mpi data
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_type_mpi] object representation
* @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 {openpgp_type_mpi} object representation
*/
function read(input, position, len) {
var mypos = position;
@ -12407,7 +12405,7 @@ function openpgp_type_mpi() {
/**
* generates debug output (pretty print)
* @return String which gives some information about the mpi
* @return {string} String which gives some information about the mpi
*/
function toString() {
var r = " MPI("+this.mpiBitLength+"b/"+this.mpiByteLength+"B) : 0x";
@ -12417,7 +12415,7 @@ function openpgp_type_mpi() {
/**
* converts the mpi to an BigInteger object
* @return [BigInteger]
* @return {BigInteger}
*/
function getBigInteger() {
return new BigInteger(util.hexstrdump(this.MPI),16);
@ -12432,7 +12430,7 @@ function openpgp_type_mpi() {
/**
* gets the length of the mpi in bytes
* @return [integer] mpi byte length
* @return {integer} mpi byte length
*/
function getByteLength() {
return this.mpiByteLength;
@ -12440,8 +12438,8 @@ function openpgp_type_mpi() {
/**
* creates an mpi from the specified string
* @param data [String] data to read the mpi from
* @return [openpgp_type_mpi]
* @param {String} data data to read the mpi from
* @return {openpgp_type_mpi}
*/
function create(data) {
this.MPI = data;
@ -12452,7 +12450,7 @@ function openpgp_type_mpi() {
/**
* converts the mpi object to a string as specified in RFC4880 3.2
* @return [String] mpi byte representation
* @return {String} mpi byte representation
*/
function toBin() {
var result = String.fromCharCode((this.mpiBitLength >> 8) & 0xFF);
@ -12487,7 +12485,8 @@ function openpgp_type_mpi() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of type key id (RFC4880 3.3)
* @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
@ -12496,8 +12495,8 @@ function openpgp_type_mpi() {
function openpgp_type_keyid() {
/**
* parsing method for a key id
* @param input [String] input to read the key id from
* @param position [integer] position where to start reading the key id from input
* @param {String} input input to read the key id from
* @param {integer} position position where to start reading the key id from input
* @return this object
*/
function read_packet(input, position) {
@ -12507,7 +12506,7 @@ function openpgp_type_keyid() {
/**
* generates debug output (pretty print)
* @return [String] Key Id as hexadecimal string
* @return {String} Key Id as hexadecimal string
*/
function toString() {
return util.hexstrdump(this.bytes);
@ -12534,7 +12533,8 @@ function openpgp_type_keyid() {
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the String-to-key specifier (RFC4880 3.7)
* @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
@ -12544,9 +12544,9 @@ function openpgp_type_keyid() {
function openpgp_type_s2k() {
/**
* parsing function for a string-to-key specifier (RFC 4880 3.7).
* @param input [string] payload of string-to-key specifier
* @param position [integer] position to start reading from the input string
* @return [openpgp_type_s2k] object representation
* @param {string} input payload of string-to-key specifier
* @param {integer} position position to start reading from the input string
* @return {openpgp_type_s2k} object representation
*/
function read(input, position) {
var mypos = position;
@ -12594,7 +12594,7 @@ function openpgp_type_s2k() {
/**
* writes an s2k hash based on the inputs.
* @return [String] produced key of hashAlgorithm hash length
* @return {String} produced key of hashAlgorithm hash length
*/
function write(type, hash, passphrase, salt, c){
this.type = type;
@ -12608,8 +12608,8 @@ function openpgp_type_s2k() {
/**
* produces a key using the specified passphrase and the defined hashAlgorithm
* @param passphrase [String] passphrase containing user input
* @return [String] produced key with a length corresponding to hashAlgorithm hash length
* @param passphrase {String} passphrase containing user input
* @return {String} produced key with a length corresponding to hashAlgorithm hash length
*/
function produce_key(passphrase, numBytes) {
if (this.type == 0) {

2
resources/openpgp.min.js vendored
View File

@ -391,7 +391,7 @@ return this.len=b-c};this.write=function(){};this.toString=function(){for(var b=
this.subKeys.length;a++)b+=" "+this.subKeys[a].toString();return b};this.validate=function(){for(var b=0;b<this.revocationSignatures.length;b++)if(this.revocationSignatures[b].verify(this.publicKeyPacket.header+this.publicKeyPacket.data,this.publicKeyPacket))return!1;if(0!=this.subKeys.length){for(var a=!1,b=0;b<this.subKeys.length;b++)if(3==this.subKeys[b].verifyKey()){a=!0;break}if(!a)return!1}a=!1;for(b=0;b<this.userIds.length;b++)if(0==this.userIds[b].verify(this.publicKeyPacket)){a=!0;break}return!a?
!1:!0};this.getFingerprint=function(){return this.publicKeyPacket.getFingerprint()};this.getKeyId=function(){return this.publicKeyPacket.getKeyId()};this.verifyBasicSignatures=function(){for(var b=0;b<this.revocationSignatures.length;)return this.revocationSignatures[b].verify(this.publicKeyPacket.header+this.publicKeyPacket.data,this.publicKeyPacket),!1;if(0!=this.subKeys.length){for(var a=!1,b=0;b<this.subKeys.length;b++)if(null!=this.subKeys[b]&&3==this.subKeys[b].verifyKey()){a=!0;break}if(!a)return!1}a=
this.getKeyId();for(b=0;b<this.userIds.length;b++)for(var c=0;c<this.userIds[b].certificationRevocationSignatures.length;c++)if(this.userIds[b].certificationSignatures[c].getIssuer==a&&4!=this.userIds[b].certificationSignatures[c].verifyBasic(this.publicKeyPacket))return!1;return!0}}
function openpgp_config(){this.config=null;this.default_config={prefer_hash_algorithm:2,encryption_cipher:9,compression:1,show_version:!0,show_comment:!0,integrity_protect:!0,composition_behavior:0,keyserver:"keyserver.linux.it"};this.versionstring="OpenPGP.js v.1.20120905";this.commentstring="http://openpgpjs.org";this.debug=!1;this.read=function(){var b=JSON.parse(window.localStorage.getItem("config"));null==b?(this.config=this.default_config,this.write()):this.config=b};this.write=function(){window.localStorage.setItem("config",
function openpgp_config(){this.config=null;this.default_config={prefer_hash_algorithm:2,encryption_cipher:9,compression:1,show_version:!0,show_comment:!0,integrity_protect:!0,composition_behavior:0,keyserver:"keyserver.linux.it"};this.versionstring="OpenPGP.js v.1.20120911";this.commentstring="http://openpgpjs.org";this.debug=!1;this.read=function(){var b=JSON.parse(window.localStorage.getItem("config"));null==b?(this.config=this.default_config,this.write()):this.config=b};this.write=function(){window.localStorage.setItem("config",
JSON.stringify(this.config))}}
function openpgp_msg_privatekey(){this.subKeys=[];this.privateKeyPacket=null;this.userIds=[];this.userAttributes=[];this.revocationSignatures=[];this.subKeys=[];this.extractPublicKey=function(){for(var b=this.privateKeyPacket.publicKey.header+this.privateKeyPacket.publicKey.data,a=0;a<this.userIds.length;a++){if(0===this.userIds[a].certificationSignatures.length)return util.print_error("extractPublicKey - missing certification signatures"),null;for(var c=new openpgp_packet_userid,b=b+c.write_packet(this.userIds[a].text),
c=0;c<this.userIds[a].certificationSignatures.length;c++)var d=this.userIds[a].certificationSignatures[c],b=b+(openpgp_packet.write_packet_header(2,d.data.length)+d.data)}for(a=0;a<this.subKeys.length;a++)if(c=this.subKeys[a].publicKey,b+=openpgp_packet.write_old_packet_header(14,c.data.length)+c.data,c=this.subKeys[a].subKeySignature,null!==c)b+=openpgp_packet.write_packet_header(2,c.data.length)+c.data;else return util.print_error("extractPublicKey - missing subkey signature"),null;return openpgp_encoding_armor(4,

5
src/compression/zlib/jsxcompressor.js
View File

@ -21,12 +21,9 @@ JXG.decompress = function(str) {return unescape((new JXG.Util.Unzip(JXG.Util.Bas
*/
/**
* @fileoverview Utilities for uncompressing and base64 decoding
*/
/**
* @class Util class
* @classdesc Utilities for uncompressing and base64 decoding
* Class for gunzipping, unzipping and base64 decoding of files.
* It is used for reading GEONExT, Geogebra and Intergeo files.
*

3
src/config/openpgp.config.js
View File

@ -16,7 +16,6 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the GPG4Browsers config object
*
* This object contains configuration values and implements
* storing and retrieving configuration them from HTML5 local storage.
@ -25,6 +24,8 @@
* using openpgp.config
* Stored config parameters can be accessed using
* openpgp.config.config
* @class
* @classdesc Implementation of the GPG4Browsers config object
*/
function openpgp_config() {
this.config = null;

6
src/openpgp.js
View File

@ -15,6 +15,12 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* @fileoverview The openpgp base class should provide all of the functionality
* to consume the openpgp.js library. All additional classes are documented
* for extending and developing on top of the base library.
*/
/**
* GPG4Browsers Core interface. A single instance is hold
* from the beginning. To use this library call "openpgp.init()"

27
src/packet/openpgp.packet.compressed.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Compressed Data Packet (Tag 8)
* @class
* @classdesc Implementation of the Compressed Data Packet (Tag 8)
*
* RFC4880 5.6:
* The Compressed Data packet contains compressed data. Typically, this
@ -29,10 +30,10 @@ function openpgp_packet_compressed() {
/**
* parsing function for the packet.
* @param input [string] payload of a tag 8 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_compressed] object representation
* @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 {openpgp_packet_compressed} object representation
*/
function read_packet (input, position, len) {
this.packetLength = len;
@ -46,7 +47,7 @@ function openpgp_packet_compressed() {
/**
* decompression method for decompressing the compressed data
* read by read_packet
* @return [String] the decompressed data
* @return {String} the decompressed data
*/
function decompress() {
if (this.decompressedData != null)
@ -100,9 +101,9 @@ function openpgp_packet_compressed() {
/**
* Compress the packet data (member decompressedData)
* @param type [integer] algorithm to be used // See RFC 4880 9.3
* @param data [String] data to be compressed
* @return [String] The compressed data stored in attribute compressedData
* @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
*/
function compress(type, data) {
this.type = type;
@ -132,9 +133,9 @@ function openpgp_packet_compressed() {
/**
* creates a string representation of the packet
* @param algorithm [integer] algorithm to be used // See RFC 4880 9.3
* @param data [String] data to be compressed
* @return [String] string-representation of the packet
* @param {integer} algorithm algorithm to be used // See RFC 4880 9.3
* @param {String} data data to be compressed
* @return {String} string-representation of the packet
*/
function write_packet(algorithm, data) {
this.decompressedData = data;
@ -147,7 +148,7 @@ function openpgp_packet_compressed() {
/**
* pretty printing the packet (useful for debug purposes)
* @return [String]
* @return {String}
*/
function toString() {
return '5.6. Compressed Data Packet (Tag 8)\n'+

33
src/packet/openpgp.packet.encrypteddata.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Symmetrically Encrypted Data Packet (Tag 9)
* @class
* @classdesc 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
@ -34,14 +35,11 @@ function openpgp_packet_encrypteddata() {
/**
* parsing function for the packet.
*
* @param input
* [string] payload of a tag 9 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 9 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
var mypos = position;
@ -55,10 +53,10 @@ function openpgp_packet_encrypteddata() {
/**
* symmetrically decrypt the packet data
*
* @param symmetric_algorithm_type
* [integer] symmetric key algorithm to use // See RFC4880 9.2
* @param key
* [String] key as string with the corresponding length to the
* @param {integer} symmetric_algorithm_type
* symmetric key algorithm to use // See RFC4880 9.2
* @param {String} key
* key as string with the corresponding length to the
* algorithm
* @return the decrypted data;
*/
@ -73,14 +71,11 @@ function openpgp_packet_encrypteddata() {
/**
* Creates a string representation of the packet
*
* @param algo
* [Integer] symmetric key algorithm to use // See RFC4880 9.2
* @param key
* [String] key as string with the corresponding length to the
* @param {Integer} algo symmetric key algorithm to use // See RFC4880 9.2
* @param {String} key key as string with the corresponding length to the
* algorithm
* @param data
* [String] data to be
* @return [String] string-representation of the packet
* @param {String} data data to be
* @return {String} string-representation of the packet
*/
function write_packet(algo, key, data) {
var result = "";

31
src/packet/openpgp.packet.encryptedintegrityprotecteddata.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Sym. Encrypted Integrity Protected Data Packet (Tag 18)
* @class
* @classdesc 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
@ -35,14 +36,12 @@ function openpgp_packet_encryptedintegrityprotecteddata() {
/**
* parsing function for the packet.
*
* @param input
* [string] payload of a tag 18 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 18 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 [openpgp_packet_encryptedintegrityprotecteddata] object
* @return {openpgp_packet_encryptedintegrityprotecteddata} object
* representation
*/
function read_packet(input, position, len) {
@ -73,11 +72,9 @@ function openpgp_packet_encryptedintegrityprotecteddata() {
* Creates a string representation of a Sym. Encrypted Integrity Protected
* Data Packet (tag 18) (see RFC4880 5.13)
*
* @param symmetric_algorithm
* [integer] the selected symmetric encryption algorithm to be
* used
* @param key
* [String] the key of cipher blocksize length to be used
* @param {integer} symmetric_algorithm
* the selected symmetric encryption algorithm to be used
* @param {String} key the key of cipher blocksize length to be used
* @param data
* plaintext data to be encrypted within the packet
* @return a string representation of the packet
@ -110,11 +107,9 @@ function openpgp_packet_encryptedintegrityprotecteddata() {
* Decrypts the encrypted data contained in this object read_packet must
* have been called before
*
* @param symmetric_algorithm_type
* [integer] the selected symmetric encryption algorithm to be
* used
* @param key
* [String] the key of cipher blocksize length to be used
* @param {integer} symmetric_algorithm_type
* the selected symmetric encryption algorithm to be used
* @param {String} key the key of cipher blocksize length to be used
* @return the decrypted data of this packet
*/
function decrypt(symmetric_algorithm_type, key) {

67
src/packet/openpgp.packet.encryptedsessionkey.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Public-Key Encrypted Session Key Packets (Tag 1)
* @class
* @classdesc 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
@ -35,14 +36,11 @@ function openpgp_packet_encryptedsessionkey() {
/**
* parsing function for a publickey encrypted session key packet (tag 1).
*
* @param input
* [string] payload of a tag 1 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 1 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_pub_key_packet(input, position, len) {
this.tagType = 1;
@ -87,23 +85,19 @@ function openpgp_packet_encryptedsessionkey() {
/**
* create a string representation of a tag 1 packet
*
* @param publicKeyId
* [String] the public key id corresponding to publicMPIs key as
* string
* @param publicMPIs
* [Array[openpgp_type_mpi]] multiprecision integer objects
* describing the public key
* @param pubalgo
* [integer] the corresponding public key algorithm // See
* RFC4880 9.1
* @param symmalgo
* [integer] the symmetric cipher algorithm used to encrypt the
* data within an encrypteddatapacket or
* encryptedintegrityprotecteddatapacket following this packet //
* See RFC4880 9.2
* @param sessionkey
* [String] a string of randombytes representing the session key
* @return [String] the string representation
* @param {String} publicKeyId
* the public key id corresponding to publicMPIs key as string
* @param {Array[openpgp_type_mpi]} publicMPIs
* multiprecision integer objects describing the public key
* @param {integer} pubalgo
* the corresponding public key algorithm // See RFC4880 9.1
* @param {integer} symmalgo
* the symmetric cipher algorithm used to encrypt the data within
* an encrypteddatapacket or encryptedintegrityprotecteddatapacket
* following this packet //See RFC4880 9.2
* @param {String} sessionkey
* a string of randombytes representing the session key
* @return {String} the string representation
*/
function write_pub_key_packet(publicKeyId, publicMPIs, pubalgo, symmalgo,
sessionkey) {
@ -129,14 +123,12 @@ function openpgp_packet_encryptedsessionkey() {
/**
* parsing function for a symmetric encrypted session key packet (tag 3).
*
* @param input
* [string] payload of a tag 1 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 1 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_symmetric_key_packet(input, position, len) {
this.tagType = 3;
@ -164,12 +156,11 @@ function openpgp_packet_encryptedsessionkey() {
* Decrypts the session key (only for public key encrypted session key
* packets (tag 1)
*
* @param msg
* [openpgp_msg_message] the message object (with member
* encryptedData
* @param key
* [openpgp_msg_privatekey] private key with secMPIs unlocked
* @return [String] the unencrypted session key
* @param {openpgp_msg_message} msg
* the message object (with member encryptedData
* @param {openpgp_msg_privatekey} key
* private key with secMPIs unlocked
* @return {String} the unencrypted session key
*/
function decrypt(msg, key) {
if (this.tagType == 1) {

37
src/packet/openpgp.packet.js
View File

@ -15,14 +15,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
/**
* @class
* @classdesc Parent openpgp packet class. Operations focus on determining packet types
* and packet header.
*/
function _openpgp_packet() {
/**
* Encodes a given integer of length to the openpgp length specifier to a
* string
*
* @param length
* [Integer] of the length to encode
* @return string with openpgp length representation
* @param {Integer} length of the length to encode
* @return {string} string with openpgp length representation
*/
function encode_length(length) {
result = "";
@ -50,11 +54,9 @@ function _openpgp_packet() {
* Writes a packet header version 4 with the given tag_type and length to a
* string
*
* @param tag_type
* integer of tag type
* @param length
* integer length of the payload
* @return string of the header
* @param {integer} tag_type tag type
* @param {integer} length length of the payload
* @return {string} string of the header
*/
function write_packet_header(tag_type, length) {
/* we're only generating v4 packet headers here */
@ -68,11 +70,9 @@ function _openpgp_packet() {
* Writes a packet header Version 3 with the given tag_type and length to a
* string
*
* @param tag_type
* integer of tag type
* @param length
* integer length of the payload
* @return string of the header
* @param {integer} tag_type tag type
* @param {integer} length length of the payload
* @return {string} string of the header
*/
function write_old_packet_header(tag_type, length) {
var result = "";
@ -97,13 +97,10 @@ function _openpgp_packet() {
/**
* Generic static Packet Parser function
*
* @param input
* [String] input stream as string
* @param position
* [integer] position to start parsing
* @param len
* [integer] length of the input from position on
* @return [openpgp_packet_*] returns a parsed openpgp_packet
* @param {String} input input stream as string
* @param {integer} position position to start parsing
* @param {integer} len length of the input from position on
* @return {openpgp_packet_*} returns a parsed openpgp_packet
*/
function read_packet(input, position, len) {
// some sanity checks

30
src/packet/openpgp.packet.keymaterial.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Key Material Packet (Tag 5,6,7,14)
* @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
@ -545,11 +546,11 @@ function openpgp_packet_keymaterial() {
/**
* Continue parsing packets belonging to the key material such as signatures
* @param parent_node [openpgp_*] the parent object
* @param input [String] input string to read the packet(s) from
* @param position [integer] start position for the parser
* @param len [integer] length of the packet(s) or remaining length of input
* @return [integer] length of nodes read
* @param {openpgp_*} parent_node the parent object
* @param {String} input input string to read the packet(s) from
* @param {integer} position start position for the parser
* @param {integer} len length of the packet(s) or remaining length of input
* @return {integer} length of nodes read
*/
function read_nodes(parent_node, input, position, len) {
this.parentNode = parent_node;
@ -657,7 +658,7 @@ function openpgp_packet_keymaterial() {
/**
* calculates the key id of they key
* @return [String] a 8 byte key id
* @return {String} a 8 byte key id
*/
function getKeyId() {
if (this.version == 4) {
@ -672,7 +673,7 @@ function openpgp_packet_keymaterial() {
/**
* calculates the fingerprint of the key
* @return [String] a string containing the fingerprint
* @return {String} a string containing the fingerprint
*/
function getFingerprint() {
if (this.version == 4) {
@ -687,8 +688,12 @@ function openpgp_packet_keymaterial() {
/*
* creates an OpenPGP key packet for the given key. much TODO in regards to s2k, subkeys.
* @param keyType [int] follows the OpenPGP algorithm standard, IE 1 corresponds to RSA.
* @param key [RSA.keyObject]
* @param {int} keyType follows the OpenPGP algorithm standard, IE 1 corresponds to RSA.
* @param {RSA.keyObject} key
* @param password
* @param s2kHash
* @param symmetricEncryptionAlgorithm
* @param timePacket
* @return {body: [string]OpenPGP packet body contents, header: [string] OpenPGP packet header, string: [string] header+body}
*/
function write_private_key(keyType, key, password, s2kHash, symmetricEncryptionAlgorithm, timePacket){
@ -764,8 +769,9 @@ function openpgp_packet_keymaterial() {
/*
* same as write_private_key, but has less information because of public key.
* @param keyType [int] follows the OpenPGP algorithm standard, IE 1 corresponds to RSA.
* @param key [RSA.keyObject]
* @param {int} keyType follows the OpenPGP algorithm standard, IE 1 corresponds to RSA.
* @param {RSA.keyObject} key
* @param timePacket
* @return {body: [string]OpenPGP packet body contents, header: [string] OpenPGP packet header, string: [string] header+body}
*/
function write_public_key(keyType, key, timePacket){

23
src/packet/openpgp.packet.literaldata.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Literal Data Packet (Tag 11)
* @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.
@ -27,14 +28,13 @@ function openpgp_packet_literaldata() {
/**
* parsing function for a literal data packet (tag 11).
*
* @param input
* [string] payload of a tag 11 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 11 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.packetLength = len;
@ -53,9 +53,8 @@ function openpgp_packet_literaldata() {
/**
* Creates a string representation of the packet
*
* @param data
* [String] the data to be inserted as body
* @return [String] string-representation of the packet
* @param {String} data the data to be inserted as body
* @return {String} string-representation of the packet
*/
function write_packet(data) {
data = data.replace(/\r\n/g, "\n").replace(/\n/g, "\r\n");
@ -83,7 +82,7 @@ function openpgp_packet_literaldata() {
/**
* generates debug output (pretty print)
*
* @return String which gives some information about the keymaterial
* @return {string} String which gives some information about the keymaterial
*/
function toString() {
return '5.9. Literal Data Packet (Tag 11)\n' + ' length: '

20
src/packet/openpgp.packet.marker.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the strange "Marker packet" (Tag 10)
* @class
* @classdesc 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
@ -30,14 +31,13 @@ function openpgp_packet_marker() {
/**
* parsing function for a literal data packet (tag 10).
*
* @param input
* [string] payload of a tag 10 packet
* @param position
* [integer] position to start reading from the input string
* @param len
* [integer] length of the packet or the remaining length of
* @param {string} input payload of a tag 10 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.packetLength = 3;
@ -52,7 +52,7 @@ function openpgp_packet_marker() {
/**
* Generates Debug output
*
* @return String which gives some information about the keymaterial
* @return {string} String which gives some information about the keymaterial
*/
function toString() {
return "5.8. Marker Packet (Obsolete Literal Packet) (Tag 10)\n"
@ -61,4 +61,4 @@ function openpgp_packet_marker() {
this.read_packet = read_packet;
this.toString = toString;
}
}

18
src/packet/openpgp.packet.modificationdetectioncode.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Modification Detection Code Packet (Tag 19)
* @class
* @classdesc Implementation of the Modification Detection Code Packet (Tag 19)
*
* RFC4880 5.14: The Modification Detection Code packet contains a SHA-1 hash of
* plaintext data, which is used to detect message modification. It is only used
@ -32,14 +33,13 @@ function openpgp_packet_modificationdetectioncode() {
/**
* parsing function for a modification detection code packet (tag 19).
*
* @param input
* [String] payload of a tag 19 packet
* @param position
* [Integer] position to start reading from the input string
* @param len
* [Integer] length of the packet or the remaining length of
* @param {String} input payload of a tag 19 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 [openpgp_packet_encrypteddata] object representation
* @return {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.packetLength = len;
@ -67,7 +67,7 @@ function openpgp_packet_modificationdetectioncode() {
/**
* generates debug output (pretty print)
*
* @return String which gives some information about the modification
* @return {string} String which gives some information about the modification
* detection code
*/
function toString() {

27
src/packet/openpgp.packet.onepasssignature.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the One-Pass Signature Packets (Tag 4)
* @class
* @classdesc Implementation of the One-Pass Signature Packets (Tag 4)
*
* RFC4880 5.4:
* The One-Pass Signature packet precedes the signed data and contains
@ -36,10 +37,10 @@ function openpgp_packet_onepasssignature() {
/**
* parsing function for a one-pass signature packet (tag 4).
* @param input [string] payload of a tag 4 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_encrypteddata] object representation
* @param {string} input payload of a tag 4 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 {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.packetLength = len;
@ -71,14 +72,14 @@ function openpgp_packet_onepasssignature() {
/**
* creates a string representation of a one-pass signature packet
* @param type [integer] Signature types as described in RFC4880 Section 5.2.1.
* @param hashalgorithm [integer] the hash algorithm used within the signature
* @param privatekey [openpgp_msg_privatekey] the private key used to generate the signature
* @param length [integer] length of data to be signed
* @param nested [boolean] boolean showing whether the signature is nested.
* @param {integer} type Signature types as described in RFC4880 Section 5.2.1.
* @param {integer} hashalgorithm the hash algorithm used within the signature
* @param {openpgp_msg_privatekey} privatekey the private key used to generate the signature
* @param {integer} length length of data to be signed
* @param {boolean} nested boolean showing whether the signature is nested.
* "true" indicates that the next packet is another One-Pass Signature packet
* that describes another signature to be applied to the same message data.
* @return [String] a string representation of a one-pass signature packet
* @return {String} a string representation of a one-pass signature packet
*/
function write_packet(type, hashalgorithm, privatekey,length, nested) {
var result ="";
@ -99,7 +100,7 @@ function openpgp_packet_onepasssignature() {
/**
* generates debug output (pretty print)
* @return String which gives some information about the one-pass signature packet
* @return {string} String which gives some information about the one-pass signature packet
*/
function toString() {
return '5.4. One-Pass Signature Packets (Tag 4)\n'+
@ -115,4 +116,4 @@ function openpgp_packet_onepasssignature() {
this.read_packet = read_packet;
this.toString = toString;
this.write_packet = write_packet;
};
};

29
src/packet/openpgp.packet.signature.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the Signature Packet (Tag 2)
* @class
* @classdesc Implementation of the Signature Packet (Tag 2)
*
* RFC4480 5.2:
* A Signature packet describes a binding between some public key and
@ -68,10 +69,10 @@ function openpgp_packet_signature() {
/**
* parsing function for a signature packet (tag 2).
* @param input [string] payload of a tag 2 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_encrypteddata] object representation
* @param {string} input payload of a tag 2 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 {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.data = input.substring (position, position+len);
@ -208,10 +209,10 @@ function openpgp_packet_signature() {
/**
* creates a string representation of a message signature packet (tag 2).
* This can be only used on text data
* @param signature_type [integer] should be 1 (one)
* @param data [String] data to be signed
* @param privatekey [openpgp_msg_privatekey] private key used to sign the message. (secMPIs MUST be unlocked)
* @return string representation of a signature packet
* @param {integer} signature_type should be 1 (one)
* @param {String} data data to be signed
* @param {openpgp_msg_privatekey} privatekey private key used to sign the message. (secMPIs MUST be unlocked)
* @return {string} string representation of a signature packet
*/
function write_message_signature(signature_type, data, privatekey) {
var publickey = privatekey.privateKeyPacket.publicKey;
@ -254,9 +255,9 @@ function openpgp_packet_signature() {
}
/**
* creates a string representation of a sub signature packet (See RFC 4880 5.2.3.1)
* @param type [integer] subpacket signature type. Signature types as described in RFC4880 Section 5.2.3.2
* @param data [String] data to be included
* @return [String] a string-representation of a sub signature packet (See RFC 4880 5.2.3.1)
* @param {integer} type subpacket signature type. Signature types as described in RFC4880 Section 5.2.3.2
* @param {String} data data to be included
* @return {String} a string-representation of a sub signature packet (See RFC 4880 5.2.3.1)
*/
function write_sub_signature_packet(type, data) {
var result = "";
@ -662,7 +663,7 @@ function openpgp_packet_signature() {
}
/**
* generates debug output (pretty print)
* @return String which gives some information about the signature packet
* @return {string} String which gives some information about the signature packet
*/
function toString () {
@ -721,7 +722,7 @@ function openpgp_packet_signature() {
/**
* gets the issuer key id of this signature
* @return [String] issuer key id as string (8bytes)
* @return {String} issuer key id as string (8bytes)
*/
function getIssuer() {
if (this.version == 4)

24
src/packet/openpgp.packet.userattribute.js
View File

@ -16,6 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* @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
@ -39,10 +41,10 @@ function openpgp_packet_userattribute() {
/**
* parsing function for a user attribute packet (tag 17).
* @param input [string] payload of a tag 17 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_encrypteddata] object representation
* @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 {openpgp_packet_encrypteddata} object representation
*/
function read_packet (input, position, len) {
var total_len = 0;
@ -87,7 +89,7 @@ function openpgp_packet_userattribute() {
/**
* generates debug output (pretty print)
* @return String which gives some information about the user attribute packet
* @return {string} String which gives some information about the user attribute packet
*/
function toString() {
var result = '5.12. User Attribute Packet (Tag 17)\n'+
@ -100,11 +102,11 @@ function openpgp_packet_userattribute() {
/**
* Continue parsing packets belonging to the user attribute packet such as signatures
* @param parent_node [openpgp_*] the parent object
* @param input [String] input string to read the packet(s) from
* @param position [integer] start position for the parser
* @param len [integer] length of the packet(s) or remaining length of input
* @return [integer] length of nodes read
* @param {openpgp_*} parent_node the parent object
* @param {String} input input string to read the packet(s) from
* @param {integer} position start position for the parser
* @param {integer} len length of the packet(s) or remaining length of input
* @return {integer} length of nodes read
*/
function read_nodes(parent_node, input, position, len) {
@ -150,4 +152,4 @@ function openpgp_packet_userattribute() {
this.read_nodes = read_nodes;
this.toString = toString;
};
};

28
src/packet/openpgp.packet.userid.js
View File

@ -16,6 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* @class
* @classdesc 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
@ -32,10 +34,10 @@ function openpgp_packet_userid() {
/**
* parsing function for a user id packet (tag 13).
* @param input [string] payload of a tag 13 packet
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_packet_encrypteddata] object representation
* @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 {openpgp_packet_encrypteddata} object representation
*/
function read_packet(input, position, len) {
this.text = '';
@ -49,8 +51,8 @@ function openpgp_packet_userid() {
/**
* creates a string representation of the user id packet
* @param user_id [String] the user id as string ("John Doe <john.doe@mail.us")
* @return [String] string representation
* @param {String} user_id the user id as string ("John Doe <john.doe@mail.us")
* @return {String} string representation
*/
function write_packet(user_id) {
this.text = user_id;
@ -61,11 +63,11 @@ function openpgp_packet_userid() {
/**
* Continue parsing packets belonging to the userid packet such as signatures
* @param parent_node [openpgp_*] the parent object
* @param input [String] input string to read the packet(s) from
* @param position [integer] start position for the parser
* @param len [integer] length of the packet(s) or remaining length of input
* @return [integer] length of nodes read
* @param {openpgp_*} parent_node the parent object
* @param {String} input input string to read the packet(s) from
* @param {integer} position start position for the parser
* @param {integer} len length of the packet(s) or remaining length of input
* @return {integer} length of nodes read
*/
function read_nodes(parent_node, input, position, len) {
if (parent_node.tagType == 6) { // public key
@ -145,7 +147,7 @@ function openpgp_packet_userid() {
/**
* generates debug output (pretty print)
* @return String which gives some information about the user id packet
* @return {string} String which gives some information about the user id packet
*/
function toString() {
var result = ' 5.11. User ID Packet (Tag 13)\n' + ' text ('
@ -164,7 +166,7 @@ function openpgp_packet_userid() {
/**
* lookup function to find certification revocation signatures
* @param keyId string containing the key id of the issuer of this signature
* @param {string} keyId string containing the key id of the issuer of this signature
* @return a CertificationRevocationSignature if found; otherwise null
*/
function hasCertificationRevocationSignature(keyId) {

9
src/type/openpgp.type.keyid.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of type key id (RFC4880 3.3)
* @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
@ -25,8 +26,8 @@
function openpgp_type_keyid() {
/**
* parsing method for a key id
* @param input [String] input to read the key id from
* @param position [integer] position where to start reading the key id from input
* @param {String} input input to read the key id from
* @param {integer} position position where to start reading the key id from input
* @return this object
*/
function read_packet(input, position) {
@ -36,7 +37,7 @@ function openpgp_type_keyid() {
/**
* generates debug output (pretty print)
* @return [String] Key Id as hexadecimal string
* @return {String} Key Id as hexadecimal string
*/
function toString() {
return util.hexstrdump(this.bytes);

35
src/type/openpgp.type.mpi.js
View File

@ -21,13 +21,14 @@
// - MPI = c | d << 8 | e << ((MPI.length -2)*8) | f ((MPI.length -2)*8)
/**
* 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.
* @class
* @classdescImplementation 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.
*/
function openpgp_type_mpi() {
this.MPI = null;
@ -36,10 +37,10 @@ function openpgp_type_mpi() {
this.data = null;
/**
* parsing function for a mpi (RFC 4880 3.2).
* @param input [string] payload of mpi data
* @param position [integer] position to start reading from the input string
* @param len [integer] length of the packet or the remaining length of input at position
* @return [openpgp_type_mpi] object representation
* @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 {openpgp_type_mpi} object representation
*/
function read(input, position, len) {
var mypos = position;
@ -68,7 +69,7 @@ function openpgp_type_mpi() {
/**
* generates debug output (pretty print)
* @return String which gives some information about the mpi
* @return {string} String which gives some information about the mpi
*/
function toString() {
var r = " MPI("+this.mpiBitLength+"b/"+this.mpiByteLength+"B) : 0x";
@ -78,7 +79,7 @@ function openpgp_type_mpi() {
/**
* converts the mpi to an BigInteger object
* @return [BigInteger]
* @return {BigInteger}
*/
function getBigInteger() {
return new BigInteger(util.hexstrdump(this.MPI),16);
@ -93,7 +94,7 @@ function openpgp_type_mpi() {
/**
* gets the length of the mpi in bytes
* @return [integer] mpi byte length
* @return {integer} mpi byte length
*/
function getByteLength() {
return this.mpiByteLength;
@ -101,8 +102,8 @@ function openpgp_type_mpi() {
/**
* creates an mpi from the specified string
* @param data [String] data to read the mpi from
* @return [openpgp_type_mpi]
* @param {String} data data to read the mpi from
* @return {openpgp_type_mpi}
*/
function create(data) {
this.MPI = data;
@ -113,7 +114,7 @@ function openpgp_type_mpi() {
/**
* converts the mpi object to a string as specified in RFC4880 3.2
* @return [String] mpi byte representation
* @return {String} mpi byte representation
*/
function toBin() {
var result = String.fromCharCode((this.mpiBitLength >> 8) & 0xFF);

15
src/type/openpgp.type.s2k.js
View File

@ -16,7 +16,8 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
/**
* Implementation of the String-to-key specifier (RFC4880 3.7)
* @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
@ -26,9 +27,9 @@
function openpgp_type_s2k() {
/**
* parsing function for a string-to-key specifier (RFC 4880 3.7).
* @param input [string] payload of string-to-key specifier
* @param position [integer] position to start reading from the input string
* @return [openpgp_type_s2k] object representation
* @param {string} input payload of string-to-key specifier
* @param {integer} position position to start reading from the input string
* @return {openpgp_type_s2k} object representation
*/
function read(input, position) {
var mypos = position;
@ -76,7 +77,7 @@ function openpgp_type_s2k() {
/**
* writes an s2k hash based on the inputs.
* @return [String] produced key of hashAlgorithm hash length
* @return {String} produced key of hashAlgorithm hash length
*/
function write(type, hash, passphrase, salt, c){
this.type = type;
@ -90,8 +91,8 @@ function openpgp_type_s2k() {
/**
* produces a key using the specified passphrase and the defined hashAlgorithm
* @param passphrase [String] passphrase containing user input
* @return [String] produced key with a length corresponding to hashAlgorithm hash length
* @param passphrase {String} passphrase containing user input
* @return {String} produced key with a length corresponding to hashAlgorithm hash length
*/
function produce_key(passphrase, numBytes) {
if (this.type == 0) {