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