/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:57:09 UTC
  • Revision ID: teddy@recompile.se-20150802165709-k0vuxe3vjph3n5ss
Deprecate the D-Bus property "se.recompile.Mandos.Client.ObjectPath".

The D-Bus property "se.recompile.Mandos.Client.ObjectPath" is
unnecessary - is not used by mandos-monitor or mandos-ctl, and I
cannot see it being useful for anyone.

* DBUS-API (se.recompile.Mandos.Client.ObjectPath): Remove;
                                                    deprecated.
* mandos (ClientDBus.ObjectPath_dbus_property): Annotate as
                                                deprecated.

Show diffs side-by-side

added added

removed removed

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