/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: Björn Påhlsson
  • Date: 2011-09-18 16:00:55 UTC
  • mto: This revision was merged to the branch mainline in revision 498.
  • Revision ID: belorn@fukt.bsnet.se-20110918160055-04y4aoz1j87iyjo2
updated DBUS-API documentation for extended timeout

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.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
87
87
   | Created (d)             | s    | Read       | N/A                 |
88
88
   | Enabled (e)             | b    | Read/Write | N/A                 |
89
89
   | Expires (f)             | s    | Read       | N/A                 |
90
 
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
91
90
   | Fingerprint             | s    | Read       | fingerprint         |
92
91
   | Host                    | s    | Read/Write | host                |
93
92
   | Interval (a)            | t    | Read/Write | interval            |
94
93
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
95
94
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
96
 
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
97
 
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
95
   | LastEnabled (i)         | s    | Read       | N/A                 |
98
96
   | Name                    | s    | Read       | (Section name)      |
99
97
   | ObjectPath              | o    | Read       | N/A                 |
100
 
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
98
   | Secret (j)              | ay   | Write      | secret (or secfile) |
101
99
   | Timeout (a)             | t    | Read/Write | timeout             |
 
100
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
102
101
   
103
102
   a) Represented as milliseconds.
104
103
   
113
112
      Disable().
114
113
   
115
114
   f) The date and time this client will be disabled, as an RFC 3339
116
 
      string, or an empty string if this is not scheduled.
117
 
   
118
 
   g) The date and time of the last approval request, as an RFC 3339
119
 
      string, or an empty string if this has not happened.
120
 
   
121
 
   h) The date and time a checker was last successful, as an RFC 3339
122
 
      string, or an empty string if this has not happened.  Setting
123
 
      this property is equivalent to calling CheckedOK(), i.e. the
124
 
      current time is set, regardless of the string sent.  Please
125
 
      always use an empty string when setting this property, to allow
126
 
      for possible future expansion.
127
 
   
128
 
   i) The exit status of the last checker, -1 if it did not exit
129
 
      cleanly, -2 if a checker has not yet returned.
130
 
   
131
 
   j) The date and time this client was last enabled, as an RFC 3339
132
 
      string, or an empty string if this has not happened.
133
 
   
134
 
   k) A raw byte array, not hexadecimal digits.
 
115
      string, or an empty string if this has not happened.
 
116
   
 
117
   g) The time of the last approval request, as an RFC 3339 string, or
 
118
      an empty string if this has not happened.
 
119
   
 
120
   h) The last time a checker was successful, as an RFC 3339 string,
 
121
      or an empty string if this has not happened.  Setting this
 
122
      property is equivalent to calling CheckedOK(), i.e. the current
 
123
      time is set, regardless of the string sent.  Please always use
 
124
      an empty string when setting this property, to allow for
 
125
      possible future expansion.
 
126
   
 
127
   i) The last time this client was enabled, as an RFC 3339 string, or
 
128
      an empty string if this has not happened.
 
129
   
 
130
   j) A raw byte array, not hexadecimal digits.
135
131
 
136
132
** Signals
137
133
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
158
154
 
159
155
* Copyright
160
156
 
161
 
    Copyright © 2010-2012 Teddy Hogeborn
162
 
    Copyright © 2010-2012 Björn Påhlsson
 
157
    Copyright © 2010-2011 Teddy Hogeborn
 
158
    Copyright © 2010-2011 Björn Påhlsson
163
159
  
164
160
** License:
165
161