"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_file_set_encryption.mdoc" (12 Mar 2019, 3554 Bytes) of package /linux/misc/libzip-1.5.2.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "zip_file_set_encryption.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_file_set_encryption.mdoc -- set encryption method for file
    2 .\" Copyright (C) 2016-2017 Dieter Baron and Thomas Klausner
    3 .\"
    4 .\" This file is part of libzip, a library to manipulate ZIP files.
    5 .\" The authors can be contacted at <libzip@nih.at>
    6 .\"
    7 .\" Redistribution and use in source and binary forms, with or without
    8 .\" modification, are permitted provided that the following conditions
    9 .\" are met:
   10 .\" 1. Redistributions of source code must retain the above copyright
   11 .\"    notice, this list of conditions and the following disclaimer.
   12 .\" 2. Redistributions in binary form must reproduce the above copyright
   13 .\"    notice, this list of conditions and the following disclaimer in
   14 .\"    the documentation and/or other materials provided with the
   15 .\"    distribution.
   16 .\" 3. The names of the authors may not be used to endorse or promote
   17 .\"    products derived from this software without specific prior
   18 .\"    written permission.
   19 .\"
   20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
   21 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   22 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
   24 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
   26 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
   28 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
   29 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
   30 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   31 .\"
   32 .Dd December 18, 2017
   33 .Dt ZIP_FILE_SET_ENCRYPTION 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_file_set_encryption
   37 .Nd set encryption method for file in zip
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft int
   43 .Fn zip_file_set_encryption "zip_t *archive" "zip_uint64_t index" "zip_uint16_t method" "const char *password"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_file_set_encryption
   47 function sets the encryption method for the file at position
   48 .Ar index
   49 in the zip archive to
   50 .Ar method
   51 using the password
   52 .Ar password .
   53 The
   54 .Ar method
   55 is the same as returned by
   56 .Xr zip_stat 3 .
   57 For the
   58 .Ar method
   59 argument, currently only the following values are supported:
   60 .Bl -tag -width ZIP_CM_DEFLATE_XX
   61 .It Dv ZIP_EM_NONE
   62 No encryption.
   63 .It Dv ZIP_EM_AES_128
   64 Winzip AES-128 encryption.
   65 .It Dv ZIP_EM_AES_192
   66 Winzip AES-192 encryption.
   67 .It Dv ZIP_EM_AES_256
   68 Winzip AES-256 encryption.
   69 .El
   70 .Pp
   71 If
   72 .Ar password
   73 is
   74 .Dv NULL ,
   75 the default password provided by
   76 .Xr zip_set_default_password 3
   77 is used.
   78 .Pp
   79 The current encryption method for a file in a zip archive can be
   80 determined using
   81 .Xr zip_stat 3 .
   82 .Sh RETURN VALUES
   83 Upon successful completion 0 is returned.
   84 Otherwise, \-1 is returned and the error information in
   85 .Ar archive
   86 is set to indicate the error.
   87 .Sh ERRORS
   88 .Fn zip_file_set_encryption
   89 fails if:
   90 .Bl -tag -width Er
   91 .It Bq Er ZIP_ER_ENCRNOTSUPP
   92 Unsupported compression method requested.
   93 .It Bq Er ZIP_ER_INVAL
   94 .Ar index
   95 is not a valid file index in
   96 .Ar archive ,
   97 or the argument combination is invalid.
   98 .It Bq Er ZIP_ER_MEMORY
   99 Required memory could not be allocated.
  100 .It Bq Er ZIP_ER_RDONLY
  101 Read-only zip file, no changes allowed.
  102 .El
  103 .Sh SEE ALSO
  104 .Xr libzip 3 ,
  105 .Xr zip_set_default_password 3 ,
  106 .Xr zip_stat 3
  107 .Sh HISTORY
  108 .Fn zip_file_set_encryption
  109 was added in libzip 1.2.0.
  110 .Sh AUTHORS
  111 .An -nosplit
  112 .An Dieter Baron Aq Mt dillo@nih.at
  113 and
  114 .An Thomas Klausner Aq Mt tk@giga.or.at