Manpages

Manpage of Net::LDAPS

Net::LDAPS

Section: User Contributed Perl Documentation (3)
Updated: 2001-10-04
Index
Return to Main Contents
 

NAME

Net::LDAPS - use LDAP over an SSL connection  

SYNOPSIS

 use Net::LDAPS;


 $ldaps = new Net::LDAPS('myhost.example.com',
                         port => '10000',
                         verify => 'require',
                         capath => '/usr/local/cacerts/');


 

DESCRIPTION

Communicate using the LDAP protocol to a directory server using a potentially encrypted (SSL) network connection.

This class is a subclass of Net::LDAP so all the normal Net::LDAP methods can be used with a Net::LDAPS object; see the documentation for Net::LDAP to find out how to query a directory server using the LDAP protocol.

Note that the use of LDAPS is not recommended, because it is not described by any IETF documents. Instead, you should consider using LDAPv3 with the TLS extension defined in RFC 2830. This will give you the same functionality as LDAPS, but using recognized standards. See ``start_tls'' in Net::LDAP.  

CONSTRUCTOR

new ( HOST [, OPTIONS ] )
Create a new connection. HOST is the hostname to contact. OPTIONS is a number of key/value pairs - additional keys to those understood by Net::LDAP::new are:
verify
How to verify the server's certificate, either 'none' (the server may provide a certificate but it will not be checked - this may mean you are be connected to the wrong server), 'optional' (verify if the server offers a certificate), or 'require' (the server must provide a certificate, and it must be valid.) If you set verify to optional or require, you must also set either cafile or capath. The most secure option is 'require'.
sslversion
This defines the version of the SSL/TLS protocol to use. Defaults to 'sslv2/3', other possible values are 'sslv2', 'sslv3', and 'tlsv1'.
ciphers
Specify which subset of cipher suites are permissible for this connection, using the standard OpenSSL string format. The default value for ciphers is 'ALL', which permits all ciphers, even those that don't encrypt!
clientcert
clientkey
If you want to use the client to offer a certificate to the server for SSL authentication (which is not the same as for the LDAP Bind operation) then set clientcert to the user's certificate file, and clientkey to the user's private key file. These files must be in PEM format.
capath
cafile
When verifying the server's certificate, either set capath to the pathname of the directory containing CA certificates, or set cafile to the filename containing the certificate of the CA who signed the server's certificate. These certificates must all be in PEM format.

The directory in 'capath' must contain certificates named using the hash value of themselves. To generate these names, use OpenSSL like this in Unix:

    ln -s cacert.pem `openssl x509 -hash -noout < cacert.pem`.0


(assuming that the certificate of the CA is in cacert.pem.)
 

ADDITIONAL METHODS

cipher
Returns the cipher mode being used by the connection, in the string format used by OpenSSL.
certificate
Returns an X509_Certificate object containing the server's certificate. See the IO::Socket::SSL documentation for information about this class.

For example, to get the subject name (in a peculiar OpenSSL-specific format, different from RFC 1779 and RFC 2253) from the server's certificate, do this:

    print "Subject DN: " . $ldaps->certificate->subject_name . "\n";


 

SEE ALSO

Net::LDAP, IO::Socket::SSL  

BUGS

Several apparently bogus warnings are emitted when initializing the two underlying modules used by Net::LDAPS, namely IO::Socket::SSL and Net::SSLeay. To avoid these, don't initialize via 'use Net::LDAPS' and instead try initializing Net::LDAPS like this:

    BEGIN {
        # Turn off all warnings etc whilst initializing
        # IO::Socket::SSL and Net::SSLeay.
        local $^W = 0;
        no strict;
        require Net::SSLeay;
        # The /dev/urandom is a device on Linux that returns
        # random data.
        Net::SSLeay::randomize('/dev/urandom');
        require Net::LDAPS;
    }


 

AUTHOR

Chris Ridd <chris.ridd@messagingdirect.com>  

COPYRIGHT

Copyright (c) 2000-2001, Chris Ridd and Graham Barr. All rights reserved. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.


 

Index

NAME
SYNOPSIS
DESCRIPTION
CONSTRUCTOR
ADDITIONAL METHODS
SEE ALSO
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html, using the manual pages.
Time: 09:17:41 GMT, March 28, 2024