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