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