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