/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

Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

Show diffs side-by-side

added added

removed removed

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