|
Packit |
aea12f |
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
|
|
Packit Service |
991b93 |
.TH "gnutls_pkcs8_info" 3 "3.6.14" "gnutls" "gnutls"
|
|
Packit |
aea12f |
.SH NAME
|
|
Packit |
aea12f |
gnutls_pkcs8_info \- API function
|
|
Packit |
aea12f |
.SH SYNOPSIS
|
|
Packit |
aea12f |
.B #include <gnutls/x509.h>
|
|
Packit |
aea12f |
.sp
|
|
Packit |
aea12f |
.BI "int gnutls_pkcs8_info(const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int * " schema ", unsigned int * " cipher ", void * " salt ", unsigned int * " salt_size ", unsigned int * " iter_count ", char ** " oid ");"
|
|
Packit |
aea12f |
.SH ARGUMENTS
|
|
Packit |
aea12f |
.IP "const gnutls_datum_t * data" 12
|
|
Packit |
aea12f |
Holds the PKCS \fB8\fP data
|
|
Packit |
aea12f |
.IP "gnutls_x509_crt_fmt_t format" 12
|
|
Packit |
aea12f |
the format of the PKCS \fB8\fP data
|
|
Packit |
aea12f |
.IP "unsigned int * schema" 12
|
|
Packit |
aea12f |
indicate the schema as one of \fBgnutls_pkcs_encrypt_flags_t\fP
|
|
Packit |
aea12f |
.IP "unsigned int * cipher" 12
|
|
Packit |
aea12f |
the cipher used as \fBgnutls_cipher_algorithm_t\fP
|
|
Packit |
aea12f |
.IP "void * salt" 12
|
|
Packit |
aea12f |
PBKDF2 salt (if non\-NULL then \fIsalt_size\fP initially holds its size)
|
|
Packit |
aea12f |
.IP "unsigned int * salt_size" 12
|
|
Packit |
aea12f |
PBKDF2 salt size
|
|
Packit |
aea12f |
.IP "unsigned int * iter_count" 12
|
|
Packit |
aea12f |
PBKDF2 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 algorithms used
|
|
Packit |
aea12f |
in a particular PKCS \fB8\fP structure. If the structure algorithms
|
|
Packit |
aea12f |
are unknown the code \fBGNUTLS_E_UNKNOWN_CIPHER_TYPE\fP will be returned,
|
|
Packit |
aea12f |
and only \fIoid\fP , will be set. That is, \fIoid\fP will be set on encrypted PKCS \fB8\fP
|
|
Packit |
aea12f |
structures 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 isn't an encrypted key,
|
|
Packit |
aea12f |
\fBGNUTLS_E_UNKNOWN_CIPHER_TYPE\fP if the structure's encryption isn't supported, or
|
|
Packit |
aea12f |
another negative error code in case of a failure. Zero on success.
|
|
Packit |
aea12f |
.SH "SINCE"
|
|
Packit |
aea12f |
3.4.0
|
|
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 Service |
991b93 |
Copyright \(co 2001- 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
|