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