[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[b358845] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY gpgme-download-http "&gnupg-http;/gpgme/gpgme-&gpgme-version;.tar.bz2">
|
---|
[14d673a2] | 8 | <!ENTITY gpgme-download-ftp " ">
|
---|
[1414135] | 9 | <!ENTITY gpgme-md5sum "01a8c05b409847e87daf0543e91f8c37">
|
---|
| 10 | <!ENTITY gpgme-size "1.8 MB">
|
---|
| 11 | <!ENTITY gpgme-buildsize "260 MB (with tests)">
|
---|
[ee01972] | 12 | <!ENTITY gpgme-time "1.0 SBU (with all bindings and tests; with parallelism=4)">
|
---|
[b358845] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gpgme" xreflabel="GPGME-&gpgme-version;">
|
---|
| 16 | <?dbhtml filename="gpgme.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>GPGME-&gpgme-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="gpgme">
|
---|
| 22 | <primary sortas="a-GPGME">GPGME</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to GPGME</title>
|
---|
| 27 |
|
---|
[d6da5da] | 28 | <para>
|
---|
[200bab29] | 29 | The <application>GPGME</application> package is a C library
|
---|
[bbacc9a] | 30 | that allows cryptography support to be added to a
|
---|
[d6da5da] | 31 | program. It is designed to make access to public key crypto
|
---|
| 32 | engines like <application>GnuPG</application> or GpgSM easier
|
---|
| 33 | for applications. <application>GPGME</application> provides
|
---|
| 34 | a high-level crypto API for encryption, decryption, signing,
|
---|
| 35 | signature verification and key management.
|
---|
| 36 | </para>
|
---|
[b358845] | 37 |
|
---|
[4c0efc3c] | 38 | &lfs122_checked;
|
---|
[b358845] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[d6da5da] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&gpgme-download-http;"/>
|
---|
| 45 | </para>
|
---|
[b358845] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[d6da5da] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&gpgme-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[b358845] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[d6da5da] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &gpgme-md5sum;
|
---|
| 55 | </para>
|
---|
[b358845] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[d6da5da] | 58 | <para>
|
---|
| 59 | Download size: &gpgme-size;
|
---|
| 60 | </para>
|
---|
[b358845] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[d6da5da] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &gpgme-buildsize;
|
---|
| 65 | </para>
|
---|
[b358845] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[d6da5da] | 68 | <para>
|
---|
| 69 | Estimated build time: &gpgme-time;
|
---|
| 70 | </para>
|
---|
[b358845] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
[e1d06c0] | 73 | <!--
|
---|
[367cbd0] | 74 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 75 | <itemizedlist spacing="compact">
|
---|
| 76 | <listitem>
|
---|
| 77 | <para>
|
---|
| 78 | Recommended patch (required if SWIG is installed):
|
---|
| 79 | <ulink url="&patch-root;/gpgme-&gpgme-version;-gpg_error_1_46-1.patch"/>
|
---|
| 80 | </para>
|
---|
| 81 | </listitem>
|
---|
| 82 | </itemizedlist>
|
---|
[e1d06c0] | 83 | -->
|
---|
[b358845] | 84 | <bridgehead renderas="sect3">GPGME Dependencies</bridgehead>
|
---|
| 85 |
|
---|
| 86 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[d6da5da] | 87 | <para role="required">
|
---|
| 88 | <xref linkend="libassuan"/>
|
---|
| 89 | </para>
|
---|
[b358845] | 90 |
|
---|
| 91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[289d262f] | 92 | <para role="optional">
|
---|
[33690a1] | 93 | <xref linkend="doxygen"/> and
|
---|
[cd074c2] | 94 | <xref linkend="graphviz"/> (for API documentation),
|
---|
[33690a1] | 95 | <xref linkend="gnupg2"/> (required if Qt or SWIG are installed;
|
---|
[48771ae] | 96 | used during the test suite),
|
---|
[0e16b36] | 97 | <xref linkend="clisp"/>, and
|
---|
[30d6b736] | 98 | <xref linkend="swig"/> (for language bindings)
|
---|
[d6da5da] | 99 | </para>
|
---|
[b358845] | 100 |
|
---|
| 101 | </sect2>
|
---|
| 102 |
|
---|
| 103 | <sect2 role="installation">
|
---|
| 104 | <title>Installation of GPGME</title>
|
---|
| 105 |
|
---|
[d6da5da] | 106 | <para>
|
---|
| 107 | Install <application>GPGME</application> by running the following
|
---|
| 108 | commands:
|
---|
| 109 | </para>
|
---|
[c226321] | 110 | <!--gpgme 1.22 FTBFS when building in tree. Upstream thinks building
|
---|
| 111 | should be done out of tree, but this is not in the doc yet
|
---|
| 112 | https://github.com/gpg/gpgme/commit/24a8c279da98fe7e586a9fc3cd91175c9e60ffef
|
---|
| 113 | -->
|
---|
| 114 | <screen><userinput>mkdir build &&
|
---|
[3802215] | 115 | cd build &&
|
---|
[c226321] | 116 |
|
---|
| 117 | ../configure --prefix=/usr --disable-gpg-test &&
|
---|
[c3ad4c38] | 118 | make PYTHONS=</userinput></screen>
|
---|
| 119 |
|
---|
| 120 | <para>
|
---|
| 121 | If <xref linkend='swig'/> is installed, build the Python 3 binding as
|
---|
| 122 | a wheel:
|
---|
| 123 | </para>
|
---|
| 124 |
|
---|
| 125 | <screen><userinput>if swig -version > /dev/null; then
|
---|
| 126 | srcdir=$PWD/../lang/python \
|
---|
| 127 | top_builddir=$PWD \
|
---|
[4395529] | 128 | &build-wheel-cmd; $PWD/lang/python
|
---|
[c3ad4c38] | 129 | fi</userinput></screen>
|
---|
[150992ab] | 130 |
|
---|
[d6da5da] | 131 | <para>
|
---|
[14f0ab29] | 132 | To test the results, you should have <xref linkend="gnupg2"/> installed
|
---|
[782bd40d] | 133 | and remove the <option>--disable-gpg-test</option> above. If
|
---|
[c3ad4c38] | 134 | <xref linkend='swig'/> is installed, it's necessary to adapt the
|
---|
| 135 | test suite to use the Python 3 binding just built as a wheel as well.
|
---|
| 136 | Issue:
|
---|
[d6da5da] | 137 | </para>
|
---|
[b358845] | 138 |
|
---|
[c3ad4c38] | 139 | <screen remap='test'><userinput>if swig -version > /dev/null; then
|
---|
| 140 | python3 -m venv testenv &&
|
---|
| 141 | testenv/bin/pip3 install --no-index --find-links=dist --no-cache-dir \
|
---|
| 142 | gpg &&
|
---|
| 143 | sed '/PYTHON/s#run-tests.py#& --python-libdir=/dev/null#' \
|
---|
| 144 | -i lang/python/tests/Makefile
|
---|
| 145 | fi &&
|
---|
| 146 |
|
---|
| 147 | make -k check PYTHONS= PYTHON=$PWD/testenv/bin/python3</userinput></screen>
|
---|
| 148 |
|
---|
[fa7203b] | 149 | <!-- https://dev.gnupg.org/T6778 -->
|
---|
| 150 | <para>
|
---|
| 151 | One test named <filename>t-quick-key-manipulation.py</filename> is
|
---|
| 152 | known to fail.
|
---|
| 153 | </para>
|
---|
| 154 |
|
---|
[d6da5da] | 155 | <para>
|
---|
| 156 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 157 | </para>
|
---|
[b358845] | 158 |
|
---|
[c3ad4c38] | 159 | <screen role="root"><userinput>make install PYTHONS=</userinput></screen>
|
---|
| 160 |
|
---|
| 161 | <para>
|
---|
| 162 | If <xref linkend='swig'/> is installed, still as the &root; user,
|
---|
| 163 | install the Python 3 binding:
|
---|
| 164 | </para>
|
---|
| 165 |
|
---|
| 166 | <screen role="root"><userinput>if swig -version > /dev/null; then
|
---|
[1cdea83] | 167 | &install-wheel; gpg
|
---|
[c3ad4c38] | 168 | fi</userinput></screen>
|
---|
[b358845] | 169 |
|
---|
| 170 | </sect2>
|
---|
[f7ac7b2] | 171 |
|
---|
[14f0ab29] | 172 | <sect2 role="commands">
|
---|
| 173 | <title>Command Explanations</title>
|
---|
| 174 |
|
---|
| 175 | <para>
|
---|
| 176 | <parameter>--disable-gpg-test</parameter>: if this parameter is not
|
---|
| 177 | passed to configure, the test programs are built during
|
---|
| 178 | <command>make</command> stage, which requires <xref linkend="gnupg2"/>.
|
---|
| 179 | This parameter is not needed if <xref linkend="gnupg2"/> is installed.
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
[c3ad4c38] | 182 | <para>
|
---|
| 183 | <parameter>PYTHONS=</parameter>: Disable building Python binding
|
---|
| 184 | using the deprecated <command>python3 setup.py build</command>
|
---|
| 185 | command. The explicit instruction to build the Python 3 binding with
|
---|
| 186 | the <command>pip3 wheel</command> command is provided.
|
---|
| 187 | </para>
|
---|
| 188 |
|
---|
[14f0ab29] | 189 | </sect2>
|
---|
| 190 |
|
---|
[b358845] | 191 | <sect2 role="content">
|
---|
| 192 | <title>Contents</title>
|
---|
| 193 |
|
---|
| 194 | <segmentedlist>
|
---|
| 195 | <segtitle>Installed Program</segtitle>
|
---|
| 196 | <segtitle>Installed Libraries</segtitle>
|
---|
| 197 | <segtitle>Installed Directory</segtitle>
|
---|
| 198 |
|
---|
| 199 | <seglistitem>
|
---|
[d6da5da] | 200 | <seg>
|
---|
[b3285de] | 201 | gpgme-json, and gpgme-tool
|
---|
[d6da5da] | 202 | </seg>
|
---|
| 203 | <seg>
|
---|
[c226321] | 204 | libgpgme.so, libgpgmepp.so, and libqgpgme.so
|
---|
[d6da5da] | 205 | </seg>
|
---|
| 206 | <seg>
|
---|
[cd074c2] | 207 | /usr/include/{gpgme++,qgpgme,QGpgME},
|
---|
| 208 | /usr/lib/cmake/{Gpgmepp,QGpgme}.
|
---|
[0425945] | 209 | /usr/lib/python&python3-majorver;/site-packages/gpg{,-&gpgme-version;.dist-info}, and
|
---|
[d6da5da] | 210 | /usr/share/common-lisp/source/gpgme
|
---|
| 211 | </seg>
|
---|
[b358845] | 212 | </seglistitem>
|
---|
| 213 | </segmentedlist>
|
---|
| 214 |
|
---|
| 215 | <variablelist>
|
---|
| 216 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 217 | <?dbfo list-presentation="list"?>
|
---|
| 218 | <?dbhtml list-presentation="table"?>
|
---|
| 219 |
|
---|
[cd074c2] | 220 | <varlistentry id="gpgme-json">
|
---|
| 221 | <term><command>gpgme-json</command></term>
|
---|
| 222 | <listitem>
|
---|
| 223 | <para>
|
---|
[4c24eb0a] | 224 | outputs <application>GPGME</application> commands in JSON format
|
---|
[cd074c2] | 225 | </para>
|
---|
| 226 | <indexterm zone="gpgme gpgme-json">
|
---|
| 227 | <primary sortas="b-gpgme-json">gpgme-json</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
[150992ab] | 232 | <varlistentry id="gpgme-tool">
|
---|
| 233 | <term><command>gpgme-tool</command></term>
|
---|
| 234 | <listitem>
|
---|
| 235 | <para>
|
---|
[d5f6e8e] | 236 | is an assuan server exposing <application>GPGME</application>
|
---|
| 237 | operations, such as printing fingerprints and keyids with
|
---|
[4c24eb0a] | 238 | keyservers
|
---|
[150992ab] | 239 | </para>
|
---|
| 240 | <indexterm zone="gpgme gpgme-tool">
|
---|
| 241 | <primary sortas="b-gpgme-tool">gpgme-tool</primary>
|
---|
| 242 | </indexterm>
|
---|
| 243 | </listitem>
|
---|
| 244 | </varlistentry>
|
---|
| 245 |
|
---|
[cd074c2] | 246 | <!-- As of 1.13.1, this library isn't present anymore.
|
---|
[b358845] | 247 | <varlistentry id="libgpgme-pthread">
|
---|
[d6da5da] | 248 | <term><filename class="libraryfile">libgpgme-pthread.so</filename></term>
|
---|
[b358845] | 249 | <listitem>
|
---|
[d6da5da] | 250 | <para>
|
---|
| 251 | contains the <application>GPGME</application> API functions for
|
---|
| 252 | applications using pthread.
|
---|
| 253 | </para>
|
---|
[b358845] | 254 | <indexterm zone="gpgme libgpgme-pthread">
|
---|
[d6da5da] | 255 | <primary sortas="c-libgpgme-pthread">libgpgme-pthread.so</primary>
|
---|
[b358845] | 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
[cd074c2] | 259 | -->
|
---|
[b358845] | 260 |
|
---|
| 261 | <varlistentry id="libgpgme">
|
---|
[d6da5da] | 262 | <term><filename class="libraryfile">libgpgme.so</filename></term>
|
---|
[b358845] | 263 | <listitem>
|
---|
[d6da5da] | 264 | <para>
|
---|
[4c24eb0a] | 265 | contains the <application>GPGME</application> API functions
|
---|
[d6da5da] | 266 | </para>
|
---|
[b358845] | 267 | <indexterm zone="gpgme libgpgme">
|
---|
[d6da5da] | 268 | <primary sortas="c-libgpgme">libgpgme.so</primary>
|
---|
[b358845] | 269 | </indexterm>
|
---|
| 270 | </listitem>
|
---|
| 271 | </varlistentry>
|
---|
| 272 |
|
---|
[48ad7d9] | 273 | <varlistentry id="libgpgmepp">
|
---|
| 274 | <term><filename class="libraryfile">libgpgmepp.so</filename></term>
|
---|
| 275 | <listitem>
|
---|
| 276 | <para>
|
---|
[4c24eb0a] | 277 | contains the C++ <application>GPGME</application> API functions
|
---|
[48ad7d9] | 278 | </para>
|
---|
| 279 | <indexterm zone="gpgme libgpgmepp">
|
---|
| 280 | <primary sortas="c-libgpgmepp">libgpgmepp.so</primary>
|
---|
| 281 | </indexterm>
|
---|
| 282 | </listitem>
|
---|
| 283 | </varlistentry>
|
---|
| 284 |
|
---|
[cd074c2] | 285 | <varlistentry id="libqgpgme">
|
---|
| 286 | <term><filename class="libraryfile">libqgpgme.so</filename></term>
|
---|
| 287 | <listitem>
|
---|
| 288 | <para>
|
---|
| 289 | contains API functions for handling GPG operations in
|
---|
[4c24eb0a] | 290 | <application>Qt</application> applications
|
---|
[cd074c2] | 291 | </para>
|
---|
| 292 | <indexterm zone="gpgme libqgpgme">
|
---|
| 293 | <primary sortas="c-libqgpgme">libqgpgme.so</primary>
|
---|
| 294 | </indexterm>
|
---|
| 295 | </listitem>
|
---|
| 296 | </varlistentry>
|
---|
| 297 |
|
---|
[b358845] | 298 | </variablelist>
|
---|
| 299 |
|
---|
| 300 | </sect2>
|
---|
| 301 |
|
---|
| 302 | </sect1>
|
---|