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
- browse files at revision 476
- compare with another revision
- download diff
- download tarball
- view history from revision 476
- Committer: Teddy Hogeborn
- Date: 2011-03-17 18:13:40 UTC
- Revision ID: teddy@fukt.bsnet.se-20110317181340-nf79nlcbilqx3ccg
* debian/control (mandos-client): Conflict with correct version of
dropbear.
dropbear.
- files removed:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
#
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
#
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
#
12
#
13
13
# Everything else is
14
# Copyright © 2008-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
16
#
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
19
19
# the Free Software Foundation, either version 3 of the License, or
23
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
25
# GNU General Public License for more details.
26
#
26
#
27
27
# You should have received a copy of the GNU General Public License
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
#
31
# Contact the authors at <mandos@recompile.se>.
32
#
30
#
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
#
33
33
34
34
from __future__ import (division, absolute_import, print_function,
35
35
unicode_literals)
36
36
37
try:
38
from future_builtins import *
39
except ImportError:
40
pass
41
42
try:
43
import SocketServer as socketserver
44
except ImportError:
45
import socketserver
37
import SocketServer as socketserver
46
38
import socket
47
39
import argparse
48
40
import datetime
49
41
import errno
50
try:
51
import ConfigParser as configparser
52
except ImportError:
53
import configparser
42
import gnutls.crypto
43
import gnutls.connection
44
import gnutls.errors
45
import gnutls.library.functions
46
import gnutls.library.constants
47
import gnutls.library.types
48
import ConfigParser as configparser
54
49
import sys
55
50
import re
56
51
import os
65
60
import struct
66
61
import fcntl
67
62
import functools
68
try:
69
import cPickle as pickle
70
except ImportError:
71
import pickle
63
import cPickle as pickle
72
64
import multiprocessing
73
import types
74
import binascii
75
import tempfile
76
import itertools
77
import collections
78
import codecs
79
65
80
66
import dbus
81
67
import dbus.service
82
from gi.repository import GLib
68
import gobject
69
import avahi
83
70
from dbus.mainloop.glib import DBusGMainLoop
84
71
import ctypes
85
72
import ctypes.util
86
73
import xml.dom.minidom
87
74
import inspect
88
75
89
# Try to find the value of SO_BINDTODEVICE:
90
76
try:
91
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
92
# newer, and it is also the most natural place for it:
93
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
94
78
except AttributeError:
95
79
try:
96
# This is where SO_BINDTODEVICE was up to and including Python
97
# 2.6, and also 3.2:
98
80
from IN import SO_BINDTODEVICE
99
81
except ImportError:
100
# In Python 2.7 it seems to have been removed entirely.
101
# Try running the C preprocessor:
102
try:
103
cc = subprocess.Popen(["cc", "--language=c", "-E",
104
"/dev/stdin"],
105
stdin=subprocess.PIPE,
106
stdout=subprocess.PIPE)
107
stdout = cc.communicate(
108
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
109
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
110
except (OSError, ValueError, IndexError):
111
# No value found
112
SO_BINDTODEVICE = None
113
114
if sys.version_info.major == 2:
115
str = unicode
116
117
version = "1.7.10"
118
stored_state_file = "clients.pickle"
119
120
logger = logging.getLogger()
121
syslogger = None
122
123
try:
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
126
except (OSError, AttributeError):
127
128
def if_nametoindex(interface):
129
"Get an interface index the hard way, i.e. using fcntl()"
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
131
with contextlib.closing(socket.socket()) as s:
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
135
return interface_index
136
137
138
def copy_function(func):
139
"""Make a copy of a function"""
140
if sys.version_info.major == 2:
141
return types.FunctionType(func.func_code,
142
func.func_globals,
143
func.func_name,
144
func.func_defaults,
145
func.func_closure)
146
else:
147
return types.FunctionType(func.__code__,
148
func.__globals__,
149
func.__name__,
150
func.__defaults__,
151
func.__closure__)
152
153
154
def initlogger(debug, level=logging.WARNING):
155
"""init logger and add loglevel"""
156
157
global syslogger
158
syslogger = (logging.handlers.SysLogHandler(
159
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
160
address="/dev/log"))
161
syslogger.setFormatter(logging.Formatter
162
('Mandos [%(process)d]: %(levelname)s:'
163
' %(message)s'))
164
logger.addHandler(syslogger)
165
166
if debug:
167
console = logging.StreamHandler()
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
169
' [%(process)d]:'
170
' %(levelname)s:'
171
' %(message)s'))
172
logger.addHandler(console)
173
logger.setLevel(level)
174
175
176
class PGPError(Exception):
177
"""Exception if encryption/decryption fails"""
178
pass
179
180
181
class PGPEngine(object):
182
"""A simple class for OpenPGP symmetric encryption & decryption"""
183
184
def __init__(self):
185
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
186
self.gpg = "gpg"
187
try:
188
output = subprocess.check_output(["gpgconf"])
189
for line in output.splitlines():
190
name, text, path = line.split(b":")
191
if name == "gpg":
192
self.gpg = path
193
break
194
except OSError as e:
195
if e.errno != errno.ENOENT:
196
raise
197
self.gnupgargs = ['--batch',
198
'--homedir', self.tempdir,
199
'--force-mdc',
200
'--quiet']
201
# Only GPG version 1 has the --no-use-agent option.
202
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
203
self.gnupgargs.append("--no-use-agent")
204
205
def __enter__(self):
206
return self
207
208
def __exit__(self, exc_type, exc_value, traceback):
209
self._cleanup()
210
return False
211
212
def __del__(self):
213
self._cleanup()
214
215
def _cleanup(self):
216
if self.tempdir is not None:
217
# Delete contents of tempdir
218
for root, dirs, files in os.walk(self.tempdir,
219
topdown=False):
220
for filename in files:
221
os.remove(os.path.join(root, filename))
222
for dirname in dirs:
223
os.rmdir(os.path.join(root, dirname))
224
# Remove tempdir
225
os.rmdir(self.tempdir)
226
self.tempdir = None
227
228
def password_encode(self, password):
229
# Passphrase can not be empty and can not contain newlines or
230
# NUL bytes. So we prefix it and hex encode it.
231
encoded = b"mandos" + binascii.hexlify(password)
232
if len(encoded) > 2048:
233
# GnuPG can't handle long passwords, so encode differently
234
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
235
.replace(b"\n", b"\\n")
236
.replace(b"\0", b"\\x00"))
237
return encoded
238
239
def encrypt(self, data, password):
240
passphrase = self.password_encode(password)
241
with tempfile.NamedTemporaryFile(
242
dir=self.tempdir) as passfile:
243
passfile.write(passphrase)
244
passfile.flush()
245
proc = subprocess.Popen([self.gpg, '--symmetric',
246
'--passphrase-file',
247
passfile.name]
248
+ self.gnupgargs,
249
stdin=subprocess.PIPE,
250
stdout=subprocess.PIPE,
251
stderr=subprocess.PIPE)
252
ciphertext, err = proc.communicate(input=data)
253
if proc.returncode != 0:
254
raise PGPError(err)
255
return ciphertext
256
257
def decrypt(self, data, password):
258
passphrase = self.password_encode(password)
259
with tempfile.NamedTemporaryFile(
260
dir=self.tempdir) as passfile:
261
passfile.write(passphrase)
262
passfile.flush()
263
proc = subprocess.Popen([self.gpg, '--decrypt',
264
'--passphrase-file',
265
passfile.name]
266
+ self.gnupgargs,
267
stdin=subprocess.PIPE,
268
stdout=subprocess.PIPE,
269
stderr=subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input=data)
271
if proc.returncode != 0:
272
raise PGPError(err)
273
return decrypted_plaintext
274
275
276
# Pretend that we have an Avahi module
277
class Avahi(object):
278
"""This isn't so much a class as it is a module-like namespace.
279
It is instantiated once, and simulates having an Avahi module."""
280
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
288
289
def string_array_to_txt_array(self, t):
290
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
291
for s in t), signature="ay")
292
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
293
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
294
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
295
SERVER_INVALID = 0 # avahi-common/defs.h
296
SERVER_REGISTERING = 1 # avahi-common/defs.h
297
SERVER_RUNNING = 2 # avahi-common/defs.h
298
SERVER_COLLISION = 3 # avahi-common/defs.h
299
SERVER_FAILURE = 4 # avahi-common/defs.h
300
avahi = Avahi()
301
82
SO_BINDTODEVICE = None
83
84
85
version = "1.3.0"
86
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
94
' %(message)s'))
95
logger.addHandler(syslogger)
96
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
' %(levelname)s:'
100
' %(message)s'))
101
logger.addHandler(console)
302
102
303
103
class AvahiError(Exception):
304
104
def __init__(self, value, *args, **kwargs):
305
105
self.value = value
306
return super(AvahiError, self).__init__(value, *args,
307
**kwargs)
308
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
309
109
310
110
class AvahiServiceError(AvahiError):
311
111
pass
312
112
313
314
113
class AvahiGroupError(AvahiError):
315
114
pass
316
115
317
116
318
117
class AvahiService(object):
319
118
"""An Avahi (Zeroconf) service.
320
119
321
120
Attributes:
322
121
interface: integer; avahi.IF_UNSPEC or an interface index.
323
122
Used to optionally bind to the specified interface.
324
123
name: string; Example: 'Mandos'
325
124
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
125
See <http://www.dns-sd.org/ServiceTypes.html>
327
126
port: integer; what port to announce
328
127
TXT: list of strings; TXT record for the service
329
128
domain: string; Domain to publish on, default to .local if empty.
335
134
server: D-Bus Server
336
135
bus: dbus.SystemBus()
337
136
"""
338
339
def __init__(self,
340
interface=avahi.IF_UNSPEC,
341
name=None,
342
servicetype=None,
343
port=None,
344
TXT=None,
345
domain="",
346
host="",
347
max_renames=32768,
348
protocol=avahi.PROTO_UNSPEC,
349
bus=None):
137
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
138
servicetype = None, port = None, TXT = None,
139
domain = "", host = "", max_renames = 32768,
140
protocol = avahi.PROTO_UNSPEC, bus = None):
350
141
self.interface = interface
351
142
self.name = name
352
143
self.type = servicetype
360
151
self.group = None # our entry group
361
152
self.server = None
362
153
self.bus = bus
363
self.entry_group_state_changed_match = None
364
365
def rename(self, remove=True):
154
def rename(self):
366
155
"""Derived from the Avahi example code"""
367
156
if self.rename_count >= self.max_renames:
368
157
logger.critical("No suitable Zeroconf service name found"
369
158
" after %i retries, exiting.",
370
159
self.rename_count)
371
160
raise AvahiServiceError("Too many renames")
372
self.name = str(
373
self.server.GetAlternativeServiceName(self.name))
374
self.rename_count += 1
161
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
375
162
logger.info("Changing Zeroconf service name to %r ...",
376
163
self.name)
377
if remove:
378
self.remove()
164
syslogger.setFormatter(logging.Formatter
165
('Mandos (%s) [%%(process)d]:'
166
' %%(levelname)s: %%(message)s'
167
% self.name))
168
self.remove()
379
169
try:
380
170
self.add()
381
except dbus.exceptions.DBusException as error:
382
if (error.get_dbus_name()
383
== "org.freedesktop.Avahi.CollisionError"):
384
logger.info("Local Zeroconf service name collision.")
385
return self.rename(remove=False)
386
else:
387
logger.critical("D-Bus Exception", exc_info=error)
388
self.cleanup()
389
os._exit(1)
390
171
except dbus.exceptions.DBusException, error:
172
logger.critical("DBusException: %s", error)
173
self.cleanup()
174
os._exit(1)
175
self.rename_count += 1
391
176
def remove(self):
392
177
"""Derived from the Avahi example code"""
393
if self.entry_group_state_changed_match is not None:
394
self.entry_group_state_changed_match.remove()
395
self.entry_group_state_changed_match = None
396
178
if self.group is not None:
397
179
self.group.Reset()
398
399
180
def add(self):
400
181
"""Derived from the Avahi example code"""
401
self.remove()
402
182
if self.group is None:
403
183
self.group = dbus.Interface(
404
184
self.bus.get_object(avahi.DBUS_NAME,
405
185
self.server.EntryGroupNew()),
406
186
avahi.DBUS_INTERFACE_ENTRY_GROUP)
407
self.entry_group_state_changed_match = (
408
self.group.connect_to_signal(
409
'StateChanged', self.entry_group_state_changed))
187
self.group.connect_to_signal('StateChanged',
188
self
189
.entry_group_state_changed)
410
190
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
411
191
self.name, self.type)
412
192
self.group.AddService(
418
198
dbus.UInt16(self.port),
419
199
avahi.string_array_to_txt_array(self.TXT))
420
200
self.group.Commit()
421
422
201
def entry_group_state_changed(self, state, error):
423
202
"""Derived from the Avahi example code"""
424
203
logger.debug("Avahi entry group state change: %i", state)
425
204
426
205
if state == avahi.ENTRY_GROUP_ESTABLISHED:
427
206
logger.debug("Zeroconf service established.")
428
207
elif state == avahi.ENTRY_GROUP_COLLISION:
430
209
self.rename()
431
210
elif state == avahi.ENTRY_GROUP_FAILURE:
432
211
logger.critical("Avahi: Error in group state changed %s",
433
str(error))
434
raise AvahiGroupError("State changed: {!s}".format(error))
435
212
unicode(error))
213
raise AvahiGroupError("State changed: %s"
214
% unicode(error))
436
215
def cleanup(self):
437
216
"""Derived from the Avahi example code"""
438
217
if self.group is not None:
439
try:
440
self.group.Free()
441
except (dbus.exceptions.UnknownMethodException,
442
dbus.exceptions.DBusException):
443
pass
218
self.group.Free()
444
219
self.group = None
445
self.remove()
446
447
def server_state_changed(self, state, error=None):
220
def server_state_changed(self, state):
448
221
"""Derived from the Avahi example code"""
449
222
logger.debug("Avahi server state change: %i", state)
450
bad_states = {
451
avahi.SERVER_INVALID: "Zeroconf server invalid",
452
avahi.SERVER_REGISTERING: None,
453
avahi.SERVER_COLLISION: "Zeroconf server name collision",
454
avahi.SERVER_FAILURE: "Zeroconf server failure",
455
}
456
if state in bad_states:
457
if bad_states[state] is not None:
458
if error is None:
459
logger.error(bad_states[state])
460
else:
461
logger.error(bad_states[state] + ": %r", error)
462
self.cleanup()
223
if state == avahi.SERVER_COLLISION:
224
logger.error("Zeroconf server name collision")
225
self.remove()
463
226
elif state == avahi.SERVER_RUNNING:
464
try:
465
self.add()
466
except dbus.exceptions.DBusException as error:
467
if (error.get_dbus_name()
468
== "org.freedesktop.Avahi.CollisionError"):
469
logger.info("Local Zeroconf service name"
470
" collision.")
471
return self.rename(remove=False)
472
else:
473
logger.critical("D-Bus Exception", exc_info=error)
474
self.cleanup()
475
os._exit(1)
476
else:
477
if error is None:
478
logger.debug("Unknown state: %r", state)
479
else:
480
logger.debug("Unknown state: %r: %r", state, error)
481
227
self.add()
482
228
def activate(self):
483
229
"""Derived from the Avahi example code"""
484
230
if self.server is None:
485
231
self.server = dbus.Interface(
486
232
self.bus.get_object(avahi.DBUS_NAME,
487
avahi.DBUS_PATH_SERVER,
488
follow_name_owner_changes=True),
233
avahi.DBUS_PATH_SERVER),
489
234
avahi.DBUS_INTERFACE_SERVER)
490
235
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
236
self.server_state_changed)
492
237
self.server_state_changed(self.server.GetState())
493
238
494
239
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
501
.format(self.name)))
502
return ret
503
504
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
509
510
_library = ctypes.cdll.LoadLibrary(
511
ctypes.util.find_library("gnutls"))
512
_need_version = b"3.3.0"
513
514
def __init__(self):
515
# Need to use class name "GnuTLS" here, since this method is
516
# called before the assignment to the "gnutls" global variable
517
# happens.
518
if GnuTLS.check_version(self._need_version) is None:
519
raise GnuTLS.Error("Needs GnuTLS {} or later"
520
.format(self._need_version))
521
522
# Unless otherwise indicated, the constants and types below are
523
# all from the gnutls/gnutls.h C header file.
524
525
# Constants
526
E_SUCCESS = 0
527
E_INTERRUPTED = -52
528
E_AGAIN = -28
529
CRT_OPENPGP = 2
530
CLIENT = 2
531
SHUT_RDWR = 0
532
CRD_CERTIFICATE = 1
533
E_NO_CERTIFICATE_FOUND = -49
534
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
535
536
# Types
537
class session_int(ctypes.Structure):
538
_fields_ = []
539
session_t = ctypes.POINTER(session_int)
540
541
class certificate_credentials_st(ctypes.Structure):
542
_fields_ = []
543
certificate_credentials_t = ctypes.POINTER(
544
certificate_credentials_st)
545
certificate_type_t = ctypes.c_int
546
547
class datum_t(ctypes.Structure):
548
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
549
('size', ctypes.c_uint)]
550
551
class openpgp_crt_int(ctypes.Structure):
552
_fields_ = []
553
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
554
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
555
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
556
credentials_type_t = ctypes.c_int
557
transport_ptr_t = ctypes.c_void_p
558
close_request_t = ctypes.c_int
559
560
# Exceptions
561
class Error(Exception):
562
# We need to use the class name "GnuTLS" here, since this
563
# exception might be raised from within GnuTLS.__init__,
564
# which is called before the assignment to the "gnutls"
565
# global variable has happened.
566
def __init__(self, message=None, code=None, args=()):
567
# Default usage is by a message string, but if a return
568
# code is passed, convert it to a string with
569
# gnutls.strerror()
570
self.code = code
571
if message is None and code is not None:
572
message = GnuTLS.strerror(code)
573
return super(GnuTLS.Error, self).__init__(
574
message, *args)
575
576
class CertificateSecurityError(Error):
577
pass
578
579
# Classes
580
class Credentials(object):
581
def __init__(self):
582
self._c_object = gnutls.certificate_credentials_t()
583
gnutls.certificate_allocate_credentials(
584
ctypes.byref(self._c_object))
585
self.type = gnutls.CRD_CERTIFICATE
586
587
def __del__(self):
588
gnutls.certificate_free_credentials(self._c_object)
589
590
class ClientSession(object):
591
def __init__(self, socket, credentials=None):
592
self._c_object = gnutls.session_t()
593
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
594
gnutls.set_default_priority(self._c_object)
595
gnutls.transport_set_ptr(self._c_object, socket.fileno())
596
gnutls.handshake_set_private_extensions(self._c_object,
597
True)
598
self.socket = socket
599
if credentials is None:
600
credentials = gnutls.Credentials()
601
gnutls.credentials_set(self._c_object, credentials.type,
602
ctypes.cast(credentials._c_object,
603
ctypes.c_void_p))
604
self.credentials = credentials
605
606
def __del__(self):
607
gnutls.deinit(self._c_object)
608
609
def handshake(self):
610
return gnutls.handshake(self._c_object)
611
612
def send(self, data):
613
data = bytes(data)
614
data_len = len(data)
615
while data_len > 0:
616
data_len -= gnutls.record_send(self._c_object,
617
data[-data_len:],
618
data_len)
619
620
def bye(self):
621
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
622
623
# Error handling functions
624
def _error_code(result):
625
"""A function to raise exceptions on errors, suitable
626
for the 'restype' attribute on ctypes functions"""
627
if result >= 0:
628
return result
629
if result == gnutls.E_NO_CERTIFICATE_FOUND:
630
raise gnutls.CertificateSecurityError(code=result)
631
raise gnutls.Error(code=result)
632
633
def _retry_on_error(result, func, arguments):
634
"""A function to retry on some errors, suitable
635
for the 'errcheck' attribute on ctypes functions"""
636
while result < 0:
637
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
638
return _error_code(result)
639
result = func(*arguments)
640
return result
641
642
# Unless otherwise indicated, the function declarations below are
643
# all from the gnutls/gnutls.h C header file.
644
645
# Functions
646
priority_set_direct = _library.gnutls_priority_set_direct
647
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
648
ctypes.POINTER(ctypes.c_char_p)]
649
priority_set_direct.restype = _error_code
650
651
init = _library.gnutls_init
652
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
653
init.restype = _error_code
654
655
set_default_priority = _library.gnutls_set_default_priority
656
set_default_priority.argtypes = [session_t]
657
set_default_priority.restype = _error_code
658
659
record_send = _library.gnutls_record_send
660
record_send.argtypes = [session_t, ctypes.c_void_p,
661
ctypes.c_size_t]
662
record_send.restype = ctypes.c_ssize_t
663
record_send.errcheck = _retry_on_error
664
665
certificate_allocate_credentials = (
666
_library.gnutls_certificate_allocate_credentials)
667
certificate_allocate_credentials.argtypes = [
668
ctypes.POINTER(certificate_credentials_t)]
669
certificate_allocate_credentials.restype = _error_code
670
671
certificate_free_credentials = (
672
_library.gnutls_certificate_free_credentials)
673
certificate_free_credentials.argtypes = [
674
certificate_credentials_t]
675
certificate_free_credentials.restype = None
676
677
handshake_set_private_extensions = (
678
_library.gnutls_handshake_set_private_extensions)
679
handshake_set_private_extensions.argtypes = [session_t,
680
ctypes.c_int]
681
handshake_set_private_extensions.restype = None
682
683
credentials_set = _library.gnutls_credentials_set
684
credentials_set.argtypes = [session_t, credentials_type_t,
685
ctypes.c_void_p]
686
credentials_set.restype = _error_code
687
688
strerror = _library.gnutls_strerror
689
strerror.argtypes = [ctypes.c_int]
690
strerror.restype = ctypes.c_char_p
691
692
certificate_type_get = _library.gnutls_certificate_type_get
693
certificate_type_get.argtypes = [session_t]
694
certificate_type_get.restype = _error_code
695
696
certificate_get_peers = _library.gnutls_certificate_get_peers
697
certificate_get_peers.argtypes = [session_t,
698
ctypes.POINTER(ctypes.c_uint)]
699
certificate_get_peers.restype = ctypes.POINTER(datum_t)
700
701
global_set_log_level = _library.gnutls_global_set_log_level
702
global_set_log_level.argtypes = [ctypes.c_int]
703
global_set_log_level.restype = None
704
705
global_set_log_function = _library.gnutls_global_set_log_function
706
global_set_log_function.argtypes = [log_func]
707
global_set_log_function.restype = None
708
709
deinit = _library.gnutls_deinit
710
deinit.argtypes = [session_t]
711
deinit.restype = None
712
713
handshake = _library.gnutls_handshake
714
handshake.argtypes = [session_t]
715
handshake.restype = _error_code
716
handshake.errcheck = _retry_on_error
717
718
transport_set_ptr = _library.gnutls_transport_set_ptr
719
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
720
transport_set_ptr.restype = None
721
722
bye = _library.gnutls_bye
723
bye.argtypes = [session_t, close_request_t]
724
bye.restype = _error_code
725
bye.errcheck = _retry_on_error
726
727
check_version = _library.gnutls_check_version
728
check_version.argtypes = [ctypes.c_char_p]
729
check_version.restype = ctypes.c_char_p
730
731
# All the function declarations below are from gnutls/openpgp.h
732
733
openpgp_crt_init = _library.gnutls_openpgp_crt_init
734
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
735
openpgp_crt_init.restype = _error_code
736
737
openpgp_crt_import = _library.gnutls_openpgp_crt_import
738
openpgp_crt_import.argtypes = [openpgp_crt_t,
739
ctypes.POINTER(datum_t),
740
openpgp_crt_fmt_t]
741
openpgp_crt_import.restype = _error_code
742
743
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
744
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
745
ctypes.POINTER(ctypes.c_uint)]
746
openpgp_crt_verify_self.restype = _error_code
747
748
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
749
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
750
openpgp_crt_deinit.restype = None
751
752
openpgp_crt_get_fingerprint = (
753
_library.gnutls_openpgp_crt_get_fingerprint)
754
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
755
ctypes.c_void_p,
756
ctypes.POINTER(
757
ctypes.c_size_t)]
758
openpgp_crt_get_fingerprint.restype = _error_code
759
760
# Remove non-public functions
761
del _error_code, _retry_on_error
762
# Create the global "gnutls" object, simulating a module
763
gnutls = GnuTLS()
764
765
766
def call_pipe(connection, # : multiprocessing.Connection
767
func, *args, **kwargs):
768
"""This function is meant to be called by multiprocessing.Process
769
770
This function runs func(*args, **kwargs), and writes the resulting
771
return value on the provided multiprocessing.Connection.
772
"""
773
connection.send(func(*args, **kwargs))
774
connection.close()
775
776
777
240
class Client(object):
778
241
"""A representation of a client host served by this server.
779
242
780
243
Attributes:
781
approved: bool(); 'None' if not yet approved/disapproved
244
_approved: bool(); 'None' if not yet approved/disapproved
782
245
approval_delay: datetime.timedelta(); Time to wait for approval
783
246
approval_duration: datetime.timedelta(); Duration of one approval
784
247
checker: subprocess.Popen(); a running checker process used
785
248
to see if the client lives.
786
249
'None' if no process is running.
787
checker_callback_tag: a GLib event source tag, or None
250
checker_callback_tag: a gobject event source tag, or None
788
251
checker_command: string; External command which is run to check
789
252
if client lives. %() expansions are done at
790
253
runtime with vars(self) as dict, so that for
791
254
instance %(name)s can be used in the command.
792
checker_initiator_tag: a GLib event source tag, or None
255
checker_initiator_tag: a gobject event source tag, or None
793
256
created: datetime.datetime(); (UTC) object creation
794
client_structure: Object describing what attributes a client has
795
and is used for storing the client at exit
796
257
current_checker_command: string; current running checker_command
797
disable_initiator_tag: a GLib event source tag, or None
258
disable_hook: If set, called by disable() as disable_hook(self)
259
disable_initiator_tag: a gobject event source tag, or None
798
260
enabled: bool()
799
261
fingerprint: string (40 or 32 hexadecimal digits); used to
800
262
uniquely identify the client
802
264
interval: datetime.timedelta(); How often to start a new checker
803
265
last_approval_request: datetime.datetime(); (UTC) or None
804
266
last_checked_ok: datetime.datetime(); (UTC) or None
805
last_checker_status: integer between 0 and 255 reflecting exit
806
status of last checker. -1 reflects crashed
807
checker, -2 means no checker completed yet.
808
last_checker_signal: The signal which killed the last checker, if
809
last_checker_status is -1
810
last_enabled: datetime.datetime(); (UTC) or None
267
last_enabled: datetime.datetime(); (UTC)
811
268
name: string; from the config file, used in log messages and
812
269
D-Bus identifiers
813
270
secret: bytestring; sent verbatim (over TLS) to client
814
271
timeout: datetime.timedelta(); How long from last_checked_ok
815
272
until this client is disabled
816
extended_timeout: extra long timeout when secret has been sent
817
273
runtime_expansions: Allowed attributes for runtime expansion.
818
expires: datetime.datetime(); time (UTC) when a client will be
819
disabled, or None
820
server_settings: The server_settings dict from main()
821
274
"""
822
275
823
276
runtime_expansions = ("approval_delay", "approval_duration",
824
"created", "enabled", "expires",
825
"fingerprint", "host", "interval",
826
"last_approval_request", "last_checked_ok",
277
"created", "enabled", "fingerprint",
278
"host", "interval", "last_checked_ok",
827
279
"last_enabled", "name", "timeout")
828
client_defaults = {
829
"timeout": "PT5M",
830
"extended_timeout": "PT15M",
831
"interval": "PT2M",
832
"checker": "fping -q -- %%(host)s",
833
"host": "",
834
"approval_delay": "PT0S",
835
"approval_duration": "PT1S",
836
"approved_by_default": "True",
837
"enabled": "True",
838
}
839
280
840
281
@staticmethod
841
def config_parser(config):
842
"""Construct a new dict of client settings of this form:
843
{ client_name: {setting_name: value, ...}, ...}
844
with exceptions for any special settings as defined above.
845
NOTE: Must be a pure function. Must return the same result
846
value given the same arguments.
847
"""
848
settings = {}
849
for client_name in config.sections():
850
section = dict(config.items(client_name))
851
client = settings[client_name] = {}
852
853
client["host"] = section["host"]
854
# Reformat values from string types to Python types
855
client["approved_by_default"] = config.getboolean(
856
client_name, "approved_by_default")
857
client["enabled"] = config.getboolean(client_name,
858
"enabled")
859
860
# Uppercase and remove spaces from fingerprint for later
861
# comparison purposes with return value from the
862
# fingerprint() function
863
client["fingerprint"] = (section["fingerprint"].upper()
864
.replace(" ", ""))
865
if "secret" in section:
866
client["secret"] = codecs.decode(section["secret"]
867
.encode("utf-8"),
868
"base64")
869
elif "secfile" in section:
870
with open(os.path.expanduser(os.path.expandvars
871
(section["secfile"])),
872
"rb") as secfile:
873
client["secret"] = secfile.read()
874
else:
875
raise TypeError("No secret or secfile for section {}"
876
.format(section))
877
client["timeout"] = string_to_delta(section["timeout"])
878
client["extended_timeout"] = string_to_delta(
879
section["extended_timeout"])
880
client["interval"] = string_to_delta(section["interval"])
881
client["approval_delay"] = string_to_delta(
882
section["approval_delay"])
883
client["approval_duration"] = string_to_delta(
884
section["approval_duration"])
885
client["checker_command"] = section["checker"]
886
client["last_approval_request"] = None
887
client["last_checked_ok"] = None
888
client["last_checker_status"] = -2
889
890
return settings
891
892
def __init__(self, settings, name=None, server_settings=None):
282
def _timedelta_to_milliseconds(td):
283
"Convert a datetime.timedelta() to milliseconds"
284
return ((td.days * 24 * 60 * 60 * 1000)
285
+ (td.seconds * 1000)
286
+ (td.microseconds // 1000))
287
288
def timeout_milliseconds(self):
289
"Return the 'timeout' attribute in milliseconds"
290
return self._timedelta_to_milliseconds(self.timeout)
291
292
def interval_milliseconds(self):
293
"Return the 'interval' attribute in milliseconds"
294
return self._timedelta_to_milliseconds(self.interval)
295
296
def approval_delay_milliseconds(self):
297
return self._timedelta_to_milliseconds(self.approval_delay)
298
299
def __init__(self, name = None, disable_hook=None, config=None):
300
"""Note: the 'checker' key in 'config' sets the
301
'checker_command' attribute and *not* the 'checker'
302
attribute."""
893
303
self.name = name
894
if server_settings is None:
895
server_settings = {}
896
self.server_settings = server_settings
897
# adding all client settings
898
for setting, value in settings.items():
899
setattr(self, setting, value)
900
901
if self.enabled:
902
if not hasattr(self, "last_enabled"):
903
self.last_enabled = datetime.datetime.utcnow()
904
if not hasattr(self, "expires"):
905
self.expires = (datetime.datetime.utcnow()
906
+ self.timeout)
907
else:
908
self.last_enabled = None
909
self.expires = None
910
304
if config is None:
305
config = {}
911
306
logger.debug("Creating client %r", self.name)
307
# Uppercase and remove spaces from fingerprint for later
308
# comparison purposes with return value from the fingerprint()
309
# function
310
self.fingerprint = (config["fingerprint"].upper()
311
.replace(" ", ""))
912
312
logger.debug(" Fingerprint: %s", self.fingerprint)
913
self.created = settings.get("created",
914
datetime.datetime.utcnow())
915
916
# attributes specific for this server instance
313
if "secret" in config:
314
self.secret = config["secret"].decode("base64")
315
elif "secfile" in config:
316
with open(os.path.expanduser(os.path.expandvars
317
(config["secfile"])),
318
"rb") as secfile:
319
self.secret = secfile.read()
320
else:
321
raise TypeError("No secret or secfile for client %s"
322
% self.name)
323
self.host = config.get("host", "")
324
self.created = datetime.datetime.utcnow()
325
self.enabled = False
326
self.last_approval_request = None
327
self.last_enabled = None
328
self.last_checked_ok = None
329
self.timeout = string_to_delta(config["timeout"])
330
self.interval = string_to_delta(config["interval"])
331
self.disable_hook = disable_hook
917
332
self.checker = None
918
333
self.checker_initiator_tag = None
919
334
self.disable_initiator_tag = None
920
335
self.checker_callback_tag = None
336
self.checker_command = config["checker"]
921
337
self.current_checker_command = None
922
self.approved = None
338
self.last_connect = None
339
self._approved = None
340
self.approved_by_default = config.get("approved_by_default",
341
True)
923
342
self.approvals_pending = 0
924
self.changedstate = multiprocessing_manager.Condition(
925
multiprocessing_manager.Lock())
926
self.client_structure = [attr
927
for attr in self.__dict__.keys()
928
if not attr.startswith("_")]
929
self.client_structure.append("client_structure")
930
931
for name, t in inspect.getmembers(
932
type(self), lambda obj: isinstance(obj, property)):
933
if not name.startswith("_"):
934
self.client_structure.append(name)
935
936
# Send notice to process children that client state has changed
343
self.approval_delay = string_to_delta(
344
config["approval_delay"])
345
self.approval_duration = string_to_delta(
346
config["approval_duration"])
347
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
348
937
349
def send_changedstate(self):
938
with self.changedstate:
939
self.changedstate.notify_all()
940
350
self.changedstate.acquire()
351
self.changedstate.notify_all()
352
self.changedstate.release()
353
941
354
def enable(self):
942
355
"""Start this client's checker and timeout hooks"""
943
356
if getattr(self, "enabled", False):
944
357
# Already enabled
945
358
return
946
self.expires = datetime.datetime.utcnow() + self.timeout
947
self.enabled = True
359
self.send_changedstate()
948
360
self.last_enabled = datetime.datetime.utcnow()
949
self.init_checker()
950
self.send_changedstate()
951
361
# Schedule a new checker to be started an 'interval' from now,
362
# and every interval from then on.
363
self.checker_initiator_tag = (gobject.timeout_add
364
(self.interval_milliseconds(),
365
self.start_checker))
366
# Schedule a disable() when 'timeout' has passed
367
self.disable_initiator_tag = (gobject.timeout_add
368
(self.timeout_milliseconds(),
369
self.disable))
370
self.enabled = True
371
# Also start a new checker *right now*.
372
self.start_checker()
373
952
374
def disable(self, quiet=True):
953
375
"""Disable this client."""
954
376
if not getattr(self, "enabled", False):
955
377
return False
956
378
if not quiet:
379
self.send_changedstate()
380
if not quiet:
957
381
logger.info("Disabling client %s", self.name)
958
if getattr(self, "disable_initiator_tag", None) is not None:
959
GLib.source_remove(self.disable_initiator_tag)
382
if getattr(self, "disable_initiator_tag", False):
383
gobject.source_remove(self.disable_initiator_tag)
960
384
self.disable_initiator_tag = None
961
self.expires = None
962
if getattr(self, "checker_initiator_tag", None) is not None:
963
GLib.source_remove(self.checker_initiator_tag)
385
if getattr(self, "checker_initiator_tag", False):
386
gobject.source_remove(self.checker_initiator_tag)
964
387
self.checker_initiator_tag = None
965
388
self.stop_checker()
389
if self.disable_hook:
390
self.disable_hook(self)
966
391
self.enabled = False
967
if not quiet:
968
self.send_changedstate()
969
# Do not run this again if called by a GLib.timeout_add
392
# Do not run this again if called by a gobject.timeout_add
970
393
return False
971
394
972
395
def __del__(self):
396
self.disable_hook = None
973
397
self.disable()
974
975
def init_checker(self):
976
# Schedule a new checker to be started an 'interval' from now,
977
# and every interval from then on.
978
if self.checker_initiator_tag is not None:
979
GLib.source_remove(self.checker_initiator_tag)
980
self.checker_initiator_tag = GLib.timeout_add(
981
int(self.interval.total_seconds() * 1000),
982
self.start_checker)
983
# Schedule a disable() when 'timeout' has passed
984
if self.disable_initiator_tag is not None:
985
GLib.source_remove(self.disable_initiator_tag)
986
self.disable_initiator_tag = GLib.timeout_add(
987
int(self.timeout.total_seconds() * 1000), self.disable)
988
# Also start a new checker *right now*.
989
self.start_checker()
990
991
def checker_callback(self, source, condition, connection,
992
command):
398
399
def checker_callback(self, pid, condition, command):
993
400
"""The checker has completed, so take appropriate actions."""
994
401
self.checker_callback_tag = None
995
402
self.checker = None
996
# Read return code from connection (see call_pipe)
997
returncode = connection.recv()
998
connection.close()
999
1000
if returncode >= 0:
1001
self.last_checker_status = returncode
1002
self.last_checker_signal = None
1003
if self.last_checker_status == 0:
403
if os.WIFEXITED(condition):
404
exitstatus = os.WEXITSTATUS(condition)
405
if exitstatus == 0:
1004
406
logger.info("Checker for %(name)s succeeded",
1005
407
vars(self))
1006
408
self.checked_ok()
1007
409
else:
1008
logger.info("Checker for %(name)s failed", vars(self))
410
logger.info("Checker for %(name)s failed",
411
vars(self))
1009
412
else:
1010
self.last_checker_status = -1
1011
self.last_checker_signal = -returncode
1012
413
logger.warning("Checker for %(name)s crashed?",
1013
414
vars(self))
1014
return False
1015
415
1016
416
def checked_ok(self):
1017
"""Assert that the client has been seen, alive and well."""
417
"""Bump up the timeout for this client.
418
419
This should only be called when the client has been seen,
420
alive and well.
421
"""
1018
422
self.last_checked_ok = datetime.datetime.utcnow()
1019
self.last_checker_status = 0
1020
self.last_checker_signal = None
1021
self.bump_timeout()
1022
1023
def bump_timeout(self, timeout=None):
1024
"""Bump up the timeout for this client."""
1025
if timeout is None:
1026
timeout = self.timeout
1027
if self.disable_initiator_tag is not None:
1028
GLib.source_remove(self.disable_initiator_tag)
1029
self.disable_initiator_tag = None
1030
if getattr(self, "enabled", False):
1031
self.disable_initiator_tag = GLib.timeout_add(
1032
int(timeout.total_seconds() * 1000), self.disable)
1033
self.expires = datetime.datetime.utcnow() + timeout
1034
423
gobject.source_remove(self.disable_initiator_tag)
424
self.disable_initiator_tag = (gobject.timeout_add
425
(self.timeout_milliseconds(),
426
self.disable))
427
1035
428
def need_approval(self):
1036
429
self.last_approval_request = datetime.datetime.utcnow()
1037
430
1038
431
def start_checker(self):
1039
432
"""Start a new checker subprocess if one is not running.
1040
433
1041
434
If a checker already exists, leave it running and do
1042
435
nothing."""
1043
436
# The reason for not killing a running checker is that if we
1044
# did that, and if a checker (for some reason) started running
1045
# slowly and taking more than 'interval' time, then the client
1046
# would inevitably timeout, since no checker would get a
1047
# chance to run to completion. If we instead leave running
437
# did that, then if a checker (for some reason) started
438
# running slowly and taking more than 'interval' time, the
439
# client would inevitably timeout, since no checker would get
440
# a chance to run to completion. If we instead leave running
1048
441
# checkers alone, the checker would have to take more time
1049
442
# than 'timeout' for the client to be disabled, which is as it
1050
443
# should be.
1051
1052
if self.checker is not None and not self.checker.is_alive():
1053
logger.warning("Checker was not alive; joining")
1054
self.checker.join()
1055
self.checker = None
444
445
# If a checker exists, make sure it is not a zombie
446
try:
447
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
448
except (AttributeError, OSError), error:
449
if (isinstance(error, OSError)
450
and error.errno != errno.ECHILD):
451
raise error
452
else:
453
if pid:
454
logger.warning("Checker was a zombie")
455
gobject.source_remove(self.checker_callback_tag)
456
self.checker_callback(pid, status,
457
self.current_checker_command)
1056
458
# Start a new checker if needed
1057
459
if self.checker is None:
1058
# Escape attributes for the shell
1059
escaped_attrs = {
1060
attr: re.escape(str(getattr(self, attr)))
1061
for attr in self.runtime_expansions}
1062
460
try:
1063
command = self.checker_command % escaped_attrs
1064
except TypeError as error:
1065
logger.error('Could not format string "%s"',
1066
self.checker_command,
1067
exc_info=error)
1068
return True # Try again later
461
# In case checker_command has exactly one % operator
462
command = self.checker_command % self.host
463
except TypeError:
464
# Escape attributes for the shell
465
escaped_attrs = dict(
466
(attr,
467
re.escape(unicode(str(getattr(self, attr, "")),
468
errors=
469
'replace')))
470
for attr in
471
self.runtime_expansions)
472
473
try:
474
command = self.checker_command % escaped_attrs
475
except TypeError, error:
476
logger.error('Could not format string "%s":'
477
' %s', self.checker_command, error)
478
return True # Try again later
1069
479
self.current_checker_command = command
1070
logger.info("Starting checker %r for %s", command,
1071
self.name)
1072
# We don't need to redirect stdout and stderr, since
1073
# in normal mode, that is already done by daemon(),
1074
# and in debug mode we don't want to. (Stdin is
1075
# always replaced by /dev/null.)
1076
# The exception is when not debugging but nevertheless
1077
# running in the foreground; use the previously
1078
# created wnull.
1079
popen_args = {"close_fds": True,
1080
"shell": True,
1081
"cwd": "/"}
1082
if (not self.server_settings["debug"]
1083
and self.server_settings["foreground"]):
1084
popen_args.update({"stdout": wnull,
1085
"stderr": wnull})
1086
pipe = multiprocessing.Pipe(duplex=False)
1087
self.checker = multiprocessing.Process(
1088
target=call_pipe,
1089
args=(pipe[1], subprocess.call, command),
1090
kwargs=popen_args)
1091
self.checker.start()
1092
self.checker_callback_tag = GLib.io_add_watch(
1093
pipe[0].fileno(), GLib.IO_IN,
1094
self.checker_callback, pipe[0], command)
1095
# Re-run this periodically if run by GLib.timeout_add
480
try:
481
logger.info("Starting checker %r for %s",
482
command, self.name)
483
# We don't need to redirect stdout and stderr, since
484
# in normal mode, that is already done by daemon(),
485
# and in debug mode we don't want to. (Stdin is
486
# always replaced by /dev/null.)
487
self.checker = subprocess.Popen(command,
488
close_fds=True,
489
shell=True, cwd="/")
490
self.checker_callback_tag = (gobject.child_watch_add
491
(self.checker.pid,
492
self.checker_callback,
493
data=command))
494
# The checker may have completed before the gobject
495
# watch was added. Check for this.
496
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
497
if pid:
498
gobject.source_remove(self.checker_callback_tag)
499
self.checker_callback(pid, status, command)
500
except OSError, error:
501
logger.error("Failed to start subprocess: %s",
502
error)
503
# Re-run this periodically if run by gobject.timeout_add
1096
504
return True
1097
505
1098
506
def stop_checker(self):
1099
507
"""Force the checker process, if any, to stop."""
1100
508
if self.checker_callback_tag:
1101
GLib.source_remove(self.checker_callback_tag)
509
gobject.source_remove(self.checker_callback_tag)
1102
510
self.checker_callback_tag = None
1103
511
if getattr(self, "checker", None) is None:
1104
512
return
1105
513
logger.debug("Stopping checker for %(name)s", vars(self))
1106
self.checker.terminate()
514
try:
515
os.kill(self.checker.pid, signal.SIGTERM)
516
#time.sleep(0.5)
517
#if self.checker.poll() is None:
518
# os.kill(self.checker.pid, signal.SIGKILL)
519
except OSError, error:
520
if error.errno != errno.ESRCH: # No such process
521
raise
1107
522
self.checker = None
1108
523
1109
1110
def dbus_service_property(dbus_interface,
1111
signature="v",
1112
access="readwrite",
1113
byte_arrays=False):
524
def dbus_service_property(dbus_interface, signature="v",
525
access="readwrite", byte_arrays=False):
1114
526
"""Decorators for marking methods of a DBusObjectWithProperties to
1115
527
become properties on the D-Bus.
1116
528
1117
529
The decorated method will be called with no arguments by "Get"
1118
530
and with one argument by "Set".
1119
531
1120
532
The parameters, where they are supported, are the same as
1121
533
dbus.service.method, except there is only "signature", since the
1122
534
type from Get() and the type sent to Set() is the same.
1125
537
# "Set" method, so we fail early here:
1126
538
if byte_arrays and signature != "ay":
1127
539
raise ValueError("Byte arrays not supported for non-'ay'"
1128
" signature {!r}".format(signature))
1129
540
" signature %r" % signature)
1130
541
def decorator(func):
1131
542
func._dbus_is_property = True
1132
543
func._dbus_interface = dbus_interface
1135
546
func._dbus_name = func.__name__
1136
547
if func._dbus_name.endswith("_dbus_property"):
1137
548
func._dbus_name = func._dbus_name[:-14]
1138
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1139
return func
1140
1141
return decorator
1142
1143
1144
def dbus_interface_annotations(dbus_interface):
1145
"""Decorator for marking functions returning interface annotations
1146
1147
Usage:
1148
1149
@dbus_interface_annotations("org.example.Interface")
1150
def _foo(self): # Function name does not matter
1151
return {"org.freedesktop.DBus.Deprecated": "true",
1152
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1153
"false"}
1154
"""
1155
1156
def decorator(func):
1157
func._dbus_is_interface = True
1158
func._dbus_interface = dbus_interface
1159
func._dbus_name = dbus_interface
1160
return func
1161
1162
return decorator
1163
1164
1165
def dbus_annotations(annotations):
1166
"""Decorator to annotate D-Bus methods, signals or properties
1167
Usage:
1168
1169
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1170
"org.freedesktop.DBus.Property."
1171
"EmitsChangedSignal": "false"})
1172
@dbus_service_property("org.example.Interface", signature="b",
1173
access="r")
1174
def Property_dbus_property(self):
1175
return dbus.Boolean(False)
1176
1177
See also the DBusObjectWithAnnotations class.
1178
"""
1179
1180
def decorator(func):
1181
func._dbus_annotations = annotations
1182
return func
1183
549
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
550
return func
1184
551
return decorator
1185
552
1186
553
1187
554
class DBusPropertyException(dbus.exceptions.DBusException):
1188
555
"""A base class for D-Bus property-related exceptions
1189
556
"""
1190
pass
557
def __unicode__(self):
558
return unicode(str(self))
1191
559
1192
560
1193
561
class DBusPropertyAccessException(DBusPropertyException):
1202
570
pass
1203
571
1204
572
1205
class DBusObjectWithAnnotations(dbus.service.Object):
1206
"""A D-Bus object with annotations.
1207
1208
Classes inheriting from this can use the dbus_annotations
1209
decorator to add annotations to methods or signals.
1210
"""
1211
1212
@staticmethod
1213
def _is_dbus_thing(thing):
1214
"""Returns a function testing if an attribute is a D-Bus thing
1215
1216
If called like _is_dbus_thing("method") it returns a function
1217
suitable for use as predicate to inspect.getmembers().
1218
"""
1219
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1220
False)
1221
1222
def _get_all_dbus_things(self, thing):
1223
"""Returns a generator of (name, attribute) pairs
1224
"""
1225
return ((getattr(athing.__get__(self), "_dbus_name", name),
1226
athing.__get__(self))
1227
for cls in self.__class__.__mro__
1228
for name, athing in
1229
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1230
1231
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1232
out_signature="s",
1233
path_keyword='object_path',
1234
connection_keyword='connection')
1235
def Introspect(self, object_path, connection):
1236
"""Overloading of standard D-Bus method.
1237
1238
Inserts annotation tags on methods and signals.
1239
"""
1240
xmlstring = dbus.service.Object.Introspect(self, object_path,
1241
connection)
1242
try:
1243
document = xml.dom.minidom.parseString(xmlstring)
1244
1245
for if_tag in document.getElementsByTagName("interface"):
1246
# Add annotation tags
1247
for typ in ("method", "signal"):
1248
for tag in if_tag.getElementsByTagName(typ):
1249
annots = dict()
1250
for name, prop in (self.
1251
_get_all_dbus_things(typ)):
1252
if (name == tag.getAttribute("name")
1253
and prop._dbus_interface
1254
== if_tag.getAttribute("name")):
1255
annots.update(getattr(
1256
prop, "_dbus_annotations", {}))
1257
for name, value in annots.items():
1258
ann_tag = document.createElement(
1259
"annotation")
1260
ann_tag.setAttribute("name", name)
1261
ann_tag.setAttribute("value", value)
1262
tag.appendChild(ann_tag)
1263
# Add interface annotation tags
1264
for annotation, value in dict(
1265
itertools.chain.from_iterable(
1266
annotations().items()
1267
for name, annotations
1268
in self._get_all_dbus_things("interface")
1269
if name == if_tag.getAttribute("name")
1270
)).items():
1271
ann_tag = document.createElement("annotation")
1272
ann_tag.setAttribute("name", annotation)
1273
ann_tag.setAttribute("value", value)
1274
if_tag.appendChild(ann_tag)
1275
# Fix argument name for the Introspect method itself
1276
if (if_tag.getAttribute("name")
1277
== dbus.INTROSPECTABLE_IFACE):
1278
for cn in if_tag.getElementsByTagName("method"):
1279
if cn.getAttribute("name") == "Introspect":
1280
for arg in cn.getElementsByTagName("arg"):
1281
if (arg.getAttribute("direction")
1282
== "out"):
1283
arg.setAttribute("name",
1284
"xml_data")
1285
xmlstring = document.toxml("utf-8")
1286
document.unlink()
1287
except (AttributeError, xml.dom.DOMException,
1288
xml.parsers.expat.ExpatError) as error:
1289
logger.error("Failed to override Introspection method",
1290
exc_info=error)
1291
return xmlstring
1292
1293
1294
class DBusObjectWithProperties(DBusObjectWithAnnotations):
573
class DBusObjectWithProperties(dbus.service.Object):
1295
574
"""A D-Bus object with properties.
1296
575
1297
576
Classes inheriting from this can use the dbus_service_property
1298
577
decorator to expose methods as D-Bus properties. It exposes the
1299
578
standard Get(), Set(), and GetAll() methods on the D-Bus.
1300
579
"""
1301
580
581
@staticmethod
582
def _is_dbus_property(obj):
583
return getattr(obj, "_dbus_is_property", False)
584
585
def _get_all_dbus_properties(self):
586
"""Returns a generator of (name, attribute) pairs
587
"""
588
return ((prop._dbus_name, prop)
589
for name, prop in
590
inspect.getmembers(self, self._is_dbus_property))
591
1302
592
def _get_dbus_property(self, interface_name, property_name):
1303
593
"""Returns a bound method if one exists which is a D-Bus
1304
594
property with the specified name and interface.
1305
595
"""
1306
for cls in self.__class__.__mro__:
1307
for name, value in inspect.getmembers(
1308
cls, self._is_dbus_thing("property")):
1309
if (value._dbus_name == property_name
1310
and value._dbus_interface == interface_name):
1311
return value.__get__(self)
1312
596
for name in (property_name,
597
property_name + "_dbus_property"):
598
prop = getattr(self, name, None)
599
if (prop is None
600
or not self._is_dbus_property(prop)
601
or prop._dbus_name != property_name
602
or (interface_name and prop._dbus_interface
603
and interface_name != prop._dbus_interface)):
604
continue
605
return prop
1313
606
# No such property
1314
raise DBusPropertyNotFound("{}:{}.{}".format(
1315
self.dbus_object_path, interface_name, property_name))
1316
1317
@classmethod
1318
def _get_all_interface_names(cls):
1319
"""Get a sequence of all interfaces supported by an object"""
1320
return (name for name in set(getattr(getattr(x, attr),
1321
"_dbus_interface", None)
1322
for x in (inspect.getmro(cls))
1323
for attr in dir(x))
1324
if name is not None)
1325
1326
@dbus.service.method(dbus.PROPERTIES_IFACE,
1327
in_signature="ss",
607
raise DBusPropertyNotFound(self.dbus_object_path + ":"
608
+ interface_name + "."
609
+ property_name)
610
611
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1328
612
out_signature="v")
1329
613
def Get(self, interface_name, property_name):
1330
614
"""Standard D-Bus property Get() method, see D-Bus standard.
1336
620
if not hasattr(value, "variant_level"):
1337
621
return value
1338
622
return type(value)(value, variant_level=value.variant_level+1)
1339
623
1340
624
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1341
625
def Set(self, interface_name, property_name, value):
1342
626
"""Standard D-Bus property Set() method, see D-Bus standard.
1348
632
# The byte_arrays option is not supported yet on
1349
633
# signatures other than "ay".
1350
634
if prop._dbus_signature != "ay":
1351
raise ValueError("Byte arrays not supported for non-"
1352
"'ay' signature {!r}"
1353
.format(prop._dbus_signature))
1354
value = dbus.ByteArray(b''.join(chr(byte)
1355
for byte in value))
635
raise ValueError
636
value = dbus.ByteArray(''.join(unichr(byte)
637
for byte in value))
1356
638
prop(value)
1357
1358
@dbus.service.method(dbus.PROPERTIES_IFACE,
1359
in_signature="s",
639
640
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1360
641
out_signature="a{sv}")
1361
642
def GetAll(self, interface_name):
1362
643
"""Standard D-Bus property GetAll() method, see D-Bus
1364
645
1365
646
Note: Will not include properties with access="write".
1366
647
"""
1367
properties = {}
1368
for name, prop in self._get_all_dbus_things("property"):
648
all = {}
649
for name, prop in self._get_all_dbus_properties():
1369
650
if (interface_name
1370
651
and interface_name != prop._dbus_interface):
1371
652
# Interface non-empty but did not match
1375
656
continue
1376
657
value = prop()
1377
658
if not hasattr(value, "variant_level"):
1378
properties[name] = value
659
all[name] = value
1379
660
continue
1380
properties[name] = type(value)(
1381
value, variant_level=value.variant_level + 1)
1382
return dbus.Dictionary(properties, signature="sv")
1383
1384
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1385
def PropertiesChanged(self, interface_name, changed_properties,
1386
invalidated_properties):
1387
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1388
standard.
1389
"""
1390
pass
1391
661
all[name] = type(value)(value, variant_level=
662
value.variant_level+1)
663
return dbus.Dictionary(all, signature="sv")
664
1392
665
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1393
666
out_signature="s",
1394
667
path_keyword='object_path',
1395
668
connection_keyword='connection')
1396
669
def Introspect(self, object_path, connection):
1397
"""Overloading of standard D-Bus method.
1398
1399
Inserts property tags and interface annotation tags.
670
"""Standard D-Bus method, overloaded to insert property tags.
1400
671
"""
1401
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1402
object_path,
1403
connection)
672
xmlstring = dbus.service.Object.Introspect(self, object_path,
673
connection)
1404
674
try:
1405
675
document = xml.dom.minidom.parseString(xmlstring)
1406
1407
676
def make_tag(document, name, prop):
1408
677
e = document.createElement("property")
1409
678
e.setAttribute("name", name)
1410
679
e.setAttribute("type", prop._dbus_signature)
1411
680
e.setAttribute("access", prop._dbus_access)
1412
681
return e
1413
1414
682
for if_tag in document.getElementsByTagName("interface"):
1415
# Add property tags
1416
683
for tag in (make_tag(document, name, prop)
1417
684
for name, prop
1418
in self._get_all_dbus_things("property")
685
in self._get_all_dbus_properties()
1419
686
if prop._dbus_interface
1420
687
== if_tag.getAttribute("name")):
1421
688
if_tag.appendChild(tag)
1422
# Add annotation tags for properties
1423
for tag in if_tag.getElementsByTagName("property"):
1424
annots = dict()
1425
for name, prop in self._get_all_dbus_things(
1426
"property"):
1427
if (name == tag.getAttribute("name")
1428
and prop._dbus_interface
1429
== if_tag.getAttribute("name")):
1430
annots.update(getattr(
1431
prop, "_dbus_annotations", {}))
1432
for name, value in annots.items():
1433
ann_tag = document.createElement(
1434
"annotation")
1435
ann_tag.setAttribute("name", name)
1436
ann_tag.setAttribute("value", value)
1437
tag.appendChild(ann_tag)
1438
689
# Add the names to the return values for the
1439
690
# "org.freedesktop.DBus.Properties" methods
1440
691
if (if_tag.getAttribute("name")
1453
704
xmlstring = document.toxml("utf-8")
1454
705
document.unlink()
1455
706
except (AttributeError, xml.dom.DOMException,
1456
xml.parsers.expat.ExpatError) as error:
1457
logger.error("Failed to override Introspection method",
1458
exc_info=error)
1459
return xmlstring
1460
1461
try:
1462
dbus.OBJECT_MANAGER_IFACE
1463
except AttributeError:
1464
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1465
1466
1467
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1468
"""A D-Bus object with an ObjectManager.
1469
1470
Classes inheriting from this exposes the standard
1471
GetManagedObjects call and the InterfacesAdded and
1472
InterfacesRemoved signals on the standard
1473
"org.freedesktop.DBus.ObjectManager" interface.
1474
1475
Note: No signals are sent automatically; they must be sent
1476
manually.
1477
"""
1478
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1479
out_signature="a{oa{sa{sv}}}")
1480
def GetManagedObjects(self):
1481
"""This function must be overridden"""
1482
raise NotImplementedError()
1483
1484
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1485
signature="oa{sa{sv}}")
1486
def InterfacesAdded(self, object_path, interfaces_and_properties):
1487
pass
1488
1489
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1490
def InterfacesRemoved(self, object_path, interfaces):
1491
pass
1492
1493
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1494
out_signature="s",
1495
path_keyword='object_path',
1496
connection_keyword='connection')
1497
def Introspect(self, object_path, connection):
1498
"""Overloading of standard D-Bus method.
1499
1500
Override return argument name of GetManagedObjects to be
1501
"objpath_interfaces_and_properties"
1502
"""
1503
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1504
object_path,
1505
connection)
1506
try:
1507
document = xml.dom.minidom.parseString(xmlstring)
1508
1509
for if_tag in document.getElementsByTagName("interface"):
1510
# Fix argument name for the GetManagedObjects method
1511
if (if_tag.getAttribute("name")
1512
== dbus.OBJECT_MANAGER_IFACE):
1513
for cn in if_tag.getElementsByTagName("method"):
1514
if (cn.getAttribute("name")
1515
== "GetManagedObjects"):
1516
for arg in cn.getElementsByTagName("arg"):
1517
if (arg.getAttribute("direction")
1518
== "out"):
1519
arg.setAttribute(
1520
"name",
1521
"objpath_interfaces"
1522
"_and_properties")
1523
xmlstring = document.toxml("utf-8")
1524
document.unlink()
1525
except (AttributeError, xml.dom.DOMException,
1526
xml.parsers.expat.ExpatError) as error:
1527
logger.error("Failed to override Introspection method",
1528
exc_info=error)
1529
return xmlstring
1530
1531
1532
def datetime_to_dbus(dt, variant_level=0):
1533
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1534
if dt is None:
1535
return dbus.String("", variant_level=variant_level)
1536
return dbus.String(dt.isoformat(), variant_level=variant_level)
1537
1538
1539
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1540
"""A class decorator; applied to a subclass of
1541
dbus.service.Object, it will add alternate D-Bus attributes with
1542
interface names according to the "alt_interface_names" mapping.
1543
Usage:
1544
1545
@alternate_dbus_interfaces({"org.example.Interface":
1546
"net.example.AlternateInterface"})
1547
class SampleDBusObject(dbus.service.Object):
1548
@dbus.service.method("org.example.Interface")
1549
def SampleDBusMethod():
1550
pass
1551
1552
The above "SampleDBusMethod" on "SampleDBusObject" will be
1553
reachable via two interfaces: "org.example.Interface" and
1554
"net.example.AlternateInterface", the latter of which will have
1555
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1556
"true", unless "deprecate" is passed with a False value.
1557
1558
This works for methods and signals, and also for D-Bus properties
1559
(from DBusObjectWithProperties) and interfaces (from the
1560
dbus_interface_annotations decorator).
1561
"""
1562
1563
def wrapper(cls):
1564
for orig_interface_name, alt_interface_name in (
1565
alt_interface_names.items()):
1566
attr = {}
1567
interface_names = set()
1568
# Go though all attributes of the class
1569
for attrname, attribute in inspect.getmembers(cls):
1570
# Ignore non-D-Bus attributes, and D-Bus attributes
1571
# with the wrong interface name
1572
if (not hasattr(attribute, "_dbus_interface")
1573
or not attribute._dbus_interface.startswith(
1574
orig_interface_name)):
1575
continue
1576
# Create an alternate D-Bus interface name based on
1577
# the current name
1578
alt_interface = attribute._dbus_interface.replace(
1579
orig_interface_name, alt_interface_name)
1580
interface_names.add(alt_interface)
1581
# Is this a D-Bus signal?
1582
if getattr(attribute, "_dbus_is_signal", False):
1583
# Extract the original non-method undecorated
1584
# function by black magic
1585
if sys.version_info.major == 2:
1586
nonmethod_func = (dict(
1587
zip(attribute.func_code.co_freevars,
1588
attribute.__closure__))
1589
["func"].cell_contents)
1590
else:
1591
nonmethod_func = (dict(
1592
zip(attribute.__code__.co_freevars,
1593
attribute.__closure__))
1594
["func"].cell_contents)
1595
# Create a new, but exactly alike, function
1596
# object, and decorate it to be a new D-Bus signal
1597
# with the alternate D-Bus interface name
1598
new_function = copy_function(nonmethod_func)
1599
new_function = (dbus.service.signal(
1600
alt_interface,
1601
attribute._dbus_signature)(new_function))
1602
# Copy annotations, if any
1603
try:
1604
new_function._dbus_annotations = dict(
1605
attribute._dbus_annotations)
1606
except AttributeError:
1607
pass
1608
1609
# Define a creator of a function to call both the
1610
# original and alternate functions, so both the
1611
# original and alternate signals gets sent when
1612
# the function is called
1613
def fixscope(func1, func2):
1614
"""This function is a scope container to pass
1615
func1 and func2 to the "call_both" function
1616
outside of its arguments"""
1617
1618
@functools.wraps(func2)
1619
def call_both(*args, **kwargs):
1620
"""This function will emit two D-Bus
1621
signals by calling func1 and func2"""
1622
func1(*args, **kwargs)
1623
func2(*args, **kwargs)
1624
# Make wrapper function look like a D-Bus
1625
# signal
1626
for name, attr in inspect.getmembers(func2):
1627
if name.startswith("_dbus_"):
1628
setattr(call_both, name, attr)
1629
1630
return call_both
1631
# Create the "call_both" function and add it to
1632
# the class
1633
attr[attrname] = fixscope(attribute, new_function)
1634
# Is this a D-Bus method?
1635
elif getattr(attribute, "_dbus_is_method", False):
1636
# Create a new, but exactly alike, function
1637
# object. Decorate it to be a new D-Bus method
1638
# with the alternate D-Bus interface name. Add it
1639
# to the class.
1640
attr[attrname] = (
1641
dbus.service.method(
1642
alt_interface,
1643
attribute._dbus_in_signature,
1644
attribute._dbus_out_signature)
1645
(copy_function(attribute)))
1646
# Copy annotations, if any
1647
try:
1648
attr[attrname]._dbus_annotations = dict(
1649
attribute._dbus_annotations)
1650
except AttributeError:
1651
pass
1652
# Is this a D-Bus property?
1653
elif getattr(attribute, "_dbus_is_property", False):
1654
# Create a new, but exactly alike, function
1655
# object, and decorate it to be a new D-Bus
1656
# property with the alternate D-Bus interface
1657
# name. Add it to the class.
1658
attr[attrname] = (dbus_service_property(
1659
alt_interface, attribute._dbus_signature,
1660
attribute._dbus_access,
1661
attribute._dbus_get_args_options
1662
["byte_arrays"])
1663
(copy_function(attribute)))
1664
# Copy annotations, if any
1665
try:
1666
attr[attrname]._dbus_annotations = dict(
1667
attribute._dbus_annotations)
1668
except AttributeError:
1669
pass
1670
# Is this a D-Bus interface?
1671
elif getattr(attribute, "_dbus_is_interface", False):
1672
# Create a new, but exactly alike, function
1673
# object. Decorate it to be a new D-Bus interface
1674
# with the alternate D-Bus interface name. Add it
1675
# to the class.
1676
attr[attrname] = (
1677
dbus_interface_annotations(alt_interface)
1678
(copy_function(attribute)))
1679
if deprecate:
1680
# Deprecate all alternate interfaces
1681
iname = "_AlternateDBusNames_interface_annotation{}"
1682
for interface_name in interface_names:
1683
1684
@dbus_interface_annotations(interface_name)
1685
def func(self):
1686
return {"org.freedesktop.DBus.Deprecated":
1687
"true"}
1688
# Find an unused name
1689
for aname in (iname.format(i)
1690
for i in itertools.count()):
1691
if aname not in attr:
1692
attr[aname] = func
1693
break
1694
if interface_names:
1695
# Replace the class with a new subclass of it with
1696
# methods, signals, etc. as created above.
1697
if sys.version_info.major == 2:
1698
cls = type(b"{}Alternate".format(cls.__name__),
1699
(cls, ), attr)
1700
else:
1701
cls = type("{}Alternate".format(cls.__name__),
1702
(cls, ), attr)
1703
return cls
1704
1705
return wrapper
1706
1707
1708
@alternate_dbus_interfaces({"se.recompile.Mandos":
1709
"se.bsnet.fukt.Mandos"})
707
xml.parsers.expat.ExpatError), error:
708
logger.error("Failed to override Introspection method",
709
error)
710
return xmlstring
711
712
1710
713
class ClientDBus(Client, DBusObjectWithProperties):
1711
714
"""A Client class using D-Bus
1712
715
1713
716
Attributes:
1714
717
dbus_object_path: dbus.ObjectPath
1715
718
bus: dbus.SystemBus()
1716
719
"""
1717
720
1718
721
runtime_expansions = (Client.runtime_expansions
1719
+ ("dbus_object_path", ))
1720
1721
_interface = "se.recompile.Mandos.Client"
1722
722
+ ("dbus_object_path",))
723
1723
724
# dbus.service.Object doesn't use super(), so we can't either.
1724
1725
def __init__(self, bus=None, *args, **kwargs):
725
726
def __init__(self, bus = None, *args, **kwargs):
727
self._approvals_pending = 0
1726
728
self.bus = bus
1727
729
Client.__init__(self, *args, **kwargs)
1728
730
# Only now, when this client is initialized, can it show up on
1729
731
# the D-Bus
1730
client_object_name = str(self.name).translate(
732
client_object_name = unicode(self.name).translate(
1731
733
{ord("."): ord("_"),
1732
734
ord("-"): ord("_")})
1733
self.dbus_object_path = dbus.ObjectPath(
1734
"/clients/" + client_object_name)
735
self.dbus_object_path = (dbus.ObjectPath
736
("/clients/" + client_object_name))
1735
737
DBusObjectWithProperties.__init__(self, self.bus,
1736
738
self.dbus_object_path)
1737
1738
def notifychangeproperty(transform_func, dbus_name,
1739
type_func=lambda x: x,
1740
variant_level=1,
1741
invalidate_only=False,
1742
_interface=_interface):
1743
""" Modify a variable so that it's a property which announces
1744
its changes to DBus.
1745
1746
transform_fun: Function that takes a value and a variant_level
1747
and transforms it to a D-Bus type.
1748
dbus_name: D-Bus name of the variable
1749
type_func: Function that transform the value before sending it
1750
to the D-Bus. Default: no transform
1751
variant_level: D-Bus variant level. Default: 1
1752
"""
1753
attrname = "_{}".format(dbus_name)
1754
1755
def setter(self, value):
1756
if hasattr(self, "dbus_object_path"):
1757
if (not hasattr(self, attrname) or
1758
type_func(getattr(self, attrname, None))
1759
!= type_func(value)):
1760
if invalidate_only:
1761
self.PropertiesChanged(
1762
_interface, dbus.Dictionary(),
1763
dbus.Array((dbus_name, )))
1764
else:
1765
dbus_value = transform_func(
1766
type_func(value),
1767
variant_level=variant_level)
1768
self.PropertyChanged(dbus.String(dbus_name),
1769
dbus_value)
1770
self.PropertiesChanged(
1771
_interface,
1772
dbus.Dictionary({dbus.String(dbus_name):
1773
dbus_value}),
1774
dbus.Array())
1775
setattr(self, attrname, value)
1776
1777
return property(lambda self: getattr(self, attrname), setter)
1778
1779
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1780
approvals_pending = notifychangeproperty(dbus.Boolean,
1781
"ApprovalPending",
1782
type_func=bool)
1783
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1784
last_enabled = notifychangeproperty(datetime_to_dbus,
1785
"LastEnabled")
1786
checker = notifychangeproperty(
1787
dbus.Boolean, "CheckerRunning",
1788
type_func=lambda checker: checker is not None)
1789
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1790
"LastCheckedOK")
1791
last_checker_status = notifychangeproperty(dbus.Int16,
1792
"LastCheckerStatus")
1793
last_approval_request = notifychangeproperty(
1794
datetime_to_dbus, "LastApprovalRequest")
1795
approved_by_default = notifychangeproperty(dbus.Boolean,
1796
"ApprovedByDefault")
1797
approval_delay = notifychangeproperty(
1798
dbus.UInt64, "ApprovalDelay",
1799
type_func=lambda td: td.total_seconds() * 1000)
1800
approval_duration = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDuration",
1802
type_func=lambda td: td.total_seconds() * 1000)
1803
host = notifychangeproperty(dbus.String, "Host")
1804
timeout = notifychangeproperty(
1805
dbus.UInt64, "Timeout",
1806
type_func=lambda td: td.total_seconds() * 1000)
1807
extended_timeout = notifychangeproperty(
1808
dbus.UInt64, "ExtendedTimeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1810
interval = notifychangeproperty(
1811
dbus.UInt64, "Interval",
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
checker_command = notifychangeproperty(dbus.String, "Checker")
1814
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1815
invalidate_only=True)
1816
1817
del notifychangeproperty
1818
739
740
def _get_approvals_pending(self):
741
return self._approvals_pending
742
def _set_approvals_pending(self, value):
743
old_value = self._approvals_pending
744
self._approvals_pending = value
745
bval = bool(value)
746
if (hasattr(self, "dbus_object_path")
747
and bval is not bool(old_value)):
748
dbus_bool = dbus.Boolean(bval, variant_level=1)
749
self.PropertyChanged(dbus.String("ApprovalPending"),
750
dbus_bool)
751
752
approvals_pending = property(_get_approvals_pending,
753
_set_approvals_pending)
754
del _get_approvals_pending, _set_approvals_pending
755
756
@staticmethod
757
def _datetime_to_dbus(dt, variant_level=0):
758
"""Convert a UTC datetime.datetime() to a D-Bus type."""
759
return dbus.String(dt.isoformat(),
760
variant_level=variant_level)
761
762
def enable(self):
763
oldstate = getattr(self, "enabled", False)
764
r = Client.enable(self)
765
if oldstate != self.enabled:
766
# Emit D-Bus signals
767
self.PropertyChanged(dbus.String("Enabled"),
768
dbus.Boolean(True, variant_level=1))
769
self.PropertyChanged(
770
dbus.String("LastEnabled"),
771
self._datetime_to_dbus(self.last_enabled,
772
variant_level=1))
773
return r
774
775
def disable(self, quiet = False):
776
oldstate = getattr(self, "enabled", False)
777
r = Client.disable(self, quiet=quiet)
778
if not quiet and oldstate != self.enabled:
779
# Emit D-Bus signal
780
self.PropertyChanged(dbus.String("Enabled"),
781
dbus.Boolean(False, variant_level=1))
782
return r
783
1819
784
def __del__(self, *args, **kwargs):
1820
785
try:
1821
786
self.remove_from_connection()
1824
789
if hasattr(DBusObjectWithProperties, "__del__"):
1825
790
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1826
791
Client.__del__(self, *args, **kwargs)
1827
1828
def checker_callback(self, source, condition,
1829
connection, command, *args, **kwargs):
1830
ret = Client.checker_callback(self, source, condition,
1831
connection, command, *args,
1832
**kwargs)
1833
exitstatus = self.last_checker_status
1834
if exitstatus >= 0:
792
793
def checker_callback(self, pid, condition, command,
794
*args, **kwargs):
795
self.checker_callback_tag = None
796
self.checker = None
797
# Emit D-Bus signal
798
self.PropertyChanged(dbus.String("CheckerRunning"),
799
dbus.Boolean(False, variant_level=1))
800
if os.WIFEXITED(condition):
801
exitstatus = os.WEXITSTATUS(condition)
1835
802
# Emit D-Bus signal
1836
803
self.CheckerCompleted(dbus.Int16(exitstatus),
1837
# This is specific to GNU libC
1838
dbus.Int64(exitstatus << 8),
804
dbus.Int64(condition),
1839
805
dbus.String(command))
1840
806
else:
1841
807
# Emit D-Bus signal
1842
808
self.CheckerCompleted(dbus.Int16(-1),
1843
dbus.Int64(
1844
# This is specific to GNU libC
1845
(exitstatus << 8)
1846
| self.last_checker_signal),
809
dbus.Int64(condition),
1847
810
dbus.String(command))
1848
return ret
1849
811
812
return Client.checker_callback(self, pid, condition, command,
813
*args, **kwargs)
814
815
def checked_ok(self, *args, **kwargs):
816
r = Client.checked_ok(self, *args, **kwargs)
817
# Emit D-Bus signal
818
self.PropertyChanged(
819
dbus.String("LastCheckedOK"),
820
(self._datetime_to_dbus(self.last_checked_ok,
821
variant_level=1)))
822
return r
823
824
def need_approval(self, *args, **kwargs):
825
r = Client.need_approval(self, *args, **kwargs)
826
# Emit D-Bus signal
827
self.PropertyChanged(
828
dbus.String("LastApprovalRequest"),
829
(self._datetime_to_dbus(self.last_approval_request,
830
variant_level=1)))
831
return r
832
1850
833
def start_checker(self, *args, **kwargs):
1851
old_checker_pid = getattr(self.checker, "pid", None)
834
old_checker = self.checker
835
if self.checker is not None:
836
old_checker_pid = self.checker.pid
837
else:
838
old_checker_pid = None
1852
839
r = Client.start_checker(self, *args, **kwargs)
1853
840
# Only if new checker process was started
1854
841
if (self.checker is not None
1855
842
and old_checker_pid != self.checker.pid):
1856
843
# Emit D-Bus signal
1857
844
self.CheckerStarted(self.current_checker_command)
845
self.PropertyChanged(
846
dbus.String("CheckerRunning"),
847
dbus.Boolean(True, variant_level=1))
848
return r
849
850
def stop_checker(self, *args, **kwargs):
851
old_checker = getattr(self, "checker", None)
852
r = Client.stop_checker(self, *args, **kwargs)
853
if (old_checker is not None
854
and getattr(self, "checker", None) is None):
855
self.PropertyChanged(dbus.String("CheckerRunning"),
856
dbus.Boolean(False, variant_level=1))
1858
857
return r
1859
858
1860
859
def _reset_approved(self):
1861
self.approved = None
860
self._approved = None
1862
861
return False
1863
862
1864
863
def approve(self, value=True):
1865
self.approved = value
1866
GLib.timeout_add(int(self.approval_duration.total_seconds()
1867
* 1000), self._reset_approved)
1868
864
self.send_changedstate()
1869
1870
# D-Bus methods, signals & properties
1871
1872
# Interfaces
1873
1874
# Signals
1875
865
self._approved = value
866
gobject.timeout_add(self._timedelta_to_milliseconds
867
(self.approval_duration),
868
self._reset_approved)
869
870
871
## D-Bus methods, signals & properties
872
_interface = "se.bsnet.fukt.Mandos.Client"
873
874
## Signals
875
1876
876
# CheckerCompleted - signal
1877
877
@dbus.service.signal(_interface, signature="nxs")
1878
878
def CheckerCompleted(self, exitcode, waitstatus, command):
1879
879
"D-Bus signal"
1880
880
pass
1881
881
1882
882
# CheckerStarted - signal
1883
883
@dbus.service.signal(_interface, signature="s")
1884
884
def CheckerStarted(self, command):
1885
885
"D-Bus signal"
1886
886
pass
1887
887
1888
888
# PropertyChanged - signal
1889
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1890
889
@dbus.service.signal(_interface, signature="sv")
1891
890
def PropertyChanged(self, property, value):
1892
891
"D-Bus signal"
1893
892
pass
1894
893
1895
894
# GotSecret - signal
1896
895
@dbus.service.signal(_interface)
1897
896
def GotSecret(self):
1900
899
server to mandos-client
1901
900
"""
1902
901
pass
1903
902
1904
903
# Rejected - signal
1905
904
@dbus.service.signal(_interface, signature="s")
1906
905
def Rejected(self, reason):
1907
906
"D-Bus signal"
1908
907
pass
1909
908
1910
909
# NeedApproval - signal
1911
910
@dbus.service.signal(_interface, signature="tb")
1912
911
def NeedApproval(self, timeout, default):
1913
912
"D-Bus signal"
1914
913
return self.need_approval()
1915
1916
# Methods
1917
914
915
## Methods
916
1918
917
# Approve - method
1919
918
@dbus.service.method(_interface, in_signature="b")
1920
919
def Approve(self, value):
1921
920
self.approve(value)
1922
921
1923
922
# CheckedOK - method
1924
923
@dbus.service.method(_interface)
1925
924
def CheckedOK(self):
1926
self.checked_ok()
1927
925
return self.checked_ok()
926
1928
927
# Enable - method
1929
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1930
928
@dbus.service.method(_interface)
1931
929
def Enable(self):
1932
930
"D-Bus method"
1933
931
self.enable()
1934
932
1935
933
# StartChecker - method
1936
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1937
934
@dbus.service.method(_interface)
1938
935
def StartChecker(self):
1939
936
"D-Bus method"
1940
937
self.start_checker()
1941
938
1942
939
# Disable - method
1943
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1944
940
@dbus.service.method(_interface)
1945
941
def Disable(self):
1946
942
"D-Bus method"
1947
943
self.disable()
1948
944
1949
945
# StopChecker - method
1950
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1951
946
@dbus.service.method(_interface)
1952
947
def StopChecker(self):
1953
948
self.stop_checker()
1954
1955
# Properties
1956
949
950
## Properties
951
1957
952
# ApprovalPending - property
1958
953
@dbus_service_property(_interface, signature="b", access="read")
1959
954
def ApprovalPending_dbus_property(self):
1960
955
return dbus.Boolean(bool(self.approvals_pending))
1961
956
1962
957
# ApprovedByDefault - property
1963
@dbus_service_property(_interface,
1964
signature="b",
958
@dbus_service_property(_interface, signature="b",
1965
959
access="readwrite")
1966
960
def ApprovedByDefault_dbus_property(self, value=None):
1967
961
if value is None: # get
1968
962
return dbus.Boolean(self.approved_by_default)
1969
963
self.approved_by_default = bool(value)
1970
964
# Emit D-Bus signal
965
self.PropertyChanged(dbus.String("ApprovedByDefault"),
966
dbus.Boolean(value, variant_level=1))
967
1971
968
# ApprovalDelay - property
1972
@dbus_service_property(_interface,
1973
signature="t",
969
@dbus_service_property(_interface, signature="t",
1974
970
access="readwrite")
1975
971
def ApprovalDelay_dbus_property(self, value=None):
1976
972
if value is None: # get
1977
return dbus.UInt64(self.approval_delay.total_seconds()
1978
* 1000)
973
return dbus.UInt64(self.approval_delay_milliseconds())
1979
974
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1980
975
# Emit D-Bus signal
976
self.PropertyChanged(dbus.String("ApprovalDelay"),
977
dbus.UInt64(value, variant_level=1))
978
1981
979
# ApprovalDuration - property
1982
@dbus_service_property(_interface,
1983
signature="t",
980
@dbus_service_property(_interface, signature="t",
1984
981
access="readwrite")
1985
982
def ApprovalDuration_dbus_property(self, value=None):
1986
983
if value is None: # get
1987
return dbus.UInt64(self.approval_duration.total_seconds()
1988
* 1000)
984
return dbus.UInt64(self._timedelta_to_milliseconds(
985
self.approval_duration))
1989
986
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1990
987
# Emit D-Bus signal
988
self.PropertyChanged(dbus.String("ApprovalDuration"),
989
dbus.UInt64(value, variant_level=1))
990
1991
991
# Name - property
1992
@dbus_annotations(
1993
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1994
992
@dbus_service_property(_interface, signature="s", access="read")
1995
993
def Name_dbus_property(self):
1996
994
return dbus.String(self.name)
1997
995
1998
996
# Fingerprint - property
1999
@dbus_annotations(
2000
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2001
997
@dbus_service_property(_interface, signature="s", access="read")
2002
998
def Fingerprint_dbus_property(self):
2003
999
return dbus.String(self.fingerprint)
2004
1000
2005
1001
# Host - property
2006
@dbus_service_property(_interface,
2007
signature="s",
1002
@dbus_service_property(_interface, signature="s",
2008
1003
access="readwrite")
2009
1004
def Host_dbus_property(self, value=None):
2010
1005
if value is None: # get
2011
1006
return dbus.String(self.host)
2012
self.host = str(value)
2013
1007
self.host = value
1008
# Emit D-Bus signal
1009
self.PropertyChanged(dbus.String("Host"),
1010
dbus.String(value, variant_level=1))
1011
2014
1012
# Created - property
2015
@dbus_annotations(
2016
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2017
1013
@dbus_service_property(_interface, signature="s", access="read")
2018
1014
def Created_dbus_property(self):
2019
return datetime_to_dbus(self.created)
2020
1015
return dbus.String(self._datetime_to_dbus(self.created))
1016
2021
1017
# LastEnabled - property
2022
1018
@dbus_service_property(_interface, signature="s", access="read")
2023
1019
def LastEnabled_dbus_property(self):
2024
return datetime_to_dbus(self.last_enabled)
2025
1020
if self.last_enabled is None:
1021
return dbus.String("")
1022
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1023
2026
1024
# Enabled - property
2027
@dbus_service_property(_interface,
2028
signature="b",
1025
@dbus_service_property(_interface, signature="b",
2029
1026
access="readwrite")
2030
1027
def Enabled_dbus_property(self, value=None):
2031
1028
if value is None: # get
2034
1031
self.enable()
2035
1032
else:
2036
1033
self.disable()
2037
1034
2038
1035
# LastCheckedOK - property
2039
@dbus_service_property(_interface,
2040
signature="s",
1036
@dbus_service_property(_interface, signature="s",
2041
1037
access="readwrite")
2042
1038
def LastCheckedOK_dbus_property(self, value=None):
2043
1039
if value is not None:
2044
1040
self.checked_ok()
2045
1041
return
2046
return datetime_to_dbus(self.last_checked_ok)
2047
2048
# LastCheckerStatus - property
2049
@dbus_service_property(_interface, signature="n", access="read")
2050
def LastCheckerStatus_dbus_property(self):
2051
return dbus.Int16(self.last_checker_status)
2052
2053
# Expires - property
2054
@dbus_service_property(_interface, signature="s", access="read")
2055
def Expires_dbus_property(self):
2056
return datetime_to_dbus(self.expires)
2057
1042
if self.last_checked_ok is None:
1043
return dbus.String("")
1044
return dbus.String(self._datetime_to_dbus(self
1045
.last_checked_ok))
1046
2058
1047
# LastApprovalRequest - property
2059
1048
@dbus_service_property(_interface, signature="s", access="read")
2060
1049
def LastApprovalRequest_dbus_property(self):
2061
return datetime_to_dbus(self.last_approval_request)
2062
1050
if self.last_approval_request is None:
1051
return dbus.String("")
1052
return dbus.String(self.
1053
_datetime_to_dbus(self
1054
.last_approval_request))
1055
2063
1056
# Timeout - property
2064
@dbus_service_property(_interface,
2065
signature="t",
1057
@dbus_service_property(_interface, signature="t",
2066
1058
access="readwrite")
2067
1059
def Timeout_dbus_property(self, value=None):
2068
1060
if value is None: # get
2069
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2070
old_timeout = self.timeout
1061
return dbus.UInt64(self.timeout_milliseconds())
2071
1062
self.timeout = datetime.timedelta(0, 0, 0, value)
2072
# Reschedule disabling
2073
if self.enabled:
2074
now = datetime.datetime.utcnow()
2075
self.expires += self.timeout - old_timeout
2076
if self.expires <= now:
2077
# The timeout has passed
2078
self.disable()
2079
else:
2080
if (getattr(self, "disable_initiator_tag", None)
2081
is None):
2082
return
2083
GLib.source_remove(self.disable_initiator_tag)
2084
self.disable_initiator_tag = GLib.timeout_add(
2085
int((self.expires - now).total_seconds() * 1000),
2086
self.disable)
2087
2088
# ExtendedTimeout - property
2089
@dbus_service_property(_interface,
2090
signature="t",
2091
access="readwrite")
2092
def ExtendedTimeout_dbus_property(self, value=None):
2093
if value is None: # get
2094
return dbus.UInt64(self.extended_timeout.total_seconds()
2095
* 1000)
2096
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2097
1063
# Emit D-Bus signal
1064
self.PropertyChanged(dbus.String("Timeout"),
1065
dbus.UInt64(value, variant_level=1))
1066
if getattr(self, "disable_initiator_tag", None) is None:
1067
return
1068
# Reschedule timeout
1069
gobject.source_remove(self.disable_initiator_tag)
1070
self.disable_initiator_tag = None
1071
time_to_die = (self.
1072
_timedelta_to_milliseconds((self
1073
.last_checked_ok
1074
+ self.timeout)
1075
- datetime.datetime
1076
.utcnow()))
1077
if time_to_die <= 0:
1078
# The timeout has passed
1079
self.disable()
1080
else:
1081
self.disable_initiator_tag = (gobject.timeout_add
1082
(time_to_die, self.disable))
1083
2098
1084
# Interval - property
2099
@dbus_service_property(_interface,
2100
signature="t",
1085
@dbus_service_property(_interface, signature="t",
2101
1086
access="readwrite")
2102
1087
def Interval_dbus_property(self, value=None):
2103
1088
if value is None: # get
2104
return dbus.UInt64(self.interval.total_seconds() * 1000)
1089
return dbus.UInt64(self.interval_milliseconds())
2105
1090
self.interval = datetime.timedelta(0, 0, 0, value)
1091
# Emit D-Bus signal
1092
self.PropertyChanged(dbus.String("Interval"),
1093
dbus.UInt64(value, variant_level=1))
2106
1094
if getattr(self, "checker_initiator_tag", None) is None:
2107
1095
return
2108
if self.enabled:
2109
# Reschedule checker run
2110
GLib.source_remove(self.checker_initiator_tag)
2111
self.checker_initiator_tag = GLib.timeout_add(
2112
value, self.start_checker)
2113
self.start_checker() # Start one now, too
1096
# Reschedule checker run
1097
gobject.source_remove(self.checker_initiator_tag)
1098
self.checker_initiator_tag = (gobject.timeout_add
1099
(value, self.start_checker))
1100
self.start_checker() # Start one now, too
2114
1101
2115
1102
# Checker - property
2116
@dbus_service_property(_interface,
2117
signature="s",
1103
@dbus_service_property(_interface, signature="s",
2118
1104
access="readwrite")
2119
1105
def Checker_dbus_property(self, value=None):
2120
1106
if value is None: # get
2121
1107
return dbus.String(self.checker_command)
2122
self.checker_command = str(value)
2123
1108
self.checker_command = value
1109
# Emit D-Bus signal
1110
self.PropertyChanged(dbus.String("Checker"),
1111
dbus.String(self.checker_command,
1112
variant_level=1))
1113
2124
1114
# CheckerRunning - property
2125
@dbus_service_property(_interface,
2126
signature="b",
1115
@dbus_service_property(_interface, signature="b",
2127
1116
access="readwrite")
2128
1117
def CheckerRunning_dbus_property(self, value=None):
2129
1118
if value is None: # get
2132
1121
self.start_checker()
2133
1122
else:
2134
1123
self.stop_checker()
2135
1124
2136
1125
# ObjectPath - property
2137
@dbus_annotations(
2138
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2139
"org.freedesktop.DBus.Deprecated": "true"})
2140
1126
@dbus_service_property(_interface, signature="o", access="read")
2141
1127
def ObjectPath_dbus_property(self):
2142
return self.dbus_object_path # is already a dbus.ObjectPath
2143
1128
return self.dbus_object_path # is already a dbus.ObjectPath
1129
2144
1130
# Secret = property
2145
@dbus_annotations(
2146
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2147
"invalidates"})
2148
@dbus_service_property(_interface,
2149
signature="ay",
2150
access="write",
2151
byte_arrays=True)
1131
@dbus_service_property(_interface, signature="ay",
1132
access="write", byte_arrays=True)
2152
1133
def Secret_dbus_property(self, value):
2153
self.secret = bytes(value)
2154
1134
self.secret = str(value)
1135
2155
1136
del _interface
2156
1137
2157
1138
2160
1141
self._pipe = child_pipe
2161
1142
self._pipe.send(('init', fpr, address))
2162
1143
if not self._pipe.recv():
2163
raise KeyError(fpr)
1144
raise KeyError()
2164
1145
2165
1146
def __getattribute__(self, name):
2166
if name == '_pipe':
1147
if(name == '_pipe'):
2167
1148
return super(ProxyClient, self).__getattribute__(name)
2168
1149
self._pipe.send(('getattr', name))
2169
1150
data = self._pipe.recv()
2170
1151
if data[0] == 'data':
2171
1152
return data[1]
2172
1153
if data[0] == 'function':
2173
2174
1154
def func(*args, **kwargs):
2175
1155
self._pipe.send(('funcall', name, args, kwargs))
2176
1156
return self._pipe.recv()[1]
2177
2178
1157
return func
2179
1158
2180
1159
def __setattr__(self, name, value):
2181
if name == '_pipe':
1160
if(name == '_pipe'):
2182
1161
return super(ProxyClient, self).__setattr__(name, value)
2183
1162
self._pipe.send(('setattr', name, value))
2184
1163
2185
1164
2186
1165
class ClientHandler(socketserver.BaseRequestHandler, object):
2187
1166
"""A class to handle client connections.
2188
1167
2189
1168
Instantiated once for each connection to handle it.
2190
1169
Note: This will run in its own forked process."""
2191
1170
2192
1171
def handle(self):
2193
1172
with contextlib.closing(self.server.child_pipe) as child_pipe:
2194
1173
logger.info("TCP connection from: %s",
2195
str(self.client_address))
1174
unicode(self.client_address))
2196
1175
logger.debug("Pipe FD: %d",
2197
1176
self.server.child_pipe.fileno())
2198
1177
2199
session = gnutls.ClientSession(self.request)
2200
2201
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2202
# "+AES-256-CBC", "+SHA1",
2203
# "+COMP-NULL", "+CTYPE-OPENPGP",
2204
# "+DHE-DSS"))
1178
session = (gnutls.connection
1179
.ClientSession(self.request,
1180
gnutls.connection
1181
.X509Credentials()))
1182
1183
# Note: gnutls.connection.X509Credentials is really a
1184
# generic GnuTLS certificate credentials object so long as
1185
# no X.509 keys are added to it. Therefore, we can use it
1186
# here despite using OpenPGP certificates.
1187
1188
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1189
# "+AES-256-CBC", "+SHA1",
1190
# "+COMP-NULL", "+CTYPE-OPENPGP",
1191
# "+DHE-DSS"))
2205
1192
# Use a fallback default, since this MUST be set.
2206
1193
priority = self.server.gnutls_priority
2207
1194
if priority is None:
2208
1195
priority = "NORMAL"
2209
gnutls.priority_set_direct(session._c_object,
2210
priority.encode("utf-8"),
2211
None)
1196
(gnutls.library.functions
1197
.gnutls_priority_set_direct(session._c_object,
1198
priority, None))
2212
1199
2213
1200
# Start communication using the Mandos protocol
2214
1201
# Get protocol number
2216
1203
logger.debug("Protocol version: %r", line)
2217
1204
try:
2218
1205
if int(line.strip().split()[0]) > 1:
2219
raise RuntimeError(line)
2220
except (ValueError, IndexError, RuntimeError) as error:
1206
raise RuntimeError
1207
except (ValueError, IndexError, RuntimeError), error:
2221
1208
logger.error("Unknown protocol version: %s", error)
2222
1209
return
2223
1210
2224
1211
# Start GnuTLS connection
2225
1212
try:
2226
1213
session.handshake()
2227
except gnutls.Error as error:
1214
except gnutls.errors.GNUTLSError, error:
2228
1215
logger.warning("Handshake failed: %s", error)
2229
1216
# Do not run session.bye() here: the session is not
2230
1217
# established. Just abandon the request.
2234
1221
approval_required = False
2235
1222
try:
2236
1223
try:
2237
fpr = self.fingerprint(
2238
self.peer_certificate(session))
2239
except (TypeError, gnutls.Error) as error:
1224
fpr = self.fingerprint(self.peer_certificate
1225
(session))
1226
except (TypeError, gnutls.errors.GNUTLSError), error:
2240
1227
logger.warning("Bad certificate: %s", error)
2241
1228
return
2242
1229
logger.debug("Fingerprint: %s", fpr)
2246
1233
self.client_address)
2247
1234
except KeyError:
2248
1235
return
2249
1236
2250
1237
if client.approval_delay:
2251
1238
delay = client.approval_delay
2252
1239
client.approvals_pending += 1
2253
1240
approval_required = True
2254
1241
2255
1242
while True:
2256
1243
if not client.enabled:
2257
logger.info("Client %s is disabled",
2258
client.name)
1244
logger.warning("Client %s is disabled",
1245
client.name)
2259
1246
if self.server.use_dbus:
2260
1247
# Emit D-Bus signal
2261
client.Rejected("Disabled")
1248
client.Rejected("Disabled")
2262
1249
return
2263
2264
if client.approved or not client.approval_delay:
2265
# We are approved or approval is disabled
1250
1251
if client._approved or not client.approval_delay:
1252
#We are approved or approval is disabled
2266
1253
break
2267
elif client.approved is None:
1254
elif client._approved is None:
2268
1255
logger.info("Client %s needs approval",
2269
1256
client.name)
2270
1257
if self.server.use_dbus:
2271
1258
# Emit D-Bus signal
2272
1259
client.NeedApproval(
2273
client.approval_delay.total_seconds()
2274
* 1000, client.approved_by_default)
1260
client.approval_delay_milliseconds(),
1261
client.approved_by_default)
2275
1262
else:
2276
1263
logger.warning("Client %s was not approved",
2277
1264
client.name)
2279
1266
# Emit D-Bus signal
2280
1267
client.Rejected("Denied")
2281
1268
return
2282
2283
# wait until timeout or approved
1269
1270
#wait until timeout or approved
1271
#x = float(client._timedelta_to_milliseconds(delay))
2284
1272
time = datetime.datetime.now()
2285
1273
client.changedstate.acquire()
2286
client.changedstate.wait(delay.total_seconds())
1274
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2287
1275
client.changedstate.release()
2288
1276
time2 = datetime.datetime.now()
2289
1277
if (time2 - time) >= delay:
2299
1287
break
2300
1288
else:
2301
1289
delay -= time2 - time
2302
2303
try:
2304
session.send(client.secret)
2305
except gnutls.Error as error:
2306
logger.warning("gnutls send failed",
2307
exc_info=error)
2308
return
1290
1291
sent_size = 0
1292
while sent_size < len(client.secret):
1293
try:
1294
sent = session.send(client.secret[sent_size:])
1295
except (gnutls.errors.GNUTLSError), error:
1296
logger.warning("gnutls send failed")
1297
return
1298
logger.debug("Sent: %d, remaining: %d",
1299
sent, len(client.secret)
1300
- (sent_size + sent))
1301
sent_size += sent
2309
1302
2310
1303
logger.info("Sending secret to %s", client.name)
2311
# bump the timeout using extended_timeout
2312
client.bump_timeout(client.extended_timeout)
1304
# bump the timeout as if seen
1305
client.checked_ok()
2313
1306
if self.server.use_dbus:
2314
1307
# Emit D-Bus signal
2315
1308
client.GotSecret()
2316
1309
2317
1310
finally:
2318
1311
if approval_required:
2319
1312
client.approvals_pending -= 1
2320
1313
try:
2321
1314
session.bye()
2322
except gnutls.Error as error:
2323
logger.warning("GnuTLS bye failed",
2324
exc_info=error)
2325
1315
except (gnutls.errors.GNUTLSError), error:
1316
logger.warning("GnuTLS bye failed")
1317
2326
1318
@staticmethod
2327
1319
def peer_certificate(session):
2328
1320
"Return the peer's OpenPGP certificate as a bytestring"
2329
1321
# If not an OpenPGP certificate...
2330
if (gnutls.certificate_type_get(session._c_object)
2331
!= gnutls.CRT_OPENPGP):
2332
# ...return invalid data
2333
return b""
1322
if (gnutls.library.functions
1323
.gnutls_certificate_type_get(session._c_object)
1324
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1325
# ...do the normal thing
1326
return session.peer_certificate
2334
1327
list_size = ctypes.c_uint(1)
2335
cert_list = (gnutls.certificate_get_peers
1328
cert_list = (gnutls.library.functions
1329
.gnutls_certificate_get_peers
2336
1330
(session._c_object, ctypes.byref(list_size)))
2337
1331
if not bool(cert_list) and list_size.value != 0:
2338
raise gnutls.Error("error getting peer certificate")
1332
raise gnutls.errors.GNUTLSError("error getting peer"
1333
" certificate")
2339
1334
if list_size.value == 0:
2340
1335
return None
2341
1336
cert = cert_list[0]
2342
1337
return ctypes.string_at(cert.data, cert.size)
2343
1338
2344
1339
@staticmethod
2345
1340
def fingerprint(openpgp):
2346
1341
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2347
1342
# New GnuTLS "datum" with the OpenPGP public key
2348
datum = gnutls.datum_t(
2349
ctypes.cast(ctypes.c_char_p(openpgp),
2350
ctypes.POINTER(ctypes.c_ubyte)),
2351
ctypes.c_uint(len(openpgp)))
1343
datum = (gnutls.library.types
1344
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1345
ctypes.POINTER
1346
(ctypes.c_ubyte)),
1347
ctypes.c_uint(len(openpgp))))
2352
1348
# New empty GnuTLS certificate
2353
crt = gnutls.openpgp_crt_t()
2354
gnutls.openpgp_crt_init(ctypes.byref(crt))
1349
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1350
(gnutls.library.functions
1351
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2355
1352
# Import the OpenPGP public key into the certificate
2356
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2357
gnutls.OPENPGP_FMT_RAW)
1353
(gnutls.library.functions
1354
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1355
gnutls.library.constants
1356
.GNUTLS_OPENPGP_FMT_RAW))
2358
1357
# Verify the self signature in the key
2359
1358
crtverify = ctypes.c_uint()
2360
gnutls.openpgp_crt_verify_self(crt, 0,
2361
ctypes.byref(crtverify))
1359
(gnutls.library.functions
1360
.gnutls_openpgp_crt_verify_self(crt, 0,
1361
ctypes.byref(crtverify)))
2362
1362
if crtverify.value != 0:
2363
gnutls.openpgp_crt_deinit(crt)
2364
raise gnutls.CertificateSecurityError("Verify failed")
1363
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1364
raise (gnutls.errors.CertificateSecurityError
1365
("Verify failed"))
2365
1366
# New buffer for the fingerprint
2366
1367
buf = ctypes.create_string_buffer(20)
2367
1368
buf_len = ctypes.c_size_t()
2368
1369
# Get the fingerprint from the certificate into the buffer
2369
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2370
ctypes.byref(buf_len))
1370
(gnutls.library.functions
1371
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1372
ctypes.byref(buf_len)))
2371
1373
# Deinit the certificate
2372
gnutls.openpgp_crt_deinit(crt)
1374
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2373
1375
# Convert the buffer to a Python bytestring
2374
1376
fpr = ctypes.string_at(buf, buf_len.value)
2375
1377
# Convert the bytestring to hexadecimal notation
2376
hex_fpr = binascii.hexlify(fpr).upper()
1378
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2377
1379
return hex_fpr
2378
1380
2379
1381
2380
1382
class MultiprocessingMixIn(object):
2381
1383
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2382
2383
1384
def sub_process_main(self, request, address):
2384
1385
try:
2385
1386
self.finish_request(request, address)
2386
except Exception:
1387
except:
2387
1388
self.handle_error(request, address)
2388
1389
self.close_request(request)
2389
1390
2390
1391
def process_request(self, request, address):
2391
1392
"""Start a new process to process the request."""
2392
proc = multiprocessing.Process(target=self.sub_process_main,
2393
args=(request, address))
2394
proc.start()
2395
return proc
2396
1393
multiprocessing.Process(target = self.sub_process_main,
1394
args = (request, address)).start()
2397
1395
2398
1396
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2399
1397
""" adds a pipe to the MixIn """
2400
2401
1398
def process_request(self, request, client_address):
2402
1399
"""Overrides and wraps the original process_request().
2403
1400
2404
1401
This function creates a new pipe in self.pipe
2405
1402
"""
2406
1403
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2407
1404
2408
proc = MultiprocessingMixIn.process_request(self, request,
2409
client_address)
1405
super(MultiprocessingMixInWithPipe,
1406
self).process_request(request, client_address)
2410
1407
self.child_pipe.close()
2411
self.add_pipe(parent_pipe, proc)
1408
self.add_pipe(parent_pipe)
2412
1409
2413
def add_pipe(self, parent_pipe, proc):
1410
def add_pipe(self, parent_pipe):
2414
1411
"""Dummy function; override as necessary"""
2415
raise NotImplementedError()
2416
1412
raise NotImplementedError
2417
1413
2418
1414
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2419
1415
socketserver.TCPServer, object):
2420
1416
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2421
1417
2422
1418
Attributes:
2423
1419
enabled: Boolean; whether this server is activated yet
2424
1420
interface: None or a network interface name (string)
2425
1421
use_ipv6: Boolean; to use IPv6 or not
2426
1422
"""
2427
2428
1423
def __init__(self, server_address, RequestHandlerClass,
2429
interface=None,
2430
use_ipv6=True,
2431
socketfd=None):
2432
"""If socketfd is set, use that file descriptor instead of
2433
creating a new one with socket.socket().
2434
"""
1424
interface=None, use_ipv6=True):
2435
1425
self.interface = interface
2436
1426
if use_ipv6:
2437
1427
self.address_family = socket.AF_INET6
2438
if socketfd is not None:
2439
# Save the file descriptor
2440
self.socketfd = socketfd
2441
# Save the original socket.socket() function
2442
self.socket_socket = socket.socket
2443
2444
# To implement --socket, we monkey patch socket.socket.
2445
#
2446
# (When socketserver.TCPServer is a new-style class, we
2447
# could make self.socket into a property instead of monkey
2448
# patching socket.socket.)
2449
#
2450
# Create a one-time-only replacement for socket.socket()
2451
@functools.wraps(socket.socket)
2452
def socket_wrapper(*args, **kwargs):
2453
# Restore original function so subsequent calls are
2454
# not affected.
2455
socket.socket = self.socket_socket
2456
del self.socket_socket
2457
# This time only, return a new socket object from the
2458
# saved file descriptor.
2459
return socket.fromfd(self.socketfd, *args, **kwargs)
2460
# Replace socket.socket() function with wrapper
2461
socket.socket = socket_wrapper
2462
# The socketserver.TCPServer.__init__ will call
2463
# socket.socket(), which might be our replacement,
2464
# socket_wrapper(), if socketfd was set.
2465
1428
socketserver.TCPServer.__init__(self, server_address,
2466
1429
RequestHandlerClass)
2467
2468
1430
def server_bind(self):
2469
1431
"""This overrides the normal server_bind() function
2470
1432
to bind to an interface if one was specified, and also NOT to
2471
1433
bind to an address or port if they were not specified."""
2472
global SO_BINDTODEVICE
2473
1434
if self.interface is not None:
2474
1435
if SO_BINDTODEVICE is None:
2475
# Fall back to a hard-coded value which seems to be
2476
# common enough.
2477
logger.warning("SO_BINDTODEVICE not found, trying 25")
2478
SO_BINDTODEVICE = 25
2479
try:
2480
self.socket.setsockopt(
2481
socket.SOL_SOCKET, SO_BINDTODEVICE,
2482
(self.interface + "\0").encode("utf-8"))
2483
except socket.error as error:
2484
if error.errno == errno.EPERM:
2485
logger.error("No permission to bind to"
2486
" interface %s", self.interface)
2487
elif error.errno == errno.ENOPROTOOPT:
2488
logger.error("SO_BINDTODEVICE not available;"
2489
" cannot bind to interface %s",
2490
self.interface)
2491
elif error.errno == errno.ENODEV:
2492
logger.error("Interface %s does not exist,"
2493
" cannot bind", self.interface)
2494
else:
2495
raise
1436
logger.error("SO_BINDTODEVICE does not exist;"
1437
" cannot bind to interface %s",
1438
self.interface)
1439
else:
1440
try:
1441
self.socket.setsockopt(socket.SOL_SOCKET,
1442
SO_BINDTODEVICE,
1443
str(self.interface
1444
+ '\0'))
1445
except socket.error, error:
1446
if error[0] == errno.EPERM:
1447
logger.error("No permission to"
1448
" bind to interface %s",
1449
self.interface)
1450
elif error[0] == errno.ENOPROTOOPT:
1451
logger.error("SO_BINDTODEVICE not available;"
1452
" cannot bind to interface %s",
1453
self.interface)
1454
else:
1455
raise
2496
1456
# Only bind(2) the socket if we really need to.
2497
1457
if self.server_address[0] or self.server_address[1]:
2498
1458
if not self.server_address[0]:
2499
1459
if self.address_family == socket.AF_INET6:
2500
any_address = "::" # in6addr_any
1460
any_address = "::" # in6addr_any
2501
1461
else:
2502
any_address = "0.0.0.0" # INADDR_ANY
1462
any_address = socket.INADDR_ANY
2503
1463
self.server_address = (any_address,
2504
1464
self.server_address[1])
2505
1465
elif not self.server_address[1]:
2506
self.server_address = (self.server_address[0], 0)
1466
self.server_address = (self.server_address[0],
1467
0)
2507
1468
# if self.interface:
2508
1469
# self.server_address = (self.server_address[0],
2509
1470
# 0, # port
2515
1476
2516
1477
class MandosServer(IPv6_TCPServer):
2517
1478
"""Mandos server.
2518
1479
2519
1480
Attributes:
2520
1481
clients: set of Client objects
2521
1482
gnutls_priority GnuTLS priority string
2522
1483
use_dbus: Boolean; to emit D-Bus signals or not
2523
2524
Assumes a GLib.MainLoop event loop.
1484
1485
Assumes a gobject.MainLoop event loop.
2525
1486
"""
2526
2527
1487
def __init__(self, server_address, RequestHandlerClass,
2528
interface=None,
2529
use_ipv6=True,
2530
clients=None,
2531
gnutls_priority=None,
2532
use_dbus=True,
2533
socketfd=None):
1488
interface=None, use_ipv6=True, clients=None,
1489
gnutls_priority=None, use_dbus=True):
2534
1490
self.enabled = False
2535
1491
self.clients = clients
2536
1492
if self.clients is None:
2537
self.clients = {}
1493
self.clients = set()
2538
1494
self.use_dbus = use_dbus
2539
1495
self.gnutls_priority = gnutls_priority
2540
1496
IPv6_TCPServer.__init__(self, server_address,
2541
1497
RequestHandlerClass,
2542
interface=interface,
2543
use_ipv6=use_ipv6,
2544
socketfd=socketfd)
2545
1498
interface = interface,
1499
use_ipv6 = use_ipv6)
2546
1500
def server_activate(self):
2547
1501
if self.enabled:
2548
1502
return socketserver.TCPServer.server_activate(self)
2549
2550
1503
def enable(self):
2551
1504
self.enabled = True
2552
2553
def add_pipe(self, parent_pipe, proc):
1505
def add_pipe(self, parent_pipe):
2554
1506
# Call "handle_ipc" for both data and EOF events
2555
GLib.io_add_watch(
2556
parent_pipe.fileno(),
2557
GLib.IO_IN | GLib.IO_HUP,
2558
functools.partial(self.handle_ipc,
2559
parent_pipe=parent_pipe,
2560
proc=proc))
2561
2562
def handle_ipc(self, source, condition,
2563
parent_pipe=None,
2564
proc=None,
1507
gobject.io_add_watch(parent_pipe.fileno(),
1508
gobject.IO_IN | gobject.IO_HUP,
1509
functools.partial(self.handle_ipc,
1510
parent_pipe = parent_pipe))
1511
1512
def handle_ipc(self, source, condition, parent_pipe=None,
2565
1513
client_object=None):
2566
# error, or the other end of multiprocessing.Pipe has closed
2567
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2568
# Wait for other process to exit
2569
proc.join()
1514
condition_names = {
1515
gobject.IO_IN: "IN", # There is data to read.
1516
gobject.IO_OUT: "OUT", # Data can be written (without
1517
# blocking).
1518
gobject.IO_PRI: "PRI", # There is urgent data to read.
1519
gobject.IO_ERR: "ERR", # Error condition.
1520
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1521
# broken, usually for pipes and
1522
# sockets).
1523
}
1524
conditions_string = ' | '.join(name
1525
for cond, name in
1526
condition_names.iteritems()
1527
if cond & condition)
1528
# error or the other end of multiprocessing.Pipe has closed
1529
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2570
1530
return False
2571
1531
2572
1532
# Read a request from the child
2573
1533
request = parent_pipe.recv()
2574
1534
command = request[0]
2575
1535
2576
1536
if command == 'init':
2577
1537
fpr = request[1]
2578
1538
address = request[2]
2579
2580
for c in self.clients.values():
1539
1540
for c in self.clients:
2581
1541
if c.fingerprint == fpr:
2582
1542
client = c
2583
1543
break
2584
1544
else:
2585
logger.info("Client not found for fingerprint: %s, ad"
2586
"dress: %s", fpr, address)
1545
logger.warning("Client not found for fingerprint: %s, ad"
1546
"dress: %s", fpr, address)
2587
1547
if self.use_dbus:
2588
1548
# Emit D-Bus signal
2589
mandos_dbus_service.ClientNotFound(fpr,
2590
address[0])
1549
mandos_dbus_service.ClientNotFound(fpr, address[0])
2591
1550
parent_pipe.send(False)
2592
1551
return False
2593
2594
GLib.io_add_watch(
2595
parent_pipe.fileno(),
2596
GLib.IO_IN | GLib.IO_HUP,
2597
functools.partial(self.handle_ipc,
2598
parent_pipe=parent_pipe,
2599
proc=proc,
2600
client_object=client))
1552
1553
gobject.io_add_watch(parent_pipe.fileno(),
1554
gobject.IO_IN | gobject.IO_HUP,
1555
functools.partial(self.handle_ipc,
1556
parent_pipe = parent_pipe,
1557
client_object = client))
2601
1558
parent_pipe.send(True)
2602
# remove the old hook in favor of the new above hook on
2603
# same fileno
1559
# remove the old hook in favor of the new above hook on same fileno
2604
1560
return False
2605
1561
if command == 'funcall':
2606
1562
funcname = request[1]
2607
1563
args = request[2]
2608
1564
kwargs = request[3]
2609
2610
parent_pipe.send(('data', getattr(client_object,
2611
funcname)(*args,
2612
**kwargs)))
1565
1566
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2613
1567
2614
1568
if command == 'getattr':
2615
1569
attrname = request[1]
2616
if isinstance(client_object.__getattribute__(attrname),
2617
collections.Callable):
2618
parent_pipe.send(('function', ))
1570
if callable(client_object.__getattribute__(attrname)):
1571
parent_pipe.send(('function',))
2619
1572
else:
2620
parent_pipe.send((
2621
'data', client_object.__getattribute__(attrname)))
2622
1573
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1574
2623
1575
if command == 'setattr':
2624
1576
attrname = request[1]
2625
1577
value = request[2]
2628
1580
return True
2629
1581
2630
1582
2631
def rfc3339_duration_to_delta(duration):
2632
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2633
2634
>>> rfc3339_duration_to_delta("P7D")
2635
datetime.timedelta(7)
2636
>>> rfc3339_duration_to_delta("PT60S")
2637
datetime.timedelta(0, 60)
2638
>>> rfc3339_duration_to_delta("PT60M")
2639
datetime.timedelta(0, 3600)
2640
>>> rfc3339_duration_to_delta("PT24H")
2641
datetime.timedelta(1)
2642
>>> rfc3339_duration_to_delta("P1W")
2643
datetime.timedelta(7)
2644
>>> rfc3339_duration_to_delta("PT5M30S")
2645
datetime.timedelta(0, 330)
2646
>>> rfc3339_duration_to_delta("P1DT3M20S")
2647
datetime.timedelta(1, 200)
2648
"""
2649
2650
# Parsing an RFC 3339 duration with regular expressions is not
2651
# possible - there would have to be multiple places for the same
2652
# values, like seconds. The current code, while more esoteric, is
2653
# cleaner without depending on a parsing library. If Python had a
2654
# built-in library for parsing we would use it, but we'd like to
2655
# avoid excessive use of external libraries.
2656
2657
# New type for defining tokens, syntax, and semantics all-in-one
2658
Token = collections.namedtuple("Token", (
2659
"regexp", # To match token; if "value" is not None, must have
2660
# a "group" containing digits
2661
"value", # datetime.timedelta or None
2662
"followers")) # Tokens valid after this token
2663
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2664
# the "duration" ABNF definition in RFC 3339, Appendix A.
2665
token_end = Token(re.compile(r"$"), None, frozenset())
2666
token_second = Token(re.compile(r"(\d+)S"),
2667
datetime.timedelta(seconds=1),
2668
frozenset((token_end, )))
2669
token_minute = Token(re.compile(r"(\d+)M"),
2670
datetime.timedelta(minutes=1),
2671
frozenset((token_second, token_end)))
2672
token_hour = Token(re.compile(r"(\d+)H"),
2673
datetime.timedelta(hours=1),
2674
frozenset((token_minute, token_end)))
2675
token_time = Token(re.compile(r"T"),
2676
None,
2677
frozenset((token_hour, token_minute,
2678
token_second)))
2679
token_day = Token(re.compile(r"(\d+)D"),
2680
datetime.timedelta(days=1),
2681
frozenset((token_time, token_end)))
2682
token_month = Token(re.compile(r"(\d+)M"),
2683
datetime.timedelta(weeks=4),
2684
frozenset((token_day, token_end)))
2685
token_year = Token(re.compile(r"(\d+)Y"),
2686
datetime.timedelta(weeks=52),
2687
frozenset((token_month, token_end)))
2688
token_week = Token(re.compile(r"(\d+)W"),
2689
datetime.timedelta(weeks=1),
2690
frozenset((token_end, )))
2691
token_duration = Token(re.compile(r"P"), None,
2692
frozenset((token_year, token_month,
2693
token_day, token_time,
2694
token_week)))
2695
# Define starting values:
2696
# Value so far
2697
value = datetime.timedelta()
2698
found_token = None
2699
# Following valid tokens
2700
followers = frozenset((token_duration, ))
2701
# String left to parse
2702
s = duration
2703
# Loop until end token is found
2704
while found_token is not token_end:
2705
# Search for any currently valid tokens
2706
for token in followers:
2707
match = token.regexp.match(s)
2708
if match is not None:
2709
# Token found
2710
if token.value is not None:
2711
# Value found, parse digits
2712
factor = int(match.group(1), 10)
2713
# Add to value so far
2714
value += factor * token.value
2715
# Strip token from string
2716
s = token.regexp.sub("", s, 1)
2717
# Go to found token
2718
found_token = token
2719
# Set valid next tokens
2720
followers = found_token.followers
2721
break
2722
else:
2723
# No currently valid tokens were found
2724
raise ValueError("Invalid RFC 3339 duration: {!r}"
2725
.format(duration))
2726
# End token found
2727
return value
2728
2729
2730
1583
def string_to_delta(interval):
2731
1584
"""Parse a string and return a datetime.timedelta
2732
1585
2733
1586
>>> string_to_delta('7d')
2734
1587
datetime.timedelta(7)
2735
1588
>>> string_to_delta('60s')
2743
1596
>>> string_to_delta('5m 30s')
2744
1597
datetime.timedelta(0, 330)
2745
1598
"""
2746
2747
try:
2748
return rfc3339_duration_to_delta(interval)
2749
except ValueError:
2750
pass
2751
2752
1599
timevalue = datetime.timedelta(0)
2753
1600
for s in interval.split():
2754
1601
try:
2755
suffix = s[-1]
1602
suffix = unicode(s[-1])
2756
1603
value = int(s[:-1])
2757
1604
if suffix == "d":
2758
1605
delta = datetime.timedelta(value)
2765
1612
elif suffix == "w":
2766
1613
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2767
1614
else:
2768
raise ValueError("Unknown suffix {!r}".format(suffix))
2769
except IndexError as e:
1615
raise ValueError("Unknown suffix %r" % suffix)
1616
except (ValueError, IndexError), e:
2770
1617
raise ValueError(*(e.args))
2771
1618
timevalue += delta
2772
1619
return timevalue
2773
1620
2774
1621
2775
def daemon(nochdir=False, noclose=False):
1622
def if_nametoindex(interface):
1623
"""Call the C function if_nametoindex(), or equivalent
1624
1625
Note: This function cannot accept a unicode string."""
1626
global if_nametoindex
1627
try:
1628
if_nametoindex = (ctypes.cdll.LoadLibrary
1629
(ctypes.util.find_library("c"))
1630
.if_nametoindex)
1631
except (OSError, AttributeError):
1632
logger.warning("Doing if_nametoindex the hard way")
1633
def if_nametoindex(interface):
1634
"Get an interface index the hard way, i.e. using fcntl()"
1635
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1636
with contextlib.closing(socket.socket()) as s:
1637
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1638
struct.pack(str("16s16x"),
1639
interface))
1640
interface_index = struct.unpack(str("I"),
1641
ifreq[16:20])[0]
1642
return interface_index
1643
return if_nametoindex(interface)
1644
1645
1646
def daemon(nochdir = False, noclose = False):
2776
1647
"""See daemon(3). Standard BSD Unix function.
2777
1648
2778
1649
This should really exist as os.daemon, but it doesn't (yet)."""
2779
1650
if os.fork():
2780
1651
sys.exit()
2785
1656
sys.exit()
2786
1657
if not noclose:
2787
1658
# Close all standard open file descriptors
2788
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1659
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2789
1660
if not stat.S_ISCHR(os.fstat(null).st_mode):
2790
1661
raise OSError(errno.ENODEV,
2791
"{} not a character device"
2792
.format(os.devnull))
1662
"%s not a character device"
1663
% os.path.devnull)
2793
1664
os.dup2(null, sys.stdin.fileno())
2794
1665
os.dup2(null, sys.stdout.fileno())
2795
1666
os.dup2(null, sys.stderr.fileno())
2798
1669
2799
1670
2800
1671
def main():
2801
1672
2802
1673
##################################################################
2803
1674
# Parsing of options, both command line and config file
2804
1675
2805
1676
parser = argparse.ArgumentParser()
2806
1677
parser.add_argument("-v", "--version", action="version",
2807
version="%(prog)s {}".format(version),
1678
version = "%%(prog)s %s" % version,
2808
1679
help="show version number and exit")
2809
1680
parser.add_argument("-i", "--interface", metavar="IF",
2810
1681
help="Bind to interface IF")
2816
1687
help="Run self-test")
2817
1688
parser.add_argument("--debug", action="store_true",
2818
1689
help="Debug mode; run in foreground and log"
2819
" to terminal", default=None)
1690
" to terminal")
2820
1691
parser.add_argument("--debuglevel", metavar="LEVEL",
2821
1692
help="Debug level for stdout output")
2822
1693
parser.add_argument("--priority", help="GnuTLS"
2829
1700
" files")
2830
1701
parser.add_argument("--no-dbus", action="store_false",
2831
1702
dest="use_dbus", help="Do not provide D-Bus"
2832
" system bus interface", default=None)
1703
" system bus interface")
2833
1704
parser.add_argument("--no-ipv6", action="store_false",
2834
dest="use_ipv6", help="Do not use IPv6",
2835
default=None)
2836
parser.add_argument("--no-restore", action="store_false",
2837
dest="restore", help="Do not restore stored"
2838
" state", default=None)
2839
parser.add_argument("--socket", type=int,
2840
help="Specify a file descriptor to a network"
2841
" socket to use instead of creating one")
2842
parser.add_argument("--statedir", metavar="DIR",
2843
help="Directory to save/restore state in")
2844
parser.add_argument("--foreground", action="store_true",
2845
help="Run in foreground", default=None)
2846
parser.add_argument("--no-zeroconf", action="store_false",
2847
dest="zeroconf", help="Do not use Zeroconf",
2848
default=None)
2849
1705
dest="use_ipv6", help="Do not use IPv6")
2850
1706
options = parser.parse_args()
2851
1707
2852
1708
if options.check:
2853
1709
import doctest
2854
fail_count, test_count = doctest.testmod()
2855
sys.exit(os.EX_OK if fail_count == 0 else 1)
2856
1710
doctest.testmod()
1711
sys.exit()
1712
2857
1713
# Default values for config file for server-global settings
2858
server_defaults = {"interface": "",
2859
"address": "",
2860
"port": "",
2861
"debug": "False",
2862
"priority":
2863
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2864
":+SIGN-DSA-SHA256",
2865
"servicename": "Mandos",
2866
"use_dbus": "True",
2867
"use_ipv6": "True",
2868
"debuglevel": "",
2869
"restore": "True",
2870
"socket": "",
2871
"statedir": "/var/lib/mandos",
2872
"foreground": "False",
2873
"zeroconf": "True",
2874
}
2875
1714
server_defaults = { "interface": "",
1715
"address": "",
1716
"port": "",
1717
"debug": "False",
1718
"priority":
1719
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1720
"servicename": "Mandos",
1721
"use_dbus": "True",
1722
"use_ipv6": "True",
1723
"debuglevel": "",
1724
}
1725
2876
1726
# Parse config file for server-global settings
2877
1727
server_config = configparser.SafeConfigParser(server_defaults)
2878
1728
del server_defaults
2879
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1729
server_config.read(os.path.join(options.configdir,
1730
"mandos.conf"))
2880
1731
# Convert the SafeConfigParser object to a dict
2881
1732
server_settings = server_config.defaults()
2882
1733
# Use the appropriate methods on the non-string config options
2883
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1734
for option in ("debug", "use_dbus", "use_ipv6"):
2884
1735
server_settings[option] = server_config.getboolean("DEFAULT",
2885
1736
option)
2886
1737
if server_settings["port"]:
2887
1738
server_settings["port"] = server_config.getint("DEFAULT",
2888
1739
"port")
2889
if server_settings["socket"]:
2890
server_settings["socket"] = server_config.getint("DEFAULT",
2891
"socket")
2892
# Later, stdin will, and stdout and stderr might, be dup'ed
2893
# over with an opened os.devnull. But we don't want this to
2894
# happen with a supplied network socket.
2895
if 0 <= server_settings["socket"] <= 2:
2896
server_settings["socket"] = os.dup(server_settings
2897
["socket"])
2898
1740
del server_config
2899
1741
2900
1742
# Override the settings from the config file with command line
2901
1743
# options, if set.
2902
1744
for option in ("interface", "address", "port", "debug",
2903
"priority", "servicename", "configdir", "use_dbus",
2904
"use_ipv6", "debuglevel", "restore", "statedir",
2905
"socket", "foreground", "zeroconf"):
1745
"priority", "servicename", "configdir",
1746
"use_dbus", "use_ipv6", "debuglevel"):
2906
1747
value = getattr(options, option)
2907
1748
if value is not None:
2908
1749
server_settings[option] = value
2909
1750
del options
2910
1751
# Force all strings to be unicode
2911
1752
for option in server_settings.keys():
2912
if isinstance(server_settings[option], bytes):
2913
server_settings[option] = (server_settings[option]
2914
.decode("utf-8"))
2915
# Force all boolean options to be boolean
2916
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2917
"foreground", "zeroconf"):
2918
server_settings[option] = bool(server_settings[option])
2919
# Debug implies foreground
2920
if server_settings["debug"]:
2921
server_settings["foreground"] = True
1753
if type(server_settings[option]) is str:
1754
server_settings[option] = unicode(server_settings[option])
2922
1755
# Now we have our good server settings in "server_settings"
2923
1756
2924
1757
##################################################################
2925
2926
if (not server_settings["zeroconf"]
2927
and not (server_settings["port"]
2928
or server_settings["socket"] != "")):
2929
parser.error("Needs port or socket to work without Zeroconf")
2930
1758
2931
1759
# For convenience
2932
1760
debug = server_settings["debug"]
2933
1761
debuglevel = server_settings["debuglevel"]
2934
1762
use_dbus = server_settings["use_dbus"]
2935
1763
use_ipv6 = server_settings["use_ipv6"]
2936
stored_state_path = os.path.join(server_settings["statedir"],
2937
stored_state_file)
2938
foreground = server_settings["foreground"]
2939
zeroconf = server_settings["zeroconf"]
2940
2941
if debug:
2942
initlogger(debug, logging.DEBUG)
2943
else:
2944
if not debuglevel:
2945
initlogger(debug)
2946
else:
2947
level = getattr(logging, debuglevel.upper())
2948
initlogger(debug, level)
2949
1764
2950
1765
if server_settings["servicename"] != "Mandos":
2951
syslogger.setFormatter(
2952
logging.Formatter('Mandos ({}) [%(process)d]:'
2953
' %(levelname)s: %(message)s'.format(
2954
server_settings["servicename"])))
2955
1766
syslogger.setFormatter(logging.Formatter
1767
('Mandos (%s) [%%(process)d]:'
1768
' %%(levelname)s: %%(message)s'
1769
% server_settings["servicename"]))
1770
2956
1771
# Parse config file with clients
2957
client_config = configparser.SafeConfigParser(Client
2958
.client_defaults)
1772
client_defaults = { "timeout": "1h",
1773
"interval": "5m",
1774
"checker": "fping -q -- %%(host)s",
1775
"host": "",
1776
"approval_delay": "0s",
1777
"approval_duration": "1s",
1778
}
1779
client_config = configparser.SafeConfigParser(client_defaults)
2959
1780
client_config.read(os.path.join(server_settings["configdir"],
2960
1781
"clients.conf"))
2961
1782
2962
1783
global mandos_dbus_service
2963
1784
mandos_dbus_service = None
2964
2965
socketfd = None
2966
if server_settings["socket"] != "":
2967
socketfd = server_settings["socket"]
2968
tcp_server = MandosServer(
2969
(server_settings["address"], server_settings["port"]),
2970
ClientHandler,
2971
interface=(server_settings["interface"] or None),
2972
use_ipv6=use_ipv6,
2973
gnutls_priority=server_settings["priority"],
2974
use_dbus=use_dbus,
2975
socketfd=socketfd)
2976
if not foreground:
2977
pidfilename = "/run/mandos.pid"
2978
if not os.path.isdir("/run/."):
2979
pidfilename = "/var/run/mandos.pid"
2980
pidfile = None
2981
try:
2982
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2983
except IOError as e:
2984
logger.error("Could not open file %r", pidfilename,
2985
exc_info=e)
2986
2987
for name, group in (("_mandos", "_mandos"),
2988
("mandos", "mandos"),
2989
("nobody", "nogroup")):
2990
try:
2991
uid = pwd.getpwnam(name).pw_uid
2992
gid = pwd.getpwnam(group).pw_gid
2993
break
1785
1786
tcp_server = MandosServer((server_settings["address"],
1787
server_settings["port"]),
1788
ClientHandler,
1789
interface=(server_settings["interface"]
1790
or None),
1791
use_ipv6=use_ipv6,
1792
gnutls_priority=
1793
server_settings["priority"],
1794
use_dbus=use_dbus)
1795
if not debug:
1796
pidfilename = "/var/run/mandos.pid"
1797
try:
1798
pidfile = open(pidfilename, "w")
1799
except IOError:
1800
logger.error("Could not open file %r", pidfilename)
1801
1802
try:
1803
uid = pwd.getpwnam("_mandos").pw_uid
1804
gid = pwd.getpwnam("_mandos").pw_gid
1805
except KeyError:
1806
try:
1807
uid = pwd.getpwnam("mandos").pw_uid
1808
gid = pwd.getpwnam("mandos").pw_gid
2994
1809
except KeyError:
2995
continue
2996
else:
2997
uid = 65534
2998
gid = 65534
1810
try:
1811
uid = pwd.getpwnam("nobody").pw_uid
1812
gid = pwd.getpwnam("nobody").pw_gid
1813
except KeyError:
1814
uid = 65534
1815
gid = 65534
2999
1816
try:
3000
1817
os.setgid(gid)
3001
1818
os.setuid(uid)
3002
if debug:
3003
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3004
gid))
3005
except OSError as error:
3006
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3007
.format(uid, gid, os.strerror(error.errno)))
3008
if error.errno != errno.EPERM:
3009
raise
1819
except OSError, error:
1820
if error[0] != errno.EPERM:
1821
raise error
1822
1823
if not debug and not debuglevel:
1824
syslogger.setLevel(logging.WARNING)
1825
console.setLevel(logging.WARNING)
1826
if debuglevel:
1827
level = getattr(logging, debuglevel.upper())
1828
syslogger.setLevel(level)
1829
console.setLevel(level)
3010
1830
3011
1831
if debug:
3012
1832
# Enable all possible GnuTLS debugging
3013
1833
3014
1834
# "Use a log level over 10 to enable all debugging options."
3015
1835
# - GnuTLS manual
3016
gnutls.global_set_log_level(11)
3017
3018
@gnutls.log_func
1836
gnutls.library.functions.gnutls_global_set_log_level(11)
1837
1838
@gnutls.library.types.gnutls_log_func
3019
1839
def debug_gnutls(level, string):
3020
1840
logger.debug("GnuTLS: %s", string[:-1])
3021
3022
gnutls.global_set_log_function(debug_gnutls)
3023
1841
1842
(gnutls.library.functions
1843
.gnutls_global_set_log_function(debug_gnutls))
1844
3024
1845
# Redirect stdin so all checkers get /dev/null
3025
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1846
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3026
1847
os.dup2(null, sys.stdin.fileno())
3027
1848
if null > 2:
3028
1849
os.close(null)
3029
1850
else:
1851
# No console logging
1852
logger.removeHandler(console)
1853
3030
1854
# Need to fork before connecting to D-Bus
3031
if not foreground:
1855
if not debug:
3032
1856
# Close all input and output, do double fork, etc.
3033
1857
daemon()
3034
3035
# multiprocessing will use threads, so before we use GLib we need
3036
# to inform GLib that threads will be used.
3037
GLib.threads_init()
3038
1858
3039
1859
global main_loop
3040
1860
# From the Avahi example code
3041
DBusGMainLoop(set_as_default=True)
3042
main_loop = GLib.MainLoop()
1861
DBusGMainLoop(set_as_default=True )
1862
main_loop = gobject.MainLoop()
3043
1863
bus = dbus.SystemBus()
3044
1864
# End of Avahi example code
3045
1865
if use_dbus:
3046
1866
try:
3047
bus_name = dbus.service.BusName("se.recompile.Mandos",
3048
bus,
3049
do_not_queue=True)
3050
old_bus_name = dbus.service.BusName(
3051
"se.bsnet.fukt.Mandos", bus,
3052
do_not_queue=True)
3053
except dbus.exceptions.DBusException as e:
3054
logger.error("Disabling D-Bus:", exc_info=e)
1867
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1868
bus, do_not_queue=True)
1869
except dbus.exceptions.NameExistsException, e:
1870
logger.error(unicode(e) + ", disabling D-Bus")
3055
1871
use_dbus = False
3056
1872
server_settings["use_dbus"] = False
3057
1873
tcp_server.use_dbus = False
3058
if zeroconf:
3059
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3060
service = AvahiServiceToSyslog(
3061
name=server_settings["servicename"],
3062
servicetype="_mandos._tcp",
3063
protocol=protocol,
3064
bus=bus)
3065
if server_settings["interface"]:
3066
service.interface = if_nametoindex(
3067
server_settings["interface"].encode("utf-8"))
3068
1874
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1875
service = AvahiService(name = server_settings["servicename"],
1876
servicetype = "_mandos._tcp",
1877
protocol = protocol, bus = bus)
1878
if server_settings["interface"]:
1879
service.interface = (if_nametoindex
1880
(str(server_settings["interface"])))
1881
3069
1882
global multiprocessing_manager
3070
1883
multiprocessing_manager = multiprocessing.Manager()
3071
1884
3072
1885
client_class = Client
3073
1886
if use_dbus:
3074
client_class = functools.partial(ClientDBus, bus=bus)
3075
3076
client_settings = Client.config_parser(client_config)
3077
old_client_settings = {}
3078
clients_data = {}
3079
3080
# This is used to redirect stdout and stderr for checker processes
3081
global wnull
3082
wnull = open(os.devnull, "w") # A writable /dev/null
3083
# Only used if server is running in foreground but not in debug
3084
# mode
3085
if debug or not foreground:
3086
wnull.close()
3087
3088
# Get client data and settings from last running state.
3089
if server_settings["restore"]:
3090
try:
3091
with open(stored_state_path, "rb") as stored_state:
3092
if sys.version_info.major == 2:
3093
clients_data, old_client_settings = pickle.load(
3094
stored_state)
3095
else:
3096
bytes_clients_data, bytes_old_client_settings = (
3097
pickle.load(stored_state, encoding="bytes"))
3098
# Fix bytes to strings
3099
# clients_data
3100
# .keys()
3101
clients_data = {(key.decode("utf-8")
3102
if isinstance(key, bytes)
3103
else key): value
3104
for key, value in
3105
bytes_clients_data.items()}
3106
del bytes_clients_data
3107
for key in clients_data:
3108
value = {(k.decode("utf-8")
3109
if isinstance(k, bytes) else k): v
3110
for k, v in
3111
clients_data[key].items()}
3112
clients_data[key] = value
3113
# .client_structure
3114
value["client_structure"] = [
3115
(s.decode("utf-8")
3116
if isinstance(s, bytes)
3117
else s) for s in
3118
value["client_structure"]]
3119
# .name & .host
3120
for k in ("name", "host"):
3121
if isinstance(value[k], bytes):
3122
value[k] = value[k].decode("utf-8")
3123
# old_client_settings
3124
# .keys()
3125
old_client_settings = {
3126
(key.decode("utf-8")
3127
if isinstance(key, bytes)
3128
else key): value
3129
for key, value in
3130
bytes_old_client_settings.items()}
3131
del bytes_old_client_settings
3132
# .host
3133
for value in old_client_settings.values():
3134
if isinstance(value["host"], bytes):
3135
value["host"] = (value["host"]
3136
.decode("utf-8"))
3137
os.remove(stored_state_path)
3138
except IOError as e:
3139
if e.errno == errno.ENOENT:
3140
logger.warning("Could not load persistent state:"
3141
" {}".format(os.strerror(e.errno)))
3142
else:
3143
logger.critical("Could not load persistent state:",
3144
exc_info=e)
3145
raise
3146
except EOFError as e:
3147
logger.warning("Could not load persistent state: "
3148
"EOFError:",
3149
exc_info=e)
3150
3151
with PGPEngine() as pgp:
3152
for client_name, client in clients_data.items():
3153
# Skip removed clients
3154
if client_name not in client_settings:
3155
continue
3156
3157
# Decide which value to use after restoring saved state.
3158
# We have three different values: Old config file,
3159
# new config file, and saved state.
3160
# New config value takes precedence if it differs from old
3161
# config value, otherwise use saved state.
3162
for name, value in client_settings[client_name].items():
3163
try:
3164
# For each value in new config, check if it
3165
# differs from the old config value (Except for
3166
# the "secret" attribute)
3167
if (name != "secret"
3168
and (value !=
3169
old_client_settings[client_name][name])):
3170
client[name] = value
3171
except KeyError:
3172
pass
3173
3174
# Clients who has passed its expire date can still be
3175
# enabled if its last checker was successful. A Client
3176
# whose checker succeeded before we stored its state is
3177
# assumed to have successfully run all checkers during
3178
# downtime.
3179
if client["enabled"]:
3180
if datetime.datetime.utcnow() >= client["expires"]:
3181
if not client["last_checked_ok"]:
3182
logger.warning(
3183
"disabling client {} - Client never "
3184
"performed a successful checker".format(
3185
client_name))
3186
client["enabled"] = False
3187
elif client["last_checker_status"] != 0:
3188
logger.warning(
3189
"disabling client {} - Client last"
3190
" checker failed with error code"
3191
" {}".format(
3192
client_name,
3193
client["last_checker_status"]))
3194
client["enabled"] = False
3195
else:
3196
client["expires"] = (
3197
datetime.datetime.utcnow()
3198
+ client["timeout"])
3199
logger.debug("Last checker succeeded,"
3200
" keeping {} enabled".format(
3201
client_name))
1887
client_class = functools.partial(ClientDBus, bus = bus)
1888
def client_config_items(config, section):
1889
special_settings = {
1890
"approved_by_default":
1891
lambda: config.getboolean(section,
1892
"approved_by_default"),
1893
}
1894
for name, value in config.items(section):
3202
1895
try:
3203
client["secret"] = pgp.decrypt(
3204
client["encrypted_secret"],
3205
client_settings[client_name]["secret"])
3206
except PGPError:
3207
# If decryption fails, we use secret from new settings
3208
logger.debug("Failed to decrypt {} old secret".format(
3209
client_name))
3210
client["secret"] = (client_settings[client_name]
3211
["secret"])
3212
3213
# Add/remove clients based on new changes made to config
3214
for client_name in (set(old_client_settings)
3215
- set(client_settings)):
3216
del clients_data[client_name]
3217
for client_name in (set(client_settings)
3218
- set(old_client_settings)):
3219
clients_data[client_name] = client_settings[client_name]
3220
3221
# Create all client objects
3222
for client_name, client in clients_data.items():
3223
tcp_server.clients[client_name] = client_class(
3224
name=client_name,
3225
settings=client,
3226
server_settings=server_settings)
3227
1896
yield (name, special_settings[name]())
1897
except KeyError:
1898
yield (name, value)
1899
1900
tcp_server.clients.update(set(
1901
client_class(name = section,
1902
config= dict(client_config_items(
1903
client_config, section)))
1904
for section in client_config.sections()))
3228
1905
if not tcp_server.clients:
3229
1906
logger.warning("No clients defined")
3230
3231
if not foreground:
3232
if pidfile is not None:
3233
pid = os.getpid()
3234
try:
3235
with pidfile:
3236
print(pid, file=pidfile)
3237
except IOError:
3238
logger.error("Could not write to file %r with PID %d",
3239
pidfilename, pid)
3240
del pidfile
1907
1908
if not debug:
1909
try:
1910
with pidfile:
1911
pid = os.getpid()
1912
pidfile.write(str(pid) + "\n".encode("utf-8"))
1913
del pidfile
1914
except IOError:
1915
logger.error("Could not write to file %r with PID %d",
1916
pidfilename, pid)
1917
except NameError:
1918
# "pidfile" was never created
1919
pass
3241
1920
del pidfilename
3242
3243
for termsig in (signal.SIGHUP, signal.SIGTERM):
3244
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3245
lambda: main_loop.quit() and False)
3246
1921
1922
signal.signal(signal.SIGINT, signal.SIG_IGN)
1923
1924
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1925
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1926
3247
1927
if use_dbus:
3248
3249
@alternate_dbus_interfaces(
3250
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3251
class MandosDBusService(DBusObjectWithObjectManager):
1928
class MandosDBusService(dbus.service.Object):
3252
1929
"""A D-Bus proxy object"""
3253
3254
1930
def __init__(self):
3255
1931
dbus.service.Object.__init__(self, bus, "/")
3256
3257
_interface = "se.recompile.Mandos"
3258
1932
_interface = "se.bsnet.fukt.Mandos"
1933
3259
1934
@dbus.service.signal(_interface, signature="o")
3260
1935
def ClientAdded(self, objpath):
3261
1936
"D-Bus signal"
3262
1937
pass
3263
1938
3264
1939
@dbus.service.signal(_interface, signature="ss")
3265
1940
def ClientNotFound(self, fingerprint, address):
3266
1941
"D-Bus signal"
3267
1942
pass
3268
3269
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3270
"true"})
1943
3271
1944
@dbus.service.signal(_interface, signature="os")
3272
1945
def ClientRemoved(self, objpath, name):
3273
1946
"D-Bus signal"
3274
1947
pass
3275
3276
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3277
"true"})
1948
3278
1949
@dbus.service.method(_interface, out_signature="ao")
3279
1950
def GetAllClients(self):
3280
1951
"D-Bus method"
3281
return dbus.Array(c.dbus_object_path for c in
3282
tcp_server.clients.values())
3283
3284
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3285
"true"})
1952
return dbus.Array(c.dbus_object_path
1953
for c in tcp_server.clients)
1954
3286
1955
@dbus.service.method(_interface,
3287
1956
out_signature="a{oa{sv}}")
3288
1957
def GetAllClientsWithProperties(self):
3289
1958
"D-Bus method"
3290
1959
return dbus.Dictionary(
3291
{c.dbus_object_path: c.GetAll(
3292
"se.recompile.Mandos.Client")
3293
for c in tcp_server.clients.values()},
1960
((c.dbus_object_path, c.GetAll(""))
1961
for c in tcp_server.clients),
3294
1962
signature="oa{sv}")
3295
1963
3296
1964
@dbus.service.method(_interface, in_signature="o")
3297
1965
def RemoveClient(self, object_path):
3298
1966
"D-Bus method"
3299
for c in tcp_server.clients.values():
1967
for c in tcp_server.clients:
3300
1968
if c.dbus_object_path == object_path:
3301
del tcp_server.clients[c.name]
1969
tcp_server.clients.remove(c)
3302
1970
c.remove_from_connection()
3303
# Don't signal the disabling
1971
# Don't signal anything except ClientRemoved
3304
1972
c.disable(quiet=True)
3305
# Emit D-Bus signal for removal
3306
self.client_removed_signal(c)
1973
# Emit D-Bus signal
1974
self.ClientRemoved(object_path, c.name)
3307
1975
return
3308
1976
raise KeyError(object_path)
3309
1977
3310
1978
del _interface
3311
3312
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3313
out_signature="a{oa{sa{sv}}}")
3314
def GetManagedObjects(self):
3315
"""D-Bus method"""
3316
return dbus.Dictionary(
3317
{client.dbus_object_path:
3318
dbus.Dictionary(
3319
{interface: client.GetAll(interface)
3320
for interface in
3321
client._get_all_interface_names()})
3322
for client in tcp_server.clients.values()})
3323
3324
def client_added_signal(self, client):
3325
"""Send the new standard signal and the old signal"""
3326
if use_dbus:
3327
# New standard signal
3328
self.InterfacesAdded(
3329
client.dbus_object_path,
3330
dbus.Dictionary(
3331
{interface: client.GetAll(interface)
3332
for interface in
3333
client._get_all_interface_names()}))
3334
# Old signal
3335
self.ClientAdded(client.dbus_object_path)
3336
3337
def client_removed_signal(self, client):
3338
"""Send the new standard signal and the old signal"""
3339
if use_dbus:
3340
# New standard signal
3341
self.InterfacesRemoved(
3342
client.dbus_object_path,
3343
client._get_all_interface_names())
3344
# Old signal
3345
self.ClientRemoved(client.dbus_object_path,
3346
client.name)
3347
1979
3348
1980
mandos_dbus_service = MandosDBusService()
3349
3350
# Save modules to variables to exempt the modules from being
3351
# unloaded before the function registered with atexit() is run.
3352
mp = multiprocessing
3353
wn = wnull
3354
1981
3355
1982
def cleanup():
3356
1983
"Cleanup function; run on exit"
3357
if zeroconf:
3358
service.cleanup()
3359
3360
mp.active_children()
3361
wn.close()
3362
if not (tcp_server.clients or client_settings):
3363
return
3364
3365
# Store client before exiting. Secrets are encrypted with key
3366
# based on what config file has. If config file is
3367
# removed/edited, old secret will thus be unrecovable.
3368
clients = {}
3369
with PGPEngine() as pgp:
3370
for client in tcp_server.clients.values():
3371
key = client_settings[client.name]["secret"]
3372
client.encrypted_secret = pgp.encrypt(client.secret,
3373
key)
3374
client_dict = {}
3375
3376
# A list of attributes that can not be pickled
3377
# + secret.
3378
exclude = {"bus", "changedstate", "secret",
3379
"checker", "server_settings"}
3380
for name, typ in inspect.getmembers(dbus.service
3381
.Object):
3382
exclude.add(name)
3383
3384
client_dict["encrypted_secret"] = (client
3385
.encrypted_secret)
3386
for attr in client.client_structure:
3387
if attr not in exclude:
3388
client_dict[attr] = getattr(client, attr)
3389
3390
clients[client.name] = client_dict
3391
del client_settings[client.name]["secret"]
3392
3393
try:
3394
with tempfile.NamedTemporaryFile(
3395
mode='wb',
3396
suffix=".pickle",
3397
prefix='clients-',
3398
dir=os.path.dirname(stored_state_path),
3399
delete=False) as stored_state:
3400
pickle.dump((clients, client_settings), stored_state,
3401
protocol=2)
3402
tempname = stored_state.name
3403
os.rename(tempname, stored_state_path)
3404
except (IOError, OSError) as e:
3405
if not debug:
3406
try:
3407
os.remove(tempname)
3408
except NameError:
3409
pass
3410
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3411
logger.warning("Could not save persistent state: {}"
3412
.format(os.strerror(e.errno)))
3413
else:
3414
logger.warning("Could not save persistent state:",
3415
exc_info=e)
3416
raise
3417
3418
# Delete all clients, and settings from config
1984
service.cleanup()
1985
3419
1986
while tcp_server.clients:
3420
name, client = tcp_server.clients.popitem()
1987
client = tcp_server.clients.pop()
3421
1988
if use_dbus:
3422
1989
client.remove_from_connection()
3423
# Don't signal the disabling
1990
client.disable_hook = None
1991
# Don't signal anything except ClientRemoved
3424
1992
client.disable(quiet=True)
3425
# Emit D-Bus signal for removal
3426
1993
if use_dbus:
3427
mandos_dbus_service.client_removed_signal(client)
3428
client_settings.clear()
3429
1994
# Emit D-Bus signal
1995
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1996
client.name)
1997
3430
1998
atexit.register(cleanup)
3431
3432
for client in tcp_server.clients.values():
1999
2000
for client in tcp_server.clients:
3433
2001
if use_dbus:
3434
# Emit D-Bus signal for adding
3435
mandos_dbus_service.client_added_signal(client)
3436
# Need to initiate checking of clients
3437
if client.enabled:
3438
client.init_checker()
3439
2002
# Emit D-Bus signal
2003
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2004
client.enable()
2005
3440
2006
tcp_server.enable()
3441
2007
tcp_server.server_activate()
3442
2008
3443
2009
# Find out what port we got
3444
if zeroconf:
3445
service.port = tcp_server.socket.getsockname()[1]
2010
service.port = tcp_server.socket.getsockname()[1]
3446
2011
if use_ipv6:
3447
2012
logger.info("Now listening on address %r, port %d,"
3448
" flowinfo %d, scope_id %d",
3449
*tcp_server.socket.getsockname())
2013
" flowinfo %d, scope_id %d"
2014
% tcp_server.socket.getsockname())
3450
2015
else: # IPv4
3451
logger.info("Now listening on address %r, port %d",
3452
*tcp_server.socket.getsockname())
3453
3454
# service.interface = tcp_server.socket.getsockname()[3]
3455
2016
logger.info("Now listening on address %r, port %d"
2017
% tcp_server.socket.getsockname())
2018
2019
#service.interface = tcp_server.socket.getsockname()[3]
2020
3456
2021
try:
3457
if zeroconf:
3458
# From the Avahi example code
3459
try:
3460
service.activate()
3461
except dbus.exceptions.DBusException as error:
3462
logger.critical("D-Bus Exception", exc_info=error)
3463
cleanup()
3464
sys.exit(1)
3465
# End of Avahi example code
3466
3467
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3468
lambda *args, **kwargs:
3469
(tcp_server.handle_request
3470
(*args[2:], **kwargs) or True))
3471
2022
# From the Avahi example code
2023
try:
2024
service.activate()
2025
except dbus.exceptions.DBusException, error:
2026
logger.critical("DBusException: %s", error)
2027
cleanup()
2028
sys.exit(1)
2029
# End of Avahi example code
2030
2031
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2032
lambda *args, **kwargs:
2033
(tcp_server.handle_request
2034
(*args[2:], **kwargs) or True))
2035
3472
2036
logger.debug("Starting main loop")
3473
2037
main_loop.run()
3474
except AvahiError as error:
3475
logger.critical("Avahi Error", exc_info=error)
2038
except AvahiError, error:
2039
logger.critical("AvahiError: %s", error)
3476
2040
cleanup()
3477
2041
sys.exit(1)
3478
2042
except KeyboardInterrupt:
3483
2047
# Must run before the D-Bus bus name gets deregistered
3484
2048
cleanup()
3485
2049
3486
3487
2050
if __name__ == '__main__':
3488
2051
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0