├── .travis.yml ├── CHANGELOG.rst ├── LICENSE ├── README.md ├── django_auth_ldap_ad ├── __init__.py ├── backend.py ├── models.py └── tests.py ├── setup.py └── testing-ci ├── manage.py ├── requirements.txt └── settings.py /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | 4 | python: 5 | - "2.7" 6 | 7 | env: 8 | - DJANGO_VERSION=1.4 9 | - DJANGO_VERSION=1.8 10 | 11 | apt: 12 | packages: 13 | - libldap2-dev 14 | - libsasl2-dev 15 | 16 | sudo: false 17 | 18 | install: 19 | - pip install Django==$DJANGO_VERSION 20 | - pip install . 21 | - pip install -r testing-ci/requirements.txt 22 | - pip install pep8 pyflakes 23 | 24 | before_script: 25 | - pep8 --ignore=E501 django_auth_ldap_ad/ 26 | - pyflakes django_auth_ldap_ad/ 27 | 28 | script: PYTHONPATH=$TRAVIS_BUILD_DIR python testing-ci/manage.py test django_auth_ldap_ad 29 | 30 | 31 | -------------------------------------------------------------------------------- /CHANGELOG.rst: -------------------------------------------------------------------------------- 1 | Changelog 2 | ========= 3 | 4 | HEAD 5 | ----- 6 | * Renamed the module src directory to django_auth_ldap_ad 7 | * Making pip package started (setup.py added) 8 | 9 | 10 | 1.0.0 11 | ----- 12 | * First release, used in producetion enviroment, based on python-ldap package, python2 only. 13 | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | django-auth-ldap-ad 2 | =================== 3 | 4 | 5 | ## Status 6 | The project **is not maintained**. Use with extreme caution. Issues: 7 | * Django version is old and one should upgrade this package for later django version. Please make pull request. 8 | * There is good start on writing the whole thing in python3 https://github.com/susundberg/django-auth-ldap-ad/pull/13 that was not merged since it was not tested on target. 9 | * Security advisory GHSA-3gh2-xw74-jmcw (high severity) is effective on this repository. 10 | 11 | 12 | USE WITH EXTREME CARE. YOU HAVE BEEN WARNED. 13 | 14 | 15 | 16 | ## Why 17 | Django authentication backend for LDAP with Active Directory 18 | 19 | I created this project since i could not find proper way of doing binding with SASL using [django-auth-ldap](https://pythonhosted.org/django-auth-ldap/). 20 | 21 | Problem is that not all AD setups support TLS. So if SASL is not used the password and username when doing the bind is sent cleartext over the network. SASL provides some security with for example DIGEST-MD5. 22 | 23 | While adding support for django-auth-ldap would have been one option, the library looked too heavy for my usecase, and googling gave me messy looking snippet from [snippets](https://djangosnippets.org/snippets/501/) i decided to make minimal AD-backend of my own. 24 | 25 | 26 | ## Installation 27 | Copy the package to your django project root and add it to INSTALLED apps 28 | 29 | Required packages: ldap and mockldap for testing. See [.travis.yml](https://github.com/susundberg/django-auth-ldap-ad/blob/master/.travis.yml) for how to build is done in CI service. 30 | 31 | ## Usage 32 | 33 | Modify your settings to contain authentication backend, for example 34 | 35 | AUTHENTICATION_BACKENDS = ('django.contrib.auth.backends.ModelBackend', 'django-auth-ldap-ad.backend.LDAPBackend') 36 | 37 | 38 | AUTH_LDAP_SERVER_URI = ["ldap://localhost:389","ldap://remote_host.org:389"] 39 | AUTH_LDAP_SEARCH_DN = "DC=mydomain,DC=org" 40 | 41 | AUTH_LDAP_USER_FLAGS_BY_GROUP = { 42 | # Groups on left side are memberOf key values. If all the groups are found in single entry, then the flag is set to 43 | # True. If no entry contains all required groups then the flag is set False. 44 | 45 | "is_superuser" : ["CN=WebAdmin,DC=mydomain"], 46 | # Above example will match on entry "CN=WebAdmin,DC=mydomain,OU=People,OU=Users" 47 | # Above will NOT match "CN=WebAdmin,OU=People,OU=Users" (missing DC=mydomain). 48 | 49 | "is_staff" : ["CN=Developer,DC=mydomain","CN=Tester,DC=mydomain"] 50 | # True if one of the conditions is true. 51 | 52 | 53 | } 54 | 55 | # All people that are to be staff are also to belong to this group 56 | AUTH_LDAP_USER_GROUPS_BY_GROUP = { 57 | "AdminGroup" : AUTH_LDAP_USER_FLAGS_BY_GROUP["is_staff"], 58 | } 59 | 60 | # Map django user preferences 61 | AUTH_LDAP_USER_ATTR_MAP = { 62 | "first_name": "givenName", 63 | "last_name": "sn", 64 | "email": "mail" 65 | } 66 | 67 | # Troubleshooting 68 | 69 | I use [tcpdump](http://linux.die.net/man/1/tcpdump) for checking what happens on the wire and and [ldapsearch](http://linux.die.net/man/1/ldapsearch) to debug the AD server functionality. 70 | 71 | For example: 72 | 73 | ldapsearch -LLL -h "ldapdomainhere" -U "myuserid" -w "mypasswordid" -Y DIGEST-MD5 -b "dc=mydomain,dc=org" "SAMAccountName=myusername" 74 | 75 | # What it does? 76 | 77 | for server in configured_servers: 78 | try to open connection and do bind 79 | -> except: server is down -> continue 80 | -> except: bad credentials -> return no login from LDAP backend 81 | 82 | try to dosearch and update django user preferences from ldap search response 83 | -> except: no entry found -> return no login from LDAP backend 84 | 85 | 86 | 87 | 88 | 89 | ## References 90 | 91 | #### CONNECTION_OPTIONS 92 | 93 | Default : { ldap.OPT_REFERRALS : 0} 94 | 95 | Set Ldap connection optios, as in [python-ldap options](http://www.python-ldap.org/doc/html/ldap.html#options). 96 | For the default option, see [python ldap faq question 12](http://www.python-ldap.org/faq.shtml). 97 | 98 | 99 | #### SERVER_URI 100 | 101 | Defaut : ['ldap://localhost'], 102 | 103 | List of servers to be used. Looped until one response is received (negative or positive). 104 | 105 | Example : ['ldap://foo.org','ldap://bar.org'] 106 | 107 | #### USER_FLAGS_BY_GROUP 108 | 109 | Defaut : { } 110 | 111 | Dictonary of 'flag_name' : list of 'required groups'. Set user flags (True/False) based on if requirement is met. 112 | 113 | The requirement is set met for 'required groups', if the (comma separated) groups are found from single memberOf field entry. 114 | If one of the list entries meets the requirement, then the list requirement is met. That is: on match, return True, otherwise, return False. 115 | 116 | Example : { 'is_superuser' : [ 'cn=admins,cn=website,ou=IT', 'cn=sysadmin,ou=IT' ] } 117 | 118 | #### USER_GROUPS_BY_GROUP 119 | 120 | Defaut : { } 121 | 122 | Dictonary of 'group name' : list of 'required groups'. Adds user to the group if all requirement is met (see USER_FLAGS_BY_GROUP). 123 | 124 | 125 | 126 | #### USER_ATTR_MAP 127 | 128 | Defaut : { } 129 | 130 | Dictonary of 'django user attribute' : 'ldap user attribute' . Maps given ldap attributes to django user attributes. 131 | 132 | 133 | #### TRACE_LEVEL 134 | 135 | Defaut : 0 136 | 137 | Set python LDAP trace level, see [python-ldap](http://www.python-ldap.org/doc/html/ldap.html) 138 | 139 | #### SASL_MECH 140 | 141 | Defaut : "DIGEST-MD5" 142 | 143 | Set SASL mechanism, see python-ldap manual. 144 | 145 | 146 | #### SEARCH_DN 147 | 148 | Defaut : "DC=localdomain,DC=ORG" 149 | 150 | When performing the user search what to use as startpoint, corresponds to '-b' options in [ldapsearch](http://linux.die.net/man/1/ldapsearch) 151 | 152 | #### SEARCH_FILTER 153 | 154 | Default : 'SEARCH_FILTER' : "(SAMAccountName=%(user)s)" 155 | 156 | With what to filter the search results. 157 | 158 | # Python 3? 159 | Sorry no luck. Seems like python-ldap package is not python3 compatible, and rather than porting it some people made new library ldap3, that is something totally different. As i am no longer working actively with this project i am not doing the porting. But please, if you want i would be more than happy to merge such changes. 160 | 161 | # Tested with 162 | * There is CI running on the repo at https://travis-ci.org/susundberg/django-auth-ldap-ad/ -- its currently testing with Python 2.7 and with Django-1.4 and Django-1.8 (both beeing LTS). 163 | * Used in production enviroment in 2015 : Django 1.4 and Debian 7 164 | 165 | [![Build Status](https://travis-ci.org/susundberg/django-auth-ldap-ad.svg?branch=master)](https://travis-ci.org/susundberg/django-auth-ldap-ad) 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | -------------------------------------------------------------------------------- /django_auth_ldap_ad/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/susundberg/django-auth-ldap-ad/a667daf0e841209729297540295b610ad1e5e94a/django_auth_ldap_ad/__init__.py -------------------------------------------------------------------------------- /django_auth_ldap_ad/backend.py: -------------------------------------------------------------------------------- 1 | 2 | import ldap 3 | import ldap.sasl 4 | from django.contrib.auth.models import User, Group 5 | 6 | import six 7 | 8 | 9 | class LDAPBackendException(Exception): 10 | pass 11 | 12 | """ 13 | Main class for handling the authentication 14 | """ 15 | 16 | 17 | class LDAPBackend(object): 18 | 19 | def authenticate(self, username=None, password=None): 20 | if not hasattr(self, "ldap_settings"): 21 | self.ldap_settings = LDAPSettings() 22 | 23 | if isinstance(self.ldap_settings.SERVER_URI, six.string_types): 24 | servers_urls = [self.ldap_settings.SERVER_URI] 25 | else: 26 | servers_urls = self.ldap_settings.SERVER_URI 27 | 28 | # For all configured servers try to connect 29 | for server in servers_urls: 30 | # Use self.ldap_connection object if such is given for testing with 31 | # mockldap. 32 | if not hasattr(self, "ldap_connection"): 33 | try: 34 | ldap_connection = self.ldap_open_connection( 35 | server, username, password) 36 | except ldap.SERVER_DOWN: 37 | continue 38 | except ldap.INVALID_CREDENTIALS: 39 | return None 40 | else: # end up here with mock 41 | ldap_connection = self.ldap_connection 42 | 43 | for key, value in self.ldap_settings.CONNECTION_OPTIONS.items(): 44 | ldap_connection.set_option(key, value) 45 | 46 | # Do search 47 | try: 48 | ldap_user_info = self.ldap_search_user( 49 | ldap_connection, username, password) 50 | except LDAPBackendException: 51 | return None 52 | 53 | return self.get_local_user(username, ldap_user_info) 54 | return None 55 | 56 | def get_user(self, user_id): 57 | try: 58 | return User.objects.get(pk=user_id) 59 | except User.DoesNotExist: 60 | return None 61 | 62 | def ldap_open_connection(self, ldap_url, username, password): 63 | ldap_session = ldap.initialize( 64 | ldap_url, trace_level=self.ldap_settings.TRACE_LEVEL) 65 | 66 | sasl_auth = ldap.sasl.sasl({ 67 | ldap.sasl.CB_AUTHNAME: username, 68 | ldap.sasl.CB_PASS: password, 69 | }, 70 | self.ldap_settings.SASL_MECH 71 | ) 72 | 73 | ldap_session.sasl_interactive_bind_s("", sasl_auth) 74 | return ldap_session 75 | 76 | # Search for user, returns users info (dict) 77 | def ldap_search_user(self, connection, username, password): 78 | ldap_result_id = connection.search( 79 | self.ldap_settings.SEARCH_DN, 80 | ldap.SCOPE_SUBTREE, 81 | self.ldap_settings.SEARCH_FILTER % { 82 | "user": username}) 83 | result_all_type, result_all_data = connection.result(ldap_result_id, 1) 84 | result_entries = [] 85 | for result_type, result_data in result_all_data: 86 | if result_type is not None: 87 | result_entries.append(result_data) 88 | 89 | if len(result_entries) == 0: 90 | raise LDAPBackendException("No entries found!") 91 | 92 | if len(result_entries) != 1: 93 | raise LDAPBackendException("More than one found!") 94 | 95 | return result_entries[0] 96 | 97 | def get_local_user(self, ldap_username, info): 98 | username = ldap_username.lower() 99 | try: 100 | user = User.objects.get(username=username) 101 | except User.DoesNotExist: 102 | # Make new one 103 | user = User(username=username) 104 | user.set_unusable_password() 105 | # refresh memberships 106 | members_of = [] 107 | for group in info.get('memberOf', []): 108 | members_of.append(group.lower().split(",")) 109 | 110 | # Set first_name or last_name or email .. 111 | for key, value in self.ldap_settings.USER_ATTR_MAP.items(): 112 | if value in info: 113 | setattr(user, key, info[value][0]) 114 | 115 | def check_for_membership(members_of, required_groups_options): 116 | """ Check for membership in given groups, 117 | Parameter: 118 | required_groups_options - can be string or list of strings. Each entry must 119 | be comma-separeted groupnames """ 120 | 121 | if isinstance(required_groups_options, six.string_types): 122 | required_groups_options = [required_groups_options] 123 | 124 | for required_groups in required_groups_options: 125 | required_groups = required_groups.lower().split(",") 126 | # check for all members of groups 127 | for member_of_group in members_of: 128 | # check that all required groups are in this membership 129 | requirement_fullfilled = all( 130 | (required_group in member_of_group) for required_group in required_groups) 131 | if requirement_fullfilled: 132 | return True 133 | return False 134 | 135 | # set is_superuser etc 136 | for wanted_property, requirements in self.ldap_settings.USER_FLAGS_BY_GROUP.items(): 137 | has_property = check_for_membership(members_of, requirements) 138 | setattr(user, wanted_property, has_property) 139 | 140 | # We need to do save before we can use the groups (for m2m binding) 141 | user.save() 142 | # user.groups.add( Group.objects.get(name = "ODAdmin")) 143 | for wanted_group, requirements in self.ldap_settings.USER_GROUPS_BY_GROUP.items(): 144 | if check_for_membership(members_of, requirements): 145 | user.groups.add(Group.objects.get(name=wanted_group)) 146 | else: 147 | user.groups.remove(Group.objects.get(name=wanted_group)) 148 | user.save() 149 | return user 150 | 151 | 152 | """ Load settings from Django settigns """ 153 | 154 | 155 | class LDAPSettings(object): 156 | defaults = { 157 | 'CONNECTION_OPTIONS': {ldap.OPT_REFERRALS: 0}, 158 | 'SERVER_URI': 'ldap://localhost', 159 | 'USER_FLAGS_BY_GROUP': {}, 160 | 'USER_GROUPS_BY_GROUP': {}, 161 | 'USER_ATTR_MAP': {}, 162 | 'TRACE_LEVEL': 0, 163 | 'SASL_MECH': 'DIGEST-MD5', 164 | 'SEARCH_DN': "DC=localdomain,DC=ORG", 165 | 'SEARCH_FILTER': "(SAMAccountName=%(user)s)" 166 | } 167 | 168 | def __init__(self, prefix='AUTH_LDAP_'): 169 | from django.conf import settings 170 | 171 | for name, default in self.defaults.items(): 172 | value = getattr(settings, prefix + name, default) 173 | setattr(self, name, value) 174 | -------------------------------------------------------------------------------- /django_auth_ldap_ad/models.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/susundberg/django-auth-ldap-ad/a667daf0e841209729297540295b610ad1e5e94a/django_auth_ldap_ad/models.py -------------------------------------------------------------------------------- /django_auth_ldap_ad/tests.py: -------------------------------------------------------------------------------- 1 | 2 | 3 | import mockldap 4 | import backend 5 | 6 | from django.test import TestCase 7 | 8 | 9 | from django.contrib.auth.models import User, Group 10 | 11 | 12 | class TestSettings(backend.LDAPSettings): 13 | 14 | def __init__(self, **kwargs): 15 | for name, default in self.defaults.items(): 16 | value = kwargs.get(name, default) 17 | setattr(self, name, value) 18 | 19 | 20 | class LDAPBackendTest(TestCase): 21 | top = ('o=test', {'o': 'test'}) 22 | alice = ('cn=alice,ou=example,o=test', 23 | {'SAMAccountName': ['alice'], 24 | 'userPassword': ['alicepw'], 25 | 'memberOf': ["dc=test,cn=admin,cn=extra,cn=fake,ou=foo", 26 | "dc=test,cn=superuser,cn=extra,cn=fake,ou=foo", 27 | "dc=test,cn=fakuser,cn=extra,cn=fake,ou=foo"]}) 28 | 29 | # This is the content of our mock LDAP directory. It takes the form 30 | # {dn: {attr: [value, ...], ...}, ...}. 31 | directory = dict([top, alice]) 32 | 33 | @classmethod 34 | def setUpClass(cls): 35 | # We only need to create the MockLdap instance once. The content we 36 | # pass in will be used for all LDAP connections. 37 | cls.mockldap = mockldap.MockLdap(cls.directory) 38 | 39 | @classmethod 40 | def tearDownClass(cls): 41 | del cls.mockldap 42 | 43 | def setUp(self): 44 | self.mockldap.start() 45 | self.ldapobj = self.mockldap['ldap://localhost/'] 46 | self.backend = backend.LDAPBackend() 47 | self.backend.ldap_connection = self.ldapobj 48 | 49 | def tearDown(self): 50 | # Stop patching ldap.initialize and reset state. 51 | self.mockldap.stop() 52 | del self.ldapobj 53 | 54 | def _init_settings(self, **kwargs): 55 | self.backend.ldap_settings = TestSettings(**kwargs) 56 | 57 | def test_options(self): 58 | self._init_settings( 59 | SEARCH_DN="o=test", 60 | CONNECTION_OPTIONS={'opt1': 'value1'} 61 | ) 62 | self.backend.authenticate(username='alice', password='alicepw') 63 | self.assertEqual(self.ldapobj.get_option('opt1'), 'value1') 64 | 65 | def test_server_uri_string(self): 66 | self._init_settings( 67 | SEARCH_DN="o=test", 68 | SERVER_URI="ldap://localhost/" 69 | ) 70 | self.backend.authenticate(username='alice', password='alicepw') 71 | 72 | def test_server_uri_list(self): 73 | self._init_settings( 74 | SEARCH_DN="o=test", 75 | SERVER_URI=["ldap://127.0.0.1", "ldap://localhost/"] 76 | ) 77 | self.backend.authenticate(username='alice', password='alicepw') 78 | 79 | def test_bad_person(self): 80 | self._init_settings( 81 | SEARCH_DN="o=test", 82 | ) 83 | self.assertEqual(User.objects.filter(username="veikko").count(), 0) 84 | self.backend.authenticate(username='veikko', password='alicepw') 85 | self.assertEqual(User.objects.filter(username="veikko").count(), 0) 86 | 87 | # Well this would be nice, but since we dont have bind its not going to hapen 88 | # def test_bad_password(self): 89 | 90 | def test_user_creation(self): 91 | self._init_settings( 92 | SEARCH_DN="o=test", 93 | ) 94 | self.assertEqual(User.objects.filter(username="alice").count(), 0) 95 | self.backend.authenticate(username='alice', password='alicepw') 96 | self.assertEqual(User.objects.filter(username="alice").count(), 1) 97 | self.backend.authenticate(username='alice', password='alicepw') 98 | self.assertEqual(User.objects.filter(username="alice").count(), 1) 99 | 100 | def test_user_properties(self): 101 | self._init_settings( 102 | SEARCH_DN="o=test", 103 | USER_ATTR_MAP={'first_name': 'userPassword'} 104 | ) 105 | self.backend.authenticate(username='alice', password='alicepw') 106 | user_alice = User.objects.get(username="alice") 107 | self.assertEqual(user_alice.first_name, 'alicepw') 108 | 109 | def test_user_flags_000(self): 110 | self._init_settings( 111 | SEARCH_DN="o=test", 112 | USER_FLAGS_BY_GROUP={'is_superuser': 'cn=superuser', 113 | 'is_staff': 'cn=is_staff_not_found'} 114 | ) 115 | 116 | self.backend.authenticate(username='alice', password='alicepw') 117 | user_alice = User.objects.get(username="alice") 118 | self.assertEqual(user_alice.is_superuser, True) 119 | self.assertEqual(user_alice.is_staff, False) 120 | 121 | def test_user_flags_001(self): 122 | self._init_settings( 123 | SEARCH_DN="o=test", 124 | USER_FLAGS_BY_GROUP={ 125 | 'is_superuser': 'cn=superuser,dc=test_not_found', 126 | 'is_staff': 'cn=fake,cn=superuser,ou=foo'}) 127 | 128 | self.backend.authenticate(username='alice', password='alicepw') 129 | user_alice = User.objects.get(username="alice") 130 | self.assertEqual(user_alice.is_superuser, False) 131 | self.assertEqual(user_alice.is_staff, True) 132 | 133 | def test_user_flags_002(self): 134 | self._init_settings( 135 | SEARCH_DN="o=test", 136 | USER_FLAGS_BY_GROUP={ 137 | 'is_superuser': [ 138 | 'cn=superuser,dc=test_not_found', 139 | 'cn=fake,cn=superuser,ou=foo']}) 140 | 141 | self.backend.authenticate(username='alice', password='alicepw') 142 | user_alice = User.objects.get(username="alice") 143 | self.assertEqual(user_alice.is_superuser, True) 144 | 145 | def test_user_groups(self): 146 | group_admin = Group.objects.create(name="MyAdmins") 147 | Group.objects.create(name="MyPonies") 148 | self._init_settings( 149 | SEARCH_DN="o=test", 150 | USER_GROUPS_BY_GROUP={'MyAdmins': 'cn=superuser,dc=test_not_found', 151 | 'MyPonies': 'cn=fake,cn=superuser,ou=foo'} 152 | ) 153 | 154 | self.backend.authenticate(username='alice', password='alicepw') 155 | user_alice = User.objects.get(username="alice") 156 | self.assertEqual(user_alice.groups.filter(name="MyAdmins").count(), 0) 157 | self.assertEqual(user_alice.groups.filter(name="MyPonies").count(), 1) 158 | 159 | # Check also removal 160 | user_alice.groups.add(group_admin) 161 | user_alice.save() 162 | 163 | self.assertEqual(user_alice.groups.filter(name="MyAdmins").count(), 1) 164 | 165 | self.backend.authenticate(username='alice', password='alicepw') 166 | user_alice = User.objects.get(username="alice") 167 | self.assertEqual(user_alice.groups.filter(name="MyAdmins").count(), 0) 168 | self.assertEqual(user_alice.groups.filter(name="MyPonies").count(), 1) 169 | 170 | def test_user_groups_001(self): 171 | """ Test for groups list requirements """ 172 | Group.objects.create(name="MyPonies") 173 | self._init_settings( 174 | SEARCH_DN="o=test", 175 | USER_GROUPS_BY_GROUP={ 176 | 'MyPonies': ( 177 | 'cn=superuser,dc=test_not_found', 178 | 'cn=fake,cn=superuser,ou=foo')}) 179 | self.backend.authenticate(username='alice', password='alicepw') 180 | user_alice = User.objects.get(username="alice") 181 | self.assertEqual(user_alice.groups.filter(name="MyPonies").count(), 1) 182 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | url = "https://github.com/susundberg/django-auth-ldap-ad" 4 | long_description = url 5 | 6 | setup( 7 | name = "django-auth-ldap-ad", 8 | author = "Pauli", 9 | author_email = "susundberg@gmail.com", 10 | description = "Django authentication backend for LDAP with Active Directory", 11 | license = "GPLv2", 12 | url = url, 13 | version = "2.0.0", 14 | packages = ["django_auth_ldap_ad"], 15 | long_description = long_description, 16 | install_requires = ["python-ldap", "Django>=1.4,<=1.9", "six"] 17 | ) 18 | -------------------------------------------------------------------------------- /testing-ci/manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os, sys 3 | 4 | if __name__ == "__main__": 5 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings") 6 | from django.core.management import execute_from_command_line 7 | execute_from_command_line(sys.argv) 8 | 9 | 10 | -------------------------------------------------------------------------------- /testing-ci/requirements.txt: -------------------------------------------------------------------------------- 1 | mockldap 2 | 3 | -------------------------------------------------------------------------------- /testing-ci/settings.py: -------------------------------------------------------------------------------- 1 | DATABASES = { 2 | 'default': { 3 | 'ENGINE': 'django.db.backends.sqlite3', 4 | 'NAME': 'travisdb', 5 | 'USER': '', 6 | 'PASSWORD': '', 7 | 'HOST': 'localhost', 8 | 'PORT': '', 9 | } 10 | } 11 | 12 | INSTALLED_APPS=["django_auth_ldap_ad","django.contrib.auth", "django.contrib.contenttypes"] 13 | DEBUG=True 14 | 15 | SECRET_KEY="92f7zw@-pl+pc2seg=*sfc7hkrx3h-8+jgsfzay#p)9$t(6@@t" 16 | 17 | --------------------------------------------------------------------------------