doc/manpages/gnutls_pkcs11_copy_secret_key.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_pkcs11_copy_secret_key" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_pkcs11_copy_secret_key \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .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 ");"
   9 .SH ARGUMENTS
  10 .IP "const char * token_url" 12
  11 A PKCS \fB11\fP URL specifying a token
  12 .IP "gnutls_datum_t * key" 12
  13 The raw key
  14 .IP "const char * label" 12
  15 A name to be used for the stored data
  16 .IP "unsigned int key_usage" 12
  17 One of GNUTLS_KEY_*
  18 .IP "unsigned int flags" 12
  19 One of GNUTLS_PKCS11_OBJ_FLAG_*
  20 .SH "DESCRIPTION"
  21 This function will copy a raw secret (symmetric) key into a PKCS \fB11\fP
  22 token specified by a URL. The key can be marked as sensitive or not.
  23 .SH "RETURNS"
  24 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
  25 negative error value.
  26 .SH "REPORTING BUGS"
  27 Report bugs to <bug-gnutls@gnu.org>.
  28 GnuTLS home page: http://www.gnu.org/software/gnutls/
  29 General help using GNU software: http://www.gnu.org/gethelp/
  30 .SH COPYRIGHT
  31 Copyright \(co 2008 Free Software Foundation.
  32 .br
  33 Copying and distribution of this file, with or without modification,
  34 are permitted in any medium without royalty provided the copyright
  35 notice and this notice are preserved.
  36 .SH "SEE ALSO"
  37 The full documentation for
  38 .B gnutls
  39 is maintained as a Texinfo manual.  If the
  40 .B info
  41 and
  42 .B gnutls
  43 programs are properly installed at your site, the command
  44 .IP
  45 .B info gnutls
  46 .PP
  47 should give you access to the complete manual.