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