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