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