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