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
 
 
76
53
   "clients.conf", in which case they are fully documented in
 
77
54
   mandos-clients.conf(5).
 
79
 
   | Name                 | Type | Access     | clients.conf        |
 
80
 
   |----------------------+------+------------+---------------------|
 
81
 
   | ApprovedByDefault    | b    | Read/Write | approved_by_default |
 
82
 
   | ApprovalDelay (a)    | t    | Read/Write | approval_delay      |
 
83
 
   | ApprovalDuration (a) | t    | Read/Write | approval_duration   |
 
84
 
   | ApprovalPending (b)  | b    | Read       | N/A                 |
 
85
 
   | Checker              | s    | Read/Write | checker             |
 
86
 
   | CheckerRunning (c)   | b    | Read/Write | N/A                 |
 
87
 
   | Created (d)          | s    | Read       | N/A                 |
 
88
 
   | Enabled (e)          | b    | Read/Write | N/A                 |
 
89
 
   | Fingerprint          | s    | Read       | fingerprint         |
 
90
 
   | Host                 | s    | Read/Write | host                |
 
91
 
   | Interval (a)         | t    | Read/Write | interval            |
 
92
 
   | LastCheckedOK (f)    | s    | Read/Write | N/A                 |
 
93
 
   | LastEnabled (g)      | s    | Read       | N/A                 |
 
94
 
   | Name                 | s    | Read       | (Section name)      |
 
95
 
   | ObjectPath           | o    | Read       | N/A                 |
 
96
 
   | Secret (h)           | ay   | Write      | secret (or secfile) |
 
97
 
   | Timeout (a)          | t    | Read/Write | timeout             |
 
 
56
   | Name                    | Type | Access     | clients.conf        |
 
 
57
   |-------------------------+------+------------+---------------------|
 
 
58
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
 
 
59
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
 
 
60
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
 
 
61
   | ApprovalPending (b)     | b    | Read       | N/A                 |
 
 
62
   | Checker                 | s    | Read/Write | checker             |
 
 
63
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
 
 
64
   | Created (d)             | s    | Read       | N/A                 |
 
 
65
   | Enabled (e)             | b    | Read/Write | N/A                 |
 
 
66
   | Expires (f)             | s    | Read       | N/A                 |
 
 
67
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
 
 
68
   | Fingerprint             | s    | Read       | fingerprint         |
 
 
69
   | Host                    | s    | Read/Write | host                |
 
 
70
   | Interval (a)            | t    | Read/Write | interval            |
 
 
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                 |
 
 
75
   | Name                    | s    | Read       | (Section name)      |
 
 
76
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
 
77
   | Timeout (a)             | t    | Read/Write | timeout             |
 
99
79
   a) Represented as milliseconds.
 
101
81
   b) An approval is currently pending.
 
103
 
   c) Setting this property is equivalent to calling StartChecker() or
 
106
 
   d) The creation time of this client object, as a RFC 3339 string.
 
108
 
   e) Setting this property is equivalent to calling Enable() or
 
111
 
   f) The last time a checker was successful, as a RFC 3339 string, or
 
112
 
      an empty string if this has not happened.  Setting this property
 
113
 
      is equivalent to calling CheckedOK(), i.e. the current time is
 
114
 
      set, regardless of the string sent.  Please always use an empty
 
115
 
      string when setting this property, to allow for possible future
 
118
 
   g) The last time this client was enabled, as a RFC 3339 string, or
 
119
 
      an empty string if this has not happened.
 
121
 
   h) 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.
 
124
112
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
 
136
124
    This client will be approved or denied in exactly Timeout
 
137
125
    milliseconds, depending on ApprovedByDefault.  Approve() can now
 
138
126
    usefully be called on this client object.
 
140
 
*** PropertyChanged(s: Property, v: Value)
 
141
 
    The Property on this client has changed to Value.
 
143
128
*** Rejected(s: Reason)
 
144
129
    This client was not given its secret for a specified Reason.
 
 
133
    Copyright © 2010-2016 Teddy Hogeborn
 
 
134
    Copyright © 2010-2016 Björn Påhlsson
 
 
138
   This program is free software: you can redistribute it and/or
 
 
139
   modify it under the terms of the GNU General Public License as
 
 
140
   published by the Free Software Foundation, either version 3 of the
 
 
141
   License, or (at your option) any later version.
 
 
143
   This program is distributed in the hope that it will be useful, but
 
 
144
   WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
145
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
 
146
   General Public License for more details.
 
 
148
   You should have received a copy of the GNU General Public License
 
 
149
   along with this program.  If not, see
 
 
150
   <http://www.gnu.org/licenses/>.
 
147
153
#+STARTUP: showall