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