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