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