pyadm-toolkit 0.0.1__tar.gz

pyadm-toolkit-0.0.1/LICENSE

@@ -0,0 +1,10 @@
+
+Copyright 2023 Ole Kleinschmidt <ok@datenreisende.org>
+
+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.
+
+

pyadm-toolkit-0.0.1/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: pyadm-toolkit
+Version: 0.0.1
+Summary: PyADM - Python Admin Toolkit. The swiss army knife for every engineer.
+Home-page: https://github.com/okleinschmidt/pyadm
+Author: Ole Kleinschmidt
+Author-email: Ole Kleinschmidt <ok@datenreisende.org>
+License: MIT License
+Project-URL: Homepage, https://github.com/okleinschmidt/pyadm
+Project-URL: Bug Tracker, https://github.com/okleinschmidt/pyadm/issues
+Keywords: python admin toolkit pyadm ldap activedirectory directoryserver
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# pyadm - Swiss Army Knife for Engineers and Administrators
+
+**pyadm** is a versatile command-line tool designed as a Swiss Army Knife for engineers and administrators.\
+It provides modular functionality to perform various tasks efficiently. 
+
+**Currently, the only available module is `ldap`, which enables LDAP-related operations.**
+
+## Installation
+
+To install `pyadm`, use the following command (soon!):
+
+```shell
+pip install pyadm-toolkit
+```
+## Usage
+The general command structure for pyadm is as follows:
+```shell
+pyadm MODULE SUBCOMMAND [OPTIONS]
+```
+To use the LDAP module, execute the pyadm ldap command followed by the desired subcommand to perform specific LDAP operations.
+
+## LDAP Module
+The LDAP module within pyadm allows you to interact with LDAP servers and perform common operations, such as retrieving user information, showing group associations, and displaying group members.
+
+### Examples
+* Retrieve information for a user in the LDAP directory:
+  ```shell
+  pyadm ldap user USERNAME
+  ```
+* Show groups associated with a user in the LDAP directory:
+  ```shell
+  pyadm ldap groups USERNAME
+  ```
+* Show members of a group in the LDAP directory:
+  ```shell
+  pyadm ldap members GROUP_CN
+  ```
+For more information on each subcommand, you can use the --help option, as shown in the examples below:
+```shell
+pyadm ldap user --help
+pyadm ldap groups --help
+pyadm ldap members --hel
+```
+
+## Configuration
+The pyadm tool allows you to customize its behavior through a configuration file. By default, the configuration file is located at `~/.config/pyadm/pyadm.conf`.
+
+To use a custom configuration file, create a file in the following format:
+```ini
+[LDAP]
+server = ldaps://dc.example.org
+base_dn = dc=example,dc=org
+bind_username = administrator@example.org
+bind_password = s3cr3t-p455w0rd!
+```
+Specify the desired values for the LDAP server, base DN, bind username, and bind password in the configuration file.
+
+## Contributing
+Contributions are welcome! If you encounter any issues, have suggestions, or would like to add new features, please submit an issue or a pull request.
+
+## License
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).\
+Feel free to copy and use this markdown source as needed for your `README.md` file.

pyadm-toolkit-0.0.1/README.md

@@ -0,0 +1,63 @@
+# pyadm - Swiss Army Knife for Engineers and Administrators
+
+**pyadm** is a versatile command-line tool designed as a Swiss Army Knife for engineers and administrators.\
+It provides modular functionality to perform various tasks efficiently. 
+
+**Currently, the only available module is `ldap`, which enables LDAP-related operations.**
+
+## Installation
+
+To install `pyadm`, use the following command (soon!):
+
+```shell
+pip install pyadm-toolkit
+```
+## Usage
+The general command structure for pyadm is as follows:
+```shell
+pyadm MODULE SUBCOMMAND [OPTIONS]
+```
+To use the LDAP module, execute the pyadm ldap command followed by the desired subcommand to perform specific LDAP operations.
+
+## LDAP Module
+The LDAP module within pyadm allows you to interact with LDAP servers and perform common operations, such as retrieving user information, showing group associations, and displaying group members.
+
+### Examples
+* Retrieve information for a user in the LDAP directory:
+  ```shell
+  pyadm ldap user USERNAME
+  ```
+* Show groups associated with a user in the LDAP directory:
+  ```shell
+  pyadm ldap groups USERNAME
+  ```
+* Show members of a group in the LDAP directory:
+  ```shell
+  pyadm ldap members GROUP_CN
+  ```
+For more information on each subcommand, you can use the --help option, as shown in the examples below:
+```shell
+pyadm ldap user --help
+pyadm ldap groups --help
+pyadm ldap members --hel
+```
+
+## Configuration
+The pyadm tool allows you to customize its behavior through a configuration file. By default, the configuration file is located at `~/.config/pyadm/pyadm.conf`.
+
+To use a custom configuration file, create a file in the following format:
+```ini
+[LDAP]
+server = ldaps://dc.example.org
+base_dn = dc=example,dc=org
+bind_username = administrator@example.org
+bind_password = s3cr3t-p455w0rd!
+```
+Specify the desired values for the LDAP server, base DN, bind username, and bind password in the configuration file.
+
+## Contributing
+Contributions are welcome! If you encounter any issues, have suggestions, or would like to add new features, please submit an issue or a pull request.
+
+## License
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).\
+Feel free to copy and use this markdown source as needed for your `README.md` file.

pyadm-toolkit-0.0.1/VERSION

@@ -0,0 +1 @@
+0.0.1

pyadm-toolkit-0.0.1/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools", "black"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyadm-toolkit"
+version = "0.0.1"
+authors = [
+  { name="Ole Kleinschmidt", email="ok@datenreisende.org" },
+]
+description = "PyADM - Python Admin Toolkit. The swiss army knife for every engineer."
+readme = "README.md"
+requires-python = ">=3.10.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/okleinschmidt/pyadm"
+"Bug Tracker" = "https://github.com/okleinschmidt/pyadm/issues"

pyadm-toolkit-0.0.1/requirements.txt

@@ -0,0 +1,3 @@
+# Enter requirements
+click
+ldap3

pyadm-toolkit-0.0.1/setup.cfg

@@ -0,0 +1,37 @@
+[metadata]
+name = pyadm-toolkit
+version = file: VERSION
+author = Ole Kleinschmidt
+author_email = ok@datenreisende.org
+url = https://github.com/okleinschmidt/pyadm
+description = PyADM - Python Admin Toolkit. The swiss army knife for every engineer.
+long_description = file: README.md
+long_description_content_type = text/markdown
+keywords = python admin toolkit pyadm ldap activedirectory directoryserver
+license = MIT License
+classifiers = 
+	License :: OSI Approved :: MIT License
+	Programming Language :: Python :: 3
+	Operating System :: OS Independent
+
+[options]
+packages = find:
+zip_safe = True
+include_package_data = True
+install_requires = file: requirements.txt
+python_requires = >=3.10.8
+
+[options.package_data]
+* = README.md, LICENSE, VERSION
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+console_scripts = 
+	pyadm = pyadm.main:cli
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyadm-toolkit-0.0.1/src/pyadm/config.py

@@ -0,0 +1,6 @@
+import configparser
+from pathlib import Path
+
+config = configparser.ConfigParser()
+config_file = Path.home() / ".config/pyadm/pyadm.conf"
+config.read(config_file)

pyadm-toolkit-0.0.1/src/pyadm/ldapcli/click_commands.py

@@ -0,0 +1,220 @@
+import click
+import json
+import ldap3
+
+from ldap3.core.exceptions import LDAPException
+from pyadm.config import config
+
+defaults = {
+    "server": "ldap://localhost",
+    "base_dn": "dc=example,dc=org",
+    "username": "root@example.org",
+    "password": "s3cur3_p455w0rd",
+}
+
+click_options = {}
+
+def ldap_search(click_options, search_filter, attributes=[]):
+    try:
+        server_url = click_options["server"]
+        bind_dn = click_options["username"]
+        bind_password = click_options["password"]
+
+        server = ldap3.Server(server_url)
+        conn = ldap3.Connection(server, user=bind_dn, password=bind_password)
+        conn.open()
+        conn.bind()
+
+        base_dn = click_options["base_dn"]
+
+        conn.search(base_dn, search_filter, attributes=attributes)
+
+        result_entries = conn.entries
+        return result_entries
+    except LDAPException as e:
+        raise click.ClickException(f"LDAP search failed: {e}")
+
+# define click commands
+@click.group("ldap")
+@click.option("--server", "-s", help="Specify the LDAP server.")
+@click.option("--base_dn", "-b", help="Specify the base DN (Distinguished Name).")
+@click.option("--username", "-u", help="Specify the username for authentication.")
+@click.option("--password", "-p", help="Specify the password for authentication. It will prompt if the password is empty.", prompt=False, hide_input=True)
+def ldapcli(server, base_dn, username, password):
+    """
+    Query LDAP/Active Directory.
+
+    This command provides various subcommands to interact with
+    an LDAP or Active Directory server. It allows you to perform queries,
+    retrieve information, and manage users and groups within the directory.
+    
+    \b
+    To see the available subcommands, run 'pyadm ldap --help'.\r
+    Get help for subcommands, run 'pyadm ldap COMMAND --help'.
+    
+    \b
+    Configuration File:\r
+    The configuration file allows you to customize various settings for the
+    command, such as the LDAP server, base DN, username, password, and other options.
+
+    The default location for the configuration file is `/home/user/.config/pyadm/pyadm.conf`.
+
+    Example configuration file contents:
+    
+    \b
+    [LDAP]
+    server = ldaps://dc.example.org
+    base_dn = dc=example,dc=org
+    bind_username = administrator@example.org
+    bind_password = s3cr3t-p455w0rd!
+    
+    """
+    if not (server or base_dn or username or password):
+        click_options["server"] = config["LDAP"]["server"] or defaults["server"]
+        click_options["base_dn"] = config["LDAP"]["base_dn"] or defaults["base_dn"]
+        click_options["username"] = config["LDAP"]["bind_username"] or defaults["username"]
+        click_options["password"] = config["LDAP"]["bind_password"] or defaults["password"]
+    else:
+        click_options["server"] = server or defaults["server"]
+        click_options["base_dn"] = base_dn or defaults["base_dn"]
+        click_options["username"] = username or defaults["username"]
+        click_options["password"] = password
+
+# show information about a user
+@ldapcli.command("user")
+@click.argument("username", metavar="[UID, CN, MAIL]")
+@click.option("--all", "-a", is_flag=True, default=None, help="Show all attributes")
+@click.option("--json", "-j", "json_output", is_flag=True, default=None, help="Output as JSON")
+def user(username, json_output, all):
+    """Show information about a user specified by [UID], [CN], or [MAIL].
+
+    This command allows you to retrieve detailed information about a user
+    in the LDAP directory. You can specify the username using their UID,
+    CN (Common Name), or MAIL (Email Address).
+    
+    \b
+    Examples:
+    $ pyadm ldap user jdoe              # Retrieve information for user with UID 'jdoe'
+    $ pyadm ldap user "John Doe"        # Retrieve information for user with CN 'John Doe'
+    $ pyadm ldap user jdoe@example.com  # Retrieve information for user with MAIL 'jdoe@example.com'
+    """
+    search_filter = f"(|(uid={username})(cn={username})(mail={username}))"
+    try:
+        if all:
+            attributes = ["*"]
+            result = ldap_search(click_options, search_filter, attributes)
+        else:
+            attributes = ["cn", "mail", "memberOf"]
+            result = ldap_search(click_options, search_filter, attributes)
+
+        if result:
+            if json_output:
+                user_info = result[0].entry_to_json()
+                print(user_info)
+            else:
+                user_info = result[0].entry_attributes_as_dict
+                user_info = {str(attr): [str(value) for value in values] for attr, values in user_info.items()}
+                for attr, values in sorted(user_info.items()):
+                    if attr == "memberOf" or attr == "objectClass":
+                        print(f"{attr}:")
+                        for group in values:
+                            print(f" - {group}")
+                    else:
+                        print(f"{attr}: {', '.join(values)}")
+        else:
+            raise click.ClickException(f"No user found with UID '{username}'.")
+    except click.ClickException as e:
+        raise e
+    except Exception as e:
+        raise click.ClickException(f"An error occurred: {e}")
+
+# show groups a user belongs to
+@ldapcli.command("groups")
+@click.argument("username", metavar="[UID, CN, MAIL]")
+@click.option("--json", "-j", "json_output", is_flag=True, default=None, help="Output as JSON")
+def groups(username, json_output):
+    """
+    Show groups associated with a user specified by [UID], [CN], or [MAIL].
+
+    This command allows you to retrieve the groups associated with a user
+    in the LDAP directory. You can specify the username using their UID,
+    CN (Common Name), or MAIL (Email Address).
+    
+    \b
+    Examples:
+    $ pyadm ldap groups jdoe              # Retrieve groups for user with UID 'jdoe'
+    $ pyadm ldap groups "John Doe"        # Retrieve groups for user with CN 'John Doe'
+    $ pyadm ldap groups jdoe@example.com  # Retrieve groups for user with MAIL 'jdoe@example.com'
+    """
+    search_filter = f"(|(uid={username})(cn={username}))"
+    try:
+        attributes = ["memberOf"]
+        result = ldap_search(click_options, search_filter, attributes)
+
+        if result:
+            if json_output:
+                group_info = result[0].entry_to_json()
+                print(group_info)
+            else:
+                group_info = result[0].entry_attributes_as_dict
+                group_info = {str(attr): [str(value) for value in values] for attr, values in group_info.items()}
+                for attr, values in sorted(group_info.items()):
+                    if attr == "memberOf" or attr == "objectClass":
+                        print(f"{attr}:")
+                        for group in values:
+                            print(f" - {group}")
+                    else:
+                        print(f"{attr}: {', '.join(values)}")
+        else:
+            raise click.ClickException(f"No user found with UID '{uid}'.")
+    except click.ClickException as e:
+        raise e
+    except Exception as e:
+        raise click.ClickException(f"An error occurred: {e}")
+
+# show members of a group
+@ldapcli.command("members")
+@click.argument("group_cn", metavar="[GROUP]")
+@click.option("--all", "-a", is_flag=True, default=None, help="Show all attributes")
+@click.option("--json", "-j", "json_output", is_flag=True, default=None, help="Output as JSON")
+def members(group_cn, json_output, all):
+    """
+    Show members of a group specified by [GROUP].
+
+    This command allows you to retrieve the members of a group in the LDAP
+    directory. You can specify the group using its CN (Common Name).
+
+    \b
+    Examples:
+    $ pyadm ldap members "Developers"     # Retrieve members of the group with CN 'Developers'
+    $ pyadm ldap members "Admins"         # Retrieve members of the group with CN 'Admins'
+    """
+    search_filter = f"(cn={group_cn})"
+    try:
+        if all:
+            attributes = ["*"]
+            result = ldap_search(click_options, search_filter, attributes)
+        else:
+            attributes = ["cn", "description", "member"]
+            result = ldap_search(click_options, search_filter, attributes)
+
+        if result:
+            if json_output:
+                group_info = result[0].entry_to_json()
+                print(group_info)
+            else:
+                group_info = result[0].entry_attributes_as_dict
+                group_info = {str(attr): [str(value) for value in values] for attr, values in group_info.items()}
+                for attr, values in sorted(group_info.items()):
+                    if attr == "member" or attr == "objectClass":
+                        print(f"{attr}:")
+                        for group in values:
+                            print(f"  - {group}")
+                    else:
+                        print(f"{attr}: {', '.join(values)}")
+        else:
+            raise click.ClickException(f"No user found with UID '{group_cn}'.")
+    except click.ClickException as e:
+        raise e
+    except Exception as e:
+        raise click.ClickException(f"An error occurred: {e}")

pyadm-toolkit-0.0.1/src/pyadm/main.py

@@ -0,0 +1,39 @@
+import click
+
+from pyadm.ldapcli.click_commands import ldapcli
+
+
+@click.group()
+def cli():
+    """
+    pyadm - Swiss Army Knife for Engineers and Administrators
+ 
+    It provides modular functionality to perform various tasks efficiently.
+    Currently, the only available module is 'ldap', which enables LDAP-related operations.
+
+    Usage: pyadm ldap SUBCOMMAND [OPTIONS]
+
+    To use the LDAP module, execute the 'pyadm ldap' command followed by the desired subcommand to perform specific LDAP operations.
+
+    For more information on a particular subcommand, run 'pyadm ldap SUBCOMMAND --help'.
+    
+    \b
+    Example:
+    $ pyadm ldap user jdoe             # Retrieve information for a user in the LDAP directory
+    $ pyadm ldap groups jdoe           # Show groups associated with a user in the LDAP directory
+    $ pyadm ldap members "Developers"  # Show members of a group in the LDAP directory
+    """
+    pass
+
+@click.command()
+def version():
+    """Display version information"""
+    with open("VERSION", "r") as version_file:
+        version = version_file.read().strip()
+    click.echo(f"Version: {version}")
+
+cli.add_command(ldapcli)
+cli.add_command(version)
+
+if __name__ == "__main__":
+    cli()

pyadm-toolkit-0.0.1/src/pyadm_toolkit.egg-info/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: pyadm-toolkit
+Version: 0.0.1
+Summary: PyADM - Python Admin Toolkit. The swiss army knife for every engineer.
+Home-page: https://github.com/okleinschmidt/pyadm
+Author: Ole Kleinschmidt
+Author-email: Ole Kleinschmidt <ok@datenreisende.org>
+License: MIT License
+Project-URL: Homepage, https://github.com/okleinschmidt/pyadm
+Project-URL: Bug Tracker, https://github.com/okleinschmidt/pyadm/issues
+Keywords: python admin toolkit pyadm ldap activedirectory directoryserver
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# pyadm - Swiss Army Knife for Engineers and Administrators
+
+**pyadm** is a versatile command-line tool designed as a Swiss Army Knife for engineers and administrators.\
+It provides modular functionality to perform various tasks efficiently. 
+
+**Currently, the only available module is `ldap`, which enables LDAP-related operations.**
+
+## Installation
+
+To install `pyadm`, use the following command (soon!):
+
+```shell
+pip install pyadm-toolkit
+```
+## Usage
+The general command structure for pyadm is as follows:
+```shell
+pyadm MODULE SUBCOMMAND [OPTIONS]
+```
+To use the LDAP module, execute the pyadm ldap command followed by the desired subcommand to perform specific LDAP operations.
+
+## LDAP Module
+The LDAP module within pyadm allows you to interact with LDAP servers and perform common operations, such as retrieving user information, showing group associations, and displaying group members.
+
+### Examples
+* Retrieve information for a user in the LDAP directory:
+  ```shell
+  pyadm ldap user USERNAME
+  ```
+* Show groups associated with a user in the LDAP directory:
+  ```shell
+  pyadm ldap groups USERNAME
+  ```
+* Show members of a group in the LDAP directory:
+  ```shell
+  pyadm ldap members GROUP_CN
+  ```
+For more information on each subcommand, you can use the --help option, as shown in the examples below:
+```shell
+pyadm ldap user --help
+pyadm ldap groups --help
+pyadm ldap members --hel
+```
+
+## Configuration
+The pyadm tool allows you to customize its behavior through a configuration file. By default, the configuration file is located at `~/.config/pyadm/pyadm.conf`.
+
+To use a custom configuration file, create a file in the following format:
+```ini
+[LDAP]
+server = ldaps://dc.example.org
+base_dn = dc=example,dc=org
+bind_username = administrator@example.org
+bind_password = s3cr3t-p455w0rd!
+```
+Specify the desired values for the LDAP server, base DN, bind username, and bind password in the configuration file.
+
+## Contributing
+Contributions are welcome! If you encounter any issues, have suggestions, or would like to add new features, please submit an issue or a pull request.
+
+## License
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).\
+Feel free to copy and use this markdown source as needed for your `README.md` file.

pyadm-toolkit-0.0.1/src/pyadm_toolkit.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+LICENSE
+README.md
+VERSION
+pyproject.toml
+requirements.txt
+setup.cfg
+src/pyadm/__init__.py
+src/pyadm/config.py
+src/pyadm/main.py
+src/pyadm/ldapcli/__init__.py
+src/pyadm/ldapcli/click_commands.py
+src/pyadm_toolkit.egg-info/PKG-INFO
+src/pyadm_toolkit.egg-info/SOURCES.txt
+src/pyadm_toolkit.egg-info/dependency_links.txt
+src/pyadm_toolkit.egg-info/entry_points.txt
+src/pyadm_toolkit.egg-info/requires.txt
+src/pyadm_toolkit.egg-info/top_level.txt
+src/pyadm_toolkit.egg-info/zip-safe

pyadm-toolkit-0.0.1/src/pyadm_toolkit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyadm-toolkit-0.0.1/src/pyadm_toolkit.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyadm = pyadm.main:cli

pyadm-toolkit-0.0.1/src/pyadm_toolkit.egg-info/requires.txt

@@ -0,0 +1,2 @@
+click
+ldap3

pyadm-toolkit-0.0.1/src/pyadm_toolkit.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyadm

pyadm-toolkit-0.0.1/src/pyadm_toolkit.egg-info/zip-safe

@@ -0,0 +1 @@
+