gnutls_pkcs11_obj_get_info(3) — Linux manual page

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

gnutls_pkcs11_obj_get_info(3)    gnutls    gnutls_pkcs11_obj_get_info(3)

NAME         top

       gnutls_pkcs11_obj_get_info - API function

SYNOPSIS         top

       #include <gnutls/pkcs11.h>

       int gnutls_pkcs11_obj_get_info(gnutls_pkcs11_obj_t obj,
       gnutls_pkcs11_obj_info_t itype, void * output, size_t *
       output_size);

ARGUMENTS         top

       gnutls_pkcs11_obj_t obj
                   should contain a gnutls_pkcs11_obj_t type

       gnutls_pkcs11_obj_info_t itype
                   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 PKCS11
       certificate such as the label, id as well as token information
       where the key is stored.

       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.

       In versions previously to 3.6.0 this function included the null
       terminator to  output_size . After 3.6.0 the output size doesn't
       include the terminator character.

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 <bugs@gnutls.org>.
       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 bugs@gnutls.org.  This page was obtained
       from the tarball gnutls-3.8.2.tar.xz fetched from
       ⟨http://www.gnutls.org/download.html⟩ on 2023-12-22.  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 man-pages@man7.org

gnutls                            3.8.2    gnutls_pkcs11_obj_get_info(3)