hcrypto_des(3)

💖 hcrypto_des — DES crypto functions 💖

okay bestie, sit DOWN, because this is the hcrypto_des(3) page from the Heimdal crypto library and it's literally the whole DES situation. old-school, iconic, slightly cursed, we love her 💅

---

✨ NAME ✨

hcrypto_des — DES crypto functions

---

🌸 SYNOPSIS 🌸

🎀 Functions 🎀

void DES_set_odd_parity (DES_cblock *key)
int HC_DEPRECATED DES_check_key_parity (DES_cblock *key)
int DES_is_weak_key (DES_cblock *key)
int HC_DEPRECATED DES_set_key (DES_cblock *key, DES_key_schedule *ks)
int DES_set_key_unchecked (DES_cblock *key, DES_key_schedule *ks)
int DES_set_key_checked (DES_cblock *key, DES_key_schedule *ks)
int DES_key_sched (DES_cblock *key, DES_key_schedule *ks)
void DES_encrypt (uint32_t u[2], DES_key_schedule *ks, int encp)
void DES_ecb_encrypt (DES_cblock *input, DES_cblock *output,
    DES_key_schedule *ks, int encp)
void DES_cbc_encrypt (const void *in, void *out, long length,
    DES_key_schedule *ks, DES_cblock *iv, int encp)
void DES_pcbc_encrypt (const void *in, void *out, long length,
    DES_key_schedule *ks, DES_cblock *iv, int encp)
void DES_ecb3_encrypt (DES_cblock *input, DES_cblock *output,
    DES_key_schedule *ks1, DES_key_schedule *ks2, DES_key_schedule *ks3,
    int encp)
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)
void DES_cfb64_encrypt (const void *in, void *out, long length,
    DES_key_schedule *ks, DES_cblock *iv, int *num, int encp)
uint32_t DES_cbc_cksum (const void *in, DES_cblock *output, long length,
    DES_key_schedule *ks, DES_cblock *iv)
void DES_string_to_key (const char *str, DES_cblock *key)
int HC_DEPRECATED DES_new_random_key (DES_cblock *key)
void HC_DEPRECATED DES_init_random_number_generator (DES_cblock *seed)
void HC_DEPRECATED DES_random_key (DES_cblock *key)

---

🦋 Detailed Description 🦋

See the DES - Data Encryption Standard crypto interface for description and examples. ✨ iykyk, that's where the actual lore lives 💖

---

👑 Function Documentation 👑

🌈 uint32_t DES_cbc_cksum (const void * in, DES_cblock * output, long length, DES_key_schedule * ks, DES_cblock * iv)

Creates a checksum using DES in CBC encryption mode. okay so bestie, heads up: this mode is only used for Kerberos 4, and it should stay that way. fr fr, do not go expanding her horizons 🫶

The IV must always be different for different input data blocks. no cap 🚫

Parameters

• in — data to checksum
• output — the checksum
• length — length of data
• ks — key schedule to use
• iv — initial vector to use

---

🌈 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). 🎀

The IV must always be different for different input data blocks. the way that matters 😭

Parameters

• in — data to encrypt
• out — data to encrypt
• length — length of data
• ks — key schedule to use
• iv — initial vector to use
• encp — if non zero, encrypt. if zero, decrypt.

---

🌈 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. slay 💅

The IV must always be different for different input data blocks. 🦋

Parameters

• in — data to encrypt
• out — data to encrypt
• length — length of data
• ks — key schedule to use
• iv — initial vector to use
• num — offset into in cipher block encryption/decryption stop last time.
• encp — if non zero, encrypt. if zero, decrypt.

---

🌈 int HC_DEPRECATED DES_check_key_parity (DES_cblock * key)

Check if the key have correct parity. note the HC_DEPRECATED, bestie — she's marked deprecated, so she's giving legacy energy 🙈

Parameters

• key — key to check the parity.

Returns

• 1 on success, 0 on failure.

---

🌈 void DES_ecb3_encrypt (DES_cblock * input, DES_cblock * output, DES_key_schedule * ks1, DES_key_schedule * ks2, DES_key_schedule * ks3, int encp)

Encrypt/decrypt a block using triple DES using EDE mode, encrypt/decrypt/encrypt. three keys, three schedules, main character energy 👑

Parameters

• input — data to encrypt
• output — data to encrypt
• ks1 — key schedule to use
• ks2 — key schedule to use
• ks3 — key schedule to use
• encp — if non zero, encrypt. if zero, decrypt.

---

🌈 void DES_ecb_encrypt (DES_cblock * input, DES_cblock * output, DES_key_schedule * ks, int encp)

Encrypt/decrypt a block using DES. classic, iconic, the original 💖

Parameters

• input — data to encrypt
• output — data to encrypt
• ks — key schedule to use
• encp — if non zero, encrypt. if zero, decrypt.

---

🌈 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). ✨

The IV must always be different for different input data blocks. periodt 💅

Parameters

• in — data to encrypt
• out — data to encrypt
• length — length of data
• ks1 — key schedule to use
• ks2 — key schedule to use
• ks3 — key schedule to use
• iv — initial vector to use
• encp — if non zero, encrypt. if zero, decrypt.

---

🌈 void DES_encrypt (uint32_t u[2], DES_key_schedule * ks, int encp)

Encrypt/decrypt a block using DES. Also called ECB mode 🌸

Parameters

• u — data to encrypt
• ks — key schedule to use
• encp — if non zero, encrypt. if zero, decrypt.

---

🌈 void HC_DEPRECATED DES_init_random_number_generator (DES_cblock * seed)

Seed the random number generator. Deprecated, use RAND - random number 🫶 bestie pls stop using this one, she's retired 🙈

Parameters

• seed — a seed to seed that random number generate with.

---

🌈 int DES_is_weak_key (DES_cblock * key)

Checks if the key is any of the weaks keys that makes DES attacks trival. 💀 yeah. she said trivial, and she meant it.

Parameters

• key — key to check.

Returns

• 1 if the key is weak, 0 otherwise.

---

🌈 int DES_key_sched (DES_cblock * key, DES_key_schedule * ks)

Compatibility function for eay libdes, works just like DES_set_key_checked(). nostalgia-core 🎀

Parameters

• key — a key to initialize the key schedule with.
• ks — a key schedule to initialize.

Returns

• 0 on success, -1 on invalid parity, -2 on weak key.

---

🌈 int HC_DEPRECATED DES_new_random_key (DES_cblock * key)

Generate a random des key using a random block, fixup parity and skip weak keys. marked HC_DEPRECATED, so proceed accordingly 🌈

Parameters

• key — is set to a random key.

Returns

• 0 on success, non zero on random number generator failure.

---

🌈 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. okay so again: this mode is only used for Kerberos 4, and it should stay that way. do not touch, do not expand, do not romanticize 🚫💅

The IV must always be different for different input data blocks.

Parameters

• in — data to encrypt
• out — data to encrypt
• length — length of data
• ks — key schedule to use
• iv — initial vector to use
• encp — if non zero, encrypt. if zero, decrypt.

---

🌈 void HC_DEPRECATED DES_random_key (DES_cblock * key)

Generate a random key, deprecated since it doesn't return an error code, use DES_new_random_key(). no error code = no closure, and that's why she's deprecated 😭

Parameters

• key — is set to a random key.

---

🌈 int HC_DEPRECATED DES_set_key (DES_cblock * key, DES_key_schedule * ks)

Setup a des key schedule from a key. Deprecated function, use DES_set_key_unchecked() or DES_set_key_checked() instead. bestie, pick one of the cool ones 🫶

Parameters

• key — a key to initialize the key schedule with.
• ks — a key schedule to initialize.

Returns

• 0 on success

---

🌈 int DES_set_key_checked (DES_cblock * key, DES_key_schedule * ks)

Just like DES_set_key_unchecked() except checking that the key is not weak for or have correct parity. she's the one who actually does the vibe check ✅

Parameters

• key — a key to initialize the key schedule with.
• ks — a key schedule to initialize.

Returns

• 0 on success, -1 on invalid parity, -2 on weak key.

---

🌈 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. 🌸

Does NOT check that the key is weak for or have wrong parity. okay so she does ZERO vibe checks, she just trusts you, which is lowkey terrifying 💀

Parameters

• key — a key to initialize the key schedule with.
• ks — a key schedule to initialize.

Returns

• 0 on success

---

🌈 void DES_set_odd_parity (DES_cblock * key)

Set the parity of the key block, used to generate a des key from a random key. See DES key generation. ✨

Parameters

• key — key to fixup the parity for.

---

🌈 void DES_string_to_key (const char * str, DES_cblock * key)

Convert a string to a DES key. Use something like PKCS5_PBKDF2_HMAC_SHA1() to create key from passwords. 👑 pls pls pls use the KDF, i am begging 🙏

Parameters

• str — The string to convert to a key
• key — the resulting key

---

💜 Author 💜

Generated automatically by Doxygen for Heimdal crypto library from the source code. she was born in a doc generator, and honestly? that's her origin story and it ate ✨

---

🎀 Sign-off 🎀

this whole page is from Version 7.8.0, dated Tue Nov 15 2022, and it's the hcrypto_des(3) page from the Heimdal crypto library. mwah, go encrypt something responsibly bestie 💖🦋💅