From 874ee585b7ecc47725095da0974d68106fef51a1 Mon Sep 17 00:00:00 2001 From: Alessandro Mauri Date: Sun, 25 Jul 2021 18:18:14 +0200 Subject: [PATCH] updated readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 2d11b2f..9fb533d 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,21 @@ Opens a shell as a different user without needing to authenticate as that user. This is similar to the behavior of `su` but it allows to execute privileged and/or commands as any other user without needing their password. +It doesn't use PAM, instead relies on shadow files and the passwd database +to check if the given password is correct. Support for different methods of +authentication is planned. + +## Installing + +To install use `make install` and to uninstall use `make uninstall`, all +other documentation is provided as man pages, `man us` will give general +information about the utility and how to use it and `man us.conf` contains +info about the config file format. + +## Supported platforms + +All platforms that store the encrypted password in `/etc/passwd` should be +supported, which to this day are none. Linux is supported through `shadow(3)` +and OpenBSD through its API. Support for more systems is planned. +This program is libc-agnostic as (apart from authentication) it is POSIX +compliant code.