/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
 
15
14
tablewords = {
16
 
    'name': u'Name',
17
 
    'enabled': u'Enabled',
18
 
    'timeout': u'Timeout',
19
 
    'last_checked_ok': u'Last Successful Check',
20
 
    'created': u'Created',
21
 
    'interval': u'Interval',
22
 
    'host': u'Host',
23
 
    'fingerprint': u'Fingerprint',
24
 
    'checker_running': u'Check Is Running',
25
 
    'last_enabled': u'Last Enabled',
26
 
    'checker': u'Checker',
 
15
    'Name': u'Name',
 
16
    'Enabled': u'Enabled',
 
17
    'Timeout': u'Timeout',
 
18
    'LastCheckedOK': u'Last Successful Check',
 
19
    'Created': u'Created',
 
20
    'Interval': u'Interval',
 
21
    'Host': u'Host',
 
22
    'Fingerprint': u'Fingerprint',
 
23
    'CheckerRunning': u'Check Is Running',
 
24
    'LastEnabled': u'Last Enabled',
 
25
    'Checker': u'Checker',
27
26
    }
28
 
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok')
 
27
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
29
28
domain = 'se.bsnet.fukt'
30
29
busname = domain + '.Mandos'
31
30
server_path = '/'
32
31
server_interface = domain + '.Mandos'
33
32
client_interface = domain + '.Mandos.Client'
34
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()
35
43
 
36
44
def timedelta_to_milliseconds(td):
37
45
    "Convert a datetime.timedelta object to milliseconds"
89
97
        timevalue += delta
90
98
    return timevalue
91
99
 
92
 
def print_clients(clients, keywords):
 
100
def print_clients(clients):
93
101
    def valuetostring(value, keyword):
94
102
        if type(value) is dbus.Boolean:
95
103
            return u"Yes" if value else u"No"
100
108
    # Create format string to print table rows
101
109
    format_string = u' '.join(u'%%-%ds' %
102
110
                              max(len(tablewords[key]),
103
 
                                  max(len(valuetostring(client[key], key))
 
111
                                  max(len(valuetostring(client[key],
 
112
                                                        key))
104
113
                                      for client in
105
114
                                      clients))
106
115
                              for key in keywords)
109
118
    for client in clients:
110
119
        print format_string % tuple(valuetostring(client[key], key)
111
120
                                    for key in keywords)
112
 
def has_actions(options):
113
 
    return any((options.enable,
114
 
                options.disable,
115
 
                options.bump_timeout,
116
 
                options.start_checker,
117
 
                options.stop_checker,
118
 
                options.is_enabled,
119
 
                options.remove,
120
 
                options.checker is not None,
121
 
                options.timeout is not None,
122
 
                options.interval is not None,
123
 
                options.host is not None,
124
 
                options.secret is not None,
125
 
                options.approve,
126
 
                options.deny))
127
 
        
128
 
def main():
129
 
        parser = OptionParser(version = "%%prog %s" % version)
130
 
        parser.add_option("-a", "--all", action="store_true",
131
 
                          help="Select all clients")
132
 
        parser.add_option("-v", "--verbose", action="store_true",
133
 
                          help="Print all fields")
134
 
        parser.add_option("-e", "--enable", action="store_true",
135
 
                          help="Enable client")
136
 
        parser.add_option("-d", "--disable", action="store_true",
137
 
                          help="disable client")
138
 
        parser.add_option("-b", "--bump-timeout", action="store_true",
139
 
                          help="Bump timeout for client")
140
 
        parser.add_option("--start-checker", action="store_true",
141
 
                          help="Start checker for client")
142
 
        parser.add_option("--stop-checker", action="store_true",
143
 
                          help="Stop checker for client")
144
 
        parser.add_option("-V", "--is-enabled", action="store_true",
145
 
                          help="Check if client is enabled")
146
 
        parser.add_option("-r", "--remove", action="store_true",
147
 
                          help="Remove client")
148
 
        parser.add_option("-c", "--checker", type="string",
149
 
                          help="Set checker command for client")
150
 
        parser.add_option("-t", "--timeout", type="string",
151
 
                          help="Set timeout for client")
152
 
        parser.add_option("-i", "--interval", type="string",
153
 
                          help="Set checker interval for client")
154
 
        parser.add_option("-H", "--host", type="string",
155
 
                          help="Set host for client")
156
 
        parser.add_option("-s", "--secret", type="string",
157
 
                          help="Set password blob (file) for client")
158
 
        parser.add_option("-A", "--approve", action="store_true",
159
 
                          help="Approve any current client request")
160
 
        parser.add_option("-D", "--deny", action="store_true",
161
 
                          help="Deny any current client request")
162
 
        options, client_names = parser.parse_args()
163
 
 
164
 
        if has_actions(options) and not client_names and not options.all:
165
 
            parser.error('Options requires clients names or --all.')
166
 
        if options.verbose and has_actions(options):
167
 
            parser.error('Verbose option can only be used alone or with --all.')
168
 
        if options.all and not has_actions(options):
169
 
            parser.error('--all requires an action')
170
 
            
171
 
        try:
172
 
            bus = dbus.SystemBus()
173
 
            mandos_dbus_objc = bus.get_object(busname, server_path)
174
 
        except dbus.exceptions.DBusException:
175
 
            print >> sys.stderr, "Could not connect to Mandos server"
176
 
            sys.exit(1)
177
 
    
178
 
        mandos_serv = dbus.Interface(mandos_dbus_objc,
179
 
                                     dbus_interface = server_interface)
180
 
 
181
 
        #block stderr since dbus library prints to stderr
182
 
        null = os.open(os.path.devnull, os.O_RDWR)
183
 
        stderrcopy = os.dup(sys.stderr.fileno())
184
 
        os.dup2(null, sys.stderr.fileno())
185
 
        os.close(null)
186
 
        try:
187
 
            try:
188
 
                mandos_clients = mandos_serv.GetAllClientsWithProperties()
189
 
            finally:
190
 
                #restore stderr
191
 
                os.dup2(stderrcopy, sys.stderr.fileno())
192
 
                os.close(stderrcopy)
193
 
        except dbus.exceptions.DBusException, e:
194
 
            print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
195
 
            sys.exit(1)
196
 
            
197
 
        # Compile list of clients to process
198
 
        clients=[]
199
 
 
200
 
        if options.all or not client_names:
201
 
            clients = (bus.get_object(busname, path) for path in mandos_clients.iterkeys())
202
 
        else:
203
 
            for name in client_names:
204
 
                for path, client in mandos_clients.iteritems():
205
 
                    if client['name'] == name:
206
 
                        client_objc = bus.get_object(busname, path)
207
 
                        clients.append(client_objc)
208
 
                        break
209
 
                else:
210
 
                    print >> sys.stderr, "Client not found on server: %r" % name
211
 
                    sys.exit(1)
212
 
            
213
 
        if not has_actions(options) and clients:
214
 
            if options.verbose:
215
 
                keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
216
 
                            'created', 'interval', 'host', 'fingerprint',
217
 
                            'checker_running', 'last_enabled', 'checker')
218
 
            else:
219
 
                keywords = defaultkeywords
220
 
                
221
 
            print_clients(mandos_clients.values(), keywords)
222
 
        else:
223
 
            # Process each client in the list by all selected options
224
 
            for client in clients:
225
 
                if options.remove:
226
 
                    mandos_serv.RemoveClient(client.__dbus_object_path__)
227
 
                if options.enable:
228
 
                    client.Enable(dbus_interface=client_interface)
229
 
                if options.disable:
230
 
                    client.Disable(dbus_interface=client_interface)
231
 
                if options.bump_timeout:
232
 
                    client.CheckedOK(dbus_interface=client_interface)
233
 
                if options.start_checker:
234
 
                    client.StartChecker(dbus_interface=client_interface)
235
 
                if options.stop_checker:
236
 
                    client.StopChecker(dbus_interface=client_interface)
237
 
                if options.is_enabled:
238
 
                    sys.exit(0 if client.Get(client_interface,
239
 
                                             u"enabled",
240
 
                                             dbus_interface=dbus.PROPERTIES_IFACE)
241
 
                             else 1)
242
 
                if options.checker:
243
 
                    client.Set(client_interface, u"checker", options.checker,
244
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
245
 
                if options.host:
246
 
                    client.Set(client_interface, u"host", options.host,
247
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
248
 
                if options.interval:
249
 
                    client.Set(client_interface, u"interval",
250
 
                               timedelta_to_milliseconds
251
 
                               (string_to_delta(options.interval)),
252
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
253
 
                if options.timeout:
254
 
                    client.Set(client_interface, u"timeout",
255
 
                               timedelta_to_milliseconds(string_to_delta
256
 
                                                         (options.timeout)),
257
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
258
 
                if options.secret:
259
 
                    client.Set(client_interface, u"secret",
260
 
                               dbus.ByteArray(open(options.secret, u'rb').read()),
261
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
262
 
                if options.approve:
263
 
                    client.Approve(dbus.Boolean(True), dbus_interface=client_interface)
264
 
                if options.deny:
265
 
                    client.Approve(dbus.Boolean(False), dbus_interface=client_interface)
266
 
 
267
 
if __name__ == '__main__':
268
 
    main()
 
121
 
 
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)