/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: 2012-01-01 04:52:07 UTC
  • Revision ID: belorn@recompile.se-20120101045207-5f7v5vajwpmek164
adding missing words

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
   | LastEnabled (i)         | s    | Read       | N/A                 |
95
97
   | Name                    | s    | Read       | (Section name)      |
96
98
   | ObjectPath              | o    | Read       | N/A                 |
97
 
   | Secret (i)              | ay   | Write      | secret (or secfile) |
 
99
   | Secret (j)              | ay   | Write      | secret (or secfile) |
98
100
   | Timeout (a)             | t    | Read/Write | timeout             |
99
101
   
100
102
   a) Represented as milliseconds.
104
106
   c) Setting this property is equivalent to calling StartChecker() or
105
107
      StopChecker().
106
108
   
107
 
   d) The creation time of this client object, as a RFC 3339 string.
 
109
   d) The creation time of this client object, as an RFC 3339 string.
108
110
   
109
111
   e) Setting this property is equivalent to calling Enable() or
110
112
      Disable().
111
113
   
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.
 
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.
126
131
 
127
132
** Signals
128
133
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
140
145
    This client will be approved or denied in exactly Timeout
141
146
    milliseconds, depending on ApprovedByDefault.  Approve() can now
142
147
    usefully be called on this client object.
143
 
 
 
148
    
144
149
*** PropertyChanged(s: Property, v: Value)
145
150
    The Property on this client has changed to Value.
146
 
 
 
151
    
147
152
*** Rejected(s: Reason)
148
153
    This client was not given its secret for a specified Reason.
149
154
 
 
155
*** NewRequest(s: IPAddress)
 
156
    A client at IPAdress has requested its secret.
 
157
 
150
158
* Copyright
151
159
 
152
 
    Copyright © 2010 Teddy Hogeborn
153
 
    Copyright © 2010 Björn Påhlsson
 
160
    Copyright © 2010-2012 Teddy Hogeborn
 
161
    Copyright © 2010-2012 Björn Påhlsson
154
162
  
155
163
** License:
156
164