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
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
 
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:
 
 
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                 |
 
 
68
91
   | Fingerprint             | s    | Read       | fingerprint         |
 
69
92
   | Host                    | s    | Read/Write | host                |
 
70
93
   | Interval (a)            | t    | Read/Write | interval            |
 
71
 
   | KeyID                   | s    | Read       | key_id              |
 
72
94
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
73
95
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
74
96
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
75
97
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
76
98
   | Name                    | s    | Read       | (Section name)      |
 
 
99
   | ObjectPath              | o    | Read       | N/A                 |
 
77
100
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
78
101
   | Timeout (a)             | t    | Read/Write | timeout             |
 
 
82
105
   b) An approval is currently pending.
 
84
 
   c) Changing this property can either start a new checker or abort a
 
 
107
   c) Setting this property is equivalent to calling StartChecker() or
 
87
110
   d) The creation time of this client object, as an RFC 3339 string.
 
89
 
   e) Changing this property enables or disables a client.
 
 
112
   e) Setting this property is equivalent to calling Enable() or
 
91
115
   f) The date and time this client will be disabled, as an RFC 3339
 
92
116
      string, or an empty string if this is not scheduled.
 
 
134
 
    Copyright © 2010-2019 Teddy Hogeborn
 
135
 
    Copyright © 2010-2019 Björn Påhlsson
 
 
158
    Copyright © 2010-2012 Teddy Hogeborn
 
 
159
    Copyright © 2010-2012 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
 
 
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
 
147
169
   WITHOUT ANY WARRANTY; without even the implied warranty of
 
148
170
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
149
171
   General Public License for more details.
 
151
173
   You should have received a copy of the GNU General Public License
 
152
 
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
 
174
   along with this program.  If not, see
 
 
175
   <http://www.gnu.org/licenses/>.
 
155
178
#+STARTUP: showall