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