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