freeiam 0.1.0__tar.gz

freeiam-0.1.0/CHANGELOG.md

@@ -0,0 +1,15 @@
+# CHANGELOG
+
+<!-- version list -->
+
+## v0.1.0 (2025-08-03)
+
+### Documentation
+
+- **ldap**: Add API docs and usage examples
+  ([`dfbcbe4`](https://github.com/Free-IAM/freeiam/commit/dfbcbe40fb8ba95828e9dd095e8b88c3dff4a82c))
+
+### Features
+
+- **ldap**: Implement LDAP library
+  ([`9413a8b`](https://github.com/Free-IAM/freeiam/commit/9413a8b8b8c339d220449aa5a7a557a0f7060a02))

freeiam-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,133 @@
+# Contributing
+
+Thank you for your interest in contributing to FreeIAM!
+
+We welcome contributions of all kinds — bug reports, feature ideas, code, documentation, and tests.
+
+---
+
+## Prerequisites
+
+Before contributing, please make sure you have the following installed:
+
+- Python ≥ 3.10
+- [`uv`](https://github.com/astral-sh/uv) for environment management
+- [`pre-commit`](https://pre-commit.com/)
+- Git configured to use [Conventional Commits](https://www.conventionalcommits.org/)
+- [`tox`](https://tox.readthedocs.io/)
+- [`reuse`](https://reuse.software/)
+
+---
+
+## Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/Free-IAM/freeiam.git
+cd freeiam
+
+# Set up the environment
+uv venv
+source .venv/bin/activate
+
+# Install development dependencies
+uv pip install -r requirements-dev.txt
+
+# Set up pre-commit hooks
+pre-commit install
+pre-commit run --all-files
+```
+
+---
+
+## Commit conventions
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
+
+```
+<type>(<scope>): <description>
+```
+
+---
+
+## Pull Requests
+
+- Apply principles of Clean Code.
+- Include a clear description of _what_ you changed and _why_.
+- Link any related issues.
+- All pre-commit checks and tox test environments should pass.
+
+---
+
+## Style & Linting
+
+We use [`ruff`](https://docs.astral.sh/ruff/) for linting and formatting.
+
+It is automatically run via `pre-commit`. You can also run it manually:
+
+```bash
+ruff check .
+ruff format .
+```
+
+---
+
+## Testing
+
+We use `pytest`, managed via `tox`.
+
+Run all tests:
+
+```bash
+tox
+```
+
+Run a specific environment (e.g. Python 3.11):
+
+```bash
+tox -e py311
+```
+
+Check coverage:
+
+```bash
+pytest --cov
+```
+
+---
+
+## Documentation
+
+Documentation is written in reStructuredText using Sphinx and hosted on Read the Docs.
+
+To build the docs locally:
+
+```bash
+tox -e docs
+```
+
+The output will be available under `docs/_build/html/index.html`.
+
+---
+
+## Licensing
+
+We use the [REUSE specification](https://reuse.software/) for license compliance.
+
+To check compliance:
+
+```bash
+reuse lint
+```
+
+To add copyright/license:
+
+```bash
+reuse annotate <filename>
+```
+
+Make sure all contributions are REUSE-compliant before submission.
+
+By submitting a pull request, you agree to license your contributions under the project's license.
+
+---

freeiam-0.1.0/LICENSES/Apache-2.0.txt

@@ -0,0 +1,73 @@
+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 [yyyy] [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.

freeiam-0.1.0/LICENSES/CC0-1.0.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

freeiam-0.1.0/LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

freeiam-0.1.0/MANIFEST.in

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2025 Florian Best
+# SPDX-License-Identifier: CC0-1.0
+
+exclude create_sync.sh
+exclude .gitignore
+exclude Makefile
+exclude .pre-commit-config.yaml
+exclude pytest_benchmark.ini
+exclude pytest.ini
+exclude .readthedocs.yml
+exclude tox.ini
+recursive-exclude benchmarks *
+recursive-exclude docs *
+recursive-exclude .github *
+recursive-exclude .reuse *
+recursive-exclude tests *

freeiam-0.1.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.4
+Name: freeiam
+Version: 0.1.0
+Summary: FreeIAM is a free and flexible Identity and Access Management solution.
+Author-email: Florian Best <contact@freeiam.org>
+Project-URL: homepage, https://freeiam.org
+Project-URL: documentation, https://docs.freeiam.org
+Project-URL: repository, https://github.com/Free-IAM/freeiam
+Project-URL: changelog, https://github.com/Free-IAM/freeiam/blob/main/CHANGELOG.md
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: python-ldap
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: cryptography; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-benchmark; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-timeout; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: testcontainers[docker]; extra == "dev"
+Requires-Dist: python-semantic-release; extra == "dev"
+Provides-Extra: test
+Requires-Dist: cryptography; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-benchmark; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-timeout; extra == "test"
+Requires-Dist: testcontainers[docker]; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Provides-Extra: benchmark
+Requires-Dist: ldap3; extra == "benchmark"
+Requires-Dist: bonsai; extra == "benchmark"
+
+[![CI](https://github.com/Free-IAM/freeiam/actions/workflows/ci.yml/badge.svg)](https://github.com/Free-IAM/freeiam/actions/workflows/ci.yml)
+[![pre-commit](https://github.com/Free-IAM/freeiam/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/Free-IAM/freeiam/actions/workflows/pre-commit.yml)
+[![Coverage](https://img.shields.io/codecov/c/github/Free-IAM/freeiam.svg)](https://codecov.io/gh/Free-IAM/freeiam)
+
+[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/release/python-3110/)
+[![Docs](https://readthedocs.org/projects/free-iam/badge/?version=latest)](https://docs.freeiam.org/en/latest/)
+[![Ruff](https://img.shields.io/badge/linter-ruff-blue)](https://docs.astral.sh/ruff/)
+
+[![PyPI](https://img.shields.io/pypi/v/freeiam)](https://pypi.org/project/freeiam/)
+[![Issues](https://img.shields.io/github/issues/Free-IAM/freeiam.svg)](https://github.com/Free-IAM/freeiam/issues)
+[![Security Policy](https://img.shields.io/badge/security-policy-green)](https://github.com/Free-IAM/freeiam/security/policy)
+[![REUSE status](https://api.reuse.software/badge/github.com/Free-IAM/freeiam)](https://api.reuse.software/info/github.com/Free-IAM/freeiam)
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: Apache 2](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+# Free IAM - Free Identity and Access Management.
+
+**Free IAM** is a flexible and open identity and access management system designed for interoperability, extensibility, and simplicity.
+It provides clean APIs, powerful abstractions, and deep integration with common identity schemata and directory services.
+
+## LDAP Client Library
+
+FreeIAM offers both a asynchronous and synchronous LDAP client library for Python via `freeiam.ldap`, supporting the full range of client features.
+For usage examples and detailed API documentation, please refer to the [official documentation](https://docs.freeiam.org/).
+
+```python
+import asyncio
+
+from freeiam import ldap
+
+
+async def main():
+    async with ldap.Connection('ldap://localhost:389', timeout=30) as conn:
+        # TLS
+        conn.set_tls(ca_certfile='/path/to/ca.crt', require_cert=TLSOptionValue.Hard)
+        await conn.start_tls()
+
+        # authenticate
+        await conn.bind('cn=admin,dc=freeiam,dc=org', 'iamfree')
+
+        # search for DN and attrs
+        for entry in await conn.search(search_base, Scope.Subtree, '(&(uid=*)(objectClass=person))'):
+            print(entry.dn, entry.attr)
+
+        # search iterative for DN and attrs
+        async for entry in conn.search_iter(search_base, Scope.Subtree, '(&(uid=*)(objectClass=person))'):
+            print(entry.dn, entry.attr)
+
+        # search for DN
+        async for entry in conn.search_dn(search_base, Scope.Subtree, '(&(uid=*)(objectClass=person))'):
+            print(entry.dn)
+
+        # search paginated
+        async for entry in conn.search_paginated(
+            search_base,
+            Scope.Subtree,
+            '(&(uid=*)(objectClass=person))',
+            page_size=10,
+        ):
+            print(entry.dn, entry.attr)
+
+        # get a certain object, and use its attributes
+        obj = await conn.get('uid=max.mustermann,dc=freeiam,dc=org')
+        print(obj.dn, obj.attr)
+        print(obj.attr['cn'])
+
+        # get a attribute of an object
+        cn = await conn.get_attr('uid=max.mustermann,dc=freeiam,dc=org', 'commonName')
+        print(cn)
+
+
+asyncio.run(main())
+```
+
+The same API exists synchronously:
+```python
+from freeiam import ldap
+
+
+with ldap.Connection('ldap://localhost:389', timeout=30) as conn:
+    # TLS
+    conn.set_tls(ca_certfile='/path/to/ca.crt', require_cert=TLSOptionValue.Hard)
+    conn.start_tls()
+
+    # authenticate
+    conn.bind('cn=admin,dc=freeiam,dc=org', 'iamfree')
+
+    # search for DN and attrs
+    for entry in conn.search(search_base, Scope.Subtree, '(&(uid=*)(objectClass=person))'):
+        print(entry.dn, entry.attr)
+```
+
+## Documentation
+
+Comprehensive documentation is available to help you get started quickly and to explore advanced features.
+It includes usage guides, API references, and example code snippets.
+
+Visit the official documentation site here: [https://docs.freeiam.org/](https://docs.freeiam.org/)
+
+## Changelog
+
+This project follows [Semantic Versioning](https://semver.org/) to manage releases.
+
+A detailed, human-readable changelog is maintained and can be found here: [CHANGELOG.md](CHANGELOG.md).
+
+## Contributing
+
+Contributions are very welcome!
+
+Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to get started, coding standards, and the pull request process.
+If you want to report bugs, request features, or discuss improvements, please open an issue on GitHub.
+
+## License
+
+This project is dual-licensed under the following licenses, giving fully flexibility:
+
+- [MIT License](LICENSES/MIT.txt) ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
+- [Apache License 2.0](LICENSES/Apache-2.0.txt) ![License: Apache 2](https://img.shields.io/badge/license-Apache%202.0-blue.svg)
+
+See the LICENSES files for more details.
+
+## Test Coverage
+
+The project currently maintains 100% test coverage, ensuring that all code paths are exercised by automated tests.
+This helps guarantee reliability, correctness, and ease of future maintenance.
+
+## LDAP client benchmarks
+Current benchmarks indicate that the synchronous non-iterable methods offer the best performance.
+The benchmark suite compares FreeIAM (`freeiam.ldap`) against Python-LDAP (`ldap`), LDAP3 (`ldap3`), and Bonsai (`bonsai`).
+
+Please note this is a work in progress (WIP) and the benchmark coverage and accuracy will be improved over time.
+
+| Testname                            | Min (us)  | Max (us)   | Mean (us) | StdDev (us) | Median (us) | IQR (us) | Outliers | OPS      | Rounds | Iterations |
+|-----------------------------------|-----------|------------|-----------|-------------|-------------|----------|----------|----------|--------|------------|
+| test_sync_search[ldap-noiter]      | 336.42    | 1762.35    | 466.35    | 132.87      | 428.97      | 103.48   | 120;76   | 2144.33  | 1418   | 1          |
+| test_sync_search[freeiam-noiter]   | 381.79    | 1425.61    | 572.07    | 118.68      | 545.87      | 109.69   | 165;51   | 1748.04  | 1143   | 1          |
+| test_sync_search[bonsai-noiter]    | 446.28    | 1514.67    | 680.02    | 138.66      | 645.65      | 111.18   | 113;55   | 1470.55  | 861    | 1          |
+| test_sync_search[freeiam-iter]     | 692.62    | 2134.28    | 958.01    | 186.67      | 913.93      | 169.14   | 72;29    | 1043.83  | 488    | 1          |
+| test_sync_search[ldap3-noiter]     | 1181.49   | 3948.65    | 1603.93   | 333.01      | 1518.64     | 253.67   | 71;43    | 623.47   | 482    | 1          |
+| test_async_search[freeiam-noiter]  | 1577.63   | 6493.86    | 2659.18   | 634.62      | 2430.03     | 676.09   | 58;22    | 376.06   | 328    | 1          |
+| test_async_search[freeiam-iter]    | 2768.34   | 5792.08    | 3479.36   | 598.57      | 3279.16     | 579.05   | 34;11    | 287.41   | 169    | 1          |
+| test_parallel_sync_search[freeiam] | 12317.69  | 46028.09   | 14145.28  | 4472.71     | 13232.57    | 972.18   | 1;4      | 70.70    | 55     | 1          |
+| test_multiple_parallel_sync_search[freeiam] | 33453.03  | 39019.64   | 35980.09  | 1332.03     | 36083.70    | 1862.24  | 10;0     | 27.79    | 28     | 1          |
+
+## Project Goals
+- Clean and extensible APIs and libraries
+- Standards-first: implements what standards allow - no artificial limitations
+- Identity and access management based on standardized object types:
+  - Users
+  - Groups
+  - Containers
+  - Organizational Units (OUs)
+  - etc.
+  - Authorizations
+  - Roles
+- Full support for widely used directory schemata:
+  - POSIX
+  - Kerberos
+  - Samba
+  - FreeIPA
+  - Univention Corporate Server (UCS)
+- Flexible composition of object classes (define your own object model)
+- Compatibility with major LDAP servers:
+  - OpenLDAP
+  - 389 Directory Server
+  - Samba
+  - Microsoft Active Directory
+- Data migration and synchronization connectors for diverse LDAP schemas
+- Fully asynchronous, non-blocking I/O architecture
+- HTTP API
+- OAuth 2.0 SASL OAUTHBEARER bind support
+- Integrated SCIM representation for modern interoperability
+- Modular and configurable web UI:
+  - Configurable layouts: e.g. simple, advanced, wizard-based, profile views
+  - Customizable data representations and mappings
+  - Unified abstractions for common directory operations
+  - User-friendly and modern terminology
+- Dynamic configuration via LDAP entries or static YAML files
+- Maybe: Built-in event system for tracking object changes and triggers