opendoas

my fork of doas with custom prompt
git clone git://git.kocotian.pl/opendoas.git
Log | Files | Refs | README | LICENSE

commit a1d5a98e134a410db728df2400b6c4be102318f0
parent 346e58e98596142ac2f3059814bbc7708b6824fd
Author: Duncan Overbruck <mail@duncano.de>
Date:   Fri, 26 Jul 2019 17:39:27 +0200

README.md: update the readme to match the current state

Diffstat:
MREADME.md | 54++++++++++++++++++++++--------------------------------
1 file changed, 22 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md @@ -1,7 +1,3 @@ -![sandwich](https://cloud.githubusercontent.com/assets/13654546/9128676/a583cd0a-3c9a-11e5-9b4f-e03ab0ba37d7.png) - -Apologies to [Randall Monroe](http://www.xkcd.org/149/). - # OpenDoas: a portable version of OpenBSD's `doas` command `doas` is a minimal replacement for the venerable `sudo`. It was @@ -9,47 +5,41 @@ initially [written by Ted Unangst](http://www.tedunangst.com/flak/post/doas) of the OpenBSD project to provide 95% of the features of `sudo` with a fraction of the codebase. -This is still a work in progress! Please do not deploy yet in a critical -environment! Of note, `doas` semantics may yet change, and I haven't -performed even a trivial security audit of my additions. +At the moment only linux with GLIBC or musl libc is supported and tested. ## Building and installing -Building `doas` should be just a simple `make` away. - -The included makefile also has an installation target. Installation -requires root access to properly set the executable permissions. You'll -also need to install a `doas.conf` file: - ``` -make && sudo make install -echo "permit :admin" | sudo tee /etc/doas.conf +$ ./configure +$ make +# make install ``` -Oh the irony, using `sudo` to install `doas`! - ## About the port +This is not an official port/project from OpenBSD! + As much as possible I've attempted to stick to `doas` as tedu desired it. As things stand it's essentially just code lifted from OpenBSD with -PAM based authentication glommed on to it. +PAM or shadow based authentication glommed on to it. + +Compatibility functions in libopenbsd come from openbsd directly +(`strtonum.c`, `reallocarray.c`, `strlcpy.c`, `strlcat.c`), +from openssh (`readpassphrase.c`) or from sudo (`closefrom.c`). -I've used cvsync and git-cvsimport to retain the history of the core -source files. I may choose to go back and do the same with some of the -compatibility functions (such as reallocarray.c). +The PAM and shadow authentication code does not come from the OpenBSD project. -I have found it necessary to make some fixes to the codebase. One was -a segfault due to differences in yacc/bison, others were just minor -fixes to warnings. Once this appears stable, I may try to upstream some -of these. +### Perist/Timestamp/Timeout -Currently, this is only tested on MacOSX 10.10 with Clang. My next goal -is support for Fedora Linux as well. Contributions gladly accepted. ;-) +The persist feature is disabled by default and can be enabled with the configure +flag `--with-timestamp`. -## Copyright +This feature is new and potentially dangerous, in the original doas, a kernel API +is used to set and clear timeouts. This API is openbsd specific and no similar API +is available on other operating systems. -All code from OpenBSD is licensed under the BSD license, please see -individual files for details as the specific text varies from file to -file. +As a workaround, the persist feature is implemented using timestamp files +similar to sudo. -All code I've written is licensed with the 2-clause BSD. +See the comment block in `timestamp.c` for an in-depth description on how +timestamps are created and checked to be as safe as possible.