Update README: When to use raou, clarifications

This commit is contained in:
Albert S. 2020-09-26 19:13:48 +02:00
parent ac315529b3
commit 30f3002bda
1 changed files with 20 additions and 13 deletions

View File

@ -7,9 +7,16 @@ specified by the administrator.
Originally written in C, it's now reimplemented in Rust. Originally written in C, it's now reimplemented in Rust.
By default, raou looks in /etc/raou.d/ for config files. If you run ### When to use raou (over sudo)
"raou backup", it will look for /etc/raou.d/backup. Generally, it's not a replacement for sudo. The primary use case of raou is a situation in which you would want to allow a user to run a privileged operation as root without entering passwords. You may not want to use sudo for that, particularly if you don't have it installed already. Some further arguments for raou:
- Simpler config
- Less complexity, less attack surface
- Writte in a memory-safe language
### Config
By default, raou looks in ```/etc/raou.d/``` for config files. If you run
"raou backup", it will look for ```/etc/raou.d/backup```.
Example config file: Example config file:
``` ```
user john user john
@ -20,29 +27,29 @@ path /usr/local/bin/script.sh
**user** is the name of the user who you want to give permissions to **user** is the name of the user who you want to give permissions to
execute **path** as the **target_user**. execute **path** as the **target_user**.
**path** must contain the absolute path. **path** must contain the absolute path of the to be executed command.
Optional fields #### Optional fields
---------------
**args**: If you want to leave out optional arguments (argv) to *path*, **args** (string): If you want to leave out optional arguments (argv) to *path*,
simply don't include this. Otherwise, simply specify them simply don't include this. Otherwise, specify them here.
``` ```
... ...
args -v -ltr args -v -ltr
``` ```
**allow_args**: Allow arbitrary arguments, so: **allow_args** (1 or 0, default 0): Allow arbitrary arguments, so:
``` ```
raou backup /path raou backup /path
``` ```
Will launch "path" as specified in the file for the backup entry with "/path" as argv[1] instead of the argument specified with "args" in the config file. Will execute the command specified in **path** of the ```backup``` entry with "/path" as argv[1] instead of the argument specified with "args" in the config file.
**no_new_privs**: Defaults to 1. Processes launched with this option active **no_new_privs** (1 or 0, default 1): Processes launched with this option active
won't be able to gain more privileges, even when they call setuid programs. won't be able to gain more privileges, even when they call setuid programs. This can break some programs.
**env_vars**: A comma-separated list of environment variables to inherit **env_vars** (string): A comma-separated list of environment variables to inherit
from the current environment. Everything else will be wiped (but others from the current environment. Everything else will be wiped (but others
like HOME, SHELL etc. will be appropriately set). like HOME, SHELL etc. will be appropriately set).
**argv0**: Set this option if you want to provide your own value as "argv0" **argv0** (string): Set this option if you want to provide your own value as "argv0"
The default is the name of the launched binary (not the whole path). The default is the name of the launched binary (not the whole path).