1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is last updated 4 March 2015 for version
3.5.3 of GnuTLS.
Copyright (C) 2001-2015 Free Software Foundation, Inc.\\
Copyright (C) 2001-2015 Nikos Mavrogiannopoulos
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GnuTLS 3.5.3: Symmetric algorithms</title>
<meta name="description" content="GnuTLS 3.5.3: Symmetric algorithms">
<meta name="keywords" content="GnuTLS 3.5.3: Symmetric algorithms">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-and-Data-Index.html#Function-and-Data-Index" rel="index" title="Function and Data Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Using-GnuTLS-as-a-cryptographic-library.html#Using-GnuTLS-as-a-cryptographic-library" rel="up" title="Using GnuTLS as a cryptographic library">
<link href="Public-key-algorithms.html#Public-key-algorithms" rel="next" title="Public key algorithms">
<link href="Using-GnuTLS-as-a-cryptographic-library.html#Using-GnuTLS-as-a-cryptographic-library" rel="prev" title="Using GnuTLS as a cryptographic library">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
body {
margin: 2%;
padding: 0 5%;
background: #ffffff;
}
h1,h2,h3,h4,h5 {
font-weight: bold;
padding: 5px 5px 5px 5px;
background-color: #c2e0ff;
color: #336699;
}
h1 {
padding: 2em 2em 2em 5%;
color: white;
background: #336699;
text-align: center;
letter-spacing: 3px;
}
h2 { text-decoration: underline; }
pre {
margin: 0 5%;
padding: 0.5em;
}
pre.example,pre.verbatim {
padding-bottom: 1em;
border: solid #c2e0ff;
background: #f0faff;
border-width: 1px 1px 1px 5px;
margin: 1em auto;
width: 90%;
}
div.node {
margin: 0 -5% 0 -2%;
padding: 0.5em 0.5em;
margin-top: 0.5em;
margin-bottom: 0.5em;
font-weight: bold;
}
dd, li {
padding-top: 0.1em;
padding-bottom: 0.1em;
}
div.float {
margin-bottom: 0.5em;
text-align: center;
}
table {
text-align: left;
margin-left:auto;
margin-right:auto;
border-spacing: 7px;
width: 50%;
}
th {
padding: 0;
color: #336699;
background-color: #c2e0ff;
border: solid #000000;
border-width: 0px;
margin: 1em auto;
text-align: center;
margin-left:auto;
margin-right:auto;
}
td {
padding: 0;
border: solid #000000;
background-color: #f0faff;
border-width: 0px;
margin: 1em auto;
text-align: left;
margin-left:auto;
margin-right:auto;
padding-left: 1em;
}
dl {
text-align: left;
margin-left:auto;
margin-right:auto;
width: 50%;
padding-left: 1em;
border: solid #c2e0ff;
background: #f0faff;
border-width: 5px 1px 1px 1px;
margin: 1em auto;
}
-->
</style>
</head>
<body lang="en">
<a name="Symmetric-algorithms"></a>
<div class="header">
<p>
Next: <a href="Public-key-algorithms.html#Public-key-algorithms" accesskey="n" rel="next">Public key algorithms</a>, Up: <a href="Using-GnuTLS-as-a-cryptographic-library.html#Using-GnuTLS-as-a-cryptographic-library" accesskey="u" rel="up">Using GnuTLS as a cryptographic library</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Data-Index.html#Function-and-Data-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Symmetric-algorithms-1"></a>
<h3 class="section">8.1 Symmetric algorithms</h3>
<a name="index-symmetric-algorithms"></a>
<a name="index-symmetric-cryptography"></a>
<p>The available functions to access symmetric crypto algorithms operations
are shown below. The supported algorithms are the algorithms required by the TLS protocol.
They are listed in <a href="#gnutls_005fcipher_005falgorithm_005ft">Figure 8.1</a>.
</p>
<div class="float"><a name="gnutls_005fcipher_005falgorithm_005ft"></a>
<dl compact="compact">
<dt><code>GNUTLS_CIPHER_UNKNOWN</code></dt>
<dd><p>Value to identify an unknown/unsupported algorithm.
</p></dd>
<dt><code>GNUTLS_CIPHER_NULL</code></dt>
<dd><p>The NULL (identity) encryption algorithm.
</p></dd>
<dt><code>GNUTLS_CIPHER_ARCFOUR_128</code></dt>
<dd><p>ARCFOUR stream cipher with 128-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_3DES_CBC</code></dt>
<dd><p>3DES in CBC mode.
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_128_CBC</code></dt>
<dd><p>AES in CBC mode with 128-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_256_CBC</code></dt>
<dd><p>AES in CBC mode with 256-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_ARCFOUR_40</code></dt>
<dd><p>ARCFOUR stream cipher with 40-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_CAMELLIA_128_CBC</code></dt>
<dd><p>Camellia in CBC mode with 128-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_CAMELLIA_256_CBC</code></dt>
<dd><p>Camellia in CBC mode with 256-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_192_CBC</code></dt>
<dd><p>AES in CBC mode with 192-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_128_GCM</code></dt>
<dd><p>AES in GCM mode with 128-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_256_GCM</code></dt>
<dd><p>AES in GCM mode with 256-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_CAMELLIA_192_CBC</code></dt>
<dd><p>Camellia in CBC mode with 192-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_SALSA20_256</code></dt>
<dd><p>Salsa20 with 256-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_ESTREAM_SALSA20_256</code></dt>
<dd><p>Estream’s Salsa20 variant with 256-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_CAMELLIA_128_GCM</code></dt>
<dd><p>CAMELLIA in GCM mode with 128-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_CAMELLIA_256_GCM</code></dt>
<dd><p>CAMELLIA in GCM mode with 256-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_RC2_40_CBC</code></dt>
<dd><p>RC2 in CBC mode with 40-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_DES_CBC</code></dt>
<dd><p>DES in CBC mode (56-bit keys).
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_128_CCM</code></dt>
<dd><p>AES in CCM mode with 128-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_256_CCM</code></dt>
<dd><p>AES in CCM mode with 256-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_128_CCM_8</code></dt>
<dd><p>AES in CCM mode with 64-bit tag and 128-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_AES_256_CCM_8</code></dt>
<dd><p>AES in CCM mode with 64-bit tag and 256-bit keys.
</p></dd>
<dt><code>GNUTLS_CIPHER_CHACHA20_POLY1305</code></dt>
<dd><p>The Chacha20 cipher with the Poly1305 authenticator (AEAD).
</p></dd>
<dt><code>GNUTLS_CIPHER_IDEA_PGP_CFB</code></dt>
<dd><p>IDEA in CFB mode (placeholder - unsupported).
</p></dd>
<dt><code>GNUTLS_CIPHER_3DES_PGP_CFB</code></dt>
<dd><p>3DES in CFB mode (placeholder - unsupported).
</p></dd>
<dt><code>GNUTLS_CIPHER_CAST5_PGP_CFB</code></dt>
<dd><p>CAST5 in CFB mode (placeholder - unsupported).
</p></dd>
<dt><code>GNUTLS_CIPHER_BLOWFISH_PGP_CFB</code></dt>
<dd><p>Blowfish in CFB mode (placeholder - unsupported).
</p></dd>
<dt><code>GNUTLS_CIPHER_SAFER_SK128_PGP_CFB</code></dt>
<dd><p>Safer-SK in CFB mode with 128-bit keys (placeholder - unsupported).
</p></dd>
<dt><code>GNUTLS_CIPHER_AES128_PGP_CFB</code></dt>
<dd><p>AES in CFB mode with 128-bit keys (placeholder - unsupported).
</p></dd>
<dt><code>GNUTLS_CIPHER_AES192_PGP_CFB</code></dt>
<dd><p>AES in CFB mode with 192-bit keys (placeholder - unsupported).
</p></dd>
<dt><code>GNUTLS_CIPHER_AES256_PGP_CFB</code></dt>
<dd><p>AES in CFB mode with 256-bit keys (placeholder - unsupported).
</p></dd>
<dt><code>GNUTLS_CIPHER_TWOFISH_PGP_CFB</code></dt>
<dd><p>Twofish in CFB mode (placeholder - unsupported).
</p></dd>
</dl>
<div class="float-caption"><p><strong>Figure 8.1: </strong>The supported ciphers.</p></div></div>
<dl compact="compact">
<dt><code><var>int</var> <a href="Cryptographic-API.html#gnutls_005fcipher_005finit">gnutls_cipher_init</a> (gnutls_cipher_hd_t * <var>handle</var>, gnutls_cipher_algorithm_t <var>cipher</var>, const gnutls_datum_t * <var>key</var>, const gnutls_datum_t * <var>iv</var>)</code></dt>
<dt><code><var>int</var> <a href="Cryptographic-API.html#gnutls_005fcipher_005fencrypt2">gnutls_cipher_encrypt2</a> (gnutls_cipher_hd_t <var>handle</var>, const void * <var>ptext</var>, size_t <var>ptext_len</var>, void * <var>ctext</var>, size_t <var>ctext_len</var>)</code></dt>
<dt><code><var>int</var> <a href="Cryptographic-API.html#gnutls_005fcipher_005fdecrypt2">gnutls_cipher_decrypt2</a> (gnutls_cipher_hd_t <var>handle</var>, const void * <var>ctext</var>, size_t <var>ctext_len</var>, void * <var>ptext</var>, size_t <var>ptext_len</var>)</code></dt>
<dt><code><var>void</var> <a href="Cryptographic-API.html#gnutls_005fcipher_005fset_005fiv">gnutls_cipher_set_iv</a> (gnutls_cipher_hd_t <var>handle</var>, void * <var>iv</var>, size_t <var>ivlen</var>)</code></dt>
<dt><code><var>void</var> <a href="Cryptographic-API.html#gnutls_005fcipher_005fdeinit">gnutls_cipher_deinit</a> (gnutls_cipher_hd_t <var>handle</var>)</code></dt>
</dl>
<dl compact="compact">
<dt><code><var>int</var> <a href="Cryptographic-API.html#gnutls_005fcipher_005fadd_005fauth">gnutls_cipher_add_auth</a> (gnutls_cipher_hd_t <var>handle</var>, const void * <var>ptext</var>, size_t <var>ptext_size</var>)</code></dt>
<dt><code><var>int</var> <a href="Cryptographic-API.html#gnutls_005fcipher_005ftag">gnutls_cipher_tag</a> (gnutls_cipher_hd_t <var>handle</var>, void * <var>tag</var>, size_t <var>tag_size</var>)</code></dt>
</dl>
<p>While the latter two functions allow the same API can be used with authenticated encryption ciphers,
it is recommended to use the following functions which are solely for AEAD ciphers. The latter
API is designed to be simple to use and also hard to misuse, by handling the tag verification
and addition in transparent way.
</p>
<dl compact="compact">
<dt><code><var>int</var> <a href="Cryptographic-API.html#gnutls_005faead_005fcipher_005finit">gnutls_aead_cipher_init</a> (gnutls_aead_cipher_hd_t * <var>handle</var>, gnutls_cipher_algorithm_t <var>cipher</var>, const gnutls_datum_t * <var>key</var>)</code></dt>
<dt><code><var>int</var> <a href="Cryptographic-API.html#gnutls_005faead_005fcipher_005fencrypt">gnutls_aead_cipher_encrypt</a> (gnutls_aead_cipher_hd_t <var>handle</var>, const void * <var>nonce</var>, size_t <var>nonce_len</var>, const void * <var>auth</var>, size_t <var>auth_len</var>, size_t <var>tag_size</var>, const void * <var>ptext</var>, size_t <var>ptext_len</var>, void * <var>ctext</var>, size_t * <var>ctext_len</var>)</code></dt>
<dt><code><var>int</var> <a href="Cryptographic-API.html#gnutls_005faead_005fcipher_005fdecrypt">gnutls_aead_cipher_decrypt</a> (gnutls_aead_cipher_hd_t <var>handle</var>, const void * <var>nonce</var>, size_t <var>nonce_len</var>, const void * <var>auth</var>, size_t <var>auth_len</var>, size_t <var>tag_size</var>, const void * <var>ctext</var>, size_t <var>ctext_len</var>, void * <var>ptext</var>, size_t * <var>ptext_len</var>)</code></dt>
<dt><code><var>void</var> <a href="Cryptographic-API.html#gnutls_005faead_005fcipher_005fdeinit">gnutls_aead_cipher_deinit</a> (gnutls_aead_cipher_hd_t <var>handle</var>)</code></dt>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Public-key-algorithms.html#Public-key-algorithms" accesskey="n" rel="next">Public key algorithms</a>, Up: <a href="Using-GnuTLS-as-a-cryptographic-library.html#Using-GnuTLS-as-a-cryptographic-library" accesskey="u" rel="up">Using GnuTLS as a cryptographic library</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Data-Index.html#Function-and-Data-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
