shadow

type Group struct {
	Name string
	GID  int
	// Members are the users listed as supplementary members.
	Members []string
}

type GroupSpec struct {
	Name string
	GID  *int
}

type Options struct {
	// Root is the directory containing etc/passwd and etc/group, e.g. a jail.
	// Empty means "/".
	// Busybox does not support a root other than "/".
	Root string
}

type Service interface {
	// User returns the named user, nil when it does not exist.
	User(name string) (*User, error)
	// Group returns the named group, nil when it does not exist.
	Group(name string) (*Group, error)
	// Users returns all users in file order.
	Users() ([]User, error)
	// Groups returns all groups in file order.
	Groups() ([]Group, error)
	// ApplyUser creates or modifies the user.
	ApplyUser(ctx context.Context, desired UserSpec) error
	// DeleteUser deletes the user.
	// removeHome also removes the home. Note that home removal is
	// governed by the backing tool and not by the package.
	DeleteUser(ctx context.Context, name string, removeHome bool) error
	// ApplyGroup creates or modifies the group.
	ApplyGroup(ctx context.Context, desired GroupSpec) error
	// DeleteGroup deletes the group.
	DeleteGroup(ctx context.Context, name string) error
	// AddMember adds the user as supplementary member of the group.
	AddMember(ctx context.Context, user, group string) error
	// RemoveMember removes the user as supplementary member of the group.
	RemoveMember(ctx context.Context, user, group string) error
}

type User struct {
	Name string
	UID  int
	GID  int
	// Group is the primary group name, empty when GID resolves to no group.
	Group string
	// Groups are the supplementary groups listing the user as a member.
	Groups []string
	Home   string
	Shell  string
}

type UserSpec struct {
	Name string
	UID  *int
	// Group empty applies the tool default on creation.
	Group string
	// Groups is the complete set of supplementary groups.
	// Nil is unmanaged, empty removes all supplementary groups.
	Groups []string
	// Home empty applies the tool default on creation.
	Home string
	// Shell empty applies the tool default on creation.
	Shell string
}