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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
.TH "DES crypto functions" 3 "30 Sep 2011" "Version 1.5.1" "Heimdal crypto library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DES crypto functions \-
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBDES_set_odd_parity\fP (DES_cblock *key)"
.br
.ti -1c
.RI "int HC_DEPRECATED \fBDES_check_key_parity\fP (DES_cblock *key)"
.br
.ti -1c
.RI "int \fBDES_is_weak_key\fP (DES_cblock *key)"
.br
.ti -1c
.RI "int HC_DEPRECATED \fBDES_set_key\fP (DES_cblock *key, DES_key_schedule *ks)"
.br
.ti -1c
.RI "int \fBDES_set_key_unchecked\fP (DES_cblock *key, DES_key_schedule *ks)"
.br
.ti -1c
.RI "int \fBDES_set_key_checked\fP (DES_cblock *key, DES_key_schedule *ks)"
.br
.ti -1c
.RI "int \fBDES_key_sched\fP (DES_cblock *key, DES_key_schedule *ks)"
.br
.ti -1c
.RI "void \fBDES_encrypt\fP (uint32_t u[2], DES_key_schedule *ks, int encp)"
.br
.ti -1c
.RI "void \fBDES_ecb_encrypt\fP (DES_cblock *input, DES_cblock *output, DES_key_schedule *ks, int encp)"
.br
.ti -1c
.RI "void \fBDES_cbc_encrypt\fP (const void *in, void *out, long length, DES_key_schedule *ks, DES_cblock *iv, int encp)"
.br
.ti -1c
.RI "void \fBDES_pcbc_encrypt\fP (const void *in, void *out, long length, DES_key_schedule *ks, DES_cblock *iv, int encp)"
.br
.ti -1c
.RI "void \fBDES_ecb3_encrypt\fP (DES_cblock *input, DES_cblock *output, DES_key_schedule *ks1, DES_key_schedule *ks2, DES_key_schedule *ks3, int encp)"
.br
.ti -1c
.RI "void \fBDES_ede3_cbc_encrypt\fP (const void *in, void *out, long length, DES_key_schedule *ks1, DES_key_schedule *ks2, DES_key_schedule *ks3, DES_cblock *iv, int encp)"
.br
.ti -1c
.RI "void \fBDES_cfb64_encrypt\fP (const void *in, void *out, long length, DES_key_schedule *ks, DES_cblock *iv, int *num, int encp)"
.br
.ti -1c
.RI "uint32_t \fBDES_cbc_cksum\fP (const void *in, DES_cblock *output, long length, DES_key_schedule *ks, DES_cblock *iv)"
.br
.ti -1c
.RI "void \fBDES_string_to_key\fP (const char *str, DES_cblock *key)"
.br
.ti -1c
.RI "int HC_DEPRECATED \fBDES_new_random_key\fP (DES_cblock *key)"
.br
.ti -1c
.RI "void HC_DEPRECATED \fBDES_init_random_number_generator\fP (DES_cblock *seed)"
.br
.ti -1c
.RI "void HC_DEPRECATED \fBDES_random_key\fP (DES_cblock *key)"
.br
.in -1c
.SH "Detailed Description"
.PP
See the \fBDES - Data Encryption Standard crypto interface\fP for description and examples.
.SH "Function Documentation"
.PP
.SS "uint32_t DES_cbc_cksum (const void * in, DES_cblock * output, long length, DES_key_schedule * ks, DES_cblock * iv)"
.PP
Crete a checksum using DES in CBC encryption mode. This mode is only used for Kerberos 4, and it should stay that way.
.PP
The IV must always be diffrent for diffrent input data blocks.
.PP
\fBParameters:\fP
.RS 4
\fIin\fP data to checksum
.br
\fIoutput\fP the checksum
.br
\fIlength\fP length of data
.br
\fIks\fP key schedule to use
.br
\fIiv\fP initial vector to use
.RE
.PP
.SS "void DES_cbc_encrypt (const void * in, void * out, long length, DES_key_schedule * ks, DES_cblock * iv, int encp)"
.PP
Encrypt/decrypt a block using DES in Chain Block Cipher mode (cbc).
.PP
The IV must always be diffrent for diffrent input data blocks.
.PP
\fBParameters:\fP
.RS 4
\fIin\fP data to encrypt
.br
\fIout\fP data to encrypt
.br
\fIlength\fP length of data
.br
\fIks\fP key schedule to use
.br
\fIiv\fP initial vector to use
.br
\fIencp\fP if non zero, encrypt. if zero, decrypt.
.RE
.PP
.SS "void DES_cfb64_encrypt (const void * in, void * out, long length, DES_key_schedule * ks, DES_cblock * iv, int * num, int encp)"
.PP
Encrypt/decrypt using DES in cipher feedback mode with 64 bit feedback.
.PP
The IV must always be diffrent for diffrent input data blocks.
.PP
\fBParameters:\fP
.RS 4
\fIin\fP data to encrypt
.br
\fIout\fP data to encrypt
.br
\fIlength\fP length of data
.br
\fIks\fP key schedule to use
.br
\fIiv\fP initial vector to use
.br
\fInum\fP offset into in cipher block encryption/decryption stop last time.
.br
\fIencp\fP if non zero, encrypt. if zero, decrypt.
.RE
.PP
.SS "int HC_DEPRECATED DES_check_key_parity (DES_cblock * key)"
.PP
Check if the key have correct parity.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP key to check the parity.
.RE
.PP
\fBReturns:\fP
.RS 4
1 on success, 0 on failure.
.RE
.PP
.SS "void DES_ecb3_encrypt (DES_cblock * input, DES_cblock * output, DES_key_schedule * ks1, DES_key_schedule * ks2, DES_key_schedule * ks3, int encp)"
.PP
Encrypt/decrypt a block using triple DES using EDE mode, encrypt/decrypt/encrypt.
.PP
\fBParameters:\fP
.RS 4
\fIinput\fP data to encrypt
.br
\fIoutput\fP data to encrypt
.br
\fIks1\fP key schedule to use
.br
\fIks2\fP key schedule to use
.br
\fIks3\fP key schedule to use
.br
\fIencp\fP if non zero, encrypt. if zero, decrypt.
.RE
.PP
.SS "void DES_ecb_encrypt (DES_cblock * input, DES_cblock * output, DES_key_schedule * ks, int encp)"
.PP
Encrypt/decrypt a block using DES.
.PP
\fBParameters:\fP
.RS 4
\fIinput\fP data to encrypt
.br
\fIoutput\fP data to encrypt
.br
\fIks\fP key schedule to use
.br
\fIencp\fP if non zero, encrypt. if zero, decrypt.
.RE
.PP
.SS "void DES_ede3_cbc_encrypt (const void * in, void * out, long length, DES_key_schedule * ks1, DES_key_schedule * ks2, DES_key_schedule * ks3, DES_cblock * iv, int encp)"
.PP
Encrypt/decrypt using Triple DES in Chain Block Cipher mode (cbc).
.PP
The IV must always be diffrent for diffrent input data blocks.
.PP
\fBParameters:\fP
.RS 4
\fIin\fP data to encrypt
.br
\fIout\fP data to encrypt
.br
\fIlength\fP length of data
.br
\fIks1\fP key schedule to use
.br
\fIks2\fP key schedule to use
.br
\fIks3\fP key schedule to use
.br
\fIiv\fP initial vector to use
.br
\fIencp\fP if non zero, encrypt. if zero, decrypt.
.RE
.PP
.SS "void DES_encrypt (uint32_t u[2], DES_key_schedule * ks, int encp)"
.PP
Encrypt/decrypt a block using DES. Also called ECB mode
.PP
\fBParameters:\fP
.RS 4
\fIu\fP data to encrypt
.br
\fIks\fP key schedule to use
.br
\fIencp\fP if non zero, encrypt. if zero, decrypt.
.RE
.PP
.SS "void HC_DEPRECATED DES_init_random_number_generator (DES_cblock * seed)"
.PP
Seed the random number generator. Deprecated, use \fBRAND - random number\fP
.PP
\fBParameters:\fP
.RS 4
\fIseed\fP a seed to seed that random number generate with.
.RE
.PP
.SS "int DES_is_weak_key (DES_cblock * key)"
.PP
Checks if the key is any of the weaks keys that makes DES attacks trival.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP key to check.
.RE
.PP
\fBReturns:\fP
.RS 4
1 if the key is weak, 0 otherwise.
.RE
.PP
.SS "int DES_key_sched (DES_cblock * key, DES_key_schedule * ks)"
.PP
Compatibility function for eay libdes, works just like \fBDES_set_key_checked()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP a key to initialize the key schedule with.
.br
\fIks\fP a key schedule to initialize.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on invalid parity, -2 on weak key.
.RE
.PP
.SS "int HC_DEPRECATED DES_new_random_key (DES_cblock * key)"
.PP
Generate a random des key using a random block, fixup parity and skip weak keys.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP is set to a random key.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, non zero on random number generator failure.
.RE
.PP
.SS "void DES_pcbc_encrypt (const void * in, void * out, long length, DES_key_schedule * ks, DES_cblock * iv, int encp)"
.PP
Encrypt/decrypt a block using DES in Propagating Cipher Block Chaining mode. This mode is only used for Kerberos 4, and it should stay that way.
.PP
The IV must always be diffrent for diffrent input data blocks.
.PP
\fBParameters:\fP
.RS 4
\fIin\fP data to encrypt
.br
\fIout\fP data to encrypt
.br
\fIlength\fP length of data
.br
\fIks\fP key schedule to use
.br
\fIiv\fP initial vector to use
.br
\fIencp\fP if non zero, encrypt. if zero, decrypt.
.RE
.PP
.SS "void HC_DEPRECATED DES_random_key (DES_cblock * key)"
.PP
Generate a random key, deprecated since it doesn't return an error code, use \fBDES_new_random_key()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP is set to a random key.
.RE
.PP
.SS "int HC_DEPRECATED DES_set_key (DES_cblock * key, DES_key_schedule * ks)"
.PP
Setup a des key schedule from a key. Deprecated function, use \fBDES_set_key_unchecked()\fP or \fBDES_set_key_checked()\fP instead.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP a key to initialize the key schedule with.
.br
\fIks\fP a key schedule to initialize.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success
.RE
.PP
.SS "int DES_set_key_checked (DES_cblock * key, DES_key_schedule * ks)"
.PP
Just like \fBDES_set_key_unchecked()\fP except checking that the key is not weak for or have correct parity.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP a key to initialize the key schedule with.
.br
\fIks\fP a key schedule to initialize.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on invalid parity, -2 on weak key.
.RE
.PP
.SS "int DES_set_key_unchecked (DES_cblock * key, DES_key_schedule * ks)"
.PP
Setup a des key schedule from a key. The key is no longer needed after this transaction and can cleared.
.PP
Does NOT check that the key is weak for or have wrong parity.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP a key to initialize the key schedule with.
.br
\fIks\fP a key schedule to initialize.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success
.RE
.PP
.SS "void DES_set_odd_parity (DES_cblock * key)"
.PP
Set the parity of the key block, used to generate a des key from a random key. See \fBDES key generation\fP.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP key to fixup the parity for.
.RE
.PP
.SS "void DES_string_to_key (const char * str, DES_cblock * key)"
.PP
Convert a string to a DES key. Use something like \fBPKCS5_PBKDF2_HMAC_SHA1()\fP to create key from passwords.
.PP
\fBParameters:\fP
.RS 4
\fIstr\fP The string to convert to a key
.br
\fIkey\fP the resulting key
.RE
.PP
|
