14
14
|-----------------------+-------------------|
15
15
| "/" | The Mandos Server |
17
(To get a list of paths to client objects, use the standard D-Bus
18
org.freedesktop.DBus.ObjectManager interface, which the server
16
| "/clients/CLIENTNAME" | Mandos Client |
22
19
* Mandos Server Interface:
23
Interface name: "se.recompile.Mandos"
20
Interface name: "se.bsnet.fukt.Mandos"
23
*** GetAllClients() → (ao: Clients)
24
Returns an array of all client D-Bus object paths
26
*** GetAllClientsWithProperties() → (a{oa{sv}}: ClientProperties)
27
Returns an array of all clients and all their properties
26
29
*** RemoveClient(o: ObjectPath) → nothing
30
*** ClientNotFound(s: KeyID, s: Address)
31
A client connected from Address using KeyID, but was
32
rejected because it was not found in the server. The key ID
33
*** ClientAdded(o: ObjectPath)
34
A new client was added.
36
*** ClientNotFound(s: Fingerprint, s: Address)
37
A client connected from Address using Fingerprint, but was
38
rejected because it was not found in the server. The fingerprint
33
39
is represented as a string of hexadecimal digits. The address is
34
40
an IPv4 or IPv6 address in its normal string format.
42
*** ClientRemoved(o: ObjectPath, s: Name)
43
A client named Name on ObjectPath was removed.
37
46
* Mandos Client Interface:
38
Interface name: "se.recompile.Mandos.Client"
47
Interface name: "se.bsnet.fukt.Mandos.Client"
41
50
*** Approve(b: Approve) → nothing
46
55
Assert that this client has been checked and found to be alive.
47
56
This will restart the timeout before disabling this client. See
48
57
also the "LastCheckedOK" property.
59
*** Disable() → nothing
60
Disable this client. See also the "Enabled" property.
62
*** Enable() → nothing
63
Enable this client. See also the "Enabled" property.
65
*** StartChecker() → nothing
66
Start a new checker for this client, if none is currently
67
running. See also the "CheckerRunning" property.
69
*** StopChecker() → nothing
70
Abort a running checker process for this client, if any. See also
71
the "CheckerRunning" property.
56
79
| Name | Type | Access | clients.conf |
57
80
|-------------------------+------+------------+---------------------|
81
| ApprovedByDefault | b | Read/Write | approved_by_default |
58
82
| ApprovalDelay (a) | t | Read/Write | approval_delay |
59
83
| ApprovalDuration (a) | t | Read/Write | approval_duration |
60
84
| ApprovalPending (b) | b | Read | N/A |
61
| ApprovedByDefault | b | Read/Write | approved_by_default |
62
85
| Checker | s | Read/Write | checker |
63
86
| CheckerRunning (c) | b | Read/Write | N/A |
64
87
| Created (d) | s | Read | N/A |
65
88
| Enabled (e) | b | Read/Write | N/A |
66
89
| Expires (f) | s | Read | N/A |
67
| ExtendedTimeout (a) | t | Read/Write | extended_timeout |
68
90
| Fingerprint | s | Read | fingerprint |
69
91
| Host | s | Read/Write | host |
70
92
| Interval (a) | t | Read/Write | interval |
71
| KeyID | s | Read | key_id |
72
93
| LastApprovalRequest (g) | s | Read | N/A |
73
94
| LastCheckedOK (h) | s | Read/Write | N/A |
74
| LastCheckerStatus (i) | n | Read | N/A |
75
| LastEnabled (j) | s | Read | N/A |
95
| LastEnabled (i) | s | Read | N/A |
76
96
| Name | s | Read | (Section name) |
77
| Secret (k) | ay | Write | secret (or secfile) |
97
| ObjectPath | o | Read | N/A |
98
| Secret (j) | ay | Write | secret (or secfile) |
78
99
| Timeout (a) | t | Read/Write | timeout |
80
101
a) Represented as milliseconds.
82
103
b) An approval is currently pending.
84
c) Changing this property can either start a new checker or abort a
105
c) Setting this property is equivalent to calling StartChecker() or
87
108
d) The creation time of this client object, as an RFC 3339 string.
89
e) Changing this property enables or disables a client.
110
e) Setting this property is equivalent to calling Enable() or
91
113
f) The date and time this client will be disabled, as an RFC 3339
92
string, or an empty string if this is not scheduled.
94
g) The date and time of the last approval request, as an RFC 3339
95
string, or an empty string if this has not happened.
97
h) The date and time a checker was last successful, as an RFC 3339
98
string, or an empty string if this has not happened. Setting
99
this property is equivalent to calling CheckedOK(), i.e. the
100
current time is set, regardless of the string sent. Please
101
always use an empty string when setting this property, to allow
102
for possible future expansion.
104
i) The exit status of the last checker, -1 if it did not exit
105
cleanly, -2 if a checker has not yet returned.
107
j) The date and time this client was last enabled, as an RFC 3339
108
string, or an empty string if this has not happened.
110
k) A raw byte array, not hexadecimal digits.
114
string, or an empty string if this has not happened.
116
g) The time of the last approval request, as an RFC 3339 string, or
117
an empty string if this has not happened.
119
h) The last time a checker was successful, as an RFC 3339 string,
120
or an empty string if this has not happened. Setting this
121
property is equivalent to calling CheckedOK(), i.e. the current
122
time is set, regardless of the string sent. Please always use
123
an empty string when setting this property, to allow for
124
possible future expansion.
126
i) The last time this client was enabled, as an RFC 3339 string, or
127
an empty string if this has not happened.
129
j) A raw byte array, not hexadecimal digits.
113
132
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
126
145
milliseconds, depending on ApprovedByDefault. Approve() can now
127
146
usefully be called on this client object.
148
*** PropertyChanged(s: Property, v: Value)
149
The Property on this client has changed to Value.
129
151
*** Rejected(s: Reason)
130
152
This client was not given its secret for a specified Reason.
134
Copyright © 2010-2019 Teddy Hogeborn
135
Copyright © 2010-2019 Björn Påhlsson
156
Copyright © 2010-2011 Teddy Hogeborn
157
Copyright © 2010-2011 Björn Påhlsson
139
This file is part of Mandos.
141
Mandos is free software: you can redistribute it and/or modify it
142
under the terms of the GNU General Public License as published by
143
the Free Software Foundation, either version 3 of the License, or
144
(at your option) any later version.
146
Mandos is distributed in the hope that it will be useful, but
161
This program is free software: you can redistribute it and/or
162
modify it under the terms of the GNU General Public License as
163
published by the Free Software Foundation, either version 3 of the
164
License, or (at your option) any later version.
166
This program is distributed in the hope that it will be useful, but
147
167
WITHOUT ANY WARRANTY; without even the implied warranty of
148
168
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
149
169
General Public License for more details.
151
171
You should have received a copy of the GNU General Public License
152
along with Mandos. If not, see <http://www.gnu.org/licenses/>.
172
along with this program. If not, see
173
<http://www.gnu.org/licenses/>.
155
176
#+STARTUP: showall
added
removed
DBUS-API
