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