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