1
-*- mode: org; coding: utf-8 -*-
3
Mandos Server D-Bus Interface
5
This file documents the D-Bus interface to the Mandos server.
8
Bus name: "se.recompile.Mandos"
14
|-----------------------+-------------------|
15
| "/" | The Mandos Server |
16
| "/clients/CLIENTNAME" | Mandos Client |
19
* Mandos Server Interface:
20
Interface name: "se.recompile.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
29
*** RemoveClient(o: ObjectPath) → nothing
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
39
is represented as a string of hexadecimal digits. The address is
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.
46
* Mandos Client Interface:
47
Interface name: "se.recompile.Mandos.Client"
50
*** Approve(b: Approve) → nothing
51
Approve or deny a connected client waiting for approval. If
52
denied, a client will not be sent its secret.
54
*** CheckedOK() → nothing
55
Assert that this client has been checked and found to be alive.
56
This will restart the timeout before disabling this client. See
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.
75
Note: Many of these properties directly correspond to a setting in
76
"clients.conf", in which case they are fully documented in
77
mandos-clients.conf(5).
79
| Name | Type | Access | clients.conf |
80
|-------------------------+------+------------+---------------------|
81
| ApprovedByDefault | b | Read/Write | approved_by_default |
82
| ApprovalDelay (a) | t | Read/Write | approval_delay |
83
| ApprovalDuration (a) | t | Read/Write | approval_duration |
84
| ApprovalPending (b) | b | Read | N/A |
85
| Checker | s | Read/Write | checker |
86
| CheckerRunning (c) | b | Read/Write | N/A |
87
| Created (d) | s | Read | N/A |
88
| Enabled (e) | b | Read/Write | N/A |
89
| Expires (f) | s | Read | N/A |
90
| ExtendedTimeout (a) | t | Read/Write | extended_timeout |
91
| Fingerprint | s | Read | fingerprint |
92
| Host | s | Read/Write | host |
93
| Interval (a) | t | Read/Write | interval |
94
| LastApprovalRequest (g) | s | Read | N/A |
95
| LastCheckedOK (h) | s | Read/Write | N/A |
96
| LastCheckerStatus (i) | n | Read | N/A |
97
| LastEnabled (j) | s | Read | N/A |
98
| Name | s | Read | (Section name) |
99
| ObjectPath | o | Read | N/A |
100
| Secret (k) | ay | Write | secret (or secfile) |
101
| Timeout (a) | t | Read/Write | timeout |
103
a) Represented as milliseconds.
105
b) An approval is currently pending.
107
c) Setting this property is equivalent to calling StartChecker() or
110
d) The creation time of this client object, as an RFC 3339 string.
112
e) Setting this property is equivalent to calling Enable() or
115
f) The date and time this client will be disabled, as an RFC 3339
116
string, or an empty string if this is not scheduled.
118
g) The date and time of the last approval request, as an RFC 3339
119
string, or an empty string if this has not happened.
121
h) The date and time a checker was last successful, as an RFC 3339
122
string, or an empty string if this has not happened. Setting
123
this property is equivalent to calling CheckedOK(), i.e. the
124
current time is set, regardless of the string sent. Please
125
always use an empty string when setting this property, to allow
126
for possible future expansion.
128
i) The exit status of the last checker, -1 if it did not exit
129
cleanly, -2 if a checker has not yet returned.
131
j) The date and time this client was last enabled, as an RFC 3339
132
string, or an empty string if this has not happened.
134
k) A raw byte array, not hexadecimal digits.
137
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
138
A checker (Command) has completed. Exitcode is either the exit
139
code or -1 for abnormal exit. In any case, the full Waitstatus
140
(as from wait(2)) is also available.
142
*** CheckerStarted(s: Command)
143
A checker command (Command) has just been started.
146
This client has been sent its secret.
148
*** NeedApproval(t: Timeout, b: ApprovedByDefault)
149
This client will be approved or denied in exactly Timeout
150
milliseconds, depending on ApprovedByDefault. Approve() can now
151
usefully be called on this client object.
153
*** Rejected(s: Reason)
154
This client was not given its secret for a specified Reason.
158
Copyright © 2010-2012 Teddy Hogeborn
159
Copyright © 2010-2012 Björn Påhlsson
163
This program is free software: you can redistribute it and/or
164
modify it under the terms of the GNU General Public License as
165
published by the Free Software Foundation, either version 3 of the
166
License, or (at your option) any later version.
168
This program is distributed in the hope that it will be useful, but
169
WITHOUT ANY WARRANTY; without even the implied warranty of
170
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
171
General Public License for more details.
173
You should have received a copy of the GNU General Public License
174
along with this program. If not, see
175
<http://www.gnu.org/licenses/>.
added
removed
DBUS-API
