/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

  • Committer: Björn Påhlsson
  • Date: 2011-09-18 14:28:47 UTC
  • mto: (237.7.45 trunk)
  • mto: This revision was merged to the branch mainline in revision 286.
  • Revision ID: belorn@fukt.bsnet.se-20110918142847-wx9ru8lxxsc4timi
New feature:
extended timeout given once when password is sent to client

New dbus-API property (Expire):
Time and date when a client will be disabled

New dbus-API property (ExtendedTimeout):
The duration of extended timeout

Changed default values:
Timeout: Changed from 1 hour to 5 minutes
Interval: Changed from 5 minutes to 2 minutes

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
                   -*- mode: org; coding: utf-8 -*-
 
2
 
 
3
                    Mandos Server D-Bus Interface
 
4
 
 
5
This file documents the D-Bus interface to the Mandos server.
 
6
 
 
7
* Bus: System bus
 
8
  Bus name: "se.bsnet.fukt.Mandos"
 
9
 
 
10
 
 
11
* Object Paths:
 
12
  
 
13
  | Path                  | Object            |
 
14
  |-----------------------+-------------------|
 
15
  | "/"                   | The Mandos Server |
 
16
  | "/clients/CLIENTNAME" | Mandos Client     |
 
17
 
 
18
  
 
19
* Mandos Server Interface:
 
20
  Interface name: "se.bsnet.fukt.Mandos"
 
21
  
 
22
** Methods:
 
23
*** GetAllClients() → (ao: Clients)
 
24
    Returns an array of all client D-Bus object paths
 
25
   
 
26
*** GetAllClientsWithProperties() → (a{oa{sv}}: ClientProperties)
 
27
    Returns an array of all clients and all their properties
 
28
   
 
29
*** RemoveClient(o: ObjectPath) → nothing
 
30
    Removes a client
 
31
   
 
32
** Signals:
 
33
*** ClientAdded(o: ObjectPath)
 
34
    A new client was added.
 
35
   
 
36
*** ClientNotFound(s: Fingerprint, s: Address)
 
37
    A client connected from Address using Fingerprint, but was
 
38
    rejected because it was not found in the server.  The fingerprint
 
39
    is represented as a string of hexadecimal digits.  The address is
 
40
    an IPv4 or IPv6 address in its normal string format.
 
41
   
 
42
*** ClientRemoved(o: ObjectPath, s: Name)
 
43
    A client named Name on ObjectPath was removed.
 
44
 
 
45
 
 
46
* Mandos Client Interface:
 
47
  Interface name: "se.bsnet.fukt.Mandos.Client"
 
48
  
 
49
** Methods
 
50
*** Approve(b: Approve) → nothing
 
51
    Approve or deny a connected client waiting for approval.  If
 
52
    denied, a client will not be sent its secret.
 
53
    
 
54
*** CheckedOK() → nothing
 
55
    Assert that this client has been checked and found to be alive.
 
56
    This will restart the timeout before disabling this client.  See
 
57
    also the "LastCheckedOK" property.
 
58
    
 
59
*** Disable() → nothing
 
60
    Disable this client.  See also the "Enabled" property.
 
61
    
 
62
*** Enable() → nothing
 
63
    Enable this client.  See also the "Enabled" property.
 
64
    
 
65
*** StartChecker() → nothing
 
66
    Start a new checker for this client, if none is currently
 
67
    running.  See also the "CheckerRunning" property.
 
68
    
 
69
*** StopChecker() → nothing
 
70
    Abort a running checker process for this client, if any.  See also
 
71
    the "CheckerRunning" property.
 
72
 
 
73
** Properties
 
74
   
 
75
   Note: Many of these properties directly correspond to a setting in
 
76
   "clients.conf", in which case they are fully documented in
 
77
   mandos-clients.conf(5).
 
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             |
 
100
   
 
101
   a) Represented as milliseconds.
 
102
   
 
103
   b) An approval is currently pending.
 
104
   
 
105
   c) Setting this property is equivalent to calling StartChecker() or
 
106
      StopChecker().
 
107
   
 
108
   d) The creation time of this client object, as an RFC 3339 string.
 
109
   
 
110
   e) Setting this property is equivalent to calling Enable() or
 
111
      Disable().
 
112
   
 
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.
 
130
 
 
131
** Signals
 
132
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
133
    A checker (Command) has completed.  Exitcode is either the exit
 
134
    code or -1 for abnormal exit.  In any case, the full Waitstatus
 
135
    (as from wait(2)) is also available.
 
136
    
 
137
*** CheckerStarted(s: Command)
 
138
    A checker command (Command) has just been started.
 
139
    
 
140
*** GotSecret()
 
141
    This client has been sent its secret.
 
142
    
 
143
*** NeedApproval(t: Timeout, b: ApprovedByDefault)
 
144
    This client will be approved or denied in exactly Timeout
 
145
    milliseconds, depending on ApprovedByDefault.  Approve() can now
 
146
    usefully be called on this client object.
 
147
    
 
148
*** PropertyChanged(s: Property, v: Value)
 
149
    The Property on this client has changed to Value.
 
150
    
 
151
*** Rejected(s: Reason)
 
152
    This client was not given its secret for a specified Reason.
 
153
 
 
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
 
 
176
#+STARTUP: showall