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