Commit fb25538e authored by Charalampos Serenis's avatar Charalampos Serenis Committed by Bob
Browse files

sync'd development branch with sf git

parent 1c748cd7
mysql-auth_ldap is MySQL5 authentication plugin, allowing users to
authenticate them selfs through an LDAP server.
mysql-auth_ldap was writed by Charalampos Serenis <serenis@dev.infoscope.gr>
For copyright please check file COPYRIGHT.
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
Copyright (C) 2012 by Infoscope Hellas, L.P. <info@dev.infoscope.gr>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the
Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
A copy of the GNU General Public License exists in file `COPYING'
For a list of mysql-auth_ldap, MySQL5 LDAP authentication plugin, authors
please read file `AUTHORS'
2012-10-14 15:07 bob
* ChangeLog: First official release. Version 0.4
2012-10-14 15:04 bob
* INSTALL, src/auth_ldap.c, src/config.h: completed installation
instructions
2012-10-14 02:55 bob
* INSTALL: installation instructions
2012-10-14 02:13 bob
* src/Makefile: fixed makefile typo
2012-10-14 02:10 bob
* INSTALL, src/Makefile: installation instructions
2012-10-14 01:12 alkallio
* Makefile, src/Makefile, src/auth_ldap.c: added more variables to
the Makefiles
2012-10-14 00:30 bob
* AUTHORS, COPYING, COPYRIGHT, ChangeLog, INSTALL, NEWS, README,
src/AUTHORS, src/INSTALL: release files
2012-10-14 00:13 bob
* src/AUTHORS, src/INSTALL, src/Makefile, src/auth_ldap.c,
src/config.h, src/options.h: seperated configuration fil, added
more configuration options, set correct levels for each log
message
2012-10-12 17:02 bob
* src/Makefile, src/auth_ldap.c: module works!
2012-10-12 04:57 bob
* src/Makefile: really simple makefile
2012-10-12 04:52 bob
* src, src/auth_ldap.c: initial code
2012-10-12 04:52 bob
* .: auth ldap project
[ Prerequisities ]
auth_ldap is an authentication module for MySQL 5. Plugable
authentication is supported by MySQL from version 5.5.7 and up. Any
attempt to compile this module against MySQL source code older than that
will fail. Furthermore, in order to support LDAP connectivity the plugin
requires openLDAP library dynamically compiled. The plugin was tested to
compile against openldap version 2.4.23 and up. It is unknown if it
compiles with older versions.
[ Configuration ]
Before compiling the plugin you need to configure it. Unfortunately, the
plugin doesn't support dynamic configuration through a configuration
file and therefore all its options are statically compiled in the plugin.
Future releases, will provide a configuration file, but for the time
being you will have to set the correct options by editing the config.h
file located inside the src directory.
= AUTH_LDAP_URI =
A URI is passed verbatim to the ldap_initialize function. The URI has
the form: schema://hostname:port. If other fields are present, the
behavior is undefined.
Schema:
Apart from ldap, other (non-standard) recognized values of the schema
field are ldaps (LDAP over TLS), ldapi (LDAP over IPC), and cldap
(connectionless LDAP).
Hostname:
The hostname on which the LDAP server is running. The host parameter may
contain a blank-separated list of hosts to try to connect to, and each
host may optionally be of the form host:port.
Port:
The port number to which to connect. The port parameter is optional. If
it is not present the default LDAP port (389) will be used. However,
since the default LDAP port can be changed when compiling openLDAP, it
is highly recommended that you always specify the port number.
For more information regarding the URI please check the ldap_initialize
function man page:
http://linux.die.net/man/3/ldap_initialize
= AUTH_LDAP_BASE_DN =
The LDAP server base DN.
= AUTH_LDAP_OPENLDAP_SO =
The location of the openLDAP dynamic library (.so). Failing to provide
the plugin with a correct path will led to errors during loading and a
non functional plugin. Please, provide a full path to the library.
= AUTH_LDAP_SOCKET =
Posible values: 0,1
When AUTH_LDAP_SOCKET is enabled (set to 1) the plugin will only allow
users to connect through a UNIX domain socket. Off curse, this affects
only users that will authenticate with the auth_ldap module. If set to 1
please also see AUTH_LDAP_LOCAL option.
= AUTH_LDAP_LOCAL =
Possible values: 0,1
This option has no affect if the AUTH_LDAP_SOCKET is not enabled. When
AUTH_LDAP_LOCAL is enabled (set to 1) the plugin will only allow users
to connect through a UNIX domain socket or localhost. Off curse, this
affects only users that will authenticate with the auth_ldap module.
If set to 1 please also see AUTH_LDAP_LOCAL option.
= AUTH_LDAP_DN_PATTERN =
A pattern used to specify the user's DN for binding. The pattern enables
you to use predefined macros that will be expanded in order to create
the user's DN. The provided macros are:
%u
The user's username as specified in the client application
%i
When the username has the form: username@domain.tld the %i macro expands
to the username part of the email. If the username does not contain the
@ character %i expands the same as %u
%d
When the username has the form: username@domain.tld the %d macro expands
to the domain part of the email. If the username does not contain the
@ character %d expands to a zero string.
%d
Expands to the base DN as specified by AUTH_LDAP_BASE_DN
= AUTH_LDAP_ERROR_LEVEL =
Error level reporting through the system logs. Possible values:
AUTH_LDAP_ERROR
AUTH_LDAP_INFO
AUTH_LDAP_DEBUG
AUTH_LDAP_DEVEL
AUTH_LDAP_ERROR
Only report errors that are critical (fatal) for the plugin, and invalid
login attempts.
AUTH_LDAP_INFO
Log informational messages such as successful plugin loading with
minimal footprint on system logs. Error messages continue to be logged.
This setting is recommended for production systems.
AUTH_LDAP_DEBUG
Log debugging messages about plugin operations. This creates a fairly
large amount of logging data. This setting should be used on production
systems. On the other hand, if you wish to evaluate plugin's operation
compiling with debug messages enabled is encouraged.
AUTH_LDAP_DEVEL
!Attention!
This setting should never be used in production systems. It creates
security issues by logging memory addresses, user credentials etc. It is
only used by developers.
= Other configuration macros =
The file config.h contains a few more configuration macros. These, are
reserved for future use, and have not been implemented yet. Setting, any
value to them doesn't have any impact on plugin functionality.
[ Compiling ]
After configuring the plugin you can compile it by typing `make' in the
parent directory of the source. The build system will start with some
basic tests about openldap availability, API and will continue compiling
the module. This will create the auth_ldap.so plugin. The first time you
compile the plugin it is recommended that you set the error logging level
at least to AUTH_LDAP_INFO, in order to verify that the plugin loads
correctly.
[ Installing ]
Type `make install' as a superuser to install the plugin. After, you
installed your plugin you must add a configuration directive your my.cnf
in order to instruct you server to load the plugin during initialization.
Edit your my.cnf and add the following line:
plugin-load=auth_ldap.so
under the [mysqld] section. You now must restart your MySQL server for
the plugin to load. If you check your system logs you should see the
following lines, indicating that the plugin has loaded successfully:
Oct 14 04:48:58 infoscope mysql-auth_ldap[21516]: info: loading plugin auth_ldap...
Oct 14 04:48:58 infoscope mysql-auth_ldap[21516]: info: Copyright: Infoscope Hellas, L.P.
Oct 14 04:48:58 infoscope mysql-auth_ldap[21516]: info: plugin auth_ldap loaded successfully
In order to see the above lines you must configure auth_ldap module with
at least AUTH_LDAP_INFO error logging.
[ Troubleshooting ]
= Compilation errors =
/bin/sh: mysql_config: not found
If you are getting this error message, followed by a lot of compiler
errors this means that the build system is unable to locate the
mysql_config program. Under normal conditions this should be installed
in the system paths. First of all make sure you have MySQL installed in
your system. Then check if you can access mysql_config your self from
the console. If you can access it, then there is a problem with the
system paths during compilation. Please, find out the full path to your
config program by typing which mysql_config and the use the following
command for compiling the plugin:
make MYSQL_CONFIG=/usr/local/mysql/bin/mysql_config
If you cannot access mysql_config from console then you will have to
locate it manually and give its path to the make program, by using the
forementioned command. Please, note that if some Linux distributions
have seperate packages for runtime libraries and development files. Just
because you have installed MySQL to your system doesn't mean you have
the necessary development files installed. In Debian and Ubuntu you
should install libmysqlclient-dev package.
error: mysql/plugin_auth.h: No such file or directory
If you do not see a mysql_config: not found error and you are getting
this error, this probably means that you are trying to compile the
plugin against an old verion of MySQL. The plugin requires at least
version 5.5.7 to compile. You can check your MySQL version by typing
mysql_config --version
in the console.
error: ldap.h: No such file or directory
You do not have openLDAP library installed, or it is not installed in
system standard paths. If you need to specify the path the library
header files are installed set the CFLAGS value when invoking make.
e.g.:
make CFLAGS=-I/usr/local/include
[ Creating SQL users ]
After you have successfully installed and loaded the module, you must
create your database users. Unfortunately, there is not way to
automatically load username from the LDAP directory. Furthermore, the
plugin is called only when a user specified to authenticate with the
module tries to log in. All other users are left unaffected.
In order to create a user named bob, authenticated against the LDAP
directory, log in to your SQL server with an account having
administrative privileges and execute the following SQL command:
CREATE USER 'bob'@'localhost' IDENTIFIED WITH auth_ldap;
From now on, whenever user `bob' tries to login from localhost the
auth_ldap module is going to be invoked to handle authentication. You
can write a custom script to synchronize your LDAP users and MySQL users
and execute it via cron. Although this is sub-optimal, it is still
viable since you do not need to provide MySQL with a password for the
user. Therefore, your users can reuse their passwords. For more
information about MySQL plugable authentication please read MySQL
reference manual:
http://dev.mysql.com/doc/refman/5.5/en/pluggable-authentication.html