1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 |
|
---|
7 | <!ENTITY qca-download-http "https://download.kde.org/stable/qca/&qca-version;/qca-&qca-version;.tar.xz">
|
---|
8 | <!ENTITY qca-download-ftp " ">
|
---|
9 | <!ENTITY qca-md5sum "d8aaa46356a322464f65b04d00d2bac6">
|
---|
10 | <!ENTITY qca-size "748 KB">
|
---|
11 | <!ENTITY qca-buildsize "57 MB (with tests)">
|
---|
12 | <!ENTITY qca-time "1.0 SBU (using parallelism=4; with tests)">
|
---|
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">
|
---|
22 | <primary sortas="a-qca">qca</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to Qca</title>
|
---|
27 |
|
---|
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>
|
---|
34 |
|
---|
35 | &lfs122_checked;
|
---|
36 |
|
---|
37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
38 | <itemizedlist spacing="compact">
|
---|
39 | <listitem>
|
---|
40 | <para>
|
---|
41 | Download (HTTP): <ulink url="&qca-download-http;"/>
|
---|
42 | </para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>
|
---|
46 | Download (FTP): <ulink url="&qca-download-ftp;"/>
|
---|
47 | </para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download MD5 sum: &qca-md5sum;
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download size: &qca-size;
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Estimated disk space required: &qca-buildsize;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Estimated build time: &qca-time;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 | <!--
|
---|
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>
|
---|
80 | -->
|
---|
81 | <bridgehead renderas="sect3">Qca Dependencies</bridgehead>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
84 | <para role="required">
|
---|
85 | <xref linkend="make-ca"/>,
|
---|
86 | <xref linkend="cmake"/>,
|
---|
87 | <xref linkend="qt6"/>, and
|
---|
88 | <xref linkend="which"/>
|
---|
89 | </para>
|
---|
90 |
|
---|
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"/>,
|
---|
100 | <xref linkend="doxygen"/>, and
|
---|
101 | <ulink url="https://botan.randombit.net/">Botan</ulink>
|
---|
102 | </para>
|
---|
103 |
|
---|
104 | </sect2>
|
---|
105 |
|
---|
106 | <sect2 role="installation">
|
---|
107 | <title>Installation of Qca</title>
|
---|
108 |
|
---|
109 | <para>
|
---|
110 | Fix the location of the CA certificates:
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | <screen><userinput>sed -i 's@cert.pem@certs/ca-bundle.crt@' CMakeLists.txt</userinput></screen>
|
---|
114 |
|
---|
115 | <para>
|
---|
116 | Install <application>Qca</application> by running the following
|
---|
117 | commands:
|
---|
118 | </para>
|
---|
119 |
|
---|
120 | <screen><userinput>mkdir build &&
|
---|
121 | cd build &&
|
---|
122 |
|
---|
123 | cmake -D CMAKE_INSTALL_PREFIX=$QT6DIR \
|
---|
124 | -D CMAKE_BUILD_TYPE=Release \
|
---|
125 | -D QT6=ON \
|
---|
126 | -D QCA_INSTALL_IN_QT_PREFIX=ON \
|
---|
127 | -D QCA_MAN_INSTALL_DIR:PATH=/usr/share/man \
|
---|
128 | .. &&
|
---|
129 | make</userinput></screen>
|
---|
130 |
|
---|
131 | <para>
|
---|
132 | To test the results, issue <command>make test</command>.
|
---|
133 | </para>
|
---|
134 |
|
---|
135 | <para>
|
---|
136 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
137 | </para>
|
---|
138 |
|
---|
139 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
140 |
|
---|
141 | </sect2>
|
---|
142 |
|
---|
143 | <sect2 role="commands">
|
---|
144 | <title>Command Explanations</title>
|
---|
145 |
|
---|
146 | <para>
|
---|
147 | <parameter>-D CMAKE_BUILD_TYPE=Release</parameter>: This switch is
|
---|
148 | used to apply a higher level of compiler optimizations.
|
---|
149 | </para>
|
---|
150 |
|
---|
151 | <para>
|
---|
152 | <parameter>-D QT6=ON</parameter>:
|
---|
153 | Ensure the packages is built with <xref linkend="qt6"/>.
|
---|
154 | </para>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | <parameter>-D QCA_MAN_INSTALL_DIR:PATH=/usr/share/man</parameter>:
|
---|
158 | Install the qca man page in the normal location.
|
---|
159 | </para>
|
---|
160 |
|
---|
161 | </sect2>
|
---|
162 |
|
---|
163 | <sect2 role="content">
|
---|
164 | <title>Contents</title>
|
---|
165 |
|
---|
166 | <segmentedlist>
|
---|
167 | <segtitle>Installed Programs</segtitle>
|
---|
168 | <segtitle>Installed Libraries</segtitle>
|
---|
169 | <segtitle>Installed Directories</segtitle>
|
---|
170 |
|
---|
171 | <seglistitem>
|
---|
172 | <seg>mozcerts-qt6 and qcatool-qt6</seg>
|
---|
173 | <seg>
|
---|
174 | libqca-qt6.so,
|
---|
175 | libqca-cyrus-sasl.so,
|
---|
176 | libqca-gcrypt.so,
|
---|
177 | libqca-gnupg.so,
|
---|
178 | libqca-logger.so,
|
---|
179 | libqca-nss.so,
|
---|
180 | libqca-ossl.so, and
|
---|
181 | libqca-softstore.so
|
---|
182 | </seg>
|
---|
183 | <seg>
|
---|
184 | &qt6-dir;/include/Qca-qt6,
|
---|
185 | &qt6-dir;/lib/cmake/Qca-qt6, and
|
---|
186 | &qt6-dir;/lib/qca-qt6
|
---|
187 | </seg>
|
---|
188 | </seglistitem>
|
---|
189 | </segmentedlist>
|
---|
190 |
|
---|
191 | <variablelist>
|
---|
192 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
193 | <?dbfo list-presentation="list"?>
|
---|
194 | <?dbhtml list-presentation="table"?>
|
---|
195 |
|
---|
196 | <varlistentry id="mozcerts">
|
---|
197 | <term><command>mozcerts-qt6</command></term>
|
---|
198 | <listitem>
|
---|
199 | <para>
|
---|
200 | is a command line tool for converting certdata.txt into
|
---|
201 | outfile.pem files
|
---|
202 | </para>
|
---|
203 | <indexterm zone="qca mozcerts">
|
---|
204 | <primary sortas="b-mozcerts">mozcerts-qt6</primary>
|
---|
205 | </indexterm>
|
---|
206 | </listitem>
|
---|
207 | </varlistentry>
|
---|
208 |
|
---|
209 | <varlistentry id="qcatool">
|
---|
210 | <term><command>qcatool-qt6</command></term>
|
---|
211 | <listitem>
|
---|
212 | <para>
|
---|
213 | is a command line tool for performing various cryptographic
|
---|
214 | operations with Qca
|
---|
215 | </para>
|
---|
216 | <indexterm zone="qca qcatool">
|
---|
217 | <primary sortas="b-qcatool">qcatool-qt6</primary>
|
---|
218 | </indexterm>
|
---|
219 | </listitem>
|
---|
220 | </varlistentry>
|
---|
221 |
|
---|
222 | <varlistentry id="libqca">
|
---|
223 | <term><filename class="libraryfile">libqca-qt6.so</filename></term>
|
---|
224 | <listitem>
|
---|
225 | <para>
|
---|
226 | is the Qt Cryptography Architecture (Qca) library
|
---|
227 | </para>
|
---|
228 | <indexterm zone="qca libqca">
|
---|
229 | <primary sortas="c-libqca">libqca-qt6.so</primary>
|
---|
230 | </indexterm>
|
---|
231 | </listitem>
|
---|
232 | </varlistentry>
|
---|
233 |
|
---|
234 | </variablelist>
|
---|
235 |
|
---|
236 | </sect2>
|
---|
237 |
|
---|
238 | </sect1>
|
---|