23295342fc
work correctly with utf8 strings. Fixeda visibility issue with the testing suite and added relevant unit tests.
205 lines
11 KiB
HTML
205 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: packet/openpgp.packet.literaldata.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.literaldata.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 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.
|
|
*/
|
|
function openpgp_packet_literaldata() {
|
|
this.tagType = 11;
|
|
|
|
|
|
/**
|
|
* Set the packet data to a javascript native string or a squence of
|
|
* bytes. Conversion to a proper utf8 encoding takes place when the
|
|
* packet is written.
|
|
* @param {String} str Any native javascript string
|
|
* @param {openpgp_packet_literaldata.formats} format
|
|
*/
|
|
this.set_data = function(str, format) {
|
|
this.format = format;
|
|
this.data = str;
|
|
}
|
|
|
|
/**
|
|
* Set the packet data to value represented by the provided string
|
|
* of bytes together with the appropriate conversion format.
|
|
* @param {String} bytes The string of bytes
|
|
* @param {openpgp_packet_literaldata.formats} format
|
|
*/
|
|
this.set_data_bytes = function(bytes, format) {
|
|
this.format = format;
|
|
|
|
if(format == openpgp_packet_literaldata.formats.utf8)
|
|
bytes = util.decode_utf8(bytes);
|
|
|
|
this.data = bytes;
|
|
}
|
|
|
|
/**
|
|
* Get the byte sequence representing the literal packet data
|
|
* @returns {String} A sequence of bytes
|
|
*/
|
|
this.get_data_bytes = function() {
|
|
if(this.format == openpgp_packet_literaldata.formats.utf8)
|
|
return util.encode_utf8(this.data);
|
|
else
|
|
return this.data;
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Parsing function for a literal data packet (tag 11).
|
|
*
|
|
* @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
|
|
*/
|
|
this.read_packet = function(input, position, len) {
|
|
this.packetLength = len;
|
|
// - A one-octet field that describes how the data is formatted.
|
|
|
|
var format = input[position];
|
|
|
|
this.filename = util.decode_utf8(input.substr(position + 2, input
|
|
.charCodeAt(position + 1)));
|
|
|
|
this.date = new Date(parseInt(input.substr(position + 2
|
|
+ input.charCodeAt(position + 1), 4)) * 1000);
|
|
|
|
var bytes = input.substring(position + 6
|
|
+ input.charCodeAt(position + 1));
|
|
|
|
this.set_data_bytes(bytes, format);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Creates a string representation of the packet
|
|
*
|
|
* @param {String} data The data to be inserted as body
|
|
* @return {String} string-representation of the packet
|
|
*/
|
|
this.write_packet = function(data) {
|
|
this.set_data(data, openpgp_packet_literaldata.formats.utf8);
|
|
this.filename = util.encode_utf8("msg.txt");
|
|
this.date = new Date();
|
|
|
|
data = this.get_data_bytes();
|
|
|
|
var result = openpgp_packet.write_packet_header(11, data.length + 6
|
|
+ this.filename.length);
|
|
result += this.format;
|
|
result += String.fromCharCode(this.filename.length);
|
|
result += this.filename;
|
|
result += String
|
|
.fromCharCode((Math.round(this.date.getTime() / 1000) >> 24) & 0xFF);
|
|
result += String
|
|
.fromCharCode((Math.round(this.date.getTime() / 1000) >> 16) & 0xFF);
|
|
result += String
|
|
.fromCharCode((Math.round(this.date.getTime() / 1000) >> 8) & 0xFF);
|
|
result += String
|
|
.fromCharCode(Math.round(this.date.getTime() / 1000) & 0xFF);
|
|
result += data;
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Generates debug output (pretty print)
|
|
*
|
|
* @return {String} String which gives some information about the keymaterial
|
|
*/
|
|
this.toString = function() {
|
|
return '5.9. Literal Data Packet (Tag 11)\n' + ' length: '
|
|
+ this.packetLength + '\n' + ' format: ' + this.format
|
|
+ '\n' + ' filename:' + this.filename + '\n'
|
|
+ ' date: ' + this.date + '\n' + ' data: |'
|
|
+ this.data + '|\n' + ' rdata: |' + this.real_data + '|\n';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Data types in the literal packet
|
|
* @readonly
|
|
* @enum {String}
|
|
*/
|
|
openpgp_packet_literaldata.formats = {
|
|
/** Binary data */
|
|
binary: 'b',
|
|
/** Text data */
|
|
text: 't',
|
|
/** Utf8 data */
|
|
utf8: 'u'
|
|
};
|
|
</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>
|