airflow-ldap-auth-manager 0.1.0__tar.gz

airflow_ldap_auth_manager-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

airflow_ldap_auth_manager-0.1.0/PKG-INFO

@@ -0,0 +1,333 @@
+Metadata-Version: 2.4
+Name: airflow-ldap-auth-manager
+Version: 0.1.0
+Summary: LDAP-based AuthManager for Apache Airflow 3.x
+Author-email: Emre Can <emredjan@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/emredjan/airflow-ldap-auth-manager
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Framework :: Apache Airflow
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: apache-airflow>=3.1.0
+Requires-Dist: ldap3>=2.9
+Requires-Dist: fastapi>=0.110
+Requires-Dist: jinja2>=3.1
+Dynamic: license-file
+
+> [!NOTE]
+> The code in this repository is written with the help of AI (specifically, ChatGPT 5), including this README (lazy, I know). Although I tried my best to streamline and validate most of it, there may still be some intricacies that need to be sorted out.
+
+# Airflow LDAP Auth Manager
+
+A drop-in **Auth Manager** for **Apache Airflow 3.x** that authenticates users against **LDAP/Active Directory** and maps LDAP groups to Airflow roles (**admin / editor / viewer**). It supports redundant LDAP servers, secure transport (LDAPS or StartTLS), and secret indirection for bind credentials via Airflow’s **Secrets Backend** (Variables).
+
+## Features
+
+- **LDAP/AD authentication** using [`ldap3`](https://ldap3.readthedocs.io/)
+- **Group → role mapping** (admin > editor > viewer)
+- **Redundancy & failover** via `ldap3.ServerPool` (ROUND_ROBIN by default)
+- **TLS: LDAPS or StartTLS** (with certificate verification)
+- **Secrets-friendly config:** `bind_dn_secret` and `bind_password_secret` read from Airflow Variables (resolved through your configured secrets backend)
+- **Clean Airflow 3 API:** uses the Airflow SDK (`airflow.sdk.*`)
+- **Simple login UI** with configurable instance name and login tip
+- **Helpful logging:** logs which LDAP server the connection bound to
+
+## To-do
+
+- [x] Extend the user & group search base config items to allow multiple entries (or LDAP `OR` syntax)
+- [x] Package this and upload to pypi
+
+## Requirements
+
+- **Python:** 3.12+
+- **Airflow:** 3.1+ (Auth Manager interface & SDK)
+- **Libraries:** `ldap3`, `fastapi`, `jinja2` (`fastapi` & `jinja2` is likely installed already as Airflow dependencies)
+- **Optional (recommended):** a Secrets Backend (Vault, AWS Secrets Manager, GCP SM, Azure KV) configured for Airflow Variables
+
+## Installation
+
+Install from PyPi into the environment where Airflow is installed:
+
+```shell
+pip install airflow-ldap-auth-manager
+```
+
+
+Or install after cloning the project:
+
+```shell
+git clone <repo url>
+cd airflow-ldap-auth-manager
+pip install .
+```
+
+## Configure Airflow
+
+Changes needed in `airflow.cfg`:
+
+### Enable the Auth Manager
+
+```ini
+[core]
+# Fully qualified path to the auth manager class in this repo
+auth_manager = airflow_ldap_auth_manager.LDAPAuthManager
+```
+
+
+### Make sure JWT settings are configured correctly
+
+```ini
+[api_auth]
+jwt_secret = # Needs to be set
+jwt_algorithm = # Either leave empty, or make sure consistent across all machines
+jwt_audience = # Either leave empty, or make sure consistent across all machines
+jwt_issuer = # Either leave empty, or make sure consistent across all machines
+```
+
+### LDAP settings
+
+Add a section for the LDAP auth manager (adjust to your environment):
+
+```ini
+[ldap_auth_manager]
+server_uri = ldaps://ldap1.example.com:636,ldaps://ldap2.example.com:636
+bind_dn =
+bind_password =
+bind_dn_secret = secret/path/to/airflow/variable/for/bind_dn
+bind_password_secret = path/to/airflow/variable/for/bind_password
+user_search_base = OU=Users,DC=company_name
+user_search_filter = (|(uid={username})(sAMAccountName={username})(mail={username}))
+group_search_base = OU=Groups,DC=company_name
+group_member_attr = member
+admin_groups = airflow-admins
+editor_groups = airflow-editors
+viewer_groups = airflow-viewers,airflow-auditors
+username_attr = uid
+email_attr = mail
+start_tls = false
+verify_ssl = true
+post_login_redirect = /
+logout_redirect = /
+debug_logging = false
+```
+
+Environment variable overrides are supported in the standard Airflow fashion, e.g.:`
+
+`AIRFLOW__LDAP_AUTH_MANAGER__BIND_DN_SECRET=api_server/ldap_auth_manager/bind_dn`
+
+
+### Branding & login hint (optional)
+
+```ini
+[api]
+# Human-friendly name for titles/headers on the login page
+instance_name = Company Airflow
+
+[ldap_auth_manager]
+# Optional helper text shown under "Sign in"
+login_tip = Using your Company credentials
+```
+
+Restart the api-server after changes.
+
+## Configuration reference
+
+``` ini
+[ldap_auth_manager]
+# LDAP authentication/authorization settings for LDAPAuthManager.
+# This section supports multiple redundant servers, secure transport (LDAPS or StartTLS),
+# and secret indirection for bind credentials via Airflow’s Secrets Backend.
+
+# Comma-separated list of LDAP server URIs.
+# - Supports ldap:// and ldaps:// schemes.
+# - When multiple URIs are provided, the manager builds an ldap3 ServerPool with ROUND_ROBIN
+#   strategy for load distribution and failover.
+# - For ldaps://, TLS is implicit from connect; for ldap:// + start_tls=true, StartTLS is
+#   negotiated before bind.
+# - Mixing ldaps:// with start_tls=true is not meaningful; prefer one approach.
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__SERVER_URI
+#
+server_uri = ldaps://ldap1.example.com:636,ldaps://ldap2.example.com:636
+
+# Name of the Airflow Variable that contains the LDAP bind DN (service account).
+# The Variable is resolved through the configured Secrets Backend (e.g. Vault, AWS SM, etc.).
+# If set, any plaintext `bind_dn` value is ignored. Leave empty to attempt anonymous bind.
+# Remember: This needs to be set in the "Airflow/Variables" section in your secret manager,
+# NOT "Airflow/Config"!
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__BIND_DN_SECRET
+#
+bind_dn_secret = secret/path/to/airflow/variable/for/bind_dn
+bind_dn =
+
+# Name of the Airflow Variable that contains the LDAP bind password (service account).
+# The Variable is resolved through the configured Secrets Backend.
+# If set, any plaintext `bind_password` value is ignored.
+# Remember: This needs to be set in the "Airflow/Variables" section in your secret manager,
+# NOT "Airflow/Config"!
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__BIND_PASSWORD_SECRET
+#
+bind_password_secret = path/to/airflow/variable/for/bind_password
+bind_password =
+
+# Base DN under which user entries are searched.
+# Example (Active Directory): OU=Users,OU=Country,DC=example,DC=com
+# Supports multiple base DNs, separated by newlines, semicolons, or as a JSON array.
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__USER_SEARCH_BASE
+#
+user_search_base = OU=Users,DC=company_name
+
+# LDAP filter template to locate the authenticating user.
+# The literal "{username}" placeholder is replaced with the submitted login identifier.
+# Must be a valid RFC 4515 filter. The username value is safely escaped before substitution.
+# Example: (|(uid={username})(sAMAccountName={username})(mail={username}))
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__USER_SEARCH_FILTER
+#
+user_search_filter = (|(uid={username})(sAMAccountName={username})(mail={username}))
+
+# Base DN under which group entries are searched for authorization.
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__GROUP_SEARCH_BASE
+#
+group_search_base = OU=Groups,DC=company_name
+
+# The group attribute that lists membership (DNs of user entries).
+# Common values:
+#   - Active Directory: member
+#   - RFC2307/posix groups: memberUid (then matching is by username instead of DN)
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__GROUP_MEMBER_ATTR
+#
+group_member_attr = member
+
+# Comma-separated list of groups that grant the Airflow "admin" role.
+# Values can be group CNs or full DNs under group_search_base (matching is case-insensitive).
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__ADMIN_GROUPS
+#
+admin_groups = airflow-admins
+
+
+# Comma-separated list of groups that grant the Airflow "editor" role.
+# Leave empty to disable this mapping.
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__EDITOR_GROUPS
+#
+editor_groups = airflow-editors
+
+# Comma-separated list of groups that grant the Airflow "viewer" role.
+# Users are mapped to the highest role matched (admin > editor > viewer).
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__VIEWER_GROUPS
+#
+viewer_groups = airflow-viewers,airflow-auditors
+
+# Attribute on the user entry to use as the Airflow username.
+# Typical values: uid, sAMAccountName, userPrincipalName
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__USERNAME_ATTR
+#
+username_attr = uid
+
+# Attribute on the user entry that contains the email address.
+# Typical values: mail, userPrincipalName
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__EMAIL_ATTR
+#
+email_attr = mail
+
+# Whether to perform StartTLS on ldap:// connections before bind.
+# - true  : Use StartTLS (only applies to ldap:// URIs).
+# - false : Do not use StartTLS. For ldaps:// URIs, TLS is already implicit.
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__START_TLS
+#
+start_tls = false
+
+# Whether to verify the server certificate for TLS (ldaps or StartTLS).
+# Set to true in production with a valid trust store. Set to false only for testing.
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__VERIFY_SSL
+#
+verify_ssl = true
+
+# Path (relative to the Airflow web root) to redirect a user after successful login.
+# Example: "/" or "/home"
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__POST_LOGIN_REDIRECT
+#
+post_login_redirect = /
+
+# Path (relative to the Airflow web root) to redirect a user after logout.
+# Example: "/" or "/login"
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__LOGOUT_REDIRECT
+#
+logout_redirect = /
+
+# Enable debug logging for LDAP operations.
+# This can be useful to troubleshoot LDAP issues, but beware that it may log
+# sensitive information such as usernames and group names.
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__DEBUG_LOGGING
+#
+debug_logging = false
+
+# Optional login hint shown under "Sign in". Leave empty to hide.
+#
+# Variable: AIRFLOW__LDAP_AUTH_MANAGER__LOGIN_TIP
+#
+login_tip = Using your Company credentials
+```
+
+
+## UI & templates
+
+- Login template: `ldap_login.html`
+- Static assets are served under `/auth/static/` (e.g. `/auth/static/style.css`, `/auth/static/airflow.svg`)
+- Form posts to `/auth/token`
+
+If you see 404 Not Found for `/auth/static/...`, ensure the StaticFiles mount path in your FastAPI router matches the URLs used in the template.
+
+## Logging & diagnostics
+
+If `debug_logging = true` in config:
+
+After successful bind, the manager logs which LDAP server was selected from the pool, e.g.:
+
+```log
+LDAP bound to ldaps://ldap2.example.com:636 (pool_strategy=ROUND_ROBIN, start_tls=False)
+```
+Optionally, it can log the authenticated identity via the LDAP `whoami` extended operation.
+
+## Security notes
+
+- **Choose one TLS mode:** either `ldaps://...` or `ldap://` with `start_tls=true`. Mixing them is discouraged.
+- Keep `verify_ssl = true` in production and ensure your trust store contains the issuing CA(s).
+- Bind credentials should preferrably be supplied via `*_secret` indirection (Variables → Secrets Backend), not plaintext.
+
+## Troubleshooting
+
+- **Can’t bind / invalid credentials:** test with `ldapsearch` using the same DN/password and base/filter.
+- **User not found:** verify `user_search_base` and `user_search_filter` (remember `{username}` substitution).
+- **Group mapping not applied:** confirm `group_search_base`, `group_member_attr`, and that your groups are in the configured bases.
+- **TLS errors:** verify certificates and CA chain; ensure the hostname matches the server certificate CN/SAN.
+- **Static assets 404:** check the FastAPI `StaticFiles` mount matches `/auth/static`.
+
+## Contributing
+
+Issues and PRs are welcome. Please include:
+
+- A clear description of the problem or feature
+- Repro steps or tests when possible
+- Your Airflow, Python, and LDAP server versions