1Catalyst::Model::LDAP(3U)ser Contributed Perl DocumentatiCoantalyst::Model::LDAP(3)
2
3
4

NAME

6       Catalyst::Model::LDAP - LDAP model class for Catalyst
7

VERSION

9       version 0.21
10

SYNOPSIS

12           # Use the Catalyst helper
13           script/myapp_create.pl model Person LDAP ldap.ufl.edu ou=People,dc=ufl,dc=edu
14
15           # Or, in lib/MyApp/Model/Person.pm
16           package MyApp::Model::Person;
17
18           use base qw/Catalyst::Model::LDAP/;
19
20           __PACKAGE__->config(
21               host => 'ldap.ufl.edu',
22               base => 'ou=People,dc=ufl,dc=edu',
23           );
24
25           1;
26
27           # Then, in your controller
28           my $mesg = $c->model('Person')->search('(cn=Lou Rhodes)');
29           my @entries = $mesg->entries;
30           print $entries[0]->sn;
31

DESCRIPTION

33       This is the Net::LDAP model class for Catalyst.  It is nothing more
34       than a simple wrapper for Net::LDAP.
35
36       This class simplifies LDAP access by letting you configure a common set
37       of bind arguments.  It also lets you configure a base DN for searching.
38
39       Please refer to the Net::LDAP documentation for information on what
40       else is available.
41

CONFIGURATION

43       The following configuration parameters are supported:
44
45       ·   "host"
46
47           The LDAP server's fully qualified domain name (FQDN), e.g.
48           "ldap.ufl.edu".  Can also be an IP address, e.g. 127.0.0.1.
49
50       ·   "base"
51
52           The base distinguished name (DN) for searching the directory, e.g.
53           "ou=People,dc=ufl,dc=edu".
54
55       ·   "dn"
56
57           (Optional) The bind DN for connecting to the directory, e.g.
58           "dn=admin,dc=ufl,dc=edu".  This can be anyone that has permission
59           to search under the base DN, as per your LDAP server's access
60           control lists.
61
62       ·   "password"
63
64           (Optional) The password for the specified bind DN.
65
66       ·   "start_tls"
67
68           (Optional) Set to 1 to use TLS when binding to the LDAP server, for
69           secure connections.
70
71       ·   "start_tls_options"
72
73           (Optional) A hashref containing options to use when binding using
74           TLS to the LDAP server.
75
76       ·   "options"
77
78           (Optional) A hashref containing options to pass to "search" in
79           Catalyst::Model::LDAP::Connection.  For example, this can be used
80           to set a sizelimit.
81
82           NOTE: In previous versions, these options were passed to all
83           Net::LDAP methods.  This has changed to allow a cleaner connection
84           interface.  If you still require this behavior, create a class
85           inheriting from Catalyst::Model::LDAP::Connection that overrides
86           the specific methods and set "connection_class".
87
88       ·   "connection_class"
89
90           (Optional) The class or package name that wraps Net::LDAP.
91           Defaults to Catalyst::Model::LDAP::Connection.
92
93           See also "OVERRIDING METHODS" in Catalyst::Model::LDAP::Connection.
94
95       ·   "entry_class"
96
97           (Optional) The class or package name to rebless Net::LDAP::Entry
98           objects as.  Defaults to Catalyst::Model::LDAP::Entry.
99
100           See also "ADDING ENTRY METHODS" in Catalyst::Model::LDAP::Entry.
101

INTERNAL METHODS

103   ACCEPT_CONTEXT
104       Bind the client using the current configuration and return it.  This
105       method is automatically called when you use e.g. "$c->model('LDAP')".
106
107       See "bind" in Catalyst::Model::LDAP::Connection for information on how
108       the bind operation is done.
109

SEE ALSO

111       ·   Catalyst::Helper::Model::LDAP
112
113       ·   Catalyst::Model::LDAP::Connection
114
115       ·   Catalyst::Model::LDAP::Search
116
117       ·   Catalyst::Model::LDAP::Entry
118
119       ·   Catalyst
120
121       ·   Net::LDAP
122

AUTHORS

124       ·   Daniel Westermann-Clark <danieltwc@cpan.org>
125
126       ·   Adam Jacob <holoway@cpan.org> (TLS support)
127
128       ·   Marcus Ramberg (paging support and entry AUTOLOAD)
129
130       ·   Gavin Henry <ghenry@surevoip.co.uk> (authz and raw support, plus
131           bug fixes)
132

ACKNOWLEDGMENTS

134       ·   Salih Gonullu, for initial work on Catalyst mailing list
135

LICENSE

137       This library is free software; you can redistribute it and/or modify it
138       under the same terms as Perl itself.
139

AUTHOR

141       Gavin Henry <ghenry@surevoip.co.uk>
142

144       This software is copyright (c) 2017 by Gavin Henry.
145
146       This is free software; you can redistribute it and/or modify it under
147       the same terms as the Perl 5 programming language system itself.
148
149
150
151perl v5.28.0                      2017-10-17          Catalyst::Model::LDAP(3)
Impressum