/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:
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:
17
17
 
18
18
  
19
19
* Mandos Server Interface:
20
 
  Interface name: "se.recompile.Mandos"
 
20
  Interface name: "se.bsnet.fukt.Mandos"
21
21
  
22
22
** Methods:
23
23
*** GetAllClients() → (ao: Clients)
44
44
 
45
45
 
46
46
* Mandos Client Interface:
47
 
  Interface name: "se.recompile.Mandos.Client"
 
47
  Interface name: "se.bsnet.fukt.Mandos.Client"
48
48
  
49
49
** Methods
50
50
*** Approve(b: Approve) → nothing
93
93
   | Interval (a)            | t    | Read/Write | interval            |
94
94
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
95
95
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
96
 
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
97
 
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
96
   | LastEnabled (i)         | s    | Read       | N/A                 |
98
97
   | Name                    | s    | Read       | (Section name)      |
99
98
   | ObjectPath              | o    | Read       | N/A                 |
100
 
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
99
   | Secret (j)              | ay   | Write      | secret (or secfile) |
101
100
   | Timeout (a)             | t    | Read/Write | timeout             |
102
101
   
103
102
   a) Represented as milliseconds.
113
112
      Disable().
114
113
   
115
114
   f) The date and time this client will be disabled, as an RFC 3339
116
 
      string, or an empty string if this is not scheduled.
 
115
      string, or an empty string if this has not happened.
117
116
   
118
117
   g) The date and time of the last approval request, as an RFC 3339
119
118
      string, or an empty string if this has not happened.
125
124
      always use an empty string when setting this property, to allow
126
125
      for possible future expansion.
127
126
   
128
 
   i) The exit status of the last checker, -1 if it did not exit
129
 
      cleanly, -2 if a checker has not yet returned.
130
 
   
131
 
   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
132
128
      string, or an empty string if this has not happened.
133
129
   
134
 
   k) A raw byte array, not hexadecimal digits.
 
130
   j) A raw byte array, not hexadecimal digits.
135
131
 
136
132
** Signals
137
 
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
 
133
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
138
134
    A checker (Command) has completed.  Exitcode is either the exit
139
 
    code or -1 for abnormal exit, in which case, the signal number
140
 
    is available.
 
135
    code or -1 for abnormal exit.  In any case, the full Waitstatus
 
136
    (as from wait(2)) is also available.
141
137
    
142
138
*** CheckerStarted(s: Command)
143
139
    A checker command (Command) has just been started.
150
146
    milliseconds, depending on ApprovedByDefault.  Approve() can now
151
147
    usefully be called on this client object.
152
148
    
 
149
*** PropertyChanged(s: Property, v: Value)
 
150
    The Property on this client has changed to Value.
 
151
    
153
152
*** Rejected(s: Reason)
154
153
    This client was not given its secret for a specified Reason.
155
154
 
156
155
* Copyright
157
156
 
158
 
    Copyright © 2010-2015 Teddy Hogeborn
159
 
    Copyright © 2010-2015 Björn Påhlsson
 
157
    Copyright © 2010-2011 Teddy Hogeborn
 
158
    Copyright © 2010-2011 Björn Påhlsson
160
159
  
161
160
** License:
162
161