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