1LDAP_TLS(3)                Library Functions Manual                LDAP_TLS(3)
2
3
4

NAME

6       ldap_start_tls,  ldap_start_tls_s, ldap_tls_inplace, ldap_install_tls -
7       LDAP TLS initialization routines
8

LIBRARY

10       OpenLDAP LDAP (libldap, -lldap)
11

SYNOPSIS

13       #include <ldap.h>
14
15       int ldap_start_tls(LDAP *ld);
16
17       int ldap_start_tls_s(LDAP *ld, LDAPControl  **serverctrls,  LDAPControl
18       **clientctrls);
19
20       int ldap_tls_inplace(LDAP *ld);
21
22       int ldap_install_tls(LDAP *ld);
23

DESCRIPTION

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

SEE ALSO

37       ldap(3), ldap_error(3)
38

ACKNOWLEDGEMENTS

40       OpenLDAP Software is developed and maintained by The  OpenLDAP  Project
41       <http://www.openldap.org/>.  OpenLDAP Software is derived from the Uni‐
42       versity of Michigan LDAP 3.3 Release.
43
44
45
46OpenLDAP 2.4.50                   2020/04/28                       LDAP_TLS(3)