summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_pkcs11_privkey_generate3.3
blob: c400c9345941bf8cf23a8bff66c6d95d09530241 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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