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