File: gmime-cipher-context.xml

package info (click to toggle)
gmime2.2 2.2.3-3
links: PTS
area: main
in suites: etch, etch-m68k
size: 6,316 kB
ctags: 4,763
sloc: ansic: 33,448; xml: 9,170; sh: 8,825; makefile: 573; cs: 147; perl: 6
file content (748 lines) | stat: -rw-r--r-- 43,228 bytes
parent folder | download | duplicates (2)
<refentry id="gmime-gmime-cipher-context">
<refmeta>
<refentrytitle>gmime-cipher-context</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gmime-cipher-context</refname><refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<anchor id="GMimeCipherContext"/>
<synopsis>



enum        <link linkend="GMimeCipherHash">GMimeCipherHash</link>;
            <link linkend="GMimeCipherContext-struct">GMimeCipherContext</link>;
typedef     <link linkend="GMimeCipherValidity">GMimeCipherValidity</link>;
            <link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link>;
enum        <link linkend="GMimeSignatureStatus">GMimeSignatureStatus</link>;
enum        <link linkend="GMimeSignerStatus">GMimeSignerStatus</link>;
enum        <link linkend="GMimeSignerTrust">GMimeSignerTrust</link>;
            <link linkend="GMimeSigner">GMimeSigner</link>;
<link linkend="GMimeCipherHash">GMimeCipherHash</link> <link linkend="g-mime-cipher-hash-id">g_mime_cipher_hash_id</link>       (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             const <link linkend="char">char</link> *hash);
const <link linkend="char">char</link>* <link linkend="g-mime-cipher-hash-name">g_mime_cipher_hash_name</link>         (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GMimeCipherHash">GMimeCipherHash</link> hash);
<link linkend="int">int</link>         <link linkend="g-mime-cipher-sign">g_mime_cipher_sign</link>              (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             const <link linkend="char">char</link> *userid,
                                             <link linkend="GMimeCipherHash">GMimeCipherHash</link> hash,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GMimeStream">GMimeStream</link> *ostream,
                                             <link linkend="GError">GError</link> **err);
<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link>* <link linkend="g-mime-cipher-verify">g_mime_cipher_verify</link>
                                            (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GMimeCipherHash">GMimeCipherHash</link> hash,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GMimeStream">GMimeStream</link> *sigstream,
                                             <link linkend="GError">GError</link> **err);
<link linkend="int">int</link>         <link linkend="g-mime-cipher-encrypt">g_mime_cipher_encrypt</link>           (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="gboolean">gboolean</link> sign,
                                             const <link linkend="char">char</link> *userid,
                                             <link linkend="GPtrArray">GPtrArray</link> *recipients,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GMimeStream">GMimeStream</link> *ostream,
                                             <link linkend="GError">GError</link> **err);
<link linkend="int">int</link>         <link linkend="g-mime-cipher-decrypt">g_mime_cipher_decrypt</link>           (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GMimeStream">GMimeStream</link> *ostream,
                                             <link linkend="GError">GError</link> **err);
<link linkend="int">int</link>         <link linkend="g-mime-cipher-import-keys">g_mime_cipher_import_keys</link>       (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GError">GError</link> **err);
<link linkend="int">int</link>         <link linkend="g-mime-cipher-export-keys">g_mime_cipher_export_keys</link>       (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GPtrArray">GPtrArray</link> *keys,
                                             <link linkend="GMimeStream">GMimeStream</link> *ostream,
                                             <link linkend="GError">GError</link> **err);

<link linkend="GMimeSigner">GMimeSigner</link>* <link linkend="g-mime-signer-new">g_mime_signer_new</link>              (void);
<link linkend="void">void</link>        <link linkend="g-mime-signer-free">g_mime_signer_free</link>              (<link linkend="GMimeSigner">GMimeSigner</link> *signer);

<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link>* <link linkend="g-mime-signature-validity-new">g_mime_signature_validity_new</link>
                                            (void);
<link linkend="void">void</link>        <link linkend="g-mime-signature-validity-free">g_mime_signature_validity_free</link>  (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity);
<link linkend="GMimeSignatureStatus">GMimeSignatureStatus</link> <link linkend="g-mime-signature-validity-get-status">g_mime_signature_validity_get_status</link>
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity);
<link linkend="void">void</link>        <link linkend="g-mime-signature-validity-set-status">g_mime_signature_validity_set_status</link>
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity,
                                             <link linkend="GMimeSignatureStatus">GMimeSignatureStatus</link> status);
const <link linkend="char">char</link>* <link linkend="g-mime-signature-validity-get-details">g_mime_signature_validity_get_details</link>
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity);
<link linkend="void">void</link>        <link linkend="g-mime-signature-validity-set-details">g_mime_signature_validity_set_details</link>
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity,
                                             const <link linkend="char">char</link> *details);
const <link linkend="GMimeSigner">GMimeSigner</link>* <link linkend="g-mime-signature-validity-get-signers">g_mime_signature_validity_get_signers</link>
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity);
<link linkend="void">void</link>        <link linkend="g-mime-signature-validity-add-signer">g_mime_signature_validity_add_signer</link>
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity,
                                             <link linkend="GMimeSigner">GMimeSigner</link> *signer);

<link linkend="void">void</link>        <link linkend="g-mime-cipher-validity-init">g_mime_cipher_validity_init</link>     (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);
<link linkend="GMimeCipherValidity">GMimeCipherValidity</link>* <link linkend="g-mime-cipher-validity-new">g_mime_cipher_validity_new</link>
                                            (void);
<link linkend="void">void</link>        <link linkend="g-mime-cipher-validity-clear">g_mime_cipher_validity_clear</link>    (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);
<link linkend="void">void</link>        <link linkend="g-mime-cipher-validity-free">g_mime_cipher_validity_free</link>     (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);
<link linkend="gboolean">gboolean</link>    <link linkend="g-mime-cipher-validity-get-valid">g_mime_cipher_validity_get_valid</link>
                                            (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);
<link linkend="void">void</link>        <link linkend="g-mime-cipher-validity-set-valid">g_mime_cipher_validity_set_valid</link>
                                            (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity,
                                             <link linkend="gboolean">gboolean</link> valid);
const <link linkend="char">char</link>* <link linkend="g-mime-cipher-validity-get-description">g_mime_cipher_validity_get_description</link>
                                            (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);
<link linkend="void">void</link>        <link linkend="g-mime-cipher-validity-set-description">g_mime_cipher_validity_set_description</link>
                                            (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity,
                                             const <link linkend="char">char</link> *description);


</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----GMimeCipherContext
         +----<link linkend="GMimeGpgContext">GMimeGpgContext</link>
</synopsis>

</refsect1>








<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMimeCipherHash"/>enum GMimeCipherHash</title>
<indexterm><primary>GMimeCipherHash</primary></indexterm><programlisting>typedef enum {
	GMIME_CIPHER_HASH_DEFAULT,
	GMIME_CIPHER_HASH_MD2,
	GMIME_CIPHER_HASH_MD5,
	GMIME_CIPHER_HASH_SHA1,
	GMIME_CIPHER_HASH_RIPEMD160,
	GMIME_CIPHER_HASH_TIGER192,
	GMIME_CIPHER_HASH_HAVAL5160
} GMimeCipherHash;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GMimeCipherContext-struct"/>GMimeCipherContext</title>
<indexterm><primary>GMimeCipherContext</primary></indexterm><programlisting>typedef struct _GMimeCipherContext GMimeCipherContext;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GMimeCipherValidity"/>GMimeCipherValidity</title>
<indexterm role="deprecated"><primary>GMimeCipherValidity</primary></indexterm><programlisting>typedef struct _GMimeSignatureValidity GMimeCipherValidity;
</programlisting>
<warning><para><literal>GMimeCipherValidity</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GMimeSignatureValidity"/>GMimeSignatureValidity</title>
<indexterm><primary>GMimeSignatureValidity</primary></indexterm><programlisting>typedef struct {
	GMimeSignatureStatus status;
	GMimeSigner *signers;
	char *details;
} GMimeSignatureValidity;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GMimeSignatureStatus"/>enum GMimeSignatureStatus</title>
<indexterm><primary>GMimeSignatureStatus</primary></indexterm><programlisting>typedef enum {
	GMIME_SIGNATURE_STATUS_NONE,
	GMIME_SIGNATURE_STATUS_GOOD,
	GMIME_SIGNATURE_STATUS_BAD,
	GMIME_SIGNATURE_STATUS_UNKNOWN
} GMimeSignatureStatus;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GMimeSignerStatus"/>enum GMimeSignerStatus</title>
<indexterm><primary>GMimeSignerStatus</primary></indexterm><programlisting>typedef enum {
	GMIME_SIGNER_STATUS_NONE,
	GMIME_SIGNER_STATUS_GOOD,
	GMIME_SIGNER_STATUS_BAD,
	GMIME_SIGNER_STATUS_ERROR
} GMimeSignerStatus;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GMimeSignerTrust"/>enum GMimeSignerTrust</title>
<indexterm><primary>GMimeSignerTrust</primary></indexterm><programlisting>typedef enum {
	GMIME_SIGNER_TRUST_NONE,
	GMIME_SIGNER_TRUST_NEVER,
	GMIME_SIGNER_TRUST_UNDEFINED,
	GMIME_SIGNER_TRUST_MARGINAL,
	GMIME_SIGNER_TRUST_FULLY,
	GMIME_SIGNER_TRUST_ULTIMATE
} GMimeSignerTrust;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GMimeSigner"/>GMimeSigner</title>
<indexterm><primary>GMimeSigner</primary></indexterm><programlisting>typedef struct {
	struct _GMimeSigner *next;
	unsigned int status:2;    /* GMimeSignerStatus */
	unsigned int errors:4;    /* bitfield of GMimeSignerError's */
	unsigned int trust:3;     /* GMimeSignerTrust */
	unsigned int unused:23;   /* unused expansion bits */
	time_t sig_created;
	time_t sig_expire;
	char *fingerprint;
	char *keyid;
	char *name;
} GMimeSigner;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-hash-id"/>g_mime_cipher_hash_id ()</title>
<indexterm><primary>g_mime_cipher_hash_id</primary></indexterm><programlisting><link linkend="GMimeCipherHash">GMimeCipherHash</link> g_mime_cipher_hash_id       (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             const <link linkend="char">char</link> *hash);</programlisting>
<para>
Gets the hash id based on the hash name <parameter>hash</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter>&nbsp;:</term>
<listitem><simpara> Cipher Context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hash</parameter>&nbsp;:</term>
<listitem><simpara> hash name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the equivalent hash id or <link linkend="GMIME-CIPHER-HASH-DEFAULT:CAPS"><type>GMIME_CIPHER_HASH_DEFAULT</type></link> on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-hash-name"/>g_mime_cipher_hash_name ()</title>
<indexterm><primary>g_mime_cipher_hash_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_cipher_hash_name         (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GMimeCipherHash">GMimeCipherHash</link> hash);</programlisting>
<para>
Gets the hash name based on the hash id <parameter>hash</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter>&nbsp;:</term>
<listitem><simpara> Cipher Context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hash</parameter>&nbsp;:</term>
<listitem><simpara> hash id
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the equivalent hash name or <literal>NULL</literal> on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-sign"/>g_mime_cipher_sign ()</title>
<indexterm><primary>g_mime_cipher_sign</primary></indexterm><programlisting><link linkend="int">int</link>         g_mime_cipher_sign              (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             const <link linkend="char">char</link> *userid,
                                             <link linkend="GMimeCipherHash">GMimeCipherHash</link> hash,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GMimeStream">GMimeStream</link> *ostream,
                                             <link linkend="GError">GError</link> **err);</programlisting>
<para>
Signs the input stream and writes the resulting signature to the output stream.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter>&nbsp;:</term>
<listitem><simpara> Cipher Context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>userid</parameter>&nbsp;:</term>
<listitem><simpara> private key to use to sign the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hash</parameter>&nbsp;:</term>
<listitem><simpara> preferred Message-Integrity-Check hash algorithm
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>istream</parameter>&nbsp;:</term>
<listitem><simpara> input stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ostream</parameter>&nbsp;:</term>
<listitem><simpara> output stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara> exception
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>0 on success or -1 on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-verify"/>g_mime_cipher_verify ()</title>
<indexterm><primary>g_mime_cipher_verify</primary></indexterm><programlisting><link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link>* g_mime_cipher_verify
                                            (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GMimeCipherHash">GMimeCipherHash</link> hash,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GMimeStream">GMimeStream</link> *sigstream,
                                             <link linkend="GError">GError</link> **err);</programlisting>
<para>
Verifies the signature. If <parameter>istream</parameter> is a clearsigned stream,
you should pass <literal>NULL</literal> as the sigstream parameter. Otherwise
<parameter>sigstream</parameter> is assumed to be the signature stream and is used to
verify the integirity of the <parameter>istream</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter>&nbsp;:</term>
<listitem><simpara> Cipher Context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hash</parameter>&nbsp;:</term>
<listitem><simpara> secure hash used
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>istream</parameter>&nbsp;:</term>
<listitem><simpara> input stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sigstream</parameter>&nbsp;:</term>
<listitem><simpara> optional detached-signature stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara> exception
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a <link linkend="GMimeSignatureValidity"><type>GMimeSignatureValidity</type></link> structure containing information
about the integrity of the input stream or <literal>NULL</literal> on failure to
execute at all.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-encrypt"/>g_mime_cipher_encrypt ()</title>
<indexterm><primary>g_mime_cipher_encrypt</primary></indexterm><programlisting><link linkend="int">int</link>         g_mime_cipher_encrypt           (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="gboolean">gboolean</link> sign,
                                             const <link linkend="char">char</link> *userid,
                                             <link linkend="GPtrArray">GPtrArray</link> *recipients,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GMimeStream">GMimeStream</link> *ostream,
                                             <link linkend="GError">GError</link> **err);</programlisting>
<para>
Encrypts (and optionally signs) the cleartext input stream and
writes the resulting ciphertext to the output stream.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter>&nbsp;:</term>
<listitem><simpara> Cipher Context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sign</parameter>&nbsp;:</term>
<listitem><simpara> sign as well as encrypt
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>userid</parameter>&nbsp;:</term>
<listitem><simpara> key id (or email address) to use when signing (assuming <parameter>sign</parameter> is <literal>TRUE</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>recipients</parameter>&nbsp;:</term>
<listitem><simpara> an array of recipient key ids and/or email addresses
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>istream</parameter>&nbsp;:</term>
<listitem><simpara> cleartext input stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ostream</parameter>&nbsp;:</term>
<listitem><simpara> ciphertext output stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara> exception
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>0 on success or -1 on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-decrypt"/>g_mime_cipher_decrypt ()</title>
<indexterm><primary>g_mime_cipher_decrypt</primary></indexterm><programlisting><link linkend="int">int</link>         g_mime_cipher_decrypt           (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GMimeStream">GMimeStream</link> *ostream,
                                             <link linkend="GError">GError</link> **err);</programlisting>
<para>
Decrypts the ciphertext input stream and writes the resulting
cleartext to the output stream.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter>&nbsp;:</term>
<listitem><simpara> Cipher Context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>istream</parameter>&nbsp;:</term>
<listitem><simpara> input/ciphertext stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ostream</parameter>&nbsp;:</term>
<listitem><simpara> output/cleartext stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara> exception
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>0 on success or -1 for fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-import-keys"/>g_mime_cipher_import_keys ()</title>
<indexterm><primary>g_mime_cipher_import_keys</primary></indexterm><programlisting><link linkend="int">int</link>         g_mime_cipher_import_keys       (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GMimeStream">GMimeStream</link> *istream,
                                             <link linkend="GError">GError</link> **err);</programlisting>
<para>
Imports a stream of keys/certificates contained within <parameter>istream</parameter>
into the key/certificate database controlled by <parameter>ctx</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter>&nbsp;:</term>
<listitem><simpara> Cipher Context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>istream</parameter>&nbsp;:</term>
<listitem><simpara> input stream (containing keys)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara> exception
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>0 on success or -1 on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-export-keys"/>g_mime_cipher_export_keys ()</title>
<indexterm><primary>g_mime_cipher_export_keys</primary></indexterm><programlisting><link linkend="int">int</link>         g_mime_cipher_export_keys       (<link linkend="GMimeCipherContext">GMimeCipherContext</link> *ctx,
                                             <link linkend="GPtrArray">GPtrArray</link> *keys,
                                             <link linkend="GMimeStream">GMimeStream</link> *ostream,
                                             <link linkend="GError">GError</link> **err);</programlisting>
<para>
Exports the keys/certificates in <parameter>keys</parameter> to the stream <parameter>ostream</parameter> from
the key/certificate database controlled by <parameter>ctx</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter>&nbsp;:</term>
<listitem><simpara> Cipher Context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>keys</parameter>&nbsp;:</term>
<listitem><simpara> an array of key ids
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ostream</parameter>&nbsp;:</term>
<listitem><simpara> output stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara> exception
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>0 on success or -1 on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signer-new"/>g_mime_signer_new ()</title>
<indexterm><primary>g_mime_signer_new</primary></indexterm><programlisting><link linkend="GMimeSigner">GMimeSigner</link>* g_mime_signer_new              (void);</programlisting>
<para>
Allocates an new GMimeSigner.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a new <link linkend="GMimeSigner"><type>GMimeSigner</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signer-free"/>g_mime_signer_free ()</title>
<indexterm><primary>g_mime_signer_free</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_signer_free              (<link linkend="GMimeSigner">GMimeSigner</link> *signer);</programlisting>
<para>
Free's the singleton signer.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>signer</parameter>&nbsp;:</term>
<listitem><simpara> signer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signature-validity-new"/>g_mime_signature_validity_new ()</title>
<indexterm><primary>g_mime_signature_validity_new</primary></indexterm><programlisting><link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link>* g_mime_signature_validity_new
                                            (void);</programlisting>
<para>
Creates a new <link linkend="GMimeSignatureValidity"><type>GMimeSignatureValidity</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a new <link linkend="GMimeSignatureValidity"><type>GMimeSignatureValidity</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signature-validity-free"/>g_mime_signature_validity_free ()</title>
<indexterm><primary>g_mime_signature_validity_free</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_signature_validity_free  (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity);</programlisting>
<para>
Frees the memory used by <parameter>validity</parameter> back to the system.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> signature validity
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signature-validity-get-status"/>g_mime_signature_validity_get_status ()</title>
<indexterm><primary>g_mime_signature_validity_get_status</primary></indexterm><programlisting><link linkend="GMimeSignatureStatus">GMimeSignatureStatus</link> g_mime_signature_validity_get_status
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity);</programlisting>
<para>
Gets the signature status (GOOD, BAD, UNKNOWN).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> signature validity
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a <link linkend="GMimeSignatureStatus"><type>GMimeSignatureStatus</type></link> value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signature-validity-set-status"/>g_mime_signature_validity_set_status ()</title>
<indexterm><primary>g_mime_signature_validity_set_status</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_signature_validity_set_status
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity,
                                             <link linkend="GMimeSignatureStatus">GMimeSignatureStatus</link> status);</programlisting>
<para>
Sets the status of the signature on <parameter>validity</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> signature validity
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter>&nbsp;:</term>
<listitem><simpara> GOOD, BAD or UNKNOWN
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signature-validity-get-details"/>g_mime_signature_validity_get_details ()</title>
<indexterm><primary>g_mime_signature_validity_get_details</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_signature_validity_get_details
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity);</programlisting>
<para>
Gets any user-readable status details.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> signature validity
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a user-readable string containing any status information.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signature-validity-set-details"/>g_mime_signature_validity_set_details ()</title>
<indexterm><primary>g_mime_signature_validity_set_details</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_signature_validity_set_details
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity,
                                             const <link linkend="char">char</link> *details);</programlisting>
<para>
Sets <parameter>details</parameter> as the status details string on <parameter>validity</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> signature validity
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>details</parameter>&nbsp;:</term>
<listitem><simpara> details string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signature-validity-get-signers"/>g_mime_signature_validity_get_signers ()</title>
<indexterm><primary>g_mime_signature_validity_get_signers</primary></indexterm><programlisting>const <link linkend="GMimeSigner">GMimeSigner</link>* g_mime_signature_validity_get_signers
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity);</programlisting>
<para>
Gets the list of signers.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> signature validity
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a <link linkend="GMimeSigner"><type>GMimeSigner</type></link> list which contain further information such
as trust and cipher keys.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-signature-validity-add-signer"/>g_mime_signature_validity_add_signer ()</title>
<indexterm><primary>g_mime_signature_validity_add_signer</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_signature_validity_add_signer
                                            (<link linkend="GMimeSignatureValidity">GMimeSignatureValidity</link> *validity,
                                             <link linkend="GMimeSigner">GMimeSigner</link> *signer);</programlisting>
<para>
Adds <parameter>signer</parameter> to the list of signers on <parameter>validity</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> signature validity
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>signer</parameter>&nbsp;:</term>
<listitem><simpara> signer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-validity-init"/>g_mime_cipher_validity_init ()</title>
<indexterm role="deprecated"><primary>g_mime_cipher_validity_init</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_cipher_validity_init     (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);</programlisting>
<warning><para><literal>g_mime_cipher_validity_init</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Initializes the validity structure.
</para>
<para>
WARNING: This interface has been deprecated.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> validity structure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-validity-new"/>g_mime_cipher_validity_new ()</title>
<indexterm role="deprecated"><primary>g_mime_cipher_validity_new</primary></indexterm><programlisting><link linkend="GMimeCipherValidity">GMimeCipherValidity</link>* g_mime_cipher_validity_new
                                            (void);</programlisting>
<warning><para><literal>g_mime_cipher_validity_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new validity structure.
</para>
<para>
WARNING: This interface has been deprecated. Use
<link linkend="g-mime-signature-validity-new"><function>g_mime_signature_validity_new()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a new <link linkend="GMimeCipherValidity"><type>GMimeCipherValidity</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-validity-clear"/>g_mime_cipher_validity_clear ()</title>
<indexterm role="deprecated"><primary>g_mime_cipher_validity_clear</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_cipher_validity_clear    (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);</programlisting>
<warning><para><literal>g_mime_cipher_validity_clear</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Clears the contents of the validity structure.
</para>
<para>
WARNING: This interface has been deprecated.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> validity structure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-validity-free"/>g_mime_cipher_validity_free ()</title>
<indexterm role="deprecated"><primary>g_mime_cipher_validity_free</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_cipher_validity_free     (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);</programlisting>
<warning><para><literal>g_mime_cipher_validity_free</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Frees the memory used by <parameter>validity</parameter> back to the system.
</para>
<para>
WARNING: This interface has been deprecated. Use
<link linkend="g-mime-signature-validity-free"><function>g_mime_signature_validity_free()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> validity structure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-validity-get-valid"/>g_mime_cipher_validity_get_valid ()</title>
<indexterm role="deprecated"><primary>g_mime_cipher_validity_get_valid</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    g_mime_cipher_validity_get_valid
                                            (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);</programlisting>
<warning><para><literal>g_mime_cipher_validity_get_valid</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Gets the validity of the validity structure <parameter>validity</parameter>.
</para>
<para>
WARNING: This interface has been deprecated. Use
<link linkend="g-mime-signature-validity-get-status"><function>g_mime_signature_validity_get_status()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> validity structure
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara><literal>TRUE</literal> if <parameter>validity</parameter> is valid or <literal>FALSE</literal> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-validity-set-valid"/>g_mime_cipher_validity_set_valid ()</title>
<indexterm role="deprecated"><primary>g_mime_cipher_validity_set_valid</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_cipher_validity_set_valid
                                            (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity,
                                             <link linkend="gboolean">gboolean</link> valid);</programlisting>
<warning><para><literal>g_mime_cipher_validity_set_valid</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the validness on the validity structure.
</para>
<para>
WARNING: This interface has been deprecated. Use
<link linkend="g-mime-signature-validity-set-status"><function>g_mime_signature_validity_set_status()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> validity structure
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>valid</parameter>&nbsp;:</term>
<listitem><simpara> <literal>TRUE</literal> if valid else <literal>FALSE</literal>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-validity-get-description"/>g_mime_cipher_validity_get_description ()</title>
<indexterm role="deprecated"><primary>g_mime_cipher_validity_get_description</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_cipher_validity_get_description
                                            (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity);</programlisting>
<warning><para><literal>g_mime_cipher_validity_get_description</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Gets the description set on the validity structure <parameter>validity</parameter>.
</para>
<para>
WARNING: This interface has been deprecated. Use
<link linkend="g-mime-signature-validity-get-details"><function>g_mime_signature_validity_get_details()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> validity structure
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>any description set on the validity structure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-cipher-validity-set-description"/>g_mime_cipher_validity_set_description ()</title>
<indexterm role="deprecated"><primary>g_mime_cipher_validity_set_description</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_cipher_validity_set_description
                                            (<link linkend="GMimeCipherValidity">GMimeCipherValidity</link> *validity,
                                             const <link linkend="char">char</link> *description);</programlisting>
<warning><para><literal>g_mime_cipher_validity_set_description</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the description on the validity structure.
</para>
<para>
WARNING: This interface has been deprecated. Use
<link linkend="g-mime-signature-validity-set-details"><function>g_mime_signature_validity_set_details()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>validity</parameter>&nbsp;:</term>
<listitem><simpara> validity structure
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>description</parameter>&nbsp;:</term>
<listitem><simpara> validity description
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>