/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

* clients.conf ([DEFAULT]/timeout): Changed default value to "5m".
  ([DEFAULT]/interval): Changed default value to "2m".
  ([DEFAULT]/extenden_timeout): New.
  ([bar]/interval): Changed to "1m".

Show diffs side-by-side

added added

removed removed

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