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