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