ZIP_FILE_SET_ENCRYPTION
Section: C Library Functions (3)
Index
Return to Main Contents
BSD mandoc
NAME
zip_file_set_encryption
- set encryption method for file in zip
LIBRARY
libzip (-lzip)
SYNOPSIS
In zip.h
Ft int
Fn zip_file_set_encryption zip_t *archive zip_uint64_t index zip_uint16_t method const char *password
DESCRIPTION
The
Fn zip_file_set_encryption
function sets the encryption method for the file at position
index
in the zip archive to
method
using the password
password
The
method
is the same as returned by
zip_stat3.
For the
method
argument, currently only the following values are supported:
- ZIP_EM_NONE
-
No encryption.
- 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.
Do not use this method, it is not secure.
It is only provided for backwards compatibility.
If
password
is
NULL
the default password provided by
zip_set_default_password3
is used.
The current encryption method for a file in a zip archive can be
determined using
zip_stat3.
RETURN VALUES
Upon successful completion 0 is returned.
Otherwise, -1 is returned and the error information in
archive
is set to indicate the error.
ERRORS
Fn zip_file_set_encryption
fails if:
- Bq Er ZIP_ER_ENCRNOTSUPP
-
Unsupported compression method requested.
- Bq Er ZIP_ER_INVAL
-
index
is not a valid file index in
archive
or the argument combination is invalid.
- Bq Er ZIP_ER_MEMORY
-
Required memory could not be allocated.
- Bq Er ZIP_ER_RDONLY
-
Read-only zip file, no changes allowed.
SEE ALSO
libzip(3),
zip_encryption_method_supported3,
zip_fopen_encrypted3,
zip_fopen_index_encrypted3,
zip_set_default_password3,
zip_stat3
HISTORY
Fn zip_file_set_encryption
was added in libzip 1.2.0.
AUTHORS
An -nosplit
An Dieter Baron Aq Mt dillo@nih.at
and
An Thomas Klausner Aq Mt tk@giga.or.at
Index
- NAME
-
- LIBRARY
-
- SYNOPSIS
-
- DESCRIPTION
-
- RETURN VALUES
-
- ERRORS
-
- SEE ALSO
-
- HISTORY
-
- AUTHORS
-
This document was created by
man2html,
using the manual pages.
Time: 06:01:17 GMT, May 23, 2024