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