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