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