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