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