the-littlest-jupyterhub/tljh/user.py

"""
User management for tljh.

Supports user creation, deletion & sudo
"""
import pwd
import grp
import subprocess


def ensure_user(username):
    """
    Make sure a given user exists
    """
    # Check if user exists
    try:
        pwd.getpwnam(username)
        # User exists, nothing to do!
        return
    except KeyError:
        # User doesn't exist, time to create!
        pass

    subprocess.check_call([
        'sudo',
        'adduser',
        '--disabled-password',
        '--force-badname',
        '--quiet',
        username
    ])


def remove_user(username):
    """
    Remove user from system if exists
    """
    try:
        pwd.getpwnam(username)
    except KeyError:
        # User doesn't exist, nothing to do
        return

    subprocess.check_call([
        'sudo',
        'deluser',
        '--quiet',
        username
    ])


def ensure_group(groupname):
    """
    Ensure given group exists
    """
    try:
        grp.getgrnam(groupname)
        # Group exists, nothing to do!
        return
    except KeyError:
        pass

    subprocess.check_call([
        'sudo',
        'addgroup',
        '--quiet',
        groupname
    ])


def remove_group(groupname):
    """
    Remove user from system if exists
    """
    try:
        grp.getgrnam(groupname)
    except KeyError:
        # Group doesn't exist, nothing to do
        return

    subprocess.check_call([
        'sudo',
        'delgroup',
        '--quiet',
        groupname
    ])


def ensure_user_group(username, groupname):
    """
    Ensure given user is member of given group

    Group and User must already exist.
    """
    group = grp.getgrnam(groupname)
    if username in group.gr_mem:
        return

    subprocess.check_call([
        'sudo',
        'usermod',
        '--append',
        '--groups',
        groupname,
        username
    ])


def remove_user_group(username, groupname):
    """
    Ensure given user is *not* a member of given group
    """
    group = grp.getgrnam(groupname)
    if username not in group.gr_mem:
        return

    subprocess.check_call([
        'sudo',
        'deluser',
        '--quiet',
        username,
        groupname
    ])