Skip to content

Commit

Permalink
Update README with startTLS info
Browse files Browse the repository at this point in the history
  • Loading branch information
sshanks-kx committed Nov 28, 2022
1 parent 1af6110 commit 229887a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,15 @@ Gets options globally that affect LDAP operating procedures. Reference .ldap.get

Syntax: `.ldap.getGlobalOption[option]`

### .ldap.startTLS

Using ldaps:// (with the appropriate TLS/SSL options) will perform the TLS handshake automatically on connection.
An alternative is to use `.ldap.startTLS` for initialising a TLS handshake on a normal ldap connection (calls [ldap_start_tls_s](https://linux.die.net/man/3/ldap_start_tls_s))

`.ldap.startTLS` 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.

Syntax: `.ldap.startTLS[sess]`

### .ldap.bind

Synchronous bind operations are used to authenticate clients (and the users or applications behind them) to the directory server, to establish an authorization identity that will be used for subsequent operations processed on that connection, and to specify the LDAP protocol version that the client will use. See [here](https://ldap.com/the-ldap-bind-operation/) for reference documentation
Expand Down

0 comments on commit 229887a

Please sign in to comment.