[47969a6] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 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 |
|
---|
[c6b192c] | 7 | <!ENTITY qca-download-http "https://download.kde.org/stable/qca/&qca-version;/qca-&qca-version;.tar.xz">
|
---|
[47969a6] | 8 | <!ENTITY qca-download-ftp " ">
|
---|
[b58d6e5] | 9 | <!ENTITY qca-md5sum "4c6348286c170b3da24820c977565d75">
|
---|
| 10 | <!ENTITY qca-size "744 KB">
|
---|
| 11 | <!ENTITY qca-buildsize "42 MB">
|
---|
| 12 | <!ENTITY qca-time "0.5 SBU (using parallelism=4; add 0.1 SBU for tests)">
|
---|
[47969a6] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="qca" xreflabel="qca-&qca-version;">
|
---|
| 16 | <?dbhtml filename="qca.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>Qca-&qca-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="qca">
|
---|
[81586492] | 22 | <primary sortas="a-qca">qca</primary>
|
---|
[47969a6] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[ad41452] | 26 | <title>Introduction to Qca</title>
|
---|
[47969a6] | 27 |
|
---|
[d56e7df] | 28 | <para>
|
---|
| 29 | <application>Qca</application> aims to provide a straightforward and
|
---|
| 30 | cross-platform crypto API, using <application>Qt</application> datatypes
|
---|
| 31 | and conventions. <application>Qca</application> separates the API from
|
---|
| 32 | the implementation, using plugins known as Providers.
|
---|
| 33 | </para>
|
---|
[47969a6] | 34 |
|
---|
[d9dc0431] | 35 | &lfs120_checked;
|
---|
[47969a6] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
[d56e7df] | 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&qca-download-http;"/>
|
---|
| 42 | </para>
|
---|
[47969a6] | 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
[d56e7df] | 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&qca-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
[47969a6] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[d56e7df] | 50 | <para>
|
---|
| 51 | Download MD5 sum: &qca-md5sum;
|
---|
| 52 | </para>
|
---|
[47969a6] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[d56e7df] | 55 | <para>
|
---|
| 56 | Download size: &qca-size;
|
---|
| 57 | </para>
|
---|
[47969a6] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[d56e7df] | 60 | <para>
|
---|
| 61 | Estimated disk space required: &qca-buildsize;
|
---|
| 62 | </para>
|
---|
[47969a6] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[d56e7df] | 65 | <para>
|
---|
| 66 | Estimated build time: &qca-time;
|
---|
| 67 | </para>
|
---|
[47969a6] | 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
[8558044] | 70 | <!--
|
---|
[b51c6f5c] | 71 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 72 | <itemizedlist spacing="compact">
|
---|
| 73 | <listitem>
|
---|
| 74 | <para>
|
---|
| 75 | Required patch:
|
---|
| 76 | <ulink url="&patch-root;/qca-&qca-version;-openssl-1.patch"/>
|
---|
| 77 | </para>
|
---|
| 78 | </listitem>
|
---|
| 79 | </itemizedlist>
|
---|
[691fc571] | 80 | -->
|
---|
[ad41452] | 81 | <bridgehead renderas="sect3">Qca Dependencies</bridgehead>
|
---|
[47969a6] | 82 |
|
---|
| 83 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 84 | <para role="required">
|
---|
[2198a32] | 85 | <xref linkend="make-ca"/>,
|
---|
[615961f] | 86 | <xref linkend="cmake"/>,
|
---|
[67b1a0a1] | 87 | <xref linkend="qt5"/>, and
|
---|
[e40b79b6] | 88 | <xref linkend="which"/>
|
---|
[47969a6] | 89 | </para>
|
---|
| 90 |
|
---|
[615961f] | 91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 92 | <para role="Optional">
|
---|
| 93 | <xref linkend="cyrus-sasl"/>,
|
---|
| 94 | <xref linkend="gnupg2"/>,
|
---|
| 95 | <xref linkend="libgcrypt"/>,
|
---|
| 96 | <xref linkend="libgpg-error"/>,
|
---|
| 97 | <xref linkend="nss"/>,
|
---|
| 98 | <xref linkend="nspr"/>,
|
---|
| 99 | <xref linkend="p11-kit"/>,
|
---|
[8558044] | 100 | <xref linkend="doxygen"/>,
|
---|
[691fc571] | 101 | <xref linkend="which"/>, and
|
---|
| 102 | <ulink url="https://botan.randombit.net/">Botan</ulink>
|
---|
[615961f] | 103 | </para>
|
---|
| 104 |
|
---|
[47969a6] | 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 role="installation">
|
---|
[ad41452] | 108 | <title>Installation of Qca</title>
|
---|
[b51c6f5c] | 109 |
|
---|
[d56e7df] | 110 | <para>
|
---|
| 111 | Fix the location of the CA certificates:
|
---|
| 112 | </para>
|
---|
[1e314ce] | 113 |
|
---|
[5c3f3856] | 114 | <screen><userinput>sed -i 's@cert.pem@certs/ca-bundle.crt@' CMakeLists.txt</userinput></screen>
|
---|
[1e314ce] | 115 |
|
---|
[d56e7df] | 116 | <para>
|
---|
| 117 | Install <application>Qca</application> by running the following
|
---|
| 118 | commands:
|
---|
| 119 | </para>
|
---|
[47969a6] | 120 |
|
---|
[615961f] | 121 | <screen><userinput>mkdir build &&
|
---|
| 122 | cd build &&
|
---|
| 123 |
|
---|
[691fc571] | 124 | cmake -DCMAKE_INSTALL_PREFIX=$QT5DIR \
|
---|
| 125 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 126 | -DQCA_MAN_INSTALL_DIR:PATH=/usr/share/man \
|
---|
| 127 | .. &&
|
---|
[7170000e] | 128 | make</userinput></screen>
|
---|
| 129 |
|
---|
[d56e7df] | 130 | <para>
|
---|
[4bd3b64d] | 131 | To test the results, issue <command>make test</command>. <!--One test
|
---|
[d56e7df] | 132 | using <xref linkend="gnupg2"/> fails without a correct passphrase. The
|
---|
[4bd3b64d] | 133 | required passphrase does not seem to be published.-->
|
---|
[d56e7df] | 134 | </para>
|
---|
[9ca304a] | 135 |
|
---|
[d56e7df] | 136 | <para>
|
---|
| 137 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 138 | </para>
|
---|
[47969a6] | 139 |
|
---|
| 140 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 141 |
|
---|
| 142 | </sect2>
|
---|
[ad41452] | 143 |
|
---|
[47969a6] | 144 | <sect2 role="commands">
|
---|
| 145 | <title>Command Explanations</title>
|
---|
| 146 |
|
---|
[d56e7df] | 147 | <para>
|
---|
| 148 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is
|
---|
| 149 | used to apply a higher level of compiler optimizations.
|
---|
| 150 | </para>
|
---|
[47969a6] | 151 |
|
---|
[d56e7df] | 152 | <para>
|
---|
| 153 | <parameter>-DQCA_MAN_INSTALL_DIR:PATH=/usr/share/man</parameter>:
|
---|
| 154 | Install the qca man page in the normal location.
|
---|
| 155 | </para>
|
---|
[cbdad90b] | 156 |
|
---|
[47969a6] | 157 | </sect2>
|
---|
[ad41452] | 158 |
|
---|
[47969a6] | 159 | <sect2 role="content">
|
---|
| 160 | <title>Contents</title>
|
---|
| 161 |
|
---|
| 162 | <segmentedlist>
|
---|
[ad41452] | 163 | <segtitle>Installed Programs</segtitle>
|
---|
[47969a6] | 164 | <segtitle>Installed Libraries</segtitle>
|
---|
[ad41452] | 165 | <segtitle>Installed Directories</segtitle>
|
---|
[47969a6] | 166 |
|
---|
| 167 | <seglistitem>
|
---|
[67b1a0a1] | 168 | <seg>mozcerts-qt5 and qcatool-qt5</seg>
|
---|
[b51c6f5c] | 169 | <seg>
|
---|
| 170 | libqca-qt5.so,
|
---|
| 171 | libqca-cyrus-sasl.so,
|
---|
| 172 | libqca-gcrypt.so,
|
---|
| 173 | libqca-gnupg.so,
|
---|
| 174 | libqca-logger.so,
|
---|
| 175 | libqca-nss.so,
|
---|
| 176 | libqca-ossl.so, and
|
---|
| 177 | libqca-softstore.so
|
---|
| 178 | </seg>
|
---|
[615961f] | 179 | <seg>
|
---|
[67b1a0a1] | 180 | &qt5-dir;/include/Qca-qt5,
|
---|
| 181 | &qt5-dir;/lib/cmake/Qca-qt5, and
|
---|
| 182 | &qt5-dir;/lib/qca-qt5
|
---|
[615961f] | 183 | </seg>
|
---|
[47969a6] | 184 | </seglistitem>
|
---|
| 185 | </segmentedlist>
|
---|
[a88acf4] | 186 |
|
---|
[47969a6] | 187 | <variablelist>
|
---|
| 188 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 189 | <?dbfo list-presentation="list"?>
|
---|
| 190 | <?dbhtml list-presentation="table"?>
|
---|
| 191 |
|
---|
[615961f] | 192 | <varlistentry id="mozcerts">
|
---|
[67b1a0a1] | 193 | <term><command>mozcerts-qt5</command></term>
|
---|
[615961f] | 194 | <listitem>
|
---|
[d56e7df] | 195 | <para>
|
---|
| 196 | is a command line tool for converting certdata.txt into
|
---|
[4c24eb0a] | 197 | outfile.pem files
|
---|
[d56e7df] | 198 | </para>
|
---|
[615961f] | 199 | <indexterm zone="qca mozcerts">
|
---|
[67b1a0a1] | 200 | <primary sortas="b-mozcerts">mozcerts-qt5</primary>
|
---|
[615961f] | 201 | </indexterm>
|
---|
| 202 | </listitem>
|
---|
| 203 | </varlistentry>
|
---|
| 204 |
|
---|
| 205 | <varlistentry id="qcatool">
|
---|
[67b1a0a1] | 206 | <term><command>qcatool-qt5</command></term>
|
---|
[a88acf4] | 207 | <listitem>
|
---|
[d56e7df] | 208 | <para>
|
---|
| 209 | is a command line tool for performing various cryptographic
|
---|
[4c24eb0a] | 210 | operations with Qca
|
---|
[d56e7df] | 211 | </para>
|
---|
[615961f] | 212 | <indexterm zone="qca qcatool">
|
---|
[67b1a0a1] | 213 | <primary sortas="b-qcatool">qcatool-qt5</primary>
|
---|
[a88acf4] | 214 | </indexterm>
|
---|
| 215 | </listitem>
|
---|
| 216 | </varlistentry>
|
---|
| 217 |
|
---|
| 218 | <varlistentry id="libqca">
|
---|
[4c24eb0a] | 219 | <term><filename class="libraryfile">libqca-qt5.so</filename></term>
|
---|
[47969a6] | 220 | <listitem>
|
---|
[d56e7df] | 221 | <para>
|
---|
[4c24eb0a] | 222 | is the Qt Cryptography Architecture (Qca) library
|
---|
[d56e7df] | 223 | </para>
|
---|
[a88acf4] | 224 | <indexterm zone="qca libqca">
|
---|
[67b1a0a1] | 225 | <primary sortas="c-libqca">libqca-qt5.so</primary>
|
---|
[47969a6] | 226 | </indexterm>
|
---|
| 227 | </listitem>
|
---|
| 228 | </varlistentry>
|
---|
| 229 |
|
---|
| 230 | </variablelist>
|
---|
[a88acf4] | 231 |
|
---|
[47969a6] | 232 | </sect2>
|
---|
| 233 |
|
---|
| 234 | </sect1>
|
---|