14
14
  |-----------------------+-------------------|
 
15
15
  | "/"                   | The Mandos Server |
 
16
 
  | "/clients/CLIENTNAME" | Mandos Client     |
 
 
17
  (To get a list of paths to client objects, use the standard D-Bus
 
 
18
  org.freedesktop.DBus.ObjectManager interface, which the server
 
19
22
* Mandos Server Interface:
 
20
 
  Interface name: "se.bsnet.fukt.Mandos"
 
 
23
  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
26
*** 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
 
 
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
 
39
33
    is represented as a string of hexadecimal digits.  The address is
 
40
34
    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
37
* Mandos Client Interface:
 
47
 
  Interface name: "se.bsnet.fukt.Mandos.Client"
 
 
38
  Interface name: "se.recompile.Mandos.Client"
 
50
41
*** Approve(b: Approve) → nothing
 
 
55
46
    Assert that this client has been checked and found to be alive.
 
56
47
    This will restart the timeout before disabling this client.  See
 
57
48
    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.
 
 
79
56
   | Name                    | Type | Access     | clients.conf        |
 
80
57
   |-------------------------+------+------------+---------------------|
 
81
 
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
 
82
58
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
 
83
59
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
 
84
60
   | ApprovalPending (b)     | b    | Read       | N/A                 |
 
 
61
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
 
85
62
   | Checker                 | s    | Read/Write | checker             |
 
86
63
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
 
87
64
   | Created (d)             | s    | Read       | N/A                 |
 
 
91
68
   | Fingerprint             | s    | Read       | fingerprint         |
 
92
69
   | Host                    | s    | Read/Write | host                |
 
93
70
   | Interval (a)            | t    | Read/Write | interval            |
 
 
71
   | KeyID                   | s    | Read       | key_id              |
 
94
72
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
95
73
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
96
 
   | LastEnabled (i)         | s    | Read       | N/A                 |
 
 
74
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
 
75
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
97
76
   | Name                    | s    | Read       | (Section name)      |
 
98
 
   | ObjectPath              | o    | Read       | N/A                 |
 
99
 
   | Secret (j)              | ay   | Write      | secret (or secfile) |
 
 
77
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
100
78
   | Timeout (a)             | t    | Read/Write | timeout             |
 
102
80
   a) Represented as milliseconds.
 
104
82
   b) An approval is currently pending.
 
106
 
   c) Setting this property is equivalent to calling StartChecker() or
 
 
84
   c) Changing this property can either start a new checker or abort a
 
109
87
   d) The creation time of this client object, as an RFC 3339 string.
 
111
 
   e) Setting this property is equivalent to calling Enable() or
 
 
89
   e) Changing this property enables or disables a client.
 
114
91
   f) The date and time this client will be disabled, as an RFC 3339
 
115
 
      string, or an empty string if this has not happened.
 
 
92
      string, or an empty string if this is not scheduled.
 
117
94
   g) The date and time of the last approval request, as an RFC 3339
 
118
95
      string, or an empty string if this has not happened.
 
 
124
101
      always use an empty string when setting this property, to allow
 
125
102
      for possible future expansion.
 
127
 
   i) The date and time this client was last enabled, as an RFC 3339
 
 
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
 
128
108
      string, or an empty string if this has not happened.
 
130
 
   j) A raw byte array, not hexadecimal digits.
 
 
110
   k) A raw byte array, not hexadecimal digits.
 
133
113
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
 
146
126
    milliseconds, depending on ApprovedByDefault.  Approve() can now
 
147
127
    usefully be called on this client object.
 
149
 
*** PropertyChanged(s: Property, v: Value)
 
150
 
    The Property on this client has changed to Value.
 
152
129
*** Rejected(s: Reason)
 
153
130
    This client was not given its secret for a specified Reason.
 
157
 
    Copyright © 2010-2011 Teddy Hogeborn
 
158
 
    Copyright © 2010-2011 Björn Påhlsson
 
 
134
    Copyright © 2010-2020 Teddy Hogeborn
 
 
135
    Copyright © 2010-2020 Björn Påhlsson
 
162
 
   This program is free software: you can redistribute it and/or
 
163
 
   modify it under the terms of the GNU General Public License as
 
164
 
   published by the Free Software Foundation, either version 3 of the
 
165
 
   License, or (at your option) any later version.
 
167
 
   This program is distributed in the hope that it will be useful, but
 
 
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
 
168
147
   WITHOUT ANY WARRANTY; without even the implied warranty of
 
169
148
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
170
149
   General Public License for more details.
 
172
151
   You should have received a copy of the GNU General Public License
 
173
 
   along with this program.  If not, see
 
174
 
   <http://www.gnu.org/licenses/>.
 
 
152
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
177
155
#+STARTUP: showall