23295342fc
work correctly with utf8 strings. Fixeda visibility issue with the testing suite and added relevant unit tests.
214 lines
13 KiB
HTML
214 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: packet/openpgp.packet.compressed.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: packet/openpgp.packet.compressed.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source"><code>// GPG4Browsers - An OpenPGP implementation in javascript
|
|
// Copyright (C) 2011 Recurity Labs GmbH
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 2.1 of the License, or (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
/**
|
|
* @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.
|
|
*/
|
|
function openpgp_packet_compressed() {
|
|
this.tagType = 8;
|
|
this.decompressedData = 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 {openpgp_packet_compressed} Object representation
|
|
*/
|
|
function read_packet (input, position, len) {
|
|
this.packetLength = len;
|
|
var mypos = position;
|
|
// One octet that gives the algorithm used to compress the packet.
|
|
this.type = input.charCodeAt(mypos++);
|
|
// Compressed data, which makes up the remainder of the packet.
|
|
this.compressedData = input.substring(position+1, position+len);
|
|
return this;
|
|
}
|
|
/**
|
|
* Decompression method for decompressing the compressed data
|
|
* read by read_packet
|
|
* @return {String} The decompressed data
|
|
*/
|
|
function decompress() {
|
|
if (this.decompressedData != null)
|
|
return this.decompressedData;
|
|
|
|
if (this.type == null)
|
|
return null;
|
|
|
|
switch (this.type) {
|
|
case 0: // - Uncompressed
|
|
this.decompressedData = this.compressedData;
|
|
break;
|
|
case 1: // - ZIP [RFC1951]
|
|
util.print_info('Decompressed packet [Type 1-ZIP]: ' + this.toString());
|
|
var compData = this.compressedData;
|
|
var radix = s2r(compData).replace(/\n/g,"");
|
|
// no header in this case, directly call deflate
|
|
var jxg_obj = new JXG.Util.Unzip(JXG.Util.Base64.decodeAsArray(radix));
|
|
this.decompressedData = unescape(jxg_obj.deflate()[0][0]);
|
|
break;
|
|
case 2: // - ZLIB [RFC1950]
|
|
util.print_info('Decompressed packet [Type 2-ZLIB]: ' + this.toString());
|
|
var compressionMethod = this.compressedData.charCodeAt(0) % 0x10; //RFC 1950. Bits 0-3 Compression Method
|
|
//Bits 4-7 RFC 1950 are LZ77 Window. Generally this value is 7 == 32k window size.
|
|
//2nd Byte in RFC 1950 is for "FLAGs" Allows for a Dictionary (how is this defined). Basic checksum, and compression level.
|
|
if (compressionMethod == 8) { //CM 8 is for DEFLATE, RFC 1951
|
|
// remove 4 bytes ADLER32 checksum from the end
|
|
var compData = this.compressedData.substring(0, this.compressedData.length - 4);
|
|
var radix = s2r(compData).replace(/\n/g,"");
|
|
//TODO check ADLER32 checksum
|
|
this.decompressedData = JXG.decompress(radix);
|
|
break;
|
|
} else {
|
|
util.print_error("Compression algorithm ZLIB only supports DEFLATE compression method.");
|
|
}
|
|
break;
|
|
case 3: // - BZip2 [BZ2]
|
|
// TODO: need to implement this
|
|
util.print_error("Compression algorithm BZip2 [BZ2] is not implemented.");
|
|
break;
|
|
default:
|
|
util.print_error("Compression algorithm unknown :"+this.type);
|
|
break;
|
|
}
|
|
util.print_debug("decompressed:"+util.hexstrdump(this.decompressedData));
|
|
return this.decompressedData;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
function compress(type, data) {
|
|
this.type = type;
|
|
this.decompressedData = data;
|
|
switch (this.type) {
|
|
case 0: // - Uncompressed
|
|
this.compressedData = this.decompressedData;
|
|
break;
|
|
case 1: // - ZIP [RFC1951]
|
|
util.print_error("Compression algorithm ZIP [RFC1951] is not implemented.");
|
|
break;
|
|
case 2: // - ZLIB [RFC1950]
|
|
// TODO: need to implement this
|
|
util.print_error("Compression algorithm ZLIB [RFC1950] is not implemented.");
|
|
break;
|
|
case 3: // - BZip2 [BZ2]
|
|
// TODO: need to implement this
|
|
util.print_error("Compression algorithm BZip2 [BZ2] is not implemented.");
|
|
break;
|
|
default:
|
|
util.print_error("Compression algorithm unknown :"+this.type);
|
|
break;
|
|
}
|
|
this.packetLength = this.compressedData.length +1;
|
|
return this.compressedData;
|
|
}
|
|
|
|
/**
|
|
* Creates a 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;
|
|
if (algorithm == null) {
|
|
this.type = 1;
|
|
}
|
|
var result = String.fromCharCode(this.type)+this.compress(this.type);
|
|
return openpgp_packet.write_packet_header(8, result.length)+result;
|
|
}
|
|
|
|
/**
|
|
* Pretty printing the packet (useful for debug purposes)
|
|
* @return {String}
|
|
*/
|
|
function toString() {
|
|
return '5.6. Compressed Data Packet (Tag 8)\n'+
|
|
' length: '+this.packetLength+'\n'+
|
|
' Compression Algorithm = '+this.type+'\n'+
|
|
' Compressed Data: Byte ['+util.hexstrdump(this.compressedData)+']\n';
|
|
}
|
|
|
|
this.read_packet = read_packet;
|
|
this.toString = toString;
|
|
this.compress = compress;
|
|
this.decompress = decompress;
|
|
this.write_packet = write_packet;
|
|
};
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="_openpgp_packet.html">_openpgp_packet</a></li><li><a href="JXG.Util.html">Util</a></li><li><a href="openpgp.html">openpgp</a></li><li><a href="openpgp_config.html">openpgp_config</a></li><li><a href="openpgp_keyring.html">openpgp_keyring</a></li><li><a href="openpgp_msg_message.html">openpgp_msg_message</a></li><li><a href="openpgp_msg_privatekey.html">openpgp_msg_privatekey</a></li><li><a href="openpgp_msg_publickey.html">openpgp_msg_publickey</a></li><li><a href="openpgp_packet_compressed.html">openpgp_packet_compressed</a></li><li><a href="openpgp_packet_encrypteddata.html">openpgp_packet_encrypteddata</a></li><li><a href="openpgp_packet_encryptedintegrityprotecteddata.html">openpgp_packet_encryptedintegrityprotecteddata</a></li><li><a href="openpgp_packet_encryptedsessionkey.html">openpgp_packet_encryptedsessionkey</a></li><li><a href="openpgp_packet_keymaterial.html">openpgp_packet_keymaterial</a></li><li><a href="openpgp_packet_literaldata.html">openpgp_packet_literaldata</a></li><li><a href="openpgp_packet_marker.html">openpgp_packet_marker</a></li><li><a href="openpgp_packet_modificationdetectioncode.html">openpgp_packet_modificationdetectioncode</a></li><li><a href="openpgp_packet_onepasssignature.html">openpgp_packet_onepasssignature</a></li><li><a href="openpgp_packet_signature.html">openpgp_packet_signature</a></li><li><a href="openpgp_packet_userattribute.html">openpgp_packet_userattribute</a></li><li><a href="openpgp_packet_userid.html">openpgp_packet_userid</a></li><li><a href="openpgp_type_keyid.html">openpgp_type_keyid</a></li><li><a href="openpgp_type_mpi.html">openpgp_type_mpi</a></li><li><a href="openpgp_type_s2k.html">openpgp_type_s2k</a></li></ul><h3>Global</h3><ul><li><a href="global.html#bin2str">bin2str</a></li><li><a href="global.html#calc_checksum">calc_checksum</a></li><li><a href="global.html#crc_table">crc_table</a></li><li><a href="global.html#decode_utf8">decode_utf8</a></li><li><a href="global.html#encode_utf8">encode_utf8</a></li><li><a href="global.html#get_hashAlgorithmString">get_hashAlgorithmString</a></li><li><a href="global.html#getCheckSum">getCheckSum</a></li><li><a href="global.html#getPGPMessageType">getPGPMessageType</a></li><li><a href="global.html#hash_headers">hash_headers</a></li><li><a href="global.html#hex2bin">hex2bin</a></li><li><a href="global.html#hexidump">hexidump</a></li><li><a href="global.html#hexstrdump">hexstrdump</a></li><li><a href="global.html#MD5">MD5</a></li><li><a href="global.html#openpgp_cfb_decrypt">openpgp_cfb_decrypt</a></li><li><a href="global.html#openpgp_cfb_encrypt">openpgp_cfb_encrypt</a></li><li><a href="global.html#openpgp_cfb_mdc">openpgp_cfb_mdc</a></li><li><a href="global.html#openpgp_crypto_asymetricDecrypt">openpgp_crypto_asymetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_asymetricEncrypt">openpgp_crypto_asymetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_generateKeyPair">openpgp_crypto_generateKeyPair</a></li><li><a href="global.html#openpgp_crypto_generateSessionKey">openpgp_crypto_generateSessionKey</a></li><li><a href="global.html#openpgp_crypto_getHashByteLength">openpgp_crypto_getHashByteLength</a></li><li><a href="global.html#openpgp_crypto_getPrefixRandom">openpgp_crypto_getPrefixRandom</a></li><li><a href="global.html#openpgp_crypto_getPseudoRandom">openpgp_crypto_getPseudoRandom</a></li><li><a href="global.html#openpgp_crypto_getRandomBigInteger">openpgp_crypto_getRandomBigInteger</a></li><li><a href="global.html#openpgp_crypto_getRandomBytes">openpgp_crypto_getRandomBytes</a></li><li><a href="global.html#openpgp_crypto_getSecureRandom">openpgp_crypto_getSecureRandom</a></li><li><a href="global.html#openpgp_crypto_hashData">openpgp_crypto_hashData</a></li><li><a href="global.html#openpgp_crypto_MDCSystemBytes">openpgp_crypto_MDCSystemBytes</a></li><li><a href="global.html#openpgp_crypto_signData">openpgp_crypto_signData</a></li><li><a href="global.html#openpgp_crypto_symmetricDecrypt">openpgp_crypto_symmetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_symmetricEncrypt">openpgp_crypto_symmetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_verifySignature">openpgp_crypto_verifySignature</a></li><li><a href="global.html#openpgp_encoding_armor">openpgp_encoding_armor</a></li><li><a href="global.html#openpgp_encoding_armor_addheader">openpgp_encoding_armor_addheader</a></li><li><a href="global.html#openpgp_encoding_base64_decode">openpgp_encoding_base64_decode</a></li><li><a href="global.html#openpgp_encoding_base64_encode">openpgp_encoding_base64_encode</a></li><li><a href="global.html#openpgp_encoding_deArmor">openpgp_encoding_deArmor</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_decode">openpgp_encoding_eme_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_encode">openpgp_encoding_eme_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_decode">openpgp_encoding_emsa_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_encode">openpgp_encoding_emsa_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_html_encode">openpgp_encoding_html_encode</a></li><li><a href="global.html#print_debug">print_debug</a></li><li><a href="global.html#print_debug_hexstr_dump">print_debug_hexstr_dump</a></li><li><a href="global.html#print_error">print_error</a></li><li><a href="global.html#print_info">print_info</a></li><li><a href="global.html#shiftRight">shiftRight</a></li><li><a href="global.html#str2bin">str2bin</a></li><li><a href="global.html#str2Uint8Array">str2Uint8Array</a></li><li><a href="global.html#Uint8Array2str">Uint8Array2str</a></li><li><a href="global.html#util">util</a></li><li><a href="global.html#verifyCheckSum">verifyCheckSum</a></li></ul>
|
|
</nav>
|
|
|
|
<br clear="both">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Tue Apr 16 2013 10:42:39 GMT+0200 (CEST)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
</body>
|
|
</html>
|