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