Blame doc/manpages/gnutls_pkcs12_mac_info.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit aea12f
.TH "gnutls_pkcs12_mac_info" 3 "3.6.8" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_pkcs12_mac_info \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/pkcs12.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_pkcs12_mac_info(gnutls_pkcs12_t " pkcs12 ", unsigned int * " mac ", void * " salt ", unsigned int * " salt_size ", unsigned int * " iter_count ", char ** " oid ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_pkcs12_t pkcs12" 12
Packit aea12f
A pkcs12 type
Packit aea12f
.IP "unsigned int * mac" 12
Packit aea12f
the MAC algorithm used as \fBgnutls_mac_algorithm_t\fP
Packit aea12f
.IP "void * salt" 12
Packit aea12f
the salt used for string to key (if non\-NULL then  \fIsalt_size\fP initially holds its size)
Packit aea12f
.IP "unsigned int * salt_size" 12
Packit aea12f
string to key salt size
Packit aea12f
.IP "unsigned int * iter_count" 12
Packit aea12f
string to key iteration count
Packit aea12f
.IP "char ** oid" 12
Packit aea12f
if non\-NULL it will contain an allocated null\-terminated variable with the OID
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will provide information on the MAC algorithm used
Packit aea12f
in a PKCS \fB12\fP structure. If the structure algorithms
Packit aea12f
are unknown the code \fBGNUTLS_E_UNKNOWN_HASH_ALGORITHM\fP will be returned,
Packit aea12f
and only  \fIoid\fP , will be set. That is,  \fIoid\fP will be set on structures
Packit aea12f
with a MAC whether supported or not. It must be deinitialized using \fBgnutls_free()\fP.
Packit aea12f
The other variables are only set on supported structures.
Packit aea12f
.SH "RETURNS"
Packit aea12f
\fBGNUTLS_E_INVALID_REQUEST\fP if the provided structure doesn't contain a MAC,
Packit aea12f
\fBGNUTLS_E_UNKNOWN_HASH_ALGORITHM\fP if the structure's MAC isn't supported, or
Packit aea12f
another negative error code in case of a failure. Zero on success.
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit aea12f
Copyright \(co 2001-2019 Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP