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 1274
- compare with another revision
- download diff
- download tarball
- view history from revision 1274
- Committer: Teddy Hogeborn
- Date: 2023-02-11 06:58:15 UTC
- Revision ID: teddy@recompile.se-20230211065815-jtffi61tbdrgr875
Suppress warnings
Suppress warnings about mlock()ing uninitialized memory and reading an
ievent struct.
* dracut-module/password-agent.c (send_password_to_socket): Suppress
"-Wmaybe-uninitialized" when mlock()ing password send buffer.
(test_read_inotify_event_IN_DELETE_badname): When reading from
a struct ievent, suppress "-Wstringop-overread".
Suppress warnings about mlock()ing uninitialized memory and reading an
ievent struct.
* dracut-module/password-agent.c (send_password_to_socket): Suppress
"-Wmaybe-uninitialized" when mlock()ing password send buffer.
(test_read_inotify_event_IN_DELETE_badname): When reading from
a struct ievent, suppress "-Wstringop-overread".
- 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.3"
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.16"
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
credentials_type_t = ctypes.c_int #
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
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(" ", ""))
794
964
client["fingerprint"] = (section["fingerprint"].upper()
795
965
.replace(" ", ""))
796
966
if "secret" in section:
797
client["secret"] = section["secret"].decode("base64")
967
client["secret"] = codecs.decode(section["secret"]
968
.encode("utf-8"),
969
"base64")
798
970
elif "secfile" in section:
799
971
with open(os.path.expanduser(os.path.expandvars
800
972
(section["secfile"])),
815
987
client["last_approval_request"] = None
816
988
client["last_checked_ok"] = None
817
989
client["last_checker_status"] = -2
818
990
819
991
return settings
820
821
def __init__(self, settings, name = None, server_settings=None):
992
993
def __init__(self, settings, name=None, server_settings=None):
822
994
self.name = name
823
995
if server_settings is None:
824
996
server_settings = {}
826
998
# adding all client settings
827
999
for setting, value in settings.items():
828
1000
setattr(self, setting, value)
829
1001
830
1002
if self.enabled:
831
1003
if not hasattr(self, "last_enabled"):
832
1004
self.last_enabled = datetime.datetime.utcnow()
836
1008
else:
837
1009
self.last_enabled = None
838
1010
self.expires = None
839
840
logger.debug("Creating client %r", self.name)
841
logger.debug(" Fingerprint: %s", self.fingerprint)
1011
1012
log.debug("Creating client %r", self.name)
1013
log.debug(" Key ID: %s", self.key_id)
1014
log.debug(" Fingerprint: %s", self.fingerprint)
842
1015
self.created = settings.get("created",
843
1016
datetime.datetime.utcnow())
844
1017
845
1018
# attributes specific for this server instance
846
1019
self.checker = None
847
1020
self.checker_initiator_tag = None
853
1026
self.changedstate = multiprocessing_manager.Condition(
854
1027
multiprocessing_manager.Lock())
855
1028
self.client_structure = [attr
856
for attr in self.__dict__.iterkeys()
1029
for attr in self.__dict__.keys()
857
1030
if not attr.startswith("_")]
858
1031
self.client_structure.append("client_structure")
859
1032
860
1033
for name, t in inspect.getmembers(
861
1034
type(self), lambda obj: isinstance(obj, property)):
862
1035
if not name.startswith("_"):
863
1036
self.client_structure.append(name)
864
1037
865
1038
# Send notice to process children that client state has changed
866
1039
def send_changedstate(self):
867
1040
with self.changedstate:
868
1041
self.changedstate.notify_all()
869
1042
870
1043
def enable(self):
871
1044
"""Start this client's checker and timeout hooks"""
872
1045
if getattr(self, "enabled", False):
873
1046
# Already enabled
874
1047
return
875
self.expires = datetime.datetime.utcnow() + self.timeout
876
1048
self.enabled = True
877
1049
self.last_enabled = datetime.datetime.utcnow()
878
1050
self.init_checker()
879
1051
self.send_changedstate()
880
1052
881
1053
def disable(self, quiet=True):
882
1054
"""Disable this client."""
883
1055
if not getattr(self, "enabled", False):
884
1056
return False
885
1057
if not quiet:
886
logger.info("Disabling client %s", self.name)
1058
log.info("Disabling client %s", self.name)
887
1059
if getattr(self, "disable_initiator_tag", None) is not None:
888
GObject.source_remove(self.disable_initiator_tag)
1060
GLib.source_remove(self.disable_initiator_tag)
889
1061
self.disable_initiator_tag = None
890
1062
self.expires = None
891
1063
if getattr(self, "checker_initiator_tag", None) is not None:
892
GObject.source_remove(self.checker_initiator_tag)
1064
GLib.source_remove(self.checker_initiator_tag)
893
1065
self.checker_initiator_tag = None
894
1066
self.stop_checker()
895
1067
self.enabled = False
896
1068
if not quiet:
897
1069
self.send_changedstate()
898
# Do not run this again if called by a GObject.timeout_add
1070
# Do not run this again if called by a GLib.timeout_add
899
1071
return False
900
1072
901
1073
def __del__(self):
902
1074
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.
1075
1076
def init_checker(self, randomize_start=False):
1077
# Schedule a new checker to be started a randomly selected
1078
# time (a fraction of 'interval') from now. This spreads out
1079
# the startup of checkers over time when the server is
1080
# started.
907
1081
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
1082
GLib.source_remove(self.checker_initiator_tag)
1083
interval_milliseconds = int(self.interval.total_seconds()
1084
* 1000)
1085
if randomize_start:
1086
delay_milliseconds = random.randrange(
1087
interval_milliseconds + 1)
1088
else:
1089
delay_milliseconds = interval_milliseconds
1090
self.checker_initiator_tag = GLib.timeout_add(
1091
delay_milliseconds, self.start_checker, randomize_start)
1092
delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1093
# A checker might take up to an 'interval' of time, so we can
1094
# expire at the soonest one interval after a checker was
1095
# started. Since the initial checker is delayed, the expire
1096
# time might have to be extended.
1097
now = datetime.datetime.utcnow()
1098
self.expires = now + delay + self.interval
1099
# Schedule a disable() at expire time
913
1100
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
1101
GLib.source_remove(self.disable_initiator_tag)
1102
self.disable_initiator_tag = GLib.timeout_add(
1103
int((self.expires - now).total_seconds() * 1000),
1104
self.disable)
1105
920
1106
def checker_callback(self, source, condition, connection,
921
1107
command):
922
1108
"""The checker has completed, so take appropriate actions."""
923
self.checker_callback_tag = None
924
self.checker = None
925
1109
# Read return code from connection (see call_pipe)
926
1110
returncode = connection.recv()
927
1111
connection.close()
928
1112
if self.checker is not None:
1113
self.checker.join()
1114
self.checker_callback_tag = None
1115
self.checker = None
1116
929
1117
if returncode >= 0:
930
1118
self.last_checker_status = returncode
931
1119
self.last_checker_signal = None
932
1120
if self.last_checker_status == 0:
933
logger.info("Checker for %(name)s succeeded",
934
vars(self))
1121
log.info("Checker for %(name)s succeeded", vars(self))
935
1122
self.checked_ok()
936
1123
else:
937
logger.info("Checker for %(name)s failed", vars(self))
1124
log.info("Checker for %(name)s failed", vars(self))
938
1125
else:
939
1126
self.last_checker_status = -1
940
1127
self.last_checker_signal = -returncode
941
logger.warning("Checker for %(name)s crashed?",
942
vars(self))
1128
log.warning("Checker for %(name)s crashed?", vars(self))
943
1129
return False
944
1130
945
1131
def checked_ok(self):
946
1132
"""Assert that the client has been seen, alive and well."""
947
1133
self.last_checked_ok = datetime.datetime.utcnow()
948
1134
self.last_checker_status = 0
949
1135
self.last_checker_signal = None
950
1136
self.bump_timeout()
951
1137
952
1138
def bump_timeout(self, timeout=None):
953
1139
"""Bump up the timeout for this client."""
954
1140
if timeout is None:
955
1141
timeout = self.timeout
956
1142
if self.disable_initiator_tag is not None:
957
GObject.source_remove(self.disable_initiator_tag)
1143
GLib.source_remove(self.disable_initiator_tag)
958
1144
self.disable_initiator_tag = None
959
1145
if getattr(self, "enabled", False):
960
self.disable_initiator_tag = GObject.timeout_add(
1146
self.disable_initiator_tag = GLib.timeout_add(
961
1147
int(timeout.total_seconds() * 1000), self.disable)
962
1148
self.expires = datetime.datetime.utcnow() + timeout
963
1149
964
1150
def need_approval(self):
965
1151
self.last_approval_request = datetime.datetime.utcnow()
966
967
def start_checker(self):
1152
1153
def start_checker(self, start_was_randomized=False):
968
1154
"""Start a new checker subprocess if one is not running.
969
1155
970
1156
If a checker already exists, leave it running and do
971
1157
nothing."""
972
1158
# The reason for not killing a running checker is that if we
977
1163
# checkers alone, the checker would have to take more time
978
1164
# than 'timeout' for the client to be disabled, which is as it
979
1165
# should be.
980
1166
981
1167
if self.checker is not None and not self.checker.is_alive():
982
logger.warning("Checker was not alive; joining")
1168
log.warning("Checker was not alive; joining")
983
1169
self.checker.join()
984
1170
self.checker = None
985
1171
# Start a new checker if needed
986
1172
if self.checker is None:
987
1173
# Escape attributes for the shell
988
1174
escaped_attrs = {
989
attr: re.escape(str(getattr(self, attr)))
990
for attr in self.runtime_expansions }
1175
attr: shlex.quote(str(getattr(self, attr)))
1176
for attr in self.runtime_expansions}
991
1177
try:
992
1178
command = self.checker_command % escaped_attrs
993
1179
except TypeError as error:
994
logger.error('Could not format string "%s"',
995
self.checker_command,
996
exc_info=error)
1180
log.error('Could not format string "%s"',
1181
self.checker_command, exc_info=error)
997
1182
return True # Try again later
998
1183
self.current_checker_command = command
999
logger.info("Starting checker %r for %s", command,
1000
self.name)
1184
log.info("Starting checker %r for %s", command, self.name)
1001
1185
# We don't need to redirect stdout and stderr, since
1002
1186
# in normal mode, that is already done by daemon(),
1003
1187
# and in debug mode we don't want to. (Stdin is
1005
1189
# The exception is when not debugging but nevertheless
1006
1190
# running in the foreground; use the previously
1007
1191
# created wnull.
1008
popen_args = { "close_fds": True,
1009
"shell": True,
1010
"cwd": "/" }
1192
popen_args = {"close_fds": True,
1193
"shell": True,
1194
"cwd": "/"}
1011
1195
if (not self.server_settings["debug"]
1012
1196
and self.server_settings["foreground"]):
1013
1197
popen_args.update({"stdout": wnull,
1014
"stderr": wnull })
1015
pipe = multiprocessing.Pipe(duplex = False)
1198
"stderr": wnull})
1199
pipe = multiprocessing.Pipe(duplex=False)
1016
1200
self.checker = multiprocessing.Process(
1017
target = call_pipe,
1018
args = (pipe[1], subprocess.call, command),
1019
kwargs = popen_args)
1201
target=call_pipe,
1202
args=(pipe[1], subprocess.call, command),
1203
kwargs=popen_args)
1020
1204
self.checker.start()
1021
self.checker_callback_tag = GObject.io_add_watch(
1022
pipe[0].fileno(), GObject.IO_IN,
1205
self.checker_callback_tag = GLib.io_add_watch(
1206
GLib.IOChannel.unix_new(pipe[0].fileno()),
1207
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1023
1208
self.checker_callback, pipe[0], command)
1024
# Re-run this periodically if run by GObject.timeout_add
1209
if start_was_randomized:
1210
# We were started after a random delay; Schedule a new
1211
# checker to be started an 'interval' from now, and every
1212
# interval from then on.
1213
now = datetime.datetime.utcnow()
1214
self.checker_initiator_tag = GLib.timeout_add(
1215
int(self.interval.total_seconds() * 1000),
1216
self.start_checker)
1217
self.expires = max(self.expires, now + self.interval)
1218
# Don't start a new checker again after same random delay
1219
return False
1220
# Re-run this periodically if run by GLib.timeout_add
1025
1221
return True
1026
1222
1027
1223
def stop_checker(self):
1028
1224
"""Force the checker process, if any, to stop."""
1029
1225
if self.checker_callback_tag:
1030
GObject.source_remove(self.checker_callback_tag)
1226
GLib.source_remove(self.checker_callback_tag)
1031
1227
self.checker_callback_tag = None
1032
1228
if getattr(self, "checker", None) is None:
1033
1229
return
1034
logger.debug("Stopping checker for %(name)s", vars(self))
1230
log.debug("Stopping checker for %(name)s", vars(self))
1035
1231
self.checker.terminate()
1036
1232
self.checker = None
1037
1233
1042
1238
byte_arrays=False):
1043
1239
"""Decorators for marking methods of a DBusObjectWithProperties to
1044
1240
become properties on the D-Bus.
1045
1241
1046
1242
The decorated method will be called with no arguments by "Get"
1047
1243
and with one argument by "Set".
1048
1244
1049
1245
The parameters, where they are supported, are the same as
1050
1246
dbus.service.method, except there is only "signature", since the
1051
1247
type from Get() and the type sent to Set() is the same.
1055
1251
if byte_arrays and signature != "ay":
1056
1252
raise ValueError("Byte arrays not supported for non-'ay'"
1057
1253
" signature {!r}".format(signature))
1058
1254
1059
1255
def decorator(func):
1060
1256
func._dbus_is_property = True
1061
1257
func._dbus_interface = dbus_interface
1064
1260
func._dbus_name = func.__name__
1065
1261
if func._dbus_name.endswith("_dbus_property"):
1066
1262
func._dbus_name = func._dbus_name[:-14]
1067
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1263
func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1068
1264
return func
1069
1265
1070
1266
return decorator
1071
1267
1072
1268
1073
1269
def dbus_interface_annotations(dbus_interface):
1074
1270
"""Decorator for marking functions returning interface annotations
1075
1271
1076
1272
Usage:
1077
1273
1078
1274
@dbus_interface_annotations("org.example.Interface")
1079
1275
def _foo(self): # Function name does not matter
1080
1276
return {"org.freedesktop.DBus.Deprecated": "true",
1081
1277
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1082
1278
"false"}
1083
1279
"""
1084
1280
1085
1281
def decorator(func):
1086
1282
func._dbus_is_interface = True
1087
1283
func._dbus_interface = dbus_interface
1088
1284
func._dbus_name = dbus_interface
1089
1285
return func
1090
1286
1091
1287
return decorator
1092
1288
1093
1289
1094
1290
def dbus_annotations(annotations):
1095
1291
"""Decorator to annotate D-Bus methods, signals or properties
1096
1292
Usage:
1097
1293
1098
1294
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1099
1295
"org.freedesktop.DBus.Property."
1100
1296
"EmitsChangedSignal": "false"})
1102
1298
access="r")
1103
1299
def Property_dbus_property(self):
1104
1300
return dbus.Boolean(False)
1105
1301
1106
1302
See also the DBusObjectWithAnnotations class.
1107
1303
"""
1108
1304
1109
1305
def decorator(func):
1110
1306
func._dbus_annotations = annotations
1111
1307
return func
1112
1308
1113
1309
return decorator
1114
1310
1115
1311
1133
1329
1134
1330
class DBusObjectWithAnnotations(dbus.service.Object):
1135
1331
"""A D-Bus object with annotations.
1136
1332
1137
1333
Classes inheriting from this can use the dbus_annotations
1138
1334
decorator to add annotations to methods or signals.
1139
1335
"""
1140
1336
1141
1337
@staticmethod
1142
1338
def _is_dbus_thing(thing):
1143
1339
"""Returns a function testing if an attribute is a D-Bus thing
1144
1340
1145
1341
If called like _is_dbus_thing("method") it returns a function
1146
1342
suitable for use as predicate to inspect.getmembers().
1147
1343
"""
1148
1344
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1149
1345
False)
1150
1346
1151
1347
def _get_all_dbus_things(self, thing):
1152
1348
"""Returns a generator of (name, attribute) pairs
1153
1349
"""
1156
1352
for cls in self.__class__.__mro__
1157
1353
for name, athing in
1158
1354
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1159
1355
1160
1356
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1161
out_signature = "s",
1162
path_keyword = 'object_path',
1163
connection_keyword = 'connection')
1357
out_signature="s",
1358
path_keyword="object_path",
1359
connection_keyword="connection")
1164
1360
def Introspect(self, object_path, connection):
1165
1361
"""Overloading of standard D-Bus method.
1166
1362
1167
1363
Inserts annotation tags on methods and signals.
1168
1364
"""
1169
1365
xmlstring = dbus.service.Object.Introspect(self, object_path,
1170
1366
connection)
1171
1367
try:
1172
1368
document = xml.dom.minidom.parseString(xmlstring)
1173
1369
1174
1370
for if_tag in document.getElementsByTagName("interface"):
1175
1371
# Add annotation tags
1176
1372
for typ in ("method", "signal"):
1203
1399
if_tag.appendChild(ann_tag)
1204
1400
# Fix argument name for the Introspect method itself
1205
1401
if (if_tag.getAttribute("name")
1206
== dbus.INTROSPECTABLE_IFACE):
1402
== dbus.INTROSPECTABLE_IFACE):
1207
1403
for cn in if_tag.getElementsByTagName("method"):
1208
1404
if cn.getAttribute("name") == "Introspect":
1209
1405
for arg in cn.getElementsByTagName("arg"):
1215
1411
document.unlink()
1216
1412
except (AttributeError, xml.dom.DOMException,
1217
1413
xml.parsers.expat.ExpatError) as error:
1218
logger.error("Failed to override Introspection method",
1219
exc_info=error)
1414
log.error("Failed to override Introspection method",
1415
exc_info=error)
1220
1416
return xmlstring
1221
1417
1222
1418
1223
1419
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1224
1420
"""A D-Bus object with properties.
1225
1421
1226
1422
Classes inheriting from this can use the dbus_service_property
1227
1423
decorator to expose methods as D-Bus properties. It exposes the
1228
1424
standard Get(), Set(), and GetAll() methods on the D-Bus.
1229
1425
"""
1230
1426
1231
1427
def _get_dbus_property(self, interface_name, property_name):
1232
1428
"""Returns a bound method if one exists which is a D-Bus
1233
1429
property with the specified name and interface.
1238
1434
if (value._dbus_name == property_name
1239
1435
and value._dbus_interface == interface_name):
1240
1436
return value.__get__(self)
1241
1437
1242
1438
# No such property
1243
1439
raise DBusPropertyNotFound("{}:{}.{}".format(
1244
1440
self.dbus_object_path, interface_name, property_name))
1245
1441
1246
1442
@classmethod
1247
1443
def _get_all_interface_names(cls):
1248
1444
"""Get a sequence of all interfaces supported by an object"""
1251
1447
for x in (inspect.getmro(cls))
1252
1448
for attr in dir(x))
1253
1449
if name is not None)
1254
1450
1255
1451
@dbus.service.method(dbus.PROPERTIES_IFACE,
1256
1452
in_signature="ss",
1257
1453
out_signature="v")
1265
1461
if not hasattr(value, "variant_level"):
1266
1462
return value
1267
1463
return type(value)(value, variant_level=value.variant_level+1)
1268
1464
1269
1465
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1270
1466
def Set(self, interface_name, property_name, value):
1271
1467
"""Standard D-Bus property Set() method, see D-Bus standard.
1280
1476
raise ValueError("Byte arrays not supported for non-"
1281
1477
"'ay' signature {!r}"
1282
1478
.format(prop._dbus_signature))
1283
value = dbus.ByteArray(b''.join(chr(byte)
1284
for byte in value))
1479
value = dbus.ByteArray(bytes(value))
1285
1480
prop(value)
1286
1481
1287
1482
@dbus.service.method(dbus.PROPERTIES_IFACE,
1288
1483
in_signature="s",
1289
1484
out_signature="a{sv}")
1290
1485
def GetAll(self, interface_name):
1291
1486
"""Standard D-Bus property GetAll() method, see D-Bus
1292
1487
standard.
1293
1488
1294
1489
Note: Will not include properties with access="write".
1295
1490
"""
1296
1491
properties = {}
1307
1502
properties[name] = value
1308
1503
continue
1309
1504
properties[name] = type(value)(
1310
value, variant_level = value.variant_level + 1)
1505
value, variant_level=value.variant_level + 1)
1311
1506
return dbus.Dictionary(properties, signature="sv")
1312
1507
1313
1508
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1314
1509
def PropertiesChanged(self, interface_name, changed_properties,
1315
1510
invalidated_properties):
1317
1512
standard.
1318
1513
"""
1319
1514
pass
1320
1515
1321
1516
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1322
1517
out_signature="s",
1323
path_keyword='object_path',
1324
connection_keyword='connection')
1518
path_keyword="object_path",
1519
connection_keyword="connection")
1325
1520
def Introspect(self, object_path, connection):
1326
1521
"""Overloading of standard D-Bus method.
1327
1522
1328
1523
Inserts property tags and interface annotation tags.
1329
1524
"""
1330
1525
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1332
1527
connection)
1333
1528
try:
1334
1529
document = xml.dom.minidom.parseString(xmlstring)
1335
1530
1336
1531
def make_tag(document, name, prop):
1337
1532
e = document.createElement("property")
1338
1533
e.setAttribute("name", name)
1339
1534
e.setAttribute("type", prop._dbus_signature)
1340
1535
e.setAttribute("access", prop._dbus_access)
1341
1536
return e
1342
1537
1343
1538
for if_tag in document.getElementsByTagName("interface"):
1344
1539
# Add property tags
1345
1540
for tag in (make_tag(document, name, prop)
1383
1578
document.unlink()
1384
1579
except (AttributeError, xml.dom.DOMException,
1385
1580
xml.parsers.expat.ExpatError) as error:
1386
logger.error("Failed to override Introspection method",
1387
exc_info=error)
1581
log.error("Failed to override Introspection method",
1582
exc_info=error)
1388
1583
return xmlstring
1389
1584
1585
1390
1586
try:
1391
1587
dbus.OBJECT_MANAGER_IFACE
1392
1588
except AttributeError:
1393
1589
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1394
1590
1591
1395
1592
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1396
1593
"""A D-Bus object with an ObjectManager.
1397
1594
1398
1595
Classes inheriting from this exposes the standard
1399
1596
GetManagedObjects call and the InterfacesAdded and
1400
1597
InterfacesRemoved signals on the standard
1401
1598
"org.freedesktop.DBus.ObjectManager" interface.
1402
1599
1403
1600
Note: No signals are sent automatically; they must be sent
1404
1601
manually.
1405
1602
"""
1406
1603
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1407
out_signature = "a{oa{sa{sv}}}")
1604
out_signature="a{oa{sa{sv}}}")
1408
1605
def GetManagedObjects(self):
1409
1606
"""This function must be overridden"""
1410
1607
raise NotImplementedError()
1411
1608
1412
1609
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1413
signature = "oa{sa{sv}}")
1610
signature="oa{sa{sv}}")
1414
1611
def InterfacesAdded(self, object_path, interfaces_and_properties):
1415
1612
pass
1416
1417
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1613
1614
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1418
1615
def InterfacesRemoved(self, object_path, interfaces):
1419
1616
pass
1420
1617
1421
1618
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1422
out_signature = "s",
1423
path_keyword = 'object_path',
1424
connection_keyword = 'connection')
1619
out_signature="s",
1620
path_keyword="object_path",
1621
connection_keyword="connection")
1425
1622
def Introspect(self, object_path, connection):
1426
1623
"""Overloading of standard D-Bus method.
1427
1624
1428
1625
Override return argument name of GetManagedObjects to be
1429
1626
"objpath_interfaces_and_properties"
1430
1627
"""
1433
1630
connection)
1434
1631
try:
1435
1632
document = xml.dom.minidom.parseString(xmlstring)
1436
1633
1437
1634
for if_tag in document.getElementsByTagName("interface"):
1438
1635
# Fix argument name for the GetManagedObjects method
1439
1636
if (if_tag.getAttribute("name")
1440
== dbus.OBJECT_MANAGER_IFACE):
1637
== dbus.OBJECT_MANAGER_IFACE):
1441
1638
for cn in if_tag.getElementsByTagName("method"):
1442
1639
if (cn.getAttribute("name")
1443
1640
== "GetManagedObjects"):
1452
1649
document.unlink()
1453
1650
except (AttributeError, xml.dom.DOMException,
1454
1651
xml.parsers.expat.ExpatError) as error:
1455
logger.error("Failed to override Introspection method",
1456
exc_info = error)
1652
log.error("Failed to override Introspection method",
1653
exc_info=error)
1457
1654
return xmlstring
1458
1655
1656
1459
1657
def datetime_to_dbus(dt, variant_level=0):
1460
1658
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1461
1659
if dt is None:
1462
return dbus.String("", variant_level = variant_level)
1660
return dbus.String("", variant_level=variant_level)
1463
1661
return dbus.String(dt.isoformat(), variant_level=variant_level)
1464
1662
1465
1663
1468
1666
dbus.service.Object, it will add alternate D-Bus attributes with
1469
1667
interface names according to the "alt_interface_names" mapping.
1470
1668
Usage:
1471
1669
1472
1670
@alternate_dbus_interfaces({"org.example.Interface":
1473
1671
"net.example.AlternateInterface"})
1474
1672
class SampleDBusObject(dbus.service.Object):
1475
1673
@dbus.service.method("org.example.Interface")
1476
1674
def SampleDBusMethod():
1477
1675
pass
1478
1676
1479
1677
The above "SampleDBusMethod" on "SampleDBusObject" will be
1480
1678
reachable via two interfaces: "org.example.Interface" and
1481
1679
"net.example.AlternateInterface", the latter of which will have
1482
1680
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1483
1681
"true", unless "deprecate" is passed with a False value.
1484
1682
1485
1683
This works for methods and signals, and also for D-Bus properties
1486
1684
(from DBusObjectWithProperties) and interfaces (from the
1487
1685
dbus_interface_annotations decorator).
1488
1686
"""
1489
1687
1490
1688
def wrapper(cls):
1491
1689
for orig_interface_name, alt_interface_name in (
1492
1690
alt_interface_names.items()):
1507
1705
interface_names.add(alt_interface)
1508
1706
# Is this a D-Bus signal?
1509
1707
if getattr(attribute, "_dbus_is_signal", False):
1708
# Extract the original non-method undecorated
1709
# function by black magic
1510
1710
if sys.version_info.major == 2:
1511
# Extract the original non-method undecorated
1512
# function by black magic
1513
1711
nonmethod_func = (dict(
1514
1712
zip(attribute.func_code.co_freevars,
1515
1713
attribute.__closure__))
1516
1714
["func"].cell_contents)
1517
1715
else:
1518
nonmethod_func = attribute
1716
nonmethod_func = (dict(
1717
zip(attribute.__code__.co_freevars,
1718
attribute.__closure__))
1719
["func"].cell_contents)
1519
1720
# Create a new, but exactly alike, function
1520
1721
# object, and decorate it to be a new D-Bus signal
1521
1722
# 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__)
1723
new_function = copy_function(nonmethod_func)
1536
1724
new_function = (dbus.service.signal(
1537
1725
alt_interface,
1538
1726
attribute._dbus_signature)(new_function))
1542
1730
attribute._dbus_annotations)
1543
1731
except AttributeError:
1544
1732
pass
1733
1545
1734
# Define a creator of a function to call both the
1546
1735
# original and alternate functions, so both the
1547
1736
# original and alternate signals gets sent when
1550
1739
"""This function is a scope container to pass
1551
1740
func1 and func2 to the "call_both" function
1552
1741
outside of its arguments"""
1553
1742
1554
1743
@functools.wraps(func2)
1555
1744
def call_both(*args, **kwargs):
1556
1745
"""This function will emit two D-Bus
1557
1746
signals by calling func1 and func2"""
1558
1747
func1(*args, **kwargs)
1559
1748
func2(*args, **kwargs)
1560
# Make wrapper function look like a D-Bus signal
1749
# Make wrapper function look like a D-Bus
1750
# signal
1561
1751
for name, attr in inspect.getmembers(func2):
1562
1752
if name.startswith("_dbus_"):
1563
1753
setattr(call_both, name, attr)
1564
1754
1565
1755
return call_both
1566
1756
# Create the "call_both" function and add it to
1567
1757
# the class
1577
1767
alt_interface,
1578
1768
attribute._dbus_in_signature,
1579
1769
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)))
1770
(copy_function(attribute)))
1585
1771
# Copy annotations, if any
1586
1772
try:
1587
1773
attr[attrname]._dbus_annotations = dict(
1599
1785
attribute._dbus_access,
1600
1786
attribute._dbus_get_args_options
1601
1787
["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)))
1788
(copy_function(attribute)))
1608
1789
# Copy annotations, if any
1609
1790
try:
1610
1791
attr[attrname]._dbus_annotations = dict(
1619
1800
# to the class.
1620
1801
attr[attrname] = (
1621
1802
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)))
1803
(copy_function(attribute)))
1627
1804
if deprecate:
1628
1805
# Deprecate all alternate interfaces
1629
iname="_AlternateDBusNames_interface_annotation{}"
1806
iname = "_AlternateDBusNames_interface_annotation{}"
1630
1807
for interface_name in interface_names:
1631
1808
1632
1809
@dbus_interface_annotations(interface_name)
1633
1810
def func(self):
1634
return { "org.freedesktop.DBus.Deprecated":
1635
"true" }
1811
return {"org.freedesktop.DBus.Deprecated":
1812
"true"}
1636
1813
# Find an unused name
1637
1814
for aname in (iname.format(i)
1638
1815
for i in itertools.count()):
1642
1819
if interface_names:
1643
1820
# Replace the class with a new subclass of it with
1644
1821
# methods, signals, etc. as created above.
1645
cls = type(b"{}Alternate".format(cls.__name__),
1646
(cls, ), attr)
1822
if sys.version_info.major == 2:
1823
cls = type(b"{}Alternate".format(cls.__name__),
1824
(cls, ), attr)
1825
else:
1826
cls = type("{}Alternate".format(cls.__name__),
1827
(cls, ), attr)
1647
1828
return cls
1648
1829
1649
1830
return wrapper
1650
1831
1651
1832
1653
1834
"se.bsnet.fukt.Mandos"})
1654
1835
class ClientDBus(Client, DBusObjectWithProperties):
1655
1836
"""A Client class using D-Bus
1656
1837
1657
1838
Attributes:
1658
1839
dbus_object_path: dbus.ObjectPath
1659
1840
bus: dbus.SystemBus()
1660
1841
"""
1661
1842
1662
1843
runtime_expansions = (Client.runtime_expansions
1663
1844
+ ("dbus_object_path", ))
1664
1845
1665
1846
_interface = "se.recompile.Mandos.Client"
1666
1847
1667
1848
# dbus.service.Object doesn't use super(), so we can't either.
1668
1669
def __init__(self, bus = None, *args, **kwargs):
1849
1850
def __init__(self, bus=None, *args, **kwargs):
1670
1851
self.bus = bus
1671
1852
Client.__init__(self, *args, **kwargs)
1672
1853
# Only now, when this client is initialized, can it show up on
1678
1859
"/clients/" + client_object_name)
1679
1860
DBusObjectWithProperties.__init__(self, self.bus,
1680
1861
self.dbus_object_path)
1681
1862
1682
1863
def notifychangeproperty(transform_func, dbus_name,
1683
1864
type_func=lambda x: x,
1684
1865
variant_level=1,
1686
1867
_interface=_interface):
1687
1868
""" Modify a variable so that it's a property which announces
1688
1869
its changes to DBus.
1689
1870
1690
1871
transform_fun: Function that takes a value and a variant_level
1691
1872
and transforms it to a D-Bus type.
1692
1873
dbus_name: D-Bus name of the variable
1695
1876
variant_level: D-Bus variant level. Default: 1
1696
1877
"""
1697
1878
attrname = "_{}".format(dbus_name)
1698
1879
1699
1880
def setter(self, value):
1700
1881
if hasattr(self, "dbus_object_path"):
1701
1882
if (not hasattr(self, attrname) or
1708
1889
else:
1709
1890
dbus_value = transform_func(
1710
1891
type_func(value),
1711
variant_level = variant_level)
1892
variant_level=variant_level)
1712
1893
self.PropertyChanged(dbus.String(dbus_name),
1713
1894
dbus_value)
1714
1895
self.PropertiesChanged(
1715
1896
_interface,
1716
dbus.Dictionary({ dbus.String(dbus_name):
1717
dbus_value }),
1897
dbus.Dictionary({dbus.String(dbus_name):
1898
dbus_value}),
1718
1899
dbus.Array())
1719
1900
setattr(self, attrname, value)
1720
1901
1721
1902
return property(lambda self: getattr(self, attrname), setter)
1722
1903
1723
1904
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1724
1905
approvals_pending = notifychangeproperty(dbus.Boolean,
1725
1906
"ApprovalPending",
1726
type_func = bool)
1907
type_func=bool)
1727
1908
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1728
1909
last_enabled = notifychangeproperty(datetime_to_dbus,
1729
1910
"LastEnabled")
1730
1911
checker = notifychangeproperty(
1731
1912
dbus.Boolean, "CheckerRunning",
1732
type_func = lambda checker: checker is not None)
1913
type_func=lambda checker: checker is not None)
1733
1914
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1734
1915
"LastCheckedOK")
1735
1916
last_checker_status = notifychangeproperty(dbus.Int16,
1740
1921
"ApprovedByDefault")
1741
1922
approval_delay = notifychangeproperty(
1742
1923
dbus.UInt64, "ApprovalDelay",
1743
type_func = lambda td: td.total_seconds() * 1000)
1924
type_func=lambda td: td.total_seconds() * 1000)
1744
1925
approval_duration = notifychangeproperty(
1745
1926
dbus.UInt64, "ApprovalDuration",
1746
type_func = lambda td: td.total_seconds() * 1000)
1927
type_func=lambda td: td.total_seconds() * 1000)
1747
1928
host = notifychangeproperty(dbus.String, "Host")
1748
1929
timeout = notifychangeproperty(
1749
1930
dbus.UInt64, "Timeout",
1750
type_func = lambda td: td.total_seconds() * 1000)
1931
type_func=lambda td: td.total_seconds() * 1000)
1751
1932
extended_timeout = notifychangeproperty(
1752
1933
dbus.UInt64, "ExtendedTimeout",
1753
type_func = lambda td: td.total_seconds() * 1000)
1934
type_func=lambda td: td.total_seconds() * 1000)
1754
1935
interval = notifychangeproperty(
1755
1936
dbus.UInt64, "Interval",
1756
type_func = lambda td: td.total_seconds() * 1000)
1937
type_func=lambda td: td.total_seconds() * 1000)
1757
1938
checker_command = notifychangeproperty(dbus.String, "Checker")
1758
1939
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1759
1940
invalidate_only=True)
1760
1941
1761
1942
del notifychangeproperty
1762
1943
1763
1944
def __del__(self, *args, **kwargs):
1764
1945
try:
1765
1946
self.remove_from_connection()
1768
1949
if hasattr(DBusObjectWithProperties, "__del__"):
1769
1950
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1770
1951
Client.__del__(self, *args, **kwargs)
1771
1952
1772
1953
def checker_callback(self, source, condition,
1773
1954
connection, command, *args, **kwargs):
1774
1955
ret = Client.checker_callback(self, source, condition,
1790
1971
| self.last_checker_signal),
1791
1972
dbus.String(command))
1792
1973
return ret
1793
1974
1794
1975
def start_checker(self, *args, **kwargs):
1795
1976
old_checker_pid = getattr(self.checker, "pid", None)
1796
1977
r = Client.start_checker(self, *args, **kwargs)
1800
1981
# Emit D-Bus signal
1801
1982
self.CheckerStarted(self.current_checker_command)
1802
1983
return r
1803
1984
1804
1985
def _reset_approved(self):
1805
1986
self.approved = None
1806
1987
return False
1807
1988
1808
1989
def approve(self, value=True):
1809
1990
self.approved = value
1810
GObject.timeout_add(int(self.approval_duration.total_seconds()
1811
* 1000), self._reset_approved)
1991
GLib.timeout_add(int(self.approval_duration.total_seconds()
1992
* 1000), self._reset_approved)
1812
1993
self.send_changedstate()
1813
1814
## D-Bus methods, signals & properties
1815
1816
## Interfaces
1817
1818
## Signals
1819
1994
1995
# D-Bus methods, signals & properties
1996
1997
# Interfaces
1998
1999
# Signals
2000
1820
2001
# CheckerCompleted - signal
1821
2002
@dbus.service.signal(_interface, signature="nxs")
1822
2003
def CheckerCompleted(self, exitcode, waitstatus, command):
1823
2004
"D-Bus signal"
1824
2005
pass
1825
2006
1826
2007
# CheckerStarted - signal
1827
2008
@dbus.service.signal(_interface, signature="s")
1828
2009
def CheckerStarted(self, command):
1829
2010
"D-Bus signal"
1830
2011
pass
1831
2012
1832
2013
# PropertyChanged - signal
1833
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1834
2015
@dbus.service.signal(_interface, signature="sv")
1835
2016
def PropertyChanged(self, property, value):
1836
2017
"D-Bus signal"
1837
2018
pass
1838
2019
1839
2020
# GotSecret - signal
1840
2021
@dbus.service.signal(_interface)
1841
2022
def GotSecret(self):
1844
2025
server to mandos-client
1845
2026
"""
1846
2027
pass
1847
2028
1848
2029
# Rejected - signal
1849
2030
@dbus.service.signal(_interface, signature="s")
1850
2031
def Rejected(self, reason):
1851
2032
"D-Bus signal"
1852
2033
pass
1853
2034
1854
2035
# NeedApproval - signal
1855
2036
@dbus.service.signal(_interface, signature="tb")
1856
2037
def NeedApproval(self, timeout, default):
1857
2038
"D-Bus signal"
1858
2039
return self.need_approval()
1859
1860
## Methods
1861
2040
2041
# Methods
2042
1862
2043
# Approve - method
1863
2044
@dbus.service.method(_interface, in_signature="b")
1864
2045
def Approve(self, value):
1865
2046
self.approve(value)
1866
2047
1867
2048
# CheckedOK - method
1868
2049
@dbus.service.method(_interface)
1869
2050
def CheckedOK(self):
1870
2051
self.checked_ok()
1871
2052
1872
2053
# Enable - method
1873
2054
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1874
2055
@dbus.service.method(_interface)
1875
2056
def Enable(self):
1876
2057
"D-Bus method"
1877
2058
self.enable()
1878
2059
1879
2060
# StartChecker - method
1880
2061
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1881
2062
@dbus.service.method(_interface)
1882
2063
def StartChecker(self):
1883
2064
"D-Bus method"
1884
2065
self.start_checker()
1885
2066
1886
2067
# Disable - method
1887
2068
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1888
2069
@dbus.service.method(_interface)
1889
2070
def Disable(self):
1890
2071
"D-Bus method"
1891
2072
self.disable()
1892
2073
1893
2074
# StopChecker - method
1894
2075
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1895
2076
@dbus.service.method(_interface)
1896
2077
def StopChecker(self):
1897
2078
self.stop_checker()
1898
1899
## Properties
1900
2079
2080
# Properties
2081
1901
2082
# ApprovalPending - property
1902
2083
@dbus_service_property(_interface, signature="b", access="read")
1903
2084
def ApprovalPending_dbus_property(self):
1904
2085
return dbus.Boolean(bool(self.approvals_pending))
1905
2086
1906
2087
# ApprovedByDefault - property
1907
2088
@dbus_service_property(_interface,
1908
2089
signature="b",
1911
2092
if value is None: # get
1912
2093
return dbus.Boolean(self.approved_by_default)
1913
2094
self.approved_by_default = bool(value)
1914
2095
1915
2096
# ApprovalDelay - property
1916
2097
@dbus_service_property(_interface,
1917
2098
signature="t",
1921
2102
return dbus.UInt64(self.approval_delay.total_seconds()
1922
2103
* 1000)
1923
2104
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1924
2105
1925
2106
# ApprovalDuration - property
1926
2107
@dbus_service_property(_interface,
1927
2108
signature="t",
1931
2112
return dbus.UInt64(self.approval_duration.total_seconds()
1932
2113
* 1000)
1933
2114
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1934
2115
1935
2116
# Name - property
1936
2117
@dbus_annotations(
1937
2118
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1938
2119
@dbus_service_property(_interface, signature="s", access="read")
1939
2120
def Name_dbus_property(self):
1940
2121
return dbus.String(self.name)
1941
2122
2123
# KeyID - property
2124
@dbus_annotations(
2125
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2126
@dbus_service_property(_interface, signature="s", access="read")
2127
def KeyID_dbus_property(self):
2128
return dbus.String(self.key_id)
2129
1942
2130
# Fingerprint - property
1943
2131
@dbus_annotations(
1944
2132
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1945
2133
@dbus_service_property(_interface, signature="s", access="read")
1946
2134
def Fingerprint_dbus_property(self):
1947
2135
return dbus.String(self.fingerprint)
1948
2136
1949
2137
# Host - property
1950
2138
@dbus_service_property(_interface,
1951
2139
signature="s",
1954
2142
if value is None: # get
1955
2143
return dbus.String(self.host)
1956
2144
self.host = str(value)
1957
2145
1958
2146
# Created - property
1959
2147
@dbus_annotations(
1960
2148
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1961
2149
@dbus_service_property(_interface, signature="s", access="read")
1962
2150
def Created_dbus_property(self):
1963
2151
return datetime_to_dbus(self.created)
1964
2152
1965
2153
# LastEnabled - property
1966
2154
@dbus_service_property(_interface, signature="s", access="read")
1967
2155
def LastEnabled_dbus_property(self):
1968
2156
return datetime_to_dbus(self.last_enabled)
1969
2157
1970
2158
# Enabled - property
1971
2159
@dbus_service_property(_interface,
1972
2160
signature="b",
1978
2166
self.enable()
1979
2167
else:
1980
2168
self.disable()
1981
2169
1982
2170
# LastCheckedOK - property
1983
2171
@dbus_service_property(_interface,
1984
2172
signature="s",
1988
2176
self.checked_ok()
1989
2177
return
1990
2178
return datetime_to_dbus(self.last_checked_ok)
1991
2179
1992
2180
# LastCheckerStatus - property
1993
2181
@dbus_service_property(_interface, signature="n", access="read")
1994
2182
def LastCheckerStatus_dbus_property(self):
1995
2183
return dbus.Int16(self.last_checker_status)
1996
2184
1997
2185
# Expires - property
1998
2186
@dbus_service_property(_interface, signature="s", access="read")
1999
2187
def Expires_dbus_property(self):
2000
2188
return datetime_to_dbus(self.expires)
2001
2189
2002
2190
# LastApprovalRequest - property
2003
2191
@dbus_service_property(_interface, signature="s", access="read")
2004
2192
def LastApprovalRequest_dbus_property(self):
2005
2193
return datetime_to_dbus(self.last_approval_request)
2006
2194
2007
2195
# Timeout - property
2008
2196
@dbus_service_property(_interface,
2009
2197
signature="t",
2024
2212
if (getattr(self, "disable_initiator_tag", None)
2025
2213
is None):
2026
2214
return
2027
GObject.source_remove(self.disable_initiator_tag)
2028
self.disable_initiator_tag = GObject.timeout_add(
2215
GLib.source_remove(self.disable_initiator_tag)
2216
self.disable_initiator_tag = GLib.timeout_add(
2029
2217
int((self.expires - now).total_seconds() * 1000),
2030
2218
self.disable)
2031
2219
2032
2220
# ExtendedTimeout - property
2033
2221
@dbus_service_property(_interface,
2034
2222
signature="t",
2038
2226
return dbus.UInt64(self.extended_timeout.total_seconds()
2039
2227
* 1000)
2040
2228
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2041
2229
2042
2230
# Interval - property
2043
2231
@dbus_service_property(_interface,
2044
2232
signature="t",
2051
2239
return
2052
2240
if self.enabled:
2053
2241
# Reschedule checker run
2054
GObject.source_remove(self.checker_initiator_tag)
2055
self.checker_initiator_tag = GObject.timeout_add(
2242
GLib.source_remove(self.checker_initiator_tag)
2243
self.checker_initiator_tag = GLib.timeout_add(
2056
2244
value, self.start_checker)
2057
self.start_checker() # Start one now, too
2058
2245
self.start_checker() # Start one now, too
2246
2059
2247
# Checker - property
2060
2248
@dbus_service_property(_interface,
2061
2249
signature="s",
2064
2252
if value is None: # get
2065
2253
return dbus.String(self.checker_command)
2066
2254
self.checker_command = str(value)
2067
2255
2068
2256
# CheckerRunning - property
2069
2257
@dbus_service_property(_interface,
2070
2258
signature="b",
2076
2264
self.start_checker()
2077
2265
else:
2078
2266
self.stop_checker()
2079
2267
2080
2268
# ObjectPath - property
2081
2269
@dbus_annotations(
2082
2270
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2083
2271
"org.freedesktop.DBus.Deprecated": "true"})
2084
2272
@dbus_service_property(_interface, signature="o", access="read")
2085
2273
def ObjectPath_dbus_property(self):
2086
return self.dbus_object_path # is already a dbus.ObjectPath
2087
2274
return self.dbus_object_path # is already a dbus.ObjectPath
2275
2088
2276
# Secret = property
2089
2277
@dbus_annotations(
2090
2278
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2095
2283
byte_arrays=True)
2096
2284
def Secret_dbus_property(self, value):
2097
2285
self.secret = bytes(value)
2098
2286
2099
2287
del _interface
2100
2288
2101
2289
2102
class ProxyClient(object):
2103
def __init__(self, child_pipe, fpr, address):
2290
class ProxyClient:
2291
def __init__(self, child_pipe, key_id, fpr, address):
2104
2292
self._pipe = child_pipe
2105
self._pipe.send(('init', fpr, address))
2293
self._pipe.send(("init", key_id, fpr, address))
2106
2294
if not self._pipe.recv():
2107
raise KeyError(fpr)
2108
2295
raise KeyError(key_id or fpr)
2296
2109
2297
def __getattribute__(self, name):
2110
if name == '_pipe':
2298
if name == "_pipe":
2111
2299
return super(ProxyClient, self).__getattribute__(name)
2112
self._pipe.send(('getattr', name))
2300
self._pipe.send(("getattr", name))
2113
2301
data = self._pipe.recv()
2114
if data[0] == 'data':
2302
if data[0] == "data":
2115
2303
return data[1]
2116
if data[0] == 'function':
2117
2304
if data[0] == "function":
2305
2118
2306
def func(*args, **kwargs):
2119
self._pipe.send(('funcall', name, args, kwargs))
2307
self._pipe.send(("funcall", name, args, kwargs))
2120
2308
return self._pipe.recv()[1]
2121
2309
2122
2310
return func
2123
2311
2124
2312
def __setattr__(self, name, value):
2125
if name == '_pipe':
2313
if name == "_pipe":
2126
2314
return super(ProxyClient, self).__setattr__(name, value)
2127
self._pipe.send(('setattr', name, value))
2315
self._pipe.send(("setattr", name, value))
2128
2316
2129
2317
2130
2318
class ClientHandler(socketserver.BaseRequestHandler, object):
2131
2319
"""A class to handle client connections.
2132
2320
2133
2321
Instantiated once for each connection to handle it.
2134
2322
Note: This will run in its own forked process."""
2135
2323
2136
2324
def handle(self):
2137
2325
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
2326
log.info("TCP connection from: %s",
2327
str(self.client_address))
2328
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2329
2143
2330
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"))
2331
2332
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2333
# "+AES-256-CBC", "+SHA1",
2334
# "+COMP-NULL", "+CTYPE-OPENPGP",
2335
# "+DHE-DSS"))
2149
2336
# Use a fallback default, since this MUST be set.
2150
2337
priority = self.server.gnutls_priority
2151
2338
if priority is None:
2152
2339
priority = "NORMAL"
2153
gnutls.priority_set_direct(session._c_object, priority,
2154
None)
2155
2340
gnutls.priority_set_direct(session,
2341
priority.encode("utf-8"), None)
2342
2156
2343
# Start communication using the Mandos protocol
2157
2344
# Get protocol number
2158
2345
line = self.request.makefile().readline()
2159
logger.debug("Protocol version: %r", line)
2346
log.debug("Protocol version: %r", line)
2160
2347
try:
2161
2348
if int(line.strip().split()[0]) > 1:
2162
2349
raise RuntimeError(line)
2163
2350
except (ValueError, IndexError, RuntimeError) as error:
2164
logger.error("Unknown protocol version: %s", error)
2351
log.error("Unknown protocol version: %s", error)
2165
2352
return
2166
2353
2167
2354
# Start GnuTLS connection
2168
2355
try:
2169
2356
session.handshake()
2170
2357
except gnutls.Error as error:
2171
logger.warning("Handshake failed: %s", error)
2358
log.warning("Handshake failed: %s", error)
2172
2359
# Do not run session.bye() here: the session is not
2173
2360
# established. Just abandon the request.
2174
2361
return
2175
logger.debug("Handshake succeeded")
2176
2362
log.debug("Handshake succeeded")
2363
2177
2364
approval_required = False
2178
2365
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,
2366
if gnutls.has_rawpk:
2367
fpr = b""
2368
try:
2369
key_id = self.key_id(
2370
self.peer_certificate(session))
2371
except (TypeError, gnutls.Error) as error:
2372
log.warning("Bad certificate: %s", error)
2373
return
2374
log.debug("Key ID: %s",
2375
key_id.decode("utf-8",
2376
errors="replace"))
2377
2378
else:
2379
key_id = b""
2380
try:
2381
fpr = self.fingerprint(
2382
self.peer_certificate(session))
2383
except (TypeError, gnutls.Error) as error:
2384
log.warning("Bad certificate: %s", error)
2385
return
2386
log.debug("Fingerprint: %s", fpr)
2387
2388
try:
2389
client = ProxyClient(child_pipe, key_id, fpr,
2189
2390
self.client_address)
2190
2391
except KeyError:
2191
2392
return
2192
2393
2193
2394
if client.approval_delay:
2194
2395
delay = client.approval_delay
2195
2396
client.approvals_pending += 1
2196
2397
approval_required = True
2197
2398
2198
2399
while True:
2199
2400
if not client.enabled:
2200
logger.info("Client %s is disabled",
2201
client.name)
2401
log.info("Client %s is disabled", client.name)
2202
2402
if self.server.use_dbus:
2203
2403
# Emit D-Bus signal
2204
2404
client.Rejected("Disabled")
2205
2405
return
2206
2406
2207
2407
if client.approved or not client.approval_delay:
2208
#We are approved or approval is disabled
2408
# We are approved or approval is disabled
2209
2409
break
2210
2410
elif client.approved is None:
2211
logger.info("Client %s needs approval",
2212
client.name)
2411
log.info("Client %s needs approval",
2412
client.name)
2213
2413
if self.server.use_dbus:
2214
2414
# Emit D-Bus signal
2215
2415
client.NeedApproval(
2216
2416
client.approval_delay.total_seconds()
2217
2417
* 1000, client.approved_by_default)
2218
2418
else:
2219
logger.warning("Client %s was not approved",
2220
client.name)
2419
log.warning("Client %s was not approved",
2420
client.name)
2221
2421
if self.server.use_dbus:
2222
2422
# Emit D-Bus signal
2223
2423
client.Rejected("Denied")
2224
2424
return
2225
2226
#wait until timeout or approved
2425
2426
# wait until timeout or approved
2227
2427
time = datetime.datetime.now()
2228
2428
client.changedstate.acquire()
2229
2429
client.changedstate.wait(delay.total_seconds())
2231
2431
time2 = datetime.datetime.now()
2232
2432
if (time2 - time) >= delay:
2233
2433
if not client.approved_by_default:
2234
logger.warning("Client %s timed out while"
2235
" waiting for approval",
2236
client.name)
2434
log.warning("Client %s timed out while"
2435
" waiting for approval",
2436
client.name)
2237
2437
if self.server.use_dbus:
2238
2438
# Emit D-Bus signal
2239
2439
client.Rejected("Approval timed out")
2242
2442
break
2243
2443
else:
2244
2444
delay -= time2 - time
2245
2445
2246
2446
try:
2247
2447
session.send(client.secret)
2248
2448
except gnutls.Error as error:
2249
logger.warning("gnutls send failed",
2250
exc_info = error)
2449
log.warning("gnutls send failed", exc_info=error)
2251
2450
return
2252
2253
logger.info("Sending secret to %s", client.name)
2451
2452
log.info("Sending secret to %s", client.name)
2254
2453
# bump the timeout using extended_timeout
2255
2454
client.bump_timeout(client.extended_timeout)
2256
2455
if self.server.use_dbus:
2257
2456
# Emit D-Bus signal
2258
2457
client.GotSecret()
2259
2458
2260
2459
finally:
2261
2460
if approval_required:
2262
2461
client.approvals_pending -= 1
2263
2462
try:
2264
2463
session.bye()
2265
2464
except gnutls.Error as error:
2266
logger.warning("GnuTLS bye failed",
2267
exc_info=error)
2268
2465
log.warning("GnuTLS bye failed", exc_info=error)
2466
2269
2467
@staticmethod
2270
2468
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):
2469
"Return the peer's certificate as a bytestring"
2470
try:
2471
cert_type = gnutls.certificate_type_get2(
2472
session, gnutls.CTYPE_PEERS)
2473
except AttributeError:
2474
cert_type = gnutls.certificate_type_get(session)
2475
if gnutls.has_rawpk:
2476
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2477
else:
2478
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2479
# If not a valid certificate type...
2480
if cert_type not in valid_cert_types:
2481
log.info("Cert type %r not in %r", cert_type,
2482
valid_cert_types)
2275
2483
# ...return invalid data
2276
2484
return b""
2277
2485
list_size = ctypes.c_uint(1)
2278
2486
cert_list = (gnutls.certificate_get_peers
2279
(session._c_object, ctypes.byref(list_size)))
2487
(session, ctypes.byref(list_size)))
2280
2488
if not bool(cert_list) and list_size.value != 0:
2281
2489
raise gnutls.Error("error getting peer certificate")
2282
2490
if list_size.value == 0:
2283
2491
return None
2284
2492
cert = cert_list[0]
2285
2493
return ctypes.string_at(cert.data, cert.size)
2286
2494
2495
@staticmethod
2496
def key_id(certificate):
2497
"Convert a certificate bytestring to a hexdigit key ID"
2498
# New GnuTLS "datum" with the public key
2499
datum = gnutls.datum_t(
2500
ctypes.cast(ctypes.c_char_p(certificate),
2501
ctypes.POINTER(ctypes.c_ubyte)),
2502
ctypes.c_uint(len(certificate)))
2503
# XXX all these need to be created in the gnutls "module"
2504
# New empty GnuTLS certificate
2505
pubkey = gnutls.pubkey_t()
2506
gnutls.pubkey_init(ctypes.byref(pubkey))
2507
# Import the raw public key into the certificate
2508
gnutls.pubkey_import(pubkey,
2509
ctypes.byref(datum),
2510
gnutls.X509_FMT_DER)
2511
# New buffer for the key ID
2512
buf = ctypes.create_string_buffer(32)
2513
buf_len = ctypes.c_size_t(len(buf))
2514
# Get the key ID from the raw public key into the buffer
2515
gnutls.pubkey_get_key_id(
2516
pubkey,
2517
gnutls.KEYID_USE_SHA256,
2518
ctypes.cast(ctypes.byref(buf),
2519
ctypes.POINTER(ctypes.c_ubyte)),
2520
ctypes.byref(buf_len))
2521
# Deinit the certificate
2522
gnutls.pubkey_deinit(pubkey)
2523
2524
# Convert the buffer to a Python bytestring
2525
key_id = ctypes.string_at(buf, buf_len.value)
2526
# Convert the bytestring to hexadecimal notation
2527
hex_key_id = binascii.hexlify(key_id).upper()
2528
return hex_key_id
2529
2287
2530
@staticmethod
2288
2531
def fingerprint(openpgp):
2289
2532
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2304
2547
ctypes.byref(crtverify))
2305
2548
if crtverify.value != 0:
2306
2549
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
2550
raise gnutls.CertificateSecurityError(code
2551
=crtverify.value)
2308
2552
# New buffer for the fingerprint
2309
2553
buf = ctypes.create_string_buffer(20)
2310
2554
buf_len = ctypes.c_size_t()
2320
2564
return hex_fpr
2321
2565
2322
2566
2323
class MultiprocessingMixIn(object):
2567
class MultiprocessingMixIn:
2324
2568
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2325
2569
2326
2570
def sub_process_main(self, request, address):
2327
2571
try:
2328
2572
self.finish_request(request, address)
2329
2573
except Exception:
2330
2574
self.handle_error(request, address)
2331
2575
self.close_request(request)
2332
2576
2333
2577
def process_request(self, request, address):
2334
2578
"""Start a new process to process the request."""
2335
proc = multiprocessing.Process(target = self.sub_process_main,
2336
args = (request, address))
2579
proc = multiprocessing.Process(target=self.sub_process_main,
2580
args=(request, address))
2337
2581
proc.start()
2338
2582
return proc
2339
2583
2340
2584
2341
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2585
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2342
2586
""" adds a pipe to the MixIn """
2343
2587
2344
2588
def process_request(self, request, client_address):
2345
2589
"""Overrides and wraps the original process_request().
2346
2590
2347
2591
This function creates a new pipe in self.pipe
2348
2592
"""
2349
2593
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2350
2594
2351
2595
proc = MultiprocessingMixIn.process_request(self, request,
2352
2596
client_address)
2353
2597
self.child_pipe.close()
2354
2598
self.add_pipe(parent_pipe, proc)
2355
2599
2356
2600
def add_pipe(self, parent_pipe, proc):
2357
2601
"""Dummy function; override as necessary"""
2358
2602
raise NotImplementedError()
2359
2603
2360
2604
2361
2605
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2362
socketserver.TCPServer, object):
2363
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2364
2606
socketserver.TCPServer):
2607
"""IPv6-capable TCP server. Accepts None as address and/or port
2608
2365
2609
Attributes:
2366
2610
enabled: Boolean; whether this server is activated yet
2367
2611
interface: None or a network interface name (string)
2368
2612
use_ipv6: Boolean; to use IPv6 or not
2369
2613
"""
2370
2614
2371
2615
def __init__(self, server_address, RequestHandlerClass,
2372
2616
interface=None,
2373
2617
use_ipv6=True,
2383
2627
self.socketfd = socketfd
2384
2628
# Save the original socket.socket() function
2385
2629
self.socket_socket = socket.socket
2630
2386
2631
# To implement --socket, we monkey patch socket.socket.
2387
#
2632
#
2388
2633
# (When socketserver.TCPServer is a new-style class, we
2389
2634
# could make self.socket into a property instead of monkey
2390
2635
# patching socket.socket.)
2391
#
2636
#
2392
2637
# Create a one-time-only replacement for socket.socket()
2393
2638
@functools.wraps(socket.socket)
2394
2639
def socket_wrapper(*args, **kwargs):
2406
2651
# socket_wrapper(), if socketfd was set.
2407
2652
socketserver.TCPServer.__init__(self, server_address,
2408
2653
RequestHandlerClass)
2409
2654
2410
2655
def server_bind(self):
2411
2656
"""This overrides the normal server_bind() function
2412
2657
to bind to an interface if one was specified, and also NOT to
2413
2658
bind to an address or port if they were not specified."""
2659
global SO_BINDTODEVICE
2414
2660
if self.interface is not None:
2415
2661
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
2662
# Fall back to a hard-coded value which seems to be
2663
# common enough.
2664
log.warning("SO_BINDTODEVICE not found, trying 25")
2665
SO_BINDTODEVICE = 25
2666
try:
2667
self.socket.setsockopt(
2668
socket.SOL_SOCKET, SO_BINDTODEVICE,
2669
(self.interface + "\0").encode("utf-8"))
2670
except socket.error as error:
2671
if error.errno == errno.EPERM:
2672
log.error("No permission to bind to interface %s",
2673
self.interface)
2674
elif error.errno == errno.ENOPROTOOPT:
2675
log.error("SO_BINDTODEVICE not available; cannot"
2676
" bind to interface %s", self.interface)
2677
elif error.errno == errno.ENODEV:
2678
log.error("Interface %s does not exist, cannot"
2679
" bind", self.interface)
2680
else:
2681
raise
2437
2682
# Only bind(2) the socket if we really need to.
2438
2683
if self.server_address[0] or self.server_address[1]:
2684
if self.server_address[1]:
2685
self.allow_reuse_address = True
2439
2686
if not self.server_address[0]:
2440
2687
if self.address_family == socket.AF_INET6:
2441
any_address = "::" # in6addr_any
2688
any_address = "::" # in6addr_any
2442
2689
else:
2443
any_address = "0.0.0.0" # INADDR_ANY
2690
any_address = "0.0.0.0" # INADDR_ANY
2444
2691
self.server_address = (any_address,
2445
2692
self.server_address[1])
2446
2693
elif not self.server_address[1]:
2456
2703
2457
2704
class MandosServer(IPv6_TCPServer):
2458
2705
"""Mandos server.
2459
2706
2460
2707
Attributes:
2461
2708
clients: set of Client objects
2462
2709
gnutls_priority GnuTLS priority string
2463
2710
use_dbus: Boolean; to emit D-Bus signals or not
2464
2465
Assumes a GObject.MainLoop event loop.
2711
2712
Assumes a GLib.MainLoop event loop.
2466
2713
"""
2467
2714
2468
2715
def __init__(self, server_address, RequestHandlerClass,
2469
2716
interface=None,
2470
2717
use_ipv6=True,
2480
2727
self.gnutls_priority = gnutls_priority
2481
2728
IPv6_TCPServer.__init__(self, server_address,
2482
2729
RequestHandlerClass,
2483
interface = interface,
2484
use_ipv6 = use_ipv6,
2485
socketfd = socketfd)
2486
2730
interface=interface,
2731
use_ipv6=use_ipv6,
2732
socketfd=socketfd)
2733
2487
2734
def server_activate(self):
2488
2735
if self.enabled:
2489
2736
return socketserver.TCPServer.server_activate(self)
2490
2737
2491
2738
def enable(self):
2492
2739
self.enabled = True
2493
2740
2494
2741
def add_pipe(self, parent_pipe, proc):
2495
2742
# 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,
2743
GLib.io_add_watch(
2744
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2745
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2499
2746
functools.partial(self.handle_ipc,
2500
parent_pipe = parent_pipe,
2501
proc = proc))
2502
2747
parent_pipe=parent_pipe,
2748
proc=proc))
2749
2503
2750
def handle_ipc(self, source, condition,
2504
2751
parent_pipe=None,
2505
proc = None,
2752
proc=None,
2506
2753
client_object=None):
2507
2754
# error, or the other end of multiprocessing.Pipe has closed
2508
if condition & (GObject.IO_ERR | GObject.IO_HUP):
2755
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2509
2756
# Wait for other process to exit
2510
2757
proc.join()
2511
2758
return False
2512
2759
2513
2760
# Read a request from the child
2514
2761
request = parent_pipe.recv()
2515
2762
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:
2763
2764
if command == "init":
2765
key_id = request[1].decode("ascii")
2766
fpr = request[2].decode("ascii")
2767
address = request[3]
2768
2769
for c in self.clients.values():
2770
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2771
"27AE41E4649B934CA495991B7852B855"):
2772
continue
2773
if key_id and c.key_id == key_id:
2774
client = c
2775
break
2776
if fpr and c.fingerprint == fpr:
2523
2777
client = c
2524
2778
break
2525
2779
else:
2526
logger.info("Client not found for fingerprint: %s, ad"
2527
"dress: %s", fpr, address)
2780
log.info("Client not found for key ID: %s, address:"
2781
" %s", key_id or fpr, address)
2528
2782
if self.use_dbus:
2529
2783
# Emit D-Bus signal
2530
mandos_dbus_service.ClientNotFound(fpr,
2784
mandos_dbus_service.ClientNotFound(key_id or fpr,
2531
2785
address[0])
2532
2786
parent_pipe.send(False)
2533
2787
return False
2534
2535
GObject.io_add_watch(
2536
parent_pipe.fileno(),
2537
GObject.IO_IN | GObject.IO_HUP,
2788
2789
GLib.io_add_watch(
2790
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2791
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2538
2792
functools.partial(self.handle_ipc,
2539
parent_pipe = parent_pipe,
2540
proc = proc,
2541
client_object = client))
2793
parent_pipe=parent_pipe,
2794
proc=proc,
2795
client_object=client))
2542
2796
parent_pipe.send(True)
2543
2797
# remove the old hook in favor of the new above hook on
2544
2798
# same fileno
2545
2799
return False
2546
if command == 'funcall':
2800
if command == "funcall":
2547
2801
funcname = request[1]
2548
2802
args = request[2]
2549
2803
kwargs = request[3]
2550
2551
parent_pipe.send(('data', getattr(client_object,
2804
2805
parent_pipe.send(("data", getattr(client_object,
2552
2806
funcname)(*args,
2553
2807
**kwargs)))
2554
2555
if command == 'getattr':
2808
2809
if command == "getattr":
2556
2810
attrname = request[1]
2557
2811
if isinstance(client_object.__getattribute__(attrname),
2558
collections.Callable):
2559
parent_pipe.send(('function', ))
2812
collections.abc.Callable):
2813
parent_pipe.send(("function", ))
2560
2814
else:
2561
2815
parent_pipe.send((
2562
'data', client_object.__getattribute__(attrname)))
2563
2564
if command == 'setattr':
2816
"data", client_object.__getattribute__(attrname)))
2817
2818
if command == "setattr":
2565
2819
attrname = request[1]
2566
2820
value = request[2]
2567
2821
setattr(client_object, attrname, value)
2568
2822
2569
2823
return True
2570
2824
2571
2825
2572
2826
def rfc3339_duration_to_delta(duration):
2573
2827
"""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)
2828
2829
>>> timedelta = datetime.timedelta
2830
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2831
True
2832
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2833
True
2834
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2835
True
2836
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2837
True
2838
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2839
True
2840
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2841
True
2842
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2843
True
2844
>>> del timedelta
2589
2845
"""
2590
2846
2591
2847
# Parsing an RFC 3339 duration with regular expressions is not
2592
2848
# possible - there would have to be multiple places for the same
2593
2849
# values, like seconds. The current code, while more esoteric, is
2594
2850
# cleaner without depending on a parsing library. If Python had a
2595
2851
# built-in library for parsing we would use it, but we'd like to
2596
2852
# avoid excessive use of external libraries.
2597
2853
2598
2854
# New type for defining tokens, syntax, and semantics all-in-one
2599
2855
Token = collections.namedtuple("Token", (
2600
2856
"regexp", # To match token; if "value" is not None, must have
2633
2889
frozenset((token_year, token_month,
2634
2890
token_day, token_time,
2635
2891
token_week)))
2636
# Define starting values
2637
value = datetime.timedelta() # Value so far
2892
# Define starting values:
2893
# Value so far
2894
value = datetime.timedelta()
2638
2895
found_token = None
2639
followers = frozenset((token_duration, )) # Following valid tokens
2640
s = duration # String left to parse
2896
# Following valid tokens
2897
followers = frozenset((token_duration, ))
2898
# String left to parse
2899
s = duration
2641
2900
# Loop until end token is found
2642
2901
while found_token is not token_end:
2643
2902
# Search for any currently valid tokens
2667
2926
2668
2927
def string_to_delta(interval):
2669
2928
"""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)
2929
2930
>>> string_to_delta("7d") == datetime.timedelta(7)
2931
True
2932
>>> string_to_delta("60s") == datetime.timedelta(0, 60)
2933
True
2934
>>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2935
True
2936
>>> string_to_delta("24h") == datetime.timedelta(1)
2937
True
2938
>>> string_to_delta("1w") == datetime.timedelta(7)
2939
True
2940
>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2941
True
2683
2942
"""
2684
2943
2685
2944
try:
2686
2945
return rfc3339_duration_to_delta(interval)
2687
2946
except ValueError:
2688
2947
pass
2689
2948
2690
2949
timevalue = datetime.timedelta(0)
2691
2950
for s in interval.split():
2692
2951
try:
2710
2969
return timevalue
2711
2970
2712
2971
2713
def daemon(nochdir = False, noclose = False):
2972
def daemon(nochdir=False, noclose=False):
2714
2973
"""See daemon(3). Standard BSD Unix function.
2715
2974
2716
2975
This should really exist as os.daemon, but it doesn't (yet)."""
2717
2976
if os.fork():
2718
2977
sys.exit()
2736
2995
2737
2996
2738
2997
def main():
2739
2998
2740
2999
##################################################################
2741
3000
# Parsing of options, both command line and config file
2742
3001
2743
3002
parser = argparse.ArgumentParser()
2744
3003
parser.add_argument("-v", "--version", action="version",
2745
version = "%(prog)s {}".format(version),
3004
version="%(prog)s {}".format(version),
2746
3005
help="show version number and exit")
2747
3006
parser.add_argument("-i", "--interface", metavar="IF",
2748
3007
help="Bind to interface IF")
2784
3043
parser.add_argument("--no-zeroconf", action="store_false",
2785
3044
dest="zeroconf", help="Do not use Zeroconf",
2786
3045
default=None)
2787
3046
2788
3047
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
3048
2795
3049
# 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
3050
if gnutls.has_rawpk:
3051
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3052
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3053
else:
3054
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3055
":+SIGN-DSA-SHA256")
3056
server_defaults = {"interface": "",
3057
"address": "",
3058
"port": "",
3059
"debug": "False",
3060
"priority": priority,
3061
"servicename": "Mandos",
3062
"use_dbus": "True",
3063
"use_ipv6": "True",
3064
"debuglevel": "",
3065
"restore": "True",
3066
"socket": "",
3067
"statedir": "/var/lib/mandos",
3068
"foreground": "False",
3069
"zeroconf": "True",
3070
}
3071
del priority
3072
2814
3073
# Parse config file for server-global settings
2815
server_config = configparser.SafeConfigParser(server_defaults)
3074
server_config = configparser.ConfigParser(server_defaults)
2816
3075
del server_defaults
2817
3076
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2818
# Convert the SafeConfigParser object to a dict
3077
# Convert the ConfigParser object to a dict
2819
3078
server_settings = server_config.defaults()
2820
3079
# Use the appropriate methods on the non-string config options
2821
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3080
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3081
"foreground", "zeroconf"):
2822
3082
server_settings[option] = server_config.getboolean("DEFAULT",
2823
3083
option)
2824
3084
if server_settings["port"]:
2834
3094
server_settings["socket"] = os.dup(server_settings
2835
3095
["socket"])
2836
3096
del server_config
2837
3097
2838
3098
# Override the settings from the config file with command line
2839
3099
# options, if set.
2840
3100
for option in ("interface", "address", "port", "debug",
2858
3118
if server_settings["debug"]:
2859
3119
server_settings["foreground"] = True
2860
3120
# Now we have our good server settings in "server_settings"
2861
3121
2862
3122
##################################################################
2863
3123
2864
3124
if (not server_settings["zeroconf"]
2865
3125
and not (server_settings["port"]
2866
3126
or server_settings["socket"] != "")):
2867
3127
parser.error("Needs port or socket to work without Zeroconf")
2868
3128
2869
3129
# For convenience
2870
3130
debug = server_settings["debug"]
2871
3131
debuglevel = server_settings["debuglevel"]
2875
3135
stored_state_file)
2876
3136
foreground = server_settings["foreground"]
2877
3137
zeroconf = server_settings["zeroconf"]
2878
3138
2879
3139
if debug:
2880
3140
initlogger(debug, logging.DEBUG)
2881
3141
else:
2884
3144
else:
2885
3145
level = getattr(logging, debuglevel.upper())
2886
3146
initlogger(debug, level)
2887
3147
2888
3148
if server_settings["servicename"] != "Mandos":
2889
3149
syslogger.setFormatter(
2890
logging.Formatter('Mandos ({}) [%(process)d]:'
2891
' %(levelname)s: %(message)s'.format(
3150
logging.Formatter("Mandos ({}) [%(process)d]:"
3151
" %(levelname)s: %(message)s".format(
2892
3152
server_settings["servicename"])))
2893
3153
2894
3154
# Parse config file with clients
2895
client_config = configparser.SafeConfigParser(Client
2896
.client_defaults)
3155
client_config = configparser.ConfigParser(Client.client_defaults)
2897
3156
client_config.read(os.path.join(server_settings["configdir"],
2898
3157
"clients.conf"))
2899
3158
2900
3159
global mandos_dbus_service
2901
3160
mandos_dbus_service = None
2902
3161
2903
3162
socketfd = None
2904
3163
if server_settings["socket"] != "":
2905
3164
socketfd = server_settings["socket"]
2919
3178
try:
2920
3179
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2921
3180
except IOError as e:
2922
logger.error("Could not open file %r", pidfilename,
2923
exc_info=e)
2924
3181
log.error("Could not open file %r", pidfilename,
3182
exc_info=e)
3183
2925
3184
for name, group in (("_mandos", "_mandos"),
2926
3185
("mandos", "mandos"),
2927
3186
("nobody", "nogroup")):
2937
3196
try:
2938
3197
os.setgid(gid)
2939
3198
os.setuid(uid)
3199
log.debug("Did setuid/setgid to %s:%s", uid, gid)
2940
3200
except OSError as error:
3201
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3202
os.strerror(error.errno))
2941
3203
if error.errno != errno.EPERM:
2942
3204
raise
2943
3205
2944
3206
if debug:
2945
3207
# Enable all possible GnuTLS debugging
2946
3208
2947
3209
# "Use a log level over 10 to enable all debugging options."
2948
3210
# - GnuTLS manual
2949
3211
gnutls.global_set_log_level(11)
2950
3212
2951
3213
@gnutls.log_func
2952
3214
def debug_gnutls(level, string):
2953
logger.debug("GnuTLS: %s", string[:-1])
2954
3215
log.debug("GnuTLS: %s",
3216
string[:-1].decode("utf-8", errors="replace"))
3217
2955
3218
gnutls.global_set_log_function(debug_gnutls)
2956
3219
2957
3220
# Redirect stdin so all checkers get /dev/null
2958
3221
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2959
3222
os.dup2(null, sys.stdin.fileno())
2960
3223
if null > 2:
2961
3224
os.close(null)
2962
3225
2963
3226
# Need to fork before connecting to D-Bus
2964
3227
if not foreground:
2965
3228
# Close all input and output, do double fork, etc.
2966
3229
daemon()
2967
2968
# multiprocessing will use threads, so before we use GObject we
2969
# need to inform GObject that threads will be used.
2970
GObject.threads_init()
2971
3230
3231
if gi.version_info < (3, 10, 2):
3232
# multiprocessing will use threads, so before we use GLib we
3233
# need to inform GLib that threads will be used.
3234
GLib.threads_init()
3235
2972
3236
global main_loop
2973
3237
# From the Avahi example code
2974
3238
DBusGMainLoop(set_as_default=True)
2975
main_loop = GObject.MainLoop()
3239
main_loop = GLib.MainLoop()
2976
3240
bus = dbus.SystemBus()
2977
3241
# End of Avahi example code
2978
3242
if use_dbus:
2984
3248
"se.bsnet.fukt.Mandos", bus,
2985
3249
do_not_queue=True)
2986
3250
except dbus.exceptions.DBusException as e:
2987
logger.error("Disabling D-Bus:", exc_info=e)
3251
log.error("Disabling D-Bus:", exc_info=e)
2988
3252
use_dbus = False
2989
3253
server_settings["use_dbus"] = False
2990
3254
tcp_server.use_dbus = False
2991
3255
if zeroconf:
2992
3256
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2993
3257
service = AvahiServiceToSyslog(
2994
name = server_settings["servicename"],
2995
servicetype = "_mandos._tcp",
2996
protocol = protocol,
2997
bus = bus)
3258
name=server_settings["servicename"],
3259
servicetype="_mandos._tcp",
3260
protocol=protocol,
3261
bus=bus)
2998
3262
if server_settings["interface"]:
2999
3263
service.interface = if_nametoindex(
3000
3264
server_settings["interface"].encode("utf-8"))
3001
3265
3002
3266
global multiprocessing_manager
3003
3267
multiprocessing_manager = multiprocessing.Manager()
3004
3268
3005
3269
client_class = Client
3006
3270
if use_dbus:
3007
client_class = functools.partial(ClientDBus, bus = bus)
3008
3271
client_class = functools.partial(ClientDBus, bus=bus)
3272
3009
3273
client_settings = Client.config_parser(client_config)
3010
3274
old_client_settings = {}
3011
3275
clients_data = {}
3012
3276
3013
3277
# This is used to redirect stdout and stderr for checker processes
3014
3278
global wnull
3015
wnull = open(os.devnull, "w") # A writable /dev/null
3279
wnull = open(os.devnull, "w") # A writable /dev/null
3016
3280
# Only used if server is running in foreground but not in debug
3017
3281
# mode
3018
3282
if debug or not foreground:
3019
3283
wnull.close()
3020
3284
3021
3285
# Get client data and settings from last running state.
3022
3286
if server_settings["restore"]:
3023
3287
try:
3024
3288
with open(stored_state_path, "rb") as stored_state:
3025
clients_data, old_client_settings = pickle.load(
3026
stored_state)
3289
if sys.version_info.major == 2:
3290
clients_data, old_client_settings = pickle.load(
3291
stored_state)
3292
else:
3293
bytes_clients_data, bytes_old_client_settings = (
3294
pickle.load(stored_state, encoding="bytes"))
3295
# Fix bytes to strings
3296
# clients_data
3297
# .keys()
3298
clients_data = {(key.decode("utf-8")
3299
if isinstance(key, bytes)
3300
else key): value
3301
for key, value in
3302
bytes_clients_data.items()}
3303
del bytes_clients_data
3304
for key in clients_data:
3305
value = {(k.decode("utf-8")
3306
if isinstance(k, bytes) else k): v
3307
for k, v in
3308
clients_data[key].items()}
3309
clients_data[key] = value
3310
# .client_structure
3311
value["client_structure"] = [
3312
(s.decode("utf-8")
3313
if isinstance(s, bytes)
3314
else s) for s in
3315
value["client_structure"]]
3316
# .name, .host, and .checker_command
3317
for k in ("name", "host", "checker_command"):
3318
if isinstance(value[k], bytes):
3319
value[k] = value[k].decode("utf-8")
3320
if "key_id" not in value:
3321
value["key_id"] = ""
3322
elif "fingerprint" not in value:
3323
value["fingerprint"] = ""
3324
# old_client_settings
3325
# .keys()
3326
old_client_settings = {
3327
(key.decode("utf-8")
3328
if isinstance(key, bytes)
3329
else key): value
3330
for key, value in
3331
bytes_old_client_settings.items()}
3332
del bytes_old_client_settings
3333
# .host and .checker_command
3334
for value in old_client_settings.values():
3335
for attribute in ("host", "checker_command"):
3336
if isinstance(value[attribute], bytes):
3337
value[attribute] = (value[attribute]
3338
.decode("utf-8"))
3027
3339
os.remove(stored_state_path)
3028
3340
except IOError as e:
3029
3341
if e.errno == errno.ENOENT:
3030
logger.warning("Could not load persistent state:"
3031
" {}".format(os.strerror(e.errno)))
3342
log.warning("Could not load persistent state:"
3343
" %s", os.strerror(e.errno))
3032
3344
else:
3033
logger.critical("Could not load persistent state:",
3034
exc_info=e)
3345
log.critical("Could not load persistent state:",
3346
exc_info=e)
3035
3347
raise
3036
3348
except EOFError as e:
3037
logger.warning("Could not load persistent state: "
3038
"EOFError:",
3039
exc_info=e)
3040
3349
log.warning("Could not load persistent state: EOFError:",
3350
exc_info=e)
3351
3041
3352
with PGPEngine() as pgp:
3042
3353
for client_name, client in clients_data.items():
3043
3354
# Skip removed clients
3044
3355
if client_name not in client_settings:
3045
3356
continue
3046
3357
3047
3358
# Decide which value to use after restoring saved state.
3048
3359
# We have three different values: Old config file,
3049
3360
# new config file, and saved state.
3060
3371
client[name] = value
3061
3372
except KeyError:
3062
3373
pass
3063
3374
3064
3375
# Clients who has passed its expire date can still be
3065
3376
# enabled if its last checker was successful. A Client
3066
3377
# whose checker succeeded before we stored its state is
3069
3380
if client["enabled"]:
3070
3381
if datetime.datetime.utcnow() >= client["expires"]:
3071
3382
if not client["last_checked_ok"]:
3072
logger.warning(
3073
"disabling client {} - Client never "
3074
"performed a successful checker".format(
3075
client_name))
3383
log.warning("disabling client %s - Client"
3384
" never performed a successful"
3385
" checker", client_name)
3076
3386
client["enabled"] = False
3077
3387
elif client["last_checker_status"] != 0:
3078
logger.warning(
3079
"disabling client {} - Client last"
3080
" checker failed with error code"
3081
" {}".format(
3082
client_name,
3083
client["last_checker_status"]))
3388
log.warning("disabling client %s - Client"
3389
" last checker failed with error"
3390
" code %s", client_name,
3391
client["last_checker_status"])
3084
3392
client["enabled"] = False
3085
3393
else:
3086
3394
client["expires"] = (
3087
3395
datetime.datetime.utcnow()
3088
3396
+ client["timeout"])
3089
logger.debug("Last checker succeeded,"
3090
" keeping {} enabled".format(
3091
client_name))
3397
log.debug("Last checker succeeded, keeping %s"
3398
" enabled", client_name)
3092
3399
try:
3093
3400
client["secret"] = pgp.decrypt(
3094
3401
client["encrypted_secret"],
3095
3402
client_settings[client_name]["secret"])
3096
3403
except PGPError:
3097
3404
# If decryption fails, we use secret from new settings
3098
logger.debug("Failed to decrypt {} old secret".format(
3099
client_name))
3405
log.debug("Failed to decrypt %s old secret",
3406
client_name)
3100
3407
client["secret"] = (client_settings[client_name]
3101
3408
["secret"])
3102
3409
3103
3410
# Add/remove clients based on new changes made to config
3104
3411
for client_name in (set(old_client_settings)
3105
3412
- set(client_settings)):
3107
3414
for client_name in (set(client_settings)
3108
3415
- set(old_client_settings)):
3109
3416
clients_data[client_name] = client_settings[client_name]
3110
3417
3111
3418
# Create all client objects
3112
3419
for client_name, client in clients_data.items():
3113
3420
tcp_server.clients[client_name] = client_class(
3114
name = client_name,
3115
settings = client,
3116
server_settings = server_settings)
3117
3421
name=client_name,
3422
settings=client,
3423
server_settings=server_settings)
3424
3118
3425
if not tcp_server.clients:
3119
logger.warning("No clients defined")
3120
3426
log.warning("No clients defined")
3427
3121
3428
if not foreground:
3122
3429
if pidfile is not None:
3123
3430
pid = os.getpid()
3125
3432
with pidfile:
3126
3433
print(pid, file=pidfile)
3127
3434
except IOError:
3128
logger.error("Could not write to file %r with PID %d",
3129
pidfilename, pid)
3435
log.error("Could not write to file %r with PID %d",
3436
pidfilename, pid)
3130
3437
del pidfile
3131
3438
del pidfilename
3132
3133
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3134
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3135
3439
3440
for termsig in (signal.SIGHUP, signal.SIGTERM):
3441
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3442
lambda: main_loop.quit() and False)
3443
3136
3444
if use_dbus:
3137
3445
3138
3446
@alternate_dbus_interfaces(
3139
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3447
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3140
3448
class MandosDBusService(DBusObjectWithObjectManager):
3141
3449
"""A D-Bus proxy object"""
3142
3450
3143
3451
def __init__(self):
3144
3452
dbus.service.Object.__init__(self, bus, "/")
3145
3453
3146
3454
_interface = "se.recompile.Mandos"
3147
3455
3148
3456
@dbus.service.signal(_interface, signature="o")
3149
3457
def ClientAdded(self, objpath):
3150
3458
"D-Bus signal"
3151
3459
pass
3152
3460
3153
3461
@dbus.service.signal(_interface, signature="ss")
3154
def ClientNotFound(self, fingerprint, address):
3462
def ClientNotFound(self, key_id, address):
3155
3463
"D-Bus signal"
3156
3464
pass
3157
3465
3158
3466
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3159
3467
"true"})
3160
3468
@dbus.service.signal(_interface, signature="os")
3161
3469
def ClientRemoved(self, objpath, name):
3162
3470
"D-Bus signal"
3163
3471
pass
3164
3472
3165
3473
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3166
3474
"true"})
3167
3475
@dbus.service.method(_interface, out_signature="ao")
3168
3476
def GetAllClients(self):
3169
3477
"D-Bus method"
3170
3478
return dbus.Array(c.dbus_object_path for c in
3171
tcp_server.clients.itervalues())
3172
3479
tcp_server.clients.values())
3480
3173
3481
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3174
3482
"true"})
3175
3483
@dbus.service.method(_interface,
3177
3485
def GetAllClientsWithProperties(self):
3178
3486
"D-Bus method"
3179
3487
return dbus.Dictionary(
3180
{ c.dbus_object_path: c.GetAll(
3488
{c.dbus_object_path: c.GetAll(
3181
3489
"se.recompile.Mandos.Client")
3182
for c in tcp_server.clients.itervalues() },
3490
for c in tcp_server.clients.values()},
3183
3491
signature="oa{sv}")
3184
3492
3185
3493
@dbus.service.method(_interface, in_signature="o")
3186
3494
def RemoveClient(self, object_path):
3187
3495
"D-Bus method"
3188
for c in tcp_server.clients.itervalues():
3496
for c in tcp_server.clients.values():
3189
3497
if c.dbus_object_path == object_path:
3190
3498
del tcp_server.clients[c.name]
3191
3499
c.remove_from_connection()
3195
3503
self.client_removed_signal(c)
3196
3504
return
3197
3505
raise KeyError(object_path)
3198
3506
3199
3507
del _interface
3200
3508
3201
3509
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3202
out_signature = "a{oa{sa{sv}}}")
3510
out_signature="a{oa{sa{sv}}}")
3203
3511
def GetManagedObjects(self):
3204
3512
"""D-Bus method"""
3205
3513
return dbus.Dictionary(
3206
{ client.dbus_object_path:
3207
dbus.Dictionary(
3208
{ interface: client.GetAll(interface)
3209
for interface in
3210
client._get_all_interface_names()})
3211
for client in tcp_server.clients.values()})
3212
3514
{client.dbus_object_path:
3515
dbus.Dictionary(
3516
{interface: client.GetAll(interface)
3517
for interface in
3518
client._get_all_interface_names()})
3519
for client in tcp_server.clients.values()})
3520
3213
3521
def client_added_signal(self, client):
3214
3522
"""Send the new standard signal and the old signal"""
3215
3523
if use_dbus:
3217
3525
self.InterfacesAdded(
3218
3526
client.dbus_object_path,
3219
3527
dbus.Dictionary(
3220
{ interface: client.GetAll(interface)
3221
for interface in
3222
client._get_all_interface_names()}))
3528
{interface: client.GetAll(interface)
3529
for interface in
3530
client._get_all_interface_names()}))
3223
3531
# Old signal
3224
3532
self.ClientAdded(client.dbus_object_path)
3225
3533
3226
3534
def client_removed_signal(self, client):
3227
3535
"""Send the new standard signal and the old signal"""
3228
3536
if use_dbus:
3233
3541
# Old signal
3234
3542
self.ClientRemoved(client.dbus_object_path,
3235
3543
client.name)
3236
3544
3237
3545
mandos_dbus_service = MandosDBusService()
3238
3546
3547
# Save modules to variables to exempt the modules from being
3548
# unloaded before the function registered with atexit() is run.
3549
mp = multiprocessing
3550
wn = wnull
3551
3239
3552
def cleanup():
3240
3553
"Cleanup function; run on exit"
3241
3554
if zeroconf:
3242
3555
service.cleanup()
3243
3244
multiprocessing.active_children()
3245
wnull.close()
3556
3557
mp.active_children()
3558
wn.close()
3246
3559
if not (tcp_server.clients or client_settings):
3247
3560
return
3248
3561
3249
3562
# Store client before exiting. Secrets are encrypted with key
3250
3563
# based on what config file has. If config file is
3251
3564
# removed/edited, old secret will thus be unrecovable.
3252
3565
clients = {}
3253
3566
with PGPEngine() as pgp:
3254
for client in tcp_server.clients.itervalues():
3567
for client in tcp_server.clients.values():
3255
3568
key = client_settings[client.name]["secret"]
3256
3569
client.encrypted_secret = pgp.encrypt(client.secret,
3257
3570
key)
3258
3571
client_dict = {}
3259
3572
3260
3573
# A list of attributes that can not be pickled
3261
3574
# + secret.
3262
exclude = { "bus", "changedstate", "secret",
3263
"checker", "server_settings" }
3575
exclude = {"bus", "changedstate", "secret",
3576
"checker", "server_settings"}
3264
3577
for name, typ in inspect.getmembers(dbus.service
3265
3578
.Object):
3266
3579
exclude.add(name)
3267
3580
3268
3581
client_dict["encrypted_secret"] = (client
3269
3582
.encrypted_secret)
3270
3583
for attr in client.client_structure:
3271
3584
if attr not in exclude:
3272
3585
client_dict[attr] = getattr(client, attr)
3273
3586
3274
3587
clients[client.name] = client_dict
3275
3588
del client_settings[client.name]["secret"]
3276
3589
3277
3590
try:
3278
3591
with tempfile.NamedTemporaryFile(
3279
mode='wb',
3592
mode="wb",
3280
3593
suffix=".pickle",
3281
prefix='clients-',
3594
prefix="clients-",
3282
3595
dir=os.path.dirname(stored_state_path),
3283
3596
delete=False) as stored_state:
3284
pickle.dump((clients, client_settings), stored_state)
3597
pickle.dump((clients, client_settings), stored_state,
3598
protocol=2)
3285
3599
tempname = stored_state.name
3286
3600
os.rename(tempname, stored_state_path)
3287
3601
except (IOError, OSError) as e:
3291
3605
except NameError:
3292
3606
pass
3293
3607
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3294
logger.warning("Could not save persistent state: {}"
3295
.format(os.strerror(e.errno)))
3608
log.warning("Could not save persistent state: %s",
3609
os.strerror(e.errno))
3296
3610
else:
3297
logger.warning("Could not save persistent state:",
3298
exc_info=e)
3611
log.warning("Could not save persistent state:",
3612
exc_info=e)
3299
3613
raise
3300
3614
3301
3615
# Delete all clients, and settings from config
3302
3616
while tcp_server.clients:
3303
3617
name, client = tcp_server.clients.popitem()
3309
3623
if use_dbus:
3310
3624
mandos_dbus_service.client_removed_signal(client)
3311
3625
client_settings.clear()
3312
3626
3313
3627
atexit.register(cleanup)
3314
3315
for client in tcp_server.clients.itervalues():
3628
3629
for client in tcp_server.clients.values():
3316
3630
if use_dbus:
3317
3631
# Emit D-Bus signal for adding
3318
3632
mandos_dbus_service.client_added_signal(client)
3319
3633
# Need to initiate checking of clients
3320
3634
if client.enabled:
3321
client.init_checker()
3322
3635
client.init_checker(randomize_start=True)
3636
3323
3637
tcp_server.enable()
3324
3638
tcp_server.server_activate()
3325
3639
3326
3640
# Find out what port we got
3327
3641
if zeroconf:
3328
3642
service.port = tcp_server.socket.getsockname()[1]
3329
3643
if use_ipv6:
3330
logger.info("Now listening on address %r, port %d,"
3331
" flowinfo %d, scope_id %d",
3332
*tcp_server.socket.getsockname())
3644
log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
" scope_id %d", *tcp_server.socket.getsockname())
3333
3646
else: # IPv4
3334
logger.info("Now listening on address %r, port %d",
3335
*tcp_server.socket.getsockname())
3336
3337
#service.interface = tcp_server.socket.getsockname()[3]
3338
3647
log.info("Now listening on address %r, port %d",
3648
*tcp_server.socket.getsockname())
3649
3650
# service.interface = tcp_server.socket.getsockname()[3]
3651
3339
3652
try:
3340
3653
if zeroconf:
3341
3654
# From the Avahi example code
3342
3655
try:
3343
3656
service.activate()
3344
3657
except dbus.exceptions.DBusException as error:
3345
logger.critical("D-Bus Exception", exc_info=error)
3658
log.critical("D-Bus Exception", exc_info=error)
3346
3659
cleanup()
3347
3660
sys.exit(1)
3348
3661
# End of Avahi example code
3349
3350
GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
3351
lambda *args, **kwargs:
3352
(tcp_server.handle_request
3353
(*args[2:], **kwargs) or True))
3354
3355
logger.debug("Starting main loop")
3662
3663
GLib.io_add_watch(
3664
GLib.IOChannel.unix_new(tcp_server.fileno()),
3665
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3666
lambda *args, **kwargs: (tcp_server.handle_request
3667
(*args[2:], **kwargs) or True))
3668
3669
log.debug("Starting main loop")
3356
3670
main_loop.run()
3357
3671
except AvahiError as error:
3358
logger.critical("Avahi Error", exc_info=error)
3672
log.critical("Avahi Error", exc_info=error)
3359
3673
cleanup()
3360
3674
sys.exit(1)
3361
3675
except KeyboardInterrupt:
3362
3676
if debug:
3363
3677
print("", file=sys.stderr)
3364
logger.debug("Server received KeyboardInterrupt")
3365
logger.debug("Server exiting")
3678
log.debug("Server received KeyboardInterrupt")
3679
log.debug("Server exiting")
3366
3680
# Must run before the D-Bus bus name gets deregistered
3367
3681
cleanup()
3368
3682
3369
3370
if __name__ == '__main__':
3371
main()
3683
3684
def parse_test_args():
3685
# type: () -> argparse.Namespace
3686
parser = argparse.ArgumentParser(add_help=False)
3687
parser.add_argument("--check", action="store_true")
3688
parser.add_argument("--prefix", )
3689
args, unknown_args = parser.parse_known_args()
3690
if args.check:
3691
# Remove test options from sys.argv
3692
sys.argv[1:] = unknown_args
3693
return args
3694
3695
# Add all tests from doctest strings
3696
def load_tests(loader, tests, none):
3697
import doctest
3698
tests.addTests(doctest.DocTestSuite())
3699
return tests
3700
3701
if __name__ == "__main__":
3702
options = parse_test_args()
3703
try:
3704
if options.check:
3705
extra_test_prefix = options.prefix
3706
if extra_test_prefix is not None:
3707
if not (unittest.main(argv=[""], exit=False)
3708
.result.wasSuccessful()):
3709
sys.exit(1)
3710
class ExtraTestLoader(unittest.TestLoader):
3711
testMethodPrefix = extra_test_prefix
3712
# Call using ./scriptname --test [--verbose]
3713
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3714
else:
3715
unittest.main(argv=[""])
3716
else:
3717
main()
3718
finally:
3719
logging.shutdown()
3720
3721
# Local Variables:
3722
# run-tests:
3723
# (lambda (&optional extra)
3724
# (if (not (funcall run-tests-in-test-buffer default-directory
3725
# extra))
3726
# (funcall show-test-buffer-in-test-window)
3727
# (funcall remove-test-window)
3728
# (if extra (message "Extra tests run successfully!"))))
3729
# run-tests-in-test-buffer:
3730
# (lambda (dir &optional extra)
3731
# (with-current-buffer (get-buffer-create "*Test*")
3732
# (setq buffer-read-only nil
3733
# default-directory dir)
3734
# (erase-buffer)
3735
# (compilation-mode))
3736
# (let ((process-result
3737
# (let ((inhibit-read-only t))
3738
# (process-file-shell-command
3739
# (funcall get-command-line extra) nil "*Test*"))))
3740
# (and (numberp process-result)
3741
# (= process-result 0))))
3742
# get-command-line:
3743
# (lambda (&optional extra)
3744
# (let ((quoted-script
3745
# (shell-quote-argument (funcall get-script-name))))
3746
# (format
3747
# (concat "%s --check" (if extra " --prefix=atest" ""))
3748
# quoted-script)))
3749
# get-script-name:
3750
# (lambda ()
3751
# (if (fboundp 'file-local-name)
3752
# (file-local-name (buffer-file-name))
3753
# (or (file-remote-p (buffer-file-name) 'localname)
3754
# (buffer-file-name))))
3755
# remove-test-window:
3756
# (lambda ()
3757
# (let ((test-window (get-buffer-window "*Test*")))
3758
# (if test-window (delete-window test-window))))
3759
# show-test-buffer-in-test-window:
3760
# (lambda ()
3761
# (when (not (get-buffer-window-list "*Test*"))
3762
# (setq next-error-last-buffer (get-buffer "*Test*"))
3763
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3764
# (display-buffer-overriding-action
3765
# `((display-buffer-in-side-window) (side . ,side)
3766
# (window-height . fit-window-to-buffer)
3767
# (window-width . fit-window-to-buffer))))
3768
# (display-buffer "*Test*"))))
3769
# eval:
3770
# (progn
3771
# (let* ((run-extra-tests (lambda () (interactive)
3772
# (funcall run-tests t)))
3773
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3774
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3775
# (setq minor-mode-overriding-map-alist
3776
# (cons `(run-tests . ,outer-keymap)
3777
# minor-mode-overriding-map-alist)))
3778
# (add-hook 'after-save-hook run-tests 90 t))
3779
# End:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0