<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>certmanager/lib: Encryption and Decryption (certmanager/lib)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<img id="nav_header_logo_right" alt="" align="right" src="../../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../../">API Reference</a>
/ <a href="../../html/index.html">certmanager</a> / <a href=".">lib</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>certmanager/lib</h2>
<!-- Generated by Doxygen 1.5.5 -->
<div class="contents">
<h1>Encryption and Decryption<br>
<small>
[<a class="el" href="group__groupSignCryptAct.html">Signing and Encrypting Actions</a>]</small>
</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
The following methods are used to encrypt and decrypt email messages.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__groupCryptAct.html#g470538d2b9834737ab7d1923f93d3fc2">CryptPlug::decryptMessage</a> (const char *ciphertext, bool cipherIsBinary, int cipherLen, const char **cleartext, const char *certificate, int *errId, char **errTxt)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__groupCryptAct.html#gfbd6f0cd6ad101b375451fab608aadb8">CryptPlug::decryptAndCheckMessage</a> (const char *ciphertext, bool cipherIsBinary, int cipherLen, const char **cleartext, const char *certificate, bool *signatureFound, struct SignatureMetaData *sigmeta, int *errId, char **errTxt, char **attrOrder, const char *unknownAttrsHandling)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__groupCryptAct.html#g2350cb6e5fb2fdcd078f983a65e3394c">CryptPlugWrapper::decryptMessage</a> (const char *ciphertext, bool cipherIsBinary, int cipherLen, char **cleartext, const char *certificate, int *errId, char **errTxt)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__groupCryptAct.html#gb5a67054245388a7339787fbde49e051">CryptPlugWrapper::decryptAndCheckMessage</a> (const char *ciphertext, bool cipherIsBinary, int cipherLen, char **cleartext, const char *certificate, bool *signatureFound, CryptPlug::SignatureMetaData *sigmeta, int *errId, char **errTxt)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gb5a67054245388a7339787fbde49e051"></a><!-- doxytag: member="CryptPlugWrapper::decryptAndCheckMessage" ref="gb5a67054245388a7339787fbde49e051" args="(const char *ciphertext, bool cipherIsBinary, int cipherLen, char **cleartext, const char *certificate, bool *signatureFound, CryptPlug::SignatureMetaData *sigmeta, int *errId, char **errTxt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CryptPlugWrapper::decryptAndCheckMessage </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>cipherIsBinary</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>cipherLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>cleartext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>certificate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool * </td>
<td class="paramname"> <em>signatureFound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CryptPlug::SignatureMetaData * </td>
<td class="paramname"> <em>sigmeta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>errId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>errTxt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Combines the functionality of <code><a class="el" href="group__groupSignAct.html#gb57b4e2ebb5d4eed99d46fa69d76d7b9" title="Checks whether the signature of a message is valid.">checkMessageSignature()</a></code> and <code><a class="el" href="group__groupCryptAct.html#g2350cb6e5fb2fdcd078f983a65e3394c" title="Tries to decrypt an email message ciphertext and returns the decrypted message in...">decryptMessage()</a></code>.
<p>
If <code>certificate</code> is <code>NULL</code>, the default certificate will be used. If <code>sigmeta</code> is non-null, the <code>SignatureMetaData</code> object pointed to will contain meta information about the signature after the function call.
<p>Definition at line <a class="el" href="cryptplugwrapper_8cpp-source.html#l00599">599</a> of file <a class="el" href="cryptplugwrapper_8cpp-source.html">cryptplugwrapper.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="gfbd6f0cd6ad101b375451fab608aadb8"></a><!-- doxytag: member="CryptPlug::decryptAndCheckMessage" ref="gfbd6f0cd6ad101b375451fab608aadb8" args="(const char *ciphertext, bool cipherIsBinary, int cipherLen, const char **cleartext, const char *certificate, bool *signatureFound, struct SignatureMetaData *sigmeta, int *errId, char **errTxt, char **attrOrder, const char *unknownAttrsHandling)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CryptPlug::decryptAndCheckMessage </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>cipherIsBinary</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>cipherLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>cleartext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>certificate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool * </td>
<td class="paramname"> <em>signatureFound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct SignatureMetaData * </td>
<td class="paramname"> <em>sigmeta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>errId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>errTxt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>attrOrder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>unknownAttrsHandling</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Combines the functionality of <code>checkMessageSignature()</code> and <code>decryptMessage()</code>.
<p>
If <code>certificate</code> is <code>NULL</code>, the default certificate will be used. If <code>sigmeta</code> is non-null, the <code>SignatureMetaData</code> object pointed to will contain meta information about the signature after the function call.
<p>Definition at line <a class="el" href="cryptplug_8cpp-source.html#l01032">1032</a> of file <a class="el" href="cryptplug_8cpp-source.html">cryptplug.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="g2350cb6e5fb2fdcd078f983a65e3394c"></a><!-- doxytag: member="CryptPlugWrapper::decryptMessage" ref="g2350cb6e5fb2fdcd078f983a65e3394c" args="(const char *ciphertext, bool cipherIsBinary, int cipherLen, char **cleartext, const char *certificate, int *errId, char **errTxt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CryptPlugWrapper::decryptMessage </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>cipherIsBinary</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>cipherLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>cleartext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>certificate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>errId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>errTxt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to decrypt an email message <code>ciphertext</code> and returns the decrypted message in <code>cleartext</code>.
<p>
The <code>certificate</code> is used for decryption. If the message could be decrypted, the function returns <code>true</code>, otherwise <code>false</code>.
<p>Definition at line <a class="el" href="cryptplugwrapper_8cpp-source.html#l00586">586</a> of file <a class="el" href="cryptplugwrapper_8cpp-source.html">cryptplugwrapper.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="g470538d2b9834737ab7d1923f93d3fc2"></a><!-- doxytag: member="CryptPlug::decryptMessage" ref="g470538d2b9834737ab7d1923f93d3fc2" args="(const char *ciphertext, bool cipherIsBinary, int cipherLen, const char **cleartext, const char *certificate, int *errId, char **errTxt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CryptPlug::decryptMessage </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>cipherIsBinary</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>cipherLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>cleartext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>certificate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>errId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>errTxt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to decrypt an email message <code>ciphertext</code> and returns the decrypted message in <code>cleartext</code>.
<p>
The <code>certificate</code> is used for decryption. If the message could be decrypted, the function returns <code>true</code>, otherwise <code>false</code>.
<p>Definition at line <a class="el" href="cryptplug_8cpp-source.html#l00318">318</a> of file <a class="el" href="cryptplug_8cpp-source.html">cryptplug.cpp</a>.</p>
</div>
</div><p>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>certmanager/lib</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="modules.html">Modules</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classCryptPlugWrapper.html">cryptplugwrapper</option>, <option value="classKleo_1_1ChiasmusJob.html">kleo::chiasmusjob</option>, <option value="classKleo_1_1ChiasmusLibrary.html">kleo::chiasmuslibrary</option>, <option value="classKleo_1_1CryptoConfig.html">kleo::cryptoconfig</option>, <option value="classKleo_1_1CryptoConfigComponent.html">kleo::cryptoconfigcomponent</option>, <option value="classKleo_1_1CryptoConfigDialog.html">kleo::cryptoconfigdialog</option>, <option value="classKleo_1_1CryptoConfigEntry.html">kleo::cryptoconfigentry</option>, <option value="classKleo_1_1CryptoConfigGroup.html">kleo::cryptoconfiggroup</option>, <option value="classKleo_1_1CryptoConfigModule.html">kleo::cryptoconfigmodule</option>, <option value="classKleo_1_1DecryptJob.html">kleo::decryptjob</option>, <option value="classKleo_1_1DecryptVerifyJob.html">kleo::decryptverifyjob</option>, <option value="classKleo_1_1DeleteJob.html">kleo::deletejob</option>, <option value="classKleo_1_1DN.html">kleo::dn</option>, <option value="classKleo_1_1DNAttributeMapper.html">kleo::dnattributemapper</option>, <option value="classKleo_1_1DownloadJob.html">kleo::downloadjob</option>, <option value="classKleo_1_1EncryptJob.html">kleo::encryptjob</option>, <option value="classKleo_1_1ExportJob.html">kleo::exportjob</option>, <option value="classKleo_1_1GnuPGProcessBase.html">kleo::gnupgprocessbase</option>, <option value="classKleo_1_1HierarchicalKeyListJob.html">kleo::hierarchicalkeylistjob</option>, <option value="classKleo_1_1ImportJob.html">kleo::importjob</option>, <option value="classKleo_1_1Job.html">kleo::job</option>, <option value="classKleo_1_1KeyFilter.html">kleo::keyfilter</option>, <option value="classKleo_1_1KeyGenerationJob.html">kleo::keygenerationjob</option>, <option value="classKleo_1_1KeyListJob.html">kleo::keylistjob</option>, <option value="classKleo_1_1KeyRequester.html">kleo::keyrequester</option>, <option value="classKleo_1_1MultiDeleteJob.html">kleo::multideletejob</option>, <option value="classKleo_1_1ObtainKeysJob.html">kleo::obtainkeysjob</option>, <option value="classKleo_1_1ProgressBar.html">kleo::progressbar</option>, <option value="classKleo_1_1ProgressDialog.html">kleo::progressdialog</option>, <option value="classKleo_1_1QGpgMEJob.html">kleo::qgpgmejob</option>, <option value="classKleo_1_1RefreshKeysJob.html">kleo::refreshkeysjob</option>, <option value="classKleo_1_1SignEncryptJob.html">kleo::signencryptjob</option>, <option value="classKleo_1_1SignJob.html">kleo::signjob</option>, <option value="classKleo_1_1SpecialJob.html">kleo::specialjob</option>, <option value="classKleo_1_1VerifyDetachedJob.html">kleo::verifydetachedjob</option>, <option value="classKleo_1_1VerifyOpaqueJob.html">kleo::verifyopaquejob</option>, <option value="classQGpgMECryptoConfig.html">qgpgmecryptoconfig</option>, <option value="classQGpgMECryptoConfigComponent.html">qgpgmecryptoconfigcomponent</option>, <option value="classStructuringInfoWrapper.html">structuringinfowrapper</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../akregator/html/index.html">akregator</a></li><li> <a href="../../../akregator/src/html/index.html">src</a></li><li> <a href="../../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../../kandy/html/index.html">kandy</a></li><li><a href="../../../karm/html/index.html">karm</a></li><li><a href="../../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../../kgantt/html/index.html">kgantt</a></li><li><a href="../../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../../kmail/html/index.html">kmail</a></li><li><a href="../../../knotes/html/index.html">knotes</a></li><li><a href="../../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../../kontact/html/index.html">kontact</a></li><li><a href="../../../korganizer/html/index.html">korganizer</a></li><li><a href="../../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../../libkcal/html/index.html">libkcal</a></li><li><a href="../../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../../libkmime/html/index.html">libkmime</a></li><li><a href="../../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
