summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_pkcs11_copy_secret_key.3
blob: 4351a694b32fd0f2a9a917f59d59ecb571a40ea8 (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
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_pkcs11_copy_secret_key" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_pkcs11_copy_secret_key \- API function
.SH SYNOPSIS
.B #include <gnutls/pkcs11.h>
.sp
.BI "int gnutls_pkcs11_copy_secret_key(const char * " token_url ", gnutls_datum_t * " key ", const char * " label ", unsigned int " key_usage ", unsigned int " flags ");"
.SH ARGUMENTS
.IP "const char * token_url" 12
A PKCS \fB11\fP URL specifying a token
.IP "gnutls_datum_t * key" 12
The raw key
.IP "const char * label" 12
A name to be used for the stored data
.IP "unsigned int key_usage" 12
One of GNUTLS_KEY_*
.IP "unsigned int flags" 12
One of GNUTLS_PKCS11_OBJ_FLAG_*
.SH "DESCRIPTION"
This function will copy a raw secret (symmetric) key into a PKCS \fB11\fP 
token specified by a URL. The key can be marked as sensitive or not.
.SH "RETURNS"
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
negative error value.
.SH "SINCE"
2.12.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