47
44
import gnutls.library.functions
48
45
import gnutls.library.constants
49
46
import gnutls.library.types
50
import ConfigParser as configparser
59
57
import logging.handlers
65
import cPickle as pickle
66
import multiprocessing
77
62
from dbus.mainloop.glib import DBusGMainLoop
80
import xml.dom.minidom
84
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
except AttributeError:
87
from IN import SO_BINDTODEVICE
89
SO_BINDTODEVICE = None
92
stored_state_file = "clients.pickle"
94
logger = logging.getLogger()
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
101
except (OSError, AttributeError):
102
def if_nametoindex(interface):
103
"Get an interface index the hard way, i.e. using fcntl()"
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
with contextlib.closing(socket.socket()) as s:
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
111
return interface_index
114
def initlogger(debug, level=logging.WARNING):
115
"""init logger and add loglevel"""
118
syslogger = (logging.handlers.SysLogHandler
120
logging.handlers.SysLogHandler.LOG_DAEMON,
121
address = str("/dev/log")))
122
syslogger.setFormatter(logging.Formatter
123
('Mandos [%(process)d]: %(levelname)s:'
125
logger.addHandler(syslogger)
128
console = logging.StreamHandler()
129
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
133
logger.addHandler(console)
134
logger.setLevel(level)
137
class PGPError(Exception):
138
"""Exception if encryption/decryption fails"""
142
class PGPEngine(object):
143
"""A simple class for OpenPGP symmetric encryption & decryption"""
145
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
146
self.gnupgargs = ['--batch',
147
'--home', self.tempdir,
155
def __exit__(self, exc_type, exc_value, traceback):
163
if self.tempdir is not None:
164
# Delete contents of tempdir
165
for root, dirs, files in os.walk(self.tempdir,
167
for filename in files:
168
os.remove(os.path.join(root, filename))
170
os.rmdir(os.path.join(root, dirname))
172
os.rmdir(self.tempdir)
175
def password_encode(self, password):
176
# Passphrase can not be empty and can not contain newlines or
177
# NUL bytes. So we prefix it and hex encode it.
178
encoded = b"mandos" + binascii.hexlify(password)
179
if len(encoded) > 2048:
180
# GnuPG can't handle long passwords, so encode differently
181
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
182
.replace(b"\n", b"\\n")
183
.replace(b"\0", b"\\x00"))
186
def encrypt(self, data, password):
187
passphrase = self.password_encode(password)
188
with tempfile.NamedTemporaryFile(dir=self.tempdir
190
passfile.write(passphrase)
192
proc = subprocess.Popen(['gpg', '--symmetric',
196
stdin = subprocess.PIPE,
197
stdout = subprocess.PIPE,
198
stderr = subprocess.PIPE)
199
ciphertext, err = proc.communicate(input = data)
200
if proc.returncode != 0:
204
def decrypt(self, data, password):
205
passphrase = self.password_encode(password)
206
with tempfile.NamedTemporaryFile(dir = self.tempdir
208
passfile.write(passphrase)
210
proc = subprocess.Popen(['gpg', '--decrypt',
214
stdin = subprocess.PIPE,
215
stdout = subprocess.PIPE,
216
stderr = subprocess.PIPE)
217
decrypted_plaintext, err = proc.communicate(input
219
if proc.returncode != 0:
221
return decrypted_plaintext
224
class AvahiError(Exception):
225
def __init__(self, value, *args, **kwargs):
227
super(AvahiError, self).__init__(value, *args, **kwargs)
228
def __unicode__(self):
229
return unicode(repr(self.value))
231
class AvahiServiceError(AvahiError):
234
class AvahiGroupError(AvahiError):
238
class AvahiService(object):
239
"""An Avahi (Zeroconf) service.
242
interface: integer; avahi.IF_UNSPEC or an interface index.
243
Used to optionally bind to the specified interface.
244
name: string; Example: 'Mandos'
245
type: string; Example: '_mandos._tcp'.
246
See <https://www.iana.org/assignments/service-names-port-numbers>
247
port: integer; what port to announce
248
TXT: list of strings; TXT record for the service
249
domain: string; Domain to publish on, default to .local if empty.
250
host: string; Host to publish records for, default is localhost
251
max_renames: integer; maximum number of renames
252
rename_count: integer; counter so we only rename after collisions
253
a sensible number of times
254
group: D-Bus Entry Group
256
bus: dbus.SystemBus()
259
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
servicetype = None, port = None, TXT = None,
261
domain = "", host = "", max_renames = 32768,
262
protocol = avahi.PROTO_UNSPEC, bus = None):
263
self.interface = interface
265
self.type = servicetype
267
self.TXT = TXT if TXT is not None else []
270
self.rename_count = 0
271
self.max_renames = max_renames
272
self.protocol = protocol
273
self.group = None # our entry group
276
self.entry_group_state_changed_match = None
279
"""Derived from the Avahi example code"""
280
if self.rename_count >= self.max_renames:
281
logger.critical("No suitable Zeroconf service name found"
282
" after %i retries, exiting.",
284
raise AvahiServiceError("Too many renames")
285
self.name = unicode(self.server
286
.GetAlternativeServiceName(self.name))
287
logger.info("Changing Zeroconf service name to %r ...",
292
except dbus.exceptions.DBusException as error:
293
logger.critical("D-Bus Exception", exc_info=error)
296
self.rename_count += 1
299
"""Derived from the Avahi example code"""
300
if self.entry_group_state_changed_match is not None:
301
self.entry_group_state_changed_match.remove()
302
self.entry_group_state_changed_match = None
303
if self.group is not None:
307
"""Derived from the Avahi example code"""
309
if self.group is None:
310
self.group = dbus.Interface(
311
self.bus.get_object(avahi.DBUS_NAME,
312
self.server.EntryGroupNew()),
313
avahi.DBUS_INTERFACE_ENTRY_GROUP)
314
self.entry_group_state_changed_match = (
315
self.group.connect_to_signal(
316
'StateChanged', self.entry_group_state_changed))
317
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
318
self.name, self.type)
319
self.group.AddService(
322
dbus.UInt32(0), # flags
323
self.name, self.type,
324
self.domain, self.host,
325
dbus.UInt16(self.port),
326
avahi.string_array_to_txt_array(self.TXT))
329
def entry_group_state_changed(self, state, error):
330
"""Derived from the Avahi example code"""
331
logger.debug("Avahi entry group state change: %i", state)
333
if state == avahi.ENTRY_GROUP_ESTABLISHED:
334
logger.debug("Zeroconf service established.")
335
elif state == avahi.ENTRY_GROUP_COLLISION:
336
logger.info("Zeroconf service name collision.")
338
elif state == avahi.ENTRY_GROUP_FAILURE:
339
logger.critical("Avahi: Error in group state changed %s",
341
raise AvahiGroupError("State changed: {!s}"
345
"""Derived from the Avahi example code"""
346
if self.group is not None:
349
except (dbus.exceptions.UnknownMethodException,
350
dbus.exceptions.DBusException):
355
def server_state_changed(self, state, error=None):
356
"""Derived from the Avahi example code"""
357
logger.debug("Avahi server state change: %i", state)
358
bad_states = { avahi.SERVER_INVALID:
359
"Zeroconf server invalid",
360
avahi.SERVER_REGISTERING: None,
361
avahi.SERVER_COLLISION:
362
"Zeroconf server name collision",
363
avahi.SERVER_FAILURE:
364
"Zeroconf server failure" }
365
if state in bad_states:
366
if bad_states[state] is not None:
368
logger.error(bad_states[state])
370
logger.error(bad_states[state] + ": %r", error)
372
elif state == avahi.SERVER_RUNNING:
376
logger.debug("Unknown state: %r", state)
378
logger.debug("Unknown state: %r: %r", state, error)
381
"""Derived from the Avahi example code"""
382
if self.server is None:
383
self.server = dbus.Interface(
384
self.bus.get_object(avahi.DBUS_NAME,
385
avahi.DBUS_PATH_SERVER,
386
follow_name_owner_changes=True),
387
avahi.DBUS_INTERFACE_SERVER)
388
self.server.connect_to_signal("StateChanged",
389
self.server_state_changed)
390
self.server_state_changed(self.server.GetState())
393
class AvahiServiceToSyslog(AvahiService):
395
"""Add the new name to the syslog messages"""
396
ret = AvahiService.rename(self)
397
syslogger.setFormatter(logging.Formatter
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
404
def timedelta_to_milliseconds(td):
405
"Convert a datetime.timedelta() to milliseconds"
406
return ((td.days * 24 * 60 * 60 * 1000)
407
+ (td.seconds * 1000)
408
+ (td.microseconds // 1000))
65
# Brief description of the operation of this program:
67
# This server announces itself as a Zeroconf service. Connecting
68
# clients use the TLS protocol, with the unusual quirk that this
69
# server program acts as a TLS "client" while the connecting clients
70
# acts as a TLS "server". The clients (acting as a TLS "server") must
71
# supply an OpenPGP certificate, and the fingerprint of this
72
# certificate is used by this server to look up (in a list read from a
73
# file at start time) which binary blob to give the client. No other
74
# authentication or authorization is done by this server.
77
logger = logging.Logger('mandos')
78
syslogger = logging.handlers.SysLogHandler\
79
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
80
syslogger.setFormatter(logging.Formatter\
81
('%(levelname)s: %(message)s'))
82
logger.addHandler(syslogger)
85
# This variable is used to optionally bind to a specified interface.
86
# It is a global variable to fit in with the other variables from the
88
serviceInterface = avahi.IF_UNSPEC
89
# From the Avahi example code:
90
serviceName = "Mandos"
91
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
92
servicePort = None # Not known at startup
93
serviceTXT = [] # TXT record for the service
94
domain = "" # Domain to publish on, default to .local
95
host = "" # Host to publish records for, default to localhost
96
group = None #our entry group
97
rename_count = 12 # Counter so we only rename after collisions a
98
# sensible number of times
99
# End of Avahi example code
411
102
class Client(object):
412
103
"""A representation of a client host served by this server.
415
approved: bool(); 'None' if not yet approved/disapproved
416
approval_delay: datetime.timedelta(); Time to wait for approval
417
approval_duration: datetime.timedelta(); Duration of one approval
418
checker: subprocess.Popen(); a running checker process used
419
to see if the client lives.
420
'None' if no process is running.
421
checker_callback_tag: a gobject event source tag, or None
422
checker_command: string; External command which is run to check
423
if client lives. %() expansions are done at
105
name: string; from the config file, used in log messages
106
fingerprint: string (40 or 32 hexadecimal digits); used to
107
uniquely identify the client
108
secret: bytestring; sent verbatim (over TLS) to client
109
fqdn: string (FQDN); available for use by the checker command
110
created: datetime.datetime()
111
last_seen: datetime.datetime() or None if not yet seen
112
timeout: datetime.timedelta(); How long from last_seen until
113
this client is invalid
114
interval: datetime.timedelta(); How often to start a new checker
115
stop_hook: If set, called by stop() as stop_hook(self)
116
checker: subprocess.Popen(); a running checker process used
117
to see if the client lives.
118
Is None if no process is running.
119
checker_initiator_tag: a gobject event source tag, or None
120
stop_initiator_tag: - '' -
121
checker_callback_tag: - '' -
122
checker_command: string; External command which is run to check if
123
client lives. %()s expansions are done at
424
124
runtime with vars(self) as dict, so that for
425
125
instance %(name)s can be used in the command.
426
checker_initiator_tag: a gobject event source tag, or None
427
created: datetime.datetime(); (UTC) object creation
428
client_structure: Object describing what attributes a client has
429
and is used for storing the client at exit
430
current_checker_command: string; current running checker_command
431
disable_initiator_tag: a gobject event source tag, or None
433
fingerprint: string (40 or 32 hexadecimal digits); used to
434
uniquely identify the client
435
host: string; available for use by the checker command
436
interval: datetime.timedelta(); How often to start a new checker
437
last_approval_request: datetime.datetime(); (UTC) or None
438
last_checked_ok: datetime.datetime(); (UTC) or None
439
last_checker_status: integer between 0 and 255 reflecting exit
440
status of last checker. -1 reflects crashed
441
checker, -2 means no checker completed yet.
442
last_enabled: datetime.datetime(); (UTC) or None
443
name: string; from the config file, used in log messages and
445
secret: bytestring; sent verbatim (over TLS) to client
446
timeout: datetime.timedelta(); How long from last_checked_ok
447
until this client is disabled
448
extended_timeout: extra long timeout when secret has been sent
449
runtime_expansions: Allowed attributes for runtime expansion.
450
expires: datetime.datetime(); time (UTC) when a client will be
452
server_settings: The server_settings dict from main()
127
_timeout: Real variable for 'timeout'
128
_interval: Real variable for 'interval'
129
_timeout_milliseconds: Used by gobject.timeout_add()
130
_interval_milliseconds: - '' -
455
runtime_expansions = ("approval_delay", "approval_duration",
456
"created", "enabled", "expires",
457
"fingerprint", "host", "interval",
458
"last_approval_request", "last_checked_ok",
459
"last_enabled", "name", "timeout")
460
client_defaults = { "timeout": "PT5M",
461
"extended_timeout": "PT15M",
463
"checker": "fping -q -- %%(host)s",
465
"approval_delay": "PT0S",
466
"approval_duration": "PT1S",
467
"approved_by_default": "True",
471
def timeout_milliseconds(self):
472
"Return the 'timeout' attribute in milliseconds"
473
return timedelta_to_milliseconds(self.timeout)
475
def extended_timeout_milliseconds(self):
476
"Return the 'extended_timeout' attribute in milliseconds"
477
return timedelta_to_milliseconds(self.extended_timeout)
479
def interval_milliseconds(self):
480
"Return the 'interval' attribute in milliseconds"
481
return timedelta_to_milliseconds(self.interval)
483
def approval_delay_milliseconds(self):
484
return timedelta_to_milliseconds(self.approval_delay)
487
def config_parser(config):
488
"""Construct a new dict of client settings of this form:
489
{ client_name: {setting_name: value, ...}, ...}
490
with exceptions for any special settings as defined above.
491
NOTE: Must be a pure function. Must return the same result
492
value given the same arguments.
495
for client_name in config.sections():
496
section = dict(config.items(client_name))
497
client = settings[client_name] = {}
499
client["host"] = section["host"]
500
# Reformat values from string types to Python types
501
client["approved_by_default"] = config.getboolean(
502
client_name, "approved_by_default")
503
client["enabled"] = config.getboolean(client_name,
506
client["fingerprint"] = (section["fingerprint"].upper()
508
if "secret" in section:
509
client["secret"] = section["secret"].decode("base64")
510
elif "secfile" in section:
511
with open(os.path.expanduser(os.path.expandvars
512
(section["secfile"])),
514
client["secret"] = secfile.read()
516
raise TypeError("No secret or secfile for section {}"
518
client["timeout"] = string_to_delta(section["timeout"])
519
client["extended_timeout"] = string_to_delta(
520
section["extended_timeout"])
521
client["interval"] = string_to_delta(section["interval"])
522
client["approval_delay"] = string_to_delta(
523
section["approval_delay"])
524
client["approval_duration"] = string_to_delta(
525
section["approval_duration"])
526
client["checker_command"] = section["checker"]
527
client["last_approval_request"] = None
528
client["last_checked_ok"] = None
529
client["last_checker_status"] = -2
533
def __init__(self, settings, name = None, server_settings=None):
132
def _set_timeout(self, timeout):
133
"Setter function for 'timeout' attribute"
134
self._timeout = timeout
135
self._timeout_milliseconds = ((self.timeout.days
136
* 24 * 60 * 60 * 1000)
137
+ (self.timeout.seconds * 1000)
138
+ (self.timeout.microseconds
140
timeout = property(lambda self: self._timeout,
143
def _set_interval(self, interval):
144
"Setter function for 'interval' attribute"
145
self._interval = interval
146
self._interval_milliseconds = ((self.interval.days
147
* 24 * 60 * 60 * 1000)
148
+ (self.interval.seconds
150
+ (self.interval.microseconds
152
interval = property(lambda self: self._interval,
155
def __init__(self, name=None, options=None, stop_hook=None,
156
fingerprint=None, secret=None, secfile=None,
157
fqdn=None, timeout=None, interval=-1, checker=None):
158
"""Note: the 'checker' argument sets the 'checker_command'
159
attribute and not the 'checker' attribute.."""
535
if server_settings is None:
537
self.server_settings = server_settings
538
# adding all client settings
539
for setting, value in settings.items():
540
setattr(self, setting, value)
543
if not hasattr(self, "last_enabled"):
544
self.last_enabled = datetime.datetime.utcnow()
545
if not hasattr(self, "expires"):
546
self.expires = (datetime.datetime.utcnow()
549
self.last_enabled = None
552
logger.debug("Creating client %r", self.name)
553
# Uppercase and remove spaces from fingerprint for later
554
# comparison purposes with return value from the fingerprint()
556
logger.debug(" Fingerprint: %s", self.fingerprint)
557
self.created = settings.get("created",
558
datetime.datetime.utcnow())
560
# attributes specific for this server instance
161
# Uppercase and remove spaces from fingerprint
162
# for later comparison purposes with return value of
163
# the fingerprint() function
164
self.fingerprint = fingerprint.upper().replace(u" ", u"")
166
self.secret = secret.decode(u"base64")
169
self.secret = sf.read()
172
raise RuntimeError(u"No secret or secfile for client %s"
174
self.fqdn = fqdn # string
175
self.created = datetime.datetime.now()
176
self.last_seen = None
178
self.timeout = options.timeout
180
self.timeout = string_to_delta(timeout)
182
self.interval = options.interval
184
self.interval = string_to_delta(interval)
185
self.stop_hook = stop_hook
561
186
self.checker = None
562
187
self.checker_initiator_tag = None
563
self.disable_initiator_tag = None
188
self.stop_initiator_tag = None
564
189
self.checker_callback_tag = None
565
self.current_checker_command = None
567
self.approvals_pending = 0
568
self.changedstate = (multiprocessing_manager
569
.Condition(multiprocessing_manager
571
self.client_structure = [attr for attr in
572
self.__dict__.iterkeys()
573
if not attr.startswith("_")]
574
self.client_structure.append("client_structure")
576
for name, t in inspect.getmembers(type(self),
580
if not name.startswith("_"):
581
self.client_structure.append(name)
583
# Send notice to process children that client state has changed
584
def send_changedstate(self):
585
with self.changedstate:
586
self.changedstate.notify_all()
190
self.check_command = checker
589
192
"""Start this client's checker and timeout hooks"""
590
if getattr(self, "enabled", False):
593
self.expires = datetime.datetime.utcnow() + self.timeout
595
self.last_enabled = datetime.datetime.utcnow()
597
self.send_changedstate()
599
def disable(self, quiet=True):
600
"""Disable this client."""
601
if not getattr(self, "enabled", False):
604
logger.info("Disabling client %s", self.name)
605
if getattr(self, "disable_initiator_tag", None) is not None:
606
gobject.source_remove(self.disable_initiator_tag)
607
self.disable_initiator_tag = None
609
if getattr(self, "checker_initiator_tag", None) is not None:
610
gobject.source_remove(self.checker_initiator_tag)
611
self.checker_initiator_tag = None
615
self.send_changedstate()
616
# Do not run this again if called by a gobject.timeout_add
622
def init_checker(self):
623
193
# Schedule a new checker to be started an 'interval' from now,
624
194
# and every interval from then on.
625
if self.checker_initiator_tag is not None:
626
gobject.source_remove(self.checker_initiator_tag)
627
self.checker_initiator_tag = (gobject.timeout_add
628
(self.interval_milliseconds(),
630
# Schedule a disable() when 'timeout' has passed
631
if self.disable_initiator_tag is not None:
632
gobject.source_remove(self.disable_initiator_tag)
633
self.disable_initiator_tag = (gobject.timeout_add
634
(self.timeout_milliseconds(),
195
self.checker_initiator_tag = gobject.timeout_add\
196
(self._interval_milliseconds,
636
198
# Also start a new checker *right now*.
637
199
self.start_checker()
639
def checker_callback(self, pid, condition, command):
200
# Schedule a stop() when 'timeout' has passed
201
self.stop_initiator_tag = gobject.timeout_add\
202
(self._timeout_milliseconds,
206
The possibility that this client might be restarted is left
207
open, but not currently used."""
208
# If this client doesn't have a secret, it is already stopped.
210
logger.debug(u"Stopping client %s", self.name)
214
if hasattr(self, "stop_initiator_tag") \
215
and self.stop_initiator_tag:
216
gobject.source_remove(self.stop_initiator_tag)
217
self.stop_initiator_tag = None
218
if hasattr(self, "checker_initiator_tag") \
219
and self.checker_initiator_tag:
220
gobject.source_remove(self.checker_initiator_tag)
221
self.checker_initiator_tag = None
225
# Do not run this again if called by a gobject.timeout_add
228
self.stop_hook = None
230
def checker_callback(self, pid, condition):
640
231
"""The checker has completed, so take appropriate actions."""
232
now = datetime.datetime.now()
641
233
self.checker_callback_tag = None
642
234
self.checker = None
643
if os.WIFEXITED(condition):
644
self.last_checker_status = os.WEXITSTATUS(condition)
645
if self.last_checker_status == 0:
646
logger.info("Checker for %(name)s succeeded",
650
logger.info("Checker for %(name)s failed",
653
self.last_checker_status = -1
654
logger.warning("Checker for %(name)s crashed?",
235
if os.WIFEXITED(condition) \
236
and (os.WEXITSTATUS(condition) == 0):
237
logger.debug(u"Checker for %(name)s succeeded",
240
gobject.source_remove(self.stop_initiator_tag)
241
self.stop_initiator_tag = gobject.timeout_add\
242
(self._timeout_milliseconds,
244
elif not os.WIFEXITED(condition):
245
logger.warning(u"Checker for %(name)s crashed?",
657
def checked_ok(self):
658
"""Assert that the client has been seen, alive and well."""
659
self.last_checked_ok = datetime.datetime.utcnow()
660
self.last_checker_status = 0
663
def bump_timeout(self, timeout=None):
664
"""Bump up the timeout for this client."""
666
timeout = self.timeout
667
if self.disable_initiator_tag is not None:
668
gobject.source_remove(self.disable_initiator_tag)
669
self.disable_initiator_tag = None
670
if getattr(self, "enabled", False):
671
self.disable_initiator_tag = (gobject.timeout_add
672
(timedelta_to_milliseconds
673
(timeout), self.disable))
674
self.expires = datetime.datetime.utcnow() + timeout
676
def need_approval(self):
677
self.last_approval_request = datetime.datetime.utcnow()
248
logger.debug(u"Checker for %(name)s failed",
679
250
def start_checker(self):
680
251
"""Start a new checker subprocess if one is not running.
682
252
If a checker already exists, leave it running and do
684
254
# The reason for not killing a running checker is that if we
685
# did that, and if a checker (for some reason) started running
686
# slowly and taking more than 'interval' time, then the client
687
# would inevitably timeout, since no checker would get a
688
# chance to run to completion. If we instead leave running
255
# did that, then if a checker (for some reason) started
256
# running slowly and taking more than 'interval' time, the
257
# client would inevitably timeout, since no checker would get
258
# a chance to run to completion. If we instead leave running
689
259
# checkers alone, the checker would have to take more time
690
# than 'timeout' for the client to be disabled, which is as it
693
# If a checker exists, make sure it is not a zombie
695
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
696
except AttributeError:
698
except OSError as error:
699
if error.errno != errno.ECHILD:
703
logger.warning("Checker was a zombie")
704
gobject.source_remove(self.checker_callback_tag)
705
self.checker_callback(pid, status,
706
self.current_checker_command)
707
# Start a new checker if needed
260
# than 'timeout' for the client to be declared invalid, which
261
# is as it should be.
708
262
if self.checker is None:
709
# Escape attributes for the shell
710
escaped_attrs = { attr:
711
re.escape(unicode(getattr(self,
713
for attr in self.runtime_expansions }
715
command = self.checker_command % escaped_attrs
716
except TypeError as error:
717
logger.error('Could not format string "%s"',
718
self.checker_command, exc_info=error)
719
return True # Try again later
720
self.current_checker_command = command
722
logger.info("Starting checker %r for %s",
724
# We don't need to redirect stdout and stderr, since
725
# in normal mode, that is already done by daemon(),
726
# and in debug mode we don't want to. (Stdin is
727
# always replaced by /dev/null.)
728
# The exception is when not debugging but nevertheless
729
# running in the foreground; use the previously
732
if (not self.server_settings["debug"]
733
and self.server_settings["foreground"]):
734
popen_args.update({"stdout": wnull,
736
self.checker = subprocess.Popen(command,
740
except OSError as error:
741
logger.error("Failed to start subprocess",
744
self.checker_callback_tag = (gobject.child_watch_add
746
self.checker_callback,
748
# The checker may have completed before the gobject
749
# watch was added. Check for this.
751
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
752
except OSError as error:
753
if error.errno == errno.ECHILD:
754
# This should never happen
755
logger.error("Child process vanished",
760
gobject.source_remove(self.checker_callback_tag)
761
self.checker_callback(pid, status, command)
264
command = self.check_command % self.fqdn
266
escaped_attrs = dict((key, re.escape(str(val)))
268
vars(self).iteritems())
270
command = self.check_command % escaped_attrs
271
except TypeError, error:
272
logger.critical(u'Could not format string "%s":'
273
u' %s', self.check_command, error)
274
return True # Try again later
276
logger.debug(u"Starting checker %r for %s",
278
self.checker = subprocess.\
280
close_fds=True, shell=True,
282
self.checker_callback_tag = gobject.child_watch_add\
284
self.checker_callback)
285
except subprocess.OSError, error:
286
logger.error(u"Failed to start subprocess: %s",
762
288
# Re-run this periodically if run by gobject.timeout_add
765
290
def stop_checker(self):
766
291
"""Force the checker process, if any, to stop."""
767
292
if self.checker_callback_tag:
768
293
gobject.source_remove(self.checker_callback_tag)
769
294
self.checker_callback_tag = None
770
if getattr(self, "checker", None) is None:
295
if not hasattr(self, "checker") or self.checker is None:
772
297
logger.debug("Stopping checker for %(name)s", vars(self))
774
self.checker.terminate()
299
os.kill(self.checker.pid, signal.SIGTERM)
776
301
#if self.checker.poll() is None:
777
# self.checker.kill()
778
except OSError as error:
779
if error.errno != errno.ESRCH: # No such process
302
# os.kill(self.checker.pid, signal.SIGKILL)
303
except OSError, error:
304
if error.errno != errno.ESRCH:
781
306
self.checker = None
784
def dbus_service_property(dbus_interface, signature="v",
785
access="readwrite", byte_arrays=False):
786
"""Decorators for marking methods of a DBusObjectWithProperties to
787
become properties on the D-Bus.
789
The decorated method will be called with no arguments by "Get"
790
and with one argument by "Set".
792
The parameters, where they are supported, are the same as
793
dbus.service.method, except there is only "signature", since the
794
type from Get() and the type sent to Set() is the same.
796
# Encoding deeply encoded byte arrays is not supported yet by the
797
# "Set" method, so we fail early here:
798
if byte_arrays and signature != "ay":
799
raise ValueError("Byte arrays not supported for non-'ay'"
800
" signature {!r}".format(signature))
802
func._dbus_is_property = True
803
func._dbus_interface = dbus_interface
804
func._dbus_signature = signature
805
func._dbus_access = access
806
func._dbus_name = func.__name__
807
if func._dbus_name.endswith("_dbus_property"):
808
func._dbus_name = func._dbus_name[:-14]
809
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
814
def dbus_interface_annotations(dbus_interface):
815
"""Decorator for marking functions returning interface annotations
819
@dbus_interface_annotations("org.example.Interface")
820
def _foo(self): # Function name does not matter
821
return {"org.freedesktop.DBus.Deprecated": "true",
822
"org.freedesktop.DBus.Property.EmitsChangedSignal":
826
func._dbus_is_interface = True
827
func._dbus_interface = dbus_interface
828
func._dbus_name = dbus_interface
833
def dbus_annotations(annotations):
834
"""Decorator to annotate D-Bus methods, signals or properties
837
@dbus_service_property("org.example.Interface", signature="b",
839
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
840
"org.freedesktop.DBus.Property."
841
"EmitsChangedSignal": "false"})
842
def Property_dbus_property(self):
843
return dbus.Boolean(False)
846
func._dbus_annotations = annotations
851
class DBusPropertyException(dbus.exceptions.DBusException):
852
"""A base class for D-Bus property-related exceptions
854
def __unicode__(self):
855
return unicode(str(self))
858
class DBusPropertyAccessException(DBusPropertyException):
859
"""A property's access permissions disallows an operation.
864
class DBusPropertyNotFound(DBusPropertyException):
865
"""An attempt was made to access a non-existing property.
870
class DBusObjectWithProperties(dbus.service.Object):
871
"""A D-Bus object with properties.
873
Classes inheriting from this can use the dbus_service_property
874
decorator to expose methods as D-Bus properties. It exposes the
875
standard Get(), Set(), and GetAll() methods on the D-Bus.
879
def _is_dbus_thing(thing):
880
"""Returns a function testing if an attribute is a D-Bus thing
882
If called like _is_dbus_thing("method") it returns a function
883
suitable for use as predicate to inspect.getmembers().
885
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
888
def _get_all_dbus_things(self, thing):
889
"""Returns a generator of (name, attribute) pairs
891
return ((getattr(athing.__get__(self), "_dbus_name",
893
athing.__get__(self))
894
for cls in self.__class__.__mro__
896
inspect.getmembers(cls,
897
self._is_dbus_thing(thing)))
899
def _get_dbus_property(self, interface_name, property_name):
900
"""Returns a bound method if one exists which is a D-Bus
901
property with the specified name and interface.
903
for cls in self.__class__.__mro__:
904
for name, value in (inspect.getmembers
906
self._is_dbus_thing("property"))):
907
if (value._dbus_name == property_name
908
and value._dbus_interface == interface_name):
909
return value.__get__(self)
912
raise DBusPropertyNotFound(self.dbus_object_path + ":"
913
+ interface_name + "."
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
918
def Get(self, interface_name, property_name):
919
"""Standard D-Bus property Get() method, see D-Bus standard.
921
prop = self._get_dbus_property(interface_name, property_name)
922
if prop._dbus_access == "write":
923
raise DBusPropertyAccessException(property_name)
925
if not hasattr(value, "variant_level"):
927
return type(value)(value, variant_level=value.variant_level+1)
929
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
930
def Set(self, interface_name, property_name, value):
931
"""Standard D-Bus property Set() method, see D-Bus standard.
933
prop = self._get_dbus_property(interface_name, property_name)
934
if prop._dbus_access == "read":
935
raise DBusPropertyAccessException(property_name)
936
if prop._dbus_get_args_options["byte_arrays"]:
937
# The byte_arrays option is not supported yet on
938
# signatures other than "ay".
939
if prop._dbus_signature != "ay":
940
raise ValueError("Byte arrays not supported for non-"
941
"'ay' signature {!r}"
942
.format(prop._dbus_signature))
943
value = dbus.ByteArray(b''.join(chr(byte)
947
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
948
out_signature="a{sv}")
949
def GetAll(self, interface_name):
950
"""Standard D-Bus property GetAll() method, see D-Bus
953
Note: Will not include properties with access="write".
956
for name, prop in self._get_all_dbus_things("property"):
958
and interface_name != prop._dbus_interface):
959
# Interface non-empty but did not match
961
# Ignore write-only properties
962
if prop._dbus_access == "write":
965
if not hasattr(value, "variant_level"):
966
properties[name] = value
968
properties[name] = type(value)(value, variant_level=
969
value.variant_level+1)
970
return dbus.Dictionary(properties, signature="sv")
972
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
974
path_keyword='object_path',
975
connection_keyword='connection')
976
def Introspect(self, object_path, connection):
977
"""Overloading of standard D-Bus method.
979
Inserts property tags and interface annotation tags.
981
xmlstring = dbus.service.Object.Introspect(self, object_path,
984
document = xml.dom.minidom.parseString(xmlstring)
985
def make_tag(document, name, prop):
986
e = document.createElement("property")
987
e.setAttribute("name", name)
988
e.setAttribute("type", prop._dbus_signature)
989
e.setAttribute("access", prop._dbus_access)
991
for if_tag in document.getElementsByTagName("interface"):
993
for tag in (make_tag(document, name, prop)
995
in self._get_all_dbus_things("property")
996
if prop._dbus_interface
997
== if_tag.getAttribute("name")):
998
if_tag.appendChild(tag)
999
# Add annotation tags
1000
for typ in ("method", "signal", "property"):
1001
for tag in if_tag.getElementsByTagName(typ):
1003
for name, prop in (self.
1004
_get_all_dbus_things(typ)):
1005
if (name == tag.getAttribute("name")
1006
and prop._dbus_interface
1007
== if_tag.getAttribute("name")):
1008
annots.update(getattr
1010
"_dbus_annotations",
1012
for name, value in annots.items():
1013
ann_tag = document.createElement(
1015
ann_tag.setAttribute("name", name)
1016
ann_tag.setAttribute("value", value)
1017
tag.appendChild(ann_tag)
1018
# Add interface annotation tags
1019
for annotation, value in dict(
1020
itertools.chain.from_iterable(
1021
annotations().items()
1022
for name, annotations in
1023
self._get_all_dbus_things("interface")
1024
if name == if_tag.getAttribute("name")
1026
ann_tag = document.createElement("annotation")
1027
ann_tag.setAttribute("name", annotation)
1028
ann_tag.setAttribute("value", value)
1029
if_tag.appendChild(ann_tag)
1030
# Add the names to the return values for the
1031
# "org.freedesktop.DBus.Properties" methods
1032
if (if_tag.getAttribute("name")
1033
== "org.freedesktop.DBus.Properties"):
1034
for cn in if_tag.getElementsByTagName("method"):
1035
if cn.getAttribute("name") == "Get":
1036
for arg in cn.getElementsByTagName("arg"):
1037
if (arg.getAttribute("direction")
1039
arg.setAttribute("name", "value")
1040
elif cn.getAttribute("name") == "GetAll":
1041
for arg in cn.getElementsByTagName("arg"):
1042
if (arg.getAttribute("direction")
1044
arg.setAttribute("name", "props")
1045
xmlstring = document.toxml("utf-8")
1047
except (AttributeError, xml.dom.DOMException,
1048
xml.parsers.expat.ExpatError) as error:
1049
logger.error("Failed to override Introspection method",
1054
def datetime_to_dbus(dt, variant_level=0):
1055
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1057
return dbus.String("", variant_level = variant_level)
1058
return dbus.String(dt.isoformat(),
1059
variant_level=variant_level)
1062
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1063
"""A class decorator; applied to a subclass of
1064
dbus.service.Object, it will add alternate D-Bus attributes with
1065
interface names according to the "alt_interface_names" mapping.
1068
@alternate_dbus_interfaces({"org.example.Interface":
1069
"net.example.AlternateInterface"})
1070
class SampleDBusObject(dbus.service.Object):
1071
@dbus.service.method("org.example.Interface")
1072
def SampleDBusMethod():
1075
The above "SampleDBusMethod" on "SampleDBusObject" will be
1076
reachable via two interfaces: "org.example.Interface" and
1077
"net.example.AlternateInterface", the latter of which will have
1078
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1079
"true", unless "deprecate" is passed with a False value.
1081
This works for methods and signals, and also for D-Bus properties
1082
(from DBusObjectWithProperties) and interfaces (from the
1083
dbus_interface_annotations decorator).
1086
for orig_interface_name, alt_interface_name in (
1087
alt_interface_names.items()):
1089
interface_names = set()
1090
# Go though all attributes of the class
1091
for attrname, attribute in inspect.getmembers(cls):
1092
# Ignore non-D-Bus attributes, and D-Bus attributes
1093
# with the wrong interface name
1094
if (not hasattr(attribute, "_dbus_interface")
1095
or not attribute._dbus_interface
1096
.startswith(orig_interface_name)):
1098
# Create an alternate D-Bus interface name based on
1100
alt_interface = (attribute._dbus_interface
1101
.replace(orig_interface_name,
1102
alt_interface_name))
1103
interface_names.add(alt_interface)
1104
# Is this a D-Bus signal?
1105
if getattr(attribute, "_dbus_is_signal", False):
1106
# Extract the original non-method undecorated
1107
# function by black magic
1108
nonmethod_func = (dict(
1109
zip(attribute.func_code.co_freevars,
1110
attribute.__closure__))["func"]
1112
# Create a new, but exactly alike, function
1113
# object, and decorate it to be a new D-Bus signal
1114
# with the alternate D-Bus interface name
1115
new_function = (dbus.service.signal
1117
attribute._dbus_signature)
1118
(types.FunctionType(
1119
nonmethod_func.func_code,
1120
nonmethod_func.func_globals,
1121
nonmethod_func.func_name,
1122
nonmethod_func.func_defaults,
1123
nonmethod_func.func_closure)))
1124
# Copy annotations, if any
1126
new_function._dbus_annotations = (
1127
dict(attribute._dbus_annotations))
1128
except AttributeError:
1130
# Define a creator of a function to call both the
1131
# original and alternate functions, so both the
1132
# original and alternate signals gets sent when
1133
# the function is called
1134
def fixscope(func1, func2):
1135
"""This function is a scope container to pass
1136
func1 and func2 to the "call_both" function
1137
outside of its arguments"""
1138
def call_both(*args, **kwargs):
1139
"""This function will emit two D-Bus
1140
signals by calling func1 and func2"""
1141
func1(*args, **kwargs)
1142
func2(*args, **kwargs)
1144
# Create the "call_both" function and add it to
1146
attr[attrname] = fixscope(attribute, new_function)
1147
# Is this a D-Bus method?
1148
elif getattr(attribute, "_dbus_is_method", False):
1149
# Create a new, but exactly alike, function
1150
# object. Decorate it to be a new D-Bus method
1151
# with the alternate D-Bus interface name. Add it
1153
attr[attrname] = (dbus.service.method
1155
attribute._dbus_in_signature,
1156
attribute._dbus_out_signature)
1158
(attribute.func_code,
1159
attribute.func_globals,
1160
attribute.func_name,
1161
attribute.func_defaults,
1162
attribute.func_closure)))
1163
# Copy annotations, if any
1165
attr[attrname]._dbus_annotations = (
1166
dict(attribute._dbus_annotations))
1167
except AttributeError:
1169
# Is this a D-Bus property?
1170
elif getattr(attribute, "_dbus_is_property", False):
1171
# Create a new, but exactly alike, function
1172
# object, and decorate it to be a new D-Bus
1173
# property with the alternate D-Bus interface
1174
# name. Add it to the class.
1175
attr[attrname] = (dbus_service_property
1177
attribute._dbus_signature,
1178
attribute._dbus_access,
1180
._dbus_get_args_options
1183
(attribute.func_code,
1184
attribute.func_globals,
1185
attribute.func_name,
1186
attribute.func_defaults,
1187
attribute.func_closure)))
1188
# Copy annotations, if any
1190
attr[attrname]._dbus_annotations = (
1191
dict(attribute._dbus_annotations))
1192
except AttributeError:
1194
# Is this a D-Bus interface?
1195
elif getattr(attribute, "_dbus_is_interface", False):
1196
# Create a new, but exactly alike, function
1197
# object. Decorate it to be a new D-Bus interface
1198
# with the alternate D-Bus interface name. Add it
1200
attr[attrname] = (dbus_interface_annotations
1203
(attribute.func_code,
1204
attribute.func_globals,
1205
attribute.func_name,
1206
attribute.func_defaults,
1207
attribute.func_closure)))
1209
# Deprecate all alternate interfaces
1210
iname="_AlternateDBusNames_interface_annotation{}"
1211
for interface_name in interface_names:
1212
@dbus_interface_annotations(interface_name)
1214
return { "org.freedesktop.DBus.Deprecated":
1216
# Find an unused name
1217
for aname in (iname.format(i)
1218
for i in itertools.count()):
1219
if aname not in attr:
1223
# Replace the class with a new subclass of it with
1224
# methods, signals, etc. as created above.
1225
cls = type(b"{}Alternate".format(cls.__name__),
1231
@alternate_dbus_interfaces({"se.recompile.Mandos":
1232
"se.bsnet.fukt.Mandos"})
1233
class ClientDBus(Client, DBusObjectWithProperties):
1234
"""A Client class using D-Bus
1237
dbus_object_path: dbus.ObjectPath
1238
bus: dbus.SystemBus()
1241
runtime_expansions = (Client.runtime_expansions
1242
+ ("dbus_object_path",))
1244
# dbus.service.Object doesn't use super(), so we can't either.
1246
def __init__(self, bus = None, *args, **kwargs):
1248
Client.__init__(self, *args, **kwargs)
1249
# Only now, when this client is initialized, can it show up on
1251
client_object_name = unicode(self.name).translate(
1252
{ord("."): ord("_"),
1253
ord("-"): ord("_")})
1254
self.dbus_object_path = (dbus.ObjectPath
1255
("/clients/" + client_object_name))
1256
DBusObjectWithProperties.__init__(self, self.bus,
1257
self.dbus_object_path)
1259
def notifychangeproperty(transform_func,
1260
dbus_name, type_func=lambda x: x,
1262
""" Modify a variable so that it's a property which announces
1263
its changes to DBus.
1265
transform_fun: Function that takes a value and a variant_level
1266
and transforms it to a D-Bus type.
1267
dbus_name: D-Bus name of the variable
1268
type_func: Function that transform the value before sending it
1269
to the D-Bus. Default: no transform
1270
variant_level: D-Bus variant level. Default: 1
1272
attrname = "_{}".format(dbus_name)
1273
def setter(self, value):
1274
if hasattr(self, "dbus_object_path"):
1275
if (not hasattr(self, attrname) or
1276
type_func(getattr(self, attrname, None))
1277
!= type_func(value)):
1278
dbus_value = transform_func(type_func(value),
1281
self.PropertyChanged(dbus.String(dbus_name),
1283
setattr(self, attrname, value)
1285
return property(lambda self: getattr(self, attrname), setter)
1287
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1288
approvals_pending = notifychangeproperty(dbus.Boolean,
1291
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1292
last_enabled = notifychangeproperty(datetime_to_dbus,
1294
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1295
type_func = lambda checker:
1296
checker is not None)
1297
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1299
last_checker_status = notifychangeproperty(dbus.Int16,
1300
"LastCheckerStatus")
1301
last_approval_request = notifychangeproperty(
1302
datetime_to_dbus, "LastApprovalRequest")
1303
approved_by_default = notifychangeproperty(dbus.Boolean,
1304
"ApprovedByDefault")
1305
approval_delay = notifychangeproperty(dbus.UInt64,
1308
timedelta_to_milliseconds)
1309
approval_duration = notifychangeproperty(
1310
dbus.UInt64, "ApprovalDuration",
1311
type_func = timedelta_to_milliseconds)
1312
host = notifychangeproperty(dbus.String, "Host")
1313
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1315
timedelta_to_milliseconds)
1316
extended_timeout = notifychangeproperty(
1317
dbus.UInt64, "ExtendedTimeout",
1318
type_func = timedelta_to_milliseconds)
1319
interval = notifychangeproperty(dbus.UInt64,
1322
timedelta_to_milliseconds)
1323
checker_command = notifychangeproperty(dbus.String, "Checker")
1325
del notifychangeproperty
1327
def __del__(self, *args, **kwargs):
1329
self.remove_from_connection()
1332
if hasattr(DBusObjectWithProperties, "__del__"):
1333
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1334
Client.__del__(self, *args, **kwargs)
1336
def checker_callback(self, pid, condition, command,
1338
self.checker_callback_tag = None
1340
if os.WIFEXITED(condition):
1341
exitstatus = os.WEXITSTATUS(condition)
1343
self.CheckerCompleted(dbus.Int16(exitstatus),
1344
dbus.Int64(condition),
1345
dbus.String(command))
1348
self.CheckerCompleted(dbus.Int16(-1),
1349
dbus.Int64(condition),
1350
dbus.String(command))
1352
return Client.checker_callback(self, pid, condition, command,
1355
def start_checker(self, *args, **kwargs):
1356
old_checker_pid = getattr(self.checker, "pid", None)
1357
r = Client.start_checker(self, *args, **kwargs)
1358
# Only if new checker process was started
1359
if (self.checker is not None
1360
and old_checker_pid != self.checker.pid):
1362
self.CheckerStarted(self.current_checker_command)
1365
def _reset_approved(self):
1366
self.approved = None
1369
def approve(self, value=True):
1370
self.approved = value
1371
gobject.timeout_add(timedelta_to_milliseconds
1372
(self.approval_duration),
1373
self._reset_approved)
1374
self.send_changedstate()
1376
## D-Bus methods, signals & properties
1377
_interface = "se.recompile.Mandos.Client"
1381
@dbus_interface_annotations(_interface)
1383
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1388
# CheckerCompleted - signal
1389
@dbus.service.signal(_interface, signature="nxs")
1390
def CheckerCompleted(self, exitcode, waitstatus, command):
1394
# CheckerStarted - signal
1395
@dbus.service.signal(_interface, signature="s")
1396
def CheckerStarted(self, command):
1400
# PropertyChanged - signal
1401
@dbus.service.signal(_interface, signature="sv")
1402
def PropertyChanged(self, property, value):
1406
# GotSecret - signal
1407
@dbus.service.signal(_interface)
1408
def GotSecret(self):
1410
Is sent after a successful transfer of secret from the Mandos
1411
server to mandos-client
1416
@dbus.service.signal(_interface, signature="s")
1417
def Rejected(self, reason):
1421
# NeedApproval - signal
1422
@dbus.service.signal(_interface, signature="tb")
1423
def NeedApproval(self, timeout, default):
1425
return self.need_approval()
1430
@dbus.service.method(_interface, in_signature="b")
1431
def Approve(self, value):
1434
# CheckedOK - method
1435
@dbus.service.method(_interface)
1436
def CheckedOK(self):
1440
@dbus.service.method(_interface)
1445
# StartChecker - method
1446
@dbus.service.method(_interface)
1447
def StartChecker(self):
1449
self.start_checker()
1452
@dbus.service.method(_interface)
1457
# StopChecker - method
1458
@dbus.service.method(_interface)
1459
def StopChecker(self):
1464
# ApprovalPending - property
1465
@dbus_service_property(_interface, signature="b", access="read")
1466
def ApprovalPending_dbus_property(self):
1467
return dbus.Boolean(bool(self.approvals_pending))
1469
# ApprovedByDefault - property
1470
@dbus_service_property(_interface, signature="b",
1472
def ApprovedByDefault_dbus_property(self, value=None):
1473
if value is None: # get
1474
return dbus.Boolean(self.approved_by_default)
1475
self.approved_by_default = bool(value)
1477
# ApprovalDelay - property
1478
@dbus_service_property(_interface, signature="t",
1480
def ApprovalDelay_dbus_property(self, value=None):
1481
if value is None: # get
1482
return dbus.UInt64(self.approval_delay_milliseconds())
1483
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1485
# ApprovalDuration - property
1486
@dbus_service_property(_interface, signature="t",
1488
def ApprovalDuration_dbus_property(self, value=None):
1489
if value is None: # get
1490
return dbus.UInt64(timedelta_to_milliseconds(
1491
self.approval_duration))
1492
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1495
@dbus_service_property(_interface, signature="s", access="read")
1496
def Name_dbus_property(self):
1497
return dbus.String(self.name)
1499
# Fingerprint - property
1500
@dbus_service_property(_interface, signature="s", access="read")
1501
def Fingerprint_dbus_property(self):
1502
return dbus.String(self.fingerprint)
1505
@dbus_service_property(_interface, signature="s",
1507
def Host_dbus_property(self, value=None):
1508
if value is None: # get
1509
return dbus.String(self.host)
1510
self.host = unicode(value)
1512
# Created - property
1513
@dbus_service_property(_interface, signature="s", access="read")
1514
def Created_dbus_property(self):
1515
return datetime_to_dbus(self.created)
1517
# LastEnabled - property
1518
@dbus_service_property(_interface, signature="s", access="read")
1519
def LastEnabled_dbus_property(self):
1520
return datetime_to_dbus(self.last_enabled)
1522
# Enabled - property
1523
@dbus_service_property(_interface, signature="b",
1525
def Enabled_dbus_property(self, value=None):
1526
if value is None: # get
1527
return dbus.Boolean(self.enabled)
1533
# LastCheckedOK - property
1534
@dbus_service_property(_interface, signature="s",
1536
def LastCheckedOK_dbus_property(self, value=None):
1537
if value is not None:
1540
return datetime_to_dbus(self.last_checked_ok)
1542
# LastCheckerStatus - property
1543
@dbus_service_property(_interface, signature="n",
1545
def LastCheckerStatus_dbus_property(self):
1546
return dbus.Int16(self.last_checker_status)
1548
# Expires - property
1549
@dbus_service_property(_interface, signature="s", access="read")
1550
def Expires_dbus_property(self):
1551
return datetime_to_dbus(self.expires)
1553
# LastApprovalRequest - property
1554
@dbus_service_property(_interface, signature="s", access="read")
1555
def LastApprovalRequest_dbus_property(self):
1556
return datetime_to_dbus(self.last_approval_request)
1558
# Timeout - property
1559
@dbus_service_property(_interface, signature="t",
1561
def Timeout_dbus_property(self, value=None):
1562
if value is None: # get
1563
return dbus.UInt64(self.timeout_milliseconds())
1564
old_timeout = self.timeout
1565
self.timeout = datetime.timedelta(0, 0, 0, value)
1566
# Reschedule disabling
1568
now = datetime.datetime.utcnow()
1569
self.expires += self.timeout - old_timeout
1570
if self.expires <= now:
1571
# The timeout has passed
1574
if (getattr(self, "disable_initiator_tag", None)
1577
gobject.source_remove(self.disable_initiator_tag)
1578
self.disable_initiator_tag = (
1579
gobject.timeout_add(
1580
timedelta_to_milliseconds(self.expires - now),
1583
# ExtendedTimeout - property
1584
@dbus_service_property(_interface, signature="t",
1586
def ExtendedTimeout_dbus_property(self, value=None):
1587
if value is None: # get
1588
return dbus.UInt64(self.extended_timeout_milliseconds())
1589
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1591
# Interval - property
1592
@dbus_service_property(_interface, signature="t",
1594
def Interval_dbus_property(self, value=None):
1595
if value is None: # get
1596
return dbus.UInt64(self.interval_milliseconds())
1597
self.interval = datetime.timedelta(0, 0, 0, value)
1598
if getattr(self, "checker_initiator_tag", None) is None:
1601
# Reschedule checker run
1602
gobject.source_remove(self.checker_initiator_tag)
1603
self.checker_initiator_tag = (gobject.timeout_add
1604
(value, self.start_checker))
1605
self.start_checker() # Start one now, too
1607
# Checker - property
1608
@dbus_service_property(_interface, signature="s",
1610
def Checker_dbus_property(self, value=None):
1611
if value is None: # get
1612
return dbus.String(self.checker_command)
1613
self.checker_command = unicode(value)
1615
# CheckerRunning - property
1616
@dbus_service_property(_interface, signature="b",
1618
def CheckerRunning_dbus_property(self, value=None):
1619
if value is None: # get
1620
return dbus.Boolean(self.checker is not None)
1622
self.start_checker()
1626
# ObjectPath - property
1627
@dbus_service_property(_interface, signature="o", access="read")
1628
def ObjectPath_dbus_property(self):
1629
return self.dbus_object_path # is already a dbus.ObjectPath
1632
@dbus_service_property(_interface, signature="ay",
1633
access="write", byte_arrays=True)
1634
def Secret_dbus_property(self, value):
1635
self.secret = str(value)
1640
class ProxyClient(object):
1641
def __init__(self, child_pipe, fpr, address):
1642
self._pipe = child_pipe
1643
self._pipe.send(('init', fpr, address))
1644
if not self._pipe.recv():
1647
def __getattribute__(self, name):
1649
return super(ProxyClient, self).__getattribute__(name)
1650
self._pipe.send(('getattr', name))
1651
data = self._pipe.recv()
1652
if data[0] == 'data':
1654
if data[0] == 'function':
1655
def func(*args, **kwargs):
1656
self._pipe.send(('funcall', name, args, kwargs))
1657
return self._pipe.recv()[1]
1660
def __setattr__(self, name, value):
1662
return super(ProxyClient, self).__setattr__(name, value)
1663
self._pipe.send(('setattr', name, value))
1666
class ClientHandler(socketserver.BaseRequestHandler, object):
1667
"""A class to handle client connections.
1669
Instantiated once for each connection to handle it.
307
def still_valid(self, now=None):
308
"""Has the timeout not yet passed for this client?"""
310
now = datetime.datetime.now()
311
if self.last_seen is None:
312
return now < (self.created + self.timeout)
314
return now < (self.last_seen + self.timeout)
317
def peer_certificate(session):
318
"Return the peer's OpenPGP certificate as a bytestring"
319
# If not an OpenPGP certificate...
320
if gnutls.library.functions.gnutls_certificate_type_get\
321
(session._c_object) \
322
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
323
# ...do the normal thing
324
return session.peer_certificate
325
list_size = ctypes.c_uint()
326
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
327
(session._c_object, ctypes.byref(list_size))
328
if list_size.value == 0:
331
return ctypes.string_at(cert.data, cert.size)
334
def fingerprint(openpgp):
335
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
336
# New empty GnuTLS certificate
337
crt = gnutls.library.types.gnutls_openpgp_crt_t()
338
gnutls.library.functions.gnutls_openpgp_crt_init\
340
# New GnuTLS "datum" with the OpenPGP public key
341
datum = gnutls.library.types.gnutls_datum_t\
342
(ctypes.cast(ctypes.c_char_p(openpgp),
343
ctypes.POINTER(ctypes.c_ubyte)),
344
ctypes.c_uint(len(openpgp)))
345
# Import the OpenPGP public key into the certificate
346
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
349
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
350
# New buffer for the fingerprint
351
buffer = ctypes.create_string_buffer(20)
352
buffer_length = ctypes.c_size_t()
353
# Get the fingerprint from the certificate into the buffer
354
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
355
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
356
# Deinit the certificate
357
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
358
# Convert the buffer to a Python bytestring
359
fpr = ctypes.string_at(buffer, buffer_length.value)
360
# Convert the bytestring to hexadecimal notation
361
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
365
class tcp_handler(SocketServer.BaseRequestHandler, object):
366
"""A TCP request handler class.
367
Instantiated by IPv6_TCPServer for each request to handle it.
1670
368
Note: This will run in its own forked process."""
1672
370
def handle(self):
1673
with contextlib.closing(self.server.child_pipe) as child_pipe:
1674
logger.info("TCP connection from: %s",
1675
unicode(self.client_address))
1676
logger.debug("Pipe FD: %d",
1677
self.server.child_pipe.fileno())
1679
session = (gnutls.connection
1680
.ClientSession(self.request,
1682
.X509Credentials()))
1684
# Note: gnutls.connection.X509Credentials is really a
1685
# generic GnuTLS certificate credentials object so long as
1686
# no X.509 keys are added to it. Therefore, we can use it
1687
# here despite using OpenPGP certificates.
1689
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1690
# "+AES-256-CBC", "+SHA1",
1691
# "+COMP-NULL", "+CTYPE-OPENPGP",
1693
# Use a fallback default, since this MUST be set.
1694
priority = self.server.gnutls_priority
1695
if priority is None:
1697
(gnutls.library.functions
1698
.gnutls_priority_set_direct(session._c_object,
1701
# Start communication using the Mandos protocol
1702
# Get protocol number
1703
line = self.request.makefile().readline()
1704
logger.debug("Protocol version: %r", line)
1706
if int(line.strip().split()[0]) > 1:
1707
raise RuntimeError(line)
1708
except (ValueError, IndexError, RuntimeError) as error:
1709
logger.error("Unknown protocol version: %s", error)
1712
# Start GnuTLS connection
1715
except gnutls.errors.GNUTLSError as error:
1716
logger.warning("Handshake failed: %s", error)
1717
# Do not run session.bye() here: the session is not
1718
# established. Just abandon the request.
1720
logger.debug("Handshake succeeded")
1722
approval_required = False
1725
fpr = self.fingerprint(self.peer_certificate
1728
gnutls.errors.GNUTLSError) as error:
1729
logger.warning("Bad certificate: %s", error)
1731
logger.debug("Fingerprint: %s", fpr)
1734
client = ProxyClient(child_pipe, fpr,
1735
self.client_address)
1739
if client.approval_delay:
1740
delay = client.approval_delay
1741
client.approvals_pending += 1
1742
approval_required = True
1745
if not client.enabled:
1746
logger.info("Client %s is disabled",
1748
if self.server.use_dbus:
1750
client.Rejected("Disabled")
1753
if client.approved or not client.approval_delay:
1754
#We are approved or approval is disabled
1756
elif client.approved is None:
1757
logger.info("Client %s needs approval",
1759
if self.server.use_dbus:
1761
client.NeedApproval(
1762
client.approval_delay_milliseconds(),
1763
client.approved_by_default)
1765
logger.warning("Client %s was not approved",
1767
if self.server.use_dbus:
1769
client.Rejected("Denied")
1772
#wait until timeout or approved
1773
time = datetime.datetime.now()
1774
client.changedstate.acquire()
1775
client.changedstate.wait(
1776
float(timedelta_to_milliseconds(delay)
1778
client.changedstate.release()
1779
time2 = datetime.datetime.now()
1780
if (time2 - time) >= delay:
1781
if not client.approved_by_default:
1782
logger.warning("Client %s timed out while"
1783
" waiting for approval",
1785
if self.server.use_dbus:
1787
client.Rejected("Approval timed out")
1792
delay -= time2 - time
1795
while sent_size < len(client.secret):
1797
sent = session.send(client.secret[sent_size:])
1798
except gnutls.errors.GNUTLSError as error:
1799
logger.warning("gnutls send failed",
1802
logger.debug("Sent: %d, remaining: %d",
1803
sent, len(client.secret)
1804
- (sent_size + sent))
1807
logger.info("Sending secret to %s", client.name)
1808
# bump the timeout using extended_timeout
1809
client.bump_timeout(client.extended_timeout)
1810
if self.server.use_dbus:
1815
if approval_required:
1816
client.approvals_pending -= 1
1819
except gnutls.errors.GNUTLSError as error:
1820
logger.warning("GnuTLS bye failed",
1824
def peer_certificate(session):
1825
"Return the peer's OpenPGP certificate as a bytestring"
1826
# If not an OpenPGP certificate...
1827
if (gnutls.library.functions
1828
.gnutls_certificate_type_get(session._c_object)
1829
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1830
# ...do the normal thing
1831
return session.peer_certificate
1832
list_size = ctypes.c_uint(1)
1833
cert_list = (gnutls.library.functions
1834
.gnutls_certificate_get_peers
1835
(session._c_object, ctypes.byref(list_size)))
1836
if not bool(cert_list) and list_size.value != 0:
1837
raise gnutls.errors.GNUTLSError("error getting peer"
1839
if list_size.value == 0:
1842
return ctypes.string_at(cert.data, cert.size)
1845
def fingerprint(openpgp):
1846
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1847
# New GnuTLS "datum" with the OpenPGP public key
1848
datum = (gnutls.library.types
1849
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1852
ctypes.c_uint(len(openpgp))))
1853
# New empty GnuTLS certificate
1854
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1855
(gnutls.library.functions
1856
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1857
# Import the OpenPGP public key into the certificate
1858
(gnutls.library.functions
1859
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1860
gnutls.library.constants
1861
.GNUTLS_OPENPGP_FMT_RAW))
1862
# Verify the self signature in the key
1863
crtverify = ctypes.c_uint()
1864
(gnutls.library.functions
1865
.gnutls_openpgp_crt_verify_self(crt, 0,
1866
ctypes.byref(crtverify)))
1867
if crtverify.value != 0:
1868
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1869
raise (gnutls.errors.CertificateSecurityError
1871
# New buffer for the fingerprint
1872
buf = ctypes.create_string_buffer(20)
1873
buf_len = ctypes.c_size_t()
1874
# Get the fingerprint from the certificate into the buffer
1875
(gnutls.library.functions
1876
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1877
ctypes.byref(buf_len)))
1878
# Deinit the certificate
1879
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
# Convert the buffer to a Python bytestring
1881
fpr = ctypes.string_at(buf, buf_len.value)
1882
# Convert the bytestring to hexadecimal notation
1883
hex_fpr = binascii.hexlify(fpr).upper()
1887
class MultiprocessingMixIn(object):
1888
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1889
def sub_process_main(self, request, address):
1891
self.finish_request(request, address)
1893
self.handle_error(request, address)
1894
self.close_request(request)
1896
def process_request(self, request, address):
1897
"""Start a new process to process the request."""
1898
proc = multiprocessing.Process(target = self.sub_process_main,
1899
args = (request, address))
1904
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1905
""" adds a pipe to the MixIn """
1906
def process_request(self, request, client_address):
1907
"""Overrides and wraps the original process_request().
1909
This function creates a new pipe in self.pipe
1911
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1913
proc = MultiprocessingMixIn.process_request(self, request,
1915
self.child_pipe.close()
1916
self.add_pipe(parent_pipe, proc)
1918
def add_pipe(self, parent_pipe, proc):
1919
"""Dummy function; override as necessary"""
1920
raise NotImplementedError()
1923
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1924
socketserver.TCPServer, object):
1925
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
371
logger.debug(u"TCP connection from: %s",
372
unicode(self.client_address))
373
session = gnutls.connection.ClientSession(self.request,
377
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
378
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
380
priority = "SECURE256"
382
gnutls.library.functions.gnutls_priority_set_direct\
383
(session._c_object, priority, None);
387
except gnutls.errors.GNUTLSError, error:
388
logger.debug(u"Handshake failed: %s", error)
389
# Do not run session.bye() here: the session is not
390
# established. Just abandon the request.
393
fpr = fingerprint(peer_certificate(session))
394
except (TypeError, gnutls.errors.GNUTLSError), error:
395
logger.debug(u"Bad certificate: %s", error)
398
logger.debug(u"Fingerprint: %s", fpr)
400
for c in self.server.clients:
401
if c.fingerprint == fpr:
404
# Have to check if client.still_valid(), since it is possible
405
# that the client timed out while establishing the GnuTLS
407
if (not client) or (not client.still_valid()):
409
logger.debug(u"Client %(name)s is invalid",
412
logger.debug(u"Client not found for fingerprint: %s",
417
while sent_size < len(client.secret):
418
sent = session.send(client.secret[sent_size:])
419
logger.debug(u"Sent: %d, remaining: %d",
420
sent, len(client.secret)
421
- (sent_size + sent))
426
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
427
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1928
enabled: Boolean; whether this server is activated yet
1929
interface: None or a network interface name (string)
1930
use_ipv6: Boolean; to use IPv6 or not
429
options: Command line options
430
clients: Set() of Client objects
1932
def __init__(self, server_address, RequestHandlerClass,
1933
interface=None, use_ipv6=True, socketfd=None):
1934
"""If socketfd is set, use that file descriptor instead of
1935
creating a new one with socket.socket().
1937
self.interface = interface
1939
self.address_family = socket.AF_INET6
1940
if socketfd is not None:
1941
# Save the file descriptor
1942
self.socketfd = socketfd
1943
# Save the original socket.socket() function
1944
self.socket_socket = socket.socket
1945
# To implement --socket, we monkey patch socket.socket.
1947
# (When socketserver.TCPServer is a new-style class, we
1948
# could make self.socket into a property instead of monkey
1949
# patching socket.socket.)
1951
# Create a one-time-only replacement for socket.socket()
1952
@functools.wraps(socket.socket)
1953
def socket_wrapper(*args, **kwargs):
1954
# Restore original function so subsequent calls are
1956
socket.socket = self.socket_socket
1957
del self.socket_socket
1958
# This time only, return a new socket object from the
1959
# saved file descriptor.
1960
return socket.fromfd(self.socketfd, *args, **kwargs)
1961
# Replace socket.socket() function with wrapper
1962
socket.socket = socket_wrapper
1963
# The socketserver.TCPServer.__init__ will call
1964
# socket.socket(), which might be our replacement,
1965
# socket_wrapper(), if socketfd was set.
1966
socketserver.TCPServer.__init__(self, server_address,
1967
RequestHandlerClass)
432
address_family = socket.AF_INET6
433
def __init__(self, *args, **kwargs):
434
if "options" in kwargs:
435
self.options = kwargs["options"]
436
del kwargs["options"]
437
if "clients" in kwargs:
438
self.clients = kwargs["clients"]
439
del kwargs["clients"]
440
return super(type(self), self).__init__(*args, **kwargs)
1969
441
def server_bind(self):
1970
442
"""This overrides the normal server_bind() function
1971
443
to bind to an interface if one was specified, and also NOT to
1972
444
bind to an address or port if they were not specified."""
1973
if self.interface is not None:
1974
if SO_BINDTODEVICE is None:
1975
logger.error("SO_BINDTODEVICE does not exist;"
1976
" cannot bind to interface %s",
1980
self.socket.setsockopt(socket.SOL_SOCKET,
1982
str(self.interface + '\0'))
1983
except socket.error as error:
1984
if error.errno == errno.EPERM:
1985
logger.error("No permission to bind to"
1986
" interface %s", self.interface)
1987
elif error.errno == errno.ENOPROTOOPT:
1988
logger.error("SO_BINDTODEVICE not available;"
1989
" cannot bind to interface %s",
1991
elif error.errno == errno.ENODEV:
1992
logger.error("Interface %s does not exist,"
1993
" cannot bind", self.interface)
445
if self.options.interface:
446
if not hasattr(socket, "SO_BINDTODEVICE"):
447
# From /usr/include/asm-i486/socket.h
448
socket.SO_BINDTODEVICE = 25
450
self.socket.setsockopt(socket.SOL_SOCKET,
451
socket.SO_BINDTODEVICE,
452
self.options.interface)
453
except socket.error, error:
454
if error[0] == errno.EPERM:
455
logger.warning(u"No permission to"
456
u" bind to interface %s",
457
self.options.interface)
1996
460
# Only bind(2) the socket if we really need to.
1997
461
if self.server_address[0] or self.server_address[1]:
1998
462
if not self.server_address[0]:
1999
if self.address_family == socket.AF_INET6:
2000
any_address = "::" # in6addr_any
2002
any_address = "0.0.0.0" # INADDR_ANY
2003
self.server_address = (any_address,
464
self.server_address = (in6addr_any,
2004
465
self.server_address[1])
2005
elif not self.server_address[1]:
466
elif self.server_address[1] is None:
2006
467
self.server_address = (self.server_address[0],
2008
# if self.interface:
2009
# self.server_address = (self.server_address[0],
2014
return socketserver.TCPServer.server_bind(self)
2017
class MandosServer(IPv6_TCPServer):
2021
clients: set of Client objects
2022
gnutls_priority GnuTLS priority string
2023
use_dbus: Boolean; to emit D-Bus signals or not
2025
Assumes a gobject.MainLoop event loop.
2027
def __init__(self, server_address, RequestHandlerClass,
2028
interface=None, use_ipv6=True, clients=None,
2029
gnutls_priority=None, use_dbus=True, socketfd=None):
2030
self.enabled = False
2031
self.clients = clients
2032
if self.clients is None:
2034
self.use_dbus = use_dbus
2035
self.gnutls_priority = gnutls_priority
2036
IPv6_TCPServer.__init__(self, server_address,
2037
RequestHandlerClass,
2038
interface = interface,
2039
use_ipv6 = use_ipv6,
2040
socketfd = socketfd)
2041
def server_activate(self):
2043
return socketserver.TCPServer.server_activate(self)
2048
def add_pipe(self, parent_pipe, proc):
2049
# Call "handle_ipc" for both data and EOF events
2050
gobject.io_add_watch(parent_pipe.fileno(),
2051
gobject.IO_IN | gobject.IO_HUP,
2052
functools.partial(self.handle_ipc,
2057
def handle_ipc(self, source, condition, parent_pipe=None,
2058
proc = None, client_object=None):
2059
# error, or the other end of multiprocessing.Pipe has closed
2060
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2061
# Wait for other process to exit
2065
# Read a request from the child
2066
request = parent_pipe.recv()
2067
command = request[0]
2069
if command == 'init':
2071
address = request[2]
2073
for c in self.clients.itervalues():
2074
if c.fingerprint == fpr:
2078
logger.info("Client not found for fingerprint: %s, ad"
2079
"dress: %s", fpr, address)
2082
mandos_dbus_service.ClientNotFound(fpr,
2084
parent_pipe.send(False)
2087
gobject.io_add_watch(parent_pipe.fileno(),
2088
gobject.IO_IN | gobject.IO_HUP,
2089
functools.partial(self.handle_ipc,
2095
parent_pipe.send(True)
2096
# remove the old hook in favor of the new above hook on
2099
if command == 'funcall':
2100
funcname = request[1]
2104
parent_pipe.send(('data', getattr(client_object,
2108
if command == 'getattr':
2109
attrname = request[1]
2110
if callable(client_object.__getattribute__(attrname)):
2111
parent_pipe.send(('function',))
2113
parent_pipe.send(('data', client_object
2114
.__getattribute__(attrname)))
2116
if command == 'setattr':
2117
attrname = request[1]
2119
setattr(client_object, attrname, value)
2124
def rfc3339_duration_to_delta(duration):
2125
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2127
>>> rfc3339_duration_to_delta("P7D")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT60S")
2130
datetime.timedelta(0, 60)
2131
>>> rfc3339_duration_to_delta("PT60M")
2132
datetime.timedelta(0, 3600)
2133
>>> rfc3339_duration_to_delta("PT24H")
2134
datetime.timedelta(1)
2135
>>> rfc3339_duration_to_delta("P1W")
2136
datetime.timedelta(7)
2137
>>> rfc3339_duration_to_delta("PT5M30S")
2138
datetime.timedelta(0, 330)
2139
>>> rfc3339_duration_to_delta("P1DT3M20S")
2140
datetime.timedelta(1, 200)
2143
# Parsing an RFC 3339 duration with regular expressions is not
2144
# possible - there would have to be multiple places for the same
2145
# values, like seconds. The current code, while more esoteric, is
2146
# cleaner without depending on a parsing library. If Python had a
2147
# built-in library for parsing we would use it, but we'd like to
2148
# avoid excessive use of external libraries.
2150
# New type for defining tokens, syntax, and semantics all-in-one
2151
Token = collections.namedtuple("Token",
2152
("regexp", # To match token; if
2153
# "value" is not None,
2154
# must have a "group"
2156
"value", # datetime.timedelta or
2158
"followers")) # Tokens valid after
2160
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2161
# the "duration" ABNF definition in RFC 3339, Appendix A.
2162
token_end = Token(re.compile(r"$"), None, frozenset())
2163
token_second = Token(re.compile(r"(\d+)S"),
2164
datetime.timedelta(seconds=1),
2165
frozenset((token_end,)))
2166
token_minute = Token(re.compile(r"(\d+)M"),
2167
datetime.timedelta(minutes=1),
2168
frozenset((token_second, token_end)))
2169
token_hour = Token(re.compile(r"(\d+)H"),
2170
datetime.timedelta(hours=1),
2171
frozenset((token_minute, token_end)))
2172
token_time = Token(re.compile(r"T"),
2174
frozenset((token_hour, token_minute,
2176
token_day = Token(re.compile(r"(\d+)D"),
2177
datetime.timedelta(days=1),
2178
frozenset((token_time, token_end)))
2179
token_month = Token(re.compile(r"(\d+)M"),
2180
datetime.timedelta(weeks=4),
2181
frozenset((token_day, token_end)))
2182
token_year = Token(re.compile(r"(\d+)Y"),
2183
datetime.timedelta(weeks=52),
2184
frozenset((token_month, token_end)))
2185
token_week = Token(re.compile(r"(\d+)W"),
2186
datetime.timedelta(weeks=1),
2187
frozenset((token_end,)))
2188
token_duration = Token(re.compile(r"P"), None,
2189
frozenset((token_year, token_month,
2190
token_day, token_time,
2192
# Define starting values
2193
value = datetime.timedelta() # Value so far
2195
followers = frozenset((token_duration,)) # Following valid tokens
2196
s = duration # String left to parse
2197
# Loop until end token is found
2198
while found_token is not token_end:
2199
# Search for any currently valid tokens
2200
for token in followers:
2201
match = token.regexp.match(s)
2202
if match is not None:
2204
if token.value is not None:
2205
# Value found, parse digits
2206
factor = int(match.group(1), 10)
2207
# Add to value so far
2208
value += factor * token.value
2209
# Strip token from string
2210
s = token.regexp.sub("", s, 1)
2213
# Set valid next tokens
2214
followers = found_token.followers
2217
# No currently valid tokens were found
2218
raise ValueError("Invalid RFC 3339 duration")
469
return super(type(self), self).server_bind()
2223
472
def string_to_delta(interval):
2224
473
"""Parse a string and return a datetime.timedelta
2226
475
>>> string_to_delta('7d')
2227
476
datetime.timedelta(7)
2228
477
>>> string_to_delta('60s')
616
def killme(status = 0):
617
logger.debug("Stopping server with exit status %d", status)
619
if main_loop_started:
2295
##################################################################
2296
# Parsing of options, both command line and config file
2298
parser = argparse.ArgumentParser()
2299
parser.add_argument("-v", "--version", action="version",
2300
version = "%(prog)s {}".format(version),
2301
help="show version number and exit")
2302
parser.add_argument("-i", "--interface", metavar="IF",
2303
help="Bind to interface IF")
2304
parser.add_argument("-a", "--address",
2305
help="Address to listen for requests on")
2306
parser.add_argument("-p", "--port", type=int,
2307
help="Port number to receive requests on")
2308
parser.add_argument("--check", action="store_true",
2309
help="Run self-test")
2310
parser.add_argument("--debug", action="store_true",
2311
help="Debug mode; run in foreground and log"
2312
" to terminal", default=None)
2313
parser.add_argument("--debuglevel", metavar="LEVEL",
2314
help="Debug level for stdout output")
2315
parser.add_argument("--priority", help="GnuTLS"
2316
" priority string (see GnuTLS documentation)")
2317
parser.add_argument("--servicename",
2318
metavar="NAME", help="Zeroconf service name")
2319
parser.add_argument("--configdir",
2320
default="/etc/mandos", metavar="DIR",
2321
help="Directory to search for configuration"
2323
parser.add_argument("--no-dbus", action="store_false",
2324
dest="use_dbus", help="Do not provide D-Bus"
2325
" system bus interface", default=None)
2326
parser.add_argument("--no-ipv6", action="store_false",
2327
dest="use_ipv6", help="Do not use IPv6",
2329
parser.add_argument("--no-restore", action="store_false",
2330
dest="restore", help="Do not restore stored"
2331
" state", default=None)
2332
parser.add_argument("--socket", type=int,
2333
help="Specify a file descriptor to a network"
2334
" socket to use instead of creating one")
2335
parser.add_argument("--statedir", metavar="DIR",
2336
help="Directory to save/restore state in")
2337
parser.add_argument("--foreground", action="store_true",
2338
help="Run in foreground", default=None)
2339
parser.add_argument("--no-zeroconf", action="store_false",
2340
dest="zeroconf", help="Do not use Zeroconf",
2343
options = parser.parse_args()
628
global main_loop_started
629
main_loop_started = False
631
parser = OptionParser()
632
parser.add_option("-i", "--interface", type="string",
633
default=None, metavar="IF",
634
help="Bind to interface IF")
635
parser.add_option("-a", "--address", type="string", default=None,
636
help="Address to listen for requests on")
637
parser.add_option("-p", "--port", type="int", default=None,
638
help="Port number to receive requests on")
639
parser.add_option("--timeout", type="string", # Parsed later
641
help="Amount of downtime allowed for clients")
642
parser.add_option("--interval", type="string", # Parsed later
644
help="How often to check that a client is up")
645
parser.add_option("--check", action="store_true", default=False,
646
help="Run self-test")
647
parser.add_option("--debug", action="store_true", default=False,
649
(options, args) = parser.parse_args()
2345
651
if options.check:
2347
fail_count, test_count = doctest.testmod()
2348
sys.exit(os.EX_OK if fail_count == 0 else 1)
2350
# Default values for config file for server-global settings
2351
server_defaults = { "interface": "",
2356
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2357
"servicename": "Mandos",
2363
"statedir": "/var/lib/mandos",
2364
"foreground": "False",
2368
# Parse config file for server-global settings
2369
server_config = configparser.SafeConfigParser(server_defaults)
2371
server_config.read(os.path.join(options.configdir,
2373
# Convert the SafeConfigParser object to a dict
2374
server_settings = server_config.defaults()
2375
# Use the appropriate methods on the non-string config options
2376
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2377
server_settings[option] = server_config.getboolean("DEFAULT",
2379
if server_settings["port"]:
2380
server_settings["port"] = server_config.getint("DEFAULT",
2382
if server_settings["socket"]:
2383
server_settings["socket"] = server_config.getint("DEFAULT",
2385
# Later, stdin will, and stdout and stderr might, be dup'ed
2386
# over with an opened os.devnull. But we don't want this to
2387
# happen with a supplied network socket.
2388
if 0 <= server_settings["socket"] <= 2:
2389
server_settings["socket"] = os.dup(server_settings
2393
# Override the settings from the config file with command line
2395
for option in ("interface", "address", "port", "debug",
2396
"priority", "servicename", "configdir",
2397
"use_dbus", "use_ipv6", "debuglevel", "restore",
2398
"statedir", "socket", "foreground", "zeroconf"):
2399
value = getattr(options, option)
2400
if value is not None:
2401
server_settings[option] = value
2403
# Force all strings to be unicode
2404
for option in server_settings.keys():
2405
if type(server_settings[option]) is str:
2406
server_settings[option] = unicode(server_settings[option])
2407
# Force all boolean options to be boolean
2408
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2409
"foreground", "zeroconf"):
2410
server_settings[option] = bool(server_settings[option])
2411
# Debug implies foreground
2412
if server_settings["debug"]:
2413
server_settings["foreground"] = True
2414
# Now we have our good server settings in "server_settings"
2416
##################################################################
2418
if (not server_settings["zeroconf"] and
2419
not (server_settings["port"]
2420
or server_settings["socket"] != "")):
2421
parser.error("Needs port or socket to work without"
2425
debug = server_settings["debug"]
2426
debuglevel = server_settings["debuglevel"]
2427
use_dbus = server_settings["use_dbus"]
2428
use_ipv6 = server_settings["use_ipv6"]
2429
stored_state_path = os.path.join(server_settings["statedir"],
2431
foreground = server_settings["foreground"]
2432
zeroconf = server_settings["zeroconf"]
2435
initlogger(debug, logging.DEBUG)
2440
level = getattr(logging, debuglevel.upper())
2441
initlogger(debug, level)
2443
if server_settings["servicename"] != "Mandos":
2444
syslogger.setFormatter(logging.Formatter
2445
('Mandos ({}) [%(process)d]:'
2446
' %(levelname)s: %(message)s'
2447
.format(server_settings
2450
# Parse config file with clients
2451
client_config = configparser.SafeConfigParser(Client
2453
client_config.read(os.path.join(server_settings["configdir"],
2456
global mandos_dbus_service
2457
mandos_dbus_service = None
2460
if server_settings["socket"] != "":
2461
socketfd = server_settings["socket"]
2462
tcp_server = MandosServer((server_settings["address"],
2463
server_settings["port"]),
2465
interface=(server_settings["interface"]
2469
server_settings["priority"],
2473
pidfilename = "/run/mandos.pid"
2474
if not os.path.isdir("/run/."):
2475
pidfilename = "/var/run/mandos.pid"
2478
pidfile = open(pidfilename, "w")
2479
except IOError as e:
2480
logger.error("Could not open file %r", pidfilename,
2483
for name in ("_mandos", "mandos", "nobody"):
2485
uid = pwd.getpwnam(name).pw_uid
2486
gid = pwd.getpwnam(name).pw_gid
2496
except OSError as error:
2497
if error.errno != errno.EPERM:
2501
# Enable all possible GnuTLS debugging
2503
# "Use a log level over 10 to enable all debugging options."
2505
gnutls.library.functions.gnutls_global_set_log_level(11)
2507
@gnutls.library.types.gnutls_log_func
2508
def debug_gnutls(level, string):
2509
logger.debug("GnuTLS: %s", string[:-1])
2511
(gnutls.library.functions
2512
.gnutls_global_set_log_function(debug_gnutls))
2514
# Redirect stdin so all checkers get /dev/null
2515
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2516
os.dup2(null, sys.stdin.fileno())
2520
# Need to fork before connecting to D-Bus
2522
# Close all input and output, do double fork, etc.
2525
# multiprocessing will use threads, so before we use gobject we
2526
# need to inform gobject that threads will be used.
2527
gobject.threads_init()
656
# Parse the time arguments
658
options.timeout = string_to_delta(options.timeout)
660
parser.error("option --timeout: Unparseable time")
662
options.interval = string_to_delta(options.interval)
664
parser.error("option --interval: Unparseable time")
667
defaults = { "checker": "fping -q -- %%(fqdn)s" }
668
client_config = ConfigParser.SafeConfigParser(defaults)
669
#client_config.readfp(open("global.conf"), "global.conf")
670
client_config.read("mandos-clients.conf")
2529
672
global main_loop
2530
675
# From the Avahi example code
2531
DBusGMainLoop(set_as_default=True)
676
DBusGMainLoop(set_as_default=True )
2532
677
main_loop = gobject.MainLoop()
2533
678
bus = dbus.SystemBus()
679
server = dbus.Interface(
680
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
681
avahi.DBUS_INTERFACE_SERVER )
2534
682
# End of Avahi example code
2537
bus_name = dbus.service.BusName("se.recompile.Mandos",
2538
bus, do_not_queue=True)
2539
old_bus_name = (dbus.service.BusName
2540
("se.bsnet.fukt.Mandos", bus,
2542
except dbus.exceptions.NameExistsException as e:
2543
logger.error("Disabling D-Bus:", exc_info=e)
2545
server_settings["use_dbus"] = False
2546
tcp_server.use_dbus = False
2548
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2549
service = AvahiServiceToSyslog(name =
2550
server_settings["servicename"],
2551
servicetype = "_mandos._tcp",
2552
protocol = protocol, bus = bus)
2553
if server_settings["interface"]:
2554
service.interface = (if_nametoindex
2555
(str(server_settings["interface"])))
2557
global multiprocessing_manager
2558
multiprocessing_manager = multiprocessing.Manager()
2560
client_class = Client
2562
client_class = functools.partial(ClientDBus, bus = bus)
2564
client_settings = Client.config_parser(client_config)
2565
old_client_settings = {}
2568
# This is used to redirect stdout and stderr for checker processes
2570
wnull = open(os.devnull, "w") # A writable /dev/null
2571
# Only used if server is running in foreground but not in debug
2573
if debug or not foreground:
2576
# Get client data and settings from last running state.
2577
if server_settings["restore"]:
2579
with open(stored_state_path, "rb") as stored_state:
2580
clients_data, old_client_settings = (pickle.load
2582
os.remove(stored_state_path)
2583
except IOError as e:
2584
if e.errno == errno.ENOENT:
2585
logger.warning("Could not load persistent state: {}"
2586
.format(os.strerror(e.errno)))
2588
logger.critical("Could not load persistent state:",
2591
except EOFError as e:
2592
logger.warning("Could not load persistent state: "
2593
"EOFError:", exc_info=e)
2595
with PGPEngine() as pgp:
2596
for client_name, client in clients_data.items():
2597
# Skip removed clients
2598
if client_name not in client_settings:
2601
# Decide which value to use after restoring saved state.
2602
# We have three different values: Old config file,
2603
# new config file, and saved state.
2604
# New config value takes precedence if it differs from old
2605
# config value, otherwise use saved state.
2606
for name, value in client_settings[client_name].items():
2608
# For each value in new config, check if it
2609
# differs from the old config value (Except for
2610
# the "secret" attribute)
2611
if (name != "secret" and
2612
value != old_client_settings[client_name]
2614
client[name] = value
2618
# Clients who has passed its expire date can still be
2619
# enabled if its last checker was successful. Clients
2620
# whose checker succeeded before we stored its state is
2621
# assumed to have successfully run all checkers during
2623
if client["enabled"]:
2624
if datetime.datetime.utcnow() >= client["expires"]:
2625
if not client["last_checked_ok"]:
2627
"disabling client {} - Client never "
2628
"performed a successful checker"
2629
.format(client_name))
2630
client["enabled"] = False
2631
elif client["last_checker_status"] != 0:
2633
"disabling client {} - Client last"
2634
" checker failed with error code {}"
2635
.format(client_name,
2636
client["last_checker_status"]))
2637
client["enabled"] = False
2639
client["expires"] = (datetime.datetime
2641
+ client["timeout"])
2642
logger.debug("Last checker succeeded,"
2643
" keeping {} enabled"
2644
.format(client_name))
2646
client["secret"] = (
2647
pgp.decrypt(client["encrypted_secret"],
2648
client_settings[client_name]
2651
# If decryption fails, we use secret from new settings
2652
logger.debug("Failed to decrypt {} old secret"
2653
.format(client_name))
2654
client["secret"] = (
2655
client_settings[client_name]["secret"])
2657
# Add/remove clients based on new changes made to config
2658
for client_name in (set(old_client_settings)
2659
- set(client_settings)):
2660
del clients_data[client_name]
2661
for client_name in (set(client_settings)
2662
- set(old_client_settings)):
2663
clients_data[client_name] = client_settings[client_name]
2665
# Create all client objects
2666
for client_name, client in clients_data.items():
2667
tcp_server.clients[client_name] = client_class(
2668
name = client_name, settings = client,
2669
server_settings = server_settings)
2671
if not tcp_server.clients:
2672
logger.warning("No clients defined")
2675
if pidfile is not None:
2679
pidfile.write(str(pid) + "\n".encode("utf-8"))
2681
logger.error("Could not write to file %r with PID %d",
2686
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2687
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2690
@alternate_dbus_interfaces({"se.recompile.Mandos":
2691
"se.bsnet.fukt.Mandos"})
2692
class MandosDBusService(DBusObjectWithProperties):
2693
"""A D-Bus proxy object"""
2695
dbus.service.Object.__init__(self, bus, "/")
2696
_interface = "se.recompile.Mandos"
2698
@dbus_interface_annotations(_interface)
2700
return { "org.freedesktop.DBus.Property"
2701
".EmitsChangedSignal":
2704
@dbus.service.signal(_interface, signature="o")
2705
def ClientAdded(self, objpath):
2709
@dbus.service.signal(_interface, signature="ss")
2710
def ClientNotFound(self, fingerprint, address):
2714
@dbus.service.signal(_interface, signature="os")
2715
def ClientRemoved(self, objpath, name):
2719
@dbus.service.method(_interface, out_signature="ao")
2720
def GetAllClients(self):
2722
return dbus.Array(c.dbus_object_path
2724
tcp_server.clients.itervalues())
2726
@dbus.service.method(_interface,
2727
out_signature="a{oa{sv}}")
2728
def GetAllClientsWithProperties(self):
2730
return dbus.Dictionary(
2731
((c.dbus_object_path, c.GetAll(""))
2732
for c in tcp_server.clients.itervalues()),
2735
@dbus.service.method(_interface, in_signature="o")
2736
def RemoveClient(self, object_path):
2738
for c in tcp_server.clients.itervalues():
2739
if c.dbus_object_path == object_path:
2740
del tcp_server.clients[c.name]
2741
c.remove_from_connection()
2742
# Don't signal anything except ClientRemoved
2743
c.disable(quiet=True)
2745
self.ClientRemoved(object_path, c.name)
2747
raise KeyError(object_path)
2751
mandos_dbus_service = MandosDBusService()
684
debug = options.debug
687
console = logging.StreamHandler()
688
# console.setLevel(logging.DEBUG)
689
console.setFormatter(logging.Formatter\
690
('%(levelname)s: %(message)s'))
691
logger.addHandler(console)
695
def remove_from_clients(client):
696
clients.remove(client)
698
logger.debug(u"No clients left, exiting")
701
clients.update(Set(Client(name=section, options=options,
702
stop_hook = remove_from_clients,
703
**(dict(client_config\
705
for section in client_config.sections()))
2754
711
"Cleanup function; run on exit"
2758
multiprocessing.active_children()
2760
if not (tcp_server.clients or client_settings):
2763
# Store client before exiting. Secrets are encrypted with key
2764
# based on what config file has. If config file is
2765
# removed/edited, old secret will thus be unrecovable.
2767
with PGPEngine() as pgp:
2768
for client in tcp_server.clients.itervalues():
2769
key = client_settings[client.name]["secret"]
2770
client.encrypted_secret = pgp.encrypt(client.secret,
2774
# A list of attributes that can not be pickled
2776
exclude = { "bus", "changedstate", "secret",
2777
"checker", "server_settings" }
2778
for name, typ in (inspect.getmembers
2779
(dbus.service.Object)):
2782
client_dict["encrypted_secret"] = (client
2784
for attr in client.client_structure:
2785
if attr not in exclude:
2786
client_dict[attr] = getattr(client, attr)
2788
clients[client.name] = client_dict
2789
del client_settings[client.name]["secret"]
2792
with (tempfile.NamedTemporaryFile
2793
(mode='wb', suffix=".pickle", prefix='clients-',
2794
dir=os.path.dirname(stored_state_path),
2795
delete=False)) as stored_state:
2796
pickle.dump((clients, client_settings), stored_state)
2797
tempname=stored_state.name
2798
os.rename(tempname, stored_state_path)
2799
except (IOError, OSError) as e:
2805
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2806
logger.warning("Could not save persistent state: {}"
2807
.format(os.strerror(e.errno)))
2809
logger.warning("Could not save persistent state:",
2813
# Delete all clients, and settings from config
2814
while tcp_server.clients:
2815
name, client = tcp_server.clients.popitem()
2817
client.remove_from_connection()
2818
# Don't signal anything except ClientRemoved
2819
client.disable(quiet=True)
2822
mandos_dbus_service.ClientRemoved(client
2825
client_settings.clear()
713
# From the Avahi example code
714
if not group is None:
717
# End of Avahi example code
720
client = clients.pop()
721
client.stop_hook = None
2827
724
atexit.register(cleanup)
2829
for client in tcp_server.clients.itervalues():
2832
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2833
# Need to initiate checking of clients
2835
client.init_checker()
2838
tcp_server.server_activate()
2840
# Find out what port we got
2842
service.port = tcp_server.socket.getsockname()[1]
2844
logger.info("Now listening on address %r, port %d,"
2845
" flowinfo %d, scope_id %d",
2846
*tcp_server.socket.getsockname())
2848
logger.info("Now listening on address %r, port %d",
2849
*tcp_server.socket.getsockname())
2851
#service.interface = tcp_server.socket.getsockname()[3]
2855
# From the Avahi example code
2858
except dbus.exceptions.DBusException as error:
2859
logger.critical("D-Bus Exception", exc_info=error)
2862
# End of Avahi example code
2864
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2865
lambda *args, **kwargs:
2866
(tcp_server.handle_request
2867
(*args[2:], **kwargs) or True))
727
signal.signal(signal.SIGINT, signal.SIG_IGN)
728
signal.signal(signal.SIGHUP, lambda signum, frame: killme())
729
signal.signal(signal.SIGTERM, lambda signum, frame: killme())
731
for client in clients:
734
tcp_server = IPv6_TCPServer((options.address, options.port),
738
# Find out what random port we got
740
servicePort = tcp_server.socket.getsockname()[1]
741
logger.debug(u"Now listening on port %d", servicePort)
743
if options.interface is not None:
744
global serviceInterface
745
serviceInterface = if_nametoindex(options.interface)
747
# From the Avahi example code
748
server.connect_to_signal("StateChanged", server_state_changed)
750
server_state_changed(server.GetState())
751
except dbus.exceptions.DBusException, error:
752
logger.critical(u"DBusException: %s", error)
754
# End of Avahi example code
756
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
757
lambda *args, **kwargs:
758
tcp_server.handle_request(*args[2:],
2869
761
logger.debug("Starting main loop")
762
main_loop_started = True
2871
except AvahiError as error:
2872
logger.critical("Avahi Error", exc_info=error)
2875
764
except KeyboardInterrupt:
2877
print("", file=sys.stderr)
2878
logger.debug("Server received KeyboardInterrupt")
2879
logger.debug("Server exiting")
2880
# Must run before the D-Bus bus name gets deregistered
2883
770
if __name__ == '__main__':