/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
237.2.186 by Teddy Hogeborn
Documentation changes:
1
		   -*- mode: org; coding: utf-8 -*-
2
3
		    Mandos Server D-Bus Interface
4
5
This file documents the D-Bus interface to the Mandos server.
6
7
* Bus: System bus
24.1.186 by Björn Påhlsson
transitional stuff actually working
8
  Bus name: "se.recompile.Mandos"
237.2.186 by Teddy Hogeborn
Documentation changes:
9
10
11
* Object Paths:
12
  
13
  | Path                  | Object            |
14
  |-----------------------+-------------------|
15
  | "/"                   | The Mandos Server |
16
  | "/clients/CLIENTNAME" | Mandos Client     |
17
18
  
19
* Mandos Server Interface:
24.1.186 by Björn Påhlsson
transitional stuff actually working
20
  Interface name: "se.recompile.Mandos"
237.2.186 by Teddy Hogeborn
Documentation changes:
21
  
22
** Methods:
23
*** GetAllClients()  (ao: Clients)
24
    Returns an array of all client D-Bus object paths
25
   
26
*** GetAllClientsWithProperties()  (a{oa{sv}}: ClientProperties)
27
    Returns an array of all clients and all their properties
28
   
29
*** RemoveClient(o: ObjectPath)  nothing
30
    Removes a client
31
   
32
** Signals:
33
*** ClientAdded(o: ObjectPath)
34
    A new client was added.
35
   
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
39
    is represented as a string of hexadecimal digits.  The address is
40
    an IPv4 or IPv6 address in its normal string format.
41
   
42
*** ClientRemoved(o: ObjectPath, s: Name)
43
    A client named Name on ObjectPath was removed.
44
45
46
* Mandos Client Interface:
24.1.186 by Björn Påhlsson
transitional stuff actually working
47
  Interface name: "se.recompile.Mandos.Client"
237.2.186 by Teddy Hogeborn
Documentation changes:
48
  
49
** Methods
50
*** Approve(b: Approve)  nothing
51
    Approve or deny a connected client waiting for approval.  If
52
    denied, a client will not be sent its secret.
53
    
54
*** CheckedOK()  nothing
55
    Assert that this client has been checked and found to be alive.
56
    This will restart the timeout before disabling this client.  See
57
    also the "LastCheckedOK" property.
58
59
** Properties
60
   
61
   Note: Many of these properties directly correspond to a setting in
62
   "clients.conf", in which case they are fully documented in
63
   mandos-clients.conf(5).
64
   
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
65
   | Name                    | Type | Access     | clients.conf        |
66
   |-------------------------+------+------------+---------------------|
67
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
68
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
69
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
70
   | ApprovalPending (b)     | b    | Read       | N/A                 |
71
   | Checker                 | s    | Read/Write | checker             |
72
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
73
   | Created (d)             | s    | Read       | N/A                 |
74
   | Enabled (e)             | b    | Read/Write | N/A                 |
24.1.179 by Björn Påhlsson
New feature:
75
   | Expires (f)             | s    | Read       | N/A                 |
237.7.45 by Teddy Hogeborn
* DBUS-API: Document new "Expires" and "ExtendedTimeout" properties.
76
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
77
   | Fingerprint             | s    | Read       | fingerprint         |
78
   | Host                    | s    | Read/Write | host                |
79
   | Interval (a)            | t    | Read/Write | interval            |
24.1.179 by Björn Påhlsson
New feature:
80
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
81
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
237.7.104 by Teddy Hogeborn
* DBUS-API (se.recompile.Mandos.Client.LastCheckerStatus): New
82
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
83
   | LastEnabled (j)         | s    | Read       | N/A                 |
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
84
   | Name                    | s    | Read       | (Section name)      |
85
   | ObjectPath              | o    | Read       | N/A                 |
237.7.104 by Teddy Hogeborn
* DBUS-API (se.recompile.Mandos.Client.LastCheckerStatus): New
86
   | Secret (k)              | ay   | Write      | secret (or secfile) |
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
87
   | Timeout (a)             | t    | Read/Write | timeout             |
237.2.186 by Teddy Hogeborn
Documentation changes:
88
   
89
   a) Represented as milliseconds.
90
   
91
   b) An approval is currently pending.
92
   
237.7.329 by Teddy Hogeborn
Deprecate some D-Bus methods in favor of D-Bus properties.
93
   c) Changing this property can either start a new checker or abort a
94
      running one.
237.2.186 by Teddy Hogeborn
Documentation changes:
95
   
237.7.25 by Teddy Hogeborn
* DBUS-API: Fix grammar.
96
   d) The creation time of this client object, as an RFC 3339 string.
237.2.186 by Teddy Hogeborn
Documentation changes:
97
   
237.7.329 by Teddy Hogeborn
Deprecate some D-Bus methods in favor of D-Bus properties.
98
   e) Changing this property enables or disables a client.
237.2.186 by Teddy Hogeborn
Documentation changes:
99
   
24.1.179 by Björn Påhlsson
New feature:
100
   f) The date and time this client will be disabled, as an RFC 3339
237.14.3 by Teddy Hogeborn
Make "enabled" a client config option.
101
      string, or an empty string if this is not scheduled.
24.1.179 by Björn Påhlsson
New feature:
102
   
237.7.45 by Teddy Hogeborn
* DBUS-API: Document new "Expires" and "ExtendedTimeout" properties.
103
   g) The date and time of the last approval request, as an RFC 3339
104
      string, or an empty string if this has not happened.
105
   
106
   h) The date and time a checker was last successful, as an RFC 3339
107
      string, or an empty string if this has not happened.  Setting
108
      this property is equivalent to calling CheckedOK(), i.e. the
109
      current time is set, regardless of the string sent.  Please
110
      always use an empty string when setting this property, to allow
111
      for possible future expansion.
112
   
237.7.104 by Teddy Hogeborn
* DBUS-API (se.recompile.Mandos.Client.LastCheckerStatus): New
113
   i) The exit status of the last checker, -1 if it did not exit
114
      cleanly, -2 if a checker has not yet returned.
115
   
116
   j) The date and time this client was last enabled, as an RFC 3339
237.7.45 by Teddy Hogeborn
* DBUS-API: Document new "Expires" and "ExtendedTimeout" properties.
117
      string, or an empty string if this has not happened.
237.2.186 by Teddy Hogeborn
Documentation changes:
118
   
237.7.104 by Teddy Hogeborn
* DBUS-API (se.recompile.Mandos.Client.LastCheckerStatus): New
119
   k) A raw byte array, not hexadecimal digits.
237.2.186 by Teddy Hogeborn
Documentation changes:
120
121
** Signals
237.24.1 by Teddy Hogeborn
mandos: Use multiprocessing module to run checkers.
122
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
237.2.186 by Teddy Hogeborn
Documentation changes:
123
    A checker (Command) has completed.  Exitcode is either the exit
237.24.1 by Teddy Hogeborn
mandos: Use multiprocessing module to run checkers.
124
    code or -1 for abnormal exit, in which case, the signal number
125
    is available.
237.2.186 by Teddy Hogeborn
Documentation changes:
126
    
127
*** CheckerStarted(s: Command)
128
    A checker command (Command) has just been started.
129
    
130
*** GotSecret()
131
    This client has been sent its secret.
132
    
133
*** NeedApproval(t: Timeout, b: ApprovedByDefault)
134
    This client will be approved or denied in exactly Timeout
135
    milliseconds, depending on ApprovedByDefault.  Approve() can now
136
    usefully be called on this client object.
237.7.25 by Teddy Hogeborn
* DBUS-API: Fix grammar.
137
    
237.2.186 by Teddy Hogeborn
Documentation changes:
138
*** Rejected(s: Reason)
139
    This client was not given its secret for a specified Reason.
140
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
141
* Copyright
142
237.24.1 by Teddy Hogeborn
mandos: Use multiprocessing module to run checkers.
143
    Copyright © 2010-2015 Teddy Hogeborn
144
    Copyright © 2010-2015 Björn Påhlsson
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
145
  
146
** License:
147
   
148
   This program is free software: you can redistribute it and/or
149
   modify it under the terms of the GNU General Public License as
150
   published by the Free Software Foundation, either version 3 of the
151
   License, or (at your option) any later version.
152
153
   This program is distributed in the hope that it will be useful, but
154
   WITHOUT ANY WARRANTY; without even the implied warranty of
155
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
156
   General Public License for more details.
157
158
   You should have received a copy of the GNU General Public License
159
   along with this program.  If not, see
160
   <http://www.gnu.org/licenses/>.
161
237.2.186 by Teddy Hogeborn
Documentation changes:
162

163
#+STARTUP: showall