80
101
except ImportError:
81
102
SO_BINDTODEVICE = None
86
logger = logging.Logger(u'mandos')
87
syslogger = (logging.handlers.SysLogHandler
88
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
89
address = "/dev/log"))
90
syslogger.setFormatter(logging.Formatter
91
(u'Mandos [%(process)d]: %(levelname)s:'
93
logger.addHandler(syslogger)
95
console = logging.StreamHandler()
96
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
99
logger.addHandler(console)
101
multiprocessing_manager = multiprocessing.Manager()
104
if sys.version_info.major == 2:
108
stored_state_file = "clients.pickle"
110
logger = logging.getLogger()
114
if_nametoindex = ctypes.cdll.LoadLibrary(
115
ctypes.util.find_library("c")).if_nametoindex
116
except (OSError, AttributeError):
118
def if_nametoindex(interface):
119
"Get an interface index the hard way, i.e. using fcntl()"
120
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
121
with contextlib.closing(socket.socket()) as s:
122
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
123
struct.pack(b"16s16x", interface))
124
interface_index = struct.unpack("I", ifreq[16:20])[0]
125
return interface_index
128
def initlogger(debug, level=logging.WARNING):
129
"""init logger and add loglevel"""
132
syslogger = (logging.handlers.SysLogHandler(
133
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
134
address = "/dev/log"))
135
syslogger.setFormatter(logging.Formatter
136
('Mandos [%(process)d]: %(levelname)s:'
138
logger.addHandler(syslogger)
141
console = logging.StreamHandler()
142
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
146
logger.addHandler(console)
147
logger.setLevel(level)
150
class PGPError(Exception):
151
"""Exception if encryption/decryption fails"""
155
class PGPEngine(object):
156
"""A simple class for OpenPGP symmetric encryption & decryption"""
159
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
160
self.gnupgargs = ['--batch',
161
'--home', self.tempdir,
169
def __exit__(self, exc_type, exc_value, traceback):
177
if self.tempdir is not None:
178
# Delete contents of tempdir
179
for root, dirs, files in os.walk(self.tempdir,
181
for filename in files:
182
os.remove(os.path.join(root, filename))
184
os.rmdir(os.path.join(root, dirname))
186
os.rmdir(self.tempdir)
189
def password_encode(self, password):
190
# Passphrase can not be empty and can not contain newlines or
191
# NUL bytes. So we prefix it and hex encode it.
192
encoded = b"mandos" + binascii.hexlify(password)
193
if len(encoded) > 2048:
194
# GnuPG can't handle long passwords, so encode differently
195
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
196
.replace(b"\n", b"\\n")
197
.replace(b"\0", b"\\x00"))
200
def encrypt(self, data, password):
201
passphrase = self.password_encode(password)
202
with tempfile.NamedTemporaryFile(
203
dir=self.tempdir) as passfile:
204
passfile.write(passphrase)
206
proc = subprocess.Popen(['gpg', '--symmetric',
210
stdin = subprocess.PIPE,
211
stdout = subprocess.PIPE,
212
stderr = subprocess.PIPE)
213
ciphertext, err = proc.communicate(input = data)
214
if proc.returncode != 0:
218
def decrypt(self, data, password):
219
passphrase = self.password_encode(password)
220
with tempfile.NamedTemporaryFile(
221
dir = self.tempdir) as passfile:
222
passfile.write(passphrase)
224
proc = subprocess.Popen(['gpg', '--decrypt',
228
stdin = subprocess.PIPE,
229
stdout = subprocess.PIPE,
230
stderr = subprocess.PIPE)
231
decrypted_plaintext, err = proc.communicate(input = data)
232
if proc.returncode != 0:
234
return decrypted_plaintext
103
237
class AvahiError(Exception):
104
238
def __init__(self, value, *args, **kwargs):
105
239
self.value = value
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
240
return super(AvahiError, self).__init__(value, *args,
110
244
class AvahiServiceError(AvahiError):
113
248
class AvahiGroupError(AvahiError):
193
352
dbus.UInt16(self.port),
194
353
avahi.string_array_to_txt_array(self.TXT))
195
354
self.group.Commit()
196
356
def entry_group_state_changed(self, state, error):
197
357
"""Derived from the Avahi example code"""
198
logger.debug(u"Avahi state change: %i", state)
358
logger.debug("Avahi entry group state change: %i", state)
200
360
if state == avahi.ENTRY_GROUP_ESTABLISHED:
201
logger.debug(u"Zeroconf service established.")
361
logger.debug("Zeroconf service established.")
202
362
elif state == avahi.ENTRY_GROUP_COLLISION:
203
logger.warning(u"Zeroconf service name collision.")
363
logger.info("Zeroconf service name collision.")
205
365
elif state == avahi.ENTRY_GROUP_FAILURE:
206
logger.critical(u"Avahi: Error in group state changed %s",
208
raise AvahiGroupError(u"State changed: %s"
366
logger.critical("Avahi: Error in group state changed %s",
368
raise AvahiGroupError("State changed: {!s}".format(error))
210
370
def cleanup(self):
211
371
"""Derived from the Avahi example code"""
212
372
if self.group is not None:
375
except (dbus.exceptions.UnknownMethodException,
376
dbus.exceptions.DBusException):
214
378
self.group = None
215
def server_state_changed(self, state):
381
def server_state_changed(self, state, error=None):
216
382
"""Derived from the Avahi example code"""
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
383
logger.debug("Avahi server state change: %i", state)
385
avahi.SERVER_INVALID: "Zeroconf server invalid",
386
avahi.SERVER_REGISTERING: None,
387
avahi.SERVER_COLLISION: "Zeroconf server name collision",
388
avahi.SERVER_FAILURE: "Zeroconf server failure",
390
if state in bad_states:
391
if bad_states[state] is not None:
393
logger.error(bad_states[state])
395
logger.error(bad_states[state] + ": %r", error)
220
397
elif state == avahi.SERVER_RUNNING:
400
except dbus.exceptions.DBusException as error:
401
if (error.get_dbus_name()
402
== "org.freedesktop.Avahi.CollisionError"):
403
logger.info("Local Zeroconf service name"
405
return self.rename(remove=False)
407
logger.critical("D-Bus Exception", exc_info=error)
412
logger.debug("Unknown state: %r", state)
414
logger.debug("Unknown state: %r: %r", state, error)
222
416
def activate(self):
223
417
"""Derived from the Avahi example code"""
224
418
if self.server is None:
225
419
self.server = dbus.Interface(
226
420
self.bus.get_object(avahi.DBUS_NAME,
227
avahi.DBUS_PATH_SERVER),
421
avahi.DBUS_PATH_SERVER,
422
follow_name_owner_changes=True),
228
423
avahi.DBUS_INTERFACE_SERVER)
229
self.server.connect_to_signal(u"StateChanged",
230
self.server_state_changed)
424
self.server.connect_to_signal("StateChanged",
425
self.server_state_changed)
231
426
self.server_state_changed(self.server.GetState())
235
# approved_by_default (Config option for each client)
236
# approved_delay (config option for each client)
237
# approved_duration (config option for each client)
429
class AvahiServiceToSyslog(AvahiService):
430
def rename(self, *args, **kwargs):
431
"""Add the new name to the syslog messages"""
432
ret = AvahiService.rename(self, *args, **kwargs)
433
syslogger.setFormatter(logging.Formatter(
434
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
438
def call_pipe(connection, # : multiprocessing.Connection
439
func, *args, **kwargs):
440
"""This function is meant to be called by multiprocessing.Process
442
This function runs func(*args, **kwargs), and writes the resulting
443
return value on the provided multiprocessing.Connection.
445
connection.send(func(*args, **kwargs))
238
448
class Client(object):
239
449
"""A representation of a client host served by this server.
242
name: string; from the config file, used in log messages and
452
approved: bool(); 'None' if not yet approved/disapproved
453
approval_delay: datetime.timedelta(); Time to wait for approval
454
approval_duration: datetime.timedelta(); Duration of one approval
455
checker: subprocess.Popen(); a running checker process used
456
to see if the client lives.
457
'None' if no process is running.
458
checker_callback_tag: a gobject event source tag, or None
459
checker_command: string; External command which is run to check
460
if client lives. %() expansions are done at
461
runtime with vars(self) as dict, so that for
462
instance %(name)s can be used in the command.
463
checker_initiator_tag: a gobject event source tag, or None
464
created: datetime.datetime(); (UTC) object creation
465
client_structure: Object describing what attributes a client has
466
and is used for storing the client at exit
467
current_checker_command: string; current running checker_command
468
disable_initiator_tag: a gobject event source tag, or None
244
470
fingerprint: string (40 or 32 hexadecimal digits); used to
245
471
uniquely identify the client
246
secret: bytestring; sent verbatim (over TLS) to client
247
472
host: string; available for use by the checker command
248
created: datetime.datetime(); (UTC) object creation
249
last_enabled: datetime.datetime(); (UTC)
473
interval: datetime.timedelta(); How often to start a new checker
474
last_approval_request: datetime.datetime(); (UTC) or None
251
475
last_checked_ok: datetime.datetime(); (UTC) or None
476
last_checker_status: integer between 0 and 255 reflecting exit
477
status of last checker. -1 reflects crashed
478
checker, -2 means no checker completed yet.
479
last_checker_signal: The signal which killed the last checker, if
480
last_checker_status is -1
481
last_enabled: datetime.datetime(); (UTC) or None
482
name: string; from the config file, used in log messages and
484
secret: bytestring; sent verbatim (over TLS) to client
252
485
timeout: datetime.timedelta(); How long from last_checked_ok
253
486
until this client is disabled
254
interval: datetime.timedelta(); How often to start a new checker
255
disable_hook: If set, called by disable() as disable_hook(self)
256
checker: subprocess.Popen(); a running checker process used
257
to see if the client lives.
258
'None' if no process is running.
259
checker_initiator_tag: a gobject event source tag, or None
260
disable_initiator_tag: - '' -
261
checker_callback_tag: - '' -
262
checker_command: string; External command which is run to check if
263
client lives. %() expansions are done at
264
runtime with vars(self) as dict, so that for
265
instance %(name)s can be used in the command.
266
current_checker_command: string; current running checker_command
267
approved_delay: datetime.timedelta(); Time to wait for approval
268
_approved: bool(); 'None' if not yet approved/disapproved
269
approved_duration: datetime.timedelta(); Duration of one approval
487
extended_timeout: extra long timeout when secret has been sent
488
runtime_expansions: Allowed attributes for runtime expansion.
489
expires: datetime.datetime(); time (UTC) when a client will be
491
server_settings: The server_settings dict from main()
494
runtime_expansions = ("approval_delay", "approval_duration",
495
"created", "enabled", "expires",
496
"fingerprint", "host", "interval",
497
"last_approval_request", "last_checked_ok",
498
"last_enabled", "name", "timeout")
501
"extended_timeout": "PT15M",
503
"checker": "fping -q -- %%(host)s",
505
"approval_delay": "PT0S",
506
"approval_duration": "PT1S",
507
"approved_by_default": "True",
273
def _timedelta_to_milliseconds(td):
274
"Convert a datetime.timedelta() to milliseconds"
275
return ((td.days * 24 * 60 * 60 * 1000)
276
+ (td.seconds * 1000)
277
+ (td.microseconds // 1000))
279
def timeout_milliseconds(self):
280
"Return the 'timeout' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.timeout)
283
def interval_milliseconds(self):
284
"Return the 'interval' attribute in milliseconds"
285
return self._timedelta_to_milliseconds(self.interval)
287
def approved_delay_milliseconds(self):
288
return self._timedelta_to_milliseconds(self.approved_delay)
290
def __init__(self, name = None, disable_hook=None, config=None):
291
"""Note: the 'checker' key in 'config' sets the
292
'checker_command' attribute and *not* the 'checker'
512
def config_parser(config):
513
"""Construct a new dict of client settings of this form:
514
{ client_name: {setting_name: value, ...}, ...}
515
with exceptions for any special settings as defined above.
516
NOTE: Must be a pure function. Must return the same result
517
value given the same arguments.
520
for client_name in config.sections():
521
section = dict(config.items(client_name))
522
client = settings[client_name] = {}
524
client["host"] = section["host"]
525
# Reformat values from string types to Python types
526
client["approved_by_default"] = config.getboolean(
527
client_name, "approved_by_default")
528
client["enabled"] = config.getboolean(client_name,
531
# Uppercase and remove spaces from fingerprint for later
532
# comparison purposes with return value from the
533
# fingerprint() function
534
client["fingerprint"] = (section["fingerprint"].upper()
536
if "secret" in section:
537
client["secret"] = section["secret"].decode("base64")
538
elif "secfile" in section:
539
with open(os.path.expanduser(os.path.expandvars
540
(section["secfile"])),
542
client["secret"] = secfile.read()
544
raise TypeError("No secret or secfile for section {}"
546
client["timeout"] = string_to_delta(section["timeout"])
547
client["extended_timeout"] = string_to_delta(
548
section["extended_timeout"])
549
client["interval"] = string_to_delta(section["interval"])
550
client["approval_delay"] = string_to_delta(
551
section["approval_delay"])
552
client["approval_duration"] = string_to_delta(
553
section["approval_duration"])
554
client["checker_command"] = section["checker"]
555
client["last_approval_request"] = None
556
client["last_checked_ok"] = None
557
client["last_checker_status"] = -2
561
def __init__(self, settings, name = None, server_settings=None):
297
logger.debug(u"Creating client %r", self.name)
298
# Uppercase and remove spaces from fingerprint for later
299
# comparison purposes with return value from the fingerprint()
301
self.fingerprint = (config[u"fingerprint"].upper()
303
logger.debug(u" Fingerprint: %s", self.fingerprint)
304
if u"secret" in config:
305
self.secret = config[u"secret"].decode(u"base64")
306
elif u"secfile" in config:
307
with open(os.path.expanduser(os.path.expandvars
308
(config[u"secfile"])),
310
self.secret = secfile.read()
563
if server_settings is None:
565
self.server_settings = server_settings
566
# adding all client settings
567
for setting, value in settings.items():
568
setattr(self, setting, value)
571
if not hasattr(self, "last_enabled"):
572
self.last_enabled = datetime.datetime.utcnow()
573
if not hasattr(self, "expires"):
574
self.expires = (datetime.datetime.utcnow()
312
#XXX Need to allow secret on demand!
313
raise TypeError(u"No secret or secfile for client %s"
315
self.host = config.get(u"host", u"")
316
self.created = datetime.datetime.utcnow()
318
self.last_enabled = None
319
self.last_checked_ok = None
320
self.timeout = string_to_delta(config[u"timeout"])
321
self.interval = string_to_delta(config[u"interval"])
322
self.disable_hook = disable_hook
577
self.last_enabled = None
580
logger.debug("Creating client %r", self.name)
581
logger.debug(" Fingerprint: %s", self.fingerprint)
582
self.created = settings.get("created",
583
datetime.datetime.utcnow())
585
# attributes specific for this server instance
323
586
self.checker = None
324
587
self.checker_initiator_tag = None
325
588
self.disable_initiator_tag = None
326
589
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
328
590
self.current_checker_command = None
329
self.last_connect = None
330
self._approved = None
331
self.approved_by_default = config.get(u"approved_by_default",
333
self.approved_delay = string_to_delta(
334
config[u"approved_delay"])
335
self.approved_duration = string_to_delta(
336
config[u"approved_duration"])
337
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
592
self.approvals_pending = 0
593
self.changedstate = multiprocessing_manager.Condition(
594
multiprocessing_manager.Lock())
595
self.client_structure = [attr
596
for attr in self.__dict__.iterkeys()
597
if not attr.startswith("_")]
598
self.client_structure.append("client_structure")
600
for name, t in inspect.getmembers(
601
type(self), lambda obj: isinstance(obj, property)):
602
if not name.startswith("_"):
603
self.client_structure.append(name)
605
# Send notice to process children that client state has changed
339
606
def send_changedstate(self):
340
self.changedstate.acquire()
341
self.changedstate.notify_all()
342
self.changedstate.release()
607
with self.changedstate:
608
self.changedstate.notify_all()
344
610
def enable(self):
345
611
"""Start this client's checker and timeout hooks"""
346
if getattr(self, u"enabled", False):
612
if getattr(self, "enabled", False):
347
613
# Already enabled
349
self.send_changedstate()
615
self.expires = datetime.datetime.utcnow() + self.timeout
350
617
self.last_enabled = datetime.datetime.utcnow()
351
# Schedule a new checker to be started an 'interval' from now,
352
# and every interval from then on.
353
self.checker_initiator_tag = (gobject.timeout_add
354
(self.interval_milliseconds(),
356
# Schedule a disable() when 'timeout' has passed
357
self.disable_initiator_tag = (gobject.timeout_add
358
(self.timeout_milliseconds(),
361
# Also start a new checker *right now*.
619
self.send_changedstate()
364
621
def disable(self, quiet=True):
365
622
"""Disable this client."""
366
623
if not getattr(self, "enabled", False):
626
logger.info("Disabling client %s", self.name)
627
if getattr(self, "disable_initiator_tag", None) is not None:
628
gobject.source_remove(self.disable_initiator_tag)
629
self.disable_initiator_tag = None
631
if getattr(self, "checker_initiator_tag", None) is not None:
632
gobject.source_remove(self.checker_initiator_tag)
633
self.checker_initiator_tag = None
369
637
self.send_changedstate()
371
logger.info(u"Disabling client %s", self.name)
372
if getattr(self, u"disable_initiator_tag", False):
373
gobject.source_remove(self.disable_initiator_tag)
374
self.disable_initiator_tag = None
375
if getattr(self, u"checker_initiator_tag", False):
376
gobject.source_remove(self.checker_initiator_tag)
377
self.checker_initiator_tag = None
379
if self.disable_hook:
380
self.disable_hook(self)
382
638
# Do not run this again if called by a gobject.timeout_add
385
641
def __del__(self):
386
self.disable_hook = None
389
def checker_callback(self, pid, condition, command):
644
def init_checker(self):
645
# Schedule a new checker to be started an 'interval' from now,
646
# and every interval from then on.
647
if self.checker_initiator_tag is not None:
648
gobject.source_remove(self.checker_initiator_tag)
649
self.checker_initiator_tag = gobject.timeout_add(
650
int(self.interval.total_seconds() * 1000),
652
# Schedule a disable() when 'timeout' has passed
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = gobject.timeout_add(
656
int(self.timeout.total_seconds() * 1000), self.disable)
657
# Also start a new checker *right now*.
660
def checker_callback(self, source, condition, connection,
390
662
"""The checker has completed, so take appropriate actions."""
391
663
self.checker_callback_tag = None
392
664
self.checker = None
393
if os.WIFEXITED(condition):
394
exitstatus = os.WEXITSTATUS(condition)
396
logger.info(u"Checker for %(name)s succeeded",
665
# Read return code from connection (see call_pipe)
666
returncode = connection.recv()
670
self.last_checker_status = returncode
671
self.last_checker_signal = None
672
if self.last_checker_status == 0:
673
logger.info("Checker for %(name)s succeeded",
398
675
self.checked_ok()
400
logger.info(u"Checker for %(name)s failed",
677
logger.info("Checker for %(name)s failed", vars(self))
403
logger.warning(u"Checker for %(name)s crashed?",
679
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
681
logger.warning("Checker for %(name)s crashed?",
406
685
def checked_ok(self):
407
"""Bump up the timeout for this client.
409
This should only be called when the client has been seen,
686
"""Assert that the client has been seen, alive and well."""
412
687
self.last_checked_ok = datetime.datetime.utcnow()
413
gobject.source_remove(self.disable_initiator_tag)
414
self.disable_initiator_tag = (gobject.timeout_add
415
(self.timeout_milliseconds(),
688
self.last_checker_status = 0
689
self.last_checker_signal = None
692
def bump_timeout(self, timeout=None):
693
"""Bump up the timeout for this client."""
695
timeout = self.timeout
696
if self.disable_initiator_tag is not None:
697
gobject.source_remove(self.disable_initiator_tag)
698
self.disable_initiator_tag = None
699
if getattr(self, "enabled", False):
700
self.disable_initiator_tag = gobject.timeout_add(
701
int(timeout.total_seconds() * 1000), self.disable)
702
self.expires = datetime.datetime.utcnow() + timeout
704
def need_approval(self):
705
self.last_approval_request = datetime.datetime.utcnow()
418
707
def start_checker(self):
419
708
"""Start a new checker subprocess if one is not running.
421
710
If a checker already exists, leave it running and do
423
712
# The reason for not killing a running checker is that if we
424
# did that, then if a checker (for some reason) started
425
# running slowly and taking more than 'interval' time, the
426
# client would inevitably timeout, since no checker would get
427
# a chance to run to completion. If we instead leave running
713
# did that, and if a checker (for some reason) started running
714
# slowly and taking more than 'interval' time, then the client
715
# would inevitably timeout, since no checker would get a
716
# chance to run to completion. If we instead leave running
428
717
# checkers alone, the checker would have to take more time
429
718
# than 'timeout' for the client to be disabled, which is as it
432
# If a checker exists, make sure it is not a zombie
434
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
435
except (AttributeError, OSError), error:
436
if (isinstance(error, OSError)
437
and error.errno != errno.ECHILD):
441
logger.warning(u"Checker was a zombie")
442
gobject.source_remove(self.checker_callback_tag)
443
self.checker_callback(pid, status,
444
self.current_checker_command)
721
if self.checker is not None and not self.checker.is_alive():
722
logger.warning("Checker was not alive; joining")
445
725
# Start a new checker if needed
446
726
if self.checker is None:
727
# Escape attributes for the shell
729
attr: re.escape(str(getattr(self, attr)))
730
for attr in self.runtime_expansions }
448
# In case checker_command has exactly one % operator
449
command = self.checker_command % self.host
451
# Escape attributes for the shell
452
escaped_attrs = dict((key,
453
re.escape(unicode(str(val),
457
vars(self).iteritems())
459
command = self.checker_command % escaped_attrs
460
except TypeError, error:
461
logger.error(u'Could not format string "%s":'
462
u' %s', self.checker_command, error)
463
return True # Try again later
732
command = self.checker_command % escaped_attrs
733
except TypeError as error:
734
logger.error('Could not format string "%s"',
735
self.checker_command,
737
return True # Try again later
464
738
self.current_checker_command = command
466
logger.info(u"Starting checker %r for %s",
468
# We don't need to redirect stdout and stderr, since
469
# in normal mode, that is already done by daemon(),
470
# and in debug mode we don't want to. (Stdin is
471
# always replaced by /dev/null.)
472
self.checker = subprocess.Popen(command,
474
shell=True, cwd=u"/")
475
self.checker_callback_tag = (gobject.child_watch_add
477
self.checker_callback,
479
# The checker may have completed before the gobject
480
# watch was added. Check for this.
481
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
483
gobject.source_remove(self.checker_callback_tag)
484
self.checker_callback(pid, status, command)
485
except OSError, error:
486
logger.error(u"Failed to start subprocess: %s",
739
logger.info("Starting checker %r for %s", command,
741
# We don't need to redirect stdout and stderr, since
742
# in normal mode, that is already done by daemon(),
743
# and in debug mode we don't want to. (Stdin is
744
# always replaced by /dev/null.)
745
# The exception is when not debugging but nevertheless
746
# running in the foreground; use the previously
748
popen_args = { "close_fds": True,
751
if (not self.server_settings["debug"]
752
and self.server_settings["foreground"]):
753
popen_args.update({"stdout": wnull,
755
pipe = multiprocessing.Pipe(duplex = False)
756
self.checker = multiprocessing.Process(
758
args = (pipe[1], subprocess.call, command),
761
self.checker_callback_tag = gobject.io_add_watch(
762
pipe[0].fileno(), gobject.IO_IN,
763
self.checker_callback, pipe[0], command)
488
764
# Re-run this periodically if run by gobject.timeout_add
558
872
class DBusObjectWithProperties(dbus.service.Object):
559
873
"""A D-Bus object with properties.
561
875
Classes inheriting from this can use the dbus_service_property
562
876
decorator to expose methods as D-Bus properties. It exposes the
563
877
standard Get(), Set(), and GetAll() methods on the D-Bus.
567
def _is_dbus_property(obj):
568
return getattr(obj, u"_dbus_is_property", False)
881
def _is_dbus_thing(thing):
882
"""Returns a function testing if an attribute is a D-Bus thing
884
If called like _is_dbus_thing("method") it returns a function
885
suitable for use as predicate to inspect.getmembers().
887
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
570
def _get_all_dbus_properties(self):
890
def _get_all_dbus_things(self, thing):
571
891
"""Returns a generator of (name, attribute) pairs
573
return ((prop._dbus_name, prop)
575
inspect.getmembers(self, self._is_dbus_property))
893
return ((getattr(athing.__get__(self), "_dbus_name", name),
894
athing.__get__(self))
895
for cls in self.__class__.__mro__
897
inspect.getmembers(cls, self._is_dbus_thing(thing)))
577
899
def _get_dbus_property(self, interface_name, property_name):
578
900
"""Returns a bound method if one exists which is a D-Bus
579
901
property with the specified name and interface.
581
for name in (property_name,
582
property_name + u"_dbus_property"):
583
prop = getattr(self, name, None)
585
or not self._is_dbus_property(prop)
586
or prop._dbus_name != property_name
587
or (interface_name and prop._dbus_interface
588
and interface_name != prop._dbus_interface)):
903
for cls in self.__class__.__mro__:
904
for name, value in inspect.getmembers(
905
cls, self._is_dbus_thing("property")):
906
if (value._dbus_name == property_name
907
and value._dbus_interface == interface_name):
908
return value.__get__(self)
591
910
# No such property
592
raise DBusPropertyNotFound(self.dbus_object_path + u":"
593
+ interface_name + u"."
911
raise DBusPropertyNotFound("{}:{}.{}".format(
912
self.dbus_object_path, interface_name, property_name))
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
914
@dbus.service.method(dbus.PROPERTIES_IFACE,
598
917
def Get(self, interface_name, property_name):
599
918
"""Standard D-Bus property Get() method, see D-Bus standard.
601
920
prop = self._get_dbus_property(interface_name, property_name)
602
if prop._dbus_access == u"write":
921
if prop._dbus_access == "write":
603
922
raise DBusPropertyAccessException(property_name)
605
if not hasattr(value, u"variant_level"):
924
if not hasattr(value, "variant_level"):
607
926
return type(value)(value, variant_level=value.variant_level+1)
609
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
928
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
610
929
def Set(self, interface_name, property_name, value):
611
930
"""Standard D-Bus property Set() method, see D-Bus standard.
613
932
prop = self._get_dbus_property(interface_name, property_name)
614
if prop._dbus_access == u"read":
933
if prop._dbus_access == "read":
615
934
raise DBusPropertyAccessException(property_name)
616
if prop._dbus_get_args_options[u"byte_arrays"]:
935
if prop._dbus_get_args_options["byte_arrays"]:
617
936
# The byte_arrays option is not supported yet on
618
937
# signatures other than "ay".
619
if prop._dbus_signature != u"ay":
621
value = dbus.ByteArray(''.join(unichr(byte)
938
if prop._dbus_signature != "ay":
939
raise ValueError("Byte arrays not supported for non-"
940
"'ay' signature {!r}"
941
.format(prop._dbus_signature))
942
value = dbus.ByteArray(b''.join(chr(byte)
625
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
626
out_signature=u"a{sv}")
946
@dbus.service.method(dbus.PROPERTIES_IFACE,
948
out_signature="a{sv}")
627
949
def GetAll(self, interface_name):
628
950
"""Standard D-Bus property GetAll() method, see D-Bus
631
953
Note: Will not include properties with access="write".
634
for name, prop in self._get_all_dbus_properties():
956
for name, prop in self._get_all_dbus_things("property"):
635
957
if (interface_name
636
958
and interface_name != prop._dbus_interface):
637
959
# Interface non-empty but did not match
639
961
# Ignore write-only properties
640
if prop._dbus_access == u"write":
962
if prop._dbus_access == "write":
643
if not hasattr(value, u"variant_level"):
965
if not hasattr(value, "variant_level"):
966
properties[name] = value
646
all[name] = type(value)(value, variant_level=
647
value.variant_level+1)
648
return dbus.Dictionary(all, signature=u"sv")
968
properties[name] = type(value)(
969
value, variant_level = value.variant_level + 1)
970
return dbus.Dictionary(properties, signature="sv")
972
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
973
def PropertiesChanged(self, interface_name, changed_properties,
974
invalidated_properties):
975
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
650
980
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
652
982
path_keyword='object_path',
653
983
connection_keyword='connection')
654
984
def Introspect(self, object_path, connection):
655
"""Standard D-Bus method, overloaded to insert property tags.
985
"""Overloading of standard D-Bus method.
987
Inserts property tags and interface annotation tags.
657
989
xmlstring = dbus.service.Object.Introspect(self, object_path,
660
992
document = xml.dom.minidom.parseString(xmlstring)
661
994
def make_tag(document, name, prop):
662
e = document.createElement(u"property")
663
e.setAttribute(u"name", name)
664
e.setAttribute(u"type", prop._dbus_signature)
665
e.setAttribute(u"access", prop._dbus_access)
995
e = document.createElement("property")
996
e.setAttribute("name", name)
997
e.setAttribute("type", prop._dbus_signature)
998
e.setAttribute("access", prop._dbus_access)
667
for if_tag in document.getElementsByTagName(u"interface"):
1001
for if_tag in document.getElementsByTagName("interface"):
668
1003
for tag in (make_tag(document, name, prop)
670
in self._get_all_dbus_properties()
1005
in self._get_all_dbus_things("property")
671
1006
if prop._dbus_interface
672
== if_tag.getAttribute(u"name")):
1007
== if_tag.getAttribute("name")):
673
1008
if_tag.appendChild(tag)
1009
# Add annotation tags
1010
for typ in ("method", "signal", "property"):
1011
for tag in if_tag.getElementsByTagName(typ):
1013
for name, prop in (self.
1014
_get_all_dbus_things(typ)):
1015
if (name == tag.getAttribute("name")
1016
and prop._dbus_interface
1017
== if_tag.getAttribute("name")):
1018
annots.update(getattr(
1019
prop, "_dbus_annotations", {}))
1020
for name, value in annots.items():
1021
ann_tag = document.createElement(
1023
ann_tag.setAttribute("name", name)
1024
ann_tag.setAttribute("value", value)
1025
tag.appendChild(ann_tag)
1026
# Add interface annotation tags
1027
for annotation, value in dict(
1028
itertools.chain.from_iterable(
1029
annotations().items()
1030
for name, annotations
1031
in self._get_all_dbus_things("interface")
1032
if name == if_tag.getAttribute("name")
1034
ann_tag = document.createElement("annotation")
1035
ann_tag.setAttribute("name", annotation)
1036
ann_tag.setAttribute("value", value)
1037
if_tag.appendChild(ann_tag)
674
1038
# Add the names to the return values for the
675
1039
# "org.freedesktop.DBus.Properties" methods
676
if (if_tag.getAttribute(u"name")
677
== u"org.freedesktop.DBus.Properties"):
678
for cn in if_tag.getElementsByTagName(u"method"):
679
if cn.getAttribute(u"name") == u"Get":
680
for arg in cn.getElementsByTagName(u"arg"):
681
if (arg.getAttribute(u"direction")
683
arg.setAttribute(u"name", u"value")
684
elif cn.getAttribute(u"name") == u"GetAll":
685
for arg in cn.getElementsByTagName(u"arg"):
686
if (arg.getAttribute(u"direction")
688
arg.setAttribute(u"name", u"props")
689
xmlstring = document.toxml(u"utf-8")
1040
if (if_tag.getAttribute("name")
1041
== "org.freedesktop.DBus.Properties"):
1042
for cn in if_tag.getElementsByTagName("method"):
1043
if cn.getAttribute("name") == "Get":
1044
for arg in cn.getElementsByTagName("arg"):
1045
if (arg.getAttribute("direction")
1047
arg.setAttribute("name", "value")
1048
elif cn.getAttribute("name") == "GetAll":
1049
for arg in cn.getElementsByTagName("arg"):
1050
if (arg.getAttribute("direction")
1052
arg.setAttribute("name", "props")
1053
xmlstring = document.toxml("utf-8")
690
1054
document.unlink()
691
1055
except (AttributeError, xml.dom.DOMException,
692
xml.parsers.expat.ExpatError), error:
693
logger.error(u"Failed to override Introspection method",
1056
xml.parsers.expat.ExpatError) as error:
1057
logger.error("Failed to override Introspection method",
695
1059
return xmlstring
1062
def datetime_to_dbus(dt, variant_level=0):
1063
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1065
return dbus.String("", variant_level = variant_level)
1066
return dbus.String(dt.isoformat(), variant_level=variant_level)
1069
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1070
"""A class decorator; applied to a subclass of
1071
dbus.service.Object, it will add alternate D-Bus attributes with
1072
interface names according to the "alt_interface_names" mapping.
1075
@alternate_dbus_interfaces({"org.example.Interface":
1076
"net.example.AlternateInterface"})
1077
class SampleDBusObject(dbus.service.Object):
1078
@dbus.service.method("org.example.Interface")
1079
def SampleDBusMethod():
1082
The above "SampleDBusMethod" on "SampleDBusObject" will be
1083
reachable via two interfaces: "org.example.Interface" and
1084
"net.example.AlternateInterface", the latter of which will have
1085
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1086
"true", unless "deprecate" is passed with a False value.
1088
This works for methods and signals, and also for D-Bus properties
1089
(from DBusObjectWithProperties) and interfaces (from the
1090
dbus_interface_annotations decorator).
1094
for orig_interface_name, alt_interface_name in (
1095
alt_interface_names.items()):
1097
interface_names = set()
1098
# Go though all attributes of the class
1099
for attrname, attribute in inspect.getmembers(cls):
1100
# Ignore non-D-Bus attributes, and D-Bus attributes
1101
# with the wrong interface name
1102
if (not hasattr(attribute, "_dbus_interface")
1103
or not attribute._dbus_interface.startswith(
1104
orig_interface_name)):
1106
# Create an alternate D-Bus interface name based on
1108
alt_interface = attribute._dbus_interface.replace(
1109
orig_interface_name, alt_interface_name)
1110
interface_names.add(alt_interface)
1111
# Is this a D-Bus signal?
1112
if getattr(attribute, "_dbus_is_signal", False):
1113
if sys.version_info.major == 2:
1114
# Extract the original non-method undecorated
1115
# function by black magic
1116
nonmethod_func = (dict(
1117
zip(attribute.func_code.co_freevars,
1118
attribute.__closure__))
1119
["func"].cell_contents)
1121
nonmethod_func = attribute
1122
# Create a new, but exactly alike, function
1123
# object, and decorate it to be a new D-Bus signal
1124
# with the alternate D-Bus interface name
1125
if sys.version_info.major == 2:
1126
new_function = types.FunctionType(
1127
nonmethod_func.func_code,
1128
nonmethod_func.func_globals,
1129
nonmethod_func.func_name,
1130
nonmethod_func.func_defaults,
1131
nonmethod_func.func_closure)
1133
new_function = types.FunctionType(
1134
nonmethod_func.__code__,
1135
nonmethod_func.__globals__,
1136
nonmethod_func.__name__,
1137
nonmethod_func.__defaults__,
1138
nonmethod_func.__closure__)
1139
new_function = (dbus.service.signal(
1141
attribute._dbus_signature)(new_function))
1142
# Copy annotations, if any
1144
new_function._dbus_annotations = dict(
1145
attribute._dbus_annotations)
1146
except AttributeError:
1148
# Define a creator of a function to call both the
1149
# original and alternate functions, so both the
1150
# original and alternate signals gets sent when
1151
# the function is called
1152
def fixscope(func1, func2):
1153
"""This function is a scope container to pass
1154
func1 and func2 to the "call_both" function
1155
outside of its arguments"""
1157
def call_both(*args, **kwargs):
1158
"""This function will emit two D-Bus
1159
signals by calling func1 and func2"""
1160
func1(*args, **kwargs)
1161
func2(*args, **kwargs)
1164
# Create the "call_both" function and add it to
1166
attr[attrname] = fixscope(attribute, new_function)
1167
# Is this a D-Bus method?
1168
elif getattr(attribute, "_dbus_is_method", False):
1169
# Create a new, but exactly alike, function
1170
# object. Decorate it to be a new D-Bus method
1171
# with the alternate D-Bus interface name. Add it
1174
dbus.service.method(
1176
attribute._dbus_in_signature,
1177
attribute._dbus_out_signature)
1178
(types.FunctionType(attribute.func_code,
1179
attribute.func_globals,
1180
attribute.func_name,
1181
attribute.func_defaults,
1182
attribute.func_closure)))
1183
# Copy annotations, if any
1185
attr[attrname]._dbus_annotations = dict(
1186
attribute._dbus_annotations)
1187
except AttributeError:
1189
# Is this a D-Bus property?
1190
elif getattr(attribute, "_dbus_is_property", False):
1191
# Create a new, but exactly alike, function
1192
# object, and decorate it to be a new D-Bus
1193
# property with the alternate D-Bus interface
1194
# name. Add it to the class.
1195
attr[attrname] = (dbus_service_property(
1196
alt_interface, attribute._dbus_signature,
1197
attribute._dbus_access,
1198
attribute._dbus_get_args_options
1200
(types.FunctionType(
1201
attribute.func_code,
1202
attribute.func_globals,
1203
attribute.func_name,
1204
attribute.func_defaults,
1205
attribute.func_closure)))
1206
# Copy annotations, if any
1208
attr[attrname]._dbus_annotations = dict(
1209
attribute._dbus_annotations)
1210
except AttributeError:
1212
# Is this a D-Bus interface?
1213
elif getattr(attribute, "_dbus_is_interface", False):
1214
# Create a new, but exactly alike, function
1215
# object. Decorate it to be a new D-Bus interface
1216
# with the alternate D-Bus interface name. Add it
1219
dbus_interface_annotations(alt_interface)
1220
(types.FunctionType(attribute.func_code,
1221
attribute.func_globals,
1222
attribute.func_name,
1223
attribute.func_defaults,
1224
attribute.func_closure)))
1226
# Deprecate all alternate interfaces
1227
iname="_AlternateDBusNames_interface_annotation{}"
1228
for interface_name in interface_names:
1230
@dbus_interface_annotations(interface_name)
1232
return { "org.freedesktop.DBus.Deprecated":
1234
# Find an unused name
1235
for aname in (iname.format(i)
1236
for i in itertools.count()):
1237
if aname not in attr:
1241
# Replace the class with a new subclass of it with
1242
# methods, signals, etc. as created above.
1243
cls = type(b"{}Alternate".format(cls.__name__),
1250
@alternate_dbus_interfaces({"se.recompile.Mandos":
1251
"se.bsnet.fukt.Mandos"})
698
1252
class ClientDBus(Client, DBusObjectWithProperties):
699
1253
"""A Client class using D-Bus
709
1269
Client.__init__(self, *args, **kwargs)
710
1270
# Only now, when this client is initialized, can it show up on
712
self.dbus_object_path = (dbus.ObjectPath
714
+ self.name.replace(u".", u"_")))
1272
client_object_name = str(self.name).translate(
1273
{ord("."): ord("_"),
1274
ord("-"): ord("_")})
1275
self.dbus_object_path = dbus.ObjectPath(
1276
"/clients/" + client_object_name)
715
1277
DBusObjectWithProperties.__init__(self, self.bus,
716
1278
self.dbus_object_path)
719
def _datetime_to_dbus(dt, variant_level=0):
720
"""Convert a UTC datetime.datetime() to a D-Bus type."""
721
return dbus.String(dt.isoformat(),
722
variant_level=variant_level)
725
oldstate = getattr(self, u"enabled", False)
726
r = Client.enable(self)
727
if oldstate != self.enabled:
729
self.PropertyChanged(dbus.String(u"enabled"),
730
dbus.Boolean(True, variant_level=1))
731
self.PropertyChanged(
732
dbus.String(u"last_enabled"),
733
self._datetime_to_dbus(self.last_enabled,
737
def disable(self, quiet = False):
738
oldstate = getattr(self, u"enabled", False)
739
r = Client.disable(self, quiet=quiet)
740
if not quiet and oldstate != self.enabled:
742
self.PropertyChanged(dbus.String(u"enabled"),
743
dbus.Boolean(False, variant_level=1))
1280
def notifychangeproperty(transform_func, dbus_name,
1281
type_func=lambda x: x,
1283
invalidate_only=False,
1284
_interface=_interface):
1285
""" Modify a variable so that it's a property which announces
1286
its changes to DBus.
1288
transform_fun: Function that takes a value and a variant_level
1289
and transforms it to a D-Bus type.
1290
dbus_name: D-Bus name of the variable
1291
type_func: Function that transform the value before sending it
1292
to the D-Bus. Default: no transform
1293
variant_level: D-Bus variant level. Default: 1
1295
attrname = "_{}".format(dbus_name)
1297
def setter(self, value):
1298
if hasattr(self, "dbus_object_path"):
1299
if (not hasattr(self, attrname) or
1300
type_func(getattr(self, attrname, None))
1301
!= type_func(value)):
1303
self.PropertiesChanged(
1304
_interface, dbus.Dictionary(),
1305
dbus.Array((dbus_name, )))
1307
dbus_value = transform_func(
1309
variant_level = variant_level)
1310
self.PropertyChanged(dbus.String(dbus_name),
1312
self.PropertiesChanged(
1314
dbus.Dictionary({ dbus.String(dbus_name):
1317
setattr(self, attrname, value)
1319
return property(lambda self: getattr(self, attrname), setter)
1321
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1322
approvals_pending = notifychangeproperty(dbus.Boolean,
1325
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1326
last_enabled = notifychangeproperty(datetime_to_dbus,
1328
checker = notifychangeproperty(
1329
dbus.Boolean, "CheckerRunning",
1330
type_func = lambda checker: checker is not None)
1331
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1333
last_checker_status = notifychangeproperty(dbus.Int16,
1334
"LastCheckerStatus")
1335
last_approval_request = notifychangeproperty(
1336
datetime_to_dbus, "LastApprovalRequest")
1337
approved_by_default = notifychangeproperty(dbus.Boolean,
1338
"ApprovedByDefault")
1339
approval_delay = notifychangeproperty(
1340
dbus.UInt64, "ApprovalDelay",
1341
type_func = lambda td: td.total_seconds() * 1000)
1342
approval_duration = notifychangeproperty(
1343
dbus.UInt64, "ApprovalDuration",
1344
type_func = lambda td: td.total_seconds() * 1000)
1345
host = notifychangeproperty(dbus.String, "Host")
1346
timeout = notifychangeproperty(
1347
dbus.UInt64, "Timeout",
1348
type_func = lambda td: td.total_seconds() * 1000)
1349
extended_timeout = notifychangeproperty(
1350
dbus.UInt64, "ExtendedTimeout",
1351
type_func = lambda td: td.total_seconds() * 1000)
1352
interval = notifychangeproperty(
1353
dbus.UInt64, "Interval",
1354
type_func = lambda td: td.total_seconds() * 1000)
1355
checker_command = notifychangeproperty(dbus.String, "Checker")
1356
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1357
invalidate_only=True)
1359
del notifychangeproperty
746
1361
def __del__(self, *args, **kwargs):
748
1363
self.remove_from_connection()
749
1364
except LookupError:
751
if hasattr(DBusObjectWithProperties, u"__del__"):
1366
if hasattr(DBusObjectWithProperties, "__del__"):
752
1367
DBusObjectWithProperties.__del__(self, *args, **kwargs)
753
1368
Client.__del__(self, *args, **kwargs)
755
def checker_callback(self, pid, condition, command,
757
self.checker_callback_tag = None
760
self.PropertyChanged(dbus.String(u"checker_running"),
761
dbus.Boolean(False, variant_level=1))
762
if os.WIFEXITED(condition):
763
exitstatus = os.WEXITSTATUS(condition)
1370
def checker_callback(self, source, condition,
1371
connection, command, *args, **kwargs):
1372
ret = Client.checker_callback(self, source, condition,
1373
connection, command, *args,
1375
exitstatus = self.last_checker_status
764
1377
# Emit D-Bus signal
765
1378
self.CheckerCompleted(dbus.Int16(exitstatus),
766
dbus.Int64(condition),
767
1380
dbus.String(command))
769
1382
# Emit D-Bus signal
770
1383
self.CheckerCompleted(dbus.Int16(-1),
771
dbus.Int64(condition),
1385
self.last_checker_signal),
772
1386
dbus.String(command))
774
return Client.checker_callback(self, pid, condition, command,
777
def checked_ok(self, *args, **kwargs):
778
r = Client.checked_ok(self, *args, **kwargs)
780
self.PropertyChanged(
781
dbus.String(u"last_checked_ok"),
782
(self._datetime_to_dbus(self.last_checked_ok,
786
1389
def start_checker(self, *args, **kwargs):
787
old_checker = self.checker
788
if self.checker is not None:
789
old_checker_pid = self.checker.pid
791
old_checker_pid = None
1390
old_checker_pid = getattr(self.checker, "pid", None)
792
1391
r = Client.start_checker(self, *args, **kwargs)
793
1392
# Only if new checker process was started
794
1393
if (self.checker is not None
795
1394
and old_checker_pid != self.checker.pid):
796
1395
# Emit D-Bus signal
797
1396
self.CheckerStarted(self.current_checker_command)
798
self.PropertyChanged(
799
dbus.String(u"checker_running"),
800
dbus.Boolean(True, variant_level=1))
803
def stop_checker(self, *args, **kwargs):
804
old_checker = getattr(self, u"checker", None)
805
r = Client.stop_checker(self, *args, **kwargs)
806
if (old_checker is not None
807
and getattr(self, u"checker", None) is None):
808
self.PropertyChanged(dbus.String(u"checker_running"),
809
dbus.Boolean(False, variant_level=1))
812
1399
def _reset_approved(self):
813
self._approved = None
1400
self.approved = None
816
1403
def approve(self, value=True):
817
self._approved = value
818
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
1404
self.approved = value
1405
gobject.timeout_add(int(self.approval_duration.total_seconds()
1406
* 1000), self._reset_approved)
1407
self.send_changedstate()
820
1409
## D-Bus methods, signals & properties
821
_interface = u"se.bsnet.fukt.Mandos.Client"
825
1415
# CheckerCompleted - signal
826
@dbus.service.signal(_interface, signature=u"nxs")
1416
@dbus.service.signal(_interface, signature="nxs")
827
1417
def CheckerCompleted(self, exitcode, waitstatus, command):
831
1421
# CheckerStarted - signal
832
@dbus.service.signal(_interface, signature=u"s")
1422
@dbus.service.signal(_interface, signature="s")
833
1423
def CheckerStarted(self, command):
837
1427
# PropertyChanged - signal
838
@dbus.service.signal(_interface, signature=u"sv")
1428
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1429
@dbus.service.signal(_interface, signature="sv")
839
1430
def PropertyChanged(self, property, value):
944
# last_checked_ok - property
945
@dbus_service_property(_interface, signature=u"s",
947
def last_checked_ok_dbus_property(self, value=None):
1567
# LastCheckedOK - property
1568
@dbus_service_property(_interface,
1571
def LastCheckedOK_dbus_property(self, value=None):
948
1572
if value is not None:
949
1573
self.checked_ok()
951
if self.last_checked_ok is None:
952
return dbus.String(u"")
953
return dbus.String(self._datetime_to_dbus(self
957
@dbus_service_property(_interface, signature=u"t",
959
def timeout_dbus_property(self, value=None):
1575
return datetime_to_dbus(self.last_checked_ok)
1577
# LastCheckerStatus - property
1578
@dbus_service_property(_interface, signature="n", access="read")
1579
def LastCheckerStatus_dbus_property(self):
1580
return dbus.Int16(self.last_checker_status)
1582
# Expires - property
1583
@dbus_service_property(_interface, signature="s", access="read")
1584
def Expires_dbus_property(self):
1585
return datetime_to_dbus(self.expires)
1587
# LastApprovalRequest - property
1588
@dbus_service_property(_interface, signature="s", access="read")
1589
def LastApprovalRequest_dbus_property(self):
1590
return datetime_to_dbus(self.last_approval_request)
1592
# Timeout - property
1593
@dbus_service_property(_interface,
1596
def Timeout_dbus_property(self, value=None):
960
1597
if value is None: # get
961
return dbus.UInt64(self.timeout_milliseconds())
1598
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1599
old_timeout = self.timeout
962
1600
self.timeout = datetime.timedelta(0, 0, 0, value)
964
self.PropertyChanged(dbus.String(u"timeout"),
965
dbus.UInt64(value, variant_level=1))
966
if getattr(self, u"disable_initiator_tag", None) is None:
969
gobject.source_remove(self.disable_initiator_tag)
970
self.disable_initiator_tag = None
972
_timedelta_to_milliseconds((self
978
# The timeout has passed
981
self.disable_initiator_tag = (gobject.timeout_add
982
(time_to_die, self.disable))
984
# interval - property
985
@dbus_service_property(_interface, signature=u"t",
987
def interval_dbus_property(self, value=None):
988
if value is None: # get
989
return dbus.UInt64(self.interval_milliseconds())
1601
# Reschedule disabling
1603
now = datetime.datetime.utcnow()
1604
self.expires += self.timeout - old_timeout
1605
if self.expires <= now:
1606
# The timeout has passed
1609
if (getattr(self, "disable_initiator_tag", None)
1612
gobject.source_remove(self.disable_initiator_tag)
1613
self.disable_initiator_tag = gobject.timeout_add(
1614
int((self.expires - now).total_seconds() * 1000),
1617
# ExtendedTimeout - property
1618
@dbus_service_property(_interface,
1621
def ExtendedTimeout_dbus_property(self, value=None):
1622
if value is None: # get
1623
return dbus.UInt64(self.extended_timeout.total_seconds()
1625
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1627
# Interval - property
1628
@dbus_service_property(_interface,
1631
def Interval_dbus_property(self, value=None):
1632
if value is None: # get
1633
return dbus.UInt64(self.interval.total_seconds() * 1000)
990
1634
self.interval = datetime.timedelta(0, 0, 0, value)
992
self.PropertyChanged(dbus.String(u"interval"),
993
dbus.UInt64(value, variant_level=1))
994
if getattr(self, u"checker_initiator_tag", None) is None:
1635
if getattr(self, "checker_initiator_tag", None) is None:
996
# Reschedule checker run
997
gobject.source_remove(self.checker_initiator_tag)
998
self.checker_initiator_tag = (gobject.timeout_add
999
(value, self.start_checker))
1000
self.start_checker() # Start one now, too
1002
# checker - property
1003
@dbus_service_property(_interface, signature=u"s",
1004
access=u"readwrite")
1005
def checker_dbus_property(self, value=None):
1638
# Reschedule checker run
1639
gobject.source_remove(self.checker_initiator_tag)
1640
self.checker_initiator_tag = gobject.timeout_add(
1641
value, self.start_checker)
1642
self.start_checker() # Start one now, too
1644
# Checker - property
1645
@dbus_service_property(_interface,
1648
def Checker_dbus_property(self, value=None):
1006
1649
if value is None: # get
1007
1650
return dbus.String(self.checker_command)
1008
self.checker_command = value
1010
self.PropertyChanged(dbus.String(u"checker"),
1011
dbus.String(self.checker_command,
1651
self.checker_command = str(value)
1014
# checker_running - property
1015
@dbus_service_property(_interface, signature=u"b",
1016
access=u"readwrite")
1017
def checker_running_dbus_property(self, value=None):
1653
# CheckerRunning - property
1654
@dbus_service_property(_interface,
1657
def CheckerRunning_dbus_property(self, value=None):
1018
1658
if value is None: # get
1019
1659
return dbus.Boolean(self.checker is not None)
1071
1715
def handle(self):
1072
1716
with contextlib.closing(self.server.child_pipe) as child_pipe:
1073
logger.info(u"TCP connection from: %s",
1074
unicode(self.client_address))
1075
logger.debug(u"Pipe FD: %d",
1717
logger.info("TCP connection from: %s",
1718
str(self.client_address))
1719
logger.debug("Pipe FD: %d",
1076
1720
self.server.child_pipe.fileno())
1078
session = (gnutls.connection
1079
.ClientSession(self.request,
1081
.X509Credentials()))
1722
session = gnutls.connection.ClientSession(
1723
self.request, gnutls.connection .X509Credentials())
1083
1725
# Note: gnutls.connection.X509Credentials is really a
1084
1726
# generic GnuTLS certificate credentials object so long as
1085
1727
# no X.509 keys are added to it. Therefore, we can use it
1086
1728
# here despite using OpenPGP certificates.
1088
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1089
# u"+AES-256-CBC", u"+SHA1",
1090
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1730
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1731
# "+AES-256-CBC", "+SHA1",
1732
# "+COMP-NULL", "+CTYPE-OPENPGP",
1092
1734
# Use a fallback default, since this MUST be set.
1093
1735
priority = self.server.gnutls_priority
1094
1736
if priority is None:
1095
priority = u"NORMAL"
1096
(gnutls.library.functions
1097
.gnutls_priority_set_direct(session._c_object,
1738
gnutls.library.functions.gnutls_priority_set_direct(
1739
session._c_object, priority, None)
1100
1741
# Start communication using the Mandos protocol
1101
1742
# Get protocol number
1102
1743
line = self.request.makefile().readline()
1103
logger.debug(u"Protocol version: %r", line)
1744
logger.debug("Protocol version: %r", line)
1105
1746
if int(line.strip().split()[0]) > 1:
1107
except (ValueError, IndexError, RuntimeError), error:
1108
logger.error(u"Unknown protocol version: %s", error)
1747
raise RuntimeError(line)
1748
except (ValueError, IndexError, RuntimeError) as error:
1749
logger.error("Unknown protocol version: %s", error)
1111
1752
# Start GnuTLS connection
1113
1754
session.handshake()
1114
except gnutls.errors.GNUTLSError, error:
1115
logger.warning(u"Handshake failed: %s", error)
1755
except gnutls.errors.GNUTLSError as error:
1756
logger.warning("Handshake failed: %s", error)
1116
1757
# Do not run session.bye() here: the session is not
1117
1758
# established. Just abandon the request.
1119
logger.debug(u"Handshake succeeded")
1760
logger.debug("Handshake succeeded")
1762
approval_required = False
1122
fpr = self.fingerprint(self.peer_certificate
1124
except (TypeError, gnutls.errors.GNUTLSError), error:
1125
logger.warning(u"Bad certificate: %s", error)
1765
fpr = self.fingerprint(
1766
self.peer_certificate(session))
1768
gnutls.errors.GNUTLSError) as error:
1769
logger.warning("Bad certificate: %s", error)
1127
logger.debug(u"Fingerprint: %s", fpr)
1771
logger.debug("Fingerprint: %s", fpr)
1130
1774
client = ProxyClient(child_pipe, fpr,
1131
1775
self.client_address)
1132
1776
except KeyError:
1135
delay = client.approved_delay
1779
if client.approval_delay:
1780
delay = client.approval_delay
1781
client.approvals_pending += 1
1782
approval_required = True
1137
1785
if not client.enabled:
1138
logger.warning(u"Client %s is disabled",
1786
logger.info("Client %s is disabled",
1140
1788
if self.server.use_dbus:
1141
1789
# Emit D-Bus signal
1142
client.Rejected("Disabled")
1790
client.Rejected("Disabled")
1144
if client._approved is None:
1145
logger.info(u"Client %s need approval",
1793
if client.approved or not client.approval_delay:
1794
#We are approved or approval is disabled
1796
elif client.approved is None:
1797
logger.info("Client %s needs approval",
1147
1799
if self.server.use_dbus:
1148
1800
# Emit D-Bus signal
1149
1801
client.NeedApproval(
1150
client.approved_delay_milliseconds(),
1151
client.approved_by_default)
1152
elif client._approved:
1153
#We have a password and are approved
1802
client.approval_delay.total_seconds()
1803
* 1000, client.approved_by_default)
1156
logger.warning(u"Client %s was not approved",
1805
logger.warning("Client %s was not approved",
1158
1807
if self.server.use_dbus:
1160
client.Rejected("Disapproved")
1809
client.Rejected("Denied")
1163
1812
#wait until timeout or approved
1164
#x = float(client._timedelta_to_milliseconds(delay))
1165
1813
time = datetime.datetime.now()
1166
1814
client.changedstate.acquire()
1167
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1815
client.changedstate.wait(delay.total_seconds())
1168
1816
client.changedstate.release()
1169
1817
time2 = datetime.datetime.now()
1170
1818
if (time2 - time) >= delay:
1225
1883
def fingerprint(openpgp):
1226
1884
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1227
1885
# New GnuTLS "datum" with the OpenPGP public key
1228
datum = (gnutls.library.types
1229
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1232
ctypes.c_uint(len(openpgp))))
1886
datum = gnutls.library.types.gnutls_datum_t(
1887
ctypes.cast(ctypes.c_char_p(openpgp),
1888
ctypes.POINTER(ctypes.c_ubyte)),
1889
ctypes.c_uint(len(openpgp)))
1233
1890
# New empty GnuTLS certificate
1234
1891
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1235
(gnutls.library.functions
1236
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1892
gnutls.library.functions.gnutls_openpgp_crt_init(
1237
1894
# Import the OpenPGP public key into the certificate
1238
(gnutls.library.functions
1239
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1240
gnutls.library.constants
1241
.GNUTLS_OPENPGP_FMT_RAW))
1895
gnutls.library.functions.gnutls_openpgp_crt_import(
1896
crt, ctypes.byref(datum),
1897
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1242
1898
# Verify the self signature in the key
1243
1899
crtverify = ctypes.c_uint()
1244
(gnutls.library.functions
1245
.gnutls_openpgp_crt_verify_self(crt, 0,
1246
ctypes.byref(crtverify)))
1900
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1901
crt, 0, ctypes.byref(crtverify))
1247
1902
if crtverify.value != 0:
1248
1903
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1249
raise (gnutls.errors.CertificateSecurityError
1904
raise gnutls.errors.CertificateSecurityError(
1251
1906
# New buffer for the fingerprint
1252
1907
buf = ctypes.create_string_buffer(20)
1253
1908
buf_len = ctypes.c_size_t()
1254
1909
# Get the fingerprint from the certificate into the buffer
1255
(gnutls.library.functions
1256
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1257
ctypes.byref(buf_len)))
1910
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1911
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1258
1912
# Deinit the certificate
1259
1913
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1260
1914
# Convert the buffer to a Python bytestring
1261
1915
fpr = ctypes.string_at(buf, buf_len.value)
1262
1916
# Convert the bytestring to hexadecimal notation
1263
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1917
hex_fpr = binascii.hexlify(fpr).upper()
1267
1921
class MultiprocessingMixIn(object):
1268
1922
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1269
1924
def sub_process_main(self, request, address):
1271
1926
self.finish_request(request, address)
1273
1928
self.handle_error(request, address)
1274
1929
self.close_request(request)
1276
1931
def process_request(self, request, address):
1277
1932
"""Start a new process to process the request."""
1278
multiprocessing.Process(target = self.sub_process_main,
1279
args = (request, address)).start()
1933
proc = multiprocessing.Process(target = self.sub_process_main,
1934
args = (request, address))
1281
1939
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1282
1940
""" adds a pipe to the MixIn """
1283
1942
def process_request(self, request, client_address):
1284
1943
"""Overrides and wraps the original process_request().
1286
1945
This function creates a new pipe in self.pipe
1288
1947
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1290
super(MultiprocessingMixInWithPipe,
1291
self).process_request(request, client_address)
1292
self.add_pipe(parent_pipe)
1293
def add_pipe(self, parent_pipe):
1949
proc = MultiprocessingMixIn.process_request(self, request,
1951
self.child_pipe.close()
1952
self.add_pipe(parent_pipe, proc)
1954
def add_pipe(self, parent_pipe, proc):
1294
1955
"""Dummy function; override as necessary"""
1956
raise NotImplementedError()
1297
1959
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1298
1960
socketserver.TCPServer, object):
1419
2116
fpr = request[1]
1420
2117
address = request[2]
1422
for c in self.clients:
2119
for c in self.clients.itervalues():
1423
2120
if c.fingerprint == fpr:
1427
logger.warning(u"Client not found for fingerprint: %s, ad"
1428
u"dress: %s", fpr, address)
2124
logger.info("Client not found for fingerprint: %s, ad"
2125
"dress: %s", fpr, address)
1429
2126
if self.use_dbus:
1430
2127
# Emit D-Bus signal
1431
mandos_dbus_service.ClientNotFound(fpr, address)
2128
mandos_dbus_service.ClientNotFound(fpr,
1432
2130
parent_pipe.send(False)
1435
gobject.io_add_watch(parent_pipe.fileno(),
1436
gobject.IO_IN | gobject.IO_HUP,
1437
functools.partial(self.handle_ipc,
1438
parent_pipe = parent_pipe,
1439
client_object = client))
2133
gobject.io_add_watch(
2134
parent_pipe.fileno(),
2135
gobject.IO_IN | gobject.IO_HUP,
2136
functools.partial(self.handle_ipc,
2137
parent_pipe = parent_pipe,
2139
client_object = client))
1440
2140
parent_pipe.send(True)
1441
# remove the old hook in favor of the new above hook on same fileno
2141
# remove the old hook in favor of the new above hook on
1443
2144
if command == 'funcall':
1444
2145
funcname = request[1]
1445
2146
args = request[2]
1446
2147
kwargs = request[3]
1448
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2149
parent_pipe.send(('data', getattr(client_object,
1450
2153
if command == 'getattr':
1451
2154
attrname = request[1]
1452
if callable(client_object.__getattribute__(attrname)):
1453
parent_pipe.send(('function',))
2155
if isinstance(client_object.__getattribute__(attrname),
2156
collections.Callable):
2157
parent_pipe.send(('function', ))
1455
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2160
'data', client_object.__getattribute__(attrname)))
1457
2162
if command == 'setattr':
1458
2163
attrname = request[1]
1459
2164
value = request[2]
1460
2165
setattr(client_object, attrname, value)
2170
def rfc3339_duration_to_delta(duration):
2171
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2173
>>> rfc3339_duration_to_delta("P7D")
2174
datetime.timedelta(7)
2175
>>> rfc3339_duration_to_delta("PT60S")
2176
datetime.timedelta(0, 60)
2177
>>> rfc3339_duration_to_delta("PT60M")
2178
datetime.timedelta(0, 3600)
2179
>>> rfc3339_duration_to_delta("PT24H")
2180
datetime.timedelta(1)
2181
>>> rfc3339_duration_to_delta("P1W")
2182
datetime.timedelta(7)
2183
>>> rfc3339_duration_to_delta("PT5M30S")
2184
datetime.timedelta(0, 330)
2185
>>> rfc3339_duration_to_delta("P1DT3M20S")
2186
datetime.timedelta(1, 200)
2189
# Parsing an RFC 3339 duration with regular expressions is not
2190
# possible - there would have to be multiple places for the same
2191
# values, like seconds. The current code, while more esoteric, is
2192
# cleaner without depending on a parsing library. If Python had a
2193
# built-in library for parsing we would use it, but we'd like to
2194
# avoid excessive use of external libraries.
2196
# New type for defining tokens, syntax, and semantics all-in-one
2197
Token = collections.namedtuple("Token", (
2198
"regexp", # To match token; if "value" is not None, must have
2199
# a "group" containing digits
2200
"value", # datetime.timedelta or None
2201
"followers")) # Tokens valid after this token
2202
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2203
# the "duration" ABNF definition in RFC 3339, Appendix A.
2204
token_end = Token(re.compile(r"$"), None, frozenset())
2205
token_second = Token(re.compile(r"(\d+)S"),
2206
datetime.timedelta(seconds=1),
2207
frozenset((token_end, )))
2208
token_minute = Token(re.compile(r"(\d+)M"),
2209
datetime.timedelta(minutes=1),
2210
frozenset((token_second, token_end)))
2211
token_hour = Token(re.compile(r"(\d+)H"),
2212
datetime.timedelta(hours=1),
2213
frozenset((token_minute, token_end)))
2214
token_time = Token(re.compile(r"T"),
2216
frozenset((token_hour, token_minute,
2218
token_day = Token(re.compile(r"(\d+)D"),
2219
datetime.timedelta(days=1),
2220
frozenset((token_time, token_end)))
2221
token_month = Token(re.compile(r"(\d+)M"),
2222
datetime.timedelta(weeks=4),
2223
frozenset((token_day, token_end)))
2224
token_year = Token(re.compile(r"(\d+)Y"),
2225
datetime.timedelta(weeks=52),
2226
frozenset((token_month, token_end)))
2227
token_week = Token(re.compile(r"(\d+)W"),
2228
datetime.timedelta(weeks=1),
2229
frozenset((token_end, )))
2230
token_duration = Token(re.compile(r"P"), None,
2231
frozenset((token_year, token_month,
2232
token_day, token_time,
2234
# Define starting values
2235
value = datetime.timedelta() # Value so far
2237
followers = frozenset((token_duration, )) # Following valid tokens
2238
s = duration # String left to parse
2239
# Loop until end token is found
2240
while found_token is not token_end:
2241
# Search for any currently valid tokens
2242
for token in followers:
2243
match = token.regexp.match(s)
2244
if match is not None:
2246
if token.value is not None:
2247
# Value found, parse digits
2248
factor = int(match.group(1), 10)
2249
# Add to value so far
2250
value += factor * token.value
2251
# Strip token from string
2252
s = token.regexp.sub("", s, 1)
2255
# Set valid next tokens
2256
followers = found_token.followers
2259
# No currently valid tokens were found
2260
raise ValueError("Invalid RFC 3339 duration: {!r}"
1465
2266
def string_to_delta(interval):
1466
2267
"""Parse a string and return a datetime.timedelta
1468
>>> string_to_delta(u'7d')
2269
>>> string_to_delta('7d')
1469
2270
datetime.timedelta(7)
1470
>>> string_to_delta(u'60s')
2271
>>> string_to_delta('60s')
1471
2272
datetime.timedelta(0, 60)
1472
>>> string_to_delta(u'60m')
2273
>>> string_to_delta('60m')
1473
2274
datetime.timedelta(0, 3600)
1474
>>> string_to_delta(u'24h')
2275
>>> string_to_delta('24h')
1475
2276
datetime.timedelta(1)
1476
>>> string_to_delta(u'1w')
2277
>>> string_to_delta('1w')
1477
2278
datetime.timedelta(7)
1478
>>> string_to_delta(u'5m 30s')
2279
>>> string_to_delta('5m 30s')
1479
2280
datetime.timedelta(0, 330)
2284
return rfc3339_duration_to_delta(interval)
1481
2288
timevalue = datetime.timedelta(0)
1482
2289
for s in interval.split():
1484
suffix = unicode(s[-1])
1485
2292
value = int(s[:-1])
1487
2294
delta = datetime.timedelta(value)
1488
elif suffix == u"s":
1489
2296
delta = datetime.timedelta(0, value)
1490
elif suffix == u"m":
1491
2298
delta = datetime.timedelta(0, 0, 0, 0, value)
1492
elif suffix == u"h":
1493
2300
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1494
elif suffix == u"w":
1495
2302
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1497
raise ValueError(u"Unknown suffix %r" % suffix)
1498
except (ValueError, IndexError), e:
1499
raise ValueError(e.message)
2304
raise ValueError("Unknown suffix {!r}".format(suffix))
2305
except IndexError as e:
2306
raise ValueError(*(e.args))
1500
2307
timevalue += delta
1501
2308
return timevalue
1504
def if_nametoindex(interface):
1505
"""Call the C function if_nametoindex(), or equivalent
1507
Note: This function cannot accept a unicode string."""
1508
global if_nametoindex
1510
if_nametoindex = (ctypes.cdll.LoadLibrary
1511
(ctypes.util.find_library(u"c"))
1513
except (OSError, AttributeError):
1514
logger.warning(u"Doing if_nametoindex the hard way")
1515
def if_nametoindex(interface):
1516
"Get an interface index the hard way, i.e. using fcntl()"
1517
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1518
with contextlib.closing(socket.socket()) as s:
1519
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1520
struct.pack(str(u"16s16x"),
1522
interface_index = struct.unpack(str(u"I"),
1524
return interface_index
1525
return if_nametoindex(interface)
1528
2311
def daemon(nochdir = False, noclose = False):
1529
2312
"""See daemon(3). Standard BSD Unix function.
1555
2338
##################################################################
1556
2339
# Parsing of options, both command line and config file
1558
parser = optparse.OptionParser(version = "%%prog %s" % version)
1559
parser.add_option("-i", u"--interface", type=u"string",
1560
metavar="IF", help=u"Bind to interface IF")
1561
parser.add_option("-a", u"--address", type=u"string",
1562
help=u"Address to listen for requests on")
1563
parser.add_option("-p", u"--port", type=u"int",
1564
help=u"Port number to receive requests on")
1565
parser.add_option("--check", action=u"store_true",
1566
help=u"Run self-test")
1567
parser.add_option("--debug", action=u"store_true",
1568
help=u"Debug mode; run in foreground and log to"
1570
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1571
u" priority string (see GnuTLS documentation)")
1572
parser.add_option("--servicename", type=u"string",
1573
metavar=u"NAME", help=u"Zeroconf service name")
1574
parser.add_option("--configdir", type=u"string",
1575
default=u"/etc/mandos", metavar=u"DIR",
1576
help=u"Directory to search for configuration"
1578
parser.add_option("--no-dbus", action=u"store_false",
1579
dest=u"use_dbus", help=u"Do not provide D-Bus"
1580
u" system bus interface")
1581
parser.add_option("--no-ipv6", action=u"store_false",
1582
dest=u"use_ipv6", help=u"Do not use IPv6")
1583
options = parser.parse_args()[0]
2341
parser = argparse.ArgumentParser()
2342
parser.add_argument("-v", "--version", action="version",
2343
version = "%(prog)s {}".format(version),
2344
help="show version number and exit")
2345
parser.add_argument("-i", "--interface", metavar="IF",
2346
help="Bind to interface IF")
2347
parser.add_argument("-a", "--address",
2348
help="Address to listen for requests on")
2349
parser.add_argument("-p", "--port", type=int,
2350
help="Port number to receive requests on")
2351
parser.add_argument("--check", action="store_true",
2352
help="Run self-test")
2353
parser.add_argument("--debug", action="store_true",
2354
help="Debug mode; run in foreground and log"
2355
" to terminal", default=None)
2356
parser.add_argument("--debuglevel", metavar="LEVEL",
2357
help="Debug level for stdout output")
2358
parser.add_argument("--priority", help="GnuTLS"
2359
" priority string (see GnuTLS documentation)")
2360
parser.add_argument("--servicename",
2361
metavar="NAME", help="Zeroconf service name")
2362
parser.add_argument("--configdir",
2363
default="/etc/mandos", metavar="DIR",
2364
help="Directory to search for configuration"
2366
parser.add_argument("--no-dbus", action="store_false",
2367
dest="use_dbus", help="Do not provide D-Bus"
2368
" system bus interface", default=None)
2369
parser.add_argument("--no-ipv6", action="store_false",
2370
dest="use_ipv6", help="Do not use IPv6",
2372
parser.add_argument("--no-restore", action="store_false",
2373
dest="restore", help="Do not restore stored"
2374
" state", default=None)
2375
parser.add_argument("--socket", type=int,
2376
help="Specify a file descriptor to a network"
2377
" socket to use instead of creating one")
2378
parser.add_argument("--statedir", metavar="DIR",
2379
help="Directory to save/restore state in")
2380
parser.add_argument("--foreground", action="store_true",
2381
help="Run in foreground", default=None)
2382
parser.add_argument("--no-zeroconf", action="store_false",
2383
dest="zeroconf", help="Do not use Zeroconf",
2386
options = parser.parse_args()
1585
2388
if options.check:
2390
fail_count, test_count = doctest.testmod()
2391
sys.exit(os.EX_OK if fail_count == 0 else 1)
1590
2393
# Default values for config file for server-global settings
1591
server_defaults = { u"interface": u"",
1596
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1597
u"servicename": u"Mandos",
1598
u"use_dbus": u"True",
1599
u"use_ipv6": u"True",
2394
server_defaults = { "interface": "",
2399
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2400
":+SIGN-DSA-SHA256",
2401
"servicename": "Mandos",
2407
"statedir": "/var/lib/mandos",
2408
"foreground": "False",
1602
2412
# Parse config file for server-global settings
1603
2413
server_config = configparser.SafeConfigParser(server_defaults)
1604
2414
del server_defaults
1605
server_config.read(os.path.join(options.configdir,
2415
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1607
2416
# Convert the SafeConfigParser object to a dict
1608
2417
server_settings = server_config.defaults()
1609
2418
# Use the appropriate methods on the non-string config options
1610
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1611
server_settings[option] = server_config.getboolean(u"DEFAULT",
2419
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2420
server_settings[option] = server_config.getboolean("DEFAULT",
1613
2422
if server_settings["port"]:
1614
server_settings["port"] = server_config.getint(u"DEFAULT",
2423
server_settings["port"] = server_config.getint("DEFAULT",
2425
if server_settings["socket"]:
2426
server_settings["socket"] = server_config.getint("DEFAULT",
2428
# Later, stdin will, and stdout and stderr might, be dup'ed
2429
# over with an opened os.devnull. But we don't want this to
2430
# happen with a supplied network socket.
2431
if 0 <= server_settings["socket"] <= 2:
2432
server_settings["socket"] = os.dup(server_settings
1616
2434
del server_config
1618
2436
# Override the settings from the config file with command line
1619
2437
# options, if set.
1620
for option in (u"interface", u"address", u"port", u"debug",
1621
u"priority", u"servicename", u"configdir",
1622
u"use_dbus", u"use_ipv6"):
2438
for option in ("interface", "address", "port", "debug",
2439
"priority", "servicename", "configdir", "use_dbus",
2440
"use_ipv6", "debuglevel", "restore", "statedir",
2441
"socket", "foreground", "zeroconf"):
1623
2442
value = getattr(options, option)
1624
2443
if value is not None:
1625
2444
server_settings[option] = value
1627
2446
# Force all strings to be unicode
1628
2447
for option in server_settings.keys():
1629
if type(server_settings[option]) is str:
1630
server_settings[option] = unicode(server_settings[option])
2448
if isinstance(server_settings[option], bytes):
2449
server_settings[option] = (server_settings[option]
2451
# Force all boolean options to be boolean
2452
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2453
"foreground", "zeroconf"):
2454
server_settings[option] = bool(server_settings[option])
2455
# Debug implies foreground
2456
if server_settings["debug"]:
2457
server_settings["foreground"] = True
1631
2458
# Now we have our good server settings in "server_settings"
1633
2460
##################################################################
2462
if (not server_settings["zeroconf"]
2463
and not (server_settings["port"]
2464
or server_settings["socket"] != "")):
2465
parser.error("Needs port or socket to work without Zeroconf")
1635
2467
# For convenience
1636
debug = server_settings[u"debug"]
1637
use_dbus = server_settings[u"use_dbus"]
1638
use_ipv6 = server_settings[u"use_ipv6"]
1641
syslogger.setLevel(logging.WARNING)
1642
console.setLevel(logging.WARNING)
1644
if server_settings[u"servicename"] != u"Mandos":
1645
syslogger.setFormatter(logging.Formatter
1646
(u'Mandos (%s) [%%(process)d]:'
1647
u' %%(levelname)s: %%(message)s'
1648
% server_settings[u"servicename"]))
2468
debug = server_settings["debug"]
2469
debuglevel = server_settings["debuglevel"]
2470
use_dbus = server_settings["use_dbus"]
2471
use_ipv6 = server_settings["use_ipv6"]
2472
stored_state_path = os.path.join(server_settings["statedir"],
2474
foreground = server_settings["foreground"]
2475
zeroconf = server_settings["zeroconf"]
2478
initlogger(debug, logging.DEBUG)
2483
level = getattr(logging, debuglevel.upper())
2484
initlogger(debug, level)
2486
if server_settings["servicename"] != "Mandos":
2487
syslogger.setFormatter(
2488
logging.Formatter('Mandos ({}) [%(process)d]:'
2489
' %(levelname)s: %(message)s'.format(
2490
server_settings["servicename"])))
1650
2492
# Parse config file with clients
1651
client_defaults = { u"timeout": u"1h",
1653
u"checker": u"fping -q -- %%(host)s",
1655
u"approved_delay": u"5m",
1656
u"approved_duration": u"1s",
1658
client_config = configparser.SafeConfigParser(client_defaults)
1659
client_config.read(os.path.join(server_settings[u"configdir"],
2493
client_config = configparser.SafeConfigParser(Client
2495
client_config.read(os.path.join(server_settings["configdir"],
1662
2498
global mandos_dbus_service
1663
2499
mandos_dbus_service = None
1665
tcp_server = MandosServer((server_settings[u"address"],
1666
server_settings[u"port"]),
1668
interface=server_settings[u"interface"],
1671
server_settings[u"priority"],
1673
pidfilename = u"/var/run/mandos.pid"
1675
pidfile = open(pidfilename, u"w")
1677
logger.error(u"Could not open file %r", pidfilename)
2502
if server_settings["socket"] != "":
2503
socketfd = server_settings["socket"]
2504
tcp_server = MandosServer(
2505
(server_settings["address"], server_settings["port"]),
2507
interface=(server_settings["interface"] or None),
2509
gnutls_priority=server_settings["priority"],
2513
pidfilename = "/run/mandos.pid"
2514
if not os.path.isdir("/run/."):
2515
pidfilename = "/var/run/mandos.pid"
2518
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2519
except IOError as e:
2520
logger.error("Could not open file %r", pidfilename,
1680
uid = pwd.getpwnam(u"_mandos").pw_uid
1681
gid = pwd.getpwnam(u"_mandos").pw_gid
2523
for name in ("_mandos", "mandos", "nobody"):
1684
uid = pwd.getpwnam(u"mandos").pw_uid
1685
gid = pwd.getpwnam(u"mandos").pw_gid
2525
uid = pwd.getpwnam(name).pw_uid
2526
gid = pwd.getpwnam(name).pw_gid
1686
2528
except KeyError:
1688
uid = pwd.getpwnam(u"nobody").pw_uid
1689
gid = pwd.getpwnam(u"nobody").pw_gid
1696
except OSError, error:
1697
if error[0] != errno.EPERM:
2536
except OSError as error:
2537
if error.errno != errno.EPERM:
1700
# Enable all possible GnuTLS debugging
2541
# Enable all possible GnuTLS debugging
1702
2543
# "Use a log level over 10 to enable all debugging options."
1703
2544
# - GnuTLS manual
1704
2545
gnutls.library.functions.gnutls_global_set_log_level(11)
1706
2547
@gnutls.library.types.gnutls_log_func
1707
2548
def debug_gnutls(level, string):
1708
logger.debug(u"GnuTLS: %s", string[:-1])
1710
(gnutls.library.functions
1711
.gnutls_global_set_log_function(debug_gnutls))
2549
logger.debug("GnuTLS: %s", string[:-1])
2551
gnutls.library.functions.gnutls_global_set_log_function(
2554
# Redirect stdin so all checkers get /dev/null
2555
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2556
os.dup2(null, sys.stdin.fileno())
2560
# Need to fork before connecting to D-Bus
2562
# Close all input and output, do double fork, etc.
2565
# multiprocessing will use threads, so before we use gobject we
2566
# need to inform gobject that threads will be used.
2567
gobject.threads_init()
1713
2569
global main_loop
1714
2570
# From the Avahi example code
1715
DBusGMainLoop(set_as_default=True )
2571
DBusGMainLoop(set_as_default=True)
1716
2572
main_loop = gobject.MainLoop()
1717
2573
bus = dbus.SystemBus()
1718
2574
# End of Avahi example code
1721
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1722
bus, do_not_queue=True)
1723
except dbus.exceptions.NameExistsException, e:
1724
logger.error(unicode(e) + u", disabling D-Bus")
2577
bus_name = dbus.service.BusName("se.recompile.Mandos",
2580
old_bus_name = dbus.service.BusName(
2581
"se.bsnet.fukt.Mandos", bus,
2583
except dbus.exceptions.DBusException as e:
2584
logger.error("Disabling D-Bus:", exc_info=e)
1725
2585
use_dbus = False
1726
server_settings[u"use_dbus"] = False
2586
server_settings["use_dbus"] = False
1727
2587
tcp_server.use_dbus = False
1728
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1729
service = AvahiService(name = server_settings[u"servicename"],
1730
servicetype = u"_mandos._tcp",
1731
protocol = protocol, bus = bus)
1732
if server_settings["interface"]:
1733
service.interface = (if_nametoindex
1734
(str(server_settings[u"interface"])))
2589
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2590
service = AvahiServiceToSyslog(
2591
name = server_settings["servicename"],
2592
servicetype = "_mandos._tcp",
2593
protocol = protocol,
2595
if server_settings["interface"]:
2596
service.interface = if_nametoindex(
2597
server_settings["interface"].encode("utf-8"))
2599
global multiprocessing_manager
2600
multiprocessing_manager = multiprocessing.Manager()
1736
2602
client_class = Client
1738
2604
client_class = functools.partial(ClientDBus, bus = bus)
1739
def client_config_items(config, section):
1740
special_settings = {
1741
"approve_by_default":
1742
lambda: config.getboolean(section,
1743
"approve_by_default"),
1745
for name, value in config.items(section):
2606
client_settings = Client.config_parser(client_config)
2607
old_client_settings = {}
2610
# This is used to redirect stdout and stderr for checker processes
2612
wnull = open(os.devnull, "w") # A writable /dev/null
2613
# Only used if server is running in foreground but not in debug
2615
if debug or not foreground:
2618
# Get client data and settings from last running state.
2619
if server_settings["restore"]:
2621
with open(stored_state_path, "rb") as stored_state:
2622
clients_data, old_client_settings = pickle.load(
2624
os.remove(stored_state_path)
2625
except IOError as e:
2626
if e.errno == errno.ENOENT:
2627
logger.warning("Could not load persistent state:"
2628
" {}".format(os.strerror(e.errno)))
2630
logger.critical("Could not load persistent state:",
2633
except EOFError as e:
2634
logger.warning("Could not load persistent state: "
2638
with PGPEngine() as pgp:
2639
for client_name, client in clients_data.items():
2640
# Skip removed clients
2641
if client_name not in client_settings:
2644
# Decide which value to use after restoring saved state.
2645
# We have three different values: Old config file,
2646
# new config file, and saved state.
2647
# New config value takes precedence if it differs from old
2648
# config value, otherwise use saved state.
2649
for name, value in client_settings[client_name].items():
2651
# For each value in new config, check if it
2652
# differs from the old config value (Except for
2653
# the "secret" attribute)
2654
if (name != "secret"
2656
old_client_settings[client_name][name])):
2657
client[name] = value
2661
# Clients who has passed its expire date can still be
2662
# enabled if its last checker was successful. A Client
2663
# whose checker succeeded before we stored its state is
2664
# assumed to have successfully run all checkers during
2666
if client["enabled"]:
2667
if datetime.datetime.utcnow() >= client["expires"]:
2668
if not client["last_checked_ok"]:
2670
"disabling client {} - Client never "
2671
"performed a successful checker".format(
2673
client["enabled"] = False
2674
elif client["last_checker_status"] != 0:
2676
"disabling client {} - Client last"
2677
" checker failed with error code"
2680
client["last_checker_status"]))
2681
client["enabled"] = False
2683
client["expires"] = (
2684
datetime.datetime.utcnow()
2685
+ client["timeout"])
2686
logger.debug("Last checker succeeded,"
2687
" keeping {} enabled".format(
1747
yield special_settings[name]()
1751
tcp_server.clients.update(set(
1752
client_class(name = section,
1753
config= dict(client_config_items(
1754
client_config, section)))
1755
for section in client_config.sections()))
2690
client["secret"] = pgp.decrypt(
2691
client["encrypted_secret"],
2692
client_settings[client_name]["secret"])
2694
# If decryption fails, we use secret from new settings
2695
logger.debug("Failed to decrypt {} old secret".format(
2697
client["secret"] = (client_settings[client_name]
2700
# Add/remove clients based on new changes made to config
2701
for client_name in (set(old_client_settings)
2702
- set(client_settings)):
2703
del clients_data[client_name]
2704
for client_name in (set(client_settings)
2705
- set(old_client_settings)):
2706
clients_data[client_name] = client_settings[client_name]
2708
# Create all client objects
2709
for client_name, client in clients_data.items():
2710
tcp_server.clients[client_name] = client_class(
2713
server_settings = server_settings)
1756
2715
if not tcp_server.clients:
1757
logger.warning(u"No clients defined")
1760
# Redirect stdin so all checkers get /dev/null
1761
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1762
os.dup2(null, sys.stdin.fileno())
1766
# No console logging
1767
logger.removeHandler(console)
1768
# Close all input and output, do double fork, etc.
2716
logger.warning("No clients defined")
2719
if pidfile is not None:
1773
2720
pid = os.getpid()
1774
pidfile.write(str(pid) + "\n")
2723
print(pid, file=pidfile)
2725
logger.error("Could not write to file %r with PID %d",
1777
logger.error(u"Could not write to file %r with PID %d",
1780
# "pidfile" was never created
1785
signal.signal(signal.SIGINT, signal.SIG_IGN)
1786
2730
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1787
2731
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1790
class MandosDBusService(dbus.service.Object):
2735
@alternate_dbus_interfaces(
2736
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2737
class MandosDBusService(DBusObjectWithProperties):
1791
2738
"""A D-Bus proxy object"""
1792
2740
def __init__(self):
1793
dbus.service.Object.__init__(self, bus, u"/")
1794
_interface = u"se.bsnet.fukt.Mandos"
1796
@dbus.service.signal(_interface, signature=u"o")
2741
dbus.service.Object.__init__(self, bus, "/")
2743
_interface = "se.recompile.Mandos"
2745
@dbus_interface_annotations(_interface)
2748
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2751
@dbus.service.signal(_interface, signature="o")
1797
2752
def ClientAdded(self, objpath):
1801
@dbus.service.signal(_interface, signature=u"ss")
2756
@dbus.service.signal(_interface, signature="ss")
1802
2757
def ClientNotFound(self, fingerprint, address):
1806
@dbus.service.signal(_interface, signature=u"os")
2761
@dbus.service.signal(_interface, signature="os")
1807
2762
def ClientRemoved(self, objpath, name):
1811
@dbus.service.method(_interface, out_signature=u"ao")
2766
@dbus.service.method(_interface, out_signature="ao")
1812
2767
def GetAllClients(self):
1814
return dbus.Array(c.dbus_object_path
1815
for c in tcp_server.clients)
2769
return dbus.Array(c.dbus_object_path for c in
2770
tcp_server.clients.itervalues())
1817
2772
@dbus.service.method(_interface,
1818
out_signature=u"a{oa{sv}}")
2773
out_signature="a{oa{sv}}")
1819
2774
def GetAllClientsWithProperties(self):
1821
2776
return dbus.Dictionary(
1822
((c.dbus_object_path, c.GetAll(u""))
1823
for c in tcp_server.clients),
1824
signature=u"oa{sv}")
2777
{ c.dbus_object_path: c.GetAll("")
2778
for c in tcp_server.clients.itervalues() },
1826
@dbus.service.method(_interface, in_signature=u"o")
2781
@dbus.service.method(_interface, in_signature="o")
1827
2782
def RemoveClient(self, object_path):
1829
for c in tcp_server.clients:
2784
for c in tcp_server.clients.itervalues():
1830
2785
if c.dbus_object_path == object_path:
1831
tcp_server.clients.remove(c)
2786
del tcp_server.clients[c.name]
1832
2787
c.remove_from_connection()
1833
2788
# Don't signal anything except ClientRemoved
1834
2789
c.disable(quiet=True)
1845
2800
"Cleanup function; run on exit"
2804
multiprocessing.active_children()
2806
if not (tcp_server.clients or client_settings):
2809
# Store client before exiting. Secrets are encrypted with key
2810
# based on what config file has. If config file is
2811
# removed/edited, old secret will thus be unrecovable.
2813
with PGPEngine() as pgp:
2814
for client in tcp_server.clients.itervalues():
2815
key = client_settings[client.name]["secret"]
2816
client.encrypted_secret = pgp.encrypt(client.secret,
2820
# A list of attributes that can not be pickled
2822
exclude = { "bus", "changedstate", "secret",
2823
"checker", "server_settings" }
2824
for name, typ in inspect.getmembers(dbus.service
2828
client_dict["encrypted_secret"] = (client
2830
for attr in client.client_structure:
2831
if attr not in exclude:
2832
client_dict[attr] = getattr(client, attr)
2834
clients[client.name] = client_dict
2835
del client_settings[client.name]["secret"]
2838
with tempfile.NamedTemporaryFile(
2842
dir=os.path.dirname(stored_state_path),
2843
delete=False) as stored_state:
2844
pickle.dump((clients, client_settings), stored_state)
2845
tempname = stored_state.name
2846
os.rename(tempname, stored_state_path)
2847
except (IOError, OSError) as e:
2853
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2854
logger.warning("Could not save persistent state: {}"
2855
.format(os.strerror(e.errno)))
2857
logger.warning("Could not save persistent state:",
2861
# Delete all clients, and settings from config
1848
2862
while tcp_server.clients:
1849
client = tcp_server.clients.pop()
2863
name, client = tcp_server.clients.popitem()
1851
2865
client.remove_from_connection()
1852
client.disable_hook = None
1853
2866
# Don't signal anything except ClientRemoved
1854
2867
client.disable(quiet=True)
1856
2869
# Emit D-Bus signal
1857
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2870
mandos_dbus_service.ClientRemoved(
2871
client.dbus_object_path, client.name)
2872
client_settings.clear()
1860
2874
atexit.register(cleanup)
1862
for client in tcp_server.clients:
2876
for client in tcp_server.clients.itervalues():
1864
2878
# Emit D-Bus signal
1865
2879
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2880
# Need to initiate checking of clients
2882
client.init_checker()
1868
2884
tcp_server.enable()
1869
2885
tcp_server.server_activate()
1871
2887
# Find out what port we got
1872
service.port = tcp_server.socket.getsockname()[1]
2889
service.port = tcp_server.socket.getsockname()[1]
1874
logger.info(u"Now listening on address %r, port %d,"
1875
" flowinfo %d, scope_id %d"
1876
% tcp_server.socket.getsockname())
2891
logger.info("Now listening on address %r, port %d,"
2892
" flowinfo %d, scope_id %d",
2893
*tcp_server.socket.getsockname())
1878
logger.info(u"Now listening on address %r, port %d"
1879
% tcp_server.socket.getsockname())
2895
logger.info("Now listening on address %r, port %d",
2896
*tcp_server.socket.getsockname())
1881
2898
#service.interface = tcp_server.socket.getsockname()[3]
1884
# From the Avahi example code
1887
except dbus.exceptions.DBusException, error:
1888
logger.critical(u"DBusException: %s", error)
1891
# End of Avahi example code
2902
# From the Avahi example code
2905
except dbus.exceptions.DBusException as error:
2906
logger.critical("D-Bus Exception", exc_info=error)
2909
# End of Avahi example code
1893
2911
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1894
2912
lambda *args, **kwargs:
1895
2913
(tcp_server.handle_request
1896
2914
(*args[2:], **kwargs) or True))
1898
logger.debug(u"Starting main loop")
2916
logger.debug("Starting main loop")
1899
2917
main_loop.run()
1900
except AvahiError, error:
1901
logger.critical(u"AvahiError: %s", error)
2918
except AvahiError as error:
2919
logger.critical("Avahi Error", exc_info=error)
1904
2922
except KeyboardInterrupt:
1907
logger.debug(u"Server received KeyboardInterrupt")
1908
logger.debug(u"Server exiting")
2924
print("", file=sys.stderr)
2925
logger.debug("Server received KeyboardInterrupt")
2926
logger.debug("Server exiting")
1909
2927
# Must run before the D-Bus bus name gets deregistered
1912
2931
if __name__ == '__main__':