gnutls_cipher_suite_info(3) — Linux manual page

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

gnutls_cipher_suite_info(3)      gnutls      gnutls_cipher_suite_info(3)

NAME         top

       gnutls_cipher_suite_info - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       const char * gnutls_cipher_suite_info(size_t idx, unsigned char *
       cs_id, gnutls_kx_algorithm_t * kx, gnutls_cipher_algorithm_t *
       cipher, gnutls_mac_algorithm_t * mac, gnutls_protocol_t *
       min_version);

ARGUMENTS         top

       size_t idx  index of cipher suite to get information about,
                   starts on 0.

       unsigned char * cs_id
                   output buffer with room for 2 bytes, indicating
                   cipher suite value

       gnutls_kx_algorithm_t * kx
                   output variable indicating key exchange algorithm, or
                   NULL.

       gnutls_cipher_algorithm_t * cipher
                   output variable indicating cipher, or NULL.

       gnutls_mac_algorithm_t * mac
                   output variable indicating MAC algorithm, or NULL.

       gnutls_protocol_t * min_version
                   output variable indicating TLS protocol version, or
                   NULL.

DESCRIPTION         top

       Get information about supported cipher suites.  Use the function
       iteratively to get information about all supported cipher suites.
       Call with idx=0 to get information about first cipher suite, then
       idx=1 and so on until the function returns NULL.

RETURNS         top

       the name of  idx cipher suite, and set the information about the
       cipher suite in the output variables.  If  idx is out of bounds,
       NULL is returned.

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:https://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.2.tar.xz fetched from
       ⟨http:https://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 [email protected]

gnutls                            3.8.2      gnutls_cipher_suite_info(3)