/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: 2015-08-02 16:45:29 UTC
  • Revision ID: teddy@recompile.se-20150802164529-pemtk1agiqluoiua
Deprecate some D-Bus methods in favor of D-Bus properties.

The following D-Bus methods on the interface
"se.recompile.Mandos.Client" are redundant, and are therefore
deprecated:  "Disable", "Enable", "StartChecker", and "StopChecker".
Instead, the D-Bus properties "Enabled" and "CheckerRunning" should be
set, as was always also possible.

* DBUS-API (se.recompile.Mandos.Client.Disable): Remove; deprecated.
  (se.recompile.Mandos.Client.Enable): - '' -
  (se.recompile.Mandos.Client.StartChecker): - '' -
  (se.recompile.Mandos.Client.StopChecker): - '' -
* mandos (ClientDBus.Enable): Annotate as deprecated.
  (ClientDBus.StartChecker): - '' -
  (ClientDBus.Disable): - '' -
  (ClientDBus.StopChecker): - '' -
* mandos-monitor (MandosClientWidget.keypress): Set properties instead
                                                of calling deprecated
                                                methods.

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:
73
82
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
74
83
   | LastEnabled (j)         | s    | Read       | N/A                 |
75
84
   | Name                    | s    | Read       | (Section name)      |
 
85
   | ObjectPath              | o    | Read       | N/A                 |
76
86
   | Secret (k)              | ay   | Write      | secret (or secfile) |
77
87
   | Timeout (a)             | t    | Read/Write | timeout             |
78
88
   
109
119
   k) A raw byte array, not hexadecimal digits.
110
120
 
111
121
** Signals
112
 
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
122
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
113
123
    A checker (Command) has completed.  Exitcode is either the exit
114
 
    code or -1 for abnormal exit.  In any case, the full Waitstatus
115
 
    (as from wait(2)) is also available.
 
124
    code or -1 for abnormal exit, in which case, the signal number
 
125
    is available.
116
126
    
117
127
*** CheckerStarted(s: Command)
118
128
    A checker command (Command) has just been started.
130
140
 
131
141
* Copyright
132
142
 
133
 
    Copyright © 2010-2018 Teddy Hogeborn
134
 
    Copyright © 2010-2018 Björn Påhlsson
 
143
    Copyright © 2010-2015 Teddy Hogeborn
 
144
    Copyright © 2010-2015 Björn Påhlsson
135
145
  
136
146
** 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
 
147
   
 
148
   This program is free software: you can redistribute it and/or
 
149
   modify it under the terms of the GNU General Public License as
 
150
   published by the Free Software Foundation, either version 3 of the
 
151
   License, or (at your option) any later version.
 
152
 
 
153
   This program is distributed in the hope that it will be useful, but
146
154
   WITHOUT ANY WARRANTY; without even the implied warranty of
147
155
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
148
156
   General Public License for more details.
149
157
 
150
158
   You should have received a copy of the GNU General Public License
151
 
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
159
   along with this program.  If not, see
 
160
   <http://www.gnu.org/licenses/>.
152
161
 
153
162
 
154
163
#+STARTUP: showall