ZIP_FILE_SET_ENCRYPTION(3)

💖 ZIP_FILE_SET_ENCRYPTION(3) 💖

okay bestie, welcome to the Library Functions Manual page for zip_file_set_encryption — yes it's a long name, yes it's giving "I took a whole paragraph just to say my name," but she's worth it 🎀

---

✨ NAME ✨

zip_file_set_encryption — set encryption method for file in zip

📚 LIBRARY 📚

libzip (-lzip) — that's the girl. Link her in and we're good 💅

---

🌸 SYNOPSIS 🌸

#include <zip.h>

int
zip_file_set_encryption(zip_t *archive, zip_uint64_t index,
    zip_uint16_t method, const char *password);

---

🦋 DESCRIPTION 🦋

So like, the whole vibe of zip_file_set_encryption() is: you've got a file sitting at position index inside the zip archive, and you're like "hmm, this needs a lock on it 🔒" — and this function right here sets the encryption method for that file, using the password you hand it. That's the whole assignment, and she ate.

The method is literally the same thing that zip_stat(3) returns, so if you've been stat-ing around, you already know her.

For the method argument, currently only these values are supported — no more, no less, don't try to freestyle:

• ZIP_EM_NONE — no encryption at all. She's an open book 📖
• ZIP_EM_AES_128 — Winzip AES-128 encryption.
• ZIP_EM_AES_192 — Winzip AES-192 encryption.
• ZIP_EM_AES_256 — Winzip AES-256 encryption.
• ZIP_EM_TRAD_PKWARE — Traditional PKWare encryption.

NOT ME telling you this but: do not use ZIP_EM_TRAD_PKWARE, it is not secure. 🚩 It's only provided for backwards compatibility. Like, she's still on the guest list but everyone knows why.

If password is NULL, then the default password — the one you set with zip_set_default_password(3) — gets used instead. Convenient ✨

And if you ever wanna know what encryption method a file in a zip archive is currently rocking, you can just determine that with zip_stat(3). Vibe check via stat, love that for us.

---

🫶 RETURN VALUES 🫶

Upon successful completion, 0 is returned. Iconic. Perfect. No notes.

Otherwise, -1 is returned and the error information in archive is set to indicate the error. Not the slay we wanted 😭 but at least she tells you why.

---

💀 ERRORS 💀

zip_file_set_encryption() fails if:

• [ZIP_ER_ENCRNOTSUPP] — Unsupported compression method requested.
• [ZIP_ER_INVAL] — index is not a valid file index in archive, or the argument combination is invalid.
• [ZIP_ER_MEMORY] — Required memory could not be allocated. She's out of room, bestie 🥲
• [ZIP_ER_RDONLY] — Read-only zip file, no changes allowed. Hands off, she's not taking edits 🙅

---

👀 SEE ALSO 👀

libzip(3), zip_encryption_method_supported(3), zip_fopen_encrypted(3), zip_fopen_index_encrypted(3), zip_set_default_password(3), zip_stat(3)

---

🌈 HISTORY 🌈

zip_file_set_encryption() was added in libzip 1.2.0. She's been around a minute, iykyk 💜

👑 AUTHORS 👑

Dieter Baron <dillo@nih.at> and Thomas Klausner <wiz@gatalith.at> — the two icons who wrote this whole thing, we thank them for their service 🫡✨

---

and that's the page, bestie!! 🎀 this one came from Debian, dated April 2, 2020, and it's your girl ZIP_FILE_SET_ENCRYPTION(3) signing off — stay encrypted, stay iconic, periodt 💖🦋🌸