Blame doc/manpages/gnutls_pkcs12_bag_enc_info.3

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