summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_pkcs11_copy_secret_key
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/gnutls_pkcs11_copy_secret_key')
-rw-r--r--doc/functions/gnutls_pkcs11_copy_secret_key23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/functions/gnutls_pkcs11_copy_secret_key b/doc/functions/gnutls_pkcs11_copy_secret_key
new file mode 100644
index 0000000..7ff3aed
--- /dev/null
+++ b/doc/functions/gnutls_pkcs11_copy_secret_key
@@ -0,0 +1,23 @@
+
+
+
+
+@deftypefun {int} {gnutls_pkcs11_copy_secret_key} (const char * @var{token_url}, gnutls_datum_t * @var{key}, const char * @var{label}, unsigned int @var{key_usage}, unsigned int @var{flags})
+@var{token_url}: A PKCS @code{11} URL specifying a token
+
+@var{key}: The raw key
+
+@var{label}: A name to be used for the stored data
+
+@var{key_usage}: One of GNUTLS_KEY_*
+
+@var{flags}: One of GNUTLS_PKCS11_OBJ_FLAG_*
+
+This function will copy a raw secret (symmetric) key into a PKCS @code{11}
+token specified by a URL. The key can be marked as sensitive or not.
+
+@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS} (0) is returned, otherwise a
+negative error value.
+
+@strong{Since:} 2.12.0
+@end deftypefun