/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: 2015-08-02 16:45:29 UTC
  • Revision ID: teddy@recompile.se-20150802164529-pemtk1agiqluoiua
Deprecate some D-Bus methods in favor of D-Bus properties.

The following D-Bus methods on the interface
"se.recompile.Mandos.Client" are redundant, and are therefore
deprecated:  "Disable", "Enable", "StartChecker", and "StopChecker".
Instead, the D-Bus properties "Enabled" and "CheckerRunning" should be
set, as was always also possible.

* DBUS-API (se.recompile.Mandos.Client.Disable): Remove; deprecated.
  (se.recompile.Mandos.Client.Enable): - '' -
  (se.recompile.Mandos.Client.StartChecker): - '' -
  (se.recompile.Mandos.Client.StopChecker): - '' -
* mandos (ClientDBus.Enable): Annotate as deprecated.
  (ClientDBus.StartChecker): - '' -
  (ClientDBus.Disable): - '' -
  (ClientDBus.StopChecker): - '' -
* mandos-monitor (MandosClientWidget.keypress): Set properties instead
                                                of calling deprecated
                                                methods.

Show diffs side-by-side

added added

removed removed

Lines of Context:
DBUS-API
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
   
93
79
   | Interval (a)            | t    | Read/Write | interval            |
94
80
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
95
81
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
96
 
   | LastEnabled (i)         | s    | Read       | N/A                 |
 
82
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
83
   | LastEnabled (j)         | s    | Read       | N/A                 |
97
84
   | Name                    | s    | Read       | (Section name)      |
98
85
   | ObjectPath              | o    | Read       | N/A                 |
99
 
   | Secret (j)              | ay   | Write      | secret (or secfile) |
 
86
   | Secret (k)              | ay   | Write      | secret (or secfile) |
100
87
   | Timeout (a)             | t    | Read/Write | timeout             |
101
88
   
102
89
   a) Represented as milliseconds.
103
90
   
104
91
   b) An approval is currently pending.
105
92
   
106
 
   c) Setting this property is equivalent to calling StartChecker() or
107
 
      StopChecker().
 
93
   c) Changing this property can either start a new checker or abort a
 
94
      running one.
108
95
   
109
96
   d) The creation time of this client object, as an RFC 3339 string.
110
97
   
111
 
   e) Setting this property is equivalent to calling Enable() or
112
 
      Disable().
 
98
   e) Changing this property enables or disables a client.
113
99
   
114
100
   f) The date and time this client will be disabled, as an RFC 3339
115
101
      string, or an empty string if this is not scheduled.
124
110
      always use an empty string when setting this property, to allow
125
111
      for possible future expansion.
126
112
   
127
 
   i) The date and time this client was last enabled, as an RFC 3339
 
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
128
117
      string, or an empty string if this has not happened.
129
118
   
130
 
   j) A raw byte array, not hexadecimal digits.
 
119
   k) A raw byte array, not hexadecimal digits.
131
120
 
132
121
** Signals
133
 
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
122
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
134
123
    A checker (Command) has completed.  Exitcode is either the exit
135
 
    code or -1 for abnormal exit.  In any case, the full Waitstatus
136
 
    (as from wait(2)) is also available.
 
124
    code or -1 for abnormal exit, in which case, the signal number
 
125
    is available.
137
126
    
138
127
*** CheckerStarted(s: Command)
139
128
    A checker command (Command) has just been started.
146
135
    milliseconds, depending on ApprovedByDefault.  Approve() can now
147
136
    usefully be called on this client object.
148
137
    
149
 
*** PropertyChanged(s: Property, v: Value)
150
 
    The Property on this client has changed to Value.
151
 
    
152
138
*** Rejected(s: Reason)
153
139
    This client was not given its secret for a specified Reason.
154
140
 
155
 
*** NewRequest(s: IP address)
156
 
    A client at IP adress has asked for its password.
157
 
 
158
141
* Copyright
159
142
 
160
 
    Copyright © 2010-2011 Teddy Hogeborn
161
 
    Copyright © 2010-2011 Björn Påhlsson
 
143
    Copyright © 2010-2015 Teddy Hogeborn
 
144
    Copyright © 2010-2015 Björn Påhlsson
162
145
  
163
146
** License:
164
147