/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: 2011-03-17 18:13:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110317181340-nf79nlcbilqx3ccg
* debian/control (mandos-client): Conflict with correct version of
                                  dropbear.

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
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    |
91
89
   | Fingerprint             | s    | Read       | fingerprint         |
92
90
   | Host                    | s    | Read/Write | host                |
93
91
   | Interval (a)            | t    | Read/Write | interval            |
94
 
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
95
 
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
96
 
   | LastEnabled (i)         | s    | Read       | N/A                 |
 
92
   | LastApprovalRequest (f) | s    | Read       | N/A                 |
 
93
   | LastCheckedOK (g)       | s    | Read/Write | N/A                 |
 
94
   | LastEnabled (h)         | s    | Read       | N/A                 |
97
95
   | Name                    | s    | Read       | (Section name)      |
98
96
   | ObjectPath              | o    | Read       | N/A                 |
99
 
   | Secret (j)              | ay   | Write      | secret (or secfile) |
 
97
   | Secret (i)              | ay   | Write      | secret (or secfile) |
100
98
   | Timeout (a)             | t    | Read/Write | timeout             |
101
99
   
102
100
   a) Represented as milliseconds.
106
104
   c) Setting this property is equivalent to calling StartChecker() or
107
105
      StopChecker().
108
106
   
109
 
   d) The creation time of this client object, as an RFC 3339 string.
 
107
   d) The creation time of this client object, as a RFC 3339 string.
110
108
   
111
109
   e) Setting this property is equivalent to calling Enable() or
112
110
      Disable().
113
111
   
114
 
   f) The date and time this client will be disabled, as an RFC 3339
115
 
      string, or an empty string if this is not scheduled.
116
 
   
117
 
   g) The date and time of the last approval request, as an RFC 3339
118
 
      string, or an empty string if this has not happened.
119
 
   
120
 
   h) The date and time a checker was last successful, as an RFC 3339
121
 
      string, or an empty string if this has not happened.  Setting
122
 
      this property is equivalent to calling CheckedOK(), i.e. the
123
 
      current time is set, regardless of the string sent.  Please
124
 
      always use an empty string when setting this property, to allow
125
 
      for possible future expansion.
126
 
   
127
 
   i) The date and time this client was last enabled, as an RFC 3339
128
 
      string, or an empty string if this has not happened.
129
 
   
130
 
   j) A raw byte array, not hexadecimal digits.
 
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.
131
126
 
132
127
** Signals
133
128
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
145
140
    This client will be approved or denied in exactly Timeout
146
141
    milliseconds, depending on ApprovedByDefault.  Approve() can now
147
142
    usefully be called on this client object.
148
 
    
 
143
 
149
144
*** PropertyChanged(s: Property, v: Value)
150
145
    The Property on this client has changed to Value.
151
 
    
 
146
 
152
147
*** Rejected(s: Reason)
153
148
    This client was not given its secret for a specified Reason.
154
149
 
155
 
*** NewRequest(s: IP address)
156
 
    A client at IP adress has asked for its password.
157
 
 
158
150
* Copyright
159
151
 
160
152
    Copyright © 2010-2011 Teddy Hogeborn