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
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:
 
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.
 
 
86
63
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
 
87
64
   | Created (d)             | s    | Read       | N/A                 |
 
88
65
   | Enabled (e)             | b    | Read/Write | N/A                 |
 
 
66
   | Expires (f)             | s    | Read       | N/A                 |
 
 
67
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
 
89
68
   | Fingerprint             | s    | Read       | fingerprint         |
 
90
69
   | Host                    | s    | Read/Write | host                |
 
91
70
   | 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                 |
 
 
71
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
 
72
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
 
73
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
 
74
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
95
75
   | Name                    | s    | Read       | (Section name)      |
 
96
 
   | ObjectPath              | o    | Read       | N/A                 |
 
97
 
   | Secret (i)              | ay   | Write      | secret (or secfile) |
 
 
76
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
98
77
   | Timeout (a)             | t    | Read/Write | timeout             |
 
100
79
   a) Represented as milliseconds.
 
102
81
   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 a RFC 3339 string.
 
109
 
   e) Setting this property is equivalent to calling Enable() or
 
112
 
   f) The time of the last approval request, as a RFC 3339 string, or
 
113
 
      an empty string if this has not happened.
 
115
 
   g) The last time a checker was successful, as a RFC 3339 string, or
 
116
 
      an empty string if this has not happened.  Setting this property
 
117
 
      is equivalent to calling CheckedOK(), i.e. the current time is
 
118
 
      set, regardless of the string sent.  Please always use an empty
 
119
 
      string when setting this property, to allow for possible future
 
122
 
   h) The last time this client was enabled, as a RFC 3339 string, or
 
123
 
      an empty string if this has not happened.
 
125
 
   i) A raw byte array, not hexadecimal digits.
 
 
83
   c) Changing this property can either start a new checker or abort a
 
 
86
   d) The creation time of this client object, as an RFC 3339 string.
 
 
88
   e) Changing this property enables or disables a client.
 
 
90
   f) The date and time this client will be disabled, as an RFC 3339
 
 
91
      string, or an empty string if this is not scheduled.
 
 
93
   g) The date and time of the last approval request, as an RFC 3339
 
 
94
      string, or an empty string if this has not happened.
 
 
96
   h) The date and time a checker was last successful, as an RFC 3339
 
 
97
      string, or an empty string if this has not happened.  Setting
 
 
98
      this property is equivalent to calling CheckedOK(), i.e. the
 
 
99
      current time is set, regardless of the string sent.  Please
 
 
100
      always use an empty string when setting this property, to allow
 
 
101
      for possible future expansion.
 
 
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
 
 
107
      string, or an empty string if this has not happened.
 
 
109
   k) A raw byte array, not hexadecimal digits.
 
128
112
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
 
140
124
    This client will be approved or denied in exactly Timeout
 
141
125
    milliseconds, depending on ApprovedByDefault.  Approve() can now
 
142
126
    usefully be called on this client object.
 
144
 
*** PropertyChanged(s: Property, v: Value)
 
145
 
    The Property on this client has changed to Value.
 
147
128
*** Rejected(s: Reason)
 
148
129
    This client was not given its secret for a specified Reason.
 
152
 
    Copyright © 2010 Teddy Hogeborn
 
153
 
    Copyright © 2010 Björn Påhlsson
 
 
133
    Copyright © 2010-2016 Teddy Hogeborn
 
 
134
    Copyright © 2010-2016 Björn Påhlsson