/mandos/release

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

« back to all changes in this revision

Viewing changes to DBUS-API

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 07:34:37 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810073437-3m8jgt13nqric6vf
Revert change to D-Bus API.

The D-Bus API signal CheckerCompleted is documented to provide a
wait(2) status value.  Since the server switched to using subprocess
to run checkers, it no longer has access to a wait(2) status value.  A
previous change to work around this made the D-Bus API incompatible.
Revert this change by constructing a fake wait(2) status value; this
keeps the D-Bus API stable.

* DBUS-API (CheckerCompleted): Revert incompatible change.
* mandos (ClientDBus.checker_callback): Construct fake wait(2) status.
* mandos-monitor (MandosClientWidget.checker_completed): Revert to
                                                         using
                                                         original API
                                                         with wait(2)
                                                         condition
                                                         value.

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.bsnet.fukt.Mandos"
 
8
  Bus name: "se.recompile.Mandos"
9
9
 
10
10
 
11
11
* Object Paths:
17
17
 
18
18
  
19
19
* Mandos Server Interface:
20
 
  Interface name: "se.bsnet.fukt.Mandos"
 
20
  Interface name: "se.recompile.Mandos"
21
21
  
22
22
** Methods:
23
23
*** GetAllClients() → (ao: Clients)
44
44
 
45
45
 
46
46
* Mandos Client Interface:
47
 
  Interface name: "se.bsnet.fukt.Mandos.Client"
 
47
  Interface name: "se.recompile.Mandos.Client"
48
48
  
49
49
** Methods
50
50
*** Approve(b: Approve) → nothing
55
55
    Assert that this client has been checked and found to be alive.
56
56
    This will restart the timeout before disabling this client.  See
57
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.
72
58
 
73
59
** Properties
74
60
   
87
73
   | Created (d)             | s    | Read       | N/A                 |
88
74
   | Enabled (e)             | b    | Read/Write | N/A                 |
89
75
   | Expires (f)             | s    | Read       | N/A                 |
 
76
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
90
77
   | Fingerprint             | s    | Read       | fingerprint         |
91
78
   | Host                    | s    | Read/Write | host                |
92
79
   | Interval (a)            | t    | Read/Write | interval            |
93
80
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
94
81
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
95
 
   | LastEnabled (i)         | s    | Read       | N/A                 |
 
82
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
83
   | LastEnabled (j)         | s    | Read       | N/A                 |
96
84
   | Name                    | s    | Read       | (Section name)      |
97
 
   | ObjectPath              | o    | Read       | N/A                 |
98
 
   | Secret (j)              | ay   | Write      | secret (or secfile) |
 
85
   | Secret (k)              | ay   | Write      | secret (or secfile) |
99
86
   | Timeout (a)             | t    | Read/Write | timeout             |
100
87
   
101
88
   a) Represented as milliseconds.
102
89
   
103
90
   b) An approval is currently pending.
104
91
   
105
 
   c) Setting this property is equivalent to calling StartChecker() or
106
 
      StopChecker().
 
92
   c) Changing this property can either start a new checker or abort a
 
93
      running one.
107
94
   
108
95
   d) The creation time of this client object, as an RFC 3339 string.
109
96
   
110
 
   e) Setting this property is equivalent to calling Enable() or
111
 
      Disable().
 
97
   e) Changing this property enables or disables a client.
112
98
   
113
99
   f) The date and time this client will be disabled, as an RFC 3339
114
 
      string, or an empty string if this has not happened.
115
 
   
116
 
   g) The time of the last approval request, as an RFC 3339 string, or
117
 
      an empty string if this has not happened.
118
 
   
119
 
   h) The last time a checker was successful, as an RFC 3339 string,
120
 
      or an empty string if this has not happened.  Setting this
121
 
      property is equivalent to calling CheckedOK(), i.e. the current
122
 
      time is set, regardless of the string sent.  Please always use
123
 
      an empty string when setting this property, to allow for
124
 
      possible future expansion.
125
 
   
126
 
   i) The last time this client was enabled, as an RFC 3339 string, or
127
 
      an empty string if this has not happened.
128
 
   
129
 
   j) A raw byte array, not hexadecimal digits.
 
100
      string, or an empty string if this is not scheduled.
 
101
   
 
102
   g) The date and time of the last approval request, as an RFC 3339
 
103
      string, or an empty string if this has not happened.
 
104
   
 
105
   h) The date and time a checker was last successful, as an RFC 3339
 
106
      string, or an empty string if this has not happened.  Setting
 
107
      this property is equivalent to calling CheckedOK(), i.e. the
 
108
      current time is set, regardless of the string sent.  Please
 
109
      always use an empty string when setting this property, to allow
 
110
      for possible future expansion.
 
111
   
 
112
   i) The exit status of the last checker, -1 if it did not exit
 
113
      cleanly, -2 if a checker has not yet returned.
 
114
   
 
115
   j) The date and time this client was last enabled, as an RFC 3339
 
116
      string, or an empty string if this has not happened.
 
117
   
 
118
   k) A raw byte array, not hexadecimal digits.
130
119
 
131
120
** Signals
132
121
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
145
134
    milliseconds, depending on ApprovedByDefault.  Approve() can now
146
135
    usefully be called on this client object.
147
136
    
148
 
*** PropertyChanged(s: Property, v: Value)
149
 
    The Property on this client has changed to Value.
150
 
    
151
137
*** Rejected(s: Reason)
152
138
    This client was not given its secret for a specified Reason.
153
139
 
154
140
* Copyright
155
141
 
156
 
    Copyright © 2010-2011 Teddy Hogeborn
157
 
    Copyright © 2010-2011 Björn Påhlsson
 
142
    Copyright © 2010-2015 Teddy Hogeborn
 
143
    Copyright © 2010-2015 Björn Påhlsson
158
144
  
159
145
** License:
160
146