RAHHH

backend/lib/python3.12/site-packages/twisted/python/fakepwd.py

@@ -0,0 +1,263 @@
+# -*- test-case-name: twisted.python.test.test_fakepwd -*-
+# Copyright (c) Twisted Matrix Laboratories.
+# See LICENSE for details.
+
+"""
+L{twisted.python.fakepwd} provides a fake implementation of the L{pwd} API.
+"""
+
+from typing import List, Optional
+
+__all__ = ["UserDatabase", "ShadowDatabase"]
+
+
+class _UserRecord:
+    """
+    L{_UserRecord} holds the user data for a single user in L{UserDatabase}.
+    It corresponds to the C{passwd} structure from the L{pwd} module.
+    See that module for attribute documentation.
+    """
+
+    def __init__(
+        self,
+        name: str,
+        password: str,
+        uid: int,
+        gid: int,
+        gecos: str,
+        home: str,
+        shell: str,
+    ) -> None:
+        self.pw_name = name
+        self.pw_passwd = password
+        self.pw_uid = uid
+        self.pw_gid = gid
+        self.pw_gecos = gecos
+        self.pw_dir = home
+        self.pw_shell = shell
+
+    def __len__(self) -> int:
+        return 7
+
+    def __getitem__(self, index):
+        return (
+            self.pw_name,
+            self.pw_passwd,
+            self.pw_uid,
+            self.pw_gid,
+            self.pw_gecos,
+            self.pw_dir,
+            self.pw_shell,
+        )[index]
+
+
+class UserDatabase:
+    """
+    L{UserDatabase} holds a traditional POSIX user data in memory and makes it
+    available via the same API as L{pwd}.
+
+    @ivar _users: A C{list} of L{_UserRecord} instances holding all user data
+        added to this database.
+    """
+
+    _users: List[_UserRecord]
+    _lastUID: int = 10101
+    _lastGID: int = 20202
+
+    def __init__(self) -> None:
+        self._users = []
+
+    def addUser(
+        self,
+        username: str,
+        password: str = "password",
+        uid: Optional[int] = None,
+        gid: Optional[int] = None,
+        gecos: str = "",
+        home: str = "",
+        shell: str = "/bin/sh",
+    ) -> None:
+        """
+        Add a new user record to this database.
+
+        @param username: The value for the C{pw_name} field of the user
+            record to add.
+
+        @param password: The value for the C{pw_passwd} field of the user
+            record to add.
+
+        @param uid: The value for the C{pw_uid} field of the user record to
+            add.
+
+        @param gid: The value for the C{pw_gid} field of the user record to
+            add.
+
+        @param gecos: The value for the C{pw_gecos} field of the user record
+            to add.
+
+        @param home: The value for the C{pw_dir} field of the user record to
+            add.
+
+        @param shell: The value for the C{pw_shell} field of the user record to
+            add.
+        """
+        if uid is None:
+            uid = self._lastUID
+            self._lastUID += 1
+        if gid is None:
+            gid = self._lastGID
+            self._lastGID += 1
+        newUser = _UserRecord(username, password, uid, gid, gecos, home, shell)
+        self._users.append(newUser)
+
+    def getpwuid(self, uid: int) -> _UserRecord:
+        """
+        Return the user record corresponding to the given uid.
+        """
+        for entry in self._users:
+            if entry.pw_uid == uid:
+                return entry
+        raise KeyError()
+
+    def getpwnam(self, name: str) -> _UserRecord:
+        """
+        Return the user record corresponding to the given username.
+        """
+        if not isinstance(name, str):
+            raise TypeError(f"getpwuam() argument must be str, not {type(name)}")
+        for entry in self._users:
+            if entry.pw_name == name:
+                return entry
+        raise KeyError()
+
+    def getpwall(self) -> List[_UserRecord]:
+        """
+        Return a list of all user records.
+        """
+        return self._users
+
+
+class _ShadowRecord:
+    """
+    L{_ShadowRecord} holds the shadow user data for a single user in
+    L{ShadowDatabase}.  It corresponds to C{spwd.struct_spwd}.  See that class
+    for attribute documentation.
+    """
+
+    def __init__(
+        self,
+        username: str,
+        password: str,
+        lastChange: int,
+        min: int,
+        max: int,
+        warn: int,
+        inact: int,
+        expire: int,
+        flag: int,
+    ) -> None:
+        self.sp_nam = username
+        self.sp_pwd = password
+        self.sp_lstchg = lastChange
+        self.sp_min = min
+        self.sp_max = max
+        self.sp_warn = warn
+        self.sp_inact = inact
+        self.sp_expire = expire
+        self.sp_flag = flag
+
+    def __len__(self) -> int:
+        return 9
+
+    def __getitem__(self, index):
+        return (
+            self.sp_nam,
+            self.sp_pwd,
+            self.sp_lstchg,
+            self.sp_min,
+            self.sp_max,
+            self.sp_warn,
+            self.sp_inact,
+            self.sp_expire,
+            self.sp_flag,
+        )[index]
+
+
+class ShadowDatabase:
+    """
+    L{ShadowDatabase} holds a shadow user database in memory and makes it
+    available via the same API as C{spwd}.
+
+    @ivar _users: A C{list} of L{_ShadowRecord} instances holding all user data
+        added to this database.
+
+    @since: 12.0
+    """
+
+    _users: List[_ShadowRecord]
+
+    def __init__(self) -> None:
+        self._users = []
+
+    def addUser(
+        self,
+        username: str,
+        password: str,
+        lastChange: int,
+        min: int,
+        max: int,
+        warn: int,
+        inact: int,
+        expire: int,
+        flag: int,
+    ) -> None:
+        """
+        Add a new user record to this database.
+
+        @param username: The value for the C{sp_nam} field of the user record to
+            add.
+
+        @param password: The value for the C{sp_pwd} field of the user record to
+            add.
+
+        @param lastChange: The value for the C{sp_lstchg} field of the user
+            record to add.
+
+        @param min: The value for the C{sp_min} field of the user record to add.
+
+        @param max: The value for the C{sp_max} field of the user record to add.
+
+        @param warn: The value for the C{sp_warn} field of the user record to
+            add.
+
+        @param inact: The value for the C{sp_inact} field of the user record to
+            add.
+
+        @param expire: The value for the C{sp_expire} field of the user record
+            to add.
+
+        @param flag: The value for the C{sp_flag} field of the user record to
+            add.
+        """
+        self._users.append(
+            _ShadowRecord(
+                username, password, lastChange, min, max, warn, inact, expire, flag
+            )
+        )
+
+    def getspnam(self, username: str) -> _ShadowRecord:
+        """
+        Return the shadow user record corresponding to the given username.
+        """
+        if not isinstance(username, str):
+            raise TypeError(f"getspnam() argument must be str, not {type(username)}")
+        for entry in self._users:
+            if entry.sp_nam == username:
+                return entry
+        raise KeyError(username)
+
+    def getspall(self):
+        """
+        Return a list of all shadow user records.
+        """
+        return self._users