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