Users

Bases: UserModel

User class representing a user in the system.

create(name, password) classmethod

Creates a new user with the given name and password.

Parameters:

Name	Type	Description	Default
name	str	The username for the new user.	required
password	str	The password for the new user.	required

Raises:

Type	Description
AlreadyExistsException	If the username already exists.
InvalidUsernameException	If the username is invalid.

Returns:

Name	Type	Description
User	User	The created user instance.

Source code in svs_core/users/user.py

@classmethod
def create(cls, name: str, password: str) -> "User":
    """Creates a new user with the given name and password.

    Args:
        name (str): The username for the new user.
        password (str): The password for the new user.

    Raises:
        AlreadyExistsException: If the username already exists.
        InvalidUsernameException: If the username is invalid.

    Returns:
        User: The created user instance.
    """
    if not cls.is_username_valid(name):
        raise InvalidUsernameException(name)
    if not cls.is_password_valid(password):
        raise InvalidPasswordException(password)
    if cls.username_exists(name):
        raise AlreadyExistsException(entity="User", identifier=name)

    user: "User" = cls.objects.create(
        name=name, password=hash_password(password).decode("utf-8")
    )

    DockerNetworkManager.create_network(name, labels={"svs_user": name})
    SystemUserManager.create_user(name, password)

    get_logger(__name__).info(f"Created user: {name}")
    return user

is_username_valid(username) staticmethod

Validates the username based on specific criteria.

The username needs to be a valid UNIX username.

Parameters:

Name	Type	Description	Default
username	str	The username to validate.	required

Returns:

Name	Type	Description
bool	bool	True if the username is valid, False otherwise.

Source code in svs_core/users/user.py

@staticmethod
def is_username_valid(username: str) -> bool:
    """Validates the username based on specific criteria.

    The username needs to be a valid UNIX username.

    Args:
        username (str): The username to validate.

    Returns:
        bool: True if the username is valid, False otherwise.
    """
    if not isinstance(username, str):
        return False
    if len(username) == 0 or len(username) > 32:
        return False

    pattern = r"^[a-z_][a-z0-9_-]{0,30}\$?$"
    return bool(re.match(pattern, username))

is_password_valid(password) staticmethod

Validates the password based on specific criteria.

The password must be at least 8 characters long.

Parameters:

Name	Type	Description	Default
password	str	The password to validate.	required

Returns:

Name	Type	Description
bool	bool	True if the password is valid, False otherwise.

Source code in svs_core/users/user.py

@staticmethod
def is_password_valid(password: str) -> bool:
    """Validates the password based on specific criteria.

    The password must be at least 8 characters long.

    Args:
        password (str): The password to validate.

    Returns:
        bool: True if the password is valid, False otherwise.
    """
    return isinstance(password, str) and len(password) >= 8

username_exists(username) classmethod

Checks if a username already exists in the database.

Parameters:

Name	Type	Description	Default
username	str	The username to check.	required

Returns:

Name	Type	Description
bool	bool	True if the username exists, False otherwise.

Source code in svs_core/users/user.py

@classmethod
def username_exists(cls, username: str) -> bool:
    """Checks if a username already exists in the database.

    Args:
        username (str): The username to check.

    Returns:
        bool: True if the username exists, False otherwise.
    """
    return cast(bool, cls.objects.filter(name=username).exists())

check_password(password)

Checks if the provided password matches the user's password.

Parameters:

Name	Type	Description	Default
password	str	The password to check.	required

Returns:

Name	Type	Description
bool	bool	True if the password matches, False otherwise.

Source code in svs_core/users/user.py

def check_password(self, password: str) -> bool:
    """Checks if the provided password matches the user's password.

    Args:
        password (str): The password to check.

    Returns:
        bool: True if the password matches, False otherwise.
    """
    from svs_core.shared.hash import check_password

    hashed = self.password.encode("utf-8")

    return check_password(password, hashed)

delete()

Deletes the user from the database and removes associated resources.

This includes deleting the system user and Docker network associated with the user.

Source code in svs_core/users/user.py

def delete(self) -> None:
    """Deletes the user from the database and removes associated resources.

    This includes deleting the system user and Docker network
    associated with the user.
    """
    if len(self.services.all()) > 0:
        raise InvalidOperationException(
            f"Cannot delete user '{self.name}' because they have associated services."
        )

    SystemVolumeManager.delete_user_volumes(self.id)
    DockerNetworkManager.delete_network(self.name)
    SystemUserManager.delete_user(self.name)
    super().delete()