/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

* debian/source/local-options: New; contains "--single-debian-patch".

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