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

  • Committer: Teddy Hogeborn
  • Date: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

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
12
11
 
13
12
locale.setlocale(locale.LC_ALL, u'')
14
13
 
17
16
    'Enabled': u'Enabled',
18
17
    'Timeout': u'Timeout',
19
18
    'LastCheckedOK': u'Last Successful Check',
20
 
    'LastApprovalRequest': u'Last Approval Request',
21
19
    'Created': u'Created',
22
20
    'Interval': u'Interval',
23
21
    'Host': u'Host',
24
22
    'Fingerprint': u'Fingerprint',
25
23
    'CheckerRunning': u'Check Is Running',
26
24
    'LastEnabled': u'Last Enabled',
27
 
    'ApprovalPending': u'Approval Is Pending',
28
 
    'ApprovedByDefault': u'Approved By Default',
29
 
    'ApprovalDelay': u"Approval Delay",
30
 
    'ApprovalDuration': u"Approval Duration",
31
25
    'Checker': u'Checker',
32
26
    }
33
27
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
37
31
server_interface = domain + '.Mandos'
38
32
client_interface = domain + '.Mandos.Client'
39
33
version = "1.0.14"
 
34
try:
 
35
    bus = dbus.SystemBus()
 
36
    mandos_dbus_objc = bus.get_object(busname, server_path)
 
37
except dbus.exceptions.DBusException:
 
38
    sys.exit(1)
 
39
    
 
40
mandos_serv = dbus.Interface(mandos_dbus_objc,
 
41
                             dbus_interface = server_interface)
 
42
mandos_clients = mandos_serv.GetAllClientsWithProperties()
40
43
 
41
44
def timedelta_to_milliseconds(td):
42
45
    "Convert a datetime.timedelta object to milliseconds"
94
97
        timevalue += delta
95
98
    return timevalue
96
99
 
97
 
def print_clients(clients, keywords):
 
100
def print_clients(clients):
98
101
    def valuetostring(value, keyword):
99
102
        if type(value) is dbus.Boolean:
100
103
            return u"Yes" if value else u"No"
101
 
        if keyword in (u"Timeout", u"Interval", u"ApprovalDelay",
102
 
                       u"ApprovalDuration"):
 
104
        if keyword in (u"timeout", u"interval"):
103
105
            return milliseconds_to_string(value)
104
106
        return unicode(value)
105
107
    
117
119
        print format_string % tuple(valuetostring(client[key], key)
118
120
                                    for key in keywords)
119
121
 
120
 
def has_actions(options):
121
 
    return any((options.enable,
122
 
                options.disable,
123
 
                options.bump_timeout,
124
 
                options.start_checker,
125
 
                options.stop_checker,
126
 
                options.is_enabled,
127
 
                options.remove,
128
 
                options.checker is not None,
129
 
                options.timeout is not None,
130
 
                options.interval is not None,
131
 
                options.approved_by_default is not None,
132
 
                options.approval_delay is not None,
133
 
                options.approval_duration is not None,
134
 
                options.host is not None,
135
 
                options.secret is not None,
136
 
                options.approve,
137
 
                options.deny))
138
 
        
139
 
def main():
140
 
        parser = OptionParser(version = "%%prog %s" % version)
141
 
        parser.add_option("-a", "--all", action="store_true",
142
 
                          help="Select all clients")
143
 
        parser.add_option("-v", "--verbose", action="store_true",
144
 
                          help="Print all fields")
145
 
        parser.add_option("-e", "--enable", action="store_true",
146
 
                          help="Enable client")
147
 
        parser.add_option("-d", "--disable", action="store_true",
148
 
                          help="disable client")
149
 
        parser.add_option("-b", "--bump-timeout", action="store_true",
150
 
                          help="Bump timeout for client")
151
 
        parser.add_option("--start-checker", action="store_true",
152
 
                          help="Start checker for client")
153
 
        parser.add_option("--stop-checker", action="store_true",
154
 
                          help="Stop checker for client")
155
 
        parser.add_option("-V", "--is-enabled", action="store_true",
156
 
                          help="Check if client is enabled")
157
 
        parser.add_option("-r", "--remove", action="store_true",
158
 
                          help="Remove client")
159
 
        parser.add_option("-c", "--checker", type="string",
160
 
                          help="Set checker command for client")
161
 
        parser.add_option("-t", "--timeout", type="string",
162
 
                          help="Set timeout for client")
163
 
        parser.add_option("-i", "--interval", type="string",
164
 
                          help="Set checker interval for client")
165
 
        parser.add_option("--approve-by-default", action="store_true",
166
 
                          dest=u"approved_by_default",
167
 
                          help="Set client to be approved by default")
168
 
        parser.add_option("--deny-by-default", action="store_false",
169
 
                          dest=u"approved_by_default",
170
 
                          help="Set client to be denied by default")
171
 
        parser.add_option("--approval-delay", type="string",
172
 
                          help="Set delay before client approve/deny")
173
 
        parser.add_option("--approval-duration", type="string",
174
 
                          help="Set duration of one client approval")
175
 
        parser.add_option("-H", "--host", type="string",
176
 
                          help="Set host for client")
177
 
        parser.add_option("-s", "--secret", type="string",
178
 
                          help="Set password blob (file) for client")
179
 
        parser.add_option("-A", "--approve", action="store_true",
180
 
                          help="Approve any current client request")
181
 
        parser.add_option("-D", "--deny", action="store_true",
182
 
                          help="Deny any current client request")
183
 
        options, client_names = parser.parse_args()
184
 
        
185
 
        if has_actions(options) and not client_names and not options.all:
186
 
            parser.error('Options require clients names or --all.')
187
 
        if options.verbose and has_actions(options):
188
 
            parser.error('--verbose can only be used alone or with'
189
 
                         ' --all.')
190
 
        if options.all and not has_actions(options):
191
 
            parser.error('--all requires an action.')
192
 
        
193
 
        try:
194
 
            bus = dbus.SystemBus()
195
 
            mandos_dbus_objc = bus.get_object(busname, server_path)
196
 
        except dbus.exceptions.DBusException:
197
 
            print >> sys.stderr, "Could not connect to Mandos server"
198
 
            sys.exit(1)
199
 
    
200
 
        mandos_serv = dbus.Interface(mandos_dbus_objc,
201
 
                                     dbus_interface = server_interface)
202
 
 
203
 
        #block stderr since dbus library prints to stderr
204
 
        null = os.open(os.path.devnull, os.O_RDWR)
205
 
        stderrcopy = os.dup(sys.stderr.fileno())
206
 
        os.dup2(null, sys.stderr.fileno())
207
 
        os.close(null)
208
 
        try:
209
 
            try:
210
 
                mandos_clients = mandos_serv.GetAllClientsWithProperties()
211
 
            finally:
212
 
                #restore stderr
213
 
                os.dup2(stderrcopy, sys.stderr.fileno())
214
 
                os.close(stderrcopy)
215
 
        except dbus.exceptions.DBusException, e:
216
 
            print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
217
 
            sys.exit(1)
218
 
            
219
 
        # Compile dict of (clients: properties) to process
220
 
        clients={}
221
 
        
222
 
        if options.all or not client_names:
223
 
            clients = dict((bus.get_object(busname, path), properties)
224
 
                           for path, properties in
225
 
                           mandos_clients.iteritems())
226
 
        else:
227
 
            for name in client_names:
228
 
                for path, client in mandos_clients.iteritems():
229
 
                    if client['Name'] == name:
230
 
                        client_objc = bus.get_object(busname, path)
231
 
                        clients[client_objc] = client
232
 
                        break
233
 
                else:
234
 
                    print >> sys.stderr, "Client not found on server: %r" % name
235
 
                    sys.exit(1)
236
 
            
237
 
        if not has_actions(options) and clients:
238
 
            if options.verbose:
239
 
                keywords = ('Name', 'Enabled', 'Timeout',
240
 
                            'LastCheckedOK', 'Created', 'Interval',
241
 
                            'Host', 'Fingerprint', 'CheckerRunning',
242
 
                            'LastEnabled', 'ApprovalPending',
243
 
                            'ApprovedByDefault',
244
 
                            'LastApprovalRequest', 'ApprovalDelay',
245
 
                            'ApprovalDuration', 'Checker')
246
 
            else:
247
 
                keywords = defaultkeywords
248
 
            
249
 
            print_clients(clients.values(), keywords)
250
 
        else:
251
 
            # Process each client in the list by all selected options
252
 
            for client in clients:
253
 
                if options.remove:
254
 
                    mandos_serv.RemoveClient(client.__dbus_object_path__)
255
 
                if options.enable:
256
 
                    client.Enable(dbus_interface=client_interface)
257
 
                if options.disable:
258
 
                    client.Disable(dbus_interface=client_interface)
259
 
                if options.bump_timeout:
260
 
                    client.CheckedOK(dbus_interface=client_interface)
261
 
                if options.start_checker:
262
 
                    client.StartChecker(dbus_interface=client_interface)
263
 
                if options.stop_checker:
264
 
                    client.StopChecker(dbus_interface=client_interface)
265
 
                if options.is_enabled:
266
 
                    sys.exit(0 if client.Get(client_interface,
267
 
                                             u"Enabled",
268
 
                                             dbus_interface=dbus.PROPERTIES_IFACE)
269
 
                             else 1)
270
 
                if options.checker:
271
 
                    client.Set(client_interface, u"Checker", options.checker,
272
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
273
 
                if options.host:
274
 
                    client.Set(client_interface, u"Host", options.host,
275
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
276
 
                if options.interval:
277
 
                    client.Set(client_interface, u"Interval",
278
 
                               timedelta_to_milliseconds
279
 
                               (string_to_delta(options.interval)),
280
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
281
 
                if options.approval_delay:
282
 
                    client.Set(client_interface, u"ApprovalDelay",
283
 
                               timedelta_to_milliseconds
284
 
                               (string_to_delta(options.
285
 
                                                approval_delay)),
286
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
287
 
                if options.approval_duration:
288
 
                    client.Set(client_interface, u"ApprovalDuration",
289
 
                               timedelta_to_milliseconds
290
 
                               (string_to_delta(options.
291
 
                                                approval_duration)),
292
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
293
 
                if options.timeout:
294
 
                    client.Set(client_interface, u"Timeout",
295
 
                               timedelta_to_milliseconds
296
 
                               (string_to_delta(options.timeout)),
297
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
298
 
                if options.secret:
299
 
                    client.Set(client_interface, u"Secret",
300
 
                               dbus.ByteArray(open(options.secret,
301
 
                                                   u'rb').read()),
302
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
303
 
                if options.approved_by_default is not None:
304
 
                    client.Set(client_interface, u"ApprovedByDefault",
305
 
                               dbus.Boolean(options
306
 
                                            .approved_by_default),
307
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
308
 
                if options.approve:
309
 
                    client.Approve(dbus.Boolean(True),
310
 
                                   dbus_interface=client_interface)
311
 
                elif options.deny:
312
 
                    client.Approve(dbus.Boolean(False),
313
 
                                   dbus_interface=client_interface)
314
 
 
315
 
if __name__ == '__main__':
316
 
    main()
 
122
parser = OptionParser(version = "%%prog %s" % version)
 
123
parser.add_option("-a", "--all", action="store_true",
 
124
                  help="Print all fields")
 
125
parser.add_option("-e", "--enable", action="store_true",
 
126
                  help="Enable client")
 
127
parser.add_option("-d", "--disable", action="store_true",
 
128
                  help="disable client")
 
129
parser.add_option("-b", "--bump-timeout", action="store_true",
 
130
                  help="Bump timeout for client")
 
131
parser.add_option("--start-checker", action="store_true",
 
132
                  help="Start checker for client")
 
133
parser.add_option("--stop-checker", action="store_true",
 
134
                  help="Stop checker for client")
 
135
parser.add_option("-V", "--is-enabled", action="store_true",
 
136
                  help="Check if client is enabled")
 
137
parser.add_option("-r", "--remove", action="store_true",
 
138
                  help="Remove client")
 
139
parser.add_option("-c", "--checker", type="string",
 
140
                  help="Set checker command for client")
 
141
parser.add_option("-t", "--timeout", type="string",
 
142
                  help="Set timeout for client")
 
143
parser.add_option("-i", "--interval", type="string",
 
144
                  help="Set checker interval for client")
 
145
parser.add_option("-H", "--host", type="string",
 
146
                  help="Set host for client")
 
147
parser.add_option("-s", "--secret", type="string",
 
148
                  help="Set password blob (file) for client")
 
149
parser.add_option("-A", "--approve", action="store_true",
 
150
                  help="Approve any current client request")
 
151
parser.add_option("-D", "--deny", action="store_true",
 
152
                  help="Deny any current client request")
 
153
options, client_names = parser.parse_args()
 
154
 
 
155
# Compile list of clients to process
 
156
clients=[]
 
157
for name in client_names:
 
158
    for path, client in mandos_clients.iteritems():
 
159
        if client['name'] == name:
 
160
            client_objc = bus.get_object(busname, path)
 
161
            clients.append(client_objc)
 
162
            break
 
163
    else:
 
164
        print >> sys.stderr, "Client not found on server: %r" % name
 
165
        sys.exit(1)
 
166
 
 
167
if not clients and mandos_clients.values():
 
168
    keywords = defaultkeywords
 
169
    if options.all:
 
170
        keywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK',
 
171
                    'Created', 'Interval', 'Host', 'Fingerprint',
 
172
                    'CheckerRunning', 'LastEnabled', 'Checker')
 
173
    print_clients(mandos_clients.values())
 
174
 
 
175
# Process each client in the list by all selected options
 
176
for client in clients:
 
177
    if options.remove:
 
178
        mandos_serv.RemoveClient(client.__dbus_object_path__)
 
179
    if options.enable:
 
180
        client.Enable(dbus_interface=client_interface)
 
181
    if options.disable:
 
182
        client.Disable(dbus_interface=client_interface)
 
183
    if options.bump_timeout:
 
184
        client.CheckedOK(dbus_interface=client_interface)
 
185
    if options.start_checker:
 
186
        client.StartChecker(dbus_interface=client_interface)
 
187
    if options.stop_checker:
 
188
        client.StopChecker(dbus_interface=client_interface)
 
189
    if options.is_enabled:
 
190
        sys.exit(0 if client.Get(client_interface,
 
191
                                 u"Enabled",
 
192
                                 dbus_interface=dbus.PROPERTIES_IFACE)
 
193
                 else 1)
 
194
    if options.checker:
 
195
        client.Set(client_interface, u"Checker", options.checker,
 
196
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
197
    if options.host:
 
198
        client.Set(client_interface, u"Host", options.host,
 
199
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
200
    if options.interval:
 
201
        client.Set(client_interface, u"Interval",
 
202
                   timedelta_to_milliseconds
 
203
                   (string_to_delta(options.interval)),
 
204
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
205
    if options.timeout:
 
206
        client.Set(client_interface, u"Timeout",
 
207
                   timedelta_to_milliseconds(string_to_delta
 
208
                                             (options.timeout)),
 
209
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
210
    if options.secret:
 
211
        client.Set(client_interface, u"Secret",
 
212
                   dbus.ByteArray(open(options.secret, u'rb').read()),
 
213
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
214
    if options.approve:
 
215
        client.Approve(dbus.Boolean(True),
 
216
                       dbus_interface=client_interface)
 
217
    if options.deny:
 
218
        client.Approve(dbus.Boolean(False),
 
219
                       dbus_interface=client_interface)