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