gnutls_credentials_set(3) — Linux manual page

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

gnutls_credentials_set(3)        gnutls        gnutls_credentials_set(3)

NAME         top

       gnutls_credentials_set - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       int gnutls_credentials_set(gnutls_session_t session,
       gnutls_credentials_type_t type, void * cred);

ARGUMENTS         top

       gnutls_session_t session
                   is a gnutls_session_t type.

       gnutls_credentials_type_t type
                   is the type of the credentials

       void * cred the credentials to set

DESCRIPTION         top

       Sets the needed credentials for the specified type.  E.g.
       username, password - or public and private keys etc.  The  cred
       parameter is a structure that depends on the specified type and
       on the current session (client or server).

       In order to minimize memory usage, and share credentials between
       several threads gnutls keeps a pointer to cred, and not the whole
       cred structure.  Thus you will have to keep the structure
       allocated until you call gnutls_deinit().

       For GNUTLS_CRD_ANON,  cred should be
       gnutls_anon_client_credentials_t in case of a client.  In case of
       a server it should be gnutls_anon_server_credentials_t.

       For GNUTLS_CRD_SRP,  cred should be
       gnutls_srp_client_credentials_t in case of a client, and
       gnutls_srp_server_credentials_t, in case of a server.

       For GNUTLS_CRD_CERTIFICATE,  cred should be
       gnutls_certificate_credentials_t.

RETURNS         top

       On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a
       negative error code 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://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_credentials_set(3)