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