1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
LDAP Authentication
===================
:program:`auth_ldap` is an authentication plugin that authenticates connections
using an :abbr:`LDAP (Lightweight Directory Access Protocol)` server. An
LDAP server is required to provide authentication.
.. note:: Unload the :doc:`/plugins/auth_all/index` plugin before using this plugin.
.. seealso:: :doc:`/administration/authentication`
.. _auth_ldap_loading:
Loading
-------
To load this plugin, start :program:`drizzled` with::
--plugin-add=auth_ldap
Loading the plugin may not enable or configure it. See the plugin's
:ref:`auth_ldap_configuration` and :ref:`auth_ldap_variables`.
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
.. _auth_ldap_configuration:
Configuration
-------------
These command line options configure the plugin when :program:`drizzled`
is started. See :doc:`/configuration` for more information about specifying
command line options.
.. program:: drizzled
.. option:: --auth-ldap.base-dn ARG
:Default:
:Variable: :ref:`auth_ldap_base_dn <auth_ldap_base_dn>`
DN to use when searching.
.. option:: --auth-ldap.bind-db ARG
:Default:
:Variable: :ref:`auth_ldap_bind_dn <auth_ldap_bind_dn>`
DN to use when binding to the LDAP server.
.. option:: --auth-ldap.bind-password ARG
:Default:
:Variable: :ref:`auth_ldap_bind_password <auth_ldap_bind_password>`
Password to use when binding the DN.
.. option:: --auth-ldap.cache-timeout ARG
:Default: ``0``
:Variable: :ref:`auth_ldap_cache_timeout <auth_ldap_cache_timeout>`
How often to empty the users cache, 0 to disable.
.. option:: --auth-ldap.mysql-password-attribute ARG
:Default: ``mysqlUserPassword``
:Variable: :ref:`auth_ldap_mysql_password_attribute <auth_ldap_mysql_password_attribute>`
Attribute in LDAP with MySQL hashed password.
.. option:: --auth-ldap.password-attribute ARG
:Default: ``userPassword``
:Variable: :ref:`auth_ldap_password_attribute <auth_ldap_password_attribute>`
Attribute in LDAP with plain text password.
.. option:: --auth-ldap.uri ARG
:Default: ``ldap://127.0.0.1/``
:Variable: :ref:`auth_ldap_uri <auth_ldap_uri>`
URI of the LDAP server to contact.
.. _auth_ldap_variables:
Variables
---------
These variables show the running configuration of the plugin.
See `variables` for more information about querying and setting variables.
.. _auth_ldap_base_dn:
* ``auth_ldap_base_dn``
:Scope: Global
:Dynamic: No
:Option: :option:`--auth-ldap.base-dn`
DN to use when searching.
.. _auth_ldap_bind_dn:
* ``auth_ldap_bind_dn``
:Scope: Global
:Dynamic: No
:Option: :option:`--auth-ldap.bind-db`
DN to use when binding to the LDAP server.
.. _auth_ldap_bind_password:
* ``auth_ldap_bind_password``
:Scope: Global
:Dynamic: No
:Option: :option:`--auth-ldap.bind-password`
Password to use when binding the DN.
.. _auth_ldap_cache_timeout:
* ``auth_ldap_cache_timeout``
:Scope: Global
:Dynamic: No
:Option: :option:`--auth-ldap.cache-timeout`
How often to empty the users cache.
.. _auth_ldap_mysql_password_attribute:
* ``auth_ldap_mysql_password_attribute``
:Scope: Global
:Dynamic: No
:Option: :option:`--auth-ldap.mysql-password-attribute`
Attribute in LDAP with MySQL hashed password.
.. _auth_ldap_password_attribute:
* ``auth_ldap_password_attribute``
:Scope: Global
:Dynamic: No
:Option: :option:`--auth-ldap.password-attribute`
Attribute in LDAP with plain text password.
.. _auth_ldap_uri:
* ``auth_ldap_uri``
:Scope: Global
:Dynamic: No
:Option: :option:`--auth-ldap.uri`
URI of the LDAP server to contact.
.. _auth_ldap_examples:
Examples
--------
Sorry, there are no examples for this plugin.
.. _auth_ldap_authors:
Authors
-------
Eric Day
.. _auth_ldap_version:
Version
-------
This documentation applies to **auth_ldap 0.1**.
To see which version of the plugin a Drizzle server is running, execute:
.. code-block:: mysql
SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='auth_ldap'
Changelog
---------
v0.1
^^^^
* First release.
|