Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ldap_tls (3oldap)

Name

ldap_tls - LDAP TLS initialization routines

Synopsis

#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

LDAP_TLS(3oldap)                                              LDAP_TLS(3oldap)



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

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #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
       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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------------+
       |ATTRIBUTE TYPE |       ATTRIBUTE VALUE        |
       +---------------+------------------------------+
       |Availability   | system/network/ldap/openldap |
       +---------------+------------------------------+
       |Stability      | Pass-through uncommitted     |
       +---------------+------------------------------+

SEE ALSO
       ldap(3), ldap_error(3)

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



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source was downloaded from   ftp://ftp.openldap.org/pub/OpenLDAP/openl-
       dap-release/openldap-2.4.59.tgz.

       Further information about this software can be found on the open source
       community website at http://www.openldap.org/.



OpenLDAP 2.4.59                   2021/06/03                  LDAP_TLS(3oldap)