QCA

examples.doco
1/** \example aes-cmac.cpp
2
3This example shows how to implement a client side "provider".
4
5There are three important parts to this:
6 - the class derived from QCA::Provider (in this example called
7 "ClientSideProvider"), that generates the context class
8 - one or more context classes (in this example only one, implementing
9 AES-CMAC, called "AESCMACContext")
10 - a call to QCA::insertProvider, to add the QCA::Provider subclass
11 into QCA
12
13*/
14
15
16/** \example base64test.cpp
17
18The code below shows some simple operations on a QCA::Base64 object, converting
19between QCA::SecureArray and QString.
20
21*/
22
23
24/** \example certtest.cpp
25
26This example shows how QCA::Certificate and QCA::CertificateCollection
27can be used. Note that the argument, if you provide it, must be a
28PEM encoded file collection.
29
30*/
31
32
33/** \example ciphertest.cpp
34
35The code below shows the normal way to use the QCA::Cipher class.
36
37*/
38
39
40/* \example cmssigner/main.cpp
41
42The code below shows how to use Cryptographic Message Syntax (CMS)
43in a GUI application.
44
45\include certitem.h
46\include certitem.cpp
47\include certviewdlg.h
48\include certviewdlg.cpp
49\include keyselectdlg.h
50\include keyselectdlg.cpp
51\include prompter.h
52\include prompter.cpp
53
54*/
55
56
57/** \example eventhandlerdemo.cpp
58
59The code below shows to implement a client side handler for
60password / passphrase / PIN and token requests from QCA and any
61associated providers.
62
63*/
64
65
66/** \example hashtest.cpp
67
68The code below shows how to use the QCA::Hash class
69
70*/
71
72
73/** \example hextest.cpp
74
75The code below shows some simple operations on a QCA::Hex object, converting
76between QCA::SecureArray and QString.
77
78*/
79
80
81/** \example keyloader.cpp
82
83The code below shows how to load a private key from a PEM format file,
84including handling any requirement for a passphrase. This is done using
85the QCA::KeyLoader class.
86
87*/
88
89
90/** \example mactest.cpp
91
92The code below shows how to use the QCA::MessageAuthenticationCode class
93
94*/
95
96
97/** \example md5crypt.cpp
98
99The code below shows how to calculate an md5crypt based password. This
100code is compatible with the glibc code.
101
102*/
103
104
105/** \example providertest.cpp
106
107The code below shows some simple operations on a QCA::Provider object, including
108use of iterators and some member functions.
109
110*/
111
112
113/** \example publickeyexample.cpp
114
115The code below shows how to do public key encryption, decryption,
116signing and verification.
117*/
118
119
120/** \example randomtest.cpp
121
122The code below shows the normal way to use the QCA::Random class.
123
124*/
125
126
127/** \example rsatest.cpp
128
129The code below shows some of the capabilities for how to use
130RSA. This example also shows how to export and import a key
131to a file, using PEM encoding.
132
133*/
134
135
136/** \example saslserver.cpp
137
138The code below shows how to create a SASL server.
139
140*/
141
142
143/** \example saslclient.cpp
144
145The code below shows how to create a SASL client.
146
147*/
148
149
150/** \example sslservtest.cpp
151
152The code below shows how to create an SSL server.
153
154Note that this server returns a self-signed certificate
155for "example.com", and that the certificate is expired.
156
157The design used here only allows for one connection
158at a time. If you want to allow for more, you should
159probably create a "TlsConnection" object that agregates
160a QCA::TLS object and a QTcpSocket (plus a little bit of
161state information) that handles a single connection. Then
162just create a TlsConnection for each server connection.
163
164*/
165
166/** \example ssltest.cpp
167
168The code below shows how to create an SSL client
169
170*/
171
172/** \example tlssocket.cpp
173
174The code below shows how to create a socket that can operate
175over an Transport Layer Security (TLS, also known as SSL) connection.
176
177\include tlssocket/tlssocket.h
178\include tlssocket/main.cpp
179*/
180
181
182
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:53:51 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.