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-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 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.13"
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")
1460
1058
exc_info=error)
1461
1059
return xmlstring
1462
1060
1463
try:
1464
dbus.OBJECT_MANAGER_IFACE
1465
except AttributeError:
1466
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1467
1468
1469
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1470
"""A D-Bus object with an ObjectManager.
1471
1472
Classes inheriting from this exposes the standard
1473
GetManagedObjects call and the InterfacesAdded and
1474
InterfacesRemoved signals on the standard
1475
"org.freedesktop.DBus.ObjectManager" interface.
1476
1477
Note: No signals are sent automatically; they must be sent
1478
manually.
1479
"""
1480
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1481
out_signature="a{oa{sa{sv}}}")
1482
def GetManagedObjects(self):
1483
"""This function must be overridden"""
1484
raise NotImplementedError()
1485
1486
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1487
signature="oa{sa{sv}}")
1488
def InterfacesAdded(self, object_path, interfaces_and_properties):
1489
pass
1490
1491
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1492
def InterfacesRemoved(self, object_path, interfaces):
1493
pass
1494
1495
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1496
out_signature="s",
1497
path_keyword='object_path',
1498
connection_keyword='connection')
1499
def Introspect(self, object_path, connection):
1500
"""Overloading of standard D-Bus method.
1501
1502
Override return argument name of GetManagedObjects to be
1503
"objpath_interfaces_and_properties"
1504
"""
1505
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1506
object_path,
1507
connection)
1508
try:
1509
document = xml.dom.minidom.parseString(xmlstring)
1510
1511
for if_tag in document.getElementsByTagName("interface"):
1512
# Fix argument name for the GetManagedObjects method
1513
if (if_tag.getAttribute("name")
1514
== dbus.OBJECT_MANAGER_IFACE):
1515
for cn in if_tag.getElementsByTagName("method"):
1516
if (cn.getAttribute("name")
1517
== "GetManagedObjects"):
1518
for arg in cn.getElementsByTagName("arg"):
1519
if (arg.getAttribute("direction")
1520
== "out"):
1521
arg.setAttribute(
1522
"name",
1523
"objpath_interfaces"
1524
"_and_properties")
1525
xmlstring = document.toxml("utf-8")
1526
document.unlink()
1527
except (AttributeError, xml.dom.DOMException,
1528
xml.parsers.expat.ExpatError) as error:
1529
logger.error("Failed to override Introspection method",
1530
exc_info=error)
1531
return xmlstring
1532
1533
1061
1534
1062
def datetime_to_dbus(dt, variant_level=0):
1535
1063
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1536
1064
if dt is None:
1537
return dbus.String("", variant_level=variant_level)
1065
return dbus.String("", variant_level = variant_level)
1538
1066
return dbus.String(dt.isoformat(), variant_level=variant_level)
1539
1067
1540
1068
1543
1071
dbus.service.Object, it will add alternate D-Bus attributes with
1544
1072
interface names according to the "alt_interface_names" mapping.
1545
1073
Usage:
1546
1074
1547
1075
@alternate_dbus_interfaces({"org.example.Interface":
1548
1076
"net.example.AlternateInterface"})
1549
1077
class SampleDBusObject(dbus.service.Object):
1550
1078
@dbus.service.method("org.example.Interface")
1551
1079
def SampleDBusMethod():
1552
1080
pass
1553
1081
1554
1082
The above "SampleDBusMethod" on "SampleDBusObject" will be
1555
1083
reachable via two interfaces: "org.example.Interface" and
1556
1084
"net.example.AlternateInterface", the latter of which will have
1557
1085
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1558
1086
"true", unless "deprecate" is passed with a False value.
1559
1087
1560
1088
This works for methods and signals, and also for D-Bus properties
1561
1089
(from DBusObjectWithProperties) and interfaces (from the
1562
1090
dbus_interface_annotations decorator).
1563
1091
"""
1564
1092
1565
1093
def wrapper(cls):
1566
1094
for orig_interface_name, alt_interface_name in (
1567
1095
alt_interface_names.items()):
1582
1110
interface_names.add(alt_interface)
1583
1111
# Is this a D-Bus signal?
1584
1112
if getattr(attribute, "_dbus_is_signal", False):
1585
# Extract the original non-method undecorated
1586
# function by black magic
1587
1113
if sys.version_info.major == 2:
1114
# Extract the original non-method undecorated
1115
# function by black magic
1588
1116
nonmethod_func = (dict(
1589
1117
zip(attribute.func_code.co_freevars,
1590
1118
attribute.__closure__))
1591
1119
["func"].cell_contents)
1592
1120
else:
1593
nonmethod_func = (dict(
1594
zip(attribute.__code__.co_freevars,
1595
attribute.__closure__))
1596
["func"].cell_contents)
1121
nonmethod_func = attribute
1597
1122
# Create a new, but exactly alike, function
1598
1123
# object, and decorate it to be a new D-Bus signal
1599
1124
# with the alternate D-Bus interface name
1600
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__)
1601
1139
new_function = (dbus.service.signal(
1602
1140
alt_interface,
1603
1141
attribute._dbus_signature)(new_function))
1607
1145
attribute._dbus_annotations)
1608
1146
except AttributeError:
1609
1147
pass
1610
1611
1148
# Define a creator of a function to call both the
1612
1149
# original and alternate functions, so both the
1613
1150
# original and alternate signals gets sent when
1616
1153
"""This function is a scope container to pass
1617
1154
func1 and func2 to the "call_both" function
1618
1155
outside of its arguments"""
1619
1620
@functools.wraps(func2)
1156
1621
1157
def call_both(*args, **kwargs):
1622
1158
"""This function will emit two D-Bus
1623
1159
signals by calling func1 and func2"""
1624
1160
func1(*args, **kwargs)
1625
1161
func2(*args, **kwargs)
1626
# Make wrapper function look like a D-Bus
1627
# signal
1628
for name, attr in inspect.getmembers(func2):
1629
if name.startswith("_dbus_"):
1630
setattr(call_both, name, attr)
1631
1162
1632
1163
return call_both
1633
1164
# Create the "call_both" function and add it to
1634
1165
# the class
1644
1175
alt_interface,
1645
1176
attribute._dbus_in_signature,
1646
1177
attribute._dbus_out_signature)
1647
(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)))
1648
1183
# Copy annotations, if any
1649
1184
try:
1650
1185
attr[attrname]._dbus_annotations = dict(
1662
1197
attribute._dbus_access,
1663
1198
attribute._dbus_get_args_options
1664
1199
["byte_arrays"])
1665
(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)))
1666
1206
# Copy annotations, if any
1667
1207
try:
1668
1208
attr[attrname]._dbus_annotations = dict(
1677
1217
# to the class.
1678
1218
attr[attrname] = (
1679
1219
dbus_interface_annotations(alt_interface)
1680
(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)))
1681
1225
if deprecate:
1682
1226
# Deprecate all alternate interfaces
1683
iname = "_AlternateDBusNames_interface_annotation{}"
1227
iname="_AlternateDBusNames_interface_annotation{}"
1684
1228
for interface_name in interface_names:
1685
1229
1686
1230
@dbus_interface_annotations(interface_name)
1687
1231
def func(self):
1688
return {"org.freedesktop.DBus.Deprecated":
1689
"true"}
1232
return { "org.freedesktop.DBus.Deprecated":
1233
"true" }
1690
1234
# Find an unused name
1691
1235
for aname in (iname.format(i)
1692
1236
for i in itertools.count()):
1696
1240
if interface_names:
1697
1241
# Replace the class with a new subclass of it with
1698
1242
# methods, signals, etc. as created above.
1699
if sys.version_info.major == 2:
1700
cls = type(b"{}Alternate".format(cls.__name__),
1701
(cls, ), attr)
1702
else:
1703
cls = type("{}Alternate".format(cls.__name__),
1704
(cls, ), attr)
1243
cls = type(b"{}Alternate".format(cls.__name__),
1244
(cls, ), attr)
1705
1245
return cls
1706
1246
1707
1247
return wrapper
1708
1248
1709
1249
1711
1251
"se.bsnet.fukt.Mandos"})
1712
1252
class ClientDBus(Client, DBusObjectWithProperties):
1713
1253
"""A Client class using D-Bus
1714
1254
1715
1255
Attributes:
1716
1256
dbus_object_path: dbus.ObjectPath
1717
1257
bus: dbus.SystemBus()
1718
1258
"""
1719
1259
1720
1260
runtime_expansions = (Client.runtime_expansions
1721
1261
+ ("dbus_object_path", ))
1722
1262
1723
1263
_interface = "se.recompile.Mandos.Client"
1724
1264
1725
1265
# dbus.service.Object doesn't use super(), so we can't either.
1726
1727
def __init__(self, bus=None, *args, **kwargs):
1266
1267
def __init__(self, bus = None, *args, **kwargs):
1728
1268
self.bus = bus
1729
1269
Client.__init__(self, *args, **kwargs)
1730
1270
# Only now, when this client is initialized, can it show up on
1736
1276
"/clients/" + client_object_name)
1737
1277
DBusObjectWithProperties.__init__(self, self.bus,
1738
1278
self.dbus_object_path)
1739
1279
1740
1280
def notifychangeproperty(transform_func, dbus_name,
1741
1281
type_func=lambda x: x,
1742
1282
variant_level=1,
1744
1284
_interface=_interface):
1745
1285
""" Modify a variable so that it's a property which announces
1746
1286
its changes to DBus.
1747
1287
1748
1288
transform_fun: Function that takes a value and a variant_level
1749
1289
and transforms it to a D-Bus type.
1750
1290
dbus_name: D-Bus name of the variable
1753
1293
variant_level: D-Bus variant level. Default: 1
1754
1294
"""
1755
1295
attrname = "_{}".format(dbus_name)
1756
1296
1757
1297
def setter(self, value):
1758
1298
if hasattr(self, "dbus_object_path"):
1759
1299
if (not hasattr(self, attrname) or
1766
1306
else:
1767
1307
dbus_value = transform_func(
1768
1308
type_func(value),
1769
variant_level=variant_level)
1309
variant_level = variant_level)
1770
1310
self.PropertyChanged(dbus.String(dbus_name),
1771
1311
dbus_value)
1772
1312
self.PropertiesChanged(
1773
1313
_interface,
1774
dbus.Dictionary({dbus.String(dbus_name):
1775
dbus_value}),
1314
dbus.Dictionary({ dbus.String(dbus_name):
1315
dbus_value }),
1776
1316
dbus.Array())
1777
1317
setattr(self, attrname, value)
1778
1318
1779
1319
return property(lambda self: getattr(self, attrname), setter)
1780
1320
1781
1321
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1782
1322
approvals_pending = notifychangeproperty(dbus.Boolean,
1783
1323
"ApprovalPending",
1784
type_func=bool)
1324
type_func = bool)
1785
1325
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1786
1326
last_enabled = notifychangeproperty(datetime_to_dbus,
1787
1327
"LastEnabled")
1788
1328
checker = notifychangeproperty(
1789
1329
dbus.Boolean, "CheckerRunning",
1790
type_func=lambda checker: checker is not None)
1330
type_func = lambda checker: checker is not None)
1791
1331
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1792
1332
"LastCheckedOK")
1793
1333
last_checker_status = notifychangeproperty(dbus.Int16,
1798
1338
"ApprovedByDefault")
1799
1339
approval_delay = notifychangeproperty(
1800
1340
dbus.UInt64, "ApprovalDelay",
1801
type_func=lambda td: td.total_seconds() * 1000)
1341
type_func = lambda td: td.total_seconds() * 1000)
1802
1342
approval_duration = notifychangeproperty(
1803
1343
dbus.UInt64, "ApprovalDuration",
1804
type_func=lambda td: td.total_seconds() * 1000)
1344
type_func = lambda td: td.total_seconds() * 1000)
1805
1345
host = notifychangeproperty(dbus.String, "Host")
1806
1346
timeout = notifychangeproperty(
1807
1347
dbus.UInt64, "Timeout",
1808
type_func=lambda td: td.total_seconds() * 1000)
1348
type_func = lambda td: td.total_seconds() * 1000)
1809
1349
extended_timeout = notifychangeproperty(
1810
1350
dbus.UInt64, "ExtendedTimeout",
1811
type_func=lambda td: td.total_seconds() * 1000)
1351
type_func = lambda td: td.total_seconds() * 1000)
1812
1352
interval = notifychangeproperty(
1813
1353
dbus.UInt64, "Interval",
1814
type_func=lambda td: td.total_seconds() * 1000)
1354
type_func = lambda td: td.total_seconds() * 1000)
1815
1355
checker_command = notifychangeproperty(dbus.String, "Checker")
1816
1356
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1817
1357
invalidate_only=True)
1818
1358
1819
1359
del notifychangeproperty
1820
1360
1821
1361
def __del__(self, *args, **kwargs):
1822
1362
try:
1823
1363
self.remove_from_connection()
1826
1366
if hasattr(DBusObjectWithProperties, "__del__"):
1827
1367
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1828
1368
Client.__del__(self, *args, **kwargs)
1829
1369
1830
1370
def checker_callback(self, source, condition,
1831
1371
connection, command, *args, **kwargs):
1832
1372
ret = Client.checker_callback(self, source, condition,
1836
1376
if exitstatus >= 0:
1837
1377
# Emit D-Bus signal
1838
1378
self.CheckerCompleted(dbus.Int16(exitstatus),
1839
# This is specific to GNU libC
1840
dbus.Int64(exitstatus << 8),
1379
dbus.Int64(0),
1841
1380
dbus.String(command))
1842
1381
else:
1843
1382
# Emit D-Bus signal
1844
1383
self.CheckerCompleted(dbus.Int16(-1),
1845
1384
dbus.Int64(
1846
# This is specific to GNU libC
1847
(exitstatus << 8)
1848
| self.last_checker_signal),
1385
self.last_checker_signal),
1849
1386
dbus.String(command))
1850
1387
return ret
1851
1388
1852
1389
def start_checker(self, *args, **kwargs):
1853
1390
old_checker_pid = getattr(self.checker, "pid", None)
1854
1391
r = Client.start_checker(self, *args, **kwargs)
1858
1395
# Emit D-Bus signal
1859
1396
self.CheckerStarted(self.current_checker_command)
1860
1397
return r
1861
1398
1862
1399
def _reset_approved(self):
1863
1400
self.approved = None
1864
1401
return False
1865
1402
1866
1403
def approve(self, value=True):
1867
1404
self.approved = value
1868
GLib.timeout_add(int(self.approval_duration.total_seconds()
1869
* 1000), self._reset_approved)
1405
gobject.timeout_add(int(self.approval_duration.total_seconds()
1406
* 1000), self._reset_approved)
1870
1407
self.send_changedstate()
1871
1872
# D-Bus methods, signals & properties
1873
1874
# Interfaces
1875
1876
# Signals
1877
1408
1409
## D-Bus methods, signals & properties
1410
1411
## Interfaces
1412
1413
## Signals
1414
1878
1415
# CheckerCompleted - signal
1879
1416
@dbus.service.signal(_interface, signature="nxs")
1880
1417
def CheckerCompleted(self, exitcode, waitstatus, command):
1881
1418
"D-Bus signal"
1882
1419
pass
1883
1420
1884
1421
# CheckerStarted - signal
1885
1422
@dbus.service.signal(_interface, signature="s")
1886
1423
def CheckerStarted(self, command):
1887
1424
"D-Bus signal"
1888
1425
pass
1889
1426
1890
1427
# PropertyChanged - signal
1891
1428
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1892
1429
@dbus.service.signal(_interface, signature="sv")
1893
1430
def PropertyChanged(self, property, value):
1894
1431
"D-Bus signal"
1895
1432
pass
1896
1433
1897
1434
# GotSecret - signal
1898
1435
@dbus.service.signal(_interface)
1899
1436
def GotSecret(self):
1902
1439
server to mandos-client
1903
1440
"""
1904
1441
pass
1905
1442
1906
1443
# Rejected - signal
1907
1444
@dbus.service.signal(_interface, signature="s")
1908
1445
def Rejected(self, reason):
1909
1446
"D-Bus signal"
1910
1447
pass
1911
1448
1912
1449
# NeedApproval - signal
1913
1450
@dbus.service.signal(_interface, signature="tb")
1914
1451
def NeedApproval(self, timeout, default):
1915
1452
"D-Bus signal"
1916
1453
return self.need_approval()
1917
1918
# Methods
1919
1454
1455
## Methods
1456
1920
1457
# Approve - method
1921
1458
@dbus.service.method(_interface, in_signature="b")
1922
1459
def Approve(self, value):
1923
1460
self.approve(value)
1924
1461
1925
1462
# CheckedOK - method
1926
1463
@dbus.service.method(_interface)
1927
1464
def CheckedOK(self):
1928
1465
self.checked_ok()
1929
1466
1930
1467
# Enable - method
1931
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1932
1468
@dbus.service.method(_interface)
1933
1469
def Enable(self):
1934
1470
"D-Bus method"
1935
1471
self.enable()
1936
1472
1937
1473
# StartChecker - method
1938
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1939
1474
@dbus.service.method(_interface)
1940
1475
def StartChecker(self):
1941
1476
"D-Bus method"
1942
1477
self.start_checker()
1943
1478
1944
1479
# Disable - method
1945
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1946
1480
@dbus.service.method(_interface)
1947
1481
def Disable(self):
1948
1482
"D-Bus method"
1949
1483
self.disable()
1950
1484
1951
1485
# StopChecker - method
1952
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1953
1486
@dbus.service.method(_interface)
1954
1487
def StopChecker(self):
1955
1488
self.stop_checker()
1956
1957
# Properties
1958
1489
1490
## Properties
1491
1959
1492
# ApprovalPending - property
1960
1493
@dbus_service_property(_interface, signature="b", access="read")
1961
1494
def ApprovalPending_dbus_property(self):
1962
1495
return dbus.Boolean(bool(self.approvals_pending))
1963
1496
1964
1497
# ApprovedByDefault - property
1965
1498
@dbus_service_property(_interface,
1966
1499
signature="b",
1969
1502
if value is None: # get
1970
1503
return dbus.Boolean(self.approved_by_default)
1971
1504
self.approved_by_default = bool(value)
1972
1505
1973
1506
# ApprovalDelay - property
1974
1507
@dbus_service_property(_interface,
1975
1508
signature="t",
1979
1512
return dbus.UInt64(self.approval_delay.total_seconds()
1980
1513
* 1000)
1981
1514
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1982
1515
1983
1516
# ApprovalDuration - property
1984
1517
@dbus_service_property(_interface,
1985
1518
signature="t",
1989
1522
return dbus.UInt64(self.approval_duration.total_seconds()
1990
1523
* 1000)
1991
1524
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1992
1525
1993
1526
# Name - property
1994
@dbus_annotations(
1995
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1996
1527
@dbus_service_property(_interface, signature="s", access="read")
1997
1528
def Name_dbus_property(self):
1998
1529
return dbus.String(self.name)
1999
1530
2000
1531
# Fingerprint - property
2001
@dbus_annotations(
2002
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2003
1532
@dbus_service_property(_interface, signature="s", access="read")
2004
1533
def Fingerprint_dbus_property(self):
2005
1534
return dbus.String(self.fingerprint)
2006
1535
2007
1536
# Host - property
2008
1537
@dbus_service_property(_interface,
2009
1538
signature="s",
2012
1541
if value is None: # get
2013
1542
return dbus.String(self.host)
2014
1543
self.host = str(value)
2015
1544
2016
1545
# Created - property
2017
@dbus_annotations(
2018
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2019
1546
@dbus_service_property(_interface, signature="s", access="read")
2020
1547
def Created_dbus_property(self):
2021
1548
return datetime_to_dbus(self.created)
2022
1549
2023
1550
# LastEnabled - property
2024
1551
@dbus_service_property(_interface, signature="s", access="read")
2025
1552
def LastEnabled_dbus_property(self):
2026
1553
return datetime_to_dbus(self.last_enabled)
2027
1554
2028
1555
# Enabled - property
2029
1556
@dbus_service_property(_interface,
2030
1557
signature="b",
2036
1563
self.enable()
2037
1564
else:
2038
1565
self.disable()
2039
1566
2040
1567
# LastCheckedOK - property
2041
1568
@dbus_service_property(_interface,
2042
1569
signature="s",
2046
1573
self.checked_ok()
2047
1574
return
2048
1575
return datetime_to_dbus(self.last_checked_ok)
2049
1576
2050
1577
# LastCheckerStatus - property
2051
1578
@dbus_service_property(_interface, signature="n", access="read")
2052
1579
def LastCheckerStatus_dbus_property(self):
2053
1580
return dbus.Int16(self.last_checker_status)
2054
1581
2055
1582
# Expires - property
2056
1583
@dbus_service_property(_interface, signature="s", access="read")
2057
1584
def Expires_dbus_property(self):
2058
1585
return datetime_to_dbus(self.expires)
2059
1586
2060
1587
# LastApprovalRequest - property
2061
1588
@dbus_service_property(_interface, signature="s", access="read")
2062
1589
def LastApprovalRequest_dbus_property(self):
2063
1590
return datetime_to_dbus(self.last_approval_request)
2064
1591
2065
1592
# Timeout - property
2066
1593
@dbus_service_property(_interface,
2067
1594
signature="t",
2082
1609
if (getattr(self, "disable_initiator_tag", None)
2083
1610
is None):
2084
1611
return
2085
GLib.source_remove(self.disable_initiator_tag)
2086
self.disable_initiator_tag = GLib.timeout_add(
1612
gobject.source_remove(self.disable_initiator_tag)
1613
self.disable_initiator_tag = gobject.timeout_add(
2087
1614
int((self.expires - now).total_seconds() * 1000),
2088
1615
self.disable)
2089
1616
2090
1617
# ExtendedTimeout - property
2091
1618
@dbus_service_property(_interface,
2092
1619
signature="t",
2096
1623
return dbus.UInt64(self.extended_timeout.total_seconds()
2097
1624
* 1000)
2098
1625
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2099
1626
2100
1627
# Interval - property
2101
1628
@dbus_service_property(_interface,
2102
1629
signature="t",
2109
1636
return
2110
1637
if self.enabled:
2111
1638
# Reschedule checker run
2112
GLib.source_remove(self.checker_initiator_tag)
2113
self.checker_initiator_tag = GLib.timeout_add(
1639
gobject.source_remove(self.checker_initiator_tag)
1640
self.checker_initiator_tag = gobject.timeout_add(
2114
1641
value, self.start_checker)
2115
self.start_checker() # Start one now, too
2116
1642
self.start_checker() # Start one now, too
1643
2117
1644
# Checker - property
2118
1645
@dbus_service_property(_interface,
2119
1646
signature="s",
2122
1649
if value is None: # get
2123
1650
return dbus.String(self.checker_command)
2124
1651
self.checker_command = str(value)
2125
1652
2126
1653
# CheckerRunning - property
2127
1654
@dbus_service_property(_interface,
2128
1655
signature="b",
2134
1661
self.start_checker()
2135
1662
else:
2136
1663
self.stop_checker()
2137
1664
2138
1665
# ObjectPath - property
2139
@dbus_annotations(
2140
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2141
"org.freedesktop.DBus.Deprecated": "true"})
2142
1666
@dbus_service_property(_interface, signature="o", access="read")
2143
1667
def ObjectPath_dbus_property(self):
2144
return self.dbus_object_path # is already a dbus.ObjectPath
2145
1668
return self.dbus_object_path # is already a dbus.ObjectPath
1669
2146
1670
# Secret = property
2147
@dbus_annotations(
2148
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2149
"invalidates"})
2150
1671
@dbus_service_property(_interface,
2151
1672
signature="ay",
2152
1673
access="write",
2153
1674
byte_arrays=True)
2154
1675
def Secret_dbus_property(self, value):
2155
1676
self.secret = bytes(value)
2156
1677
2157
1678
del _interface
2158
1679
2159
1680
2163
1684
self._pipe.send(('init', fpr, address))
2164
1685
if not self._pipe.recv():
2165
1686
raise KeyError(fpr)
2166
1687
2167
1688
def __getattribute__(self, name):
2168
1689
if name == '_pipe':
2169
1690
return super(ProxyClient, self).__getattribute__(name)
2172
1693
if data[0] == 'data':
2173
1694
return data[1]
2174
1695
if data[0] == 'function':
2175
1696
2176
1697
def func(*args, **kwargs):
2177
1698
self._pipe.send(('funcall', name, args, kwargs))
2178
1699
return self._pipe.recv()[1]
2179
1700
2180
1701
return func
2181
1702
2182
1703
def __setattr__(self, name, value):
2183
1704
if name == '_pipe':
2184
1705
return super(ProxyClient, self).__setattr__(name, value)
2187
1708
2188
1709
class ClientHandler(socketserver.BaseRequestHandler, object):
2189
1710
"""A class to handle client connections.
2190
1711
2191
1712
Instantiated once for each connection to handle it.
2192
1713
Note: This will run in its own forked process."""
2193
1714
2194
1715
def handle(self):
2195
1716
with contextlib.closing(self.server.child_pipe) as child_pipe:
2196
1717
logger.info("TCP connection from: %s",
2197
1718
str(self.client_address))
2198
1719
logger.debug("Pipe FD: %d",
2199
1720
self.server.child_pipe.fileno())
2200
2201
session = gnutls.ClientSession(self.request)
2202
2203
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2204
# "+AES-256-CBC", "+SHA1",
2205
# "+COMP-NULL", "+CTYPE-OPENPGP",
2206
# "+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"))
2207
1734
# Use a fallback default, since this MUST be set.
2208
1735
priority = self.server.gnutls_priority
2209
1736
if priority is None:
2210
1737
priority = "NORMAL"
2211
gnutls.priority_set_direct(session._c_object,
2212
priority.encode("utf-8"),
2213
None)
2214
1738
gnutls.library.functions.gnutls_priority_set_direct(
1739
session._c_object, priority, None)
1740
2215
1741
# Start communication using the Mandos protocol
2216
1742
# Get protocol number
2217
1743
line = self.request.makefile().readline()
2222
1748
except (ValueError, IndexError, RuntimeError) as error:
2223
1749
logger.error("Unknown protocol version: %s", error)
2224
1750
return
2225
1751
2226
1752
# Start GnuTLS connection
2227
1753
try:
2228
1754
session.handshake()
2229
except gnutls.Error as error:
1755
except gnutls.errors.GNUTLSError as error:
2230
1756
logger.warning("Handshake failed: %s", error)
2231
1757
# Do not run session.bye() here: the session is not
2232
1758
# established. Just abandon the request.
2233
1759
return
2234
1760
logger.debug("Handshake succeeded")
2235
1761
2236
1762
approval_required = False
2237
1763
try:
2238
1764
try:
2239
1765
fpr = self.fingerprint(
2240
1766
self.peer_certificate(session))
2241
except (TypeError, gnutls.Error) as error:
1767
except (TypeError,
1768
gnutls.errors.GNUTLSError) as error:
2242
1769
logger.warning("Bad certificate: %s", error)
2243
1770
return
2244
1771
logger.debug("Fingerprint: %s", fpr)
2245
1772
2246
1773
try:
2247
1774
client = ProxyClient(child_pipe, fpr,
2248
1775
self.client_address)
2249
1776
except KeyError:
2250
1777
return
2251
1778
2252
1779
if client.approval_delay:
2253
1780
delay = client.approval_delay
2254
1781
client.approvals_pending += 1
2255
1782
approval_required = True
2256
1783
2257
1784
while True:
2258
1785
if not client.enabled:
2259
1786
logger.info("Client %s is disabled",
2262
1789
# Emit D-Bus signal
2263
1790
client.Rejected("Disabled")
2264
1791
return
2265
1792
2266
1793
if client.approved or not client.approval_delay:
2267
# We are approved or approval is disabled
1794
#We are approved or approval is disabled
2268
1795
break
2269
1796
elif client.approved is None:
2270
1797
logger.info("Client %s needs approval",
2281
1808
# Emit D-Bus signal
2282
1809
client.Rejected("Denied")
2283
1810
return
2284
2285
# wait until timeout or approved
1811
1812
#wait until timeout or approved
2286
1813
time = datetime.datetime.now()
2287
1814
client.changedstate.acquire()
2288
1815
client.changedstate.wait(delay.total_seconds())
2301
1828
break
2302
1829
else:
2303
1830
delay -= time2 - time
2304
2305
try:
2306
session.send(client.secret)
2307
except gnutls.Error as error:
2308
logger.warning("gnutls send failed",
2309
exc_info=error)
2310
return
2311
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
2312
1845
logger.info("Sending secret to %s", client.name)
2313
1846
# bump the timeout using extended_timeout
2314
1847
client.bump_timeout(client.extended_timeout)
2315
1848
if self.server.use_dbus:
2316
1849
# Emit D-Bus signal
2317
1850
client.GotSecret()
2318
1851
2319
1852
finally:
2320
1853
if approval_required:
2321
1854
client.approvals_pending -= 1
2322
1855
try:
2323
1856
session.bye()
2324
except gnutls.Error as error:
1857
except gnutls.errors.GNUTLSError as error:
2325
1858
logger.warning("GnuTLS bye failed",
2326
1859
exc_info=error)
2327
1860
2328
1861
@staticmethod
2329
1862
def peer_certificate(session):
2330
1863
"Return the peer's OpenPGP certificate as a bytestring"
2331
1864
# If not an OpenPGP certificate...
2332
if (gnutls.certificate_type_get(session._c_object)
2333
!= gnutls.CRT_OPENPGP):
2334
# ...return invalid data
2335
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
2336
1870
list_size = ctypes.c_uint(1)
2337
cert_list = (gnutls.certificate_get_peers
1871
cert_list = (gnutls.library.functions
1872
.gnutls_certificate_get_peers
2338
1873
(session._c_object, ctypes.byref(list_size)))
2339
1874
if not bool(cert_list) and list_size.value != 0:
2340
raise gnutls.Error("error getting peer certificate")
1875
raise gnutls.errors.GNUTLSError("error getting peer"
1876
" certificate")
2341
1877
if list_size.value == 0:
2342
1878
return None
2343
1879
cert = cert_list[0]
2344
1880
return ctypes.string_at(cert.data, cert.size)
2345
1881
2346
1882
@staticmethod
2347
1883
def fingerprint(openpgp):
2348
1884
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2349
1885
# New GnuTLS "datum" with the OpenPGP public key
2350
datum = gnutls.datum_t(
1886
datum = gnutls.library.types.gnutls_datum_t(
2351
1887
ctypes.cast(ctypes.c_char_p(openpgp),
2352
1888
ctypes.POINTER(ctypes.c_ubyte)),
2353
1889
ctypes.c_uint(len(openpgp)))
2354
1890
# New empty GnuTLS certificate
2355
crt = gnutls.openpgp_crt_t()
2356
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))
2357
1894
# Import the OpenPGP public key into the certificate
2358
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2359
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)
2360
1898
# Verify the self signature in the key
2361
1899
crtverify = ctypes.c_uint()
2362
gnutls.openpgp_crt_verify_self(crt, 0,
2363
ctypes.byref(crtverify))
1900
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1901
crt, 0, ctypes.byref(crtverify))
2364
1902
if crtverify.value != 0:
2365
gnutls.openpgp_crt_deinit(crt)
2366
raise gnutls.CertificateSecurityError("Verify failed")
1903
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1904
raise gnutls.errors.CertificateSecurityError(
1905
"Verify failed")
2367
1906
# New buffer for the fingerprint
2368
1907
buf = ctypes.create_string_buffer(20)
2369
1908
buf_len = ctypes.c_size_t()
2370
1909
# Get the fingerprint from the certificate into the buffer
2371
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2372
ctypes.byref(buf_len))
1910
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1911
crt, ctypes.byref(buf), ctypes.byref(buf_len))
2373
1912
# Deinit the certificate
2374
gnutls.openpgp_crt_deinit(crt)
1913
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2375
1914
# Convert the buffer to a Python bytestring
2376
1915
fpr = ctypes.string_at(buf, buf_len.value)
2377
1916
# Convert the bytestring to hexadecimal notation
2381
1920
2382
1921
class MultiprocessingMixIn(object):
2383
1922
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2384
1923
2385
1924
def sub_process_main(self, request, address):
2386
1925
try:
2387
1926
self.finish_request(request, address)
2388
1927
except Exception:
2389
1928
self.handle_error(request, address)
2390
1929
self.close_request(request)
2391
1930
2392
1931
def process_request(self, request, address):
2393
1932
"""Start a new process to process the request."""
2394
proc = multiprocessing.Process(target=self.sub_process_main,
2395
args=(request, address))
1933
proc = multiprocessing.Process(target = self.sub_process_main,
1934
args = (request, address))
2396
1935
proc.start()
2397
1936
return proc
2398
1937
2399
1938
2400
1939
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2401
1940
""" adds a pipe to the MixIn """
2402
1941
2403
1942
def process_request(self, request, client_address):
2404
1943
"""Overrides and wraps the original process_request().
2405
1944
2406
1945
This function creates a new pipe in self.pipe
2407
1946
"""
2408
1947
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2409
1948
2410
1949
proc = MultiprocessingMixIn.process_request(self, request,
2411
1950
client_address)
2412
1951
self.child_pipe.close()
2413
1952
self.add_pipe(parent_pipe, proc)
2414
1953
2415
1954
def add_pipe(self, parent_pipe, proc):
2416
1955
"""Dummy function; override as necessary"""
2417
1956
raise NotImplementedError()
2420
1959
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2421
1960
socketserver.TCPServer, object):
2422
1961
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2423
1962
2424
1963
Attributes:
2425
1964
enabled: Boolean; whether this server is activated yet
2426
1965
interface: None or a network interface name (string)
2427
1966
use_ipv6: Boolean; to use IPv6 or not
2428
1967
"""
2429
1968
2430
1969
def __init__(self, server_address, RequestHandlerClass,
2431
1970
interface=None,
2432
1971
use_ipv6=True,
2442
1981
self.socketfd = socketfd
2443
1982
# Save the original socket.socket() function
2444
1983
self.socket_socket = socket.socket
2445
2446
1984
# To implement --socket, we monkey patch socket.socket.
2447
#
1985
#
2448
1986
# (When socketserver.TCPServer is a new-style class, we
2449
1987
# could make self.socket into a property instead of monkey
2450
1988
# patching socket.socket.)
2451
#
1989
#
2452
1990
# Create a one-time-only replacement for socket.socket()
2453
1991
@functools.wraps(socket.socket)
2454
1992
def socket_wrapper(*args, **kwargs):
2466
2004
# socket_wrapper(), if socketfd was set.
2467
2005
socketserver.TCPServer.__init__(self, server_address,
2468
2006
RequestHandlerClass)
2469
2007
2470
2008
def server_bind(self):
2471
2009
"""This overrides the normal server_bind() function
2472
2010
to bind to an interface if one was specified, and also NOT to
2473
2011
bind to an address or port if they were not specified."""
2474
global SO_BINDTODEVICE
2475
2012
if self.interface is not None:
2476
2013
if SO_BINDTODEVICE is None:
2477
# Fall back to a hard-coded value which seems to be
2478
# common enough.
2479
logger.warning("SO_BINDTODEVICE not found, trying 25")
2480
SO_BINDTODEVICE = 25
2481
try:
2482
self.socket.setsockopt(
2483
socket.SOL_SOCKET, SO_BINDTODEVICE,
2484
(self.interface + "\0").encode("utf-8"))
2485
except socket.error as error:
2486
if error.errno == errno.EPERM:
2487
logger.error("No permission to bind to"
2488
" interface %s", self.interface)
2489
elif error.errno == errno.ENOPROTOOPT:
2490
logger.error("SO_BINDTODEVICE not available;"
2491
" cannot bind to interface %s",
2492
self.interface)
2493
elif error.errno == errno.ENODEV:
2494
logger.error("Interface %s does not exist,"
2495
" cannot bind", self.interface)
2496
else:
2497
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
2498
2035
# Only bind(2) the socket if we really need to.
2499
2036
if self.server_address[0] or self.server_address[1]:
2500
2037
if not self.server_address[0]:
2501
2038
if self.address_family == socket.AF_INET6:
2502
any_address = "::" # in6addr_any
2039
any_address = "::" # in6addr_any
2503
2040
else:
2504
any_address = "0.0.0.0" # INADDR_ANY
2041
any_address = "0.0.0.0" # INADDR_ANY
2505
2042
self.server_address = (any_address,
2506
2043
self.server_address[1])
2507
2044
elif not self.server_address[1]:
2517
2054
2518
2055
class MandosServer(IPv6_TCPServer):
2519
2056
"""Mandos server.
2520
2057
2521
2058
Attributes:
2522
2059
clients: set of Client objects
2523
2060
gnutls_priority GnuTLS priority string
2524
2061
use_dbus: Boolean; to emit D-Bus signals or not
2525
2526
Assumes a GLib.MainLoop event loop.
2062
2063
Assumes a gobject.MainLoop event loop.
2527
2064
"""
2528
2065
2529
2066
def __init__(self, server_address, RequestHandlerClass,
2530
2067
interface=None,
2531
2068
use_ipv6=True,
2541
2078
self.gnutls_priority = gnutls_priority
2542
2079
IPv6_TCPServer.__init__(self, server_address,
2543
2080
RequestHandlerClass,
2544
interface=interface,
2545
use_ipv6=use_ipv6,
2546
socketfd=socketfd)
2547
2081
interface = interface,
2082
use_ipv6 = use_ipv6,
2083
socketfd = socketfd)
2084
2548
2085
def server_activate(self):
2549
2086
if self.enabled:
2550
2087
return socketserver.TCPServer.server_activate(self)
2551
2088
2552
2089
def enable(self):
2553
2090
self.enabled = True
2554
2091
2555
2092
def add_pipe(self, parent_pipe, proc):
2556
2093
# Call "handle_ipc" for both data and EOF events
2557
GLib.io_add_watch(
2094
gobject.io_add_watch(
2558
2095
parent_pipe.fileno(),
2559
GLib.IO_IN | GLib.IO_HUP,
2096
gobject.IO_IN | gobject.IO_HUP,
2560
2097
functools.partial(self.handle_ipc,
2561
parent_pipe=parent_pipe,
2562
proc=proc))
2563
2098
parent_pipe = parent_pipe,
2099
proc = proc))
2100
2564
2101
def handle_ipc(self, source, condition,
2565
2102
parent_pipe=None,
2566
proc=None,
2103
proc = None,
2567
2104
client_object=None):
2568
2105
# error, or the other end of multiprocessing.Pipe has closed
2569
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2106
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2570
2107
# Wait for other process to exit
2571
2108
proc.join()
2572
2109
return False
2573
2110
2574
2111
# Read a request from the child
2575
2112
request = parent_pipe.recv()
2576
2113
command = request[0]
2577
2114
2578
2115
if command == 'init':
2579
2116
fpr = request[1]
2580
2117
address = request[2]
2581
2582
for c in self.clients.values():
2118
2119
for c in self.clients.itervalues():
2583
2120
if c.fingerprint == fpr:
2584
2121
client = c
2585
2122
break
2592
2129
address[0])
2593
2130
parent_pipe.send(False)
2594
2131
return False
2595
2596
GLib.io_add_watch(
2132
2133
gobject.io_add_watch(
2597
2134
parent_pipe.fileno(),
2598
GLib.IO_IN | GLib.IO_HUP,
2135
gobject.IO_IN | gobject.IO_HUP,
2599
2136
functools.partial(self.handle_ipc,
2600
parent_pipe=parent_pipe,
2601
proc=proc,
2602
client_object=client))
2137
parent_pipe = parent_pipe,
2138
proc = proc,
2139
client_object = client))
2603
2140
parent_pipe.send(True)
2604
2141
# remove the old hook in favor of the new above hook on
2605
2142
# same fileno
2608
2145
funcname = request[1]
2609
2146
args = request[2]
2610
2147
kwargs = request[3]
2611
2148
2612
2149
parent_pipe.send(('data', getattr(client_object,
2613
2150
funcname)(*args,
2614
2151
**kwargs)))
2615
2152
2616
2153
if command == 'getattr':
2617
2154
attrname = request[1]
2618
2155
if isinstance(client_object.__getattribute__(attrname),
2621
2158
else:
2622
2159
parent_pipe.send((
2623
2160
'data', client_object.__getattribute__(attrname)))
2624
2161
2625
2162
if command == 'setattr':
2626
2163
attrname = request[1]
2627
2164
value = request[2]
2628
2165
setattr(client_object, attrname, value)
2629
2166
2630
2167
return True
2631
2168
2632
2169
2633
2170
def rfc3339_duration_to_delta(duration):
2634
2171
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2635
2172
2636
2173
>>> rfc3339_duration_to_delta("P7D")
2637
2174
datetime.timedelta(7)
2638
2175
>>> rfc3339_duration_to_delta("PT60S")
2648
2185
>>> rfc3339_duration_to_delta("P1DT3M20S")
2649
2186
datetime.timedelta(1, 200)
2650
2187
"""
2651
2188
2652
2189
# Parsing an RFC 3339 duration with regular expressions is not
2653
2190
# possible - there would have to be multiple places for the same
2654
2191
# values, like seconds. The current code, while more esoteric, is
2655
2192
# cleaner without depending on a parsing library. If Python had a
2656
2193
# built-in library for parsing we would use it, but we'd like to
2657
2194
# avoid excessive use of external libraries.
2658
2195
2659
2196
# New type for defining tokens, syntax, and semantics all-in-one
2660
2197
Token = collections.namedtuple("Token", (
2661
2198
"regexp", # To match token; if "value" is not None, must have
2694
2231
frozenset((token_year, token_month,
2695
2232
token_day, token_time,
2696
2233
token_week)))
2697
# Define starting values:
2698
# Value so far
2699
value = datetime.timedelta()
2234
# Define starting values
2235
value = datetime.timedelta() # Value so far
2700
2236
found_token = None
2701
# Following valid tokens
2702
followers = frozenset((token_duration, ))
2703
# String left to parse
2704
s = duration
2237
followers = frozenset((token_duration, )) # Following valid tokens
2238
s = duration # String left to parse
2705
2239
# Loop until end token is found
2706
2240
while found_token is not token_end:
2707
2241
# Search for any currently valid tokens
2731
2265
2732
2266
def string_to_delta(interval):
2733
2267
"""Parse a string and return a datetime.timedelta
2734
2268
2735
2269
>>> string_to_delta('7d')
2736
2270
datetime.timedelta(7)
2737
2271
>>> string_to_delta('60s')
2745
2279
>>> string_to_delta('5m 30s')
2746
2280
datetime.timedelta(0, 330)
2747
2281
"""
2748
2282
2749
2283
try:
2750
2284
return rfc3339_duration_to_delta(interval)
2751
2285
except ValueError:
2752
2286
pass
2753
2287
2754
2288
timevalue = datetime.timedelta(0)
2755
2289
for s in interval.split():
2756
2290
try:
2774
2308
return timevalue
2775
2309
2776
2310
2777
def daemon(nochdir=False, noclose=False):
2311
def daemon(nochdir = False, noclose = False):
2778
2312
"""See daemon(3). Standard BSD Unix function.
2779
2313
2780
2314
This should really exist as os.daemon, but it doesn't (yet)."""
2781
2315
if os.fork():
2782
2316
sys.exit()
2800
2334
2801
2335
2802
2336
def main():
2803
2337
2804
2338
##################################################################
2805
2339
# Parsing of options, both command line and config file
2806
2340
2807
2341
parser = argparse.ArgumentParser()
2808
2342
parser.add_argument("-v", "--version", action="version",
2809
version="%(prog)s {}".format(version),
2343
version = "%(prog)s {}".format(version),
2810
2344
help="show version number and exit")
2811
2345
parser.add_argument("-i", "--interface", metavar="IF",
2812
2346
help="Bind to interface IF")
2848
2382
parser.add_argument("--no-zeroconf", action="store_false",
2849
2383
dest="zeroconf", help="Do not use Zeroconf",
2850
2384
default=None)
2851
2385
2852
2386
options = parser.parse_args()
2853
2387
2854
2388
if options.check:
2855
2389
import doctest
2856
2390
fail_count, test_count = doctest.testmod()
2857
2391
sys.exit(os.EX_OK if fail_count == 0 else 1)
2858
2392
2859
2393
# Default values for config file for server-global settings
2860
server_defaults = {"interface": "",
2861
"address": "",
2862
"port": "",
2863
"debug": "False",
2864
"priority":
2865
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2866
":+SIGN-DSA-SHA256",
2867
"servicename": "Mandos",
2868
"use_dbus": "True",
2869
"use_ipv6": "True",
2870
"debuglevel": "",
2871
"restore": "True",
2872
"socket": "",
2873
"statedir": "/var/lib/mandos",
2874
"foreground": "False",
2875
"zeroconf": "True",
2876
}
2877
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
2878
2412
# Parse config file for server-global settings
2879
2413
server_config = configparser.SafeConfigParser(server_defaults)
2880
2414
del server_defaults
2898
2432
server_settings["socket"] = os.dup(server_settings
2899
2433
["socket"])
2900
2434
del server_config
2901
2435
2902
2436
# Override the settings from the config file with command line
2903
2437
# options, if set.
2904
2438
for option in ("interface", "address", "port", "debug",
2922
2456
if server_settings["debug"]:
2923
2457
server_settings["foreground"] = True
2924
2458
# Now we have our good server settings in "server_settings"
2925
2459
2926
2460
##################################################################
2927
2461
2928
2462
if (not server_settings["zeroconf"]
2929
2463
and not (server_settings["port"]
2930
2464
or server_settings["socket"] != "")):
2931
2465
parser.error("Needs port or socket to work without Zeroconf")
2932
2466
2933
2467
# For convenience
2934
2468
debug = server_settings["debug"]
2935
2469
debuglevel = server_settings["debuglevel"]
2939
2473
stored_state_file)
2940
2474
foreground = server_settings["foreground"]
2941
2475
zeroconf = server_settings["zeroconf"]
2942
2476
2943
2477
if debug:
2944
2478
initlogger(debug, logging.DEBUG)
2945
2479
else:
2948
2482
else:
2949
2483
level = getattr(logging, debuglevel.upper())
2950
2484
initlogger(debug, level)
2951
2485
2952
2486
if server_settings["servicename"] != "Mandos":
2953
2487
syslogger.setFormatter(
2954
2488
logging.Formatter('Mandos ({}) [%(process)d]:'
2955
2489
' %(levelname)s: %(message)s'.format(
2956
2490
server_settings["servicename"])))
2957
2491
2958
2492
# Parse config file with clients
2959
2493
client_config = configparser.SafeConfigParser(Client
2960
2494
.client_defaults)
2961
2495
client_config.read(os.path.join(server_settings["configdir"],
2962
2496
"clients.conf"))
2963
2497
2964
2498
global mandos_dbus_service
2965
2499
mandos_dbus_service = None
2966
2500
2967
2501
socketfd = None
2968
2502
if server_settings["socket"] != "":
2969
2503
socketfd = server_settings["socket"]
2985
2519
except IOError as e:
2986
2520
logger.error("Could not open file %r", pidfilename,
2987
2521
exc_info=e)
2988
2989
for name, group in (("_mandos", "_mandos"),
2990
("mandos", "mandos"),
2991
("nobody", "nogroup")):
2522
2523
for name in ("_mandos", "mandos", "nobody"):
2992
2524
try:
2993
2525
uid = pwd.getpwnam(name).pw_uid
2994
gid = pwd.getpwnam(group).pw_gid
2526
gid = pwd.getpwnam(name).pw_gid
2995
2527
break
2996
2528
except KeyError:
2997
2529
continue
3001
2533
try:
3002
2534
os.setgid(gid)
3003
2535
os.setuid(uid)
3004
if debug:
3005
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3006
gid))
3007
2536
except OSError as error:
3008
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3009
.format(uid, gid, os.strerror(error.errno)))
3010
2537
if error.errno != errno.EPERM:
3011
2538
raise
3012
2539
3013
2540
if debug:
3014
2541
# Enable all possible GnuTLS debugging
3015
2542
3016
2543
# "Use a log level over 10 to enable all debugging options."
3017
2544
# - GnuTLS manual
3018
gnutls.global_set_log_level(11)
3019
3020
@gnutls.log_func
2545
gnutls.library.functions.gnutls_global_set_log_level(11)
2546
2547
@gnutls.library.types.gnutls_log_func
3021
2548
def debug_gnutls(level, string):
3022
2549
logger.debug("GnuTLS: %s", string[:-1])
3023
3024
gnutls.global_set_log_function(debug_gnutls)
3025
2550
2551
gnutls.library.functions.gnutls_global_set_log_function(
2552
debug_gnutls)
2553
3026
2554
# Redirect stdin so all checkers get /dev/null
3027
2555
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3028
2556
os.dup2(null, sys.stdin.fileno())
3029
2557
if null > 2:
3030
2558
os.close(null)
3031
2559
3032
2560
# Need to fork before connecting to D-Bus
3033
2561
if not foreground:
3034
2562
# Close all input and output, do double fork, etc.
3035
2563
daemon()
3036
3037
# multiprocessing will use threads, so before we use GLib we need
3038
# to inform GLib that threads will be used.
3039
GLib.threads_init()
3040
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
3041
2569
global main_loop
3042
2570
# From the Avahi example code
3043
2571
DBusGMainLoop(set_as_default=True)
3044
main_loop = GLib.MainLoop()
2572
main_loop = gobject.MainLoop()
3045
2573
bus = dbus.SystemBus()
3046
2574
# End of Avahi example code
3047
2575
if use_dbus:
3060
2588
if zeroconf:
3061
2589
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3062
2590
service = AvahiServiceToSyslog(
3063
name=server_settings["servicename"],
3064
servicetype="_mandos._tcp",
3065
protocol=protocol,
3066
bus=bus)
2591
name = server_settings["servicename"],
2592
servicetype = "_mandos._tcp",
2593
protocol = protocol,
2594
bus = bus)
3067
2595
if server_settings["interface"]:
3068
2596
service.interface = if_nametoindex(
3069
2597
server_settings["interface"].encode("utf-8"))
3070
2598
3071
2599
global multiprocessing_manager
3072
2600
multiprocessing_manager = multiprocessing.Manager()
3073
2601
3074
2602
client_class = Client
3075
2603
if use_dbus:
3076
client_class = functools.partial(ClientDBus, bus=bus)
3077
2604
client_class = functools.partial(ClientDBus, bus = bus)
2605
3078
2606
client_settings = Client.config_parser(client_config)
3079
2607
old_client_settings = {}
3080
2608
clients_data = {}
3081
2609
3082
2610
# This is used to redirect stdout and stderr for checker processes
3083
2611
global wnull
3084
wnull = open(os.devnull, "w") # A writable /dev/null
2612
wnull = open(os.devnull, "w") # A writable /dev/null
3085
2613
# Only used if server is running in foreground but not in debug
3086
2614
# mode
3087
2615
if debug or not foreground:
3088
2616
wnull.close()
3089
2617
3090
2618
# Get client data and settings from last running state.
3091
2619
if server_settings["restore"]:
3092
2620
try:
3093
2621
with open(stored_state_path, "rb") as stored_state:
3094
if sys.version_info.major == 2:
3095
clients_data, old_client_settings = pickle.load(
3096
stored_state)
3097
else:
3098
bytes_clients_data, bytes_old_client_settings = (
3099
pickle.load(stored_state, encoding="bytes"))
3100
# Fix bytes to strings
3101
# clients_data
3102
# .keys()
3103
clients_data = {(key.decode("utf-8")
3104
if isinstance(key, bytes)
3105
else key): value
3106
for key, value in
3107
bytes_clients_data.items()}
3108
del bytes_clients_data
3109
for key in clients_data:
3110
value = {(k.decode("utf-8")
3111
if isinstance(k, bytes) else k): v
3112
for k, v in
3113
clients_data[key].items()}
3114
clients_data[key] = value
3115
# .client_structure
3116
value["client_structure"] = [
3117
(s.decode("utf-8")
3118
if isinstance(s, bytes)
3119
else s) for s in
3120
value["client_structure"]]
3121
# .name & .host
3122
for k in ("name", "host"):
3123
if isinstance(value[k], bytes):
3124
value[k] = value[k].decode("utf-8")
3125
# old_client_settings
3126
# .keys()
3127
old_client_settings = {
3128
(key.decode("utf-8")
3129
if isinstance(key, bytes)
3130
else key): value
3131
for key, value in
3132
bytes_old_client_settings.items()}
3133
del bytes_old_client_settings
3134
# .host
3135
for value in old_client_settings.values():
3136
if isinstance(value["host"], bytes):
3137
value["host"] = (value["host"]
3138
.decode("utf-8"))
2622
clients_data, old_client_settings = pickle.load(
2623
stored_state)
3139
2624
os.remove(stored_state_path)
3140
2625
except IOError as e:
3141
2626
if e.errno == errno.ENOENT:
3149
2634
logger.warning("Could not load persistent state: "
3150
2635
"EOFError:",
3151
2636
exc_info=e)
3152
2637
3153
2638
with PGPEngine() as pgp:
3154
2639
for client_name, client in clients_data.items():
3155
2640
# Skip removed clients
3156
2641
if client_name not in client_settings:
3157
2642
continue
3158
2643
3159
2644
# Decide which value to use after restoring saved state.
3160
2645
# We have three different values: Old config file,
3161
2646
# new config file, and saved state.
3172
2657
client[name] = value
3173
2658
except KeyError:
3174
2659
pass
3175
2660
3176
2661
# Clients who has passed its expire date can still be
3177
2662
# enabled if its last checker was successful. A Client
3178
2663
# whose checker succeeded before we stored its state is
3211
2696
client_name))
3212
2697
client["secret"] = (client_settings[client_name]
3213
2698
["secret"])
3214
2699
3215
2700
# Add/remove clients based on new changes made to config
3216
2701
for client_name in (set(old_client_settings)
3217
2702
- set(client_settings)):
3219
2704
for client_name in (set(client_settings)
3220
2705
- set(old_client_settings)):
3221
2706
clients_data[client_name] = client_settings[client_name]
3222
2707
3223
2708
# Create all client objects
3224
2709
for client_name, client in clients_data.items():
3225
2710
tcp_server.clients[client_name] = client_class(
3226
name=client_name,
3227
settings=client,
3228
server_settings=server_settings)
3229
2711
name = client_name,
2712
settings = client,
2713
server_settings = server_settings)
2714
3230
2715
if not tcp_server.clients:
3231
2716
logger.warning("No clients defined")
3232
2717
3233
2718
if not foreground:
3234
2719
if pidfile is not None:
3235
2720
pid = os.getpid()
3241
2726
pidfilename, pid)
3242
2727
del pidfile
3243
2728
del pidfilename
3244
3245
for termsig in (signal.SIGHUP, signal.SIGTERM):
3246
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3247
lambda: main_loop.quit() and False)
3248
2729
2730
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2731
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2732
3249
2733
if use_dbus:
3250
2734
3251
2735
@alternate_dbus_interfaces(
3252
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3253
class MandosDBusService(DBusObjectWithObjectManager):
2736
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2737
class MandosDBusService(DBusObjectWithProperties):
3254
2738
"""A D-Bus proxy object"""
3255
2739
3256
2740
def __init__(self):
3257
2741
dbus.service.Object.__init__(self, bus, "/")
3258
2742
3259
2743
_interface = "se.recompile.Mandos"
3260
2744
2745
@dbus_interface_annotations(_interface)
2746
def _foo(self):
2747
return {
2748
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2749
"false" }
2750
3261
2751
@dbus.service.signal(_interface, signature="o")
3262
2752
def ClientAdded(self, objpath):
3263
2753
"D-Bus signal"
3264
2754
pass
3265
2755
3266
2756
@dbus.service.signal(_interface, signature="ss")
3267
2757
def ClientNotFound(self, fingerprint, address):
3268
2758
"D-Bus signal"
3269
2759
pass
3270
3271
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3272
"true"})
2760
3273
2761
@dbus.service.signal(_interface, signature="os")
3274
2762
def ClientRemoved(self, objpath, name):
3275
2763
"D-Bus signal"
3276
2764
pass
3277
3278
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3279
"true"})
2765
3280
2766
@dbus.service.method(_interface, out_signature="ao")
3281
2767
def GetAllClients(self):
3282
2768
"D-Bus method"
3283
2769
return dbus.Array(c.dbus_object_path for c in
3284
tcp_server.clients.values())
3285
3286
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3287
"true"})
2770
tcp_server.clients.itervalues())
2771
3288
2772
@dbus.service.method(_interface,
3289
2773
out_signature="a{oa{sv}}")
3290
2774
def GetAllClientsWithProperties(self):
3291
2775
"D-Bus method"
3292
2776
return dbus.Dictionary(
3293
{c.dbus_object_path: c.GetAll(
3294
"se.recompile.Mandos.Client")
3295
for c in tcp_server.clients.values()},
2777
{ c.dbus_object_path: c.GetAll("")
2778
for c in tcp_server.clients.itervalues() },
3296
2779
signature="oa{sv}")
3297
2780
3298
2781
@dbus.service.method(_interface, in_signature="o")
3299
2782
def RemoveClient(self, object_path):
3300
2783
"D-Bus method"
3301
for c in tcp_server.clients.values():
2784
for c in tcp_server.clients.itervalues():
3302
2785
if c.dbus_object_path == object_path:
3303
2786
del tcp_server.clients[c.name]
3304
2787
c.remove_from_connection()
3305
# Don't signal the disabling
2788
# Don't signal anything except ClientRemoved
3306
2789
c.disable(quiet=True)
3307
# Emit D-Bus signal for removal
3308
self.client_removed_signal(c)
2790
# Emit D-Bus signal
2791
self.ClientRemoved(object_path, c.name)
3309
2792
return
3310
2793
raise KeyError(object_path)
3311
2794
3312
2795
del _interface
3313
3314
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3315
out_signature="a{oa{sa{sv}}}")
3316
def GetManagedObjects(self):
3317
"""D-Bus method"""
3318
return dbus.Dictionary(
3319
{client.dbus_object_path:
3320
dbus.Dictionary(
3321
{interface: client.GetAll(interface)
3322
for interface in
3323
client._get_all_interface_names()})
3324
for client in tcp_server.clients.values()})
3325
3326
def client_added_signal(self, client):
3327
"""Send the new standard signal and the old signal"""
3328
if use_dbus:
3329
# New standard signal
3330
self.InterfacesAdded(
3331
client.dbus_object_path,
3332
dbus.Dictionary(
3333
{interface: client.GetAll(interface)
3334
for interface in
3335
client._get_all_interface_names()}))
3336
# Old signal
3337
self.ClientAdded(client.dbus_object_path)
3338
3339
def client_removed_signal(self, client):
3340
"""Send the new standard signal and the old signal"""
3341
if use_dbus:
3342
# New standard signal
3343
self.InterfacesRemoved(
3344
client.dbus_object_path,
3345
client._get_all_interface_names())
3346
# Old signal
3347
self.ClientRemoved(client.dbus_object_path,
3348
client.name)
3349
2796
3350
2797
mandos_dbus_service = MandosDBusService()
3351
3352
# Save modules to variables to exempt the modules from being
3353
# unloaded before the function registered with atexit() is run.
3354
mp = multiprocessing
3355
wn = wnull
3356
2798
3357
2799
def cleanup():
3358
2800
"Cleanup function; run on exit"
3359
2801
if zeroconf:
3360
2802
service.cleanup()
3361
3362
mp.active_children()
3363
wn.close()
2803
2804
multiprocessing.active_children()
2805
wnull.close()
3364
2806
if not (tcp_server.clients or client_settings):
3365
2807
return
3366
2808
3367
2809
# Store client before exiting. Secrets are encrypted with key
3368
2810
# based on what config file has. If config file is
3369
2811
# removed/edited, old secret will thus be unrecovable.
3370
2812
clients = {}
3371
2813
with PGPEngine() as pgp:
3372
for client in tcp_server.clients.values():
2814
for client in tcp_server.clients.itervalues():
3373
2815
key = client_settings[client.name]["secret"]
3374
2816
client.encrypted_secret = pgp.encrypt(client.secret,
3375
2817
key)
3376
2818
client_dict = {}
3377
2819
3378
2820
# A list of attributes that can not be pickled
3379
2821
# + secret.
3380
exclude = {"bus", "changedstate", "secret",
3381
"checker", "server_settings"}
2822
exclude = { "bus", "changedstate", "secret",
2823
"checker", "server_settings" }
3382
2824
for name, typ in inspect.getmembers(dbus.service
3383
2825
.Object):
3384
2826
exclude.add(name)
3385
2827
3386
2828
client_dict["encrypted_secret"] = (client
3387
2829
.encrypted_secret)
3388
2830
for attr in client.client_structure:
3389
2831
if attr not in exclude:
3390
2832
client_dict[attr] = getattr(client, attr)
3391
2833
3392
2834
clients[client.name] = client_dict
3393
2835
del client_settings[client.name]["secret"]
3394
2836
3395
2837
try:
3396
2838
with tempfile.NamedTemporaryFile(
3397
2839
mode='wb',
3399
2841
prefix='clients-',
3400
2842
dir=os.path.dirname(stored_state_path),
3401
2843
delete=False) as stored_state:
3402
pickle.dump((clients, client_settings), stored_state,
3403
protocol=2)
2844
pickle.dump((clients, client_settings), stored_state)
3404
2845
tempname = stored_state.name
3405
2846
os.rename(tempname, stored_state_path)
3406
2847
except (IOError, OSError) as e:
3416
2857
logger.warning("Could not save persistent state:",
3417
2858
exc_info=e)
3418
2859
raise
3419
2860
3420
2861
# Delete all clients, and settings from config
3421
2862
while tcp_server.clients:
3422
2863
name, client = tcp_server.clients.popitem()
3423
2864
if use_dbus:
3424
2865
client.remove_from_connection()
3425
# Don't signal the disabling
2866
# Don't signal anything except ClientRemoved
3426
2867
client.disable(quiet=True)
3427
# Emit D-Bus signal for removal
3428
2868
if use_dbus:
3429
mandos_dbus_service.client_removed_signal(client)
2869
# Emit D-Bus signal
2870
mandos_dbus_service.ClientRemoved(
2871
client.dbus_object_path, client.name)
3430
2872
client_settings.clear()
3431
2873
3432
2874
atexit.register(cleanup)
3433
3434
for client in tcp_server.clients.values():
2875
2876
for client in tcp_server.clients.itervalues():
3435
2877
if use_dbus:
3436
# Emit D-Bus signal for adding
3437
mandos_dbus_service.client_added_signal(client)
2878
# Emit D-Bus signal
2879
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3438
2880
# Need to initiate checking of clients
3439
2881
if client.enabled:
3440
2882
client.init_checker()
3441
2883
3442
2884
tcp_server.enable()
3443
2885
tcp_server.server_activate()
3444
2886
3445
2887
# Find out what port we got
3446
2888
if zeroconf:
3447
2889
service.port = tcp_server.socket.getsockname()[1]
3452
2894
else: # IPv4
3453
2895
logger.info("Now listening on address %r, port %d",
3454
2896
*tcp_server.socket.getsockname())
3455
3456
# service.interface = tcp_server.socket.getsockname()[3]
3457
2897
2898
#service.interface = tcp_server.socket.getsockname()[3]
2899
3458
2900
try:
3459
2901
if zeroconf:
3460
2902
# From the Avahi example code
3465
2907
cleanup()
3466
2908
sys.exit(1)
3467
2909
# End of Avahi example code
3468
3469
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3470
lambda *args, **kwargs:
3471
(tcp_server.handle_request
3472
(*args[2:], **kwargs) or True))
3473
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
3474
2916
logger.debug("Starting main loop")
3475
2917
main_loop.run()
3476
2918
except AvahiError as error:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0