cvs: phpdoc /en/reference/gnupg configure.xml constants.xml functions.xml ini.xml reference.xml /en/reference/gnupg/functions gnupg-adddecryptkey.xml
gnupg-addencryptkey.xml gnupg-addsignkey.xml gnupg-cleardecryptkeys.xml gnupg-clearencryptkeys.xml gnupg-clearsignkeys.xml gnupg-decrypt.xml
gnupg-decryptverify.xml gnupg-encrypt.xml gnupg-encryptsign.xml gnupg-export.xml gnupg-geterror.xml gnupg-getprotocol.xml gnupg-import.xml
gnupg-keyinfo.xml gnupg-setarmor.xml gnupg-setsignmode.xml gnupg-sign.xml gnupg-verify.xml
| From: | Thilo Raufeisen | Date: | Sat, 29 Oct 2005 16:08:10 +0000 |
| Subject: | cvs: phpdoc /en/reference/gnupg configure.xml constants.xml functions.xml ini.xml reference.xml /en/reference/gnupg/functions gnupg-adddecryptkey.xml gnupg-addencryptkey.xml gnupg-addsignkey.xml gnupg-cleardecryptkeys.xml gnupg-clearencryptkeys.xml gnupg-clearsignkeys.xml gnupg-decrypt.xml gnupg-decryptverify.xml gnupg-encrypt.xml gnupg-encryptsign.xml gnupg-export.xml gnupg-geterror.xml gnupg-getprotocol.xml gnupg-import.xml gnupg-keyinfo.xml gnupg-setarmor.xml gnupg-setsignmode.xml gnupg-sign.xml gnupg-verify.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969370703@lists.php.net to get a copy of this message | ||
traufeisen Sat Oct 29 12:08:10 2005 EDT
Added files:
/phpdoc/en/reference/gnupg configure.xml constants.xml
functions.xml ini.xml reference.xml
/phpdoc/en/reference/gnupg/functions gnupg-adddecryptkey.xml
gnupg-addencryptkey.xml
gnupg-addsignkey.xml
gnupg-cleardecryptkeys.xml
gnupg-clearencryptkeys.xml
gnupg-clearsignkeys.xml
gnupg-decrypt.xml
gnupg-decryptverify.xml
gnupg-encrypt.xml
gnupg-encryptsign.xml
gnupg-export.xml
gnupg-geterror.xml
gnupg-getprotocol.xml
gnupg-import.xml
gnupg-keyinfo.xml
gnupg-setarmor.xml
gnupg-setsignmode.xml
gnupg-sign.xml
gnupg-verify.xml
Log:
initial release
http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/configure.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/configure.xml +++ phpdoc/en/reference/gnupg/configure.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="gnupg.installation"> &reftitle.install; <para> The gnupg-extension is not bundled with PHP. It is a <ulink url="http://pecl.php.net/">PECL</ulink> extension and can be located here: <ulink url="http://pecl.php.net/package/gnupg">http://pecl.php.net/package/gnupg</ulink>. </para> </section> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/constants.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/constants.xml +++ phpdoc/en/reference/gnupg/constants.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id='gnupg.constants'> &reftitle.constants; <variablelist> <varlistentry> <term> <constant>GNUPG_SIG_MODE_NORMAL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIG_MODE_DETACH</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIG_MODE_CLEAR</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_UNKNOWN</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_UNDEFINED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_NEVER</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_MARGINAL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_FULL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_ULTIMATE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_PROTOCOL_OpenPGP</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_PROTOCOL_CMS</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_VALID</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_GREEN</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_RED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_KEY_REVOKED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_KEY_EXPIRED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_KEY_MISSING</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_SIG_EXPIRED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_CRL_MISSING</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_CRL_TOO_OLD</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_BAD_POLICY</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_SYS_ERROR</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> </variablelist> </section> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions.xml +++ phpdoc/en/reference/gnupg/functions.xml &reference.gnupg.functions.gnupg-adddecryptkey; &reference.gnupg.functions.gnupg-addencryptkey; &reference.gnupg.functions.gnupg-addsignkey; &reference.gnupg.functions.gnupg-cleardecryptkeys; &reference.gnupg.functions.gnupg-clearencryptkeys; &reference.gnupg.functions.gnupg-clearsignkeys; &reference.gnupg.functions.gnupg-decrypt; &reference.gnupg.functions.gnupg-decryptverify; &reference.gnupg.functions.gnupg-encrypt; &reference.gnupg.functions.gnupg-encryptsign; &reference.gnupg.functions.gnupg-export; &reference.gnupg.functions.gnupg-geterror; &reference.gnupg.functions.gnupg-getprotocol; &reference.gnupg.functions.gnupg-import; &reference.gnupg.functions.gnupg-keyinfo; &reference.gnupg.functions.gnupg-setarmor; &reference.gnupg.functions.gnupg-setsignmode; &reference.gnupg.functions.gnupg-sign; &reference.gnupg.functions.gnupg-verify; http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/ini.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/ini.xml +++ phpdoc/en/reference/gnupg/ini.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="gnupg.configuration"> &reftitle.runtime; &no.config; </section> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/reference.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/reference.xml +++ phpdoc/en/reference/gnupg/reference.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Purpose: utilspec.nontext --> <!-- Membership: pecl --> <!-- State: beta --> <reference id="ref.gnupg"> <title>gnupg &Functions;</title> <titleabbrev>gnupg</titleabbrev> <partintro> <section id="gnupg.intro"> &reftitle.intro; <para> This module allows you to interact with <ulink url="http://www.gnupg.org/">gnupg</ulink>. &warn.experimental; </para> </section> <section id="gnupg.requirements"> &reftitle.required; <para> The gnupg extension requires PHP 4.3. To use this extension in an OO style, PHP 5 is required. </para> <para> This extension requires the <ulink url="http://www.gnupg.org/(en)/download/index.html#gpgme">gpgme library</ulink> </para> </section> &reference.gnupg.configure; &reference.gnupg.constants; <section id="gnupg.notes"> &reftitle.notes; <para> This extension makes use of the keyring of the current user. This keyring is normaly located in ~./.gnupg/. To specify a custom location, store the path to the keyring in the enviroment variable GNUPGHOME. See <link linkend='function.putenv'>putenv</link> for more information how to do this. </para> <para> Some functions require the specification of a key. This specification can be anything that refers to an unique key (userid, key-id, fingerprint ...). This documentation uses the fingerprint in all examples. </para> </section> <section id="gnupg.keylistiterator"> <title>keylistiterator</title> <para> This extension also comes with an Iterator for your keyring. <programlisting role="php"> <![CDATA[ <?php // create a new iterator for listing all public keys that matches 'example' $iterator = new gnupg_keylistiterator("example"); foreach($iterator as $fingerprint => $userid){ echo $fingerprint." -> ".$userid."\n"; } ?> ]]> </programlisting> </para> </section> <section id="gnupg.examples"> &reftitle.examples; <para> This example will clearsign a given text. </para> <example> <title>gnupg clearsign example (procedural)</title> <programlisting role="php"> <![CDATA[ <?php // init gnupg $res = gnupg_init(); // not really needed: Clearsign is default gnupg_setsignmode($res,GNUPG_SIG_MODE_CLEAR); // add key with passphrase 'test' for signing gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); // sign $signed = gnupg_sign("just a test"); echo $signed; ?> ]]> </programlisting> </example> <example> <title>gnupg clearsign example (OO)</title> <programlisting role="php"> <![CDATA[ <?php // new class $gnupg = new gnupg(); // not really needed. Clearsign is default $gnupg->setsignmode(gnupg::SIG_MODE_CLEAR); // add key with passphrase 'test' for signing $gnupg->addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); // sign $signed = $gnupg->sign("just a test"); echo $signed; ?> ]]> </programlisting> </example> </section> </partintro> &reference.gnupg.functions; </reference> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-adddecryptkey"> <refnamediv> <refname>gnupg_adddecryptkey</refname> <refpurpose>add a key for decryption</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_adddecryptkey</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_adddecryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_adddecryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_adddecryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-addencryptkey"> <refnamediv> <refname>gnupg_addencryptkey</refname> <refpurpose>add a key for encryption</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_addencryptkey</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_addencryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addencryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_addencryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-addsignkey"> <refnamediv> <refname>gnupg_addsignkey</refname> <refpurpose>add a key for signing</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_addsignkey</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_addsignkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_addsignkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-cleardecryptkeys"> <refnamediv> <refname>gnupg_cleardecryptkeys</refname> <refpurpose>removes all keys which were set for decryption before</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_cleardecryptkeys</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_cleardecryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_cleardecryptkeys($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_cleardecryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> cleardecryptkeys(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-clearencryptkeys"> <refnamediv> <refname>gnupg_clearencryptkeys</refname> <refpurpose>removes all keys which were set for encryption before</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_clearencryptkeys</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_clearencryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_clearencryptkeys($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_clearencryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> clearencryptkeys(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-clearsignkeys"> <refnamediv> <refname>gnupg_clearsignkeys</refname> <refpurpose>removes all keys which were set for signing before</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_clearsignkeys</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_clearsignkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_clearsignkeys($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_clearsignkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> clearsignkeys(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-decrypt"> <refnamediv> <refname>gnupg_decrypt</refname> <refpurpose>decrypts a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_decrypt</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> Decrypts the given text with the keys, which were set with <link linkend='function.gnupg-adddecryptkey'>gnupg_adddecryptkey</link> before. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the decrypted text. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_decrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_adddecryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); $plain = gnupg_decrypt($res,$encrypted_text); echo $plain; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_encrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); $plain = $gpg -> decrypt($encrypted_text); echo $plain; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-decryptverify"> <refnamediv> <refname>gnupg_decryptverify</refname> <refpurpose>decrypts and verifies a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>gnupg_decryptverify</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Decrypts and verifies a given text and returns informations about the signature. The parameter <literal>plaintext</literal> gets filled with the decrypted text. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns informations about the signature and fills plaintext with the decrypted text. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_decryptverify</function> example</title> <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; $res = gnupg_init(); gnupg_adddecryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); $info = gnupg_decryptverify($res,$text,$plaintext); print_r($info); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_decryptverify</function> example</title> <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; $gpg = new gnupg(); $gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); $info = $gpg -> decryptverify($text,$plaintext); print_r($info); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-encrypt"> <refnamediv> <refname>gnupg_encrypt</refname> <refpurpose>encrypts a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_encrypt</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Encrypts the given plaintext with the keys, which were set with <link linkend='function.gnupg-addencryptkey'>gnupg_addencryptkey</link> before and returns the encrypted text. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the encrypted text. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_encrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addencryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC"); $enc = gnupg_encrypt($res, "just a test"); echo $enc; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_encrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); $enc = $gpg -> encrypt("just a test"); echo $enc; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-encryptsign"> <refnamediv> <refname>gnupg_encryptsign</refname> <refpurpose>encrypts and signs a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_encryptsign</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Encrypts and signs the given plaintext with the keys, which were set with <link linkend='function.gnupg-addsignkey'>gnupg_addsignkey</link> and <link linkend='function.gnupg-addencryptkey'>gnupg_addencryptkey</link> before and returns the encrypted and signed text. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the encrypted and signed text. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_encryptsign</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addencryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC"); gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); $enc = gnupg_encryptsign($res, "just a test"); echo $enc; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_encryptsign</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); $gpg -> addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); $enc = $gpg -> encryptsign("just a test"); echo $enc; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-export.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-export.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-export.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-export"> <refnamediv> <refname>gnupg_export</refname> <refpurpose>Exports a key</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_export</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> <para> Exports the key <literal>fingerprint</literal> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the keydata. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_export</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); $export = gnupg_export($res,"8660281B6051D071D94B5B230549F9DC851566DC"); echo $export; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_export</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $export = $gpg -> export("8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-geterror"> <refnamediv> <refname>gnupg_geterror</refname> <refpurpose>returns the errortext, if a function fails</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_geterror</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> returns an errortext, if an error has occured, otherwise &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_geterror</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); echo gnupg_geterror($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_geterror</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); echo $gpg -> geterror(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-getprotocol"> <refnamediv> <refname>gnupg_getprotocol</refname> <refpurpose>returns the currently active protocol for all operations</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>gnupg_getprotocol</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> returns the currently active protocol, which can be one of GNUPG_PROTOCOL_OpenPGP or GNUPG_PROTOCOL_CMS. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_getprotocol</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); echo gnupg_getprotocol($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_getprotocol</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); echo $gpg -> getprotocol(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-import.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-import.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-import.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-import"> <refnamediv> <refname>gnupg_import</refname> <refpurpose>Imports a key</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>gnupg_import</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>keydata</parameter></methodparam> </methodsynopsis> <para> Iports the key <literal>keydata</literal> and returns an array with informations about the importprocess. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns and info-array about the importprocess. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_import</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); $info = gnupg_import($res,$keydata); print_r($info); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_import</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $info = $gpg -> import($keydata); print_r($info); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-keyinfo"> <refnamediv> <refname>gnupg_keyinfo</refname> <refpurpose>returns an array with informations about all keys that matches the given pattern</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>gnupg_keyinfo</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> returns an array with informations about all keys that matches the given pattern or &false;, if an error has occured. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_keyinfo</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); $info = gnupg_keyinfo("test"); print_r($info); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_keyinfo</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $info = $gpg -> keyinfo("test"); print_r($info); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-setarmor"> <refnamediv> <refname>gnupg_setarmor</refname> <refpurpose>Toggle armored output</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_setarmor</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>int</type><parameter>armor</parameter></methodparam> </methodsynopsis> <para> Pass a non-zero interger-value to this function to enable armored-output (default). Pass 0 to disable armored output. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_setarmor</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_setarmor($res,1); // enable armored output gnupg_setarmor($res,0); // disable armored output; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_setarmor</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> setarmor(1); // enable armored output; $gpg -> setarmor(0); // disable armored output; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-setsignmode"> <refnamediv> <refname>gnupg_setsignmode</refname> <refpurpose>sets the mode for signing</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_setsignmode</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>int</type><parameter>signmode</parameter></methodparam> </methodsynopsis> <para> <literal>signmode</literal> is a constant indicating what type of signature should be produced. The possible values are GNUPG_SIG_MODE_NORMAL, GNUPG_SIG_MODE_DETACH and GNUPG_SIG_MODE_CLEAR. By default GNUPG_SIG_MODE_CLEAR is used. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_setsignmode</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_setsignmode($res,GNUPG_SIG_MODE_DETACH); // produce a detached signature ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_setsignmode</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> setsignmode(gnupg::SIG_MODE_DETACH); // produce a detached signature ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-sign.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-sign.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-sign.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-sign"> <refnamediv> <refname>gnupg_sign</refname> <refpurpose>signs a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_sign</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Signs the given plaintext with the keys, which were set with <link linkend='function.gnupg-addsignkey'>gnupg_addsignkey</link> before and returns the signed text or the signature, depending on what was set with <link linkend='function.gnupg-setsignmode'>gnupg_setsignmode</link> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the signed text/ the signature. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_sign</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); $signed = gnupg_sign($res, "just a test"); echo $signed; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_sign</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> setsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); $signed = $gpg -> sign("just a test"); echo $signed; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-verify.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-verify.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-verify.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-verify"> <refnamediv> <refname>gnupg_verify</refname> <refpurpose>verifies a signed text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>gnupg_verify</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>signed_text</parameter></methodparam> <methodparam><type>string</type><parameter>signature</parameter></methodparam> <methodparam choice="opt" role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Verifies the given signed_text and returns informations about the signature. To verify a clearsigned text, set signature to &false;. If the optional parameter <literal>plaintext</literal> is passed, it is filled with the plaintext. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns informations about the signature. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_verify</function> example</title> <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; $res = gnupg_init(); // clearsigned $info = gnupg_verify($res,$signed_text,false,$plaintext); print_r($info); // detached signature $info = gnupg_verify($res,$signed_text,$signature); print_r($info); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_verify</function> example</title> <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; $gpg = new gnupg(); // clearsigned $info = $gpg -> verify($signed_text,false,$plaintext); print_r($info); // detached signature $info = $gpg -> verify($signed_text,$signature); print_r($info); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->
http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/configure.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/configure.xml +++ phpdoc/en/reference/gnupg/configure.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="gnupg.installation"> &reftitle.install; <para> The gnupg-extension is not bundled with PHP. It is a <ulink url="http://pecl.php.net/">PECL</ulink> extension and can be located here: <ulink url="http://pecl.php.net/package/gnupg">http://pecl.php.net/package/gnupg</ulink>. </para> </section> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/constants.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/constants.xml +++ phpdoc/en/reference/gnupg/constants.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id='gnupg.constants'> &reftitle.constants; <variablelist> <varlistentry> <term> <constant>GNUPG_SIG_MODE_NORMAL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIG_MODE_DETACH</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIG_MODE_CLEAR</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_UNKNOWN</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_UNDEFINED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_NEVER</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_MARGINAL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_FULL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_VALIDITY_ULTIMATE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_PROTOCOL_OpenPGP</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_PROTOCOL_CMS</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_VALID</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_GREEN</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_RED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_KEY_REVOKED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_KEY_EXPIRED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_KEY_MISSING</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_SIG_EXPIRED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_CRL_MISSING</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_CRL_TOO_OLD</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_BAD_POLICY</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>GNUPG_SIGSUM_SYS_ERROR</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> </variablelist> </section> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions.xml +++ phpdoc/en/reference/gnupg/functions.xml &reference.gnupg.functions.gnupg-adddecryptkey; &reference.gnupg.functions.gnupg-addencryptkey; &reference.gnupg.functions.gnupg-addsignkey; &reference.gnupg.functions.gnupg-cleardecryptkeys; &reference.gnupg.functions.gnupg-clearencryptkeys; &reference.gnupg.functions.gnupg-clearsignkeys; &reference.gnupg.functions.gnupg-decrypt; &reference.gnupg.functions.gnupg-decryptverify; &reference.gnupg.functions.gnupg-encrypt; &reference.gnupg.functions.gnupg-encryptsign; &reference.gnupg.functions.gnupg-export; &reference.gnupg.functions.gnupg-geterror; &reference.gnupg.functions.gnupg-getprotocol; &reference.gnupg.functions.gnupg-import; &reference.gnupg.functions.gnupg-keyinfo; &reference.gnupg.functions.gnupg-setarmor; &reference.gnupg.functions.gnupg-setsignmode; &reference.gnupg.functions.gnupg-sign; &reference.gnupg.functions.gnupg-verify; http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/ini.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/ini.xml +++ phpdoc/en/reference/gnupg/ini.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="gnupg.configuration"> &reftitle.runtime; &no.config; </section> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/reference.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/reference.xml +++ phpdoc/en/reference/gnupg/reference.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Purpose: utilspec.nontext --> <!-- Membership: pecl --> <!-- State: beta --> <reference id="ref.gnupg"> <title>gnupg &Functions;</title> <titleabbrev>gnupg</titleabbrev> <partintro> <section id="gnupg.intro"> &reftitle.intro; <para> This module allows you to interact with <ulink url="http://www.gnupg.org/">gnupg</ulink>. &warn.experimental; </para> </section> <section id="gnupg.requirements"> &reftitle.required; <para> The gnupg extension requires PHP 4.3. To use this extension in an OO style, PHP 5 is required. </para> <para> This extension requires the <ulink url="http://www.gnupg.org/(en)/download/index.html#gpgme">gpgme library</ulink> </para> </section> &reference.gnupg.configure; &reference.gnupg.constants; <section id="gnupg.notes"> &reftitle.notes; <para> This extension makes use of the keyring of the current user. This keyring is normaly located in ~./.gnupg/. To specify a custom location, store the path to the keyring in the enviroment variable GNUPGHOME. See <link linkend='function.putenv'>putenv</link> for more information how to do this. </para> <para> Some functions require the specification of a key. This specification can be anything that refers to an unique key (userid, key-id, fingerprint ...). This documentation uses the fingerprint in all examples. </para> </section> <section id="gnupg.keylistiterator"> <title>keylistiterator</title> <para> This extension also comes with an Iterator for your keyring. <programlisting role="php"> <![CDATA[ <?php // create a new iterator for listing all public keys that matches 'example' $iterator = new gnupg_keylistiterator("example"); foreach($iterator as $fingerprint => $userid){ echo $fingerprint." -> ".$userid."\n"; } ?> ]]> </programlisting> </para> </section> <section id="gnupg.examples"> &reftitle.examples; <para> This example will clearsign a given text. </para> <example> <title>gnupg clearsign example (procedural)</title> <programlisting role="php"> <![CDATA[ <?php // init gnupg $res = gnupg_init(); // not really needed: Clearsign is default gnupg_setsignmode($res,GNUPG_SIG_MODE_CLEAR); // add key with passphrase 'test' for signing gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); // sign $signed = gnupg_sign("just a test"); echo $signed; ?> ]]> </programlisting> </example> <example> <title>gnupg clearsign example (OO)</title> <programlisting role="php"> <![CDATA[ <?php // new class $gnupg = new gnupg(); // not really needed. Clearsign is default $gnupg->setsignmode(gnupg::SIG_MODE_CLEAR); // add key with passphrase 'test' for signing $gnupg->addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); // sign $signed = $gnupg->sign("just a test"); echo $signed; ?> ]]> </programlisting> </example> </section> </partintro> &reference.gnupg.functions; </reference> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-adddecryptkey.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-adddecryptkey"> <refnamediv> <refname>gnupg_adddecryptkey</refname> <refpurpose>add a key for decryption</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_adddecryptkey</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_adddecryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_adddecryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_adddecryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-addencryptkey.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-addencryptkey"> <refnamediv> <refname>gnupg_addencryptkey</refname> <refpurpose>add a key for encryption</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_addencryptkey</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_addencryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addencryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_addencryptkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-addsignkey.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-addsignkey"> <refnamediv> <refname>gnupg_addsignkey</refname> <refpurpose>add a key for signing</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_addsignkey</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_addsignkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_addsignkey</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-cleardecryptkeys.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-cleardecryptkeys"> <refnamediv> <refname>gnupg_cleardecryptkeys</refname> <refpurpose>removes all keys which were set for decryption before</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_cleardecryptkeys</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_cleardecryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_cleardecryptkeys($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_cleardecryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> cleardecryptkeys(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-clearencryptkeys.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-clearencryptkeys"> <refnamediv> <refname>gnupg_clearencryptkeys</refname> <refpurpose>removes all keys which were set for encryption before</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_clearencryptkeys</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_clearencryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_clearencryptkeys($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_clearencryptkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> clearencryptkeys(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-clearsignkeys.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-clearsignkeys"> <refnamediv> <refname>gnupg_clearsignkeys</refname> <refpurpose>removes all keys which were set for signing before</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_clearsignkeys</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_clearsignkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_clearsignkeys($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_clearsignkeys</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> clearsignkeys(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-decrypt.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-decrypt"> <refnamediv> <refname>gnupg_decrypt</refname> <refpurpose>decrypts a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_decrypt</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> Decrypts the given text with the keys, which were set with <link linkend='function.gnupg-adddecryptkey'>gnupg_adddecryptkey</link> before. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the decrypted text. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_decrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_adddecryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); $plain = gnupg_decrypt($res,$encrypted_text); echo $plain; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_encrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); $plain = $gpg -> decrypt($encrypted_text); echo $plain; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-decryptverify.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-decryptverify"> <refnamediv> <refname>gnupg_decryptverify</refname> <refpurpose>decrypts and verifies a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>gnupg_decryptverify</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Decrypts and verifies a given text and returns informations about the signature. The parameter <literal>plaintext</literal> gets filled with the decrypted text. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns informations about the signature and fills plaintext with the decrypted text. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_decryptverify</function> example</title> <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; $res = gnupg_init(); gnupg_adddecryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); $info = gnupg_decryptverify($res,$text,$plaintext); print_r($info); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_decryptverify</function> example</title> <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; $gpg = new gnupg(); $gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); $info = $gpg -> decryptverify($text,$plaintext); print_r($info); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-encrypt.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-encrypt"> <refnamediv> <refname>gnupg_encrypt</refname> <refpurpose>encrypts a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_encrypt</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Encrypts the given plaintext with the keys, which were set with <link linkend='function.gnupg-addencryptkey'>gnupg_addencryptkey</link> before and returns the encrypted text. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the encrypted text. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_encrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addencryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC"); $enc = gnupg_encrypt($res, "just a test"); echo $enc; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_encrypt</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); $enc = $gpg -> encrypt("just a test"); echo $enc; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-encryptsign.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-encryptsign"> <refnamediv> <refname>gnupg_encryptsign</refname> <refpurpose>encrypts and signs a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_encryptsign</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Encrypts and signs the given plaintext with the keys, which were set with <link linkend='function.gnupg-addsignkey'>gnupg_addsignkey</link> and <link linkend='function.gnupg-addencryptkey'>gnupg_addencryptkey</link> before and returns the encrypted and signed text. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the encrypted and signed text. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_encryptsign</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addencryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC"); gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); $enc = gnupg_encryptsign($res, "just a test"); echo $enc; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_encryptsign</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); $gpg -> addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); $enc = $gpg -> encryptsign("just a test"); echo $enc; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-export.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-export.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-export.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-export"> <refnamediv> <refname>gnupg_export</refname> <refpurpose>Exports a key</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_export</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>fingerprint</parameter></methodparam> </methodsynopsis> <para> Exports the key <literal>fingerprint</literal> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the keydata. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_export</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); $export = gnupg_export($res,"8660281B6051D071D94B5B230549F9DC851566DC"); echo $export; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_export</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $export = $gpg -> export("8660281B6051D071D94B5B230549F9DC851566DC"); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-geterror.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-geterror"> <refnamediv> <refname>gnupg_geterror</refname> <refpurpose>returns the errortext, if a function fails</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_geterror</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> returns an errortext, if an error has occured, otherwise &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_geterror</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); echo gnupg_geterror($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_geterror</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); echo $gpg -> geterror(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-getprotocol.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-getprotocol"> <refnamediv> <refname>gnupg_getprotocol</refname> <refpurpose>returns the currently active protocol for all operations</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>gnupg_getprotocol</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> returns the currently active protocol, which can be one of GNUPG_PROTOCOL_OpenPGP or GNUPG_PROTOCOL_CMS. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_getprotocol</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); echo gnupg_getprotocol($res); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_getprotocol</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); echo $gpg -> getprotocol(); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-import.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-import.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-import.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-import"> <refnamediv> <refname>gnupg_import</refname> <refpurpose>Imports a key</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>gnupg_import</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>keydata</parameter></methodparam> </methodsynopsis> <para> Iports the key <literal>keydata</literal> and returns an array with informations about the importprocess. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns and info-array about the importprocess. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_import</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); $info = gnupg_import($res,$keydata); print_r($info); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_import</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $info = $gpg -> import($keydata); print_r($info); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-keyinfo.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-keyinfo"> <refnamediv> <refname>gnupg_keyinfo</refname> <refpurpose>returns an array with informations about all keys that matches the given pattern</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>gnupg_keyinfo</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> returns an array with informations about all keys that matches the given pattern or &false;, if an error has occured. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_keyinfo</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); $info = gnupg_keyinfo("test"); print_r($info); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_keyinfo</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $info = $gpg -> keyinfo("test"); print_r($info); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-setarmor.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-setarmor"> <refnamediv> <refname>gnupg_setarmor</refname> <refpurpose>Toggle armored output</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_setarmor</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>int</type><parameter>armor</parameter></methodparam> </methodsynopsis> <para> Pass a non-zero interger-value to this function to enable armored-output (default). Pass 0 to disable armored output. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_setarmor</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_setarmor($res,1); // enable armored output gnupg_setarmor($res,0); // disable armored output; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_setarmor</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> setarmor(1); // enable armored output; $gpg -> setarmor(0); // disable armored output; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-setsignmode.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-setsignmode"> <refnamediv> <refname>gnupg_setsignmode</refname> <refpurpose>sets the mode for signing</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>gnupg_setsignmode</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>int</type><parameter>signmode</parameter></methodparam> </methodsynopsis> <para> <literal>signmode</literal> is a constant indicating what type of signature should be produced. The possible values are GNUPG_SIG_MODE_NORMAL, GNUPG_SIG_MODE_DETACH and GNUPG_SIG_MODE_CLEAR. By default GNUPG_SIG_MODE_CLEAR is used. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns &true;. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_setsignmode</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_setsignmode($res,GNUPG_SIG_MODE_DETACH); // produce a detached signature ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_setsignmode</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> setsignmode(gnupg::SIG_MODE_DETACH); // produce a detached signature ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-sign.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-sign.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-sign.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-sign"> <refnamediv> <refname>gnupg_sign</refname> <refpurpose>signs a given text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>gnupg_sign</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Signs the given plaintext with the keys, which were set with <link linkend='function.gnupg-addsignkey'>gnupg_addsignkey</link> before and returns the signed text or the signature, depending on what was set with <link linkend='function.gnupg-setsignmode'>gnupg_setsignmode</link> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns the signed text/ the signature. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_sign</function> example</title> <programlisting role="php"> <![CDATA[ <?php $res = gnupg_init(); gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test"); $signed = gnupg_sign($res, "just a test"); echo $signed; ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_sign</function> example</title> <programlisting role="php"> <![CDATA[ <?php $gpg = new gnupg(); $gpg -> setsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); $signed = $gpg -> sign("just a test"); echo $signed; ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-verify.xml?r=1.1&p=1 Index: phpdoc/en/reference/gnupg/functions/gnupg-verify.xml +++ phpdoc/en/reference/gnupg/functions/gnupg-verify.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.gnupg-verify"> <refnamediv> <refname>gnupg_verify</refname> <refpurpose>verifies a signed text</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>gnupg_verify</methodname> <methodparam><type>resource</type><parameter>identifier</parameter></methodparam> <methodparam><type>string</type><parameter>signed_text</parameter></methodparam> <methodparam><type>string</type><parameter>signature</parameter></methodparam> <methodparam choice="opt" role="reference"><type>string</type><parameter>plaintext</parameter></methodparam> </methodsynopsis> <para> Verifies the given signed_text and returns informations about the signature. To verify a clearsigned text, set signature to &false;. If the optional parameter <literal>plaintext</literal> is passed, it is filled with the plaintext. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> On success, this function returns informations about the signature. On failure, this function returns &false;. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>procedural <function>gnupg_verify</function> example</title> <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; $res = gnupg_init(); // clearsigned $info = gnupg_verify($res,$signed_text,false,$plaintext); print_r($info); // detached signature $info = gnupg_verify($res,$signed_text,$signature); print_r($info); ?> ]]> </programlisting> </example> <example> <title>OO <function>gnupg_verify</function> example</title> <programlisting role="php"> <![CDATA[ <?php $plaintext = ""; $gpg = new gnupg(); // clearsigned $info = $gpg -> verify($signed_text,false,$plaintext); print_r($info); // detached signature $info = $gpg -> verify($signed_text,$signature); print_r($info); ?> ]]> </programlisting> </example> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->