external/bsd/openldap/man/ldap_tls.3

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