aboutsummaryrefslogtreecommitdiffstats
path: root/key2root-rmkey.8
blob: ce9375477d302fce9b72ebebe66710fe54a7afb6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
.TH KEY2ROOT 8 key2root-rmkey

.SH NAME
key2root-rmkey - remove keyfiles for privilege escalation with key2root

.SH SYNOPSIS
.B key2root-rmkey
.I user
.IR key-name \ ...

.SH DESCRIPTION
The
.B key2root-rmkey
utility removes a keyfile from the database of keyfiles that may
be used to authenticate the specified
.I user
for privilege escalation with the
.BR key2root (8)
utility.

.SH OPTIONS
The
.B key2root-rmkey
utility conforms to the Base Definitions volume of POSIX.1-2017,
.IR "Section 12.2" ,
.IR "Utility Syntax Guidelines" .
.PP
No options are supported.

.SH OPERANDS
The following operands are supported:
.TP
.I user
The user the keyfile shall be removed for. This can either
be a user ID or a user name. See
.BR NOTES .
.TP
.I key-name
The name the keyfile to remove.

.SH STDIN
The
.B key2root-rmkey
utility does not use the standard input.

.SH INPUT FILES
None.

.SH ENVIRONMENT VARIABLES
No environment variables affect the execution of
.BR key2root-rmkey .

.SH ASYNCHRONOUS EVENTS
Default.

.SH STDOUT
The
.B key2root-rmkey
utility does not use the standard output.

.SH STDERR
The standard error is used for diagnostic messages.

.SH OUTPUT FILES
None.

.SH EXTENDED DESCRIPTION
None.

.SH EXIT STATUS
If the
.B key2root-rmkey
utility fails it will exit with one of the following statuses:
.TP
0
Successful completion.
.TP
1
A error occurred.

.SH CONSEQUENCES OF ERRORS
Default.

.SH APPLICATION USAGE
None.

.SH EXAMPLES
None.

.SH RATIONALE
None.

.SH NOTES
Keyfiles added by user ID and by user names are stored separatedly.
If a keyfile was added with a user name specified, it is only
associated with the user name, and the user name must be specified
when removing it. Likewise if a keyfile was added with a user ID
specified, it is only associated with the user ID, and the user ID
must be specified when removing it.
.PP
To completely remove a user, remove
.BI /etc/key2root/ user-id
and
.BR /etc/key2root/ \fIuser-name\fP.

.SH BUGS
None.

.SH FUTURE DIRECTIONS
None.

.SH SEE ALSO
.BR key2root (8),
.BR key2root-addkey (8),
.BR key2root-crypt (8),
.BR key2root-lskeys (8)

.SH AUTHORS
Mattias Andrée
.RI < maandree@kth.se >