Warning, /libraries/qca/examples/examples.doco is written in an unsupported language. File is not indexed.

0001 /** \example aes-cmac.cpp 
0002 
0003 This example shows how to implement a client side "provider".
0004 
0005 There are three important parts to this:
0006  - the class derived from QCA::Provider (in this example called
0007  "ClientSideProvider"), that generates the context class
0008  - one or more context classes (in this example only one, implementing
0009  AES-CMAC, called "AESCMACContext")
0010  - a call to QCA::insertProvider, to add the QCA::Provider subclass
0011  into QCA
0012 
0013 */
0014 
0015 
0016 /** \example base64test.cpp
0017 
0018 The code below shows some simple operations on a QCA::Base64 object, converting
0019 between QCA::SecureArray and QString.
0020 
0021 */
0022 
0023 
0024 /** \example certtest.cpp
0025 
0026 This example shows how QCA::Certificate and QCA::CertificateCollection
0027 can be used. Note that the argument, if you provide it, must be a 
0028 PEM encoded file collection.
0029 
0030 */
0031 
0032 
0033 /** \example ciphertest.cpp
0034 
0035 The code below shows the normal way to use the QCA::Cipher class.
0036 
0037 */
0038 
0039 
0040 /* \example cmssigner/main.cpp
0041 
0042 The code below shows how to use Cryptographic Message Syntax (CMS)
0043 in a GUI application.
0044 
0045 \include certitem.h
0046 \include certitem.cpp
0047 \include certviewdlg.h
0048 \include certviewdlg.cpp
0049 \include keyselectdlg.h
0050 \include keyselectdlg.cpp
0051 \include prompter.h
0052 \include prompter.cpp
0053 
0054 */
0055 
0056 
0057 /** \example eventhandlerdemo.cpp
0058 
0059 The code below shows to implement a client side handler for
0060 password / passphrase / PIN and token requests from QCA and any
0061 associated providers.
0062 
0063 */
0064 
0065 
0066 /** \example hashtest.cpp
0067 
0068 The code below shows how to use the QCA::Hash class
0069 
0070 */
0071 
0072 
0073 /** \example hextest.cpp
0074 
0075 The code below shows some simple operations on a QCA::Hex object, converting
0076 between QCA::SecureArray and QString.
0077 
0078 */
0079 
0080 
0081 /** \example keyloader.cpp
0082 
0083 The code below shows how to load a private key from a PEM format file,
0084 including handling any requirement for a passphrase. This is done using
0085 the QCA::KeyLoader class.
0086 
0087 */
0088 
0089 
0090 /** \example mactest.cpp
0091 
0092 The code below shows how to use the QCA::MessageAuthenticationCode class
0093 
0094 */
0095 
0096 
0097 /** \example md5crypt.cpp
0098 
0099 The code below shows how to calculate an md5crypt based password. This
0100 code is compatible with the glibc code.
0101 
0102 */
0103 
0104 
0105 /** \example providertest.cpp
0106 
0107 The code below shows some simple operations on a QCA::Provider object, including
0108 use of iterators and some member functions.
0109 
0110 */
0111 
0112 
0113 /** \example publickeyexample.cpp
0114 
0115 The code below shows how to do public key encryption, decryption,
0116 signing and verification.
0117 */
0118 
0119 
0120 /** \example randomtest.cpp
0121 
0122 The code below shows the normal way to use the QCA::Random class.
0123 
0124 */
0125 
0126 
0127 /** \example rsatest.cpp
0128 
0129 The code below shows some of the capabilities for how to use
0130 RSA. This example also shows how to export and import a key
0131 to a file, using PEM encoding.
0132 
0133 */
0134 
0135 
0136 /** \example saslserver.cpp
0137 
0138 The code below shows how to create a SASL server.
0139 
0140 */
0141 
0142 
0143 /** \example saslclient.cpp
0144 
0145 The code below shows how to create a SASL client.
0146 
0147 */
0148 
0149 
0150 /** \example sslservtest.cpp
0151 
0152 The code below shows how to create an SSL server.
0153 
0154 Note that this server returns a self-signed certificate
0155 for "example.com", and that the certificate is expired.
0156 
0157 The design used here only allows for one connection 
0158 at a time. If you want to allow for more, you should
0159 probably create a "TlsConnection" object that agregates
0160 a QCA::TLS object and a QTcpSocket (plus a little bit of
0161 state information) that handles a single connection. Then
0162 just create a TlsConnection for each server connection.
0163 
0164 */
0165 
0166 /** \example ssltest.cpp
0167 
0168 The code below shows how to create an SSL client 
0169 
0170 */
0171 
0172 /** \example tlssocket.cpp
0173 
0174 The code below shows how to create a socket that can operate
0175 over an Transport Layer Security (TLS, also known as SSL) connection.
0176 
0177 \include tlssocket/tlssocket.h
0178 \include tlssocket/main.cpp
0179 */
0180 
0181 
0182