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