/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

* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
                                to "_" in D-Bus object paths.
  (MandosServer.handle_ipc): Bug fix: Send only address string to
                             D-Bus signal, not whole tuple.

* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
              "--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.

* mandos-monitor (MandosClientWidget.update): Fix spelling.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
8
8
import locale
9
9
import datetime
10
10
import re
 
11
import os
11
12
 
12
13
locale.setlocale(locale.LC_ALL, u'')
13
14
 
14
15
tablewords = {
15
 
    'name': u'Name',
16
 
    'enabled': u'Enabled',
17
 
    'timeout': u'Timeout',
18
 
    'last_checked_ok': u'Last Successful Check',
19
 
    'created': u'Created',
20
 
    'interval': u'Interval',
21
 
    'host': u'Host',
22
 
    'fingerprint': u'Fingerprint',
23
 
    'checker_running': u'Check Is Running',
24
 
    'last_enabled': u'Last Enabled',
25
 
    'checker': u'Checker',
 
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',
26
31
    }
27
 
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
28
 
                   'checker')
 
32
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
29
33
domain = 'se.bsnet.fukt'
30
34
busname = domain + '.Mandos'
31
35
server_path = '/'
32
36
server_interface = domain + '.Mandos'
33
37
client_interface = domain + '.Mandos.Client'
34
 
version = "1.0.8"
35
 
bus = dbus.SystemBus()
36
 
mandos_dbus_objc = bus.get_object(busname, server_path)
37
 
mandos_serv = dbus.Interface(mandos_dbus_objc,
38
 
                             dbus_interface = server_interface)
39
 
mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
38
version = "1.0.14"
40
39
 
41
 
def datetime_to_milliseconds(dt):
42
 
    "Return the 'timeout' attribute in milliseconds"
43
 
    return ((dt.days * 24 * 60 * 60 * 1000)
44
 
            + (dt.seconds * 1000)
45
 
            + (dt.microseconds // 1000))
 
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))
46
45
 
47
46
def milliseconds_to_string(ms):
48
47
    td = datetime.timedelta(0, 0, 0, ms)
49
 
    return "%s%02d:%02d:%02d" % (("%dT" % td.days) if td.days else "", # days
50
 
                           td.seconds // 3600,        # hours
51
 
                           (td.seconds % 3600) // 60, # minutes
52
 
                           (td.seconds % 60))         # seconds
 
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
                })
53
54
 
54
55
 
55
56
def string_to_delta(interval):
92
93
        timevalue += delta
93
94
    return timevalue
94
95
 
95
 
def print_clients(clients):
 
96
def print_clients(clients, keywords):
96
97
    def valuetostring(value, keyword):
97
98
        if type(value) is dbus.Boolean:
98
99
            return u"Yes" if value else u"No"
99
 
        if keyword in ("timeout", "interval"):
 
100
        if keyword in (u"Timeout", u"Interval", u"ApprovalDelay",
 
101
                       u"ApprovalDuration"):
100
102
            return milliseconds_to_string(value)
101
103
        return unicode(value)
102
104
    
 
105
    # Create format string to print table rows
103
106
    format_string = u' '.join(u'%%-%ds' %
104
107
                              max(len(tablewords[key]),
105
 
                                  max(len(valuetostring(client[key], key))
 
108
                                  max(len(valuetostring(client[key],
 
109
                                                        key))
106
110
                                      for client in
107
111
                                      clients))
108
112
                              for key in keywords)
109
 
    print format_string % tuple(tablewords[key] for key in keywords) 
 
113
    # Print header line
 
114
    print format_string % tuple(tablewords[key] for key in keywords)
110
115
    for client in clients:
111
116
        print format_string % tuple(valuetostring(client[key], key)
112
117
                                    for key in keywords)
113
118
 
114
 
parser = OptionParser(version = "%%prog %s" % version)
115
 
parser.add_option("-a", "--all", action="store_true",
116
 
                  help="Print all fields")
117
 
parser.add_option("-e", "--enable", action="store_true",
118
 
                  help="Enable client")
119
 
parser.add_option("-d", "--disable", action="store_true",
120
 
                  help="disable client")
121
 
parser.add_option("-b", "--bump-timeout", action="store_true",
122
 
                  help="Bump timeout for client")
123
 
parser.add_option("--start-checker", action="store_true",
124
 
                  help="Start checker for client")
125
 
parser.add_option("--stop-checker", action="store_true",
126
 
                  help="Stop checker for client")
127
 
parser.add_option("-V", "--is-valid", action="store_true",
128
 
                  help="Check if client is still valid")
129
 
parser.add_option("-r", "--remove", action="store_true",
130
 
                  help="Remove client")
131
 
parser.add_option("-c", "--checker", type="string",
132
 
                  help="Set checker command for client")
133
 
parser.add_option("-t", "--timeout", type="string",
134
 
                  help="Set timeout for client")
135
 
parser.add_option("-i", "--interval", type="string",
136
 
                  help="Set checker interval for client")
137
 
parser.add_option("-H", "--host", type="string",
138
 
                  help="Set host for client")
139
 
parser.add_option("-s", "--secret", type="string",
140
 
                  help="Set password blob (file) for client")
141
 
options, client_names = parser.parse_args()
142
 
 
143
 
# Compile list of clients to process
144
 
clients=[]
145
 
for name in client_names:
146
 
    for path, client in mandos_clients.iteritems():
147
 
        if client['name'] == name:
148
 
            client_objc = bus.get_object(busname, path)
149
 
            clients.append(dbus.Interface(client_objc,
150
 
                                          dbus_interface
151
 
                                          = client_interface))
152
 
            break
153
 
    else:
154
 
        print >> sys.stderr, "Client not found on server: %r" % name
155
 
        sys.exit(1)
156
 
 
157
 
if not clients and mandos_clients.values():
158
 
    keywords = defaultkeywords
159
 
    if options.all:
160
 
        keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
161
 
                    'created', 'interval', 'host', 'fingerprint',
162
 
                    'checker_running', 'last_enabled', 'checker')
163
 
    print_clients(mandos_clients.values())
164
 
 
165
 
# Process each client in the list by all selected options
166
 
for client in clients:
167
 
    if options.remove:
168
 
        mandos_serv.RemoveClient(client.__dbus_object_path__)
169
 
    if options.enable:
170
 
        client.Enable()
171
 
    if options.disable:
172
 
        client.Disable()
173
 
    if options.bump_timeout:
174
 
        client.BumpTimeout()
175
 
    if options.start_checker:
176
 
        client.StartChecker()
177
 
    if options.stop_checker:
178
 
        client.StopChecker()
179
 
    if options.is_valid:
180
 
        sys.exit(0 if client.IsStillValid() else 1)
181
 
    if options.checker:
182
 
        client.SetChecker(options.checker)
183
 
    if options.host:
184
 
        client.SetHost(options.host)
185
 
    if options.interval:
186
 
        client.SetInterval(datetime_to_milliseconds
187
 
                           (string_to_delta(options.interval)))
188
 
    if options.timeout:
189
 
        client.SetTimeout(datetime_to_milliseconds
190
 
                          (string_to_delta(options.timeout)))
191
 
    if options.secret:
192
 
        client.SetSecret(dbus.ByteArray(open(options.secret, 'rb').read()))
 
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)
193
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()