man7.org > Linux > man-pages

Linux/UNIX system programming training

ldap_tls(3) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | SEE ALSO | ACKNOWLEDGEMENTS | COLOPHON 

LDAP_TLS(3)             Library Functions Manual             LDAP_TLS(3)

NAME         top

       ldap_start_tls, ldap_start_tls_s, ldap_tls_inplace,
       ldap_install_tls - LDAP TLS initialization routines

LIBRARY         top

       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS         top

       #include <ldap.h>

       int ldap_start_tls(LDAP *ld);

       int ldap_start_tls_s(LDAP *ld, LDAPControl **serverctrls,
       LDAPControl **clientctrls);

       int ldap_tls_inplace(LDAP *ld);

       int ldap_install_tls(LDAP *ld);

DESCRIPTION         top

       These routines are used to initiate TLS processing on an LDAP
       session.  ldap_start_tls_s() sends a StartTLS request to a
       server, waits for the reply, and then installs TLS handlers on
       the session if the request succeeded. The routine returns
       LDAP_SUCCESS if everything succeeded, otherwise it returns an
       LDAP error code.  ldap_start_tls() sends a StartTLS request to a
       server and does nothing else. It returns LDAP_SUCCESS if the
       request was sent successfully.  ldap_tls_inplace() returns 1 if
       TLS handlers have been installed on the specified session, 0
       otherwise.  ldap_install_tls() installs the TLS handlers on the
       given session. It returns LDAP_LOCAL_ERROR if TLS is already
       installed.

SEE ALSO         top

       ldap(3), ldap_error(3)

ACKNOWLEDGEMENTS         top

       OpenLDAP Software is developed and maintained by The OpenLDAP
       Project <http://www.openldap.org/>.  OpenLDAP Software is derived
       from the University of Michigan LDAP 3.3 Release.

COLOPHON         top

       This page is part of the OpenLDAP (an open source implementation
       of the Lightweight Directory Access Protocol) project.
       Information about the project can be found at 
       ⟨http://www.openldap.org/⟩.  If you have a bug report for this
       manual page, see ⟨http://www.openldap.org/its/⟩.  This page was
       obtained from the project's upstream Git repository
       ⟨https://git.openldap.org/openldap/openldap.git⟩ on 2024-06-14.
       (At that time, the date of the most recent commit that was found
       in the repository was 2024-06-13.)  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

OpenLDAP LDVERSION             RELEASEDATE                   LDAP_TLS(3)

Pages that refer to this page: ldappasswd(1),  ldap(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI