/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to DBUS-API

  • Committer: Teddy Hogeborn
  • Date: 2011-09-18 15:59:05 UTC
  • mfrom: (24.1.179 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20110918155905-ngj2ig0yheralj1s
* DBUS-API: Document new "Expires" and "ExtendedTimeout" properties.
* README: Refer to the installed manual page more simply.
* mandos (Client.extended_timeout, Client.expires): New attributes.
  (Client.extended_timeout_milliseconds): New.
  (Client.__init__, Client.enable, Client.disable): Set new attributes.
  (Client.checked_ok): Take new "timeout" argument.
  (ClientDBus.expires): Transform into a property which sends a D-Bus
                        signal when changed.
  (ClientDBus._datetime_to_dbus): Return empty D-Bus string on None.
                                  All callers changed to use this.

  (ClientDBus.ApprovedByDefault_dbus_property,
  ClientDBus.ApprovalDelay_dbus_property,
  ClientDBus.ApprovalDuration_dbus_property,
  ClientDBus.Host_dbus_property, ClientDBus.Timeout_dbus_property,
  ClientDBus.Interval_dbus_property,
  ClientDBus.Checker_dbus_property): Bug fix: Only send D-Bus signal
                                     if new value is different.
  (ClientDBus.Timeout_dbus_property): Use new "expires" attribute.
  (ClientDBus.Expires_dbus_property,
  ClientDBus.ExtendedTimeout_dbus_property): New D-Bus properties.
  (ClientHandler.handle): Bump time using extended_timeout value.
  (main.client_defaults): Change default values of "timeout" and
                          "interval", added new default value for
                          "extended_timeout".
* mandos-clients.conf.xml (OPTIONS): Changed default values of
                                     "interval" and "timeout".  Add
                                     new "extended_timeout" option.
  (EXAMPLE): Updated default values.
* mandos-ctl: Show new "ExtendedTimeout" D-Bus property and change it
              using new "--extended-timeout" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new
                                      "--extended-timeout" option.
* mandos-monitor (MandosClientWidget.update): Use new "Expires" D-Bus
                                              property.
* mandos.xml (DESCRIPTION): Add reference to intro(8mandos) manual
                            page.
  (CHECKING): Refer to the new "extended_timeout" option in
  clients.conf.

Show diffs side-by-side

added added

removed removed

Lines of Context:
DBUS-API
5
5
This file documents the D-Bus interface to the Mandos server.
6
6
 
7
7
* Bus: System bus
8
 
  Bus name: "se.recompile.Mandos"
 
8
  Bus name: "se.bsnet.fukt.Mandos"
9
9
 
10
10
 
11
11
* Object Paths:
13
13
  | Path                  | Object            |
14
14
  |-----------------------+-------------------|
15
15
  | "/"                   | The Mandos Server |
16
 
 
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
 
  object supports.)
20
 
 
21
 
 
 
16
  | "/clients/CLIENTNAME" | Mandos Client     |
 
17
 
 
18
  
22
19
* Mandos Server Interface:
23
 
  Interface name: "se.recompile.Mandos"
 
20
  Interface name: "se.bsnet.fukt.Mandos"
24
21
  
25
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
   
26
29
*** RemoveClient(o: ObjectPath) → nothing
27
30
    Removes a client
28
31
   
29
32
** Signals:
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
 
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
33
39
    is represented as a string of hexadecimal digits.  The address is
34
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.
35
44
 
36
45
 
37
46
* Mandos Client Interface:
38
 
  Interface name: "se.recompile.Mandos.Client"
 
47
  Interface name: "se.bsnet.fukt.Mandos.Client"
39
48
  
40
49
** Methods
41
50
*** Approve(b: Approve) → nothing
46
55
    Assert that this client has been checked and found to be alive.
47
56
    This will restart the timeout before disabling this client.  See
48
57
    also the "LastCheckedOK" property.
 
58
    
 
59
*** Disable() → nothing
 
60
    Disable this client.  See also the "Enabled" property.
 
61
    
 
62
*** Enable() → nothing
 
63
    Enable this client.  See also the "Enabled" property.
 
64
    
 
65
*** StartChecker() → nothing
 
66
    Start a new checker for this client, if none is currently
 
67
    running.  See also the "CheckerRunning" property.
 
68
    
 
69
*** StopChecker() → nothing
 
70
    Abort a running checker process for this client, if any.  See also
 
71
    the "CheckerRunning" property.
49
72
 
50
73
** Properties
51
74
   
55
78
   
56
79
   | Name                    | Type | Access     | clients.conf        |
57
80
   |-------------------------+------+------------+---------------------|
 
81
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
58
82
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
59
83
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
60
84
   | ApprovalPending (b)     | b    | Read       | N/A                 |
61
 
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
62
85
   | Checker                 | s    | Read/Write | checker             |
63
86
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
64
87
   | Created (d)             | s    | Read       | N/A                 |
68
91
   | Fingerprint             | s    | Read       | fingerprint         |
69
92
   | Host                    | s    | Read/Write | host                |
70
93
   | Interval (a)            | t    | Read/Write | interval            |
71
 
   | KeyID                   | s    | Read       | key_id              |
72
94
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
73
95
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
74
 
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
75
 
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
96
   | LastEnabled (i)         | s    | Read       | N/A                 |
76
97
   | Name                    | s    | Read       | (Section name)      |
77
 
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
98
   | ObjectPath              | o    | Read       | N/A                 |
 
99
   | Secret (j)              | ay   | Write      | secret (or secfile) |
78
100
   | Timeout (a)             | t    | Read/Write | timeout             |
79
101
   
80
102
   a) Represented as milliseconds.
81
103
   
82
104
   b) An approval is currently pending.
83
105
   
84
 
   c) Changing this property can either start a new checker or abort a
85
 
      running one.
 
106
   c) Setting this property is equivalent to calling StartChecker() or
 
107
      StopChecker().
86
108
   
87
109
   d) The creation time of this client object, as an RFC 3339 string.
88
110
   
89
 
   e) Changing this property enables or disables a client.
 
111
   e) Setting this property is equivalent to calling Enable() or
 
112
      Disable().
90
113
   
91
114
   f) The date and time this client will be disabled, as an RFC 3339
92
 
      string, or an empty string if this is not scheduled.
 
115
      string, or an empty string if this has not happened.
93
116
   
94
117
   g) The date and time of the last approval request, as an RFC 3339
95
118
      string, or an empty string if this has not happened.
101
124
      always use an empty string when setting this property, to allow
102
125
      for possible future expansion.
103
126
   
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.
106
 
   
107
 
   j) The date and time this client was last enabled, as an RFC 3339
 
127
   i) The date and time this client was last enabled, as an RFC 3339
108
128
      string, or an empty string if this has not happened.
109
129
   
110
 
   k) A raw byte array, not hexadecimal digits.
 
130
   j) A raw byte array, not hexadecimal digits.
111
131
 
112
132
** Signals
113
133
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
126
146
    milliseconds, depending on ApprovedByDefault.  Approve() can now
127
147
    usefully be called on this client object.
128
148
    
 
149
*** PropertyChanged(s: Property, v: Value)
 
150
    The Property on this client has changed to Value.
 
151
    
129
152
*** Rejected(s: Reason)
130
153
    This client was not given its secret for a specified Reason.
131
154
 
132
155
* Copyright
133
156
 
134
 
    Copyright © 2010-2020 Teddy Hogeborn
135
 
    Copyright © 2010-2020 Björn Påhlsson
 
157
    Copyright © 2010-2011 Teddy Hogeborn
 
158
    Copyright © 2010-2011 Björn Påhlsson
136
159
  
137
160
** License:
138
 
 
139
 
   This file is part of Mandos.
140
 
 
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.
145
 
 
146
 
   Mandos is distributed in the hope that it will be useful, but
 
161
   
 
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.
 
166
 
 
167
   This program is distributed in the hope that it will be useful, but
147
168
   WITHOUT ANY WARRANTY; without even the implied warranty of
148
169
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
149
170
   General Public License for more details.
150
171
 
151
172
   You should have received a copy of the GNU General Public License
152
 
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
173
   along with this program.  If not, see
 
174
   <http://www.gnu.org/licenses/>.
153
175
 
154
176
 
155
177
#+STARTUP: showall