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