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