diff options
Diffstat (limited to 'docs/reference/html/GMimeCryptoContext.html')
| -rw-r--r-- | docs/reference/html/GMimeCryptoContext.html | 959 |
1 files changed, 959 insertions, 0 deletions
diff --git a/docs/reference/html/GMimeCryptoContext.html b/docs/reference/html/GMimeCryptoContext.html new file mode 100644 index 0000000..e247f67 --- /dev/null +++ b/docs/reference/html/GMimeCryptoContext.html @@ -0,0 +1,959 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeCryptoContext</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="CryptoContexts.html" title="Cryptography Contexts"> +<link rel="prev" href="GMimeSignature.html" title="GMimeSignature"> +<link rel="next" href="GMimeGpgContext.html" title="GMimeGpgContext"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeSignature.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="CryptoContexts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeGpgContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeCryptoContext.synopsis" class="shortcut">Top</a> + | + <a href="#GMimeCryptoContext.description" class="shortcut">Description</a> + | + <a href="#GMimeCryptoContext.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeCryptoContext"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeCryptoContext.top_of_page"></a>GMimeCryptoContext</span></h2> +<p>GMimeCryptoContext — Encryption/signing contexts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeCryptoContext.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"><span class="returnvalue">gboolean</span> (<a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()">*GMimePasswordRequestFunc</a>) (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *user_id</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *prompt_ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> reprompt</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *response</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +struct <a class="link" href="GMimeCryptoContext.html#GMimeCryptoContext-struct" title="struct GMimeCryptoContext">GMimeCryptoContext</a>; +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-set-request-password" title="g_mime_crypto_context_set_request_password ()">g_mime_crypto_context_set_request_password</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-get-signature-protocol" title="g_mime_crypto_context_get_signature_protocol ()">g_mime_crypto_context_get_signature_protocol</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-get-encryption-protocol" title="g_mime_crypto_context_get_encryption_protocol ()">g_mime_crypto_context_get_encryption_protocol</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-get-key-exchange-protocol" title="g_mime_crypto_context_get_key_exchange_protocol ()">g_mime_crypto_context_get_key_exchange_protocol</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>); +<a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-digest-id" title="g_mime_crypto_context_digest_id ()">g_mime_crypto_context_digest_id</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-digest-name" title="g_mime_crypto_context_digest_name ()">g_mime_crypto_context_digest_name</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-sign" title="g_mime_crypto_context_sign ()">g_mime_crypto_context_sign</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-verify" title="g_mime_crypto_context_verify ()">g_mime_crypto_context_verify</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *sigstream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-encrypt" title="g_mime_crypto_context_encrypt ()">g_mime_crypto_context_encrypt</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> sign</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *recipients</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="returnvalue">GMimeDecryptResult</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-decrypt" title="g_mime_crypto_context_decrypt ()">g_mime_crypto_context_decrypt</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-import-keys" title="g_mime_crypto_context_import_keys ()">g_mime_crypto_context_import_keys</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-export-keys" title="g_mime_crypto_context_export_keys ()">g_mime_crypto_context_export_keys</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *keys</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); + +enum <a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo">GMimeCipherAlgo</a>; +struct <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult">GMimeDecryptResult</a>; +<a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="returnvalue">GMimeDecryptResult</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-new" title="g_mime_decrypt_result_new ()">g_mime_decrypt_result_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="returnvalue">GMimeCertificateList</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-get-recipients" title="g_mime_decrypt_result_get_recipients ()">g_mime_decrypt_result_get_recipients</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-set-recipients" title="g_mime_decrypt_result_set_recipients ()">g_mime_decrypt_result_set_recipients</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *recipients</code></em>); +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-get-signatures" title="g_mime_decrypt_result_get_signatures ()">g_mime_decrypt_result_get_signatures</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-set-signatures" title="g_mime_decrypt_result_set_signatures ()">g_mime_decrypt_result_set_signatures</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *signatures</code></em>); +<a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="returnvalue">GMimeCipherAlgo</span></a> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-get-cipher" title="g_mime_decrypt_result_get_cipher ()">g_mime_decrypt_result_get_cipher</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-set-cipher" title="g_mime_decrypt_result_set_cipher ()">g_mime_decrypt_result_set_cipher</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="type">GMimeCipherAlgo</span></a> cipher</code></em>); +<a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-get-mdc" title="g_mime_decrypt_result_get_mdc ()">g_mime_decrypt_result_get_mdc</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-set-mdc" title="g_mime_decrypt_result_set_mdc ()">g_mime_decrypt_result_set_mdc</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> mdc</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeCryptoContext.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeCryptoContext + +----<a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext">GMimeGpgContext</a> + +----<a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context">GMimePkcs7Context</a> +</pre> +</div> +<div class="refsect1"> +<a name="GMimeCryptoContext.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> is used for encrypting, decrypting, signing +and verifying cryptographic signatures. +</p> +</div> +<div class="refsect1"> +<a name="GMimeCryptoContext.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimePasswordRequestFunc"></a><h3>GMimePasswordRequestFunc ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> (*GMimePasswordRequestFunc) (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *user_id</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *prompt_ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> reprompt</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *response</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +A password request callback allowing a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> to +prompt the user for a password for a given key. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>the <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> making the request</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_id</code></em> :</span></p></td> +<td>the user_id of the password being requested</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>prompt_ctx</code></em> :</span></p></td> +<td>a string containing some helpful context for the prompt</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>reprompt</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if this password request is a reprompt due to a previously bad password response</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td> +<td>a stream for the application to write the password to (followed by a newline '\n' character)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> for the callback to set if an error occurs</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeCryptoContext-struct"></a><h3>struct GMimeCryptoContext</h3> +<pre class="programlisting">struct GMimeCryptoContext;</pre> +<p> +A crypto context for use with MIME. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-set-request-password"></a><h3>g_mime_crypto_context_set_request_password ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_crypto_context_set_request_password + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>);</pre> +<p> +Sets the function used by the <em class="parameter"><code>ctx</code></em> for requesting a password from +the user. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>request_passwd</code></em> :</span></p></td> +<td>a callback function for requesting a password</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-get-signature-protocol"></a><h3>g_mime_crypto_context_get_signature_protocol ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_crypto_context_get_signature_protocol + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the signature protocol for the crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the signature protocol or <code class="literal">NULL</code> if not supported.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-get-encryption-protocol"></a><h3>g_mime_crypto_context_get_encryption_protocol ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_crypto_context_get_encryption_protocol + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the encryption protocol for the crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the encryption protocol or <code class="literal">NULL</code> if not supported.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-get-key-exchange-protocol"></a><h3>g_mime_crypto_context_get_key_exchange_protocol ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_crypto_context_get_key_exchange_protocol + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the key exchange protocol for the crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the key exchange protocol or <code class="literal">NULL</code> if not supported.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-digest-id"></a><h3>g_mime_crypto_context_digest_id ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> g_mime_crypto_context_digest_id (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p> +Gets the digest id based on the digest name. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>digest name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the equivalent digest id or <a class="link" href="GMimeCertificate.html#GMIME-DIGEST-ALGO-DEFAULT:CAPS"><span class="type">GMIME_DIGEST_ALGO_DEFAULT</span></a> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-digest-name"></a><h3>g_mime_crypto_context_digest_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_crypto_context_digest_name (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>);</pre> +<p> +Gets the digest name based on the digest id <em class="parameter"><code>digest</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest id</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the equivalent digest name or <code class="literal">NULL</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-sign"></a><h3>g_mime_crypto_context_sign ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_crypto_context_sign (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Signs the input stream and writes the resulting signature to the output stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>userid</code></em> :</span></p></td> +<td>private key to use to sign the stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest algorithm to use</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>input stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> +<td>output stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> used on success (useful if <em class="parameter"><code>digest</code></em> is +specified as <a class="link" href="GMimeCertificate.html#GMIME-DIGEST-ALGO-DEFAULT:CAPS"><span class="type">GMIME_DIGEST_ALGO_DEFAULT</span></a>) or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-verify"></a><h3>g_mime_crypto_context_verify ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * g_mime_crypto_context_verify (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *sigstream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Verifies the signature. If <em class="parameter"><code>istream</code></em> is a clearsigned stream, +you should pass <code class="literal">NULL</code> as the sigstream parameter. Otherwise +<em class="parameter"><code>sigstream</code></em> is assumed to be the signature stream and is used to +verify the integirity of the <em class="parameter"><code>istream</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest algorithm used, if known</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>input stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sigstream</code></em> :</span></p></td> +<td>optional detached-signature stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> object containing the status of each +signature or <code class="literal">NULL</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-encrypt"></a><h3>g_mime_crypto_context_encrypt ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_crypto_context_encrypt (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> sign</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *recipients</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Encrypts (and optionally signs) the cleartext input stream and +writes the resulting ciphertext to the output stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sign</code></em> :</span></p></td> +<td>sign as well as encrypt</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>userid</code></em> :</span></p></td> +<td>key id (or email address) to use when signing (assuming <em class="parameter"><code>sign</code></em> is <code class="literal">TRUE</code>)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest algorithm to use when signing</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>recipients</code></em> :</span></p></td> +<td>an array of recipient key ids and/or email addresses</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>cleartext input stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> +<td>ciphertext output stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-decrypt"></a><h3>g_mime_crypto_context_decrypt ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="returnvalue">GMimeDecryptResult</span></a> * g_mime_crypto_context_decrypt (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Decrypts the ciphertext input stream and writes the resulting +cleartext to the output stream. +</p> +<p> +If the encrypted input stream was also signed, the returned +<a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> will have a non-<code class="literal">NULL</code> list of signatures, each with a +<a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> (among other details about each signature). +</p> +<p> +On success, the returned <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> will contain a list of +certificates, one for each recipient, that the original encrypted stream +was encrypted to. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>input/ciphertext stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> +<td>output/cleartext stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> on success or <code class="literal">NULL</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-import-keys"></a><h3>g_mime_crypto_context_import_keys ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_crypto_context_import_keys (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Imports a stream of keys/certificates contained within <em class="parameter"><code>istream</code></em> +into the key/certificate database controlled by <em class="parameter"><code>ctx</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>input stream (containing keys)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-export-keys"></a><h3>g_mime_crypto_context_export_keys ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_crypto_context_export_keys (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *keys</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Exports the keys/certificates in <em class="parameter"><code>keys</code></em> to the stream <em class="parameter"><code>ostream</code></em> from +the key/certificate database controlled by <em class="parameter"><code>ctx</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>keys</code></em> :</span></p></td> +<td>an array of key ids</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> +<td>output stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeCipherAlgo"></a><h3>enum GMimeCipherAlgo</h3> +<pre class="programlisting">typedef enum { + GMIME_CIPHER_ALGO_DEFAULT = 0, + GMIME_CIPHER_ALGO_IDEA = 1, + GMIME_CIPHER_ALGO_3DES = 2, + GMIME_CIPHER_ALGO_CAST5 = 3, + GMIME_CIPHER_ALGO_BLOWFISH = 4, + GMIME_CIPHER_ALGO_AES = 7, + GMIME_CIPHER_ALGO_AES192 = 8, + GMIME_CIPHER_ALGO_AES256 = 9, + GMIME_CIPHER_ALGO_TWOFISH = 10, + GMIME_CIPHER_ALGO_CAMELLIA128 = 11, + GMIME_CIPHER_ALGO_CAMELLIA192 = 12, + GMIME_CIPHER_ALGO_CAMELLIA256 = 13 +} GMimeCipherAlgo; +</pre> +<p> +A cipher algorithm. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-DEFAULT:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_DEFAULT</code></span></p></td> +<td>The default (or unknown) cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-IDEA:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_IDEA</code></span></p></td> +<td>The IDEA cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-3DES:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_3DES</code></span></p></td> +<td>The 3DES cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-CAST5:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_CAST5</code></span></p></td> +<td>The CAST5 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-BLOWFISH:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_BLOWFISH</code></span></p></td> +<td>The Blowfish cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-AES:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_AES</code></span></p></td> +<td>The AES (aka RIJANDALE) cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-AES192:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_AES192</code></span></p></td> +<td>The AES-192 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-AES256:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_AES256</code></span></p></td> +<td>The AES-256 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-TWOFISH:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_TWOFISH</code></span></p></td> +<td>The Twofish cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-CAMELLIA128:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_CAMELLIA128</code></span></p></td> +<td>The Camellia-128 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-CAMELLIA192:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_CAMELLIA192</code></span></p></td> +<td>The Camellia-192 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-CAMELLIA256:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_CAMELLIA256</code></span></p></td> +<td>The Camellia-256 cipher. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeDecryptResult"></a><h3>struct GMimeDecryptResult</h3> +<pre class="programlisting">struct GMimeDecryptResult { + GObject parent_object; + + GMimeCertificateList *recipients; + GMimeSignatureList *signatures; + GMimeCipherAlgo cipher; + GMimeDigestAlgo mdc; +}; +</pre> +<p> +An object containing the results from decrypting an encrypted stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><span class="type">GObject</span> <em class="structfield"><code><a name="GMimeDecryptResult.parent-object"></a>parent_object</code></em>;</span></p></td> +<td>parent <span class="type">GObject</span> +</td> +</tr> +<tr> +<td><p><span class="term"><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *<em class="structfield"><code><a name="GMimeDecryptResult.recipients"></a>recipients</code></em>;</span></p></td> +<td>A <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *<em class="structfield"><code><a name="GMimeDecryptResult.signatures"></a>signatures</code></em>;</span></p></td> +<td>A <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> if signed or <code class="literal">NULL</code> otherwise.</td> +</tr> +<tr> +<td><p><span class="term"><a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="type">GMimeCipherAlgo</span></a> <em class="structfield"><code><a name="GMimeDecryptResult.cipher"></a>cipher</code></em>;</span></p></td> +<td>The cipher algorithm used to encrypt the stream.</td> +</tr> +<tr> +<td><p><span class="term"><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> <em class="structfield"><code><a name="GMimeDecryptResult.mdc"></a>mdc</code></em>;</span></p></td> +<td>The MDC digest algorithm used, if any.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-new"></a><h3>g_mime_decrypt_result_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="returnvalue">GMimeDecryptResult</span></a> * g_mime_decrypt_result_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-get-recipients"></a><h3>g_mime_decrypt_result_get_recipients ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="returnvalue">GMimeCertificateList</span></a> * g_mime_decrypt_result_get_recipients + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>);</pre> +<p> +Gets the list of certificates that the stream had been encrypted to. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-set-recipients"></a><h3>g_mime_decrypt_result_set_recipients ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_decrypt_result_set_recipients + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *recipients</code></em>);</pre> +<p> +Sets the list of certificates that the stream had been encrypted to. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>recipients</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-get-signatures"></a><h3>g_mime_decrypt_result_get_signatures ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * g_mime_decrypt_result_get_signatures + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>);</pre> +<p> +Gets a list of signatures if the encrypted stream had also been signed. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> or <code class="literal">NULL</code> if the stream was not signed.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-set-signatures"></a><h3>g_mime_decrypt_result_set_signatures ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_decrypt_result_set_signatures + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *signatures</code></em>);</pre> +<p> +Sets the list of signatures. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>signatures</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-get-cipher"></a><h3>g_mime_decrypt_result_get_cipher ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="returnvalue">GMimeCipherAlgo</span></a> g_mime_decrypt_result_get_cipher (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>);</pre> +<p> +Get the cipher algorithm used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the cipher algorithm used.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-set-cipher"></a><h3>g_mime_decrypt_result_set_cipher ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_decrypt_result_set_cipher (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="type">GMimeCipherAlgo</span></a> cipher</code></em>);</pre> +<p> +Set the cipher algorithm used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cipher</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="type">GMimeCipherAlgo</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-get-mdc"></a><h3>g_mime_decrypt_result_get_mdc ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> g_mime_decrypt_result_get_mdc (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>);</pre> +<p> +Get the mdc digest algorithm used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the mdc digest algorithm used.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-set-mdc"></a><h3>g_mime_decrypt_result_set_mdc ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_decrypt_result_set_mdc (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> mdc</code></em>);</pre> +<p> +Set the mdc digest algorithm used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mdc</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file |