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