/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: 2014-02-16 13:12:20 UTC
  • mto: This revision was merged to the branch mainline in revision 656.
  • Revision ID: teddy@recompile.se-20140216131220-4nv9kjolkrxvn6l3
Tags: version-1.6.4-1
* Makefile (version): Changed to "1.6.4".
* NEWS (Version 1.6.4): New entry.
* debian/changelog (1.6.4-1): - '' -

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.bsnet.fukt.Mandos"
 
8
  Bus name: "se.recompile.Mandos"
9
9
 
10
10
 
11
11
* Object Paths:
17
17
 
18
18
  
19
19
* Mandos Server Interface:
20
 
  Interface name: "se.bsnet.fukt.Mandos"
 
20
  Interface name: "se.recompile.Mandos"
21
21
  
22
22
** Methods:
23
23
*** GetAllClients() → (ao: Clients)
44
44
 
45
45
 
46
46
* Mandos Client Interface:
47
 
  Interface name: "se.bsnet.fukt.Mandos.Client"
 
47
  Interface name: "se.recompile.Mandos.Client"
48
48
  
49
49
** Methods
50
50
*** Approve(b: Approve) → nothing
86
86
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
87
87
   | Created (d)             | s    | Read       | N/A                 |
88
88
   | Enabled (e)             | b    | Read/Write | N/A                 |
 
89
   | Expires (f)             | s    | Read       | N/A                 |
 
90
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
89
91
   | Fingerprint             | s    | Read       | fingerprint         |
90
92
   | Host                    | s    | Read/Write | host                |
91
93
   | Interval (a)            | t    | Read/Write | interval            |
92
 
   | LastApprovalRequest (f) | s    | Read       | N/A                 |
93
 
   | LastCheckedOK (g)       | s    | Read/Write | N/A                 |
94
 
   | LastEnabled (h)         | s    | Read       | N/A                 |
 
94
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
95
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
96
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
97
   | LastEnabled (j)         | s    | Read       | N/A                 |
95
98
   | Name                    | s    | Read       | (Section name)      |
96
99
   | ObjectPath              | o    | Read       | N/A                 |
97
 
   | Secret (i)              | ay   | Write      | secret (or secfile) |
 
100
   | Secret (k)              | ay   | Write      | secret (or secfile) |
98
101
   | Timeout (a)             | t    | Read/Write | timeout             |
99
102
   
100
103
   a) Represented as milliseconds.
104
107
   c) Setting this property is equivalent to calling StartChecker() or
105
108
      StopChecker().
106
109
   
107
 
   d) The creation time of this client object, as a RFC 3339 string.
 
110
   d) The creation time of this client object, as an RFC 3339 string.
108
111
   
109
112
   e) Setting this property is equivalent to calling Enable() or
110
113
      Disable().
111
114
   
112
 
   f) The time of the last approval request, as a RFC 3339 string, or
113
 
      an empty string if this has not happened.
114
 
   
115
 
   g) The last time a checker was successful, as a RFC 3339 string, or
116
 
      an empty string if this has not happened.  Setting this property
117
 
      is equivalent to calling CheckedOK(), i.e. the current time is
118
 
      set, regardless of the string sent.  Please always use an empty
119
 
      string when setting this property, to allow for possible future
120
 
      expansion.
121
 
   
122
 
   h) The last time this client was enabled, as a RFC 3339 string, or
123
 
      an empty string if this has not happened.
124
 
   
125
 
   i) A raw byte array, not hexadecimal digits.
 
115
   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.
126
135
 
127
136
** Signals
128
137
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
140
149
    This client will be approved or denied in exactly Timeout
141
150
    milliseconds, depending on ApprovedByDefault.  Approve() can now
142
151
    usefully be called on this client object.
143
 
 
 
152
    
144
153
*** PropertyChanged(s: Property, v: Value)
145
154
    The Property on this client has changed to Value.
146
 
 
 
155
    
147
156
*** Rejected(s: Reason)
148
157
    This client was not given its secret for a specified Reason.
149
158
 
150
159
* Copyright
151
160
 
152
 
    Copyright © 2010-2011 Teddy Hogeborn
153
 
    Copyright © 2010-2011 Björn Påhlsson
 
161
    Copyright © 2010-2012 Teddy Hogeborn
 
162
    Copyright © 2010-2012 Björn Påhlsson
154
163
  
155
164
** License:
156
165