gnutls_pkcs11_token_get_info(3) — Linux manual page

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURNS | SINCE | REPORTING BUGS | COPYRIGHT | SEE ALSO | COLOPHON

gnutls_pkcs11_token_get_info(3)  gnutls  gnutls_pkcs11_token_get_info(3)

NAME         top

       gnutls_pkcs11_token_get_info - API function

SYNOPSIS         top

       #include <gnutls/pkcs11.h>

       int gnutls_pkcs11_token_get_info(const char * url,
       gnutls_pkcs11_token_info_t ttype, void * output, size_t *
       output_size);

ARGUMENTS         top

       const char * url
                   should contain a PKCS 11 URL

       gnutls_pkcs11_token_info_t ttype
                   Denotes the type of information requested

       void * output
                   where output will be stored

       size_t * output_size
                   contains the maximum size of the output buffer and
                   will be overwritten with the actual size.

DESCRIPTION         top

       This function will return information about the PKCS 11 token
       such as the label, id, etc.

       When output is text, a null terminated string is written to
       output and its string length is written to  output_size (without
       null terminator). If the buffer is too small,  output_size will
       contain the expected buffer size (with null terminator for text)
       and return GNUTLS_E_SHORT_MEMORY_BUFFER.

RETURNS         top

       GNUTLS_E_SUCCESS (0) on success or a negative error code on
       error.

SINCE         top

       2.12.0

REPORTING BUGS         top

       Report bugs to <[email protected]>.
       Home page: https://www.gnutls.org

COPYRIGHT         top

       Copyright © 2001-2023 Free Software Foundation, Inc., and others.
       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.

SEE ALSO         top

       The full documentation for gnutls is maintained as a Texinfo
       manual.  If the /usr/share/doc/gnutls/ directory does not contain
       the HTML form visit

       https://www.gnutls.org/manual/

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at
       ⟨http://www.gnutls.org/⟩.  If you have a bug report for this
       manual page, send it to [email protected].  This page was obtained
       from the tarball gnutls-3.8.5.tar.xz fetched from
       ⟨http://www.gnutls.org/download.html⟩ on 2024-06-14.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to [email protected]

gnutls                            3.8.5  gnutls_pkcs11_token_get_info(3)