/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: Teddy Hogeborn
  • Date: 2014-07-17 03:24:57 UTC
  • mto: This revision was merged to the branch mainline in revision 720.
  • Revision ID: teddy@recompile.se-20140717032457-7074pobx7ft1oiio
Tags: version-1.6.7-1
* Makefile (version): Changed to "1.6.7".
* NEWS (Version 1.6.7): New entry.
* debian/changelog (1.6.7-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
DBUS-API
13
13
  | Path                  | Object            |
14
14
  |-----------------------+-------------------|
15
15
  | "/"                   | The Mandos Server |
16
 
 
17
 
  (To get a list of paths to client objects, use the standard D-Bus
18
 
  org.freedesktop.DBus.ObjectManager interface, which the server
19
 
  object supports.)
20
 
 
21
 
 
 
16
  | "/clients/CLIENTNAME" | Mandos Client     |
 
17
 
 
18
  
22
19
* Mandos Server Interface:
23
20
  Interface name: "se.recompile.Mandos"
24
21
  
25
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
   
26
29
*** RemoveClient(o: ObjectPath) → nothing
27
30
    Removes a client
28
31
   
29
32
** Signals:
 
33
*** ClientAdded(o: ObjectPath)
 
34
    A new client was added.
 
35
   
30
36
*** ClientNotFound(s: Fingerprint, s: Address)
31
37
    A client connected from Address using Fingerprint, but was
32
38
    rejected because it was not found in the server.  The fingerprint
33
39
    is represented as a string of hexadecimal digits.  The address is
34
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.
35
44
 
36
45
 
37
46
* Mandos Client Interface:
46
55
    Assert that this client has been checked and found to be alive.
47
56
    This will restart the timeout before disabling this client.  See
48
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.
49
72
 
50
73
** Properties
51
74
   
73
96
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
74
97
   | LastEnabled (j)         | s    | Read       | N/A                 |
75
98
   | Name                    | s    | Read       | (Section name)      |
 
99
   | ObjectPath              | o    | Read       | N/A                 |
76
100
   | Secret (k)              | ay   | Write      | secret (or secfile) |
77
101
   | Timeout (a)             | t    | Read/Write | timeout             |
78
102
   
80
104
   
81
105
   b) An approval is currently pending.
82
106
   
83
 
   c) Changing this property can either start a new checker or abort a
84
 
      running one.
 
107
   c) Setting this property is equivalent to calling StartChecker() or
 
108
      StopChecker().
85
109
   
86
110
   d) The creation time of this client object, as an RFC 3339 string.
87
111
   
88
 
   e) Changing this property enables or disables a client.
 
112
   e) Setting this property is equivalent to calling Enable() or
 
113
      Disable().
89
114
   
90
115
   f) The date and time this client will be disabled, as an RFC 3339
91
116
      string, or an empty string if this is not scheduled.
125
150
    milliseconds, depending on ApprovedByDefault.  Approve() can now
126
151
    usefully be called on this client object.
127
152
    
 
153
*** PropertyChanged(s: Property, v: Value)
 
154
    The Property on this client has changed to Value.
 
155
    
128
156
*** Rejected(s: Reason)
129
157
    This client was not given its secret for a specified Reason.
130
158
 
131
159
* Copyright
132
160
 
133
 
    Copyright © 2010-2018 Teddy Hogeborn
134
 
    Copyright © 2010-2018 Björn Påhlsson
 
161
    Copyright © 2010-2012 Teddy Hogeborn
 
162
    Copyright © 2010-2012 Björn Påhlsson
135
163
  
136
164
** License:
137
 
 
138
 
   This file is part of Mandos.
139
 
 
140
 
   Mandos is free software: you can redistribute it and/or modify it
141
 
   under the terms of the GNU General Public License as published by
142
 
   the Free Software Foundation, either version 3 of the License, or
143
 
   (at your option) any later version.
144
 
 
145
 
   Mandos is distributed in the hope that it will be useful, but
 
165
   
 
166
   This program is free software: you can redistribute it and/or
 
167
   modify it under the terms of the GNU General Public License as
 
168
   published by the Free Software Foundation, either version 3 of the
 
169
   License, or (at your option) any later version.
 
170
 
 
171
   This program is distributed in the hope that it will be useful, but
146
172
   WITHOUT ANY WARRANTY; without even the implied warranty of
147
173
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
148
174
   General Public License for more details.
149
175
 
150
176
   You should have received a copy of the GNU General Public License
151
 
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
177
   along with this program.  If not, see
 
178
   <http://www.gnu.org/licenses/>.
152
179
 
153
180
 
154
181
#+STARTUP: showall