{ "info": { "author": "Chad Killingsworth , Barron Hagerman ", "author_email": "chad.killingsworth@banno.com", "bugtrack_url": null, "classifiers": [ "Framework :: Django", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "Operating System :: OS Independent", "Topic :: Software Development" ], "description": "# sentry-ldap-auth\n\nA Django custom authentication backend for [Sentry](https://github.com/getsentry/sentry). This module extends the functionality of [django-auth-ldap](https://github.com/django-auth-ldap/django-auth-ldap) with Sentry specific features.\n\n## Features\n* Users created by this backend are managed users. Managed fields are not editable through the Sentry account page.\n* Users may be auto-added to an Organization upon creation.\n\n## Prerequisites\nVersions 2.0 and newer require Sentry 8. For Sentry 7 support, use [the 1.1 release](https://github.com/Banno/getsentry-ldap-auth/releases/tag/1.1)\n\n## Installation\nTo install, simply add `sentry-ldap-auth` to your *requirements.txt* for your Sentry environment (or `pip install sentry-ldap-auth`).\n\n## Configuration\nThis module extends the [django-auth-ldap](https://django-auth-ldap.readthedocs.io/en/latest/) and all the options it provides are supported (up to v1.2.x, at least). \n\nTo configure Sentry to use this module, add `sentry_ldap_auth.backend.SentryLdapBackend` to your `AUTHENTICATION_BACKENDS` in your *sentry.conf.py*, like this:\n\n```python\nAUTHENTICATION_BACKENDS = AUTHENTICATION_BACKENDS + (\n 'sentry_ldap_auth.backend.SentryLdapBackend',\n)\n```\n\nThen, add any applicable configuration options. Depending on your environment, and especially if you are running Sentry in containers, you might consider using [python-decouple](https://pypi.python.org/pypi/python-decouple) so you can set these options via environment variables.\n\n### sentry-ldap-auth Specific Options\n\n```Python\nAUTH_LDAP_DEFAULT_SENTRY_ORGANIZATION = u'My Organization Name'\n```\nAuto adds created user to the specified organization (matched by name) if it exists.\n\n```Python\nAUTH_LDAP_SENTRY_ORGANIZATION_ROLE_TYPE = 'member'\n```\nRole type auto-added users are assigned. Valid values in a default installation of Sentry are 'member', 'admin', 'manager' & 'owner'. However, custom roles can also be added to Sentry, in which case these are also valid.\n\n```Python\nAUTH_LDAP_SENTRY_ORGANIZATION_GLOBAL_ACCESS = True\n```\nWhether auto-created users should be granted global access within the default organization.\n\n```Python\nAUTH_LDAP_SENTRY_SUBSCRIBE_BY_DEFAULT = False\n```\nWhether new users should be subscribed to any new projects by default. Disabling\nthis is useful for large organizations where a subscription to each project\nmight be spammy.\n\n```Python\nAUTH_LDAP_SENTRY_USERNAME_FIELD = 'uid'\n```\nSpecify which attribute to use as the Sentry username, if different from what the user enters on the login page. You can use this to prevent multiple accounts from being created when your `AUTH_LDAP_USER_SEARCH` allows users to log in with different usernames (e.g. `(|(uid=%(user))(mail=%(user)))`). If multiple values exist for the attribute, the first value will be used.\n\n```Python\nAUTH_LDAP_DEFAULT_EMAIL_DOMAIN = 'example.com'\n```\nDefault domain to append to username as the Sentry user's e-mail address when the LDAP user has no `mail` attribute.\n\n### Sentry Options\n\n```Python\nSENTRY_MANAGED_USER_FIELDS = ('email', 'first_name', 'last_name', 'password', )\n```\n\nFields which managed users may not modify through the Sentry accounts view. Applies to all managed accounts.\n\n### Example Configuration\n\n```Python\nimport ldap\nfrom django_auth_ldap.config import LDAPSearch, GroupOfUniqueNamesType\n\nAUTH_LDAP_SERVER_URI = 'ldap://my.ldapserver.com'\nAUTH_LDAP_BIND_DN = ''\nAUTH_LDAP_BIND_PASSWORD = ''\n\nAUTH_LDAP_USER_SEARCH = LDAPSearch(\n 'dc=domain,dc=com',\n ldap.SCOPE_SUBTREE,\n '(mail=%(user)s)',\n)\n\nAUTH_LDAP_GROUP_SEARCH = LDAPSearch(\n '',\n ldap.SCOPE_SUBTREE,\n '(objectClass=groupOfUniqueNames)'\n)\n\nAUTH_LDAP_GROUP_TYPE = GroupOfUniqueNamesType()\nAUTH_LDAP_REQUIRE_GROUP = None\nAUTH_LDAP_DENY_GROUP = None\n\nAUTH_LDAP_USER_ATTR_MAP = {\n 'name': 'cn',\n 'email': 'mail'\n}\n\nAUTH_LDAP_FIND_GROUP_PERMS = False\nAUTH_LDAP_CACHE_GROUPS = True\nAUTH_LDAP_GROUP_CACHE_TIMEOUT = 3600\n\nAUTH_LDAP_DEFAULT_SENTRY_ORGANIZATION = u'My Organization Name'\nAUTH_LDAP_SENTRY_ORGANIZATION_ROLE_TYPE = 'member'\nAUTH_LDAP_SENTRY_GROUP_ROLE_MAPPING = {\n 'owner': ['sysadmins'],\n 'admin': ['devleads'],\n 'member': ['developers', 'seniordevelopers']\n}\nAUTH_LDAP_SENTRY_ORGANIZATION_GLOBAL_ACCESS = True\nAUTH_LDAP_SENTRY_USERNAME_FIELD = 'uid'\n\nAUTHENTICATION_BACKENDS = AUTHENTICATION_BACKENDS + (\n 'sentry_ldap_auth.backend.SentryLdapBackend',\n)\n\nimport logging\nlogger = logging.getLogger('django_auth_ldap')\nlogger.addHandler(logging.StreamHandler())\nlogger.setLevel('DEBUG')\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/banno/getsentry-ldap-auth/tarball/2.8", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/banno/getsentry-ldap-auth", "keywords": "", "license": "Apache-2.0", "maintainer": "", "maintainer_email": "", "name": "sentry-ldap-auth", "package_url": "https://pypi.org/project/sentry-ldap-auth/", "platform": "", "project_url": "https://pypi.org/project/sentry-ldap-auth/", "project_urls": { "Download": "https://github.com/banno/getsentry-ldap-auth/tarball/2.8", "Homepage": "http://github.com/banno/getsentry-ldap-auth" }, "release_url": "https://pypi.org/project/sentry-ldap-auth/2.8/", "requires_dist": [ "django-auth-ldap (==1.2.*)", "sentry (>=8.0.0)" ], "requires_python": "", "summary": "A Sentry extension to add an LDAP server as an authentication source.", "version": "2.8" }, "last_serial": 5908978, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "2872e807a5c317ad26be5ce39d4a9441", "sha256": "f6ce51d9a7bac1bc899b15c72befdf6d5740ec982c80c55245b5ae2d493ddf5b" }, "downloads": -1, "filename": "sentry-ldap-auth-1.0.tar.gz", "has_sig": false, "md5_digest": "2872e807a5c317ad26be5ce39d4a9441", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1964, "upload_time": "2015-04-15T21:00:53", "url": "https://files.pythonhosted.org/packages/97/35/d3e761940342271da469c2e23c07038b72483f97361e5eaf9799768894e7/sentry-ldap-auth-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "f2cdc576b3a10d8e41bfec90bb07a1a4", "sha256": "49af20071124d2dc618e89022b28002460d5d19d58a52d2ab9cd44ed0bef3451" }, "downloads": -1, "filename": "sentry-ldap-auth-1.1.tar.gz", "has_sig": false, "md5_digest": "f2cdc576b3a10d8e41bfec90bb07a1a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2129, "upload_time": "2015-12-01T13:29:11", "url": "https://files.pythonhosted.org/packages/27/12/67cb27f1034cec5bd681de26c022c0b4535c2d4d8a7e612babaea31bb384/sentry-ldap-auth-1.1.tar.gz" } ], "2.0": [ { "comment_text": "", "digests": { "md5": "a869446cb1dc40a2696ec66528daa169", "sha256": "c995612ec1c19a9f4dfa5af971d8e1858784b6648b3d0fd80ab9f464d62ab96c" }, "downloads": -1, "filename": "sentry-ldap-auth-2.0.tar.gz", "has_sig": false, "md5_digest": "a869446cb1dc40a2696ec66528daa169", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2089, "upload_time": "2015-12-17T13:05:35", "url": "https://files.pythonhosted.org/packages/23/0f/d52594c1ec34a0e6bd222cba04690923020462b3910f85b8dd512934f55b/sentry-ldap-auth-2.0.tar.gz" } ], "2.1": [ { "comment_text": "", "digests": { "md5": "e0eaead7ac5ecf5ea8c4a4d77118d87e", "sha256": "c54e5832e9d8f74859de746da44e8515d2e83ce06867519ef702f148e2ce62da" }, "downloads": -1, "filename": "sentry-ldap-auth-2.1.tar.gz", "has_sig": false, "md5_digest": "e0eaead7ac5ecf5ea8c4a4d77118d87e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2036, "upload_time": "2016-07-18T18:44:00", "url": "https://files.pythonhosted.org/packages/cd/f6/45a88e6ead06eb4fd83cae66a25239cf7702ed44260b8f9f1d0c578b90bd/sentry-ldap-auth-2.1.tar.gz" } ], "2.2": [ { "comment_text": "", "digests": { "md5": "763a20548ae9a2f77ab602b341cf28ed", "sha256": "b0ce9f429289c9adccff834ef0fae47e3250f2234ce1fa0156e3534ca9db2e90" }, "downloads": -1, "filename": "sentry-ldap-auth-2.2.tar.gz", "has_sig": false, "md5_digest": "763a20548ae9a2f77ab602b341cf28ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2112, "upload_time": "2016-09-27T21:28:36", "url": "https://files.pythonhosted.org/packages/59/55/54e5ab1f0d8b7a5b9e642365ecd6ac8c0d4eaa2470036118aaa016a9be4c/sentry-ldap-auth-2.2.tar.gz" } ], "2.3": [ { "comment_text": "", "digests": { "md5": "7c25d79aca718fe2a57049f03a538915", "sha256": "b6aa6414fe64420984f24230b12ab32f3cafc794044708cb57b9d5cd24da1927" }, "downloads": -1, "filename": "sentry-ldap-auth-2.3.tar.gz", "has_sig": false, "md5_digest": "7c25d79aca718fe2a57049f03a538915", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2133, "upload_time": "2016-10-05T20:59:53", "url": "https://files.pythonhosted.org/packages/1f/f1/446645030a1642393932f6301e8bbbde20e70235dbae960aee9ed2e82316/sentry-ldap-auth-2.3.tar.gz" } ], "2.4": [ { "comment_text": "", "digests": { "md5": "ee988ae9d93fc4fef1e9138dab5340ad", "sha256": "e3b5ba52b268609a290bf07980c1265b335650e031c09fcf50e89039922d5300" }, "downloads": -1, "filename": "sentry-ldap-auth-2.4.tar.gz", "has_sig": false, "md5_digest": "ee988ae9d93fc4fef1e9138dab5340ad", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2193, "upload_time": "2017-03-24T21:14:52", "url": "https://files.pythonhosted.org/packages/45/f5/5a9e9ea6c424f3db2f7f8ec26e6c5ab2e180d0c91ad9c66ca7cdb9ed59bf/sentry-ldap-auth-2.4.tar.gz" } ], "2.5": [ { "comment_text": "", "digests": { "md5": "d0e8c42562c9d1a17c9462e20b84edef", "sha256": "f091069f344e4640ee5a10b573fd283ebae3bf3720fada0962653a4a9b3164e6" }, "downloads": -1, "filename": "sentry-ldap-auth-2.5.tar.gz", "has_sig": false, "md5_digest": "d0e8c42562c9d1a17c9462e20b84edef", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2191, "upload_time": "2017-12-04T22:27:12", "url": "https://files.pythonhosted.org/packages/e8/61/24712ca066ce3c58fa0d32cc264e9ddefa6425c83f331d81eb37cfdb6c88/sentry-ldap-auth-2.5.tar.gz" } ], "2.6": [ { "comment_text": "", "digests": { "md5": "fe3976dba2f7f21d2bc87089ebc383e7", "sha256": "dca911eef97ef2adab08ea149ff15147b5948b5ca4ab3141f7130f97d2d41546" }, "downloads": -1, "filename": "sentry-ldap-auth-2.6.tar.gz", "has_sig": false, "md5_digest": "fe3976dba2f7f21d2bc87089ebc383e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2309, "upload_time": "2018-04-20T20:38:07", "url": "https://files.pythonhosted.org/packages/32/bc/b50c80ddd6567f791ff1740013a5077d98a70ec1ec00fa33d2e9186889ee/sentry-ldap-auth-2.6.tar.gz" } ], "2.7": [ { "comment_text": "", "digests": { "md5": "ec3446e0e0cde43f9a30992738dbbea0", "sha256": "befb9ceff029543be4fdcb5e8dfcd2bc31732b00eb09ca97d59ac455ced5e6f5" }, "downloads": -1, "filename": "sentry-ldap-auth-2.7.tar.gz", "has_sig": false, "md5_digest": "ec3446e0e0cde43f9a30992738dbbea0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2357, "upload_time": "2018-04-23T15:53:42", "url": "https://files.pythonhosted.org/packages/bd/33/f233cfda4912a31991acfbc6deed11ccb1c824f8b1b8fdbf1006dd45b7c9/sentry-ldap-auth-2.7.tar.gz" } ], "2.8": [ { "comment_text": "", "digests": { "md5": "9de4060cdbf4bfb04511fc7e17f9bb5e", "sha256": "0d486f3f914fdeb62817c5263538d1ec833b8cff0fd50f630fb1da0cb1cfdeec" }, "downloads": -1, "filename": "sentry-ldap-auth-2.8.tar.gz", "has_sig": false, "md5_digest": "9de4060cdbf4bfb04511fc7e17f9bb5e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4736, "upload_time": "2019-09-30T21:00:29", "url": "https://files.pythonhosted.org/packages/88/d0/b34f5eace815fa5e5e4eaca07b72478642eb1f31181859391d3d0c0f7fa8/sentry-ldap-auth-2.8.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9de4060cdbf4bfb04511fc7e17f9bb5e", "sha256": "0d486f3f914fdeb62817c5263538d1ec833b8cff0fd50f630fb1da0cb1cfdeec" }, "downloads": -1, "filename": "sentry-ldap-auth-2.8.tar.gz", "has_sig": false, "md5_digest": "9de4060cdbf4bfb04511fc7e17f9bb5e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4736, "upload_time": "2019-09-30T21:00:29", "url": "https://files.pythonhosted.org/packages/88/d0/b34f5eace815fa5e5e4eaca07b72478642eb1f31181859391d3d0c0f7fa8/sentry-ldap-auth-2.8.tar.gz" } ] }