185 lines
11 KiB
HTML
185 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: type/openpgp.type.mpi.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: type/openpgp.type.mpi.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
|
|
|
|
// Hint: We hold our MPIs as an array of octets in big endian format preceeding a two
|
|
// octet scalar: MPI: [a,b,c,d,e,f]
|
|
// - MPI size: (a << 8) | b
|
|
// - MPI = c | d << 8 | e << ((MPI.length -2)*8) | f ((MPI.length -2)*8)
|
|
|
|
/**
|
|
* @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;
|
|
this.mpiBitLength = null;
|
|
this.mpiByteLength = null;
|
|
this.data = null;
|
|
/**
|
|
* Parsing function for a mpi (RFC 4880 3.2).
|
|
* @param {String} input Payload of mpi data
|
|
* @param {Integer} position Position to start reading from the input
|
|
* string
|
|
* @param {Integer} len Length of the packet or the remaining length of
|
|
* input at position
|
|
* @return {openpgp_type_mpi} Object representation
|
|
*/
|
|
function read(input, position, len) {
|
|
var mypos = position;
|
|
|
|
this.mpiBitLength = (input[mypos++].charCodeAt() << 8) | input[mypos++].charCodeAt();
|
|
|
|
// Additional rules:
|
|
//
|
|
// The size of an MPI is ((MPI.length + 7) / 8) + 2 octets.
|
|
//
|
|
// The length field of an MPI describes the length starting from its
|
|
// most significant non-zero bit. Thus, the MPI [00 02 01] is not
|
|
// formed correctly. It should be [00 01 01].
|
|
|
|
// TODO: Verification of this size method! This size calculation as
|
|
// specified above is not applicable in JavaScript
|
|
this.mpiByteLength = (this.mpiBitLength - (this.mpiBitLength % 8)) / 8;
|
|
if (this.mpiBitLength % 8 != 0)
|
|
this.mpiByteLength++;
|
|
|
|
this.MPI = input.substring(mypos,mypos+this.mpiByteLength);
|
|
this.data = input.substring(position, position+2+this.mpiByteLength);
|
|
this.packetLength = this.mpiByteLength +2;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Generates debug output (pretty print)
|
|
* @return {String} String which gives some information about the mpi
|
|
*/
|
|
function toString() {
|
|
var r = " MPI("+this.mpiBitLength+"b/"+this.mpiByteLength+"B) : 0x";
|
|
r+=util.hexstrdump(this.MPI);
|
|
return r+'\n';
|
|
}
|
|
|
|
/**
|
|
* Converts the mpi to an BigInteger object
|
|
* @return {BigInteger}
|
|
*/
|
|
function getBigInteger() {
|
|
return new BigInteger(util.hexstrdump(this.MPI),16);
|
|
}
|
|
|
|
|
|
function getBits(num) {
|
|
for (var i = 0; i < 9; i++)
|
|
if (num >> i == 0)
|
|
return i;
|
|
}
|
|
|
|
/**
|
|
* Gets the length of the mpi in bytes
|
|
* @return {Integer} Mpi byte length
|
|
*/
|
|
function getByteLength() {
|
|
return this.mpiByteLength;
|
|
}
|
|
|
|
/**
|
|
* Creates an mpi from the specified string
|
|
* @param {String} data Data to read the mpi from
|
|
* @return {openpgp_type_mpi}
|
|
*/
|
|
function create(data) {
|
|
this.MPI = data;
|
|
this.mpiBitLength = (data.length -1) *8 + getBits(data.charCodeAt(0));
|
|
this.mpiByteLength = data.length;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Converts the mpi object to a string as specified in RFC4880 3.2
|
|
* @return {String} mpi Byte representation
|
|
*/
|
|
function toBin() {
|
|
var result = String.fromCharCode((this.mpiBitLength >> 8) & 0xFF);
|
|
result += String.fromCharCode(this.mpiBitLength & 0xFF);
|
|
result += this.MPI;
|
|
return result;
|
|
}
|
|
|
|
this.read = read;
|
|
this.toBigInteger = getBigInteger;
|
|
this.toString = toString;
|
|
this.create = create;
|
|
this.toBin = toBin;
|
|
this.getByteLength = getByteLength;
|
|
}
|
|
|
|
</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#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 Fri Apr 12 2013 14:20:33 GMT+0200 (CEST)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
</body>
|
|
</html>
|