README: rename to README.adoc
[ptyas/ptyas.git] / README.adoc
1 README
2 ======
3
4 ptyas is a small su/sudo replacement which prevents TTY hijacking by starting
5 a new session with a separate terminal and proxying all input.
6
7 It must be run as root and changes the owner to the specified user name,
8 permanently dropping all root permissions.
9
10 For details about the possible attacks see
11 https://ruderich.org/simon/notes/su-sudo-from-root-tty-hijacking
12
13 ptyas is licensed under AGPL version 3 or later.
14
15
16 DEPENDENCIES
17 ------------
18
19 - C99 compiler
20 - UNIX 98 pseudoterminals
21
22
23 USAGE
24 -----
25
26     ptyas <user> [<command...>]
27
28 If no command is given, the user's shell is started. Otherwise the command is
29 executed (which is useful if the user's shell is disabled).
30
31
32 BUGS
33 ----
34
35 If you find any bugs not mentioned in this document please report them to
36 <simon@ruderich.org> with ptyas in the subject.
37
38
39 AUTHORS
40 -------
41
42 Written by Simon Ruderich <simon@ruderich.org>.
43
44
45 LICENSE
46 -------
47
48 ptyas is licensed under AGPL version 3 or later.
49
50 Copyright (C) 2016-2019  Simon Ruderich
51
52 This program is free software: you can redistribute it and/or modify
53 it under the terms of the GNU Affero General Public License as published by
54 the Free Software Foundation, either version 3 of the License, or
55 (at your option) any later version.
56
57 This program is distributed in the hope that it will be useful,
58 but WITHOUT ANY WARRANTY; without even the implied warranty of
59 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
60 GNU Affero General Public License for more details.
61
62 You should have received a copy of the GNU Affero General Public License
63 along with this program.  If not, see <https://www.gnu.org/licenses/>.