/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to DBUS-API

merge

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
76
76
   "clients.conf", in which case they are fully documented in
77
77
   mandos-clients.conf(5).
78
78
   
79
 
   | Name                    | Type | Access     | clients.conf        |
80
 
   |-------------------------+------+------------+---------------------|
81
 
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
82
 
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
83
 
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
84
 
   | ApprovalPending (b)     | b    | Read       | N/A                 |
85
 
   | Checker                 | s    | Read/Write | checker             |
86
 
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
87
 
   | Created (d)             | s    | Read       | N/A                 |
88
 
   | Enabled (e)             | b    | Read/Write | N/A                 |
89
 
   | Expires (f)             | s    | Read       | N/A                 |
90
 
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
91
 
   | Fingerprint             | s    | Read       | fingerprint         |
92
 
   | Host                    | s    | Read/Write | host                |
93
 
   | 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                 |
97
 
   | Name                    | s    | Read       | (Section name)      |
98
 
   | ObjectPath              | o    | Read       | N/A                 |
99
 
   | Secret (j)              | ay   | Write      | secret (or secfile) |
100
 
   | Timeout (a)             | t    | Read/Write | timeout             |
 
79
   | Name                 | Type | Access     | clients.conf        |
 
80
   |----------------------+------+------------+---------------------|
 
81
   | ApprovedByDefault    | b    | Read/Write | approved_by_default |
 
82
   | ApprovalDelay (a)    | t    | Read/Write | approval_delay      |
 
83
   | ApprovalDuration (a) | t    | Read/Write | approval_duration   |
 
84
   | ApprovalPending (b)  | b    | Read       | N/A                 |
 
85
   | Checker              | s    | Read/Write | checker             |
 
86
   | CheckerRunning (c)   | b    | Read/Write | N/A                 |
 
87
   | Created (d)          | s    | Read       | N/A                 |
 
88
   | Enabled (e)          | b    | Read/Write | N/A                 |
 
89
   | Fingerprint          | s    | Read       | fingerprint         |
 
90
   | Host                 | s    | Read/Write | host                |
 
91
   | Interval (a)         | t    | Read/Write | interval            |
 
92
   | LastCheckedOK (f)    | s    | Read/Write | N/A                 |
 
93
   | LastEnabled (g)      | s    | Read       | N/A                 |
 
94
   | Name                 | s    | Read       | (Section name)      |
 
95
   | ObjectPath           | o    | Read       | N/A                 |
 
96
   | Secret (h)           | ay   | Write      | secret (or secfile) |
 
97
   | Timeout (a)          | t    | Read/Write | timeout             |
101
98
   
102
99
   a) Represented as milliseconds.
103
100
   
106
103
   c) Setting this property is equivalent to calling StartChecker() or
107
104
      StopChecker().
108
105
   
109
 
   d) The creation time of this client object, as an RFC 3339 string.
 
106
   d) The creation time of this client object, as a RFC 3339 string.
110
107
   
111
108
   e) Setting this property is equivalent to calling Enable() or
112
109
      Disable().
113
110
   
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.
 
111
   f) The last time a checker was successful, as a RFC 3339 string, or
 
112
      an empty string if this has not happened.  Setting this property
 
113
      is equivalent to calling CheckedOK(), i.e. the current time is
 
114
      set, regardless of the string sent.  Please always use an empty
 
115
      string when setting this property, to allow for possible future
 
116
      expansion.
 
117
   
 
118
   g) The last time this client was enabled, as a RFC 3339 string, or
 
119
      an empty string if this has not happened.
 
120
   
 
121
   h) A raw byte array, not hexadecimal digits.
131
122
 
132
123
** Signals
133
124
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
145
136
    This client will be approved or denied in exactly Timeout
146
137
    milliseconds, depending on ApprovedByDefault.  Approve() can now
147
138
    usefully be called on this client object.
148
 
    
 
139
 
149
140
*** PropertyChanged(s: Property, v: Value)
150
141
    The Property on this client has changed to Value.
151
 
    
 
142
 
152
143
*** Rejected(s: Reason)
153
144
    This client was not given its secret for a specified Reason.
154
145
 
155
 
* Copyright
156
 
 
157
 
    Copyright © 2010-2012 Teddy Hogeborn
158
 
    Copyright © 2010-2012 Björn Påhlsson
159
 
  
160
 
** License:
161
 
   
162
 
   This program is free software: you can redistribute it and/or
163
 
   modify it under the terms of the GNU General Public License as
164
 
   published by the Free Software Foundation, either version 3 of the
165
 
   License, or (at your option) any later version.
166
 
 
167
 
   This program is distributed in the hope that it will be useful, but
168
 
   WITHOUT ANY WARRANTY; without even the implied warranty of
169
 
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
170
 
   General Public License for more details.
171
 
 
172
 
   You should have received a copy of the GNU General Public License
173
 
   along with this program.  If not, see
174
 
   <http://www.gnu.org/licenses/>.
175
 
 
176
146
 
177
147
#+STARTUP: showall