/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

More consistent terminology: Clients are no longer "invalid" - they
are "disabled".  All code and documentation changed to reflect this.

D=Bus API change: The "properties" argument was removed from the
"ClientAdded" signal on interface "se.bsnet.fukt.Mandos".  All code in
both "mandos" and "mandos-monitor" changed to reflect this.

* mandos: Replaced "with closing(F)" with simply "with F" in all
          places where F is a file object.
  (Client.still_valid): Removed.  All callers changed to look at
                        "Client.enabled" instead.
  (dbus_service_property): Check for unsupported signatures with the
                           "byte_arrays" option.
  (DBusObjectWithProperties.Set): - '' -
  (ClientHandler.handle): Use the reverse pipe to receive the
                          "Client.enabled" attribute instead of the
                          now-removed "Client.still_valid()" method.
  (ForkingMixInWithPipe): Renamed to "ForkingMixInWithPipes" (all
                          users changed).  Now also create a reverse
                          pipe for sending data to the child process.
  (ForkingMixInWithPipes.add_pipe): Now takes two pipe fd's as
                                    arguments.  All callers changed.
  (IPv6_TCPServer.handle_ipc): Take an additional "reply_fd" argument
                               (all callers changed).  Close the reply
                               pipe when the child data pipe is
                               closed.  New "GETATTR" IPC method; will
                               pickle client attribute and send it
                               over the reply pipe FD.
  (MandosDBusService.ClientAdded): Removed "properties" argument.  All
                                   emitters changed.
* mandos-clients.conf.xml (DESCRIPTION, OPTIONS): Use
                                                  "enabled/disabled"
                                                  terminology.
* mandos-ctl: Option "--is-valid" renamed to "--is-enabled".
* mandos-monitor: Enable user locale.  Try to log exceptions.
  (MandosClientPropertyCache.__init__): Removed "properties" argument.
                                        All callers changed.
  (UserInterface.add_new_client): Remove "properties" argument.  All
                                  callers changed.  Supply "logger"
                                  argument to MandosClientWidget().
  (UserInterface.add_client): New "logger" argument.  All callers
                              changed.
* mandos.xml (BUGS, SECURITY/CLIENTS): Use "enabled/disabled"
                                       terminology.

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
 
25
24
    'last_enabled': u'Last Enabled',
26
25
    'checker': u'Checker',
27
26
    }
28
 
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok')
 
27
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
 
28
                   'checker')
29
29
domain = 'se.bsnet.fukt'
30
30
busname = domain + '.Mandos'
31
31
server_path = '/'
32
32
server_interface = domain + '.Mandos'
33
33
client_interface = domain + '.Mandos.Client'
34
34
version = "1.0.14"
 
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()
35
40
 
36
41
def timedelta_to_milliseconds(td):
37
42
    "Convert a datetime.timedelta object to milliseconds"
89
94
        timevalue += delta
90
95
    return timevalue
91
96
 
92
 
def print_clients(clients, keywords):
 
97
def print_clients(clients):
93
98
    def valuetostring(value, keyword):
94
99
        if type(value) is dbus.Boolean:
95
100
            return u"Yes" if value else u"No"
109
114
    for client in clients:
110
115
        print format_string % tuple(valuetostring(client[key], key)
111
116
                                    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()
 
117
 
 
118
parser = OptionParser(version = "%%prog %s" % version)
 
119
parser.add_option("-a", "--all", action="store_true",
 
120
                  help="Print all fields")
 
121
parser.add_option("-e", "--enable", action="store_true",
 
122
                  help="Enable client")
 
123
parser.add_option("-d", "--disable", action="store_true",
 
124
                  help="disable client")
 
125
parser.add_option("-b", "--bump-timeout", action="store_true",
 
126
                  help="Bump timeout for client")
 
127
parser.add_option("--start-checker", action="store_true",
 
128
                  help="Start checker for client")
 
129
parser.add_option("--stop-checker", action="store_true",
 
130
                  help="Stop checker for client")
 
131
parser.add_option("-V", "--is-enabled", action="store_true",
 
132
                  help="Check if client is enabled")
 
133
parser.add_option("-r", "--remove", action="store_true",
 
134
                  help="Remove client")
 
135
parser.add_option("-c", "--checker", type="string",
 
136
                  help="Set checker command for client")
 
137
parser.add_option("-t", "--timeout", type="string",
 
138
                  help="Set timeout for client")
 
139
parser.add_option("-i", "--interval", type="string",
 
140
                  help="Set checker interval for client")
 
141
parser.add_option("-H", "--host", type="string",
 
142
                  help="Set host for client")
 
143
parser.add_option("-s", "--secret", type="string",
 
144
                  help="Set password blob (file) for client")
 
145
options, client_names = parser.parse_args()
 
146
 
 
147
# Compile list of clients to process
 
148
clients=[]
 
149
for name in client_names:
 
150
    for path, client in mandos_clients.iteritems():
 
151
        if client['name'] == name:
 
152
            client_objc = bus.get_object(busname, path)
 
153
            clients.append(client_objc)
 
154
            break
 
155
    else:
 
156
        print >> sys.stderr, "Client not found on server: %r" % name
 
157
        sys.exit(1)
 
158
 
 
159
if not clients and mandos_clients.values():
 
160
    keywords = defaultkeywords
 
161
    if options.all:
 
162
        keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
 
163
                    'created', 'interval', 'host', 'fingerprint',
 
164
                    'checker_running', 'last_enabled', 'checker')
 
165
    print_clients(mandos_clients.values())
 
166
 
 
167
# Process each client in the list by all selected options
 
168
for client in clients:
 
169
    if options.remove:
 
170
        mandos_serv.RemoveClient(client.__dbus_object_path__)
 
171
    if options.enable:
 
172
        client.Enable(dbus_interface=client_interface)
 
173
    if options.disable:
 
174
        client.Disable(dbus_interface=client_interface)
 
175
    if options.bump_timeout:
 
176
        client.CheckedOK(dbus_interface=client_interface)
 
177
    if options.start_checker:
 
178
        client.StartChecker(dbus_interface=client_interface)
 
179
    if options.stop_checker:
 
180
        client.StopChecker(dbus_interface=client_interface)
 
181
    if options.is_enabled:
 
182
        sys.exit(0 if client.Get(client_interface,
 
183
                                 u"enabled",
 
184
                                 dbus_interface=dbus.PROPERTIES_IFACE)
 
185
                 else 1)
 
186
    if options.checker:
 
187
        client.Set(client_interface, u"checker", options.checker,
 
188
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
189
    if options.host:
 
190
        client.Set(client_interface, u"host", options.host,
 
191
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
192
    if options.interval:
 
193
        client.Set(client_interface, u"interval",
 
194
                   timedelta_to_milliseconds
 
195
                   (string_to_delta(options.interval)),
 
196
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
197
    if options.timeout:
 
198
        client.Set(client_interface, u"timeout",
 
199
                   timedelta_to_milliseconds(string_to_delta
 
200
                                             (options.timeout)),
 
201
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
202
    if options.secret:
 
203
        client.Set(client_interface, u"secret",
 
204
                   dbus.ByteArray(open(options.secret, u'rb').read()),
 
205
                   dbus_interface=dbus.PROPERTIES_IFACE)