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