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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
|
-*- mode: org; coding: utf-8 -*-
Mandos Server D-Bus Interface
This file documents the D-Bus interface to the Mandos server.
* Bus: System bus
Bus name: "se.recompile.Mandos"
* Object Paths:
| Path | Object |
|-----------------------+-------------------|
| "/" | The Mandos Server |
(To get a list of paths to client objects, use the standard D-Bus
org.freedesktop.DBus.ObjectManager interface, which the server
object supports.)
* Mandos Server Interface:
Interface name: "se.recompile.Mandos"
** Methods:
*** RemoveClient(o: ObjectPath) → nothing
Removes a client
** Signals:
*** ClientNotFound(s: KeyID, s: Address)
A client connected from Address using KeyID, but was
rejected because it was not found in the server. The key ID
is represented as a string of hexadecimal digits. The address is
an IPv4 or IPv6 address in its normal string format.
* Mandos Client Interface:
Interface name: "se.recompile.Mandos.Client"
** Methods
*** Approve(b: Approve) → nothing
Approve or deny a connected client waiting for approval. If
denied, a client will not be sent its secret.
*** CheckedOK() → nothing
Assert that this client has been checked and found to be alive.
This will restart the timeout before disabling this client. See
also the "LastCheckedOK" property.
** Properties
Note: Many of these properties directly correspond to a setting in
"clients.conf", in which case they are fully documented in
mandos-clients.conf(5).
| Name | Type | Access | clients.conf |
|-------------------------+------+------------+---------------------|
| ApprovalDelay (a) | t | Read/Write | approval_delay |
| ApprovalDuration (a) | t | Read/Write | approval_duration |
| ApprovalPending (b) | b | Read | N/A |
| ApprovedByDefault | b | Read/Write | approved_by_default |
| Checker | s | Read/Write | checker |
| CheckerRunning (c) | b | Read/Write | N/A |
| Created (d) | s | Read | N/A |
| Enabled (e) | b | Read/Write | N/A |
| Expires (f) | s | Read | N/A |
| ExtendedTimeout (a) | t | Read/Write | extended_timeout |
| Fingerprint | s | Read | fingerprint |
| Host | s | Read/Write | host |
| Interval (a) | t | Read/Write | interval |
| KeyID | s | Read | key_id |
| LastApprovalRequest (g) | s | Read | N/A |
| LastCheckedOK (h) | s | Read/Write | N/A |
| LastCheckerStatus (i) | n | Read | N/A |
| LastEnabled (j) | s | Read | N/A |
| Name | s | Read | (Section name) |
| Secret (k) | ay | Write | secret (or secfile) |
| Timeout (a) | t | Read/Write | timeout |
a) Represented as milliseconds.
b) An approval is currently pending.
c) Changing this property can either start a new checker or abort a
running one.
d) The creation time of this client object, as an RFC 3339 string.
e) Changing this property enables or disables a client.
f) The date and time this client will be disabled, as an RFC 3339
string, or an empty string if this is not scheduled.
g) The date and time of the last approval request, as an RFC 3339
string, or an empty string if this has not happened.
h) The date and time a checker was last successful, as an RFC 3339
string, or an empty string if this has not happened. Setting
this property is equivalent to calling CheckedOK(), i.e. the
current time is set, regardless of the string sent. Please
always use an empty string when setting this property, to allow
for possible future expansion.
i) The exit status of the last checker, -1 if it did not exit
cleanly, -2 if a checker has not yet returned.
j) The date and time this client was last enabled, as an RFC 3339
string, or an empty string if this has not happened.
k) A raw byte array, not hexadecimal digits.
** Signals
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
A checker (Command) has completed. Exitcode is either the exit
code or -1 for abnormal exit. In any case, the full Waitstatus
(as from wait(2)) is also available.
*** CheckerStarted(s: Command)
A checker command (Command) has just been started.
*** GotSecret()
This client has been sent its secret.
*** NeedApproval(t: Timeout, b: ApprovedByDefault)
This client will be approved or denied in exactly Timeout
milliseconds, depending on ApprovedByDefault. Approve() can now
usefully be called on this client object.
*** Rejected(s: Reason)
This client was not given its secret for a specified Reason.
* Copyright
Copyright © 2010-2020 Teddy Hogeborn
Copyright © 2010-2020 Björn Påhlsson
** License:
This file is part of Mandos.
Mandos is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Mandos is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with Mandos. If not, see <http://www.gnu.org/licenses/>.
#+STARTUP: showall
|