/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: 2019-03-30 07:03:04 UTC
  • Revision ID: teddy@recompile.se-20190330070304-dqgch62lsaaygg46
mandos-ctl: Refactor D-Bus operations

* mandos-ctl (dbus): Rename imported module to "dbus_python".
  (main): Only create a bus object and do everything via that object.
  (get_mandos_dbus_object): Remove and move code into dbus or
                            dbus_python_adapter namespaces.
  (if_dbus_exception_log_with_exception_and_exit): - '' -
  (SilenceLogger): - '' -
  (dbus): New; move everything dbus-specific into this module-like
          namespace.
  (dbus_python_adapter): New; move everything specific to the
                         dbus-python D-Bus module into this
                         module-like namespace.
  (command.Base.run): Take only a bus argument; use only that.  Pass
                      "client" argument as a D-Bus object path string,
                      not a dbus-python proxy object.  All derivatives
                      adjusted.
  (command.IsEnabled.is_enabled): Remove.
  (command.Approve, command.Deny, command.Remove,
  command.PropertySetter): Do no logging of D-Bus commands, and use
  only bus, not client, to do D-Bus calls.
  (command.DumpJSON.dbus_boolean_to_bool): Remove; move filtering to
                                           dbus_python_adapter.
  (command.Enable, command.Disable, command.StopChecker,
  command.ApproveByDefault): Use normal Python booleans instead of
  dbus-python's special Boolean types.
  (Unique): New; move here out from inside TestPropertySetterCmd.
  (Test_get_mandos_dbus_object): Remove.
  (Test_get_managed_objects): - '' -
  (Test_dbus_exceptions): New.
  (Test_dbus_MandosBus): - '' -
  (Test_dbus_python_adapter_SystemBus): - '' -
  (Test_dbus_python_adapter_CachingBus): - '' -
  (Test_commands_from_options): Don't create mock client proxy
  objects, define dict of client properties and use a mock dbus to
  verify that the correct D-Bus calls are made.  Also remove any types
  specific to dbus-python.
  (TestEnableCmd, TestDisableCmd, TestStartCheckerCmd,
  TestStopCheckerCmd, TestApproveByDefaultCmd, TestDenyByDefaultCmd):
  Use normal Python booleans instead of dbus-python's special Boolean
  types.
  (TestPropertySetterValueCmd.runTest): Remove; unnecessary.

Show diffs side-by-side

added added

removed removed

Lines of Context:
13
13
  | Path                  | Object            |
14
14
  |-----------------------+-------------------|
15
15
  | "/"                   | The Mandos Server |
16
 
  | "/clients/CLIENTNAME" | Mandos Client     |
17
 
 
18
 
  
 
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
 
19
22
* Mandos Server Interface:
20
23
  Interface name: "se.recompile.Mandos"
21
24
  
22
25
** 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
26
*** RemoveClient(o: ObjectPath) → nothing
30
27
    Removes a client
31
28
   
32
29
** 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
 
30
*** ClientNotFound(s: KeyID, s: Address)
 
31
    A client connected from Address using KeyID, but was
 
32
    rejected because it was not found in the server.  The key ID
39
33
    is represented as a string of hexadecimal digits.  The address is
40
34
    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
35
 
45
36
 
46
37
* Mandos Client Interface:
75
66
   | Expires (f)             | s    | Read       | N/A                 |
76
67
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
77
68
   | Fingerprint             | s    | Read       | fingerprint         |
 
69
   | KeyID                   | s    | Read       | key_id              |
78
70
   | Host                    | s    | Read/Write | host                |
79
71
   | Interval (a)            | t    | Read/Write | interval            |
80
72
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
139
131
 
140
132
* Copyright
141
133
 
142
 
    Copyright © 2010-2015 Teddy Hogeborn
143
 
    Copyright © 2010-2015 Björn Påhlsson
 
134
    Copyright © 2010-2019 Teddy Hogeborn
 
135
    Copyright © 2010-2019 Björn Påhlsson
144
136
  
145
137
** License:
146
 
   
147
 
   This program is free software: you can redistribute it and/or
148
 
   modify it under the terms of the GNU General Public License as
149
 
   published by the Free Software Foundation, either version 3 of the
150
 
   License, or (at your option) any later version.
151
 
 
152
 
   This program is distributed in the hope that it will be useful, but
 
138
 
 
139
   This file is part of Mandos.
 
140
 
 
141
   Mandos is free software: you can redistribute it and/or modify it
 
142
   under the terms of the GNU General Public License as published by
 
143
   the Free Software Foundation, either version 3 of the License, or
 
144
   (at your option) any later version.
 
145
 
 
146
   Mandos is distributed in the hope that it will be useful, but
153
147
   WITHOUT ANY WARRANTY; without even the implied warranty of
154
148
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
155
149
   General Public License for more details.
156
150
 
157
151
   You should have received a copy of the GNU General Public License
158
 
   along with this program.  If not, see
159
 
   <http://www.gnu.org/licenses/>.
 
152
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
160
153
 
161
154
 
162
155
#+STARTUP: showall