/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 mandos-ctl

First version of a somewhat complete D-Bus server interface.  Also
change user/group name to "_mandos".

* debian/mandos.postinst: Rename old "mandos" user and group to
                          "_mandos"; create "_mandos" user and group
                          if none exist.
* debian/mandos-client.postinst: - '' -

* initramfs-tools-hook: Try "_mandos" before "mandos" as user and
                        group name.

* mandos (_datetime_to_dbus_struct): New; was previously local.
  (Client.started): Renamed to "last_started".  All users changed.
  (Client.started): New; boolean.
  (Client.dbus_object_path): New.
  (Client.check_command): Renamed to "checker_command".  All users
                          changed.
  (Client.__init__): Set and use "self.dbus_object_path".  Set
                     "self.started".
  (Client.start): Update "self.started".  Emit "self.PropertyChanged"
                  signals for both "started" and "last_started".
  (Client.stop): Update "self.started".  Emit "self.PropertyChanged"
                 signal for "started".
  (Client.checker_callback): Take additional "command" argument.  All
                             callers changed. Emit
                             "self.PropertyChanged" signal.
  (Client.bump_timeout): Emit "self.PropertyChanged" signal for
                         "last_checked_ok".
  (Client.start_checker): Emit "self.PropertyChanged" signal for
                          "checker_running".
  (Client.stop_checker): Emit "self.PropertyChanged" signal for
                         "checker_running".
  (Client.still_valid): Bug fix: use "getattr(self, started, False)"
                        instead of "self.started" in case this client
                        object is so new that the "started" attribute
                        has not been created yet.
  (Client.IntervalChanged, Client.CheckerIsRunning, Client.GetChecker,
  Client.GetCreated, Client.GetFingerprint, Client.GetHost,
  Client.GetInterval, Client.GetName, Client.GetStarted,
  Client.GetTimeout, Client.StateChanged, Client.TimeoutChanged):
  Removed; all callers changed.
  (Client.CheckerCompleted): Add "condition" and "command" arguments.
                             All callers changed.
  (Client.GetAllProperties, Client.PropertyChanged): New.
  (Client.StillValid): Renamed to "IsStillValid".
  (Client.StartChecker): Changed to its own function to avoid the
                         return value from "Client.start_checker()".
  (Client.Stop): Changed to its own function to avoid the return value
                 from "Client.stop()".
  (main): Try "_mandos" before "mandos" as user and group name.
          Removed inner function "remove_from_clients".  New inner
          class "MandosServer".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
 
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
3
 
 
4
 
from __future__ import division
5
 
import sys
6
 
import dbus
7
 
from optparse import OptionParser
8
 
import locale
9
 
import datetime
10
 
import re
11
 
import os
12
 
 
13
 
locale.setlocale(locale.LC_ALL, u'')
14
 
 
15
 
tablewords = {
16
 
    'Name': u'Name',
17
 
    'Enabled': u'Enabled',
18
 
    'Timeout': u'Timeout',
19
 
    'LastCheckedOK': u'Last Successful Check',
20
 
    'Created': u'Created',
21
 
    'Interval': u'Interval',
22
 
    'Host': u'Host',
23
 
    'Fingerprint': u'Fingerprint',
24
 
    'CheckerRunning': u'Check Is Running',
25
 
    'LastEnabled': u'Last Enabled',
26
 
    'ApprovalPending': u'Approval Is Pending',
27
 
    'ApprovedByDefault': u'Approved By Default',
28
 
    'ApprovalDelay': u"Approval Delay",
29
 
    'ApprovalDuration': u"Approval Duration",
30
 
    'Checker': u'Checker',
31
 
    }
32
 
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
33
 
domain = 'se.bsnet.fukt'
34
 
busname = domain + '.Mandos'
35
 
server_path = '/'
36
 
server_interface = domain + '.Mandos'
37
 
client_interface = domain + '.Mandos.Client'
38
 
version = "1.0.14"
39
 
 
40
 
def timedelta_to_milliseconds(td):
41
 
    "Convert a datetime.timedelta object to milliseconds"
42
 
    return ((td.days * 24 * 60 * 60 * 1000)
43
 
            + (td.seconds * 1000)
44
 
            + (td.microseconds // 1000))
45
 
 
46
 
def milliseconds_to_string(ms):
47
 
    td = datetime.timedelta(0, 0, 0, ms)
48
 
    return (u"%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
49
 
            % { "days": "%dT" % td.days if td.days else "",
50
 
                "hours": td.seconds // 3600,
51
 
                "minutes": (td.seconds % 3600) // 60,
52
 
                "seconds": td.seconds % 60,
53
 
                })
54
 
 
55
 
 
56
 
def string_to_delta(interval):
57
 
    """Parse a string and return a datetime.timedelta
58
 
 
59
 
    >>> string_to_delta('7d')
60
 
    datetime.timedelta(7)
61
 
    >>> string_to_delta('60s')
62
 
    datetime.timedelta(0, 60)
63
 
    >>> string_to_delta('60m')
64
 
    datetime.timedelta(0, 3600)
65
 
    >>> string_to_delta('24h')
66
 
    datetime.timedelta(1)
67
 
    >>> string_to_delta(u'1w')
68
 
    datetime.timedelta(7)
69
 
    >>> string_to_delta('5m 30s')
70
 
    datetime.timedelta(0, 330)
71
 
    """
72
 
    timevalue = datetime.timedelta(0)
73
 
    regexp = re.compile("\d+[dsmhw]")
74
 
    
75
 
    for s in regexp.findall(interval):
76
 
        try:
77
 
            suffix = unicode(s[-1])
78
 
            value = int(s[:-1])
79
 
            if suffix == u"d":
80
 
                delta = datetime.timedelta(value)
81
 
            elif suffix == u"s":
82
 
                delta = datetime.timedelta(0, value)
83
 
            elif suffix == u"m":
84
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
85
 
            elif suffix == u"h":
86
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
87
 
            elif suffix == u"w":
88
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
89
 
            else:
90
 
                raise ValueError
91
 
        except (ValueError, IndexError):
92
 
            raise ValueError
93
 
        timevalue += delta
94
 
    return timevalue
95
 
 
96
 
def print_clients(clients, keywords):
97
 
    def valuetostring(value, keyword):
98
 
        if type(value) is dbus.Boolean:
99
 
            return u"Yes" if value else u"No"
100
 
        if keyword in (u"Timeout", u"Interval", u"ApprovalDelay",
101
 
                       u"ApprovalDuration"):
102
 
            return milliseconds_to_string(value)
103
 
        return unicode(value)
104
 
    
105
 
    # Create format string to print table rows
106
 
    format_string = u' '.join(u'%%-%ds' %
107
 
                              max(len(tablewords[key]),
108
 
                                  max(len(valuetostring(client[key],
109
 
                                                        key))
110
 
                                      for client in
111
 
                                      clients))
112
 
                              for key in keywords)
113
 
    # Print header line
114
 
    print format_string % tuple(tablewords[key] for key in keywords)
115
 
    for client in clients:
116
 
        print format_string % tuple(valuetostring(client[key], key)
117
 
                                    for key in keywords)
118
 
 
119
 
def has_actions(options):
120
 
    return any((options.enable,
121
 
                options.disable,
122
 
                options.bump_timeout,
123
 
                options.start_checker,
124
 
                options.stop_checker,
125
 
                options.is_enabled,
126
 
                options.remove,
127
 
                options.checker is not None,
128
 
                options.timeout is not None,
129
 
                options.interval is not None,
130
 
                options.approved_by_default is not None,
131
 
                options.approval_delay is not None,
132
 
                options.approval_duration is not None,
133
 
                options.host is not None,
134
 
                options.secret is not None,
135
 
                options.approve,
136
 
                options.deny))
137
 
        
138
 
def main():
139
 
        parser = OptionParser(version = "%%prog %s" % version)
140
 
        parser.add_option("-a", "--all", action="store_true",
141
 
                          help="Select all clients")
142
 
        parser.add_option("-v", "--verbose", action="store_true",
143
 
                          help="Print all fields")
144
 
        parser.add_option("-e", "--enable", action="store_true",
145
 
                          help="Enable client")
146
 
        parser.add_option("-d", "--disable", action="store_true",
147
 
                          help="disable client")
148
 
        parser.add_option("-b", "--bump-timeout", action="store_true",
149
 
                          help="Bump timeout for client")
150
 
        parser.add_option("--start-checker", action="store_true",
151
 
                          help="Start checker for client")
152
 
        parser.add_option("--stop-checker", action="store_true",
153
 
                          help="Stop checker for client")
154
 
        parser.add_option("-V", "--is-enabled", action="store_true",
155
 
                          help="Check if client is enabled")
156
 
        parser.add_option("-r", "--remove", action="store_true",
157
 
                          help="Remove client")
158
 
        parser.add_option("-c", "--checker", type="string",
159
 
                          help="Set checker command for client")
160
 
        parser.add_option("-t", "--timeout", type="string",
161
 
                          help="Set timeout for client")
162
 
        parser.add_option("-i", "--interval", type="string",
163
 
                          help="Set checker interval for client")
164
 
        parser.add_option("--approve-by-default", action="store_true",
165
 
                          dest=u"approved_by_default",
166
 
                          help="Set client to be approved by default")
167
 
        parser.add_option("--deny-by-default", action="store_false",
168
 
                          dest=u"approved_by_default",
169
 
                          help="Set client to be denied by default")
170
 
        parser.add_option("--approval-delay", type="string",
171
 
                          help="Set delay before client approve/deny")
172
 
        parser.add_option("--approval-duration", type="string",
173
 
                          help="Set duration of one client approval")
174
 
        parser.add_option("-H", "--host", type="string",
175
 
                          help="Set host for client")
176
 
        parser.add_option("-s", "--secret", type="string",
177
 
                          help="Set password blob (file) for client")
178
 
        parser.add_option("-A", "--approve", action="store_true",
179
 
                          help="Approve any current client request")
180
 
        parser.add_option("-D", "--deny", action="store_true",
181
 
                          help="Deny any current client request")
182
 
        options, client_names = parser.parse_args()
183
 
        
184
 
        if has_actions(options) and not client_names and not options.all:
185
 
            parser.error('Options require clients names or --all.')
186
 
        if options.verbose and has_actions(options):
187
 
            parser.error('--verbose can only be used alone or with'
188
 
                         ' --all.')
189
 
        if options.all and not has_actions(options):
190
 
            parser.error('--all requires an action.')
191
 
        
192
 
        try:
193
 
            bus = dbus.SystemBus()
194
 
            mandos_dbus_objc = bus.get_object(busname, server_path)
195
 
        except dbus.exceptions.DBusException:
196
 
            print >> sys.stderr, "Could not connect to Mandos server"
197
 
            sys.exit(1)
198
 
    
199
 
        mandos_serv = dbus.Interface(mandos_dbus_objc,
200
 
                                     dbus_interface = server_interface)
201
 
 
202
 
        #block stderr since dbus library prints to stderr
203
 
        null = os.open(os.path.devnull, os.O_RDWR)
204
 
        stderrcopy = os.dup(sys.stderr.fileno())
205
 
        os.dup2(null, sys.stderr.fileno())
206
 
        os.close(null)
207
 
        try:
208
 
            try:
209
 
                mandos_clients = mandos_serv.GetAllClientsWithProperties()
210
 
            finally:
211
 
                #restore stderr
212
 
                os.dup2(stderrcopy, sys.stderr.fileno())
213
 
                os.close(stderrcopy)
214
 
        except dbus.exceptions.DBusException, e:
215
 
            print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
216
 
            sys.exit(1)
217
 
            
218
 
        # Compile dict of (clients: properties) to process
219
 
        clients={}
220
 
        
221
 
        if options.all or not client_names:
222
 
            clients = dict((bus.get_object(busname, path), properties)
223
 
                           for path, properties in
224
 
                           mandos_clients.iteritems())
225
 
        else:
226
 
            for name in client_names:
227
 
                for path, client in mandos_clients.iteritems():
228
 
                    if client['Name'] == name:
229
 
                        client_objc = bus.get_object(busname, path)
230
 
                        clients[client_objc] = client
231
 
                        break
232
 
                else:
233
 
                    print >> sys.stderr, "Client not found on server: %r" % name
234
 
                    sys.exit(1)
235
 
            
236
 
        if not has_actions(options) and clients:
237
 
            if options.verbose:
238
 
                keywords = ('Name', 'Enabled', 'Timeout',
239
 
                            'LastCheckedOK', 'Created', 'Interval',
240
 
                            'Host', 'Fingerprint', 'CheckerRunning',
241
 
                            'LastEnabled', 'ApprovalPending',
242
 
                            'ApprovedByDefault', 'ApprovalDelay',
243
 
                            'ApprovalDuration', 'Checker')
244
 
            else:
245
 
                keywords = defaultkeywords
246
 
                
247
 
            print_clients(clients.values(), keywords)
248
 
        else:
249
 
            # Process each client in the list by all selected options
250
 
            for client in clients:
251
 
                if options.remove:
252
 
                    mandos_serv.RemoveClient(client.__dbus_object_path__)
253
 
                if options.enable:
254
 
                    client.Enable(dbus_interface=client_interface)
255
 
                if options.disable:
256
 
                    client.Disable(dbus_interface=client_interface)
257
 
                if options.bump_timeout:
258
 
                    client.CheckedOK(dbus_interface=client_interface)
259
 
                if options.start_checker:
260
 
                    client.StartChecker(dbus_interface=client_interface)
261
 
                if options.stop_checker:
262
 
                    client.StopChecker(dbus_interface=client_interface)
263
 
                if options.is_enabled:
264
 
                    sys.exit(0 if client.Get(client_interface,
265
 
                                             u"Enabled",
266
 
                                             dbus_interface=dbus.PROPERTIES_IFACE)
267
 
                             else 1)
268
 
                if options.checker:
269
 
                    client.Set(client_interface, u"Checker", options.checker,
270
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
271
 
                if options.host:
272
 
                    client.Set(client_interface, u"Host", options.host,
273
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
274
 
                if options.interval:
275
 
                    client.Set(client_interface, u"Interval",
276
 
                               timedelta_to_milliseconds
277
 
                               (string_to_delta(options.interval)),
278
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
279
 
                if options.approval_delay:
280
 
                    client.Set(client_interface, u"ApprovalDelay",
281
 
                               timedelta_to_milliseconds
282
 
                               (string_to_delta(options.
283
 
                                                approval_delay)),
284
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
285
 
                if options.approval_duration:
286
 
                    client.Set(client_interface, u"ApprovalDuration",
287
 
                               timedelta_to_milliseconds
288
 
                               (string_to_delta(options.
289
 
                                                approval_duration)),
290
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
291
 
                if options.timeout:
292
 
                    client.Set(client_interface, u"Timeout",
293
 
                               timedelta_to_milliseconds
294
 
                               (string_to_delta(options.timeout)),
295
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
296
 
                if options.secret:
297
 
                    client.Set(client_interface, u"Secret",
298
 
                               dbus.ByteArray(open(options.secret,
299
 
                                                   u'rb').read()),
300
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
301
 
                if options.approved_by_default is not None:
302
 
                    client.Set(client_interface, u"ApprovedByDefault",
303
 
                               dbus.Boolean(options
304
 
                                            .approved_by_default),
305
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
306
 
                if options.approve:
307
 
                    client.Approve(dbus.Boolean(True),
308
 
                                   dbus_interface=client_interface)
309
 
                elif options.deny:
310
 
                    client.Approve(dbus.Boolean(False),
311
 
                                   dbus_interface=client_interface)
312
 
 
313
 
if __name__ == '__main__':
314
 
    main()