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
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
30
*** ClientNotFound(s: Fingerprint, s: Address)
 
37
31
    A client connected from Address using Fingerprint, but was
 
38
32
    rejected because it was not found in the server.  The fingerprint
 
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:
 
 
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.
 
 
93
70
   | Interval (a)            | t    | Read/Write | interval            |
 
94
71
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
95
72
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
96
 
   | LastEnabled (i)         | s    | Read       | N/A                 |
 
 
73
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
 
74
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
97
75
   | Name                    | s    | Read       | (Section name)      |
 
98
 
   | ObjectPath              | o    | Read       | N/A                 |
 
99
 
   | Secret (j)              | ay   | Write      | secret (or secfile) |
 
 
76
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
100
77
   | Timeout (a)             | t    | Read/Write | timeout             |
 
102
79
   a) Represented as milliseconds.
 
104
81
   b) An approval is currently pending.
 
106
 
   c) Setting this property is equivalent to calling StartChecker() or
 
 
83
   c) Changing this property can either start a new checker or abort a
 
109
86
   d) The creation time of this client object, as an RFC 3339 string.
 
111
 
   e) Setting this property is equivalent to calling Enable() or
 
 
88
   e) Changing this property enables or disables a client.
 
114
90
   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.
 
 
91
      string, or an empty string if this is not scheduled.
 
117
93
   g) The date and time of the last approval request, as an RFC 3339
 
118
94
      string, or an empty string if this has not happened.
 
 
124
100
      always use an empty string when setting this property, to allow
 
125
101
      for possible future expansion.
 
127
 
   i) The date and time this client was last enabled, as an RFC 3339
 
 
103
   i) The exit status of the last checker, -1 if it did not exit
 
 
104
      cleanly, -2 if a checker has not yet returned.
 
 
106
   j) The date and time this client was last enabled, as an RFC 3339
 
128
107
      string, or an empty string if this has not happened.
 
130
 
   j) A raw byte array, not hexadecimal digits.
 
 
109
   k) A raw byte array, not hexadecimal digits.
 
133
112
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
 
146
125
    milliseconds, depending on ApprovedByDefault.  Approve() can now
 
147
126
    usefully be called on this client object.
 
149
 
*** PropertyChanged(s: Property, v: Value)
 
150
 
    The Property on this client has changed to Value.
 
152
128
*** Rejected(s: Reason)
 
153
129
    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
 
 
133
    Copyright © 2010-2016 Teddy Hogeborn
 
 
134
    Copyright © 2010-2016 Björn Påhlsson