python3-cyberfusion-proftpd-support 1.0__tar.gz

python3_cyberfusion_proftpd_support-1.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: python3-cyberfusion-proftpd-support
+Version: 1.0
+Summary: Library to manage ProFTPD.
+Author-email: Cyberfusion <support@cyberfusion.io>
+Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-proftpd-support
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic[dotenv]==1.10.4
+
+# python3-cyberfusion-proftpd-support
+
+Library to manage ProFTPD.
+
+At the moment, this library allows you to create auto-expiring ProFTPD users (stored in an SQLite database).
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-proftpd-support
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+Place settings in `/etc/proftpd-support.conf` (regular text file).
+
+All settings must be prefixed with `PROFTPD_SUPPORT_`.
+
+Find all available settings in `settings.py`.
+
+Find an example config in `.env.local`.
+
+# Usage
+
+```python
+from cyberfusion.ProftpdSupport.users import create_proftpd_user
+
+user = create_proftpd_user(
+    username="example",
+    password="example",
+    uid=1000,
+    gid=1000,
+    home_directory="/home/example",
+)
+```

python3_cyberfusion_proftpd_support-1.0/README.md

@@ -0,0 +1,44 @@
+# python3-cyberfusion-proftpd-support
+
+Library to manage ProFTPD.
+
+At the moment, this library allows you to create auto-expiring ProFTPD users (stored in an SQLite database).
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-proftpd-support
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+Place settings in `/etc/proftpd-support.conf` (regular text file).
+
+All settings must be prefixed with `PROFTPD_SUPPORT_`.
+
+Find all available settings in `settings.py`.
+
+Find an example config in `.env.local`.
+
+# Usage
+
+```python
+from cyberfusion.ProftpdSupport.users import create_proftpd_user
+
+user = create_proftpd_user(
+    username="example",
+    password="example",
+    uid=1000,
+    gid=1000,
+    home_directory="/home/example",
+)
+```

python3_cyberfusion_proftpd_support-1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "python3-cyberfusion-proftpd-support"
+version = "1.0"
+description = "Library to manage ProFTPD."
+readme = "README.md"
+authors = [
+    { name = "Cyberfusion", email = "support@cyberfusion.io" },
+]
+dependencies = [
+    "pydantic[dotenv]==1.10.4",
+]
+
+[project.urls]
+"Source" = "https://github.com/CyberfusionIO/python3-cyberfusion-proftpd-support"
+
+[project.scripts]
+proftpd-support-delete-expired-users = "cyberfusion.ProftpdSupport.users:delete_expire_users"

python3_cyberfusion_proftpd_support-1.0/setup.cfg

@@ -0,0 +1,12 @@
+[aliases]
+test = pytest
+
+[tool:pytest]
+norecursedirs = .git build dist *.egg __pycache__ .cache
+testpaths = tests
+junit_suite_name = python3-cyberfusion-proftpd-support
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

python3_cyberfusion_proftpd_support-1.0/src/cyberfusion/ProftpdSupport/database.py

@@ -0,0 +1,11 @@
+import sqlite3
+
+from cyberfusion.ProftpdSupport.settings import settings
+
+
+def get_database_connection() -> sqlite3.Connection:
+    connection = sqlite3.connect(settings.database_path, isolation_level=None)
+
+    connection.row_factory = sqlite3.Row  # Allow named access to columns
+
+    return connection

python3_cyberfusion_proftpd_support-1.0/src/cyberfusion/ProftpdSupport/models.py

@@ -0,0 +1,14 @@
+import datetime
+from dataclasses import dataclass
+
+
+@dataclass
+class User:
+    id: int
+    username: str
+    password: str
+    uid: int
+    gid: int
+    home_directory: str
+    shell_path: str
+    created_at: datetime.datetime

python3_cyberfusion_proftpd_support-1.0/src/cyberfusion/ProftpdSupport/settings.py

@@ -0,0 +1,16 @@
+from pydantic import BaseSettings
+from pathlib import Path
+
+
+class Settings(BaseSettings):
+    database_path: Path
+
+    user_expire_hours: int = 1
+
+    class Config:
+        env_prefix = "proftpd_support_"
+
+        env_file = ".env", "/etc/proftpd-support.conf"
+
+
+settings = Settings()

python3_cyberfusion_proftpd_support-1.0/src/cyberfusion/ProftpdSupport/users.py

@@ -0,0 +1,84 @@
+import datetime
+import os
+from typing import List
+
+from cyberfusion.ProftpdSupport.database import get_database_connection
+from cyberfusion.ProftpdSupport.models import User
+from cyberfusion.ProftpdSupport.settings import settings
+
+PATH_SHELL = os.path.join(os.path.sep, "bin", "false")
+
+
+def get_expire_users_ids() -> List[int]:
+    connection = get_database_connection()
+
+    cursor = connection.cursor()
+
+    cursor.execute(
+        f"SELECT * FROM `users` WHERE `created_at` < datetime('now', '-{settings.user_expire_hours} hours')"
+    )
+
+    return [row["id"] for row in cursor.fetchall()]
+
+
+def get_user(username: str) -> User:
+    connection = get_database_connection()
+
+    cursor = connection.cursor()
+
+    user = cursor.execute(
+        "SELECT `id`, `userid`, `passwd`, `uid`, `gid`,`homedir`, `shell`, `created_at` FROM `users` WHERE `userid` = ?",
+        (username,),
+    ).fetchone()
+
+    return User(
+        id=user["id"],
+        username=user["userid"],
+        password=user["passwd"],
+        uid=user["uid"],
+        gid=user["gid"],
+        home_directory=user["homedir"],
+        shell_path=user["shell"],
+        created_at=datetime.datetime.strptime(user["created_at"], "%Y-%m-%d %H:%M:%S"),
+    )
+
+
+def delete_expire_users() -> None:
+    expire_users_ids = get_expire_users_ids()
+
+    connection = get_database_connection()
+
+    cursor = connection.cursor()
+
+    for id_ in expire_users_ids:
+        cursor.execute("DELETE FROM `users` WHERE `id` = ?", (str(id_)))
+
+
+def get_users_amount() -> int:
+    connection = get_database_connection()
+
+    cursor = connection.cursor()
+
+    return cursor.execute("SELECT COUNT(*) FROM `users`").fetchone()[0]
+
+
+def create_proftpd_user(
+    *, username: str, password: str, uid: int, gid: int, home_directory: str
+) -> User:
+    connection = get_database_connection()
+
+    cursor = connection.cursor()
+
+    cursor.execute(
+        "INSERT INTO `users`(`userid`, `passwd`, `uid`, `gid`, `homedir`, `shell`) VALUES(?, ?, ?, ?, ?, ?)",
+        (
+            username,
+            password,
+            uid,
+            gid,
+            home_directory,
+            PATH_SHELL,
+        ),
+    )
+
+    return get_user(username)

python3_cyberfusion_proftpd_support-1.0/src/python3_cyberfusion_proftpd_support.egg-info/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: python3-cyberfusion-proftpd-support
+Version: 1.0
+Summary: Library to manage ProFTPD.
+Author-email: Cyberfusion <support@cyberfusion.io>
+Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-proftpd-support
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic[dotenv]==1.10.4
+
+# python3-cyberfusion-proftpd-support
+
+Library to manage ProFTPD.
+
+At the moment, this library allows you to create auto-expiring ProFTPD users (stored in an SQLite database).
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-proftpd-support
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+Place settings in `/etc/proftpd-support.conf` (regular text file).
+
+All settings must be prefixed with `PROFTPD_SUPPORT_`.
+
+Find all available settings in `settings.py`.
+
+Find an example config in `.env.local`.
+
+# Usage
+
+```python
+from cyberfusion.ProftpdSupport.users import create_proftpd_user
+
+user = create_proftpd_user(
+    username="example",
+    password="example",
+    uid=1000,
+    gid=1000,
+    home_directory="/home/example",
+)
+```

python3_cyberfusion_proftpd_support-1.0/src/python3_cyberfusion_proftpd_support.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+setup.cfg
+src/cyberfusion/ProftpdSupport/__init__.py
+src/cyberfusion/ProftpdSupport/database.py
+src/cyberfusion/ProftpdSupport/models.py
+src/cyberfusion/ProftpdSupport/settings.py
+src/cyberfusion/ProftpdSupport/users.py
+src/python3_cyberfusion_proftpd_support.egg-info/PKG-INFO
+src/python3_cyberfusion_proftpd_support.egg-info/SOURCES.txt
+src/python3_cyberfusion_proftpd_support.egg-info/dependency_links.txt
+src/python3_cyberfusion_proftpd_support.egg-info/entry_points.txt
+src/python3_cyberfusion_proftpd_support.egg-info/requires.txt
+src/python3_cyberfusion_proftpd_support.egg-info/top_level.txt

python3_cyberfusion_proftpd_support-1.0/src/python3_cyberfusion_proftpd_support.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

python3_cyberfusion_proftpd_support-1.0/src/python3_cyberfusion_proftpd_support.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+proftpd-support-delete-expired-users = cyberfusion.ProftpdSupport.users:delete_expire_users

python3_cyberfusion_proftpd_support-1.0/src/python3_cyberfusion_proftpd_support.egg-info/requires.txt

@@ -0,0 +1 @@
+pydantic[dotenv]==1.10.4

python3_cyberfusion_proftpd_support-1.0/src/python3_cyberfusion_proftpd_support.egg-info/top_level.txt

@@ -0,0 +1 @@
+cyberfusion