Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

archive_read_add_passphrase (3archive)

Name

archive_read_add_passphrase - functions for reading encrypted archives

Synopsis

#include <archive.h>
int
archive_read_add_passphrase(struct archive *, const char *passphrase);
int
archive_read_set_passphrase_callback(struct archive *,
void *client_data, archive_passphrase_callback *);

Description

                                         ARCHIVE_READ_ADD_PASSPHRASE(3archive)



NAME
       archive_read_add_passphrase, archive_read_set_passphrase_callback -
       functions for reading encrypted archives

LIBRARY
       Streaming Archive Library (libarchive, -larchive)

SYNOPSIS
       #include <archive.h>
       int
       archive_read_add_passphrase(struct archive *, const char *passphrase);
       int
       archive_read_set_passphrase_callback(struct archive *,
       void *client_data, archive_passphrase_callback *);

DESCRIPTION
            archive_read_add_passphrase()
                   Register passphrases for reading an encryption archive.  If
                   passphrase is NULL or empty, this function will do nothing
                   and ARCHIVE_FAILED will be returned.  Otherwise, ARCHIVE_OK
                   will be returned.

            archive_read_set_passphrase_callback()
                   Register a callback function that will be invoked to get a
                   passphrase for decryption after trying all the passphrases
                   registered by the archive_read_add_passphrase() function
                   failed.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------+
       |ATTRIBUTE TYPE |  ATTRIBUTE VALUE   |
       +---------------+--------------------+
       |Availability   | library/libarchive |
       +---------------+--------------------+
       |Stability      | Uncommitted        |
       +---------------+--------------------+

SEE ALSO
       tar(1), archive_read(3), archive_read_set_options(3), libarchive(3)



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://github.com/libarchive/libarchive/releases/down-
       load/v3.6.1/libarchive-3.6.1.tar.gz.

       Further information about this software can be found on the open source
       community website at http://www.libarchive.org/.



                              September 14, 2014
                                         ARCHIVE_READ_ADD_PASSPHRASE(3archive)