From 372dde541bf0d1d3aecd560579172f8ae0573660 Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Mon, 3 May 2021 14:22:57 -0400 Subject: [PATCH] Update README --- README.md | 39 ++++++++++----------------------------- 1 file changed, 10 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 104cf7d..b076496 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,31 @@ # OpenDoas - > a portable version of OpenBSD's `doas` command -`doas` is a minimal replacement for the venerable `sudo`. It was -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. +`doas` is a minimal replacement for the venerable `sudo`. It was 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 fork insults you, similar to `sudo`. To enable, add the "insult" option -to your `doas.conf` +This fork insults you, similar to how `sudo` can. To enable, add the "insult" option to your `doas.conf` ## Building and installation discouragements +There are a few steps you have to carefully consider before building and installing opendoas: -There are a few steps you have to carefully consider before building and installing -opendoas: - -* There are less eyes on random doas ports, just because sudo had a vulnerability - does not mean random doas ports are more secure if they are not reviewed. +* There are less eyes on random doas ports, just because sudo had a vulnerability does not mean random doas ports are more secure if they are not reviewed. * Use the configure script. * Use the default make target. ## 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 -shadow based authentication glommed on to it. +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 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`). +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`). The shadow authentication code does not come from the OpenBSD project. ### Persist/Timestamp/Timeout +The persist feature is disabled by default and can be enabled with the configure flag `--with-timestamp`. -The persist feature is disabled by default and can be enabled with the configure -flag `--with-timestamp`. - -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. +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. -As a workaround, the persist feature is implemented using timestamp files -similar to sudo. +As a workaround, the persist feature is implemented using timestamp files similar to sudo. -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. +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. -- 2.39.2