1.lf 1 stdin
2.TH LDAP_TLS 3 "2020/04/28" "OpenLDAP 2.4.50"
3.\" $OpenLDAP$
4.\" Copyright 1998-2020 The OpenLDAP Foundation All Rights Reserved.
5.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
6.SH NAME
7ldap_start_tls, ldap_start_tls_s, ldap_tls_inplace, ldap_install_tls \- LDAP TLS initialization routines
8.SH LIBRARY
9OpenLDAP LDAP (libldap, \-lldap)
10.SH SYNOPSIS
11.B #include <ldap.h>
12.LP
13.BI "int ldap_start_tls(LDAP *" ld ");"
14.LP
15.BI "int ldap_start_tls_s(LDAP *" ld ", LDAPControl **" serverctrls ", LDAPControl **" clientctrls ");"
16.LP
17.BI "int ldap_tls_inplace(LDAP *" ld ");"
18.LP
19.BI "int ldap_install_tls(LDAP *" ld ");"
20.SH DESCRIPTION
21These routines are used to initiate TLS processing on an LDAP session.
22.BR ldap_start_tls_s ()
23sends a StartTLS request to a server, waits for the reply, and then installs
24TLS handlers on the session if the request succeeded. The routine returns
25.B LDAP_SUCCESS
26if everything succeeded, otherwise it returns an LDAP error code.
27.BR ldap_start_tls ()
28sends a StartTLS request to a server and does nothing else. It returns
29.B LDAP_SUCCESS
30if the request was sent successfully.
31.BR ldap_tls_inplace ()
32returns 1 if TLS handlers have been installed on the specified session, 0
33otherwise.
34.BR ldap_install_tls ()
35installs the TLS handlers on the given session. It returns
36.B LDAP_LOCAL_ERROR
37if TLS is already installed.
38.SH SEE ALSO
39.BR ldap (3),
40.BR ldap_error (3)
41.SH ACKNOWLEDGEMENTS
42.lf 1 ./../Project
43.\" Shared Project Acknowledgement Text
44.B "OpenLDAP Software"
45is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
46.B "OpenLDAP Software"
47is derived from the University of Michigan LDAP 3.3 Release.  
48.lf 42 stdin
49