/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-12-21 00:29:33 UTC
  • mfrom: (518.1.15 mandos-persistent)
  • Revision ID: belorn@recompile.se-20111221002933-6sc0a64o1ns2s2s8
Working persistant state

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
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    |
90
91
   | Fingerprint             | s    | Read       | fingerprint         |
91
92
   | Host                    | s    | Read/Write | host                |
92
93
   | Interval (a)            | t    | Read/Write | interval            |
97
98
   | ObjectPath              | o    | Read       | N/A                 |
98
99
   | Secret (j)              | ay   | Write      | secret (or secfile) |
99
100
   | Timeout (a)             | t    | Read/Write | timeout             |
100
 
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
101
101
   
102
102
   a) Represented as milliseconds.
103
103
   
112
112
      Disable().
113
113
   
114
114
   f) The date and time this client will be disabled, as an RFC 3339
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.
 
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
129
   
130
130
   j) A raw byte array, not hexadecimal digits.
131
131
 
152
152
*** Rejected(s: Reason)
153
153
    This client was not given its secret for a specified Reason.
154
154
 
 
155
*** NewRequest(s: IP address)
 
156
    A client at IP adress has asked for its password.
 
157
 
155
158
* Copyright
156
159
 
157
160
    Copyright © 2010-2011 Teddy Hogeborn