charmlibs-interfaces-ldap 1.0.0__tar.gz

charmlibs_interfaces_ldap-1.0.0/.gitignore

@@ -0,0 +1,187 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+cos-tool*
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.coverage-*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+.report/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# PyPI configuration file
+.pypirc
+
+# packed charms
+.packed
+
+# temporary directory for packing charms
+.tmp
+
+# uv.lock from example libraries as we don't commit these
+.example/**/uv.lock
+.tutorial/**/uv.lock
+interfaces/.example/**/uv.lock
+
+# Workshop lock file (machine-local state)
+.workshop.lock

charmlibs_interfaces_ldap-1.0.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+Initial release. Migrated from `charms.glauth_k8s.v0.ldap` (v0.13).

charmlibs_interfaces_ldap-1.0.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: charmlibs-interfaces-ldap
+Version: 1.0.0
+Summary: The charmlibs.interfaces.ldap package.
+Project-URL: Documentation, https://canonical.com/juju/docs/charmlibs/reference/charmlibs/interfaces/ldap
+Project-URL: Repository, https://github.com/canonical/charmlibs/tree/main/interfaces/ldap
+Project-URL: Issues, https://github.com/canonical/charmlibs/issues
+Project-URL: Changelog, https://github.com/canonical/charmlibs/blob/main/interfaces/ldap/CHANGELOG.md
+Author: Identity Team at Canonical
+License-Expression: Apache-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: ops<4,>=2.23.1
+Requires-Dist: pydantic>=2.13.4
+Description-Content-Type: text/markdown
+
+# charmlibs.interfaces.ldap
+
+The `ldap` interface library.
+
+To install, add `charmlibs-interfaces-ldap` to your Python dependencies. Then in your Python code, import as:
+
+```py
+from charmlibs.interfaces import ldap
+```
+
+See the [reference documentation](https://canonical.com/juju/docs/charmlibs/reference/charmlibs/interfaces/ldap) for more.

charmlibs_interfaces_ldap-1.0.0/README.md

@@ -0,0 +1,11 @@
+# charmlibs.interfaces.ldap
+
+The `ldap` interface library.
+
+To install, add `charmlibs-interfaces-ldap` to your Python dependencies. Then in your Python code, import as:
+
+```py
+from charmlibs.interfaces import ldap
+```
+
+See the [reference documentation](https://canonical.com/juju/docs/charmlibs/reference/charmlibs/interfaces/ldap) for more.

charmlibs_interfaces_ldap-1.0.0/interface/v0/README.md

@@ -0,0 +1,93 @@
+# `ldap/v0`
+
+## Usage
+
+This relation interface describes the expected behavior of any charm claiming to
+be able to provide or consume the LDAP authentication configuration data.
+
+## Glossary of LDAP Terms
+
+| Abbreviation |            Term            |
+|:------------:|:--------------------------:|
+|      DN      |     Distinguished Name     |
+|     DIT      | Directory Information Tree |
+
+## Direction
+
+```mermaid
+flowchart TD
+    Requirer -- user, \ngroup --> Provider
+    Provider -- urls, \nbase_dn, \nbind_dn, \nbind_password_secret, \nauth_method, \nstarttls --> Requirer
+```
+
+## Behavior
+
+Both the `provider` and the `requirer` need to adhere to a certain set of
+criteria to be considered compatible with the `ldap` interface.
+
+Sensitive information is transmitted through Juju Secrets rather than directly
+through the relation databag(s).
+
+### Provider
+
+- Is expected to use `user` and `group` provided by the `requirer` to create a
+  bind DN in the DIT for the `requirer` to use for the `bind` operation. If
+  the `requirer` does not provide `user` and `group`, the `provider`
+  leverages `requirer`'s Juju application name and model name.
+- Is expected to provide the `requirer` with necessary configuration for
+  performing LDAP authentications and operations.
+- Is expected to update the application databag if any field's data is changed
+  in the `provider` charmed application.
+
+### Requirer
+
+- Is expected to optionally provide `user` and `group` for the `provider` to
+  generate the bind DN.
+- Is expected to consume the LDAP configuration data provided by the `provider`
+  to configure the `requirer`'s charmed application.
+
+> #### ⚠️ Use of special characters
+> Try to avoid the special characters
+> listed [here](https://datatracker.ietf.org/doc/html/rfc2253#section-2.4)
+> for the `user` and `group` in the `requirer`'s databag.
+
+## Relation Data
+
+[\[Pydantic Schema\]](./schema.py)
+
+### Provider
+
+The `provider` provides LDAP URL, base DN, and bind DN, and LDAP
+authentication method for the `requirer` to connect and perform LDAP operations.
+It should be placed in the **application** databag.
+
+#### Example
+
+```yaml
+  relation-info:
+    - endpoint: ldap
+      related-endpoint: ldap
+      application-data:
+        urls: [ldap://ldap.canonical.com:3893, ldap://ldap.ubuntu.com:3893]
+        base_dn: dc=canonical,dc=com
+        bind_dn: cn=app,ou=model,dc=canonical,dc=com
+        bind_password_secret: secret://59060ecc-0495-4a80-8006-5f1fc13fd783/cjqub6vubg2s77p3nio0
+        auth_method: simple
+        starttls: true
+``````
+
+### Requirer
+
+The `requirer` provides LDAP client information. It should be placed in the
+**application** databag.
+
+#### Example
+
+```yaml
+  relation-info:
+    - endpoint: ldap
+      related-endpoint: ldap
+      application-data:
+        user: sssd
+        group: machine-localhost
+```

charmlibs_interfaces_ldap-1.0.0/interface/v0/interface.yaml

@@ -0,0 +1,19 @@
+name: ldap
+version: 0
+status: draft
+lib: charmlibs.interfaces.ldap
+summary: Configure and connect to a Lightweight Directory Access Protocol (LDAP) server.
+description: |
+  The `ldap` interface supports sharing configuration and connection information for a Lightweight Directory Access Protocol (LDAP) server.
+  The provider is responsible for sharing the LDAP URL and other information needed for the requirer to connect and perform LDAP operations.
+
+providers:
+  - name: glauth-k8s
+    url: https://github.com/canonical/glauth-k8s-operator
+  - name: authentik-ldap-outpost
+    url: https://github.com/canonical/authentik-ldap-outpost-operator
+requirers:
+  - name: sssd
+    url: https://github.com/canonical/sssd-operator
+
+maintainer: identity

charmlibs_interfaces_ldap-1.0.0/interface/v0/schema.py

@@ -0,0 +1,72 @@
+# Copyright 2026 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+"""LDAP relation schema definitions.
+
+This file defines the schemas for the provider and requirer sides of this
+relation interface.
+
+It must expose two interfaces.schema_base.DataBagSchema subclasses called:
+- ProviderSchema
+- RequirerSchema
+"""
+
+from interface_tester.schema_base import DataBagSchema
+from pydantic import AnyUrl, BaseModel, Field
+
+
+class LdapProviderData(BaseModel):
+    """LDAP provider relation data schema."""
+
+    urls: list[AnyUrl] = Field(
+        description='List of LDAP URLs',
+        title='LDAP URLs',
+        example=['ldap://ldap.canonical.com:3893', 'ldap://ldap.ubuntu.com:3893'],
+    )
+    base_dn: str = Field(
+        description='The base entry as the starting point for LDAP search operation',
+        title='Base DN',
+        example='dc=canonical,dc=com',
+    )
+    bind_dn: str = Field(
+        description='The distinguished name (DN) of the bind account',
+        title='Bind DN',
+        example='cn=admin,ou=engineering,dc=canonical,dc=com',
+    )
+    bind_password_secret: str = Field(
+        description="The juju secret ID of the bind account's password",
+        example='secret://59060ecc-0495-4a80-8006-5f1fc13fd783/cjqub6vubg2s77p3nio0',
+    )
+    auth_method: str = Field(
+        description='The LDAP authentication method',
+        title='Authentication Method',
+        example='simple',
+    )
+    starttls: bool = Field(
+        description='The indicator of StartTLS operation enabled or not',
+        title='StartTLS',
+        example=True,
+    )
+
+
+class LdapRequirerData(BaseModel):
+    """LDAP requirer relation data schema."""
+
+    user: str | None = Field(
+        description='The user name provided by the requirer charmed operator',
+    )
+    group: str | None = Field(
+        description='The group name provided by the requirer charmed operator',
+    )
+
+
+class ProviderSchema(DataBagSchema):
+    """The schema for the provider side of the ldap interface."""
+
+    app: LdapProviderData
+
+
+class RequirerSchema(DataBagSchema):
+    """The schema for the requirer side of the ldap interface."""
+
+    app: LdapRequirerData

charmlibs_interfaces_ldap-1.0.0/pyproject.toml

@@ -0,0 +1,100 @@
+[project]
+name = "charmlibs-interfaces-ldap"
+description = "The charmlibs.interfaces.ldap package."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+    {name="Identity Team at Canonical"},
+]
+license = "Apache-2.0"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Intended Audience :: Developers",
+    "Operating System :: POSIX :: Linux",
+    "Development Status :: 5 - Production/Stable",
+]
+dynamic = ["version"]
+dependencies = [
+    # Libraries should use clear but wide dependency bounds to avoid overly constraining charms.
+    # Ops 3 is backwards compatible with Ops 2, but drops Python 3.8 support.
+    # Ops 3 has new features not present in Ops 2.23 (the last Ops 2 feature release).
+    # See the Ops 2.23 maintenance branch changelog and the Ops 3 changelog for current information:
+    # - https://github.com/canonical/operator/blob/2.23-maintenance/CHANGES.md
+    # - https://github.com/canonical/operator/blob/main/CHANGES.md
+    # Set the dependency bounds according to the features and fixes your library needs.
+    "ops>=2.23.1,<4",
+    "pydantic>=2.13.4",
+]
+
+[dependency-groups]
+lint = [  # installed for `just lint interfaces/ldap` (unit, functional, and integration are also installed)
+    # "typing_extensions",
+]
+unit = [  # installed for `just unit interfaces/ldap`
+    "ops[testing]",
+    "charmlibs-interfaces-ldap",
+]
+functional = [  # installed for `just functional interfaces/ldap`
+]
+integration = [  # installed for `just integration interfaces/ldap`
+    "jubilant",
+]
+
+[project.urls]
+"Documentation" = "https://canonical.com/juju/docs/charmlibs/reference/charmlibs/interfaces/ldap"
+"Repository" = "https://github.com/canonical/charmlibs/tree/main/interfaces/ldap"
+"Issues" = "https://github.com/canonical/charmlibs/issues"
+"Changelog" = "https://github.com/canonical/charmlibs/blob/main/interfaces/ldap/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/charmlibs"]
+
+[tool.hatch.version]
+path = "src/charmlibs/interfaces/ldap/_version.py"
+
+[tool.uv.sources]
+
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+src = ["src", "tests/unit", "tests/functional", "tests/integration"]  # correctly sort local imports in tests
+
+[tool.ruff.lint.extend-per-file-ignores]
+# add additional per-file-ignores here to avoid overriding repo-level config
+"tests/**/*" = [
+    # "E501",  # line too long
+]
+
+[tool.pyright]
+extends = "../../pyproject.toml"
+include = ["src", "tests"]
+pythonVersion = "3.10"  # check no python > 3.10 features are used
+reportUntypedFunctionDecorator = false
+reportCallIssue = false
+reportUnknownVariableType = false
+reportIncompatibleMethodOverride = false
+reportAssignmentType = false
+reportUnknownMemberType = false
+reportUnknownArgumentType = false
+reportUnknownParameterType = false
+reportMissingTypeArgument = false
+reportDeprecated = false
+reportUnnecessaryTypeIgnoreComment = false
+reportUnnecessaryComparison = false
+reportArgumentType = false
+reportReturnType = false
+reportGeneralTypeIssues = false
+
+[tool.charmlibs.functional]
+ubuntu = []  # ubuntu versions to run functional tests with, e.g. "24.04" (defaults to just "latest")
+pebble = []  # pebble versions to run functional tests with, e.g. "v1.0.0", "master" (defaults to no pebble versions)
+sudo = false  # whether to run functional tests with sudo (defaults to false)
+
+[tool.charmlibs.integration]
+# tags to run integration tests with (defaults to running once with no tag, i.e. tags = [''])
+# Available in CI in tests/integration/pack.sh and integration tests as CHARMLIBS_TAG
+tags = []  # Not used by the pack.sh and integration tests generated by the template

charmlibs_interfaces_ldap-1.0.0/src/charmlibs/interfaces/ldap/__init__.py

@@ -0,0 +1,158 @@
+# Copyright 2026 Canonical Ltd.
+#
+# 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.
+
+"""The charmlibs.interfaces.ldap package.
+
+Juju Charm Library for the `ldap` Juju Interface
+================================================
+
+This Juju charm library contains the Provider and Requirer classes for handling
+the ``ldap`` interface.
+
+Requirer Charm
+--------------
+
+The requirer charm is expected to:
+
+- Provide information for the provider charm to deliver LDAP related
+  information in the juju integration, in order to communicate with the LDAP
+  server and authenticate LDAP operations
+- Listen to the custom juju event ``LdapReadyEvent`` to obtain the LDAP
+  related information from the integration
+- Listen to the custom juju event ``LdapUnavailableEvent`` to handle the
+  situation when the LDAP integration is broken
+
+.. code-block:: python
+
+    from charmlibs.interfaces.ldap import (
+        LdapRequirer,
+        LdapReadyEvent,
+        LdapUnavailableEvent,
+    )
+
+    class RequirerCharm(CharmBase):
+        # LDAP requirer charm that integrates with an LDAP provider charm.
+
+        def __init__(self, *args):
+            super().__init__(*args)
+
+            self.ldap_requirer = LdapRequirer(self)
+            self.framework.observe(
+                self.ldap_requirer.on.ldap_ready,
+                self._on_ldap_ready,
+            )
+            self.framework.observe(
+                self.ldap_requirer.on.ldap_unavailable,
+                self._on_ldap_unavailable,
+            )
+
+        def _on_ldap_ready(self, event: LdapReadyEvent) -> None:
+            # Consume the LDAP related information
+            ldap_data = self.ldap_requirer.consume_ldap_relation_data(
+                relation=event.relation,
+            )
+
+            # Configure the LDAP requirer charm
+            ...
+
+        def _on_ldap_unavailable(self, event: LdapUnavailableEvent) -> None:
+            # Handle the situation where the LDAP integration is broken
+            ...
+
+As shown above, the library offers custom juju events to handle specific
+situations, which are listed below:
+
+- ``ldap_ready``: event emitted when the LDAP related information is ready for
+  requirer charm to use.
+- ``ldap_unavailable``: event emitted when the LDAP integration is broken.
+
+Additionally, the requirer charmed operator needs to declare the ``ldap``
+interface in the ``metadata.yaml``:
+
+.. code-block:: yaml
+
+    requires:
+      ldap:
+        interface: ldap
+
+Provider Charm
+--------------
+
+The provider charm is expected to:
+
+- Use the information provided by the requirer charm to provide LDAP related
+  information for the requirer charm to connect and authenticate to the LDAP
+  server
+- Listen to the custom juju event ``LdapRequestedEvent`` to offer LDAP related
+  information in the integration
+
+.. code-block:: python
+
+    from charmlibs.interfaces.ldap import (
+        LdapProvider,
+        LdapRequestedEvent,
+    )
+
+    class ProviderCharm(CharmBase):
+        # LDAP provider charm.
+
+        def __init__(self, *args):
+            super().__init__(*args)
+
+            self.ldap_provider = LdapProvider(self)
+            self.framework.observe(
+                self.ldap_provider.on.ldap_requested,
+                self._on_ldap_requested,
+            )
+
+        def _on_ldap_requested(self, event: LdapRequestedEvent) -> None:
+            # Consume the information provided by the requirer charm
+            requirer_data = event.data
+
+            # Prepare the LDAP related information using the requirer's data
+            ldap_data = ...
+
+            # Update the integration data
+            self.ldap_provider.update_relations_app_data(
+                relation.id,
+                ldap_data,
+            )
+
+As shown above, the library offers custom juju events to handle specific
+situations, which are listed below:
+
+- ``ldap_requested``: event emitted when the requirer charm is requesting the
+  LDAP related information in order to connect and authenticate to the LDAP server.
+"""
+
+from ._ldap import (
+    LdapProvider,
+    LdapProviderData,
+    LdapReadyEvent,
+    LdapRequestedEvent,
+    LdapRequirer,
+    LdapRequirerData,
+    LdapUnavailableEvent,
+)
+from ._version import __version__ as __version__
+
+__all__ = [
+    'LdapProvider',
+    'LdapProviderData',
+    'LdapReadyEvent',
+    'LdapRequestedEvent',
+    'LdapRequirer',
+    'LdapRequirerData',
+    'LdapUnavailableEvent',
+]