diff options
Diffstat (limited to 'doc/doxyout/hcrypto/man/man3/hcrypto_des.3')
| -rw-r--r-- | doc/doxyout/hcrypto/man/man3/hcrypto_des.3 | 135 |
1 files changed, 61 insertions, 74 deletions
diff --git a/doc/doxyout/hcrypto/man/man3/hcrypto_des.3 b/doc/doxyout/hcrypto/man/man3/hcrypto_des.3 index fd70a60a30e8..5459961fb3ca 100644 --- a/doc/doxyout/hcrypto/man/man3/hcrypto_des.3 +++ b/doc/doxyout/hcrypto/man/man3/hcrypto_des.3 @@ -1,8 +1,11 @@ -.TH "DES crypto functions" 3 "11 Jan 2012" "Version 1.5.2" "Heimdal crypto library" \" -*- nroff -*- +.TH "hcrypto_des" 3 "Fri Dec 8 2017" "Version 7.5.0" "Heimdal crypto library" \" -*- nroff -*- .ad l .nh .SH NAME -DES crypto functions \- +hcrypto_des +.SH SYNOPSIS +.br +.PP .SS "Functions" .in +1c @@ -66,14 +69,13 @@ DES crypto functions \- .in -1c .SH "Detailed Description" .PP -See the \fBDES - Data Encryption Standard crypto interface\fP for description and examples. +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)" +Crete a checksum using DES in CBC encryption mode\&. This mode is only used for Kerberos 4, and it should stay that way\&. .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. +The IV must always be diffrent for diffrent input data blocks\&. .PP \fBParameters:\fP .RS 4 @@ -90,10 +92,9 @@ The IV must always be diffrent for diffrent input data blocks. .PP .SS "void DES_cbc_encrypt (const void * in, void * out, long length, DES_key_schedule * ks, DES_cblock * iv, int encp)" +Encrypt/decrypt a block using DES in Chain Block Cipher mode (cbc)\&. .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. +The IV must always be diffrent for diffrent input data blocks\&. .PP \fBParameters:\fP .RS 4 @@ -107,15 +108,14 @@ The IV must always be diffrent for diffrent input data blocks. .br \fIiv\fP initial vector to use .br -\fIencp\fP if non zero, encrypt. if zero, decrypt. +\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)" +Encrypt/decrypt using DES in cipher feedback mode with 64 bit feedback\&. .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. +The IV must always be diffrent for diffrent input data blocks\&. .PP \fBParameters:\fP .RS 4 @@ -129,30 +129,28 @@ The IV must always be diffrent for diffrent input data blocks. .br \fIiv\fP initial vector to use .br -\fInum\fP offset into in cipher block encryption/decryption stop last time. +\fInum\fP offset into in cipher block encryption/decryption stop last time\&. .br -\fIencp\fP if non zero, encrypt. if zero, decrypt. +\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. +Check if the key have correct parity\&. .PP \fBParameters:\fP .RS 4 -\fIkey\fP key to check the parity. +\fIkey\fP key to check the parity\&. .RE .PP \fBReturns:\fP .RS 4 -1 on success, 0 on failure. +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. +Encrypt/decrypt a block using triple DES using EDE mode, encrypt/decrypt/encrypt\&. .PP \fBParameters:\fP .RS 4 @@ -166,13 +164,12 @@ Encrypt/decrypt a block using triple DES using EDE mode, encrypt/decrypt/encrypt .br \fIks3\fP key schedule to use .br -\fIencp\fP if non zero, encrypt. if zero, decrypt. +\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. +Encrypt/decrypt a block using DES\&. .PP \fBParameters:\fP .RS 4 @@ -182,15 +179,14 @@ Encrypt/decrypt a block using DES. .br \fIks\fP key schedule to use .br -\fIencp\fP if non zero, encrypt. if zero, decrypt. +\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)" +Encrypt/decrypt using Triple DES in Chain Block Cipher mode (cbc)\&. .PP -Encrypt/decrypt using Triple DES in Chain Block Cipher mode (cbc). -.PP -The IV must always be diffrent for diffrent input data blocks. +The IV must always be diffrent for diffrent input data blocks\&. .PP \fBParameters:\fP .RS 4 @@ -208,13 +204,12 @@ The IV must always be diffrent for diffrent input data blocks. .br \fIiv\fP initial vector to use .br -\fIencp\fP if non zero, encrypt. if zero, decrypt. +\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 +Encrypt/decrypt a block using DES\&. Also called ECB mode .PP \fBParameters:\fP .RS 4 @@ -222,72 +217,67 @@ Encrypt/decrypt a block using DES. Also called ECB mode .br \fIks\fP key schedule to use .br -\fIencp\fP if non zero, encrypt. if zero, decrypt. +\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 +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. +\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. +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. +\fIkey\fP key to check\&. .RE .PP \fBReturns:\fP .RS 4 -1 if the key is weak, 0 otherwise. +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. +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. +\fIkey\fP a key to initialize the key schedule with\&. .br -\fIks\fP a key schedule to initialize. +\fIks\fP a key schedule to initialize\&. .RE .PP \fBReturns:\fP .RS 4 -0 on success, -1 on invalid parity, -2 on weak key. +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. +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. +\fIkey\fP is set to a random key\&. .RE .PP \fBReturns:\fP .RS 4 -0 on success, non zero on random number generator failure. +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)" +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 -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. +The IV must always be diffrent for diffrent input data blocks\&. .PP \fBParameters:\fP .RS 4 @@ -301,29 +291,27 @@ The IV must always be diffrent for diffrent input data blocks. .br \fIiv\fP initial vector to use .br -\fIencp\fP if non zero, encrypt. if zero, decrypt. +\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. +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. +\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. +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. +\fIkey\fP a key to initialize the key schedule with\&. .br -\fIks\fP a key schedule to initialize. +\fIks\fP a key schedule to initialize\&. .RE .PP \fBReturns:\fP @@ -333,33 +321,31 @@ Setup a des key schedule from a key. Deprecated function, use \fBDES_set_key_unc .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. +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. +\fIkey\fP a key to initialize the key schedule with\&. .br -\fIks\fP a key schedule to initialize. +\fIks\fP a key schedule to initialize\&. .RE .PP \fBReturns:\fP .RS 4 -0 on success, -1 on invalid parity, -2 on weak key. +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)" +Setup a des key schedule from a key\&. The key is no longer needed after this transaction and can cleared\&. .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. +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. +\fIkey\fP a key to initialize the key schedule with\&. .br -\fIks\fP a key schedule to initialize. +\fIks\fP a key schedule to initialize\&. .RE .PP \fBReturns:\fP @@ -369,18 +355,16 @@ Does NOT check that the key is weak for or have wrong parity. .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. +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. +\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. +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 @@ -390,3 +374,6 @@ Convert a string to a DES key. Use something like \fBPKCS5_PBKDF2_HMAC_SHA1()\fP .RE .PP +.SH "Author" +.PP +Generated automatically by Doxygen for Heimdal crypto library from the source code\&. |