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