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.bsnet.fukt.Mandos"
14
|-----------------------+-------------------|
15
| "/" | The Mandos Server |
16
| "/clients/CLIENTNAME" | Mandos Client |
19
* Mandos Server Interface:
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
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.bsnet.fukt.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
| Fingerprint | s | Read | fingerprint |
90
| Host | s | Read/Write | host |
91
| Interval (a) | t | Read/Write | interval |
92
| LastApprovalRequest (f) | s | Read | N/A |
93
| LastCheckedOK (g) | s | Read/Write | N/A |
94
| LastEnabled (h) | s | Read | N/A |
95
| Name | s | Read | (Section name) |
96
| ObjectPath | o | Read | N/A |
97
| Secret (i) | ay | Write | secret (or secfile) |
98
| Timeout (a) | t | Read/Write | timeout |
100
a) Represented as milliseconds.
102
b) An approval is currently pending.
104
c) Setting this property is equivalent to calling StartChecker() or
107
d) The creation time of this client object, as an RFC 3339 string.
109
e) Setting this property is equivalent to calling Enable() or
112
f) The time of the last approval request, as an RFC 3339 string, or
113
an empty string if this has not happened.
115
g) The last time a checker was successful, as an RFC 3339 string,
116
or an empty string if this has not happened. Setting this
117
property is equivalent to calling CheckedOK(), i.e. the current
118
time is set, regardless of the string sent. Please always use
119
an empty string when setting this property, to allow for
120
possible future expansion.
122
h) The last time this client was enabled, as an RFC 3339 string, or
123
an empty string if this has not happened.
125
i) A raw byte array, not hexadecimal digits.
128
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
129
A checker (Command) has completed. Exitcode is either the exit
130
code or -1 for abnormal exit. In any case, the full Waitstatus
131
(as from wait(2)) is also available.
133
*** CheckerStarted(s: Command)
134
A checker command (Command) has just been started.
137
This client has been sent its secret.
139
*** NeedApproval(t: Timeout, b: ApprovedByDefault)
140
This client will be approved or denied in exactly Timeout
141
milliseconds, depending on ApprovedByDefault. Approve() can now
142
usefully be called on this client object.
144
*** PropertyChanged(s: Property, v: Value)
145
The Property on this client has changed to Value.
147
*** Rejected(s: Reason)
148
This client was not given its secret for a specified Reason.
152
Copyright © 2010-2011 Teddy Hogeborn
153
Copyright © 2010-2011 Björn Påhlsson
157
This program is free software: you can redistribute it and/or
158
modify it under the terms of the GNU General Public License as
159
published by the Free Software Foundation, either version 3 of the
160
License, or (at your option) any later version.
162
This program is distributed in the hope that it will be useful, but
163
WITHOUT ANY WARRANTY; without even the implied warranty of
164
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
165
General Public License for more details.
167
You should have received a copy of the GNU General Public License
168
along with this program. If not, see
169
<http://www.gnu.org/licenses/>.
added
removed
DBUS-API
