To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 466
- compare with another revision
- download diff
- download tarball
- view history from revision 466
- Committer: Teddy Hogeborn
- Date: 2011-02-27 17:26:35 UTC
- Revision ID: teddy@fukt.bsnet.se-20110227172635-hw1sire7k3vuo1co
Update copyright year to "2011" wherever appropriate.
- 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
#
32
# Contact the authors at <mandos@recompile.se>.
33
#
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
#
31
# Contact the authors at <mandos@fukt.bsnet.se>.
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
import argparse
39
import optparse
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
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
65
84
66
import dbus
85
67
import dbus.service
86
import gi
87
from gi.repository import GLib
68
import gobject
69
import avahi
88
70
from dbus.mainloop.glib import DBusGMainLoop
89
71
import ctypes
90
72
import ctypes.util
91
73
import xml.dom.minidom
92
74
import inspect
93
75
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:
76
try:
122
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
78
except AttributeError:
124
79
try:
125
# This is where SO_BINDTODEVICE was up to and including Python
126
# 2.6, and also 3.2:
127
80
from IN import SO_BINDTODEVICE
128
81
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
82
SO_BINDTODEVICE = None
83
84
85
version = "1.2.3"
86
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
94
' %(message)s'))
95
logger.addHandler(syslogger)
96
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
' %(levelname)s:'
100
' %(message)s'))
101
logger.addHandler(console)
331
102
332
103
class AvahiError(Exception):
333
104
def __init__(self, value, *args, **kwargs):
334
105
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
336
**kwargs)
337
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
338
109
339
110
class AvahiServiceError(AvahiError):
340
111
pass
341
112
342
343
113
class AvahiGroupError(AvahiError):
344
114
pass
345
115
346
116
347
class AvahiService:
117
class AvahiService(object):
348
118
"""An Avahi (Zeroconf) service.
349
119
350
120
Attributes:
351
121
interface: integer; avahi.IF_UNSPEC or an interface index.
352
122
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>
123
name: string; Example: 'Mandos'
124
type: string; Example: '_mandos._tcp'.
125
See <http://www.dns-sd.org/ServiceTypes.html>
356
126
port: integer; what port to announce
357
127
TXT: list of strings; TXT record for the service
358
128
domain: string; Domain to publish on, default to .local if empty.
364
134
server: D-Bus Server
365
135
bus: dbus.SystemBus()
366
136
"""
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):
137
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
138
servicetype = None, port = None, TXT = None,
139
domain = "", host = "", max_renames = 32768,
140
protocol = avahi.PROTO_UNSPEC, bus = None):
379
141
self.interface = interface
380
142
self.name = name
381
143
self.type = servicetype
389
151
self.group = None # our entry group
390
152
self.server = None
391
153
self.bus = bus
392
self.entry_group_state_changed_match = None
393
394
def rename(self, remove=True):
154
def rename(self):
395
155
"""Derived from the Avahi example code"""
396
156
if self.rename_count >= self.max_renames:
397
157
logger.critical("No suitable Zeroconf service name found"
398
158
" after %i retries, exiting.",
399
159
self.rename_count)
400
160
raise AvahiServiceError("Too many renames")
401
self.name = str(
402
self.server.GetAlternativeServiceName(self.name))
403
self.rename_count += 1
161
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
404
162
logger.info("Changing Zeroconf service name to %r ...",
405
163
self.name)
406
if remove:
407
self.remove()
164
syslogger.setFormatter(logging.Formatter
165
('Mandos (%s) [%%(process)d]:'
166
' %%(levelname)s: %%(message)s'
167
% self.name))
168
self.remove()
408
169
try:
409
170
self.add()
410
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
171
except dbus.exceptions.DBusException, error:
172
logger.critical("DBusException: %s", error)
173
self.cleanup()
174
os._exit(1)
175
self.rename_count += 1
420
176
def remove(self):
421
177
"""Derived from the Avahi example code"""
422
if self.entry_group_state_changed_match is not None:
423
self.entry_group_state_changed_match.remove()
424
self.entry_group_state_changed_match = None
425
178
if self.group is not None:
426
179
self.group.Reset()
427
428
180
def add(self):
429
181
"""Derived from the Avahi example code"""
430
self.remove()
431
182
if self.group is None:
432
183
self.group = dbus.Interface(
433
184
self.bus.get_object(avahi.DBUS_NAME,
434
185
self.server.EntryGroupNew()),
435
186
avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
self.entry_group_state_changed_match = (
437
self.group.connect_to_signal(
438
"StateChanged", self.entry_group_state_changed))
187
self.group.connect_to_signal('StateChanged',
188
self
189
.entry_group_state_changed)
439
190
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
191
self.name, self.type)
441
192
self.group.AddService(
447
198
dbus.UInt16(self.port),
448
199
avahi.string_array_to_txt_array(self.TXT))
449
200
self.group.Commit()
450
451
201
def entry_group_state_changed(self, state, error):
452
202
"""Derived from the Avahi example code"""
453
203
logger.debug("Avahi entry group state change: %i", state)
454
204
455
205
if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
206
logger.debug("Zeroconf service established.")
457
207
elif state == avahi.ENTRY_GROUP_COLLISION:
459
209
self.rename()
460
210
elif state == avahi.ENTRY_GROUP_FAILURE:
461
211
logger.critical("Avahi: Error in group state changed %s",
462
str(error))
463
raise AvahiGroupError("State changed: {!s}".format(error))
464
212
unicode(error))
213
raise AvahiGroupError("State changed: %s"
214
% unicode(error))
465
215
def cleanup(self):
466
216
"""Derived from the Avahi example code"""
467
217
if self.group is not None:
468
try:
469
self.group.Free()
470
except (dbus.exceptions.UnknownMethodException,
471
dbus.exceptions.DBusException):
472
pass
218
self.group.Free()
473
219
self.group = None
474
self.remove()
475
476
def server_state_changed(self, state, error=None):
220
def server_state_changed(self, state):
477
221
"""Derived from the Avahi example code"""
478
222
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
}
485
if state in bad_states:
486
if bad_states[state] is not None:
487
if error is None:
488
logger.error(bad_states[state])
489
else:
490
logger.error(bad_states[state] + ": %r", error)
491
self.cleanup()
223
if state == avahi.SERVER_COLLISION:
224
logger.error("Zeroconf server name collision")
225
self.remove()
492
226
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)
505
else:
506
if error is None:
507
logger.debug("Unknown state: %r", state)
508
else:
509
logger.debug("Unknown state: %r: %r", state, error)
510
227
self.add()
511
228
def activate(self):
512
229
"""Derived from the Avahi example code"""
513
230
if self.server is None:
514
231
self.server = dbus.Interface(
515
232
self.bus.get_object(avahi.DBUS_NAME,
516
avahi.DBUS_PATH_SERVER,
517
follow_name_owner_changes=True),
233
avahi.DBUS_PATH_SERVER),
518
234
avahi.DBUS_INTERFACE_SERVER)
519
235
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
236
self.server_state_changed)
521
237
self.server_state_changed(self.server.GetState())
522
238
523
239
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:
240
class Client(object):
876
241
"""A representation of a client host served by this server.
877
242
878
243
Attributes:
879
approved: bool(); None if not yet approved/disapproved
244
_approved: bool(); 'None' if not yet approved/disapproved
880
245
approval_delay: datetime.timedelta(); Time to wait for approval
881
246
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
247
checker: subprocess.Popen(); a running checker process used
248
to see if the client lives.
249
'None' if no process is running.
250
checker_callback_tag: a gobject event source tag, or None
886
251
checker_command: string; External command which is run to check
887
252
if client lives. %() expansions are done at
888
253
runtime with vars(self) as dict, so that for
889
254
instance %(name)s can be used in the command.
890
checker_initiator_tag: a GLib event source tag, or None
255
checker_initiator_tag: a gobject event source tag, or None
891
256
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
257
current_checker_command: string; current running checker_command
895
disable_initiator_tag: a GLib event source tag, or None
258
disable_hook: If set, called by disable() as disable_hook(self)
259
disable_initiator_tag: a gobject event source tag, or None
896
260
enabled: bool()
897
261
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
262
uniquely identify the client
901
263
host: string; available for use by the checker command
902
264
interval: datetime.timedelta(); How often to start a new checker
903
265
last_approval_request: datetime.datetime(); (UTC) or None
904
266
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
267
last_enabled: datetime.datetime(); (UTC)
911
268
name: string; from the config file, used in log messages and
912
269
D-Bus identifiers
913
270
secret: bytestring; sent verbatim (over TLS) to client
914
271
timeout: datetime.timedelta(); How long from last_checked_ok
915
272
until this client is disabled
916
extended_timeout: extra long timeout when secret has been sent
917
273
runtime_expansions: Allowed attributes for runtime expansion.
918
expires: datetime.datetime(); time (UTC) when a client will be
919
disabled, or None
920
server_settings: The server_settings dict from main()
921
274
"""
922
275
923
276
runtime_expansions = ("approval_delay", "approval_duration",
924
"created", "enabled", "expires", "key_id",
925
"fingerprint", "host", "interval",
926
"last_approval_request", "last_checked_ok",
277
"created", "enabled", "fingerprint",
278
"host", "interval", "last_checked_ok",
927
279
"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
280
940
281
@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):
282
def _timedelta_to_milliseconds(td):
283
"Convert a datetime.timedelta() to milliseconds"
284
return ((td.days * 24 * 60 * 60 * 1000)
285
+ (td.seconds * 1000)
286
+ (td.microseconds // 1000))
287
288
def timeout_milliseconds(self):
289
"Return the 'timeout' attribute in milliseconds"
290
return self._timedelta_to_milliseconds(self.timeout)
291
292
def interval_milliseconds(self):
293
"Return the 'interval' attribute in milliseconds"
294
return self._timedelta_to_milliseconds(self.interval)
295
296
def approval_delay_milliseconds(self):
297
return self._timedelta_to_milliseconds(self.approval_delay)
298
299
def __init__(self, name = None, disable_hook=None, config=None):
300
"""Note: the 'checker' key in 'config' sets the
301
'checker_command' attribute and *not* the 'checker'
302
attribute."""
995
303
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
304
if config is None:
305
config = {}
1013
306
logger.debug("Creating client %r", self.name)
1014
logger.debug(" Key ID: %s", self.key_id)
307
# Uppercase and remove spaces from fingerprint for later
308
# comparison purposes with return value from the fingerprint()
309
# function
310
self.fingerprint = (config["fingerprint"].upper()
311
.replace(" ", ""))
1015
312
logger.debug(" Fingerprint: %s", self.fingerprint)
1016
self.created = settings.get("created",
1017
datetime.datetime.utcnow())
1018
1019
# attributes specific for this server instance
313
if "secret" in config:
314
self.secret = config["secret"].decode("base64")
315
elif "secfile" in config:
316
with open(os.path.expanduser(os.path.expandvars
317
(config["secfile"])),
318
"rb") as secfile:
319
self.secret = secfile.read()
320
else:
321
raise TypeError("No secret or secfile for client %s"
322
% self.name)
323
self.host = config.get("host", "")
324
self.created = datetime.datetime.utcnow()
325
self.enabled = False
326
self.last_approval_request = None
327
self.last_enabled = None
328
self.last_checked_ok = None
329
self.timeout = string_to_delta(config["timeout"])
330
self.interval = string_to_delta(config["interval"])
331
self.disable_hook = disable_hook
1020
332
self.checker = None
1021
333
self.checker_initiator_tag = None
1022
334
self.disable_initiator_tag = None
1023
335
self.checker_callback_tag = None
336
self.checker_command = config["checker"]
1024
337
self.current_checker_command = None
1025
self.approved = None
338
self.last_connect = None
339
self._approved = None
340
self.approved_by_default = config.get("approved_by_default",
341
True)
1026
342
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
343
self.approval_delay = string_to_delta(
344
config["approval_delay"])
345
self.approval_duration = string_to_delta(
346
config["approval_duration"])
347
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
348
1040
349
def send_changedstate(self):
1041
with self.changedstate:
1042
self.changedstate.notify_all()
1043
350
self.changedstate.acquire()
351
self.changedstate.notify_all()
352
self.changedstate.release()
353
1044
354
def enable(self):
1045
355
"""Start this client's checker and timeout hooks"""
1046
356
if getattr(self, "enabled", False):
1047
357
# Already enabled
1048
358
return
1049
self.expires = datetime.datetime.utcnow() + self.timeout
1050
self.enabled = True
359
self.send_changedstate()
1051
360
self.last_enabled = datetime.datetime.utcnow()
1052
self.init_checker()
1053
self.send_changedstate()
1054
361
# Schedule a new checker to be started an 'interval' from now,
362
# and every interval from then on.
363
self.checker_initiator_tag = (gobject.timeout_add
364
(self.interval_milliseconds(),
365
self.start_checker))
366
# Schedule a disable() when 'timeout' has passed
367
self.disable_initiator_tag = (gobject.timeout_add
368
(self.timeout_milliseconds(),
369
self.disable))
370
self.enabled = True
371
# Also start a new checker *right now*.
372
self.start_checker()
373
1055
374
def disable(self, quiet=True):
1056
375
"""Disable this client."""
1057
376
if not getattr(self, "enabled", False):
1058
377
return False
1059
378
if not quiet:
379
self.send_changedstate()
380
if not quiet:
1060
381
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)
382
if getattr(self, "disable_initiator_tag", False):
383
gobject.source_remove(self.disable_initiator_tag)
1063
384
self.disable_initiator_tag = None
1064
self.expires = None
1065
if getattr(self, "checker_initiator_tag", None) is not None:
1066
GLib.source_remove(self.checker_initiator_tag)
385
if getattr(self, "checker_initiator_tag", False):
386
gobject.source_remove(self.checker_initiator_tag)
1067
387
self.checker_initiator_tag = None
1068
388
self.stop_checker()
389
if self.disable_hook:
390
self.disable_hook(self)
1069
391
self.enabled = False
1070
if not quiet:
1071
self.send_changedstate()
1072
# Do not run this again if called by a GLib.timeout_add
392
# Do not run this again if called by a gobject.timeout_add
1073
393
return False
1074
394
1075
395
def __del__(self):
396
self.disable_hook = None
1076
397
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):
398
399
def checker_callback(self, pid, condition, command):
1097
400
"""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
401
self.checker_callback_tag = None
1104
402
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:
403
if os.WIFEXITED(condition):
404
exitstatus = os.WEXITSTATUS(condition)
405
if exitstatus == 0:
1110
406
logger.info("Checker for %(name)s succeeded",
1111
407
vars(self))
1112
408
self.checked_ok()
1113
409
else:
1114
logger.info("Checker for %(name)s failed", vars(self))
410
logger.info("Checker for %(name)s failed",
411
vars(self))
1115
412
else:
1116
self.last_checker_status = -1
1117
self.last_checker_signal = -returncode
1118
413
logger.warning("Checker for %(name)s crashed?",
1119
414
vars(self))
1120
return False
1121
415
1122
416
def checked_ok(self):
1123
"""Assert that the client has been seen, alive and well."""
417
"""Bump up the timeout for this client.
418
419
This should only be called when the client has been seen,
420
alive and well.
421
"""
1124
422
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."""
1131
if timeout is None:
1132
timeout = self.timeout
1133
if self.disable_initiator_tag is not None:
1134
GLib.source_remove(self.disable_initiator_tag)
1135
self.disable_initiator_tag = None
1136
if getattr(self, "enabled", False):
1137
self.disable_initiator_tag = GLib.timeout_add(
1138
int(timeout.total_seconds() * 1000), self.disable)
1139
self.expires = datetime.datetime.utcnow() + timeout
1140
423
gobject.source_remove(self.disable_initiator_tag)
424
self.disable_initiator_tag = (gobject.timeout_add
425
(self.timeout_milliseconds(),
426
self.disable))
427
1141
428
def need_approval(self):
1142
429
self.last_approval_request = datetime.datetime.utcnow()
1143
430
1144
431
def start_checker(self):
1145
432
"""Start a new checker subprocess if one is not running.
1146
433
1147
434
If a checker already exists, leave it running and do
1148
435
nothing."""
1149
436
# 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
437
# did that, then if a checker (for some reason) started
438
# running slowly and taking more than 'interval' time, the
439
# client would inevitably timeout, since no checker would get
440
# a chance to run to completion. If we instead leave running
1154
441
# checkers alone, the checker would have to take more time
1155
442
# than 'timeout' for the client to be disabled, which is as it
1156
443
# 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
444
445
# If a checker exists, make sure it is not a zombie
446
try:
447
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
448
except (AttributeError, OSError), error:
449
if (isinstance(error, OSError)
450
and error.errno != errno.ECHILD):
451
raise error
452
else:
453
if pid:
454
logger.warning("Checker was a zombie")
455
gobject.source_remove(self.checker_callback_tag)
456
self.checker_callback(pid, status,
457
self.current_checker_command)
1162
458
# Start a new checker if needed
1163
459
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
460
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
461
# In case checker_command has exactly one % operator
462
command = self.checker_command % self.host
463
except TypeError:
464
# Escape attributes for the shell
465
escaped_attrs = dict(
466
(attr,
467
re.escape(unicode(str(getattr(self, attr, "")),
468
errors=
469
'replace')))
470
for attr in
471
self.runtime_expansions)
472
473
try:
474
command = self.checker_command % escaped_attrs
475
except TypeError, error:
476
logger.error('Could not format string "%s":'
477
' %s', self.checker_command, error)
478
return True # Try again later
1175
479
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
480
try:
481
logger.info("Starting checker %r for %s",
482
command, self.name)
483
# We don't need to redirect stdout and stderr, since
484
# in normal mode, that is already done by daemon(),
485
# and in debug mode we don't want to. (Stdin is
486
# always replaced by /dev/null.)
487
self.checker = subprocess.Popen(command,
488
close_fds=True,
489
shell=True, cwd="/")
490
self.checker_callback_tag = (gobject.child_watch_add
491
(self.checker.pid,
492
self.checker_callback,
493
data=command))
494
# The checker may have completed before the gobject
495
# watch was added. Check for this.
496
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
497
if pid:
498
gobject.source_remove(self.checker_callback_tag)
499
self.checker_callback(pid, status, command)
500
except OSError, error:
501
logger.error("Failed to start subprocess: %s",
502
error)
503
# Re-run this periodically if run by gobject.timeout_add
1203
504
return True
1204
505
1205
506
def stop_checker(self):
1206
507
"""Force the checker process, if any, to stop."""
1207
508
if self.checker_callback_tag:
1208
GLib.source_remove(self.checker_callback_tag)
509
gobject.source_remove(self.checker_callback_tag)
1209
510
self.checker_callback_tag = None
1210
511
if getattr(self, "checker", None) is None:
1211
512
return
1212
513
logger.debug("Stopping checker for %(name)s", vars(self))
1213
self.checker.terminate()
514
try:
515
os.kill(self.checker.pid, signal.SIGTERM)
516
#time.sleep(0.5)
517
#if self.checker.poll() is None:
518
# os.kill(self.checker.pid, signal.SIGKILL)
519
except OSError, error:
520
if error.errno != errno.ESRCH: # No such process
521
raise
1214
522
self.checker = None
1215
523
1216
1217
def dbus_service_property(dbus_interface,
1218
signature="v",
1219
access="readwrite",
1220
byte_arrays=False):
524
def dbus_service_property(dbus_interface, signature="v",
525
access="readwrite", byte_arrays=False):
1221
526
"""Decorators for marking methods of a DBusObjectWithProperties to
1222
527
become properties on the D-Bus.
1223
528
1224
529
The decorated method will be called with no arguments by "Get"
1225
530
and with one argument by "Set".
1226
531
1227
532
The parameters, where they are supported, are the same as
1228
533
dbus.service.method, except there is only "signature", since the
1229
534
type from Get() and the type sent to Set() is the same.
1232
537
# "Set" method, so we fail early here:
1233
538
if byte_arrays and signature != "ay":
1234
539
raise ValueError("Byte arrays not supported for non-'ay'"
1235
" signature {!r}".format(signature))
1236
540
" signature %r" % signature)
1237
541
def decorator(func):
1238
542
func._dbus_is_property = True
1239
543
func._dbus_interface = dbus_interface
1242
546
func._dbus_name = func.__name__
1243
547
if func._dbus_name.endswith("_dbus_property"):
1244
548
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
549
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
550
return func
1291
551
return decorator
1292
552
1293
553
1294
554
class DBusPropertyException(dbus.exceptions.DBusException):
1295
555
"""A base class for D-Bus property-related exceptions
1296
556
"""
1297
pass
557
def __unicode__(self):
558
return unicode(str(self))
1298
559
1299
560
1300
561
class DBusPropertyAccessException(DBusPropertyException):
1309
570
pass
1310
571
1311
572
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):
573
class DBusObjectWithProperties(dbus.service.Object):
1402
574
"""A D-Bus object with properties.
1403
575
1404
576
Classes inheriting from this can use the dbus_service_property
1405
577
decorator to expose methods as D-Bus properties. It exposes the
1406
578
standard Get(), Set(), and GetAll() methods on the D-Bus.
1407
579
"""
1408
580
581
@staticmethod
582
def _is_dbus_property(obj):
583
return getattr(obj, "_dbus_is_property", False)
584
585
def _get_all_dbus_properties(self):
586
"""Returns a generator of (name, attribute) pairs
587
"""
588
return ((prop._dbus_name, prop)
589
for name, prop in
590
inspect.getmembers(self, self._is_dbus_property))
591
1409
592
def _get_dbus_property(self, interface_name, property_name):
1410
593
"""Returns a bound method if one exists which is a D-Bus
1411
594
property with the specified name and interface.
1412
595
"""
1413
for cls in self.__class__.__mro__:
1414
for name, value in inspect.getmembers(
1415
cls, self._is_dbus_thing("property")):
1416
if (value._dbus_name == property_name
1417
and value._dbus_interface == interface_name):
1418
return value.__get__(self)
1419
596
for name in (property_name,
597
property_name + "_dbus_property"):
598
prop = getattr(self, name, None)
599
if (prop is None
600
or not self._is_dbus_property(prop)
601
or prop._dbus_name != property_name
602
or (interface_name and prop._dbus_interface
603
and interface_name != prop._dbus_interface)):
604
continue
605
return prop
1420
606
# 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",
607
raise DBusPropertyNotFound(self.dbus_object_path + ":"
608
+ interface_name + "."
609
+ property_name)
610
611
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1435
612
out_signature="v")
1436
613
def Get(self, interface_name, property_name):
1437
614
"""Standard D-Bus property Get() method, see D-Bus standard.
1443
620
if not hasattr(value, "variant_level"):
1444
621
return value
1445
622
return type(value)(value, variant_level=value.variant_level+1)
1446
623
1447
624
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1448
625
def Set(self, interface_name, property_name, value):
1449
626
"""Standard D-Bus property Set() method, see D-Bus standard.
1455
632
# The byte_arrays option is not supported yet on
1456
633
# signatures other than "ay".
1457
634
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))
635
raise ValueError
636
value = dbus.ByteArray(''.join(unichr(byte)
637
for byte in value))
1462
638
prop(value)
1463
1464
@dbus.service.method(dbus.PROPERTIES_IFACE,
1465
in_signature="s",
639
640
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1466
641
out_signature="a{sv}")
1467
642
def GetAll(self, interface_name):
1468
643
"""Standard D-Bus property GetAll() method, see D-Bus
1470
645
1471
646
Note: Will not include properties with access="write".
1472
647
"""
1473
properties = {}
1474
for name, prop in self._get_all_dbus_things("property"):
648
all = {}
649
for name, prop in self._get_all_dbus_properties():
1475
650
if (interface_name
1476
651
and interface_name != prop._dbus_interface):
1477
652
# Interface non-empty but did not match
1481
656
continue
1482
657
value = prop()
1483
658
if not hasattr(value, "variant_level"):
1484
properties[name] = value
659
all[name] = value
1485
660
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
661
all[name] = type(value)(value, variant_level=
662
value.variant_level+1)
663
return dbus.Dictionary(all, signature="sv")
664
1498
665
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1499
666
out_signature="s",
1500
path_keyword="object_path",
1501
connection_keyword="connection")
667
path_keyword='object_path',
668
connection_keyword='connection')
1502
669
def Introspect(self, object_path, connection):
1503
"""Overloading of standard D-Bus method.
1504
1505
Inserts property tags and interface annotation tags.
670
"""Standard D-Bus method, overloaded to insert property tags.
1506
671
"""
1507
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1508
object_path,
1509
connection)
672
xmlstring = dbus.service.Object.Introspect(self, object_path,
673
connection)
1510
674
try:
1511
675
document = xml.dom.minidom.parseString(xmlstring)
1512
1513
676
def make_tag(document, name, prop):
1514
677
e = document.createElement("property")
1515
678
e.setAttribute("name", name)
1516
679
e.setAttribute("type", prop._dbus_signature)
1517
680
e.setAttribute("access", prop._dbus_access)
1518
681
return e
1519
1520
682
for if_tag in document.getElementsByTagName("interface"):
1521
# Add property tags
1522
683
for tag in (make_tag(document, name, prop)
1523
684
for name, prop
1524
in self._get_all_dbus_things("property")
685
in self._get_all_dbus_properties()
1525
686
if prop._dbus_interface
1526
687
== if_tag.getAttribute("name")):
1527
688
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
689
# Add the names to the return values for the
1545
690
# "org.freedesktop.DBus.Properties" methods
1546
691
if (if_tag.getAttribute("name")
1559
704
xmlstring = document.toxml("utf-8")
1560
705
document.unlink()
1561
706
except (AttributeError, xml.dom.DOMException,
1562
xml.parsers.expat.ExpatError) as error:
1563
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):
1640
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1641
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).
1668
"""
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):
1677
# Ignore non-D-Bus attributes, and D-Bus attributes
1678
# with the wrong interface name
1679
if (not hasattr(attribute, "_dbus_interface")
1680
or not attribute._dbus_interface.startswith(
1681
orig_interface_name)):
1682
continue
1683
# Create an alternate D-Bus interface name based on
1684
# the current name
1685
alt_interface = attribute._dbus_interface.replace(
1686
orig_interface_name, alt_interface_name)
1687
interface_names.add(alt_interface)
1688
# Is this a D-Bus signal?
1689
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(
1694
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)
1702
# Create a new, but exactly alike, function
1703
# object, and decorate it to be a new D-Bus signal
1704
# 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
1716
# 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
1720
def fixscope(func1, func2):
1721
"""This function is a scope container to pass
1722
func1 and func2 to the "call_both" function
1723
outside of its arguments"""
1724
1725
@functools.wraps(func2)
1726
def call_both(*args, **kwargs):
1727
"""This function will emit two D-Bus
1728
signals by calling func1 and func2"""
1729
func1(*args, **kwargs)
1730
func2(*args, **kwargs)
1731
# Make wrapper function look like a D-Bus
1732
# signal
1733
for name, attr in inspect.getmembers(func2):
1734
if name.startswith("_dbus_"):
1735
setattr(call_both, name, attr)
1736
1737
return call_both
1738
# Create the "call_both" function and add it to
1739
# the class
1740
attr[attrname] = fixscope(attribute, new_function)
1741
# Is this a D-Bus method?
1742
elif getattr(attribute, "_dbus_is_method", False):
1743
# Create a new, but exactly alike, function
1744
# object. Decorate it to be a new D-Bus method
1745
# with the alternate D-Bus interface name. Add it
1746
# 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
1759
# Is this a D-Bus property?
1760
elif getattr(attribute, "_dbus_is_property", False):
1761
# Create a new, but exactly alike, function
1762
# object, and decorate it to be a new D-Bus
1763
# property with the alternate D-Bus interface
1764
# 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"})
707
xml.parsers.expat.ExpatError), error:
708
logger.error("Failed to override Introspection method",
709
error)
710
return xmlstring
711
712
1817
713
class ClientDBus(Client, DBusObjectWithProperties):
1818
714
"""A Client class using D-Bus
1819
715
1820
716
Attributes:
1821
717
dbus_object_path: dbus.ObjectPath
1822
718
bus: dbus.SystemBus()
1823
719
"""
1824
720
1825
721
runtime_expansions = (Client.runtime_expansions
1826
+ ("dbus_object_path", ))
1827
1828
_interface = "se.recompile.Mandos.Client"
1829
722
+ ("dbus_object_path",))
723
1830
724
# dbus.service.Object doesn't use super(), so we can't either.
1831
1832
def __init__(self, bus=None, *args, **kwargs):
725
726
def __init__(self, bus = None, *args, **kwargs):
727
self._approvals_pending = 0
1833
728
self.bus = bus
1834
729
Client.__init__(self, *args, **kwargs)
1835
730
# Only now, when this client is initialized, can it show up on
1836
731
# the D-Bus
1837
client_object_name = str(self.name).translate(
732
client_object_name = unicode(self.name).translate(
1838
733
{ord("."): ord("_"),
1839
734
ord("-"): ord("_")})
1840
self.dbus_object_path = dbus.ObjectPath(
1841
"/clients/" + client_object_name)
735
self.dbus_object_path = (dbus.ObjectPath
736
("/clients/" + client_object_name))
1842
737
DBusObjectWithProperties.__init__(self, self.bus,
1843
738
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):
1850
""" Modify a variable so that it's a property which announces
1851
its changes to DBus.
1852
1853
transform_fun: Function that takes a value and a variant_level
1854
and transforms it to a D-Bus type.
1855
dbus_name: D-Bus name of the variable
1856
type_func: Function that transform the value before sending it
1857
to the D-Bus. Default: no transform
1858
variant_level: D-Bus variant level. Default: 1
1859
"""
1860
attrname = "_{}".format(dbus_name)
1861
1862
def setter(self, value):
1863
if hasattr(self, "dbus_object_path"):
1864
if (not hasattr(self, attrname) or
1865
type_func(getattr(self, attrname, None))
1866
!= 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())
1882
setattr(self, attrname, value)
1883
1884
return property(lambda self: getattr(self, attrname), setter)
1885
1886
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1887
approvals_pending = notifychangeproperty(dbus.Boolean,
1888
"ApprovalPending",
1889
type_func=bool)
1890
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1891
last_enabled = notifychangeproperty(datetime_to_dbus,
1892
"LastEnabled")
1893
checker = notifychangeproperty(
1894
dbus.Boolean, "CheckerRunning",
1895
type_func=lambda checker: checker is not None)
1896
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1897
"LastCheckedOK")
1898
last_checker_status = notifychangeproperty(dbus.Int16,
1899
"LastCheckerStatus")
1900
last_approval_request = notifychangeproperty(
1901
datetime_to_dbus, "LastApprovalRequest")
1902
approved_by_default = notifychangeproperty(dbus.Boolean,
1903
"ApprovedByDefault")
1904
approval_delay = notifychangeproperty(
1905
dbus.UInt64, "ApprovalDelay",
1906
type_func=lambda td: td.total_seconds() * 1000)
1907
approval_duration = notifychangeproperty(
1908
dbus.UInt64, "ApprovalDuration",
1909
type_func=lambda td: td.total_seconds() * 1000)
1910
host = notifychangeproperty(dbus.String, "Host")
1911
timeout = notifychangeproperty(
1912
dbus.UInt64, "Timeout",
1913
type_func=lambda td: td.total_seconds() * 1000)
1914
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)
1920
checker_command = notifychangeproperty(dbus.String, "Checker")
1921
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1922
invalidate_only=True)
1923
1924
del notifychangeproperty
1925
739
740
def _get_approvals_pending(self):
741
return self._approvals_pending
742
def _set_approvals_pending(self, value):
743
old_value = self._approvals_pending
744
self._approvals_pending = value
745
bval = bool(value)
746
if (hasattr(self, "dbus_object_path")
747
and bval is not bool(old_value)):
748
dbus_bool = dbus.Boolean(bval, variant_level=1)
749
self.PropertyChanged(dbus.String("ApprovalPending"),
750
dbus_bool)
751
752
approvals_pending = property(_get_approvals_pending,
753
_set_approvals_pending)
754
del _get_approvals_pending, _set_approvals_pending
755
756
@staticmethod
757
def _datetime_to_dbus(dt, variant_level=0):
758
"""Convert a UTC datetime.datetime() to a D-Bus type."""
759
return dbus.String(dt.isoformat(),
760
variant_level=variant_level)
761
762
def enable(self):
763
oldstate = getattr(self, "enabled", False)
764
r = Client.enable(self)
765
if oldstate != self.enabled:
766
# Emit D-Bus signals
767
self.PropertyChanged(dbus.String("Enabled"),
768
dbus.Boolean(True, variant_level=1))
769
self.PropertyChanged(
770
dbus.String("LastEnabled"),
771
self._datetime_to_dbus(self.last_enabled,
772
variant_level=1))
773
return r
774
775
def disable(self, quiet = False):
776
oldstate = getattr(self, "enabled", False)
777
r = Client.disable(self, quiet=quiet)
778
if not quiet and oldstate != self.enabled:
779
# Emit D-Bus signal
780
self.PropertyChanged(dbus.String("Enabled"),
781
dbus.Boolean(False, variant_level=1))
782
return r
783
1926
784
def __del__(self, *args, **kwargs):
1927
785
try:
1928
786
self.remove_from_connection()
1931
789
if hasattr(DBusObjectWithProperties, "__del__"):
1932
790
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1933
791
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:
792
793
def checker_callback(self, pid, condition, command,
794
*args, **kwargs):
795
self.checker_callback_tag = None
796
self.checker = None
797
# Emit D-Bus signal
798
self.PropertyChanged(dbus.String("CheckerRunning"),
799
dbus.Boolean(False, variant_level=1))
800
if os.WIFEXITED(condition):
801
exitstatus = os.WEXITSTATUS(condition)
1942
802
# Emit D-Bus signal
1943
803
self.CheckerCompleted(dbus.Int16(exitstatus),
1944
# This is specific to GNU libC
1945
dbus.Int64(exitstatus << 8),
804
dbus.Int64(condition),
1946
805
dbus.String(command))
1947
806
else:
1948
807
# Emit D-Bus signal
1949
808
self.CheckerCompleted(dbus.Int16(-1),
1950
dbus.Int64(
1951
# This is specific to GNU libC
1952
(exitstatus << 8)
1953
| self.last_checker_signal),
809
dbus.Int64(condition),
1954
810
dbus.String(command))
1955
return ret
1956
811
812
return Client.checker_callback(self, pid, condition, command,
813
*args, **kwargs)
814
815
def checked_ok(self, *args, **kwargs):
816
r = Client.checked_ok(self, *args, **kwargs)
817
# Emit D-Bus signal
818
self.PropertyChanged(
819
dbus.String("LastCheckedOK"),
820
(self._datetime_to_dbus(self.last_checked_ok,
821
variant_level=1)))
822
return r
823
824
def need_approval(self, *args, **kwargs):
825
r = Client.need_approval(self, *args, **kwargs)
826
# Emit D-Bus signal
827
self.PropertyChanged(
828
dbus.String("LastApprovalRequest"),
829
(self._datetime_to_dbus(self.last_approval_request,
830
variant_level=1)))
831
return r
832
1957
833
def start_checker(self, *args, **kwargs):
1958
old_checker_pid = getattr(self.checker, "pid", None)
834
old_checker = self.checker
835
if self.checker is not None:
836
old_checker_pid = self.checker.pid
837
else:
838
old_checker_pid = None
1959
839
r = Client.start_checker(self, *args, **kwargs)
1960
840
# Only if new checker process was started
1961
841
if (self.checker is not None
1962
842
and old_checker_pid != self.checker.pid):
1963
843
# Emit D-Bus signal
1964
844
self.CheckerStarted(self.current_checker_command)
845
self.PropertyChanged(
846
dbus.String("CheckerRunning"),
847
dbus.Boolean(True, variant_level=1))
848
return r
849
850
def stop_checker(self, *args, **kwargs):
851
old_checker = getattr(self, "checker", None)
852
r = Client.stop_checker(self, *args, **kwargs)
853
if (old_checker is not None
854
and getattr(self, "checker", None) is None):
855
self.PropertyChanged(dbus.String("CheckerRunning"),
856
dbus.Boolean(False, variant_level=1))
1965
857
return r
1966
858
1967
859
def _reset_approved(self):
1968
self.approved = None
860
self._approved = None
1969
861
return False
1970
862
1971
863
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
864
self.send_changedstate()
1976
1977
# D-Bus methods, signals & properties
1978
1979
# Interfaces
1980
1981
# Signals
1982
865
self._approved = value
866
gobject.timeout_add(self._timedelta_to_milliseconds
867
(self.approval_duration),
868
self._reset_approved)
869
870
871
## D-Bus methods, signals & properties
872
_interface = "se.bsnet.fukt.Mandos.Client"
873
874
## Signals
875
1983
876
# CheckerCompleted - signal
1984
877
@dbus.service.signal(_interface, signature="nxs")
1985
878
def CheckerCompleted(self, exitcode, waitstatus, command):
1986
879
"D-Bus signal"
1987
880
pass
1988
881
1989
882
# CheckerStarted - signal
1990
883
@dbus.service.signal(_interface, signature="s")
1991
884
def CheckerStarted(self, command):
1992
885
"D-Bus signal"
1993
886
pass
1994
887
1995
888
# PropertyChanged - signal
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
889
@dbus.service.signal(_interface, signature="sv")
1998
890
def PropertyChanged(self, property, value):
1999
891
"D-Bus signal"
2000
892
pass
2001
893
2002
894
# GotSecret - signal
2003
895
@dbus.service.signal(_interface)
2004
896
def GotSecret(self):
2007
899
server to mandos-client
2008
900
"""
2009
901
pass
2010
902
2011
903
# Rejected - signal
2012
904
@dbus.service.signal(_interface, signature="s")
2013
905
def Rejected(self, reason):
2014
906
"D-Bus signal"
2015
907
pass
2016
908
2017
909
# NeedApproval - signal
2018
910
@dbus.service.signal(_interface, signature="tb")
2019
911
def NeedApproval(self, timeout, default):
2020
912
"D-Bus signal"
2021
913
return self.need_approval()
2022
2023
# Methods
2024
914
915
## Methods
916
2025
917
# Approve - method
2026
918
@dbus.service.method(_interface, in_signature="b")
2027
919
def Approve(self, value):
2028
920
self.approve(value)
2029
921
2030
922
# CheckedOK - method
2031
923
@dbus.service.method(_interface)
2032
924
def CheckedOK(self):
2033
self.checked_ok()
2034
925
return self.checked_ok()
926
2035
927
# Enable - method
2036
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2037
928
@dbus.service.method(_interface)
2038
929
def Enable(self):
2039
930
"D-Bus method"
2040
931
self.enable()
2041
932
2042
933
# StartChecker - method
2043
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2044
934
@dbus.service.method(_interface)
2045
935
def StartChecker(self):
2046
936
"D-Bus method"
2047
937
self.start_checker()
2048
938
2049
939
# Disable - method
2050
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2051
940
@dbus.service.method(_interface)
2052
941
def Disable(self):
2053
942
"D-Bus method"
2054
943
self.disable()
2055
944
2056
945
# StopChecker - method
2057
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2058
946
@dbus.service.method(_interface)
2059
947
def StopChecker(self):
2060
948
self.stop_checker()
2061
2062
# Properties
2063
949
950
## Properties
951
2064
952
# ApprovalPending - property
2065
953
@dbus_service_property(_interface, signature="b", access="read")
2066
954
def ApprovalPending_dbus_property(self):
2067
955
return dbus.Boolean(bool(self.approvals_pending))
2068
956
2069
957
# ApprovedByDefault - property
2070
@dbus_service_property(_interface,
2071
signature="b",
958
@dbus_service_property(_interface, signature="b",
2072
959
access="readwrite")
2073
960
def ApprovedByDefault_dbus_property(self, value=None):
2074
961
if value is None: # get
2075
962
return dbus.Boolean(self.approved_by_default)
2076
963
self.approved_by_default = bool(value)
2077
964
# Emit D-Bus signal
965
self.PropertyChanged(dbus.String("ApprovedByDefault"),
966
dbus.Boolean(value, variant_level=1))
967
2078
968
# ApprovalDelay - property
2079
@dbus_service_property(_interface,
2080
signature="t",
969
@dbus_service_property(_interface, signature="t",
2081
970
access="readwrite")
2082
971
def ApprovalDelay_dbus_property(self, value=None):
2083
972
if value is None: # get
2084
return dbus.UInt64(self.approval_delay.total_seconds()
2085
* 1000)
973
return dbus.UInt64(self.approval_delay_milliseconds())
2086
974
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2087
975
# Emit D-Bus signal
976
self.PropertyChanged(dbus.String("ApprovalDelay"),
977
dbus.UInt64(value, variant_level=1))
978
2088
979
# ApprovalDuration - property
2089
@dbus_service_property(_interface,
2090
signature="t",
980
@dbus_service_property(_interface, signature="t",
2091
981
access="readwrite")
2092
982
def ApprovalDuration_dbus_property(self, value=None):
2093
983
if value is None: # get
2094
return dbus.UInt64(self.approval_duration.total_seconds()
2095
* 1000)
984
return dbus.UInt64(self._timedelta_to_milliseconds(
985
self.approval_duration))
2096
986
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2097
987
# Emit D-Bus signal
988
self.PropertyChanged(dbus.String("ApprovalDuration"),
989
dbus.UInt64(value, variant_level=1))
990
2098
991
# Name - property
2099
@dbus_annotations(
2100
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2101
992
@dbus_service_property(_interface, signature="s", access="read")
2102
993
def Name_dbus_property(self):
2103
994
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
995
2112
996
# Fingerprint - property
2113
@dbus_annotations(
2114
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2115
997
@dbus_service_property(_interface, signature="s", access="read")
2116
998
def Fingerprint_dbus_property(self):
2117
999
return dbus.String(self.fingerprint)
2118
1000
2119
1001
# Host - property
2120
@dbus_service_property(_interface,
2121
signature="s",
1002
@dbus_service_property(_interface, signature="s",
2122
1003
access="readwrite")
2123
1004
def Host_dbus_property(self, value=None):
2124
1005
if value is None: # get
2125
1006
return dbus.String(self.host)
2126
self.host = str(value)
2127
1007
self.host = value
1008
# Emit D-Bus signal
1009
self.PropertyChanged(dbus.String("Host"),
1010
dbus.String(value, variant_level=1))
1011
2128
1012
# Created - property
2129
@dbus_annotations(
2130
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2131
1013
@dbus_service_property(_interface, signature="s", access="read")
2132
1014
def Created_dbus_property(self):
2133
return datetime_to_dbus(self.created)
2134
1015
return dbus.String(self._datetime_to_dbus(self.created))
1016
2135
1017
# LastEnabled - property
2136
1018
@dbus_service_property(_interface, signature="s", access="read")
2137
1019
def LastEnabled_dbus_property(self):
2138
return datetime_to_dbus(self.last_enabled)
2139
1020
if self.last_enabled is None:
1021
return dbus.String("")
1022
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1023
2140
1024
# Enabled - property
2141
@dbus_service_property(_interface,
2142
signature="b",
1025
@dbus_service_property(_interface, signature="b",
2143
1026
access="readwrite")
2144
1027
def Enabled_dbus_property(self, value=None):
2145
1028
if value is None: # get
2148
1031
self.enable()
2149
1032
else:
2150
1033
self.disable()
2151
1034
2152
1035
# LastCheckedOK - property
2153
@dbus_service_property(_interface,
2154
signature="s",
1036
@dbus_service_property(_interface, signature="s",
2155
1037
access="readwrite")
2156
1038
def LastCheckedOK_dbus_property(self, value=None):
2157
1039
if value is not None:
2158
1040
self.checked_ok()
2159
1041
return
2160
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
2167
# Expires - property
2168
@dbus_service_property(_interface, signature="s", access="read")
2169
def Expires_dbus_property(self):
2170
return datetime_to_dbus(self.expires)
2171
1042
if self.last_checked_ok is None:
1043
return dbus.String("")
1044
return dbus.String(self._datetime_to_dbus(self
1045
.last_checked_ok))
1046
2172
1047
# LastApprovalRequest - property
2173
1048
@dbus_service_property(_interface, signature="s", access="read")
2174
1049
def LastApprovalRequest_dbus_property(self):
2175
return datetime_to_dbus(self.last_approval_request)
2176
1050
if self.last_approval_request is None:
1051
return dbus.String("")
1052
return dbus.String(self.
1053
_datetime_to_dbus(self
1054
.last_approval_request))
1055
2177
1056
# Timeout - property
2178
@dbus_service_property(_interface,
2179
signature="t",
1057
@dbus_service_property(_interface, signature="t",
2180
1058
access="readwrite")
2181
1059
def Timeout_dbus_property(self, value=None):
2182
1060
if value is None: # get
2183
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2184
old_timeout = self.timeout
1061
return dbus.UInt64(self.timeout_milliseconds())
2185
1062
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
2202
# ExtendedTimeout - property
2203
@dbus_service_property(_interface,
2204
signature="t",
2205
access="readwrite")
2206
def ExtendedTimeout_dbus_property(self, value=None):
2207
if value is None: # get
2208
return dbus.UInt64(self.extended_timeout.total_seconds()
2209
* 1000)
2210
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2211
1063
# Emit D-Bus signal
1064
self.PropertyChanged(dbus.String("Timeout"),
1065
dbus.UInt64(value, variant_level=1))
1066
if getattr(self, "disable_initiator_tag", None) is None:
1067
return
1068
# Reschedule timeout
1069
gobject.source_remove(self.disable_initiator_tag)
1070
self.disable_initiator_tag = None
1071
time_to_die = (self.
1072
_timedelta_to_milliseconds((self
1073
.last_checked_ok
1074
+ self.timeout)
1075
- datetime.datetime
1076
.utcnow()))
1077
if time_to_die <= 0:
1078
# The timeout has passed
1079
self.disable()
1080
else:
1081
self.disable_initiator_tag = (gobject.timeout_add
1082
(time_to_die, self.disable))
1083
2212
1084
# Interval - property
2213
@dbus_service_property(_interface,
2214
signature="t",
1085
@dbus_service_property(_interface, signature="t",
2215
1086
access="readwrite")
2216
1087
def Interval_dbus_property(self, value=None):
2217
1088
if value is None: # get
2218
return dbus.UInt64(self.interval.total_seconds() * 1000)
1089
return dbus.UInt64(self.interval_milliseconds())
2219
1090
self.interval = datetime.timedelta(0, 0, 0, value)
1091
# Emit D-Bus signal
1092
self.PropertyChanged(dbus.String("Interval"),
1093
dbus.UInt64(value, variant_level=1))
2220
1094
if getattr(self, "checker_initiator_tag", None) is None:
2221
1095
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
1096
# Reschedule checker run
1097
gobject.source_remove(self.checker_initiator_tag)
1098
self.checker_initiator_tag = (gobject.timeout_add
1099
(value, self.start_checker))
1100
self.start_checker() # Start one now, too
2228
1101
2229
1102
# Checker - property
2230
@dbus_service_property(_interface,
2231
signature="s",
1103
@dbus_service_property(_interface, signature="s",
2232
1104
access="readwrite")
2233
1105
def Checker_dbus_property(self, value=None):
2234
1106
if value is None: # get
2235
1107
return dbus.String(self.checker_command)
2236
self.checker_command = str(value)
2237
1108
self.checker_command = value
1109
# Emit D-Bus signal
1110
self.PropertyChanged(dbus.String("Checker"),
1111
dbus.String(self.checker_command,
1112
variant_level=1))
1113
2238
1114
# CheckerRunning - property
2239
@dbus_service_property(_interface,
2240
signature="b",
1115
@dbus_service_property(_interface, signature="b",
2241
1116
access="readwrite")
2242
1117
def CheckerRunning_dbus_property(self, value=None):
2243
1118
if value is None: # get
2246
1121
self.start_checker()
2247
1122
else:
2248
1123
self.stop_checker()
2249
1124
2250
1125
# ObjectPath - property
2251
@dbus_annotations(
2252
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2253
"org.freedesktop.DBus.Deprecated": "true"})
2254
1126
@dbus_service_property(_interface, signature="o", access="read")
2255
1127
def ObjectPath_dbus_property(self):
2256
return self.dbus_object_path # is already a dbus.ObjectPath
2257
1128
return self.dbus_object_path # is already a dbus.ObjectPath
1129
2258
1130
# 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)
1131
@dbus_service_property(_interface, signature="ay",
1132
access="write", byte_arrays=True)
2266
1133
def Secret_dbus_property(self, value):
2267
self.secret = bytes(value)
2268
1134
self.secret = str(value)
1135
2269
1136
del _interface
2270
1137
2271
1138
2272
class ProxyClient:
2273
def __init__(self, child_pipe, key_id, fpr, address):
1139
class ProxyClient(object):
1140
def __init__(self, child_pipe, fpr, address):
2274
1141
self._pipe = child_pipe
2275
self._pipe.send(("init", key_id, fpr, address))
1142
self._pipe.send(('init', fpr, address))
2276
1143
if not self._pipe.recv():
2277
raise KeyError(key_id or fpr)
1144
raise KeyError()
2278
1145
2279
1146
def __getattribute__(self, name):
2280
if name == "_pipe":
1147
if(name == '_pipe'):
2281
1148
return super(ProxyClient, self).__getattribute__(name)
2282
self._pipe.send(("getattr", name))
1149
self._pipe.send(('getattr', name))
2283
1150
data = self._pipe.recv()
2284
if data[0] == "data":
1151
if data[0] == 'data':
2285
1152
return data[1]
2286
if data[0] == "function":
2287
1153
if data[0] == 'function':
2288
1154
def func(*args, **kwargs):
2289
self._pipe.send(("funcall", name, args, kwargs))
1155
self._pipe.send(('funcall', name, args, kwargs))
2290
1156
return self._pipe.recv()[1]
2291
2292
1157
return func
2293
1158
2294
1159
def __setattr__(self, name, value):
2295
if name == "_pipe":
1160
if(name == '_pipe'):
2296
1161
return super(ProxyClient, self).__setattr__(name, value)
2297
self._pipe.send(("setattr", name, value))
1162
self._pipe.send(('setattr', name, value))
2298
1163
2299
1164
2300
1165
class ClientHandler(socketserver.BaseRequestHandler, object):
2301
1166
"""A class to handle client connections.
2302
1167
2303
1168
Instantiated once for each connection to handle it.
2304
1169
Note: This will run in its own forked process."""
2305
1170
2306
1171
def handle(self):
2307
1172
with contextlib.closing(self.server.child_pipe) as child_pipe:
2308
1173
logger.info("TCP connection from: %s",
2309
str(self.client_address))
1174
unicode(self.client_address))
2310
1175
logger.debug("Pipe FD: %d",
2311
1176
self.server.child_pipe.fileno())
2312
1177
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"))
1178
session = (gnutls.connection
1179
.ClientSession(self.request,
1180
gnutls.connection
1181
.X509Credentials()))
1182
1183
# Note: gnutls.connection.X509Credentials is really a
1184
# generic GnuTLS certificate credentials object so long as
1185
# no X.509 keys are added to it. Therefore, we can use it
1186
# here despite using OpenPGP certificates.
1187
1188
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1189
# "+AES-256-CBC", "+SHA1",
1190
# "+COMP-NULL", "+CTYPE-OPENPGP",
1191
# "+DHE-DSS"))
2319
1192
# Use a fallback default, since this MUST be set.
2320
1193
priority = self.server.gnutls_priority
2321
1194
if priority is None:
2322
1195
priority = "NORMAL"
2323
gnutls.priority_set_direct(session,
2324
priority.encode("utf-8"), None)
1196
(gnutls.library.functions
1197
.gnutls_priority_set_direct(session._c_object,
1198
priority, None))
2325
1199
2326
1200
# Start communication using the Mandos protocol
2327
1201
# Get protocol number
2329
1203
logger.debug("Protocol version: %r", line)
2330
1204
try:
2331
1205
if int(line.strip().split()[0]) > 1:
2332
raise RuntimeError(line)
2333
except (ValueError, IndexError, RuntimeError) as error:
1206
raise RuntimeError
1207
except (ValueError, IndexError, RuntimeError), error:
2334
1208
logger.error("Unknown protocol version: %s", error)
2335
1209
return
2336
1210
2337
1211
# Start GnuTLS connection
2338
1212
try:
2339
1213
session.handshake()
2340
except gnutls.Error as error:
1214
except gnutls.errors.GNUTLSError, error:
2341
1215
logger.warning("Handshake failed: %s", error)
2342
1216
# Do not run session.bye() here: the session is not
2343
1217
# established. Just abandon the request.
2346
1220
2347
1221
approval_required = False
2348
1222
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,
1223
try:
1224
fpr = self.fingerprint(self.peer_certificate
1225
(session))
1226
except (TypeError, gnutls.errors.GNUTLSError), error:
1227
logger.warning("Bad certificate: %s", error)
1228
return
1229
logger.debug("Fingerprint: %s", fpr)
1230
1231
try:
1232
client = ProxyClient(child_pipe, fpr,
2373
1233
self.client_address)
2374
1234
except KeyError:
2375
1235
return
2376
1236
2377
1237
if client.approval_delay:
2378
1238
delay = client.approval_delay
2379
1239
client.approvals_pending += 1
2380
1240
approval_required = True
2381
1241
2382
1242
while True:
2383
1243
if not client.enabled:
2384
logger.info("Client %s is disabled",
2385
client.name)
1244
logger.warning("Client %s is disabled",
1245
client.name)
2386
1246
if self.server.use_dbus:
2387
1247
# Emit D-Bus signal
2388
client.Rejected("Disabled")
1248
client.Rejected("Disabled")
2389
1249
return
2390
2391
if client.approved or not client.approval_delay:
2392
# We are approved or approval is disabled
1250
1251
if client._approved or not client.approval_delay:
1252
#We are approved or approval is disabled
2393
1253
break
2394
elif client.approved is None:
1254
elif client._approved is None:
2395
1255
logger.info("Client %s needs approval",
2396
1256
client.name)
2397
1257
if self.server.use_dbus:
2398
1258
# Emit D-Bus signal
2399
1259
client.NeedApproval(
2400
client.approval_delay.total_seconds()
2401
* 1000, client.approved_by_default)
1260
client.approval_delay_milliseconds(),
1261
client.approved_by_default)
2402
1262
else:
2403
1263
logger.warning("Client %s was not approved",
2404
1264
client.name)
2406
1266
# Emit D-Bus signal
2407
1267
client.Rejected("Denied")
2408
1268
return
2409
2410
# wait until timeout or approved
1269
1270
#wait until timeout or approved
1271
#x = float(client._timedelta_to_milliseconds(delay))
2411
1272
time = datetime.datetime.now()
2412
1273
client.changedstate.acquire()
2413
client.changedstate.wait(delay.total_seconds())
1274
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2414
1275
client.changedstate.release()
2415
1276
time2 = datetime.datetime.now()
2416
1277
if (time2 - time) >= delay:
2426
1287
break
2427
1288
else:
2428
1289
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
1290
1291
sent_size = 0
1292
while sent_size < len(client.secret):
1293
try:
1294
sent = session.send(client.secret[sent_size:])
1295
except (gnutls.errors.GNUTLSError), error:
1296
logger.warning("gnutls send failed")
1297
return
1298
logger.debug("Sent: %d, remaining: %d",
1299
sent, len(client.secret)
1300
- (sent_size + sent))
1301
sent_size += sent
2436
1302
2437
1303
logger.info("Sending secret to %s", client.name)
2438
# bump the timeout using extended_timeout
2439
client.bump_timeout(client.extended_timeout)
1304
# bump the timeout as if seen
1305
client.checked_ok()
2440
1306
if self.server.use_dbus:
2441
1307
# Emit D-Bus signal
2442
1308
client.GotSecret()
2443
1309
2444
1310
finally:
2445
1311
if approval_required:
2446
1312
client.approvals_pending -= 1
2447
1313
try:
2448
1314
session.bye()
2449
except gnutls.Error as error:
2450
logger.warning("GnuTLS bye failed",
2451
exc_info=error)
2452
1315
except (gnutls.errors.GNUTLSError), error:
1316
logger.warning("GnuTLS bye failed")
1317
2453
1318
@staticmethod
2454
1319
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""
1320
"Return the peer's OpenPGP certificate as a bytestring"
1321
# If not an OpenPGP certificate...
1322
if (gnutls.library.functions
1323
.gnutls_certificate_type_get(session._c_object)
1324
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1325
# ...do the normal thing
1326
return session.peer_certificate
2471
1327
list_size = ctypes.c_uint(1)
2472
cert_list = (gnutls.certificate_get_peers
2473
(session, ctypes.byref(list_size)))
1328
cert_list = (gnutls.library.functions
1329
.gnutls_certificate_get_peers
1330
(session._c_object, ctypes.byref(list_size)))
2474
1331
if not bool(cert_list) and list_size.value != 0:
2475
raise gnutls.Error("error getting peer certificate")
1332
raise gnutls.errors.GNUTLSError("error getting peer"
1333
" certificate")
2476
1334
if list_size.value == 0:
2477
1335
return None
2478
1336
cert = cert_list[0]
2479
1337
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
1338
2516
1339
@staticmethod
2517
1340
def fingerprint(openpgp):
2518
1341
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2519
1342
# 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)))
1343
datum = (gnutls.library.types
1344
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1345
ctypes.POINTER
1346
(ctypes.c_ubyte)),
1347
ctypes.c_uint(len(openpgp))))
2524
1348
# New empty GnuTLS certificate
2525
crt = gnutls.openpgp_crt_t()
2526
gnutls.openpgp_crt_init(ctypes.byref(crt))
1349
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1350
(gnutls.library.functions
1351
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2527
1352
# Import the OpenPGP public key into the certificate
2528
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2529
gnutls.OPENPGP_FMT_RAW)
1353
(gnutls.library.functions
1354
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1355
gnutls.library.constants
1356
.GNUTLS_OPENPGP_FMT_RAW))
2530
1357
# Verify the self signature in the key
2531
1358
crtverify = ctypes.c_uint()
2532
gnutls.openpgp_crt_verify_self(crt, 0,
2533
ctypes.byref(crtverify))
1359
(gnutls.library.functions
1360
.gnutls_openpgp_crt_verify_self(crt, 0,
1361
ctypes.byref(crtverify)))
2534
1362
if crtverify.value != 0:
2535
gnutls.openpgp_crt_deinit(crt)
2536
raise gnutls.CertificateSecurityError(code
2537
=crtverify.value)
1363
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1364
raise (gnutls.errors.CertificateSecurityError
1365
("Verify failed"))
2538
1366
# New buffer for the fingerprint
2539
1367
buf = ctypes.create_string_buffer(20)
2540
1368
buf_len = ctypes.c_size_t()
2541
1369
# Get the fingerprint from the certificate into the buffer
2542
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2543
ctypes.byref(buf_len))
1370
(gnutls.library.functions
1371
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1372
ctypes.byref(buf_len)))
2544
1373
# Deinit the certificate
2545
gnutls.openpgp_crt_deinit(crt)
1374
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2546
1375
# Convert the buffer to a Python bytestring
2547
1376
fpr = ctypes.string_at(buf, buf_len.value)
2548
1377
# Convert the bytestring to hexadecimal notation
2549
hex_fpr = binascii.hexlify(fpr).upper()
1378
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2550
1379
return hex_fpr
2551
1380
2552
1381
2553
class MultiprocessingMixIn:
1382
class MultiprocessingMixIn(object):
2554
1383
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2555
2556
1384
def sub_process_main(self, request, address):
2557
1385
try:
2558
1386
self.finish_request(request, address)
2559
except Exception:
1387
except:
2560
1388
self.handle_error(request, address)
2561
1389
self.close_request(request)
2562
1390
2563
1391
def process_request(self, request, address):
2564
1392
"""Start a new process to process the request."""
2565
proc = multiprocessing.Process(target=self.sub_process_main,
2566
args=(request, address))
2567
proc.start()
2568
return proc
2569
2570
2571
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1393
multiprocessing.Process(target = self.sub_process_main,
1394
args = (request, address)).start()
1395
1396
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2572
1397
""" adds a pipe to the MixIn """
2573
2574
1398
def process_request(self, request, client_address):
2575
1399
"""Overrides and wraps the original process_request().
2576
1400
2577
1401
This function creates a new pipe in self.pipe
2578
1402
"""
2579
1403
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2580
1404
2581
proc = MultiprocessingMixIn.process_request(self, request,
2582
client_address)
1405
super(MultiprocessingMixInWithPipe,
1406
self).process_request(request, client_address)
2583
1407
self.child_pipe.close()
2584
self.add_pipe(parent_pipe, proc)
1408
self.add_pipe(parent_pipe)
2585
1409
2586
def add_pipe(self, parent_pipe, proc):
1410
def add_pipe(self, parent_pipe):
2587
1411
"""Dummy function; override as necessary"""
2588
raise NotImplementedError()
2589
1412
raise NotImplementedError
2590
1413
2591
1414
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2592
socketserver.TCPServer):
2593
"""IPv6-capable TCP server. Accepts None as address and/or port
2594
1415
socketserver.TCPServer, object):
1416
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1417
2595
1418
Attributes:
2596
1419
enabled: Boolean; whether this server is activated yet
2597
1420
interface: None or a network interface name (string)
2598
1421
use_ipv6: Boolean; to use IPv6 or not
2599
1422
"""
2600
2601
1423
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
"""
1424
interface=None, use_ipv6=True):
2608
1425
self.interface = interface
2609
1426
if use_ipv6:
2610
1427
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
1428
socketserver.TCPServer.__init__(self, server_address,
2639
1429
RequestHandlerClass)
2640
2641
1430
def server_bind(self):
2642
1431
"""This overrides the normal server_bind() function
2643
1432
to bind to an interface if one was specified, and also NOT to
2644
1433
bind to an address or port if they were not specified."""
2645
global SO_BINDTODEVICE
2646
1434
if self.interface is not None:
2647
1435
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
1436
logger.error("SO_BINDTODEVICE does not exist;"
1437
" cannot bind to interface %s",
1438
self.interface)
1439
else:
1440
try:
1441
self.socket.setsockopt(socket.SOL_SOCKET,
1442
SO_BINDTODEVICE,
1443
str(self.interface
1444
+ '\0'))
1445
except socket.error, error:
1446
if error[0] == errno.EPERM:
1447
logger.error("No permission to"
1448
" bind to interface %s",
1449
self.interface)
1450
elif error[0] == errno.ENOPROTOOPT:
1451
logger.error("SO_BINDTODEVICE not available;"
1452
" cannot bind to interface %s",
1453
self.interface)
1454
else:
1455
raise
2669
1456
# Only bind(2) the socket if we really need to.
2670
1457
if self.server_address[0] or self.server_address[1]:
2671
if self.server_address[1]:
2672
self.allow_reuse_address = True
2673
1458
if not self.server_address[0]:
2674
1459
if self.address_family == socket.AF_INET6:
2675
any_address = "::" # in6addr_any
1460
any_address = "::" # in6addr_any
2676
1461
else:
2677
any_address = "0.0.0.0" # INADDR_ANY
1462
any_address = socket.INADDR_ANY
2678
1463
self.server_address = (any_address,
2679
1464
self.server_address[1])
2680
1465
elif not self.server_address[1]:
2681
self.server_address = (self.server_address[0], 0)
1466
self.server_address = (self.server_address[0],
1467
0)
2682
1468
# if self.interface:
2683
1469
# self.server_address = (self.server_address[0],
2684
1470
# 0, # port
2690
1476
2691
1477
class MandosServer(IPv6_TCPServer):
2692
1478
"""Mandos server.
2693
1479
2694
1480
Attributes:
2695
1481
clients: set of Client objects
2696
1482
gnutls_priority GnuTLS priority string
2697
1483
use_dbus: Boolean; to emit D-Bus signals or not
2698
2699
Assumes a GLib.MainLoop event loop.
1484
1485
Assumes a gobject.MainLoop event loop.
2700
1486
"""
2701
2702
1487
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):
1488
interface=None, use_ipv6=True, clients=None,
1489
gnutls_priority=None, use_dbus=True):
2709
1490
self.enabled = False
2710
1491
self.clients = clients
2711
1492
if self.clients is None:
2712
self.clients = {}
1493
self.clients = set()
2713
1494
self.use_dbus = use_dbus
2714
1495
self.gnutls_priority = gnutls_priority
2715
1496
IPv6_TCPServer.__init__(self, server_address,
2716
1497
RequestHandlerClass,
2717
interface=interface,
2718
use_ipv6=use_ipv6,
2719
socketfd=socketfd)
2720
1498
interface = interface,
1499
use_ipv6 = use_ipv6)
2721
1500
def server_activate(self):
2722
1501
if self.enabled:
2723
1502
return socketserver.TCPServer.server_activate(self)
2724
2725
1503
def enable(self):
2726
1504
self.enabled = True
2727
2728
def add_pipe(self, parent_pipe, proc):
1505
def add_pipe(self, parent_pipe):
2729
1506
# 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,
1507
gobject.io_add_watch(parent_pipe.fileno(),
1508
gobject.IO_IN | gobject.IO_HUP,
1509
functools.partial(self.handle_ipc,
1510
parent_pipe = parent_pipe))
1511
1512
def handle_ipc(self, source, condition, parent_pipe=None,
2740
1513
client_object=None):
2741
# error, or the other end of multiprocessing.Pipe has closed
2742
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2743
# Wait for other process to exit
2744
proc.join()
1514
condition_names = {
1515
gobject.IO_IN: "IN", # There is data to read.
1516
gobject.IO_OUT: "OUT", # Data can be written (without
1517
# blocking).
1518
gobject.IO_PRI: "PRI", # There is urgent data to read.
1519
gobject.IO_ERR: "ERR", # Error condition.
1520
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1521
# broken, usually for pipes and
1522
# sockets).
1523
}
1524
conditions_string = ' | '.join(name
1525
for cond, name in
1526
condition_names.iteritems()
1527
if cond & condition)
1528
# error or the other end of multiprocessing.Pipe has closed
1529
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2745
1530
return False
2746
1531
2747
1532
# Read a request from the child
2748
1533
request = parent_pipe.recv()
2749
1534
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:
1535
1536
if command == 'init':
1537
fpr = request[1]
1538
address = request[2]
1539
1540
for c in self.clients:
1541
if c.fingerprint == fpr:
2764
1542
client = c
2765
1543
break
2766
1544
else:
2767
logger.info("Client not found for key ID: %s, address"
2768
": %s", key_id or fpr, address)
1545
logger.warning("Client not found for fingerprint: %s, ad"
1546
"dress: %s", fpr, address)
2769
1547
if self.use_dbus:
2770
1548
# Emit D-Bus signal
2771
mandos_dbus_service.ClientNotFound(key_id or fpr,
2772
address[0])
1549
mandos_dbus_service.ClientNotFound(fpr, address[0])
2773
1550
parent_pipe.send(False)
2774
1551
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))
1552
1553
gobject.io_add_watch(parent_pipe.fileno(),
1554
gobject.IO_IN | gobject.IO_HUP,
1555
functools.partial(self.handle_ipc,
1556
parent_pipe = parent_pipe,
1557
client_object = client))
2783
1558
parent_pipe.send(True)
2784
# remove the old hook in favor of the new above hook on
2785
# same fileno
1559
# remove the old hook in favor of the new above hook on same fileno
2786
1560
return False
2787
if command == "funcall":
1561
if command == 'funcall':
2788
1562
funcname = request[1]
2789
1563
args = request[2]
2790
1564
kwargs = request[3]
2791
2792
parent_pipe.send(("data", getattr(client_object,
2793
funcname)(*args,
2794
**kwargs)))
2795
2796
if command == "getattr":
1565
1566
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1567
1568
if command == 'getattr':
2797
1569
attrname = request[1]
2798
if isinstance(client_object.__getattribute__(attrname),
2799
collections.abc.Callable):
2800
parent_pipe.send(("function", ))
1570
if callable(client_object.__getattribute__(attrname)):
1571
parent_pipe.send(('function',))
2801
1572
else:
2802
parent_pipe.send((
2803
"data", client_object.__getattribute__(attrname)))
2804
2805
if command == "setattr":
1573
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1574
1575
if command == 'setattr':
2806
1576
attrname = request[1]
2807
1577
value = request[2]
2808
1578
setattr(client_object, attrname, value)
2810
1580
return True
2811
1581
2812
1582
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
1583
def string_to_delta(interval):
2915
1584
"""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
1585
1586
>>> string_to_delta('7d')
1587
datetime.timedelta(7)
1588
>>> string_to_delta('60s')
1589
datetime.timedelta(0, 60)
1590
>>> string_to_delta('60m')
1591
datetime.timedelta(0, 3600)
1592
>>> string_to_delta('24h')
1593
datetime.timedelta(1)
1594
>>> string_to_delta('1w')
1595
datetime.timedelta(7)
1596
>>> string_to_delta('5m 30s')
1597
datetime.timedelta(0, 330)
2929
1598
"""
2930
2931
try:
2932
return rfc3339_duration_to_delta(interval)
2933
except ValueError:
2934
pass
2935
2936
1599
timevalue = datetime.timedelta(0)
2937
1600
for s in interval.split():
2938
1601
try:
2939
suffix = s[-1]
1602
suffix = unicode(s[-1])
2940
1603
value = int(s[:-1])
2941
1604
if suffix == "d":
2942
1605
delta = datetime.timedelta(value)
2949
1612
elif suffix == "w":
2950
1613
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2951
1614
else:
2952
raise ValueError("Unknown suffix {!r}".format(suffix))
2953
except IndexError as e:
1615
raise ValueError("Unknown suffix %r" % suffix)
1616
except (ValueError, IndexError), e:
2954
1617
raise ValueError(*(e.args))
2955
1618
timevalue += delta
2956
1619
return timevalue
2957
1620
2958
1621
2959
def daemon(nochdir=False, noclose=False):
1622
def if_nametoindex(interface):
1623
"""Call the C function if_nametoindex(), or equivalent
1624
1625
Note: This function cannot accept a unicode string."""
1626
global if_nametoindex
1627
try:
1628
if_nametoindex = (ctypes.cdll.LoadLibrary
1629
(ctypes.util.find_library("c"))
1630
.if_nametoindex)
1631
except (OSError, AttributeError):
1632
logger.warning("Doing if_nametoindex the hard way")
1633
def if_nametoindex(interface):
1634
"Get an interface index the hard way, i.e. using fcntl()"
1635
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1636
with contextlib.closing(socket.socket()) as s:
1637
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1638
struct.pack(str("16s16x"),
1639
interface))
1640
interface_index = struct.unpack(str("I"),
1641
ifreq[16:20])[0]
1642
return interface_index
1643
return if_nametoindex(interface)
1644
1645
1646
def daemon(nochdir = False, noclose = False):
2960
1647
"""See daemon(3). Standard BSD Unix function.
2961
1648
2962
1649
This should really exist as os.daemon, but it doesn't (yet)."""
2963
1650
if os.fork():
2964
1651
sys.exit()
2969
1656
sys.exit()
2970
1657
if not noclose:
2971
1658
# Close all standard open file descriptors
2972
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1659
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2973
1660
if not stat.S_ISCHR(os.fstat(null).st_mode):
2974
1661
raise OSError(errno.ENODEV,
2975
"{} not a character device"
2976
.format(os.devnull))
1662
"%s not a character device"
1663
% os.path.devnull)
2977
1664
os.dup2(null, sys.stdin.fileno())
2978
1665
os.dup2(null, sys.stdout.fileno())
2979
1666
os.dup2(null, sys.stderr.fileno())
2982
1669
2983
1670
2984
1671
def main():
2985
1672
2986
1673
##################################################################
2987
1674
# Parsing of options, both command line and config file
2988
2989
parser = argparse.ArgumentParser()
2990
parser.add_argument("-v", "--version", action="version",
2991
version="%(prog)s {}".format(version),
2992
help="show version number and exit")
2993
parser.add_argument("-i", "--interface", metavar="IF",
2994
help="Bind to interface IF")
2995
parser.add_argument("-a", "--address",
2996
help="Address to listen for requests on")
2997
parser.add_argument("-p", "--port", type=int,
2998
help="Port number to receive requests on")
2999
parser.add_argument("--check", action="store_true",
3000
help="Run self-test")
3001
parser.add_argument("--debug", action="store_true",
3002
help="Debug mode; run in foreground and log"
3003
" to terminal", default=None)
3004
parser.add_argument("--debuglevel", metavar="LEVEL",
3005
help="Debug level for stdout output")
3006
parser.add_argument("--priority", help="GnuTLS"
3007
" priority string (see GnuTLS documentation)")
3008
parser.add_argument("--servicename",
3009
metavar="NAME", help="Zeroconf service name")
3010
parser.add_argument("--configdir",
3011
default="/etc/mandos", metavar="DIR",
3012
help="Directory to search for configuration"
3013
" files")
3014
parser.add_argument("--no-dbus", action="store_false",
3015
dest="use_dbus", help="Do not provide D-Bus"
3016
" system bus interface", default=None)
3017
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
3034
options = parser.parse_args()
3035
1675
1676
parser = optparse.OptionParser(version = "%%prog %s" % version)
1677
parser.add_option("-i", "--interface", type="string",
1678
metavar="IF", help="Bind to interface IF")
1679
parser.add_option("-a", "--address", type="string",
1680
help="Address to listen for requests on")
1681
parser.add_option("-p", "--port", type="int",
1682
help="Port number to receive requests on")
1683
parser.add_option("--check", action="store_true",
1684
help="Run self-test")
1685
parser.add_option("--debug", action="store_true",
1686
help="Debug mode; run in foreground and log to"
1687
" terminal")
1688
parser.add_option("--debuglevel", type="string", metavar="LEVEL",
1689
help="Debug level for stdout output")
1690
parser.add_option("--priority", type="string", help="GnuTLS"
1691
" priority string (see GnuTLS documentation)")
1692
parser.add_option("--servicename", type="string",
1693
metavar="NAME", help="Zeroconf service name")
1694
parser.add_option("--configdir", type="string",
1695
default="/etc/mandos", metavar="DIR",
1696
help="Directory to search for configuration"
1697
" files")
1698
parser.add_option("--no-dbus", action="store_false",
1699
dest="use_dbus", help="Do not provide D-Bus"
1700
" system bus interface")
1701
parser.add_option("--no-ipv6", action="store_false",
1702
dest="use_ipv6", help="Do not use IPv6")
1703
options = parser.parse_args()[0]
1704
1705
if options.check:
1706
import doctest
1707
doctest.testmod()
1708
sys.exit()
1709
3036
1710
# 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
1711
server_defaults = { "interface": "",
1712
"address": "",
1713
"port": "",
1714
"debug": "False",
1715
"priority":
1716
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1717
"servicename": "Mandos",
1718
"use_dbus": "True",
1719
"use_ipv6": "True",
1720
"debuglevel": "",
1721
}
1722
3060
1723
# Parse config file for server-global settings
3061
server_config = configparser.ConfigParser(server_defaults)
1724
server_config = configparser.SafeConfigParser(server_defaults)
3062
1725
del server_defaults
3063
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3064
# Convert the ConfigParser object to a dict
1726
server_config.read(os.path.join(options.configdir,
1727
"mandos.conf"))
1728
# Convert the SafeConfigParser object to a dict
3065
1729
server_settings = server_config.defaults()
3066
1730
# Use the appropriate methods on the non-string config options
3067
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3068
"foreground", "zeroconf"):
1731
for option in ("debug", "use_dbus", "use_ipv6"):
3069
1732
server_settings[option] = server_config.getboolean("DEFAULT",
3070
1733
option)
3071
1734
if server_settings["port"]:
3072
1735
server_settings["port"] = server_config.getint("DEFAULT",
3073
1736
"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
1737
del server_config
3084
1738
3085
1739
# Override the settings from the config file with command line
3086
1740
# options, if set.
3087
1741
for option in ("interface", "address", "port", "debug",
3088
"priority", "servicename", "configdir", "use_dbus",
3089
"use_ipv6", "debuglevel", "restore", "statedir",
3090
"socket", "foreground", "zeroconf"):
1742
"priority", "servicename", "configdir",
1743
"use_dbus", "use_ipv6", "debuglevel"):
3091
1744
value = getattr(options, option)
3092
1745
if value is not None:
3093
1746
server_settings[option] = value
3094
1747
del options
3095
1748
# Force all strings to be unicode
3096
1749
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
1750
if type(server_settings[option]) is str:
1751
server_settings[option] = unicode(server_settings[option])
3107
1752
# Now we have our good server settings in "server_settings"
3108
1753
3109
1754
##################################################################
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
1755
3116
1756
# For convenience
3117
1757
debug = server_settings["debug"]
3118
1758
debuglevel = server_settings["debuglevel"]
3119
1759
use_dbus = server_settings["use_dbus"]
3120
1760
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
1761
3135
1762
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
1763
syslogger.setFormatter(logging.Formatter
1764
('Mandos (%s) [%%(process)d]:'
1765
' %%(levelname)s: %%(message)s'
1766
% server_settings["servicename"]))
1767
3141
1768
# Parse config file with clients
3142
client_config = configparser.ConfigParser(Client.client_defaults)
1769
client_defaults = { "timeout": "1h",
1770
"interval": "5m",
1771
"checker": "fping -q -- %%(host)s",
1772
"host": "",
1773
"approval_delay": "0s",
1774
"approval_duration": "1s",
1775
}
1776
client_config = configparser.SafeConfigParser(client_defaults)
3143
1777
client_config.read(os.path.join(server_settings["configdir"],
3144
1778
"clients.conf"))
3145
1779
3146
1780
global mandos_dbus_service
3147
1781
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
1782
1783
tcp_server = MandosServer((server_settings["address"],
1784
server_settings["port"]),
1785
ClientHandler,
1786
interface=(server_settings["interface"]
1787
or None),
1788
use_ipv6=use_ipv6,
1789
gnutls_priority=
1790
server_settings["priority"],
1791
use_dbus=use_dbus)
1792
if not debug:
1793
pidfilename = "/var/run/mandos.pid"
1794
try:
1795
pidfile = open(pidfilename, "w")
1796
except IOError:
1797
logger.error("Could not open file %r", pidfilename)
1798
1799
try:
1800
uid = pwd.getpwnam("_mandos").pw_uid
1801
gid = pwd.getpwnam("_mandos").pw_gid
1802
except KeyError:
1803
try:
1804
uid = pwd.getpwnam("mandos").pw_uid
1805
gid = pwd.getpwnam("mandos").pw_gid
3178
1806
except KeyError:
3179
continue
3180
else:
3181
uid = 65534
3182
gid = 65534
1807
try:
1808
uid = pwd.getpwnam("nobody").pw_uid
1809
gid = pwd.getpwnam("nobody").pw_gid
1810
except KeyError:
1811
uid = 65534
1812
gid = 65534
3183
1813
try:
3184
1814
os.setgid(gid)
3185
1815
os.setuid(uid)
3186
if debug:
3187
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3188
gid))
3189
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
1816
except OSError, error:
1817
if error[0] != errno.EPERM:
1818
raise error
1819
1820
if not debug and not debuglevel:
1821
syslogger.setLevel(logging.WARNING)
1822
console.setLevel(logging.WARNING)
1823
if debuglevel:
1824
level = getattr(logging, debuglevel.upper())
1825
syslogger.setLevel(level)
1826
console.setLevel(level)
3194
1827
3195
1828
if debug:
3196
1829
# Enable all possible GnuTLS debugging
3197
1830
3198
1831
# "Use a log level over 10 to enable all debugging options."
3199
1832
# - GnuTLS manual
3200
gnutls.global_set_log_level(11)
3201
3202
@gnutls.log_func
1833
gnutls.library.functions.gnutls_global_set_log_level(11)
1834
1835
@gnutls.library.types.gnutls_log_func
3203
1836
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
1837
logger.debug("GnuTLS: %s", string[:-1])
1838
1839
(gnutls.library.functions
1840
.gnutls_global_set_log_function(debug_gnutls))
1841
3210
1842
# Redirect stdin so all checkers get /dev/null
3211
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1843
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3212
1844
os.dup2(null, sys.stdin.fileno())
3213
1845
if null > 2:
3214
1846
os.close(null)
3215
1847
else:
1848
# No console logging
1849
logger.removeHandler(console)
1850
3216
1851
# Need to fork before connecting to D-Bus
3217
if not foreground:
1852
if not debug:
3218
1853
# Close all input and output, do double fork, etc.
3219
1854
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
1855
3226
1856
global main_loop
3227
1857
# From the Avahi example code
3228
DBusGMainLoop(set_as_default=True)
3229
main_loop = GLib.MainLoop()
1858
DBusGMainLoop(set_as_default=True )
1859
main_loop = gobject.MainLoop()
3230
1860
bus = dbus.SystemBus()
3231
1861
# End of Avahi example code
3232
1862
if use_dbus:
3233
1863
try:
3234
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)
1864
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1865
bus, do_not_queue=True)
1866
except dbus.exceptions.NameExistsException, e:
1867
logger.error(unicode(e) + ", disabling D-Bus")
3242
1868
use_dbus = False
3243
1869
server_settings["use_dbus"] = False
3244
1870
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
1871
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1872
service = AvahiService(name = server_settings["servicename"],
1873
servicetype = "_mandos._tcp",
1874
protocol = protocol, bus = bus)
1875
if server_settings["interface"]:
1876
service.interface = (if_nametoindex
1877
(str(server_settings["interface"])))
1878
3256
1879
global multiprocessing_manager
3257
1880
multiprocessing_manager = multiprocessing.Manager()
3258
1881
3259
1882
client_class = Client
3260
1883
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))
1884
client_class = functools.partial(ClientDBus, bus = bus)
1885
def client_config_items(config, section):
1886
special_settings = {
1887
"approved_by_default":
1888
lambda: config.getboolean(section,
1889
"approved_by_default"),
1890
}
1891
for name, value in config.items(section):
3394
1892
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
1893
yield (name, special_settings[name]())
1894
except KeyError:
1895
yield (name, value)
1896
1897
tcp_server.clients.update(set(
1898
client_class(name = section,
1899
config= dict(client_config_items(
1900
client_config, section)))
1901
for section in client_config.sections()))
3420
1902
if not tcp_server.clients:
3421
1903
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
1904
1905
if not debug:
1906
try:
1907
with pidfile:
1908
pid = os.getpid()
1909
pidfile.write(str(pid) + "\n".encode("utf-8"))
1910
del pidfile
1911
except IOError:
1912
logger.error("Could not write to file %r with PID %d",
1913
pidfilename, pid)
1914
except NameError:
1915
# "pidfile" was never created
1916
pass
3433
1917
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
1918
1919
signal.signal(signal.SIGINT, signal.SIG_IGN)
1920
1921
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1922
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1923
3439
1924
if use_dbus:
3440
3441
@alternate_dbus_interfaces(
3442
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3443
class MandosDBusService(DBusObjectWithObjectManager):
1925
class MandosDBusService(dbus.service.Object):
3444
1926
"""A D-Bus proxy object"""
3445
3446
1927
def __init__(self):
3447
1928
dbus.service.Object.__init__(self, bus, "/")
3448
3449
_interface = "se.recompile.Mandos"
3450
1929
_interface = "se.bsnet.fukt.Mandos"
1930
3451
1931
@dbus.service.signal(_interface, signature="o")
3452
1932
def ClientAdded(self, objpath):
3453
1933
"D-Bus signal"
3454
1934
pass
3455
1935
3456
1936
@dbus.service.signal(_interface, signature="ss")
3457
def ClientNotFound(self, key_id, address):
1937
def ClientNotFound(self, fingerprint, address):
3458
1938
"D-Bus signal"
3459
1939
pass
3460
3461
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3462
"true"})
1940
3463
1941
@dbus.service.signal(_interface, signature="os")
3464
1942
def ClientRemoved(self, objpath, name):
3465
1943
"D-Bus signal"
3466
1944
pass
3467
3468
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3469
"true"})
1945
3470
1946
@dbus.service.method(_interface, out_signature="ao")
3471
1947
def GetAllClients(self):
3472
1948
"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"})
1949
return dbus.Array(c.dbus_object_path
1950
for c in tcp_server.clients)
1951
3478
1952
@dbus.service.method(_interface,
3479
1953
out_signature="a{oa{sv}}")
3480
1954
def GetAllClientsWithProperties(self):
3481
1955
"D-Bus method"
3482
1956
return dbus.Dictionary(
3483
{c.dbus_object_path: c.GetAll(
3484
"se.recompile.Mandos.Client")
3485
for c in tcp_server.clients.values()},
1957
((c.dbus_object_path, c.GetAll(""))
1958
for c in tcp_server.clients),
3486
1959
signature="oa{sv}")
3487
1960
3488
1961
@dbus.service.method(_interface, in_signature="o")
3489
1962
def RemoveClient(self, object_path):
3490
1963
"D-Bus method"
3491
for c in tcp_server.clients.values():
1964
for c in tcp_server.clients:
3492
1965
if c.dbus_object_path == object_path:
3493
del tcp_server.clients[c.name]
1966
tcp_server.clients.remove(c)
3494
1967
c.remove_from_connection()
3495
# Don't signal the disabling
1968
# Don't signal anything except ClientRemoved
3496
1969
c.disable(quiet=True)
3497
# Emit D-Bus signal for removal
3498
self.client_removed_signal(c)
1970
# Emit D-Bus signal
1971
self.ClientRemoved(object_path, c.name)
3499
1972
return
3500
1973
raise KeyError(object_path)
3501
1974
3502
1975
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
1976
3540
1977
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
1978
3547
1979
def cleanup():
3548
1980
"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
1981
service.cleanup()
1982
3611
1983
while tcp_server.clients:
3612
name, client = tcp_server.clients.popitem()
1984
client = tcp_server.clients.pop()
3613
1985
if use_dbus:
3614
1986
client.remove_from_connection()
3615
# Don't signal the disabling
1987
client.disable_hook = None
1988
# Don't signal anything except ClientRemoved
3616
1989
client.disable(quiet=True)
3617
# Emit D-Bus signal for removal
3618
1990
if use_dbus:
3619
mandos_dbus_service.client_removed_signal(client)
3620
client_settings.clear()
3621
1991
# Emit D-Bus signal
1992
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1993
client.name)
1994
3622
1995
atexit.register(cleanup)
3623
3624
for client in tcp_server.clients.values():
1996
1997
for client in tcp_server.clients:
3625
1998
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
1999
# Emit D-Bus signal
2000
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2001
client.enable()
2002
3632
2003
tcp_server.enable()
3633
2004
tcp_server.server_activate()
3634
2005
3635
2006
# Find out what port we got
3636
if zeroconf:
3637
service.port = tcp_server.socket.getsockname()[1]
2007
service.port = tcp_server.socket.getsockname()[1]
3638
2008
if use_ipv6:
3639
2009
logger.info("Now listening on address %r, port %d,"
3640
" flowinfo %d, scope_id %d",
3641
*tcp_server.socket.getsockname())
2010
" flowinfo %d, scope_id %d"
2011
% tcp_server.socket.getsockname())
3642
2012
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
2013
logger.info("Now listening on address %r, port %d"
2014
% tcp_server.socket.getsockname())
2015
2016
#service.interface = tcp_server.socket.getsockname()[3]
2017
3648
2018
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
2019
# From the Avahi example code
2020
try:
2021
service.activate()
2022
except dbus.exceptions.DBusException, error:
2023
logger.critical("DBusException: %s", error)
2024
cleanup()
2025
sys.exit(1)
2026
# End of Avahi example code
2027
2028
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2029
lambda *args, **kwargs:
2030
(tcp_server.handle_request
2031
(*args[2:], **kwargs) or True))
2032
3665
2033
logger.debug("Starting main loop")
3666
2034
main_loop.run()
3667
except AvahiError as error:
3668
logger.critical("Avahi Error", exc_info=error)
2035
except AvahiError, error:
2036
logger.critical("AvahiError: %s", error)
3669
2037
cleanup()
3670
2038
sys.exit(1)
3671
2039
except KeyboardInterrupt:
3676
2044
# Must run before the D-Bus bus name gets deregistered
3677
2045
cleanup()
3678
2046
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()
2047
if __name__ == '__main__':
2048
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0