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