summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_pkcs11_privkey_generate3.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages/gnutls_pkcs11_privkey_generate3.3
parentInitial commit. (diff)
downloadgnutls28-upstream.tar.xz
gnutls28-upstream.zip
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manpages/gnutls_pkcs11_privkey_generate3.3')
-rw-r--r--doc/manpages/gnutls_pkcs11_privkey_generate3.365
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_pkcs11_privkey_generate3.3 b/doc/manpages/gnutls_pkcs11_privkey_generate3.3
new file mode 100644
index 0000000..c400c93
--- /dev/null
+++ b/doc/manpages/gnutls_pkcs11_privkey_generate3.3
@@ -0,0 +1,65 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
+.TH "gnutls_pkcs11_privkey_generate3" 3 "3.7.9" "gnutls" "gnutls"
+.SH NAME
+gnutls_pkcs11_privkey_generate3 \- API function
+.SH SYNOPSIS
+.B #include <gnutls/pkcs11.h>
+.sp
+.BI "int gnutls_pkcs11_privkey_generate3(const char * " url ", gnutls_pk_algorithm_t " pk ", unsigned int " bits ", const char * " label ", const gnutls_datum_t * " cid ", gnutls_x509_crt_fmt_t " fmt ", gnutls_datum_t * " pubkey ", unsigned int " key_usage ", unsigned int " flags ");"
+.SH ARGUMENTS
+.IP "const char * url" 12
+a token URL
+.IP "gnutls_pk_algorithm_t pk" 12
+the public key algorithm
+.IP "unsigned int bits" 12
+the security bits
+.IP "const char * label" 12
+a label
+.IP "const gnutls_datum_t * cid" 12
+The CKA_ID to use for the new object
+.IP "gnutls_x509_crt_fmt_t fmt" 12
+the format of output params. PEM or DER
+.IP "gnutls_datum_t * pubkey" 12
+will hold the public key (may be \fBNULL\fP)
+.IP "unsigned int key_usage" 12
+One of GNUTLS_KEY_*
+.IP "unsigned int flags" 12
+zero or an OR'ed sequence of \fBGNUTLS_PKCS11_OBJ_FLAGs\fP
+.SH "DESCRIPTION"
+This function will generate a private key in the specified
+by the \fIurl\fP token. The private key will be generate within
+the token and will not be exportable. This function will
+store the DER\-encoded public key in the SubjectPublicKeyInfo format
+in \fIpubkey\fP . The \fIpubkey\fP should be deinitialized using \fBgnutls_free()\fP.
+
+Note that when generating an elliptic curve key, the curve
+can be substituted in the place of the bits parameter using the
+\fBGNUTLS_CURVE_TO_BITS()\fP macro.
+
+Since 3.6.3 the objects are marked as sensitive by default unless
+\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_NOT_SENSITIVE\fP is specified.
+.SH "RETURNS"
+On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
+negative error value.
+.SH "SINCE"
+3.4.0
+.SH "REPORTING BUGS"
+Report bugs to <bugs@gnutls.org>.
+.br
+Home page: https://www.gnutls.org
+
+.SH COPYRIGHT
+Copyright \(co 2001- Free Software Foundation, Inc., and others.
+.br
+Copying and distribution of this file, with or without modification,
+are permitted in any medium without royalty provided the copyright
+notice and this notice are preserved.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.
+If the /usr/share/doc/gnutls/
+directory does not contain the HTML form visit
+.B
+.IP https://www.gnutls.org/manual/
+.PP