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