23295342fc
work correctly with utf8 strings. Fixeda visibility issue with the testing suite and added relevant unit tests.
186 lines
12 KiB
HTML
186 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: openpgp.msg.message.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: openpgp.msg.message.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
|
|
|
|
/**
|
|
* @protected
|
|
* @class
|
|
* @classdesc Top-level message object. Contains information from one or more packets
|
|
*/
|
|
|
|
function openpgp_msg_message() {
|
|
|
|
// -1 = no valid passphrase submitted
|
|
// -2 = no private key found
|
|
// -3 = decryption error
|
|
// text = valid decryption
|
|
this.text = "";
|
|
this.messagePacket = null;
|
|
this.type = null;
|
|
|
|
/**
|
|
* Decrypts a message and generates user interface message out of the found.
|
|
* MDC will be verified as well as message signatures
|
|
* @param {openpgp_msg_privatekey} private_key the private the message is encrypted with (corresponding to the session key)
|
|
* @param {openpgp_packet_encryptedsessionkey} sessionkey the session key to be used to decrypt the message
|
|
* @return {String} plaintext of the message or null on error
|
|
*/
|
|
function decrypt(private_key, sessionkey) {
|
|
return this.decryptAndVerifySignature(private_key, sessionkey).text;
|
|
}
|
|
|
|
/**
|
|
* Decrypts a message and generates user interface message out of the found.
|
|
* MDC will be verified as well as message signatures
|
|
* @param {openpgp_msg_privatekey} private_key the private the message is encrypted with (corresponding to the session key)
|
|
* @param {openpgp_packet_encryptedsessionkey} sessionkey the session key to be used to decrypt the message
|
|
* @param {openpgp_msg_publickey} pubkey Array of public keys to check signature against. If not provided, checks local keystore.
|
|
* @return {String} plaintext of the message or null on error
|
|
*/
|
|
function decryptAndVerifySignature(private_key, sessionkey, pubkey) {
|
|
if (private_key == null || sessionkey == null || sessionkey == "")
|
|
return null;
|
|
var decrypted = sessionkey.decrypt(this, private_key.keymaterial);
|
|
if (decrypted == null)
|
|
return null;
|
|
var packet;
|
|
var position = 0;
|
|
var len = decrypted.length;
|
|
var validSignatures = new Array();
|
|
util.print_debug_hexstr_dump("openpgp.msg.messge decrypt:\n",decrypted);
|
|
|
|
var messages = openpgp.read_messages_dearmored({text: decrypted, openpgp: decrypted});
|
|
for(var m in messages){
|
|
if(messages[m].data){
|
|
this.text = messages[m].data;
|
|
}
|
|
if(messages[m].signature){
|
|
validSignatures.push(messages[m].verifySignature(pubkey));
|
|
}
|
|
}
|
|
return {text:this.text, validSignatures:validSignatures};
|
|
}
|
|
|
|
/**
|
|
* Verifies a message signature. This function can be called after read_message if the message was signed only.
|
|
* @param {openpgp_msg_publickey} pubkey Array of public keys to check signature against. If not provided, checks local keystore.
|
|
* @return {boolean} true if the signature was correct; otherwise false
|
|
*/
|
|
function verifySignature(pubkey) {
|
|
var result = false;
|
|
if (this.signature.tagType == 2) {
|
|
if(!pubkey || pubkey.length == 0){
|
|
var pubkey;
|
|
if (this.signature.version == 4) {
|
|
pubkey = openpgp.keyring.getPublicKeysForKeyId(this.signature.issuerKeyId);
|
|
} else if (this.signature.version == 3) {
|
|
pubkey = openpgp.keyring.getPublicKeysForKeyId(this.signature.keyId);
|
|
} else {
|
|
util.print_error("unknown signature type on message!");
|
|
return false;
|
|
}
|
|
}
|
|
if (pubkey.length == 0)
|
|
util.print_warning("Unable to verify signature of issuer: "+util.hexstrdump(this.signature.issuerKeyId)+". Public key not found in keyring.");
|
|
else {
|
|
for (var i = 0 ; i < pubkey.length; i++) {
|
|
var tohash = this.text.replace(/\r\n/g,"\n").replace(/\n/g,"\r\n");
|
|
if (this.signature.verify(tohash, pubkey[i])) {
|
|
util.print_info("Found Good Signature from "+pubkey[i].obj.userIds[0].text+" (0x"+util.hexstrdump(pubkey[i].obj.getKeyId()).substring(8)+")");
|
|
result = true;
|
|
} else {
|
|
util.print_error("Signature verification failed: Bad Signature from "+pubkey[i].obj.userIds[0].text+" (0x"+util.hexstrdump(pubkey[0].obj.getKeyId()).substring(8)+")");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
function toString() {
|
|
var result = "Session Keys:\n";
|
|
if (this.sessionKeys !=null)
|
|
for (var i = 0; i < this.sessionKeys.length; i++) {
|
|
result += this.sessionKeys[i].toString();
|
|
}
|
|
result += "\n\n EncryptedData:\n";
|
|
if(this.encryptedData != null)
|
|
result += this.encryptedData.toString();
|
|
|
|
result += "\n\n Signature:\n";
|
|
if(this.signature != null)
|
|
result += this.signature.toString();
|
|
|
|
result += "\n\n Text:\n"
|
|
if(this.signature != null)
|
|
result += this.text;
|
|
return result;
|
|
}
|
|
this.decrypt = decrypt;
|
|
this.decryptAndVerifySignature = decryptAndVerifySignature;
|
|
this.verifySignature = verifySignature;
|
|
this.toString = toString;
|
|
}
|
|
</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>
|