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 1299
- compare with another revision
- download diff
- download tarball
- view history from revision 1299
- Committer: Teddy Hogeborn
- Date: 2024-09-10 17:27:47 UTC
- Revision ID: teddy@recompile.se-20240910172747-lb81r7e888dwb8ak
Only use linker option --no-warn-execstack if supported
The --no-warn-execstack is new in ld(1) version 2.39; only use the
option if the linker supports it.
* Makefile: Only add "-Xlinker --no-warn-execstack" to LDFLAGS for
various programs if we can successfully run a compiler with that
linker flag.
The --no-warn-execstack is new in ld(1) version 2.39; only use the
option if the linker supports it.
* Makefile: Only add "-Xlinker --no-warn-execstack" to LDFLAGS for
various programs if we can successfully run a compiler with that
linker flag.
- 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.16"
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
def subprocess_call_pipe(connection, # : multiprocessing.Connection
427
*args, **kwargs):
533
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):
428
865
"""This function is meant to be called by multiprocessing.Process
429
430
This function runs a synchronous subprocess.call(), and writes the
431
resulting return code on the provided multiprocessing.Connection.
866
867
This function runs func(*args, **kwargs), and writes the resulting
868
return value on the provided multiprocessing.Connection.
432
869
"""
433
connection.send(subprocess.call(*args, **kwargs))
870
connection.send(func(*args, **kwargs))
434
871
connection.close()
435
872
436
class Client(object):
873
874
class Client:
437
875
"""A representation of a client host served by this server.
438
876
439
877
Attributes:
440
approved: bool(); 'None' if not yet approved/disapproved
878
approved: bool(); None if not yet approved/disapproved
441
879
approval_delay: datetime.timedelta(); Time to wait for approval
442
880
approval_duration: datetime.timedelta(); Duration of one approval
443
checker: subprocess.Popen(); a running checker process used
444
to see if the client lives.
445
'None' if no process is running.
446
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
447
885
checker_command: string; External command which is run to check
448
886
if client lives. %() expansions are done at
449
887
runtime with vars(self) as dict, so that for
450
888
instance %(name)s can be used in the command.
451
checker_initiator_tag: a gobject event source tag, or None
889
checker_initiator_tag: a GLib event source tag, or None
452
890
created: datetime.datetime(); (UTC) object creation
453
891
client_structure: Object describing what attributes a client has
454
892
and is used for storing the client at exit
455
893
current_checker_command: string; current running checker_command
456
disable_initiator_tag: a gobject event source tag, or None
894
disable_initiator_tag: a GLib event source tag, or None
457
895
enabled: bool()
458
896
fingerprint: string (40 or 32 hexadecimal digits); used to
459
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
460
900
host: string; available for use by the checker command
461
901
interval: datetime.timedelta(); How often to start a new checker
462
902
last_approval_request: datetime.datetime(); (UTC) or None
478
918
disabled, or None
479
919
server_settings: The server_settings dict from main()
480
920
"""
481
921
482
922
runtime_expansions = ("approval_delay", "approval_duration",
483
"created", "enabled", "expires",
923
"created", "enabled", "expires", "key_id",
484
924
"fingerprint", "host", "interval",
485
925
"last_approval_request", "last_checked_ok",
486
926
"last_enabled", "name", "timeout")
495
935
"approved_by_default": "True",
496
936
"enabled": "True",
497
937
}
498
938
499
939
@staticmethod
500
940
def config_parser(config):
501
941
"""Construct a new dict of client settings of this form:
508
948
for client_name in config.sections():
509
949
section = dict(config.items(client_name))
510
950
client = settings[client_name] = {}
511
951
512
952
client["host"] = section["host"]
513
953
# Reformat values from string types to Python types
514
954
client["approved_by_default"] = config.getboolean(
515
955
client_name, "approved_by_default")
516
956
client["enabled"] = config.getboolean(client_name,
517
957
"enabled")
518
519
# Uppercase and remove spaces from fingerprint for later
520
# comparison purposes with return value from the
521
# fingerprint() function
522
client["fingerprint"] = (section["fingerprint"].upper()
958
959
# Uppercase and remove spaces from key_id and fingerprint
960
# for later comparison purposes with return value from the
961
# key_id() and fingerprint() functions
962
client["key_id"] = (section.get("key_id", "").upper()
963
.replace(" ", ""))
964
client["fingerprint"] = (section.get("fingerprint",
965
"").upper()
523
966
.replace(" ", ""))
967
if not (client["key_id"] or client["fingerprint"]):
968
log.error("Skipping client %s without key_id or"
969
" fingerprint", client_name)
970
del settings[client_name]
971
continue
524
972
if "secret" in section:
525
client["secret"] = section["secret"].decode("base64")
973
client["secret"] = codecs.decode(section["secret"]
974
.encode("utf-8"),
975
"base64")
526
976
elif "secfile" in section:
527
977
with open(os.path.expanduser(os.path.expandvars
528
978
(section["secfile"])),
543
993
client["last_approval_request"] = None
544
994
client["last_checked_ok"] = None
545
995
client["last_checker_status"] = -2
546
996
547
997
return settings
548
549
def __init__(self, settings, name = None, server_settings=None):
998
999
def __init__(self, settings, name=None, server_settings=None):
550
1000
self.name = name
551
1001
if server_settings is None:
552
1002
server_settings = {}
554
1004
# adding all client settings
555
1005
for setting, value in settings.items():
556
1006
setattr(self, setting, value)
557
1007
558
1008
if self.enabled:
559
1009
if not hasattr(self, "last_enabled"):
560
1010
self.last_enabled = datetime.datetime.utcnow()
564
1014
else:
565
1015
self.last_enabled = None
566
1016
self.expires = None
567
568
logger.debug("Creating client %r", self.name)
569
logger.debug(" Fingerprint: %s", self.fingerprint)
1017
1018
log.debug("Creating client %r", self.name)
1019
log.debug(" Key ID: %s", self.key_id)
1020
log.debug(" Fingerprint: %s", self.fingerprint)
570
1021
self.created = settings.get("created",
571
1022
datetime.datetime.utcnow())
572
1023
573
1024
# attributes specific for this server instance
574
1025
self.checker = None
575
1026
self.checker_initiator_tag = None
581
1032
self.changedstate = multiprocessing_manager.Condition(
582
1033
multiprocessing_manager.Lock())
583
1034
self.client_structure = [attr
584
for attr in self.__dict__.iterkeys()
1035
for attr in self.__dict__.keys()
585
1036
if not attr.startswith("_")]
586
1037
self.client_structure.append("client_structure")
587
1038
588
1039
for name, t in inspect.getmembers(
589
1040
type(self), lambda obj: isinstance(obj, property)):
590
1041
if not name.startswith("_"):
591
1042
self.client_structure.append(name)
592
1043
593
1044
# Send notice to process children that client state has changed
594
1045
def send_changedstate(self):
595
1046
with self.changedstate:
596
1047
self.changedstate.notify_all()
597
1048
598
1049
def enable(self):
599
1050
"""Start this client's checker and timeout hooks"""
600
1051
if getattr(self, "enabled", False):
601
1052
# Already enabled
602
1053
return
603
self.expires = datetime.datetime.utcnow() + self.timeout
604
1054
self.enabled = True
605
1055
self.last_enabled = datetime.datetime.utcnow()
606
1056
self.init_checker()
607
1057
self.send_changedstate()
608
1058
609
1059
def disable(self, quiet=True):
610
1060
"""Disable this client."""
611
1061
if not getattr(self, "enabled", False):
612
1062
return False
613
1063
if not quiet:
614
logger.info("Disabling client %s", self.name)
1064
log.info("Disabling client %s", self.name)
615
1065
if getattr(self, "disable_initiator_tag", None) is not None:
616
gobject.source_remove(self.disable_initiator_tag)
1066
GLib.source_remove(self.disable_initiator_tag)
617
1067
self.disable_initiator_tag = None
618
1068
self.expires = None
619
1069
if getattr(self, "checker_initiator_tag", None) is not None:
620
gobject.source_remove(self.checker_initiator_tag)
1070
GLib.source_remove(self.checker_initiator_tag)
621
1071
self.checker_initiator_tag = None
622
1072
self.stop_checker()
623
1073
self.enabled = False
624
1074
if not quiet:
625
1075
self.send_changedstate()
626
# Do not run this again if called by a gobject.timeout_add
1076
# Do not run this again if called by a GLib.timeout_add
627
1077
return False
628
1078
629
1079
def __del__(self):
630
1080
self.disable()
631
632
def init_checker(self):
633
# Schedule a new checker to be started an 'interval' from now,
634
# and every interval from then on.
1081
1082
def init_checker(self, randomize_start=False):
1083
# Schedule a new checker to be started a randomly selected
1084
# time (a fraction of 'interval') from now. This spreads out
1085
# the startup of checkers over time when the server is
1086
# started.
635
1087
if self.checker_initiator_tag is not None:
636
gobject.source_remove(self.checker_initiator_tag)
637
self.checker_initiator_tag = gobject.timeout_add(
638
int(self.interval.total_seconds() * 1000),
639
self.start_checker)
640
# Schedule a disable() when 'timeout' has passed
1088
GLib.source_remove(self.checker_initiator_tag)
1089
interval_milliseconds = int(self.interval.total_seconds()
1090
* 1000)
1091
if randomize_start:
1092
delay_milliseconds = random.randrange(
1093
interval_milliseconds + 1)
1094
else:
1095
delay_milliseconds = interval_milliseconds
1096
self.checker_initiator_tag = GLib.timeout_add(
1097
delay_milliseconds, self.start_checker, randomize_start)
1098
delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1099
# A checker might take up to an 'interval' of time, so we can
1100
# expire at the soonest one interval after a checker was
1101
# started. Since the initial checker is delayed, the expire
1102
# time might have to be extended.
1103
now = datetime.datetime.utcnow()
1104
self.expires = now + delay + self.interval
1105
# Schedule a disable() at expire time
641
1106
if self.disable_initiator_tag is not None:
642
gobject.source_remove(self.disable_initiator_tag)
643
self.disable_initiator_tag = gobject.timeout_add(
644
int(self.timeout.total_seconds() * 1000), self.disable)
645
# Also start a new checker *right now*.
646
self.start_checker()
647
648
def checker_callback(self, source, condition,
649
(connection, command)):
1107
GLib.source_remove(self.disable_initiator_tag)
1108
self.disable_initiator_tag = GLib.timeout_add(
1109
int((self.expires - now).total_seconds() * 1000),
1110
self.disable)
1111
1112
def checker_callback(self, source, condition, connection,
1113
command):
650
1114
"""The checker has completed, so take appropriate actions."""
651
self.checker_callback_tag = None
652
self.checker = None
653
# Read return code from connection (see subprocess_call_pipe)
1115
# Read return code from connection (see call_pipe)
654
1116
returncode = connection.recv()
655
1117
connection.close()
656
1118
if self.checker is not None:
1119
self.checker.join()
1120
self.checker_callback_tag = None
1121
self.checker = None
1122
657
1123
if returncode >= 0:
658
1124
self.last_checker_status = returncode
659
1125
self.last_checker_signal = None
660
1126
if self.last_checker_status == 0:
661
logger.info("Checker for %(name)s succeeded",
662
vars(self))
1127
log.info("Checker for %(name)s succeeded", vars(self))
663
1128
self.checked_ok()
664
1129
else:
665
logger.info("Checker for %(name)s failed", vars(self))
1130
log.info("Checker for %(name)s failed", vars(self))
666
1131
else:
667
1132
self.last_checker_status = -1
668
1133
self.last_checker_signal = -returncode
669
logger.warning("Checker for %(name)s crashed?",
670
vars(self))
1134
log.warning("Checker for %(name)s crashed?", vars(self))
671
1135
return False
672
1136
673
1137
def checked_ok(self):
674
1138
"""Assert that the client has been seen, alive and well."""
675
1139
self.last_checked_ok = datetime.datetime.utcnow()
676
1140
self.last_checker_status = 0
677
1141
self.last_checker_signal = None
678
1142
self.bump_timeout()
679
1143
680
1144
def bump_timeout(self, timeout=None):
681
1145
"""Bump up the timeout for this client."""
682
1146
if timeout is None:
683
1147
timeout = self.timeout
684
1148
if self.disable_initiator_tag is not None:
685
gobject.source_remove(self.disable_initiator_tag)
1149
GLib.source_remove(self.disable_initiator_tag)
686
1150
self.disable_initiator_tag = None
687
1151
if getattr(self, "enabled", False):
688
self.disable_initiator_tag = gobject.timeout_add(
1152
self.disable_initiator_tag = GLib.timeout_add(
689
1153
int(timeout.total_seconds() * 1000), self.disable)
690
1154
self.expires = datetime.datetime.utcnow() + timeout
691
1155
692
1156
def need_approval(self):
693
1157
self.last_approval_request = datetime.datetime.utcnow()
694
695
def start_checker(self):
1158
1159
def start_checker(self, start_was_randomized=False):
696
1160
"""Start a new checker subprocess if one is not running.
697
1161
698
1162
If a checker already exists, leave it running and do
699
1163
nothing."""
700
1164
# The reason for not killing a running checker is that if we
705
1169
# checkers alone, the checker would have to take more time
706
1170
# than 'timeout' for the client to be disabled, which is as it
707
1171
# should be.
708
1172
709
1173
if self.checker is not None and not self.checker.is_alive():
710
logger.warning("Checker was not alive; joining")
1174
log.warning("Checker was not alive; joining")
711
1175
self.checker.join()
712
1176
self.checker = None
713
1177
# Start a new checker if needed
714
1178
if self.checker is None:
715
1179
# Escape attributes for the shell
716
1180
escaped_attrs = {
717
attr: re.escape(str(getattr(self, attr)))
718
for attr in self.runtime_expansions }
1181
attr: shlex.quote(str(getattr(self, attr)))
1182
for attr in self.runtime_expansions}
719
1183
try:
720
1184
command = self.checker_command % escaped_attrs
721
1185
except TypeError as error:
722
logger.error('Could not format string "%s"',
723
self.checker_command,
724
exc_info=error)
1186
log.error('Could not format string "%s"',
1187
self.checker_command, exc_info=error)
725
1188
return True # Try again later
726
1189
self.current_checker_command = command
727
logger.info("Starting checker %r for %s", command,
728
self.name)
1190
log.info("Starting checker %r for %s", command, self.name)
729
1191
# We don't need to redirect stdout and stderr, since
730
1192
# in normal mode, that is already done by daemon(),
731
1193
# and in debug mode we don't want to. (Stdin is
733
1195
# The exception is when not debugging but nevertheless
734
1196
# running in the foreground; use the previously
735
1197
# created wnull.
736
popen_args = { "close_fds": True,
737
"shell": True,
738
"cwd": "/" }
1198
popen_args = {"close_fds": True,
1199
"shell": True,
1200
"cwd": "/"}
739
1201
if (not self.server_settings["debug"]
740
1202
and self.server_settings["foreground"]):
741
1203
popen_args.update({"stdout": wnull,
742
"stderr": wnull })
1204
"stderr": wnull})
743
1205
pipe = multiprocessing.Pipe(duplex=False)
744
1206
self.checker = multiprocessing.Process(
745
target=subprocess_call_pipe, args=(pipe[1], command),
1207
target=call_pipe,
1208
args=(pipe[1], subprocess.call, command),
746
1209
kwargs=popen_args)
747
1210
self.checker.start()
748
self.checker_callback_tag = gobject.io_add_watch(
749
pipe[0].fileno(), gobject.IO_IN,
750
self.checker_callback, (pipe[0], command))
751
# Re-run this periodically if run by gobject.timeout_add
1211
self.checker_callback_tag = GLib.io_add_watch(
1212
GLib.IOChannel.unix_new(pipe[0].fileno()),
1213
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1214
self.checker_callback, pipe[0], command)
1215
if start_was_randomized:
1216
# We were started after a random delay; Schedule a new
1217
# checker to be started an 'interval' from now, and every
1218
# interval from then on.
1219
now = datetime.datetime.utcnow()
1220
self.checker_initiator_tag = GLib.timeout_add(
1221
int(self.interval.total_seconds() * 1000),
1222
self.start_checker)
1223
self.expires = max(self.expires, now + self.interval)
1224
# Don't start a new checker again after same random delay
1225
return False
1226
# Re-run this periodically if run by GLib.timeout_add
752
1227
return True
753
1228
754
1229
def stop_checker(self):
755
1230
"""Force the checker process, if any, to stop."""
756
1231
if self.checker_callback_tag:
757
gobject.source_remove(self.checker_callback_tag)
1232
GLib.source_remove(self.checker_callback_tag)
758
1233
self.checker_callback_tag = None
759
1234
if getattr(self, "checker", None) is None:
760
1235
return
761
logger.debug("Stopping checker for %(name)s", vars(self))
1236
log.debug("Stopping checker for %(name)s", vars(self))
762
1237
self.checker.terminate()
763
1238
self.checker = None
764
1239
769
1244
byte_arrays=False):
770
1245
"""Decorators for marking methods of a DBusObjectWithProperties to
771
1246
become properties on the D-Bus.
772
1247
773
1248
The decorated method will be called with no arguments by "Get"
774
1249
and with one argument by "Set".
775
1250
776
1251
The parameters, where they are supported, are the same as
777
1252
dbus.service.method, except there is only "signature", since the
778
1253
type from Get() and the type sent to Set() is the same.
782
1257
if byte_arrays and signature != "ay":
783
1258
raise ValueError("Byte arrays not supported for non-'ay'"
784
1259
" signature {!r}".format(signature))
785
1260
786
1261
def decorator(func):
787
1262
func._dbus_is_property = True
788
1263
func._dbus_interface = dbus_interface
791
1266
func._dbus_name = func.__name__
792
1267
if func._dbus_name.endswith("_dbus_property"):
793
1268
func._dbus_name = func._dbus_name[:-14]
794
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1269
func._dbus_get_args_options = {"byte_arrays": byte_arrays}
795
1270
return func
796
1271
797
1272
return decorator
798
1273
799
1274
800
1275
def dbus_interface_annotations(dbus_interface):
801
1276
"""Decorator for marking functions returning interface annotations
802
1277
803
1278
Usage:
804
1279
805
1280
@dbus_interface_annotations("org.example.Interface")
806
1281
def _foo(self): # Function name does not matter
807
1282
return {"org.freedesktop.DBus.Deprecated": "true",
808
1283
"org.freedesktop.DBus.Property.EmitsChangedSignal":
809
1284
"false"}
810
1285
"""
811
1286
812
1287
def decorator(func):
813
1288
func._dbus_is_interface = True
814
1289
func._dbus_interface = dbus_interface
815
1290
func._dbus_name = dbus_interface
816
1291
return func
817
1292
818
1293
return decorator
819
1294
820
1295
821
1296
def dbus_annotations(annotations):
822
1297
"""Decorator to annotate D-Bus methods, signals or properties
823
1298
Usage:
824
1299
825
1300
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
826
1301
"org.freedesktop.DBus.Property."
827
1302
"EmitsChangedSignal": "false"})
829
1304
access="r")
830
1305
def Property_dbus_property(self):
831
1306
return dbus.Boolean(False)
1307
1308
See also the DBusObjectWithAnnotations class.
832
1309
"""
833
1310
834
1311
def decorator(func):
835
1312
func._dbus_annotations = annotations
836
1313
return func
837
1314
838
1315
return decorator
839
1316
840
1317
856
1333
pass
857
1334
858
1335
859
class DBusObjectWithProperties(dbus.service.Object):
860
"""A D-Bus object with properties.
861
862
Classes inheriting from this can use the dbus_service_property
863
decorator to expose methods as D-Bus properties. It exposes the
864
standard Get(), Set(), and GetAll() methods on the D-Bus.
1336
class DBusObjectWithAnnotations(dbus.service.Object):
1337
"""A D-Bus object with annotations.
1338
1339
Classes inheriting from this can use the dbus_annotations
1340
decorator to add annotations to methods or signals.
865
1341
"""
866
1342
867
1343
@staticmethod
868
1344
def _is_dbus_thing(thing):
869
1345
"""Returns a function testing if an attribute is a D-Bus thing
870
1346
871
1347
If called like _is_dbus_thing("method") it returns a function
872
1348
suitable for use as predicate to inspect.getmembers().
873
1349
"""
874
1350
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
875
1351
False)
876
1352
877
1353
def _get_all_dbus_things(self, thing):
878
1354
"""Returns a generator of (name, attribute) pairs
879
1355
"""
882
1358
for cls in self.__class__.__mro__
883
1359
for name, athing in
884
1360
inspect.getmembers(cls, self._is_dbus_thing(thing)))
885
1361
1362
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1363
out_signature="s",
1364
path_keyword="object_path",
1365
connection_keyword="connection")
1366
def Introspect(self, object_path, connection):
1367
"""Overloading of standard D-Bus method.
1368
1369
Inserts annotation tags on methods and signals.
1370
"""
1371
xmlstring = dbus.service.Object.Introspect(self, object_path,
1372
connection)
1373
try:
1374
document = xml.dom.minidom.parseString(xmlstring)
1375
1376
for if_tag in document.getElementsByTagName("interface"):
1377
# Add annotation tags
1378
for typ in ("method", "signal"):
1379
for tag in if_tag.getElementsByTagName(typ):
1380
annots = dict()
1381
for name, prop in (self.
1382
_get_all_dbus_things(typ)):
1383
if (name == tag.getAttribute("name")
1384
and prop._dbus_interface
1385
== if_tag.getAttribute("name")):
1386
annots.update(getattr(
1387
prop, "_dbus_annotations", {}))
1388
for name, value in annots.items():
1389
ann_tag = document.createElement(
1390
"annotation")
1391
ann_tag.setAttribute("name", name)
1392
ann_tag.setAttribute("value", value)
1393
tag.appendChild(ann_tag)
1394
# Add interface annotation tags
1395
for annotation, value in dict(
1396
itertools.chain.from_iterable(
1397
annotations().items()
1398
for name, annotations
1399
in self._get_all_dbus_things("interface")
1400
if name == if_tag.getAttribute("name")
1401
)).items():
1402
ann_tag = document.createElement("annotation")
1403
ann_tag.setAttribute("name", annotation)
1404
ann_tag.setAttribute("value", value)
1405
if_tag.appendChild(ann_tag)
1406
# Fix argument name for the Introspect method itself
1407
if (if_tag.getAttribute("name")
1408
== dbus.INTROSPECTABLE_IFACE):
1409
for cn in if_tag.getElementsByTagName("method"):
1410
if cn.getAttribute("name") == "Introspect":
1411
for arg in cn.getElementsByTagName("arg"):
1412
if (arg.getAttribute("direction")
1413
== "out"):
1414
arg.setAttribute("name",
1415
"xml_data")
1416
xmlstring = document.toxml("utf-8")
1417
document.unlink()
1418
except (AttributeError, xml.dom.DOMException,
1419
xml.parsers.expat.ExpatError) as error:
1420
log.error("Failed to override Introspection method",
1421
exc_info=error)
1422
return xmlstring
1423
1424
1425
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1426
"""A D-Bus object with properties.
1427
1428
Classes inheriting from this can use the dbus_service_property
1429
decorator to expose methods as D-Bus properties. It exposes the
1430
standard Get(), Set(), and GetAll() methods on the D-Bus.
1431
"""
1432
886
1433
def _get_dbus_property(self, interface_name, property_name):
887
1434
"""Returns a bound method if one exists which is a D-Bus
888
1435
property with the specified name and interface.
893
1440
if (value._dbus_name == property_name
894
1441
and value._dbus_interface == interface_name):
895
1442
return value.__get__(self)
896
1443
897
1444
# No such property
898
1445
raise DBusPropertyNotFound("{}:{}.{}".format(
899
1446
self.dbus_object_path, interface_name, property_name))
900
1447
1448
@classmethod
1449
def _get_all_interface_names(cls):
1450
"""Get a sequence of all interfaces supported by an object"""
1451
return (name for name in set(getattr(getattr(x, attr),
1452
"_dbus_interface", None)
1453
for x in (inspect.getmro(cls))
1454
for attr in dir(x))
1455
if name is not None)
1456
901
1457
@dbus.service.method(dbus.PROPERTIES_IFACE,
902
1458
in_signature="ss",
903
1459
out_signature="v")
911
1467
if not hasattr(value, "variant_level"):
912
1468
return value
913
1469
return type(value)(value, variant_level=value.variant_level+1)
914
1470
915
1471
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
916
1472
def Set(self, interface_name, property_name, value):
917
1473
"""Standard D-Bus property Set() method, see D-Bus standard.
926
1482
raise ValueError("Byte arrays not supported for non-"
927
1483
"'ay' signature {!r}"
928
1484
.format(prop._dbus_signature))
929
value = dbus.ByteArray(b''.join(chr(byte)
930
for byte in value))
1485
value = dbus.ByteArray(bytes(value))
931
1486
prop(value)
932
1487
933
1488
@dbus.service.method(dbus.PROPERTIES_IFACE,
934
1489
in_signature="s",
935
1490
out_signature="a{sv}")
936
1491
def GetAll(self, interface_name):
937
1492
"""Standard D-Bus property GetAll() method, see D-Bus
938
1493
standard.
939
1494
940
1495
Note: Will not include properties with access="write".
941
1496
"""
942
1497
properties = {}
953
1508
properties[name] = value
954
1509
continue
955
1510
properties[name] = type(value)(
956
value, variant_level = value.variant_level + 1)
1511
value, variant_level=value.variant_level + 1)
957
1512
return dbus.Dictionary(properties, signature="sv")
958
1513
959
1514
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
960
1515
def PropertiesChanged(self, interface_name, changed_properties,
961
1516
invalidated_properties):
963
1518
standard.
964
1519
"""
965
1520
pass
966
1521
967
1522
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
968
1523
out_signature="s",
969
path_keyword='object_path',
970
connection_keyword='connection')
1524
path_keyword="object_path",
1525
connection_keyword="connection")
971
1526
def Introspect(self, object_path, connection):
972
1527
"""Overloading of standard D-Bus method.
973
1528
974
1529
Inserts property tags and interface annotation tags.
975
1530
"""
976
xmlstring = dbus.service.Object.Introspect(self, object_path,
977
connection)
1531
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1532
object_path,
1533
connection)
978
1534
try:
979
1535
document = xml.dom.minidom.parseString(xmlstring)
980
1536
981
1537
def make_tag(document, name, prop):
982
1538
e = document.createElement("property")
983
1539
e.setAttribute("name", name)
984
1540
e.setAttribute("type", prop._dbus_signature)
985
1541
e.setAttribute("access", prop._dbus_access)
986
1542
return e
987
1543
988
1544
for if_tag in document.getElementsByTagName("interface"):
989
1545
# Add property tags
990
1546
for tag in (make_tag(document, name, prop)
993
1549
if prop._dbus_interface
994
1550
== if_tag.getAttribute("name")):
995
1551
if_tag.appendChild(tag)
996
# Add annotation tags
997
for typ in ("method", "signal", "property"):
998
for tag in if_tag.getElementsByTagName(typ):
999
annots = dict()
1000
for name, prop in (self.
1001
_get_all_dbus_things(typ)):
1002
if (name == tag.getAttribute("name")
1003
and prop._dbus_interface
1004
== if_tag.getAttribute("name")):
1005
annots.update(getattr(
1006
prop, "_dbus_annotations", {}))
1007
for name, value in annots.items():
1008
ann_tag = document.createElement(
1009
"annotation")
1010
ann_tag.setAttribute("name", name)
1011
ann_tag.setAttribute("value", value)
1012
tag.appendChild(ann_tag)
1013
# Add interface annotation tags
1014
for annotation, value in dict(
1015
itertools.chain.from_iterable(
1016
annotations().items()
1017
for name, annotations
1018
in self._get_all_dbus_things("interface")
1019
if name == if_tag.getAttribute("name")
1020
)).items():
1021
ann_tag = document.createElement("annotation")
1022
ann_tag.setAttribute("name", annotation)
1023
ann_tag.setAttribute("value", value)
1024
if_tag.appendChild(ann_tag)
1552
# Add annotation tags for properties
1553
for tag in if_tag.getElementsByTagName("property"):
1554
annots = dict()
1555
for name, prop in self._get_all_dbus_things(
1556
"property"):
1557
if (name == tag.getAttribute("name")
1558
and prop._dbus_interface
1559
== if_tag.getAttribute("name")):
1560
annots.update(getattr(
1561
prop, "_dbus_annotations", {}))
1562
for name, value in annots.items():
1563
ann_tag = document.createElement(
1564
"annotation")
1565
ann_tag.setAttribute("name", name)
1566
ann_tag.setAttribute("value", value)
1567
tag.appendChild(ann_tag)
1025
1568
# Add the names to the return values for the
1026
1569
# "org.freedesktop.DBus.Properties" methods
1027
1570
if (if_tag.getAttribute("name")
1041
1584
document.unlink()
1042
1585
except (AttributeError, xml.dom.DOMException,
1043
1586
xml.parsers.expat.ExpatError) as error:
1044
logger.error("Failed to override Introspection method",
1045
exc_info=error)
1587
log.error("Failed to override Introspection method",
1588
exc_info=error)
1589
return xmlstring
1590
1591
1592
try:
1593
dbus.OBJECT_MANAGER_IFACE
1594
except AttributeError:
1595
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1596
1597
1598
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1599
"""A D-Bus object with an ObjectManager.
1600
1601
Classes inheriting from this exposes the standard
1602
GetManagedObjects call and the InterfacesAdded and
1603
InterfacesRemoved signals on the standard
1604
"org.freedesktop.DBus.ObjectManager" interface.
1605
1606
Note: No signals are sent automatically; they must be sent
1607
manually.
1608
"""
1609
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1610
out_signature="a{oa{sa{sv}}}")
1611
def GetManagedObjects(self):
1612
"""This function must be overridden"""
1613
raise NotImplementedError()
1614
1615
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1616
signature="oa{sa{sv}}")
1617
def InterfacesAdded(self, object_path, interfaces_and_properties):
1618
pass
1619
1620
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1621
def InterfacesRemoved(self, object_path, interfaces):
1622
pass
1623
1624
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1625
out_signature="s",
1626
path_keyword="object_path",
1627
connection_keyword="connection")
1628
def Introspect(self, object_path, connection):
1629
"""Overloading of standard D-Bus method.
1630
1631
Override return argument name of GetManagedObjects to be
1632
"objpath_interfaces_and_properties"
1633
"""
1634
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1635
object_path,
1636
connection)
1637
try:
1638
document = xml.dom.minidom.parseString(xmlstring)
1639
1640
for if_tag in document.getElementsByTagName("interface"):
1641
# Fix argument name for the GetManagedObjects method
1642
if (if_tag.getAttribute("name")
1643
== dbus.OBJECT_MANAGER_IFACE):
1644
for cn in if_tag.getElementsByTagName("method"):
1645
if (cn.getAttribute("name")
1646
== "GetManagedObjects"):
1647
for arg in cn.getElementsByTagName("arg"):
1648
if (arg.getAttribute("direction")
1649
== "out"):
1650
arg.setAttribute(
1651
"name",
1652
"objpath_interfaces"
1653
"_and_properties")
1654
xmlstring = document.toxml("utf-8")
1655
document.unlink()
1656
except (AttributeError, xml.dom.DOMException,
1657
xml.parsers.expat.ExpatError) as error:
1658
log.error("Failed to override Introspection method",
1659
exc_info=error)
1046
1660
return xmlstring
1047
1661
1048
1662
1049
1663
def datetime_to_dbus(dt, variant_level=0):
1050
1664
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1051
1665
if dt is None:
1052
return dbus.String("", variant_level = variant_level)
1666
return dbus.String("", variant_level=variant_level)
1053
1667
return dbus.String(dt.isoformat(), variant_level=variant_level)
1054
1668
1055
1669
1058
1672
dbus.service.Object, it will add alternate D-Bus attributes with
1059
1673
interface names according to the "alt_interface_names" mapping.
1060
1674
Usage:
1061
1675
1062
1676
@alternate_dbus_interfaces({"org.example.Interface":
1063
1677
"net.example.AlternateInterface"})
1064
1678
class SampleDBusObject(dbus.service.Object):
1065
1679
@dbus.service.method("org.example.Interface")
1066
1680
def SampleDBusMethod():
1067
1681
pass
1068
1682
1069
1683
The above "SampleDBusMethod" on "SampleDBusObject" will be
1070
1684
reachable via two interfaces: "org.example.Interface" and
1071
1685
"net.example.AlternateInterface", the latter of which will have
1072
1686
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1073
1687
"true", unless "deprecate" is passed with a False value.
1074
1688
1075
1689
This works for methods and signals, and also for D-Bus properties
1076
1690
(from DBusObjectWithProperties) and interfaces (from the
1077
1691
dbus_interface_annotations decorator).
1078
1692
"""
1079
1693
1080
1694
def wrapper(cls):
1081
1695
for orig_interface_name, alt_interface_name in (
1082
1696
alt_interface_names.items()):
1099
1713
if getattr(attribute, "_dbus_is_signal", False):
1100
1714
# Extract the original non-method undecorated
1101
1715
# function by black magic
1102
nonmethod_func = (dict(
1103
zip(attribute.func_code.co_freevars,
1104
attribute.__closure__))
1105
["func"].cell_contents)
1716
if sys.version_info.major == 2:
1717
nonmethod_func = (dict(
1718
zip(attribute.func_code.co_freevars,
1719
attribute.__closure__))
1720
["func"].cell_contents)
1721
else:
1722
nonmethod_func = (dict(
1723
zip(attribute.__code__.co_freevars,
1724
attribute.__closure__))
1725
["func"].cell_contents)
1106
1726
# Create a new, but exactly alike, function
1107
1727
# object, and decorate it to be a new D-Bus signal
1108
1728
# with the alternate D-Bus interface name
1729
new_function = copy_function(nonmethod_func)
1109
1730
new_function = (dbus.service.signal(
1110
alt_interface, attribute._dbus_signature)
1111
(types.FunctionType(
1112
nonmethod_func.func_code,
1113
nonmethod_func.func_globals,
1114
nonmethod_func.func_name,
1115
nonmethod_func.func_defaults,
1116
nonmethod_func.func_closure)))
1731
alt_interface,
1732
attribute._dbus_signature)(new_function))
1117
1733
# Copy annotations, if any
1118
1734
try:
1119
1735
new_function._dbus_annotations = dict(
1120
1736
attribute._dbus_annotations)
1121
1737
except AttributeError:
1122
1738
pass
1739
1123
1740
# Define a creator of a function to call both the
1124
1741
# original and alternate functions, so both the
1125
1742
# original and alternate signals gets sent when
1128
1745
"""This function is a scope container to pass
1129
1746
func1 and func2 to the "call_both" function
1130
1747
outside of its arguments"""
1131
1748
1749
@functools.wraps(func2)
1132
1750
def call_both(*args, **kwargs):
1133
1751
"""This function will emit two D-Bus
1134
1752
signals by calling func1 and func2"""
1135
1753
func1(*args, **kwargs)
1136
1754
func2(*args, **kwargs)
1137
1755
# Make wrapper function look like a D-Bus
1756
# signal
1757
for name, attr in inspect.getmembers(func2):
1758
if name.startswith("_dbus_"):
1759
setattr(call_both, name, attr)
1760
1138
1761
return call_both
1139
1762
# Create the "call_both" function and add it to
1140
1763
# the class
1150
1773
alt_interface,
1151
1774
attribute._dbus_in_signature,
1152
1775
attribute._dbus_out_signature)
1153
(types.FunctionType(attribute.func_code,
1154
attribute.func_globals,
1155
attribute.func_name,
1156
attribute.func_defaults,
1157
attribute.func_closure)))
1776
(copy_function(attribute)))
1158
1777
# Copy annotations, if any
1159
1778
try:
1160
1779
attr[attrname]._dbus_annotations = dict(
1172
1791
attribute._dbus_access,
1173
1792
attribute._dbus_get_args_options
1174
1793
["byte_arrays"])
1175
(types.FunctionType(
1176
attribute.func_code,
1177
attribute.func_globals,
1178
attribute.func_name,
1179
attribute.func_defaults,
1180
attribute.func_closure)))
1794
(copy_function(attribute)))
1181
1795
# Copy annotations, if any
1182
1796
try:
1183
1797
attr[attrname]._dbus_annotations = dict(
1192
1806
# to the class.
1193
1807
attr[attrname] = (
1194
1808
dbus_interface_annotations(alt_interface)
1195
(types.FunctionType(attribute.func_code,
1196
attribute.func_globals,
1197
attribute.func_name,
1198
attribute.func_defaults,
1199
attribute.func_closure)))
1809
(copy_function(attribute)))
1200
1810
if deprecate:
1201
1811
# Deprecate all alternate interfaces
1202
iname="_AlternateDBusNames_interface_annotation{}"
1812
iname = "_AlternateDBusNames_interface_annotation{}"
1203
1813
for interface_name in interface_names:
1204
1814
1205
1815
@dbus_interface_annotations(interface_name)
1206
1816
def func(self):
1207
return { "org.freedesktop.DBus.Deprecated":
1208
"true" }
1817
return {"org.freedesktop.DBus.Deprecated":
1818
"true"}
1209
1819
# Find an unused name
1210
1820
for aname in (iname.format(i)
1211
1821
for i in itertools.count()):
1215
1825
if interface_names:
1216
1826
# Replace the class with a new subclass of it with
1217
1827
# methods, signals, etc. as created above.
1218
cls = type(b"{}Alternate".format(cls.__name__),
1219
(cls, ), attr)
1828
if sys.version_info.major == 2:
1829
cls = type(b"{}Alternate".format(cls.__name__),
1830
(cls, ), attr)
1831
else:
1832
cls = type("{}Alternate".format(cls.__name__),
1833
(cls, ), attr)
1220
1834
return cls
1221
1835
1222
1836
return wrapper
1223
1837
1224
1838
1226
1840
"se.bsnet.fukt.Mandos"})
1227
1841
class ClientDBus(Client, DBusObjectWithProperties):
1228
1842
"""A Client class using D-Bus
1229
1843
1230
1844
Attributes:
1231
1845
dbus_object_path: dbus.ObjectPath
1232
1846
bus: dbus.SystemBus()
1233
1847
"""
1234
1848
1235
1849
runtime_expansions = (Client.runtime_expansions
1236
1850
+ ("dbus_object_path", ))
1237
1851
1238
1852
_interface = "se.recompile.Mandos.Client"
1239
1853
1240
1854
# dbus.service.Object doesn't use super(), so we can't either.
1241
1242
def __init__(self, bus = None, *args, **kwargs):
1855
1856
def __init__(self, bus=None, *args, **kwargs):
1243
1857
self.bus = bus
1244
1858
Client.__init__(self, *args, **kwargs)
1245
1859
# Only now, when this client is initialized, can it show up on
1251
1865
"/clients/" + client_object_name)
1252
1866
DBusObjectWithProperties.__init__(self, self.bus,
1253
1867
self.dbus_object_path)
1254
1868
1255
1869
def notifychangeproperty(transform_func, dbus_name,
1256
1870
type_func=lambda x: x,
1257
1871
variant_level=1,
1259
1873
_interface=_interface):
1260
1874
""" Modify a variable so that it's a property which announces
1261
1875
its changes to DBus.
1262
1876
1263
1877
transform_fun: Function that takes a value and a variant_level
1264
1878
and transforms it to a D-Bus type.
1265
1879
dbus_name: D-Bus name of the variable
1268
1882
variant_level: D-Bus variant level. Default: 1
1269
1883
"""
1270
1884
attrname = "_{}".format(dbus_name)
1271
1885
1272
1886
def setter(self, value):
1273
1887
if hasattr(self, "dbus_object_path"):
1274
1888
if (not hasattr(self, attrname) or
1281
1895
else:
1282
1896
dbus_value = transform_func(
1283
1897
type_func(value),
1284
variant_level = variant_level)
1898
variant_level=variant_level)
1285
1899
self.PropertyChanged(dbus.String(dbus_name),
1286
1900
dbus_value)
1287
1901
self.PropertiesChanged(
1288
1902
_interface,
1289
dbus.Dictionary({ dbus.String(dbus_name):
1290
dbus_value }),
1903
dbus.Dictionary({dbus.String(dbus_name):
1904
dbus_value}),
1291
1905
dbus.Array())
1292
1906
setattr(self, attrname, value)
1293
1907
1294
1908
return property(lambda self: getattr(self, attrname), setter)
1295
1909
1296
1910
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1297
1911
approvals_pending = notifychangeproperty(dbus.Boolean,
1298
1912
"ApprovalPending",
1299
type_func = bool)
1913
type_func=bool)
1300
1914
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1301
1915
last_enabled = notifychangeproperty(datetime_to_dbus,
1302
1916
"LastEnabled")
1303
1917
checker = notifychangeproperty(
1304
1918
dbus.Boolean, "CheckerRunning",
1305
type_func = lambda checker: checker is not None)
1919
type_func=lambda checker: checker is not None)
1306
1920
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1307
1921
"LastCheckedOK")
1308
1922
last_checker_status = notifychangeproperty(dbus.Int16,
1313
1927
"ApprovedByDefault")
1314
1928
approval_delay = notifychangeproperty(
1315
1929
dbus.UInt64, "ApprovalDelay",
1316
type_func = lambda td: td.total_seconds() * 1000)
1930
type_func=lambda td: td.total_seconds() * 1000)
1317
1931
approval_duration = notifychangeproperty(
1318
1932
dbus.UInt64, "ApprovalDuration",
1319
type_func = lambda td: td.total_seconds() * 1000)
1933
type_func=lambda td: td.total_seconds() * 1000)
1320
1934
host = notifychangeproperty(dbus.String, "Host")
1321
1935
timeout = notifychangeproperty(
1322
1936
dbus.UInt64, "Timeout",
1323
type_func = lambda td: td.total_seconds() * 1000)
1937
type_func=lambda td: td.total_seconds() * 1000)
1324
1938
extended_timeout = notifychangeproperty(
1325
1939
dbus.UInt64, "ExtendedTimeout",
1326
type_func = lambda td: td.total_seconds() * 1000)
1940
type_func=lambda td: td.total_seconds() * 1000)
1327
1941
interval = notifychangeproperty(
1328
1942
dbus.UInt64, "Interval",
1329
type_func = lambda td: td.total_seconds() * 1000)
1943
type_func=lambda td: td.total_seconds() * 1000)
1330
1944
checker_command = notifychangeproperty(dbus.String, "Checker")
1331
1945
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1332
1946
invalidate_only=True)
1333
1947
1334
1948
del notifychangeproperty
1335
1949
1336
1950
def __del__(self, *args, **kwargs):
1337
1951
try:
1338
1952
self.remove_from_connection()
1341
1955
if hasattr(DBusObjectWithProperties, "__del__"):
1342
1956
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1343
1957
Client.__del__(self, *args, **kwargs)
1344
1958
1345
1959
def checker_callback(self, source, condition,
1346
(connection, command), *args, **kwargs):
1960
connection, command, *args, **kwargs):
1347
1961
ret = Client.checker_callback(self, source, condition,
1348
(connection, command), *args,
1962
connection, command, *args,
1349
1963
**kwargs)
1350
1964
exitstatus = self.last_checker_status
1351
1965
if exitstatus >= 0:
1352
1966
# Emit D-Bus signal
1353
1967
self.CheckerCompleted(dbus.Int16(exitstatus),
1354
dbus.Int64(0),
1968
# This is specific to GNU libC
1969
dbus.Int64(exitstatus << 8),
1355
1970
dbus.String(command))
1356
1971
else:
1357
1972
# Emit D-Bus signal
1358
1973
self.CheckerCompleted(dbus.Int16(-1),
1359
1974
dbus.Int64(
1360
self.last_checker_signal),
1975
# This is specific to GNU libC
1976
(exitstatus << 8)
1977
| self.last_checker_signal),
1361
1978
dbus.String(command))
1362
1979
return ret
1363
1980
1364
1981
def start_checker(self, *args, **kwargs):
1365
1982
old_checker_pid = getattr(self.checker, "pid", None)
1366
1983
r = Client.start_checker(self, *args, **kwargs)
1370
1987
# Emit D-Bus signal
1371
1988
self.CheckerStarted(self.current_checker_command)
1372
1989
return r
1373
1990
1374
1991
def _reset_approved(self):
1375
1992
self.approved = None
1376
1993
return False
1377
1994
1378
1995
def approve(self, value=True):
1379
1996
self.approved = value
1380
gobject.timeout_add(int(self.approval_duration.total_seconds()
1381
* 1000), self._reset_approved)
1997
GLib.timeout_add(int(self.approval_duration.total_seconds()
1998
* 1000), self._reset_approved)
1382
1999
self.send_changedstate()
1383
1384
## D-Bus methods, signals & properties
1385
1386
## Interfaces
1387
1388
## Signals
1389
2000
2001
# D-Bus methods, signals & properties
2002
2003
# Interfaces
2004
2005
# Signals
2006
1390
2007
# CheckerCompleted - signal
1391
2008
@dbus.service.signal(_interface, signature="nxs")
1392
2009
def CheckerCompleted(self, exitcode, waitstatus, command):
1393
2010
"D-Bus signal"
1394
2011
pass
1395
2012
1396
2013
# CheckerStarted - signal
1397
2014
@dbus.service.signal(_interface, signature="s")
1398
2015
def CheckerStarted(self, command):
1399
2016
"D-Bus signal"
1400
2017
pass
1401
2018
1402
2019
# PropertyChanged - signal
1403
2020
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1404
2021
@dbus.service.signal(_interface, signature="sv")
1405
2022
def PropertyChanged(self, property, value):
1406
2023
"D-Bus signal"
1407
2024
pass
1408
2025
1409
2026
# GotSecret - signal
1410
2027
@dbus.service.signal(_interface)
1411
2028
def GotSecret(self):
1414
2031
server to mandos-client
1415
2032
"""
1416
2033
pass
1417
2034
1418
2035
# Rejected - signal
1419
2036
@dbus.service.signal(_interface, signature="s")
1420
2037
def Rejected(self, reason):
1421
2038
"D-Bus signal"
1422
2039
pass
1423
2040
1424
2041
# NeedApproval - signal
1425
2042
@dbus.service.signal(_interface, signature="tb")
1426
2043
def NeedApproval(self, timeout, default):
1427
2044
"D-Bus signal"
1428
2045
return self.need_approval()
1429
1430
## Methods
1431
2046
2047
# Methods
2048
1432
2049
# Approve - method
1433
2050
@dbus.service.method(_interface, in_signature="b")
1434
2051
def Approve(self, value):
1435
2052
self.approve(value)
1436
2053
1437
2054
# CheckedOK - method
1438
2055
@dbus.service.method(_interface)
1439
2056
def CheckedOK(self):
1440
2057
self.checked_ok()
1441
2058
1442
2059
# Enable - method
2060
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1443
2061
@dbus.service.method(_interface)
1444
2062
def Enable(self):
1445
2063
"D-Bus method"
1446
2064
self.enable()
1447
2065
1448
2066
# StartChecker - method
2067
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1449
2068
@dbus.service.method(_interface)
1450
2069
def StartChecker(self):
1451
2070
"D-Bus method"
1452
2071
self.start_checker()
1453
2072
1454
2073
# Disable - method
2074
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1455
2075
@dbus.service.method(_interface)
1456
2076
def Disable(self):
1457
2077
"D-Bus method"
1458
2078
self.disable()
1459
2079
1460
2080
# StopChecker - method
2081
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1461
2082
@dbus.service.method(_interface)
1462
2083
def StopChecker(self):
1463
2084
self.stop_checker()
1464
1465
## Properties
1466
2085
2086
# Properties
2087
1467
2088
# ApprovalPending - property
1468
2089
@dbus_service_property(_interface, signature="b", access="read")
1469
2090
def ApprovalPending_dbus_property(self):
1470
2091
return dbus.Boolean(bool(self.approvals_pending))
1471
2092
1472
2093
# ApprovedByDefault - property
1473
2094
@dbus_service_property(_interface,
1474
2095
signature="b",
1477
2098
if value is None: # get
1478
2099
return dbus.Boolean(self.approved_by_default)
1479
2100
self.approved_by_default = bool(value)
1480
2101
1481
2102
# ApprovalDelay - property
1482
2103
@dbus_service_property(_interface,
1483
2104
signature="t",
1487
2108
return dbus.UInt64(self.approval_delay.total_seconds()
1488
2109
* 1000)
1489
2110
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1490
2111
1491
2112
# ApprovalDuration - property
1492
2113
@dbus_service_property(_interface,
1493
2114
signature="t",
1497
2118
return dbus.UInt64(self.approval_duration.total_seconds()
1498
2119
* 1000)
1499
2120
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1500
2121
1501
2122
# Name - property
2123
@dbus_annotations(
2124
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1502
2125
@dbus_service_property(_interface, signature="s", access="read")
1503
2126
def Name_dbus_property(self):
1504
2127
return dbus.String(self.name)
1505
2128
2129
# KeyID - property
2130
@dbus_annotations(
2131
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2132
@dbus_service_property(_interface, signature="s", access="read")
2133
def KeyID_dbus_property(self):
2134
return dbus.String(self.key_id)
2135
1506
2136
# Fingerprint - property
2137
@dbus_annotations(
2138
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1507
2139
@dbus_service_property(_interface, signature="s", access="read")
1508
2140
def Fingerprint_dbus_property(self):
1509
2141
return dbus.String(self.fingerprint)
1510
2142
1511
2143
# Host - property
1512
2144
@dbus_service_property(_interface,
1513
2145
signature="s",
1516
2148
if value is None: # get
1517
2149
return dbus.String(self.host)
1518
2150
self.host = str(value)
1519
2151
1520
2152
# Created - property
2153
@dbus_annotations(
2154
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1521
2155
@dbus_service_property(_interface, signature="s", access="read")
1522
2156
def Created_dbus_property(self):
1523
2157
return datetime_to_dbus(self.created)
1524
2158
1525
2159
# LastEnabled - property
1526
2160
@dbus_service_property(_interface, signature="s", access="read")
1527
2161
def LastEnabled_dbus_property(self):
1528
2162
return datetime_to_dbus(self.last_enabled)
1529
2163
1530
2164
# Enabled - property
1531
2165
@dbus_service_property(_interface,
1532
2166
signature="b",
1538
2172
self.enable()
1539
2173
else:
1540
2174
self.disable()
1541
2175
1542
2176
# LastCheckedOK - property
1543
2177
@dbus_service_property(_interface,
1544
2178
signature="s",
1548
2182
self.checked_ok()
1549
2183
return
1550
2184
return datetime_to_dbus(self.last_checked_ok)
1551
2185
1552
2186
# LastCheckerStatus - property
1553
2187
@dbus_service_property(_interface, signature="n", access="read")
1554
2188
def LastCheckerStatus_dbus_property(self):
1555
2189
return dbus.Int16(self.last_checker_status)
1556
2190
1557
2191
# Expires - property
1558
2192
@dbus_service_property(_interface, signature="s", access="read")
1559
2193
def Expires_dbus_property(self):
1560
2194
return datetime_to_dbus(self.expires)
1561
2195
1562
2196
# LastApprovalRequest - property
1563
2197
@dbus_service_property(_interface, signature="s", access="read")
1564
2198
def LastApprovalRequest_dbus_property(self):
1565
2199
return datetime_to_dbus(self.last_approval_request)
1566
2200
1567
2201
# Timeout - property
1568
2202
@dbus_service_property(_interface,
1569
2203
signature="t",
1584
2218
if (getattr(self, "disable_initiator_tag", None)
1585
2219
is None):
1586
2220
return
1587
gobject.source_remove(self.disable_initiator_tag)
1588
self.disable_initiator_tag = gobject.timeout_add(
2221
GLib.source_remove(self.disable_initiator_tag)
2222
self.disable_initiator_tag = GLib.timeout_add(
1589
2223
int((self.expires - now).total_seconds() * 1000),
1590
2224
self.disable)
1591
2225
1592
2226
# ExtendedTimeout - property
1593
2227
@dbus_service_property(_interface,
1594
2228
signature="t",
1598
2232
return dbus.UInt64(self.extended_timeout.total_seconds()
1599
2233
* 1000)
1600
2234
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1601
2235
1602
2236
# Interval - property
1603
2237
@dbus_service_property(_interface,
1604
2238
signature="t",
1611
2245
return
1612
2246
if self.enabled:
1613
2247
# Reschedule checker run
1614
gobject.source_remove(self.checker_initiator_tag)
1615
self.checker_initiator_tag = gobject.timeout_add(
2248
GLib.source_remove(self.checker_initiator_tag)
2249
self.checker_initiator_tag = GLib.timeout_add(
1616
2250
value, self.start_checker)
1617
self.start_checker() # Start one now, too
1618
2251
self.start_checker() # Start one now, too
2252
1619
2253
# Checker - property
1620
2254
@dbus_service_property(_interface,
1621
2255
signature="s",
1624
2258
if value is None: # get
1625
2259
return dbus.String(self.checker_command)
1626
2260
self.checker_command = str(value)
1627
2261
1628
2262
# CheckerRunning - property
1629
2263
@dbus_service_property(_interface,
1630
2264
signature="b",
1636
2270
self.start_checker()
1637
2271
else:
1638
2272
self.stop_checker()
1639
2273
1640
2274
# ObjectPath - property
2275
@dbus_annotations(
2276
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2277
"org.freedesktop.DBus.Deprecated": "true"})
1641
2278
@dbus_service_property(_interface, signature="o", access="read")
1642
2279
def ObjectPath_dbus_property(self):
1643
return self.dbus_object_path # is already a dbus.ObjectPath
1644
2280
return self.dbus_object_path # is already a dbus.ObjectPath
2281
1645
2282
# Secret = property
2283
@dbus_annotations(
2284
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2285
"invalidates"})
1646
2286
@dbus_service_property(_interface,
1647
2287
signature="ay",
1648
2288
access="write",
1649
2289
byte_arrays=True)
1650
2290
def Secret_dbus_property(self, value):
1651
2291
self.secret = bytes(value)
1652
2292
1653
2293
del _interface
1654
2294
1655
2295
1656
class ProxyClient(object):
1657
def __init__(self, child_pipe, fpr, address):
2296
class ProxyClient:
2297
def __init__(self, child_pipe, key_id, fpr, address):
1658
2298
self._pipe = child_pipe
1659
self._pipe.send(('init', fpr, address))
2299
self._pipe.send(("init", key_id, fpr, address))
1660
2300
if not self._pipe.recv():
1661
raise KeyError()
1662
2301
raise KeyError(key_id or fpr)
2302
1663
2303
def __getattribute__(self, name):
1664
if name == '_pipe':
2304
if name == "_pipe":
1665
2305
return super(ProxyClient, self).__getattribute__(name)
1666
self._pipe.send(('getattr', name))
2306
self._pipe.send(("getattr", name))
1667
2307
data = self._pipe.recv()
1668
if data[0] == 'data':
2308
if data[0] == "data":
1669
2309
return data[1]
1670
if data[0] == 'function':
1671
2310
if data[0] == "function":
2311
1672
2312
def func(*args, **kwargs):
1673
self._pipe.send(('funcall', name, args, kwargs))
2313
self._pipe.send(("funcall", name, args, kwargs))
1674
2314
return self._pipe.recv()[1]
1675
2315
1676
2316
return func
1677
2317
1678
2318
def __setattr__(self, name, value):
1679
if name == '_pipe':
2319
if name == "_pipe":
1680
2320
return super(ProxyClient, self).__setattr__(name, value)
1681
self._pipe.send(('setattr', name, value))
2321
self._pipe.send(("setattr", name, value))
1682
2322
1683
2323
1684
2324
class ClientHandler(socketserver.BaseRequestHandler, object):
1685
2325
"""A class to handle client connections.
1686
2326
1687
2327
Instantiated once for each connection to handle it.
1688
2328
Note: This will run in its own forked process."""
1689
2329
1690
2330
def handle(self):
1691
2331
with contextlib.closing(self.server.child_pipe) as child_pipe:
1692
logger.info("TCP connection from: %s",
1693
str(self.client_address))
1694
logger.debug("Pipe FD: %d",
1695
self.server.child_pipe.fileno())
1696
1697
session = gnutls.connection.ClientSession(
1698
self.request, gnutls.connection .X509Credentials())
1699
1700
# Note: gnutls.connection.X509Credentials is really a
1701
# generic GnuTLS certificate credentials object so long as
1702
# no X.509 keys are added to it. Therefore, we can use it
1703
# here despite using OpenPGP certificates.
1704
1705
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1706
# "+AES-256-CBC", "+SHA1",
1707
# "+COMP-NULL", "+CTYPE-OPENPGP",
1708
# "+DHE-DSS"))
2332
log.info("TCP connection from: %s",
2333
str(self.client_address))
2334
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2335
2336
session = gnutls.ClientSession(self.request)
2337
2338
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2339
# "+AES-256-CBC", "+SHA1",
2340
# "+COMP-NULL", "+CTYPE-OPENPGP",
2341
# "+DHE-DSS"))
1709
2342
# Use a fallback default, since this MUST be set.
1710
2343
priority = self.server.gnutls_priority
1711
2344
if priority is None:
1712
2345
priority = "NORMAL"
1713
gnutls.library.functions.gnutls_priority_set_direct(
1714
session._c_object, priority, None)
1715
2346
gnutls.priority_set_direct(session,
2347
priority.encode("utf-8"), None)
2348
1716
2349
# Start communication using the Mandos protocol
1717
2350
# Get protocol number
1718
2351
line = self.request.makefile().readline()
1719
logger.debug("Protocol version: %r", line)
2352
log.debug("Protocol version: %r", line)
1720
2353
try:
1721
2354
if int(line.strip().split()[0]) > 1:
1722
2355
raise RuntimeError(line)
1723
2356
except (ValueError, IndexError, RuntimeError) as error:
1724
logger.error("Unknown protocol version: %s", error)
2357
log.error("Unknown protocol version: %s", error)
1725
2358
return
1726
2359
1727
2360
# Start GnuTLS connection
1728
2361
try:
1729
2362
session.handshake()
1730
except gnutls.errors.GNUTLSError as error:
1731
logger.warning("Handshake failed: %s", error)
2363
except gnutls.Error as error:
2364
log.warning("Handshake failed: %s", error)
1732
2365
# Do not run session.bye() here: the session is not
1733
2366
# established. Just abandon the request.
1734
2367
return
1735
logger.debug("Handshake succeeded")
1736
2368
log.debug("Handshake succeeded")
2369
1737
2370
approval_required = False
1738
2371
try:
1739
try:
1740
fpr = self.fingerprint(
1741
self.peer_certificate(session))
1742
except (TypeError,
1743
gnutls.errors.GNUTLSError) as error:
1744
logger.warning("Bad certificate: %s", error)
1745
return
1746
logger.debug("Fingerprint: %s", fpr)
1747
1748
try:
1749
client = ProxyClient(child_pipe, fpr,
2372
if gnutls.has_rawpk:
2373
fpr = b""
2374
try:
2375
key_id = self.key_id(
2376
self.peer_certificate(session))
2377
except (TypeError, gnutls.Error) as error:
2378
log.warning("Bad certificate: %s", error)
2379
return
2380
log.debug("Key ID: %s",
2381
key_id.decode("utf-8",
2382
errors="replace"))
2383
2384
else:
2385
key_id = b""
2386
try:
2387
fpr = self.fingerprint(
2388
self.peer_certificate(session))
2389
except (TypeError, gnutls.Error) as error:
2390
log.warning("Bad certificate: %s", error)
2391
return
2392
log.debug("Fingerprint: %s", fpr)
2393
2394
try:
2395
client = ProxyClient(child_pipe, key_id, fpr,
1750
2396
self.client_address)
1751
2397
except KeyError:
1752
2398
return
1753
2399
1754
2400
if client.approval_delay:
1755
2401
delay = client.approval_delay
1756
2402
client.approvals_pending += 1
1757
2403
approval_required = True
1758
2404
1759
2405
while True:
1760
2406
if not client.enabled:
1761
logger.info("Client %s is disabled",
1762
client.name)
2407
log.info("Client %s is disabled", client.name)
1763
2408
if self.server.use_dbus:
1764
2409
# Emit D-Bus signal
1765
2410
client.Rejected("Disabled")
1766
2411
return
1767
2412
1768
2413
if client.approved or not client.approval_delay:
1769
#We are approved or approval is disabled
2414
# We are approved or approval is disabled
1770
2415
break
1771
2416
elif client.approved is None:
1772
logger.info("Client %s needs approval",
1773
client.name)
2417
log.info("Client %s needs approval",
2418
client.name)
1774
2419
if self.server.use_dbus:
1775
2420
# Emit D-Bus signal
1776
2421
client.NeedApproval(
1777
2422
client.approval_delay.total_seconds()
1778
2423
* 1000, client.approved_by_default)
1779
2424
else:
1780
logger.warning("Client %s was not approved",
1781
client.name)
2425
log.warning("Client %s was not approved",
2426
client.name)
1782
2427
if self.server.use_dbus:
1783
2428
# Emit D-Bus signal
1784
2429
client.Rejected("Denied")
1785
2430
return
1786
1787
#wait until timeout or approved
2431
2432
# wait until timeout or approved
1788
2433
time = datetime.datetime.now()
1789
2434
client.changedstate.acquire()
1790
2435
client.changedstate.wait(delay.total_seconds())
1792
2437
time2 = datetime.datetime.now()
1793
2438
if (time2 - time) >= delay:
1794
2439
if not client.approved_by_default:
1795
logger.warning("Client %s timed out while"
1796
" waiting for approval",
1797
client.name)
2440
log.warning("Client %s timed out while"
2441
" waiting for approval",
2442
client.name)
1798
2443
if self.server.use_dbus:
1799
2444
# Emit D-Bus signal
1800
2445
client.Rejected("Approval timed out")
1803
2448
break
1804
2449
else:
1805
2450
delay -= time2 - time
1806
1807
sent_size = 0
1808
while sent_size < len(client.secret):
1809
try:
1810
sent = session.send(client.secret[sent_size:])
1811
except gnutls.errors.GNUTLSError as error:
1812
logger.warning("gnutls send failed",
1813
exc_info=error)
1814
return
1815
logger.debug("Sent: %d, remaining: %d", sent,
1816
len(client.secret) - (sent_size
1817
+ sent))
1818
sent_size += sent
1819
1820
logger.info("Sending secret to %s", client.name)
2451
2452
try:
2453
session.send(client.secret)
2454
except gnutls.Error as error:
2455
log.warning("gnutls send failed", exc_info=error)
2456
return
2457
2458
log.info("Sending secret to %s", client.name)
1821
2459
# bump the timeout using extended_timeout
1822
2460
client.bump_timeout(client.extended_timeout)
1823
2461
if self.server.use_dbus:
1824
2462
# Emit D-Bus signal
1825
2463
client.GotSecret()
1826
2464
1827
2465
finally:
1828
2466
if approval_required:
1829
2467
client.approvals_pending -= 1
1830
2468
try:
1831
2469
session.bye()
1832
except gnutls.errors.GNUTLSError as error:
1833
logger.warning("GnuTLS bye failed",
1834
exc_info=error)
1835
2470
except gnutls.Error as error:
2471
log.warning("GnuTLS bye failed", exc_info=error)
2472
1836
2473
@staticmethod
1837
2474
def peer_certificate(session):
1838
"Return the peer's OpenPGP certificate as a bytestring"
1839
# If not an OpenPGP certificate...
1840
if (gnutls.library.functions.gnutls_certificate_type_get(
1841
session._c_object)
1842
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1843
# ...do the normal thing
1844
return session.peer_certificate
2475
"Return the peer's certificate as a bytestring"
2476
try:
2477
cert_type = gnutls.certificate_type_get2(
2478
session, gnutls.CTYPE_PEERS)
2479
except AttributeError:
2480
cert_type = gnutls.certificate_type_get(session)
2481
if gnutls.has_rawpk:
2482
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2483
else:
2484
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2485
# If not a valid certificate type...
2486
if cert_type not in valid_cert_types:
2487
log.info("Cert type %r not in %r", cert_type,
2488
valid_cert_types)
2489
# ...return invalid data
2490
return b""
1845
2491
list_size = ctypes.c_uint(1)
1846
cert_list = (gnutls.library.functions
1847
.gnutls_certificate_get_peers
1848
(session._c_object, ctypes.byref(list_size)))
2492
cert_list = (gnutls.certificate_get_peers
2493
(session, ctypes.byref(list_size)))
1849
2494
if not bool(cert_list) and list_size.value != 0:
1850
raise gnutls.errors.GNUTLSError("error getting peer"
1851
" certificate")
2495
raise gnutls.Error("error getting peer certificate")
1852
2496
if list_size.value == 0:
1853
2497
return None
1854
2498
cert = cert_list[0]
1855
2499
return ctypes.string_at(cert.data, cert.size)
1856
2500
2501
@staticmethod
2502
def key_id(certificate):
2503
"Convert a certificate bytestring to a hexdigit key ID"
2504
# New GnuTLS "datum" with the public key
2505
datum = gnutls.datum_t(
2506
ctypes.cast(ctypes.c_char_p(certificate),
2507
ctypes.POINTER(ctypes.c_ubyte)),
2508
ctypes.c_uint(len(certificate)))
2509
# XXX all these need to be created in the gnutls "module"
2510
# New empty GnuTLS certificate
2511
pubkey = gnutls.pubkey_t()
2512
gnutls.pubkey_init(ctypes.byref(pubkey))
2513
# Import the raw public key into the certificate
2514
gnutls.pubkey_import(pubkey,
2515
ctypes.byref(datum),
2516
gnutls.X509_FMT_DER)
2517
# New buffer for the key ID
2518
buf = ctypes.create_string_buffer(32)
2519
buf_len = ctypes.c_size_t(len(buf))
2520
# Get the key ID from the raw public key into the buffer
2521
gnutls.pubkey_get_key_id(
2522
pubkey,
2523
gnutls.KEYID_USE_SHA256,
2524
ctypes.cast(ctypes.byref(buf),
2525
ctypes.POINTER(ctypes.c_ubyte)),
2526
ctypes.byref(buf_len))
2527
# Deinit the certificate
2528
gnutls.pubkey_deinit(pubkey)
2529
2530
# Convert the buffer to a Python bytestring
2531
key_id = ctypes.string_at(buf, buf_len.value)
2532
# Convert the bytestring to hexadecimal notation
2533
hex_key_id = binascii.hexlify(key_id).upper()
2534
return hex_key_id
2535
1857
2536
@staticmethod
1858
2537
def fingerprint(openpgp):
1859
2538
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1860
2539
# New GnuTLS "datum" with the OpenPGP public key
1861
datum = gnutls.library.types.gnutls_datum_t(
2540
datum = gnutls.datum_t(
1862
2541
ctypes.cast(ctypes.c_char_p(openpgp),
1863
2542
ctypes.POINTER(ctypes.c_ubyte)),
1864
2543
ctypes.c_uint(len(openpgp)))
1865
2544
# New empty GnuTLS certificate
1866
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1867
gnutls.library.functions.gnutls_openpgp_crt_init(
1868
ctypes.byref(crt))
2545
crt = gnutls.openpgp_crt_t()
2546
gnutls.openpgp_crt_init(ctypes.byref(crt))
1869
2547
# Import the OpenPGP public key into the certificate
1870
gnutls.library.functions.gnutls_openpgp_crt_import(
1871
crt, ctypes.byref(datum),
1872
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
2548
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2549
gnutls.OPENPGP_FMT_RAW)
1873
2550
# Verify the self signature in the key
1874
2551
crtverify = ctypes.c_uint()
1875
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1876
crt, 0, ctypes.byref(crtverify))
2552
gnutls.openpgp_crt_verify_self(crt, 0,
2553
ctypes.byref(crtverify))
1877
2554
if crtverify.value != 0:
1878
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1879
raise gnutls.errors.CertificateSecurityError(
1880
"Verify failed")
2555
gnutls.openpgp_crt_deinit(crt)
2556
raise gnutls.CertificateSecurityError(code
2557
=crtverify.value)
1881
2558
# New buffer for the fingerprint
1882
2559
buf = ctypes.create_string_buffer(20)
1883
2560
buf_len = ctypes.c_size_t()
1884
2561
# Get the fingerprint from the certificate into the buffer
1885
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1886
crt, ctypes.byref(buf), ctypes.byref(buf_len))
2562
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2563
ctypes.byref(buf_len))
1887
2564
# Deinit the certificate
1888
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2565
gnutls.openpgp_crt_deinit(crt)
1889
2566
# Convert the buffer to a Python bytestring
1890
2567
fpr = ctypes.string_at(buf, buf_len.value)
1891
2568
# Convert the bytestring to hexadecimal notation
1893
2570
return hex_fpr
1894
2571
1895
2572
1896
class MultiprocessingMixIn(object):
2573
class MultiprocessingMixIn:
1897
2574
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1898
2575
1899
2576
def sub_process_main(self, request, address):
1900
2577
try:
1901
2578
self.finish_request(request, address)
1902
2579
except Exception:
1903
2580
self.handle_error(request, address)
1904
2581
self.close_request(request)
1905
2582
1906
2583
def process_request(self, request, address):
1907
2584
"""Start a new process to process the request."""
1908
proc = multiprocessing.Process(target = self.sub_process_main,
1909
args = (request, address))
2585
proc = multiprocessing.Process(target=self.sub_process_main,
2586
args=(request, address))
1910
2587
proc.start()
1911
2588
return proc
1912
2589
1913
2590
1914
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2591
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1915
2592
""" adds a pipe to the MixIn """
1916
2593
1917
2594
def process_request(self, request, client_address):
1918
2595
"""Overrides and wraps the original process_request().
1919
2596
1920
2597
This function creates a new pipe in self.pipe
1921
2598
"""
1922
2599
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1923
2600
1924
2601
proc = MultiprocessingMixIn.process_request(self, request,
1925
2602
client_address)
1926
2603
self.child_pipe.close()
1927
2604
self.add_pipe(parent_pipe, proc)
1928
2605
1929
2606
def add_pipe(self, parent_pipe, proc):
1930
2607
"""Dummy function; override as necessary"""
1931
2608
raise NotImplementedError()
1932
2609
1933
2610
1934
2611
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1935
socketserver.TCPServer, object):
1936
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1937
2612
socketserver.TCPServer):
2613
"""IPv6-capable TCP server. Accepts None as address and/or port
2614
1938
2615
Attributes:
1939
2616
enabled: Boolean; whether this server is activated yet
1940
2617
interface: None or a network interface name (string)
1941
2618
use_ipv6: Boolean; to use IPv6 or not
1942
2619
"""
1943
2620
1944
2621
def __init__(self, server_address, RequestHandlerClass,
1945
2622
interface=None,
1946
2623
use_ipv6=True,
1956
2633
self.socketfd = socketfd
1957
2634
# Save the original socket.socket() function
1958
2635
self.socket_socket = socket.socket
2636
1959
2637
# To implement --socket, we monkey patch socket.socket.
1960
#
2638
#
1961
2639
# (When socketserver.TCPServer is a new-style class, we
1962
2640
# could make self.socket into a property instead of monkey
1963
2641
# patching socket.socket.)
1964
#
2642
#
1965
2643
# Create a one-time-only replacement for socket.socket()
1966
2644
@functools.wraps(socket.socket)
1967
2645
def socket_wrapper(*args, **kwargs):
1979
2657
# socket_wrapper(), if socketfd was set.
1980
2658
socketserver.TCPServer.__init__(self, server_address,
1981
2659
RequestHandlerClass)
1982
2660
1983
2661
def server_bind(self):
1984
2662
"""This overrides the normal server_bind() function
1985
2663
to bind to an interface if one was specified, and also NOT to
1986
2664
bind to an address or port if they were not specified."""
2665
global SO_BINDTODEVICE
1987
2666
if self.interface is not None:
1988
2667
if SO_BINDTODEVICE is None:
1989
logger.error("SO_BINDTODEVICE does not exist;"
1990
" cannot bind to interface %s",
1991
self.interface)
1992
else:
1993
try:
1994
self.socket.setsockopt(
1995
socket.SOL_SOCKET, SO_BINDTODEVICE,
1996
(self.interface + "\0").encode("utf-8"))
1997
except socket.error as error:
1998
if error.errno == errno.EPERM:
1999
logger.error("No permission to bind to"
2000
" interface %s", self.interface)
2001
elif error.errno == errno.ENOPROTOOPT:
2002
logger.error("SO_BINDTODEVICE not available;"
2003
" cannot bind to interface %s",
2004
self.interface)
2005
elif error.errno == errno.ENODEV:
2006
logger.error("Interface %s does not exist,"
2007
" cannot bind", self.interface)
2008
else:
2009
raise
2668
# Fall back to a hard-coded value which seems to be
2669
# common enough.
2670
log.warning("SO_BINDTODEVICE not found, trying 25")
2671
SO_BINDTODEVICE = 25
2672
try:
2673
self.socket.setsockopt(
2674
socket.SOL_SOCKET, SO_BINDTODEVICE,
2675
(self.interface + "\0").encode("utf-8"))
2676
except socket.error as error:
2677
if error.errno == errno.EPERM:
2678
log.error("No permission to bind to interface %s",
2679
self.interface)
2680
elif error.errno == errno.ENOPROTOOPT:
2681
log.error("SO_BINDTODEVICE not available; cannot"
2682
" bind to interface %s", self.interface)
2683
elif error.errno == errno.ENODEV:
2684
log.error("Interface %s does not exist, cannot"
2685
" bind", self.interface)
2686
else:
2687
raise
2010
2688
# Only bind(2) the socket if we really need to.
2011
2689
if self.server_address[0] or self.server_address[1]:
2690
if self.server_address[1]:
2691
self.allow_reuse_address = True
2012
2692
if not self.server_address[0]:
2013
2693
if self.address_family == socket.AF_INET6:
2014
any_address = "::" # in6addr_any
2694
any_address = "::" # in6addr_any
2015
2695
else:
2016
any_address = "0.0.0.0" # INADDR_ANY
2696
any_address = "0.0.0.0" # INADDR_ANY
2017
2697
self.server_address = (any_address,
2018
2698
self.server_address[1])
2019
2699
elif not self.server_address[1]:
2029
2709
2030
2710
class MandosServer(IPv6_TCPServer):
2031
2711
"""Mandos server.
2032
2712
2033
2713
Attributes:
2034
2714
clients: set of Client objects
2035
2715
gnutls_priority GnuTLS priority string
2036
2716
use_dbus: Boolean; to emit D-Bus signals or not
2037
2038
Assumes a gobject.MainLoop event loop.
2717
2718
Assumes a GLib.MainLoop event loop.
2039
2719
"""
2040
2720
2041
2721
def __init__(self, server_address, RequestHandlerClass,
2042
2722
interface=None,
2043
2723
use_ipv6=True,
2053
2733
self.gnutls_priority = gnutls_priority
2054
2734
IPv6_TCPServer.__init__(self, server_address,
2055
2735
RequestHandlerClass,
2056
interface = interface,
2057
use_ipv6 = use_ipv6,
2058
socketfd = socketfd)
2059
2736
interface=interface,
2737
use_ipv6=use_ipv6,
2738
socketfd=socketfd)
2739
2060
2740
def server_activate(self):
2061
2741
if self.enabled:
2062
2742
return socketserver.TCPServer.server_activate(self)
2063
2743
2064
2744
def enable(self):
2065
2745
self.enabled = True
2066
2746
2067
2747
def add_pipe(self, parent_pipe, proc):
2068
2748
# Call "handle_ipc" for both data and EOF events
2069
gobject.io_add_watch(
2070
parent_pipe.fileno(),
2071
gobject.IO_IN | gobject.IO_HUP,
2749
GLib.io_add_watch(
2750
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2751
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2072
2752
functools.partial(self.handle_ipc,
2073
parent_pipe = parent_pipe,
2074
proc = proc))
2075
2753
parent_pipe=parent_pipe,
2754
proc=proc))
2755
2076
2756
def handle_ipc(self, source, condition,
2077
2757
parent_pipe=None,
2078
proc = None,
2758
proc=None,
2079
2759
client_object=None):
2080
2760
# error, or the other end of multiprocessing.Pipe has closed
2081
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2761
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2082
2762
# Wait for other process to exit
2083
2763
proc.join()
2084
2764
return False
2085
2765
2086
2766
# Read a request from the child
2087
2767
request = parent_pipe.recv()
2088
2768
command = request[0]
2089
2090
if command == 'init':
2091
fpr = request[1]
2092
address = request[2]
2093
2094
for c in self.clients.itervalues():
2095
if c.fingerprint == fpr:
2769
2770
if command == "init":
2771
key_id = request[1].decode("ascii")
2772
fpr = request[2].decode("ascii")
2773
address = request[3]
2774
2775
for c in self.clients.values():
2776
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2777
"27AE41E4649B934CA495991B7852B855"):
2778
continue
2779
if key_id and c.key_id == key_id:
2780
client = c
2781
break
2782
if fpr and c.fingerprint == fpr:
2096
2783
client = c
2097
2784
break
2098
2785
else:
2099
logger.info("Client not found for fingerprint: %s, ad"
2100
"dress: %s", fpr, address)
2786
log.info("Client not found for key ID: %s, address:"
2787
" %s", key_id or fpr, address)
2101
2788
if self.use_dbus:
2102
2789
# Emit D-Bus signal
2103
mandos_dbus_service.ClientNotFound(fpr,
2790
mandos_dbus_service.ClientNotFound(key_id or fpr,
2104
2791
address[0])
2105
2792
parent_pipe.send(False)
2106
2793
return False
2107
2108
gobject.io_add_watch(
2109
parent_pipe.fileno(),
2110
gobject.IO_IN | gobject.IO_HUP,
2794
2795
GLib.io_add_watch(
2796
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2797
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2111
2798
functools.partial(self.handle_ipc,
2112
parent_pipe = parent_pipe,
2113
proc = proc,
2114
client_object = client))
2799
parent_pipe=parent_pipe,
2800
proc=proc,
2801
client_object=client))
2115
2802
parent_pipe.send(True)
2116
2803
# remove the old hook in favor of the new above hook on
2117
2804
# same fileno
2118
2805
return False
2119
if command == 'funcall':
2806
if command == "funcall":
2120
2807
funcname = request[1]
2121
2808
args = request[2]
2122
2809
kwargs = request[3]
2123
2124
parent_pipe.send(('data', getattr(client_object,
2810
2811
parent_pipe.send(("data", getattr(client_object,
2125
2812
funcname)(*args,
2126
2813
**kwargs)))
2127
2128
if command == 'getattr':
2814
2815
if command == "getattr":
2129
2816
attrname = request[1]
2130
if callable(client_object.__getattribute__(attrname)):
2131
parent_pipe.send(('function', ))
2817
if isinstance(client_object.__getattribute__(attrname),
2818
collections.abc.Callable):
2819
parent_pipe.send(("function", ))
2132
2820
else:
2133
2821
parent_pipe.send((
2134
'data', client_object.__getattribute__(attrname)))
2135
2136
if command == 'setattr':
2822
"data", client_object.__getattribute__(attrname)))
2823
2824
if command == "setattr":
2137
2825
attrname = request[1]
2138
2826
value = request[2]
2139
2827
setattr(client_object, attrname, value)
2140
2828
2141
2829
return True
2142
2830
2143
2831
2144
2832
def rfc3339_duration_to_delta(duration):
2145
2833
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2146
2147
>>> rfc3339_duration_to_delta("P7D")
2148
datetime.timedelta(7)
2149
>>> rfc3339_duration_to_delta("PT60S")
2150
datetime.timedelta(0, 60)
2151
>>> rfc3339_duration_to_delta("PT60M")
2152
datetime.timedelta(0, 3600)
2153
>>> rfc3339_duration_to_delta("PT24H")
2154
datetime.timedelta(1)
2155
>>> rfc3339_duration_to_delta("P1W")
2156
datetime.timedelta(7)
2157
>>> rfc3339_duration_to_delta("PT5M30S")
2158
datetime.timedelta(0, 330)
2159
>>> rfc3339_duration_to_delta("P1DT3M20S")
2160
datetime.timedelta(1, 200)
2834
2835
>>> timedelta = datetime.timedelta
2836
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2837
True
2838
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2839
True
2840
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2841
True
2842
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2843
True
2844
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2845
True
2846
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2847
True
2848
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2849
True
2850
>>> del timedelta
2161
2851
"""
2162
2852
2163
2853
# Parsing an RFC 3339 duration with regular expressions is not
2164
2854
# possible - there would have to be multiple places for the same
2165
2855
# values, like seconds. The current code, while more esoteric, is
2166
2856
# cleaner without depending on a parsing library. If Python had a
2167
2857
# built-in library for parsing we would use it, but we'd like to
2168
2858
# avoid excessive use of external libraries.
2169
2859
2170
2860
# New type for defining tokens, syntax, and semantics all-in-one
2171
Token = collections.namedtuple("Token",
2172
("regexp", # To match token; if
2173
# "value" is not None,
2174
# must have a "group"
2175
# containing digits
2176
"value", # datetime.timedelta or
2177
# None
2178
"followers")) # Tokens valid after
2179
# this token
2180
2861
Token = collections.namedtuple("Token", (
2181
2862
"regexp", # To match token; if "value" is not None, must have
2182
2863
# a "group" containing digits
2214
2895
frozenset((token_year, token_month,
2215
2896
token_day, token_time,
2216
2897
token_week)))
2217
# Define starting values
2218
value = datetime.timedelta() # Value so far
2898
# Define starting values:
2899
# Value so far
2900
value = datetime.timedelta()
2219
2901
found_token = None
2220
followers = frozenset((token_duration,)) # Following valid tokens
2221
s = duration # String left to parse
2902
# Following valid tokens
2903
followers = frozenset((token_duration, ))
2904
# String left to parse
2905
s = duration
2222
2906
# Loop until end token is found
2223
2907
while found_token is not token_end:
2224
2908
# Search for any currently valid tokens
2240
2924
break
2241
2925
else:
2242
2926
# No currently valid tokens were found
2243
raise ValueError("Invalid RFC 3339 duration")
2927
raise ValueError("Invalid RFC 3339 duration: {!r}"
2928
.format(duration))
2244
2929
# End token found
2245
2930
return value
2246
2931
2247
2932
2248
2933
def string_to_delta(interval):
2249
2934
"""Parse a string and return a datetime.timedelta
2250
2251
>>> string_to_delta('7d')
2252
datetime.timedelta(7)
2253
>>> string_to_delta('60s')
2254
datetime.timedelta(0, 60)
2255
>>> string_to_delta('60m')
2256
datetime.timedelta(0, 3600)
2257
>>> string_to_delta('24h')
2258
datetime.timedelta(1)
2259
>>> string_to_delta('1w')
2260
datetime.timedelta(7)
2261
>>> string_to_delta('5m 30s')
2262
datetime.timedelta(0, 330)
2935
2936
>>> string_to_delta("7d") == datetime.timedelta(7)
2937
True
2938
>>> string_to_delta("60s") == datetime.timedelta(0, 60)
2939
True
2940
>>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2941
True
2942
>>> string_to_delta("24h") == datetime.timedelta(1)
2943
True
2944
>>> string_to_delta("1w") == datetime.timedelta(7)
2945
True
2946
>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2947
True
2263
2948
"""
2264
2949
2265
2950
try:
2266
2951
return rfc3339_duration_to_delta(interval)
2267
2952
except ValueError:
2268
2953
pass
2269
2954
2270
2955
timevalue = datetime.timedelta(0)
2271
2956
for s in interval.split():
2272
2957
try:
2290
2975
return timevalue
2291
2976
2292
2977
2293
def daemon(nochdir = False, noclose = False):
2978
def daemon(nochdir=False, noclose=False):
2294
2979
"""See daemon(3). Standard BSD Unix function.
2295
2980
2296
2981
This should really exist as os.daemon, but it doesn't (yet)."""
2297
2982
if os.fork():
2298
2983
sys.exit()
2316
3001
2317
3002
2318
3003
def main():
2319
3004
2320
3005
##################################################################
2321
3006
# Parsing of options, both command line and config file
2322
3007
2323
3008
parser = argparse.ArgumentParser()
2324
3009
parser.add_argument("-v", "--version", action="version",
2325
version = "%(prog)s {}".format(version),
3010
version="%(prog)s {}".format(version),
2326
3011
help="show version number and exit")
2327
3012
parser.add_argument("-i", "--interface", metavar="IF",
2328
3013
help="Bind to interface IF")
2364
3049
parser.add_argument("--no-zeroconf", action="store_false",
2365
3050
dest="zeroconf", help="Do not use Zeroconf",
2366
3051
default=None)
2367
3052
2368
3053
options = parser.parse_args()
2369
2370
if options.check:
2371
import doctest
2372
fail_count, test_count = doctest.testmod()
2373
sys.exit(os.EX_OK if fail_count == 0 else 1)
2374
3054
2375
3055
# Default values for config file for server-global settings
2376
server_defaults = { "interface": "",
2377
"address": "",
2378
"port": "",
2379
"debug": "False",
2380
"priority":
2381
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2382
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2383
"servicename": "Mandos",
2384
"use_dbus": "True",
2385
"use_ipv6": "True",
2386
"debuglevel": "",
2387
"restore": "True",
2388
"socket": "",
2389
"statedir": "/var/lib/mandos",
2390
"foreground": "False",
2391
"zeroconf": "True",
2392
}
2393
3056
if gnutls.has_rawpk:
3057
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3058
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3059
else:
3060
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3061
":+SIGN-DSA-SHA256")
3062
server_defaults = {"interface": "",
3063
"address": "",
3064
"port": "",
3065
"debug": "False",
3066
"priority": priority,
3067
"servicename": "Mandos",
3068
"use_dbus": "True",
3069
"use_ipv6": "True",
3070
"debuglevel": "",
3071
"restore": "True",
3072
"socket": "",
3073
"statedir": "/var/lib/mandos",
3074
"foreground": "False",
3075
"zeroconf": "True",
3076
}
3077
del priority
3078
2394
3079
# Parse config file for server-global settings
2395
server_config = configparser.SafeConfigParser(server_defaults)
3080
server_config = configparser.ConfigParser(server_defaults)
2396
3081
del server_defaults
2397
3082
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2398
# Convert the SafeConfigParser object to a dict
3083
# Convert the ConfigParser object to a dict
2399
3084
server_settings = server_config.defaults()
2400
3085
# Use the appropriate methods on the non-string config options
2401
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3086
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3087
"foreground", "zeroconf"):
2402
3088
server_settings[option] = server_config.getboolean("DEFAULT",
2403
3089
option)
2404
3090
if server_settings["port"]:
2414
3100
server_settings["socket"] = os.dup(server_settings
2415
3101
["socket"])
2416
3102
del server_config
2417
3103
2418
3104
# Override the settings from the config file with command line
2419
3105
# options, if set.
2420
3106
for option in ("interface", "address", "port", "debug",
2438
3124
if server_settings["debug"]:
2439
3125
server_settings["foreground"] = True
2440
3126
# Now we have our good server settings in "server_settings"
2441
3127
2442
3128
##################################################################
2443
3129
2444
3130
if (not server_settings["zeroconf"]
2445
3131
and not (server_settings["port"]
2446
3132
or server_settings["socket"] != "")):
2447
3133
parser.error("Needs port or socket to work without Zeroconf")
2448
3134
2449
3135
# For convenience
2450
3136
debug = server_settings["debug"]
2451
3137
debuglevel = server_settings["debuglevel"]
2455
3141
stored_state_file)
2456
3142
foreground = server_settings["foreground"]
2457
3143
zeroconf = server_settings["zeroconf"]
2458
3144
2459
3145
if debug:
2460
3146
initlogger(debug, logging.DEBUG)
2461
3147
else:
2464
3150
else:
2465
3151
level = getattr(logging, debuglevel.upper())
2466
3152
initlogger(debug, level)
2467
3153
2468
3154
if server_settings["servicename"] != "Mandos":
2469
3155
syslogger.setFormatter(
2470
logging.Formatter('Mandos ({}) [%(process)d]:'
2471
' %(levelname)s: %(message)s'.format(
3156
logging.Formatter("Mandos ({}) [%(process)d]:"
3157
" %(levelname)s: %(message)s".format(
2472
3158
server_settings["servicename"])))
2473
3159
2474
3160
# Parse config file with clients
2475
client_config = configparser.SafeConfigParser(Client
2476
.client_defaults)
3161
client_config = configparser.ConfigParser(Client.client_defaults)
2477
3162
client_config.read(os.path.join(server_settings["configdir"],
2478
3163
"clients.conf"))
2479
3164
2480
3165
global mandos_dbus_service
2481
3166
mandos_dbus_service = None
2482
3167
2483
3168
socketfd = None
2484
3169
if server_settings["socket"] != "":
2485
3170
socketfd = server_settings["socket"]
2497
3182
pidfilename = "/var/run/mandos.pid"
2498
3183
pidfile = None
2499
3184
try:
2500
pidfile = open(pidfilename, "w")
3185
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2501
3186
except IOError as e:
2502
logger.error("Could not open file %r", pidfilename,
2503
exc_info=e)
2504
2505
for name in ("_mandos", "mandos", "nobody"):
3187
log.error("Could not open file %r", pidfilename,
3188
exc_info=e)
3189
3190
for name, group in (("_mandos", "_mandos"),
3191
("mandos", "mandos"),
3192
("nobody", "nogroup")):
2506
3193
try:
2507
3194
uid = pwd.getpwnam(name).pw_uid
2508
gid = pwd.getpwnam(name).pw_gid
3195
gid = pwd.getpwnam(group).pw_gid
2509
3196
break
2510
3197
except KeyError:
2511
3198
continue
2515
3202
try:
2516
3203
os.setgid(gid)
2517
3204
os.setuid(uid)
3205
log.debug("Did setuid/setgid to %s:%s", uid, gid)
2518
3206
except OSError as error:
3207
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3208
os.strerror(error.errno))
2519
3209
if error.errno != errno.EPERM:
2520
3210
raise
2521
3211
2522
3212
if debug:
2523
3213
# Enable all possible GnuTLS debugging
2524
3214
2525
3215
# "Use a log level over 10 to enable all debugging options."
2526
3216
# - GnuTLS manual
2527
gnutls.library.functions.gnutls_global_set_log_level(11)
2528
2529
@gnutls.library.types.gnutls_log_func
3217
gnutls.global_set_log_level(11)
3218
3219
@gnutls.log_func
2530
3220
def debug_gnutls(level, string):
2531
logger.debug("GnuTLS: %s", string[:-1])
2532
2533
gnutls.library.functions.gnutls_global_set_log_function(
2534
debug_gnutls)
2535
3221
log.debug("GnuTLS: %s",
3222
string[:-1].decode("utf-8", errors="replace"))
3223
3224
gnutls.global_set_log_function(debug_gnutls)
3225
2536
3226
# Redirect stdin so all checkers get /dev/null
2537
3227
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2538
3228
os.dup2(null, sys.stdin.fileno())
2539
3229
if null > 2:
2540
3230
os.close(null)
2541
3231
2542
3232
# Need to fork before connecting to D-Bus
2543
3233
if not foreground:
2544
3234
# Close all input and output, do double fork, etc.
2545
3235
daemon()
2546
2547
# multiprocessing will use threads, so before we use gobject we
2548
# need to inform gobject that threads will be used.
2549
gobject.threads_init()
2550
3236
3237
if gi.version_info < (3, 10, 2):
3238
# multiprocessing will use threads, so before we use GLib we
3239
# need to inform GLib that threads will be used.
3240
GLib.threads_init()
3241
2551
3242
global main_loop
2552
3243
# From the Avahi example code
2553
3244
DBusGMainLoop(set_as_default=True)
2554
main_loop = gobject.MainLoop()
3245
main_loop = GLib.MainLoop()
2555
3246
bus = dbus.SystemBus()
2556
3247
# End of Avahi example code
2557
3248
if use_dbus:
2562
3253
old_bus_name = dbus.service.BusName(
2563
3254
"se.bsnet.fukt.Mandos", bus,
2564
3255
do_not_queue=True)
2565
except dbus.exceptions.NameExistsException as e:
2566
logger.error("Disabling D-Bus:", exc_info=e)
3256
except dbus.exceptions.DBusException as e:
3257
log.error("Disabling D-Bus:", exc_info=e)
2567
3258
use_dbus = False
2568
3259
server_settings["use_dbus"] = False
2569
3260
tcp_server.use_dbus = False
2570
3261
if zeroconf:
2571
3262
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2572
3263
service = AvahiServiceToSyslog(
2573
name = server_settings["servicename"],
2574
servicetype = "_mandos._tcp",
2575
protocol = protocol,
2576
bus = bus)
3264
name=server_settings["servicename"],
3265
servicetype="_mandos._tcp",
3266
protocol=protocol,
3267
bus=bus)
2577
3268
if server_settings["interface"]:
2578
3269
service.interface = if_nametoindex(
2579
3270
server_settings["interface"].encode("utf-8"))
2580
3271
2581
3272
global multiprocessing_manager
2582
3273
multiprocessing_manager = multiprocessing.Manager()
2583
3274
2584
3275
client_class = Client
2585
3276
if use_dbus:
2586
client_class = functools.partial(ClientDBus, bus = bus)
2587
3277
client_class = functools.partial(ClientDBus, bus=bus)
3278
2588
3279
client_settings = Client.config_parser(client_config)
2589
3280
old_client_settings = {}
2590
3281
clients_data = {}
2591
3282
2592
3283
# This is used to redirect stdout and stderr for checker processes
2593
3284
global wnull
2594
wnull = open(os.devnull, "w") # A writable /dev/null
3285
wnull = open(os.devnull, "w") # A writable /dev/null
2595
3286
# Only used if server is running in foreground but not in debug
2596
3287
# mode
2597
3288
if debug or not foreground:
2598
3289
wnull.close()
2599
3290
2600
3291
# Get client data and settings from last running state.
2601
3292
if server_settings["restore"]:
2602
3293
try:
2603
3294
with open(stored_state_path, "rb") as stored_state:
2604
clients_data, old_client_settings = pickle.load(
2605
stored_state)
3295
if sys.version_info.major == 2:
3296
clients_data, old_client_settings = pickle.load(
3297
stored_state)
3298
else:
3299
bytes_clients_data, bytes_old_client_settings = (
3300
pickle.load(stored_state, encoding="bytes"))
3301
# Fix bytes to strings
3302
# clients_data
3303
# .keys()
3304
clients_data = {(key.decode("utf-8")
3305
if isinstance(key, bytes)
3306
else key): value
3307
for key, value in
3308
bytes_clients_data.items()}
3309
del bytes_clients_data
3310
for key in clients_data:
3311
value = {(k.decode("utf-8")
3312
if isinstance(k, bytes) else k): v
3313
for k, v in
3314
clients_data[key].items()}
3315
clients_data[key] = value
3316
# .client_structure
3317
value["client_structure"] = [
3318
(s.decode("utf-8")
3319
if isinstance(s, bytes)
3320
else s) for s in
3321
value["client_structure"]]
3322
# .name, .host, and .checker_command
3323
for k in ("name", "host", "checker_command"):
3324
if isinstance(value[k], bytes):
3325
value[k] = value[k].decode("utf-8")
3326
if "key_id" not in value:
3327
value["key_id"] = ""
3328
elif "fingerprint" not in value:
3329
value["fingerprint"] = ""
3330
# old_client_settings
3331
# .keys()
3332
old_client_settings = {
3333
(key.decode("utf-8")
3334
if isinstance(key, bytes)
3335
else key): value
3336
for key, value in
3337
bytes_old_client_settings.items()}
3338
del bytes_old_client_settings
3339
# .host and .checker_command
3340
for value in old_client_settings.values():
3341
for attribute in ("host", "checker_command"):
3342
if isinstance(value[attribute], bytes):
3343
value[attribute] = (value[attribute]
3344
.decode("utf-8"))
2606
3345
os.remove(stored_state_path)
2607
3346
except IOError as e:
2608
3347
if e.errno == errno.ENOENT:
2609
logger.warning("Could not load persistent state:"
2610
" {}".format(os.strerror(e.errno)))
3348
log.warning("Could not load persistent state:"
3349
" %s", os.strerror(e.errno))
2611
3350
else:
2612
logger.critical("Could not load persistent state:",
2613
exc_info=e)
3351
log.critical("Could not load persistent state:",
3352
exc_info=e)
2614
3353
raise
2615
3354
except EOFError as e:
2616
logger.warning("Could not load persistent state: "
2617
"EOFError:",
2618
exc_info=e)
2619
3355
log.warning("Could not load persistent state: EOFError:",
3356
exc_info=e)
3357
2620
3358
with PGPEngine() as pgp:
2621
3359
for client_name, client in clients_data.items():
2622
3360
# Skip removed clients
2623
3361
if client_name not in client_settings:
2624
3362
continue
2625
3363
2626
3364
# Decide which value to use after restoring saved state.
2627
3365
# We have three different values: Old config file,
2628
3366
# new config file, and saved state.
2639
3377
client[name] = value
2640
3378
except KeyError:
2641
3379
pass
2642
3380
2643
3381
# Clients who has passed its expire date can still be
2644
3382
# enabled if its last checker was successful. A Client
2645
3383
# whose checker succeeded before we stored its state is
2648
3386
if client["enabled"]:
2649
3387
if datetime.datetime.utcnow() >= client["expires"]:
2650
3388
if not client["last_checked_ok"]:
2651
logger.warning(
2652
"disabling client {} - Client never "
2653
"performed a successful checker".format(
2654
client_name))
3389
log.warning("disabling client %s - Client"
3390
" never performed a successful"
3391
" checker", client_name)
2655
3392
client["enabled"] = False
2656
3393
elif client["last_checker_status"] != 0:
2657
logger.warning(
2658
"disabling client {} - Client last"
2659
" checker failed with error code"
2660
" {}".format(
2661
client_name,
2662
client["last_checker_status"]))
3394
log.warning("disabling client %s - Client"
3395
" last checker failed with error"
3396
" code %s", client_name,
3397
client["last_checker_status"])
2663
3398
client["enabled"] = False
2664
3399
else:
2665
3400
client["expires"] = (
2666
3401
datetime.datetime.utcnow()
2667
3402
+ client["timeout"])
2668
logger.debug("Last checker succeeded,"
2669
" keeping {} enabled".format(
2670
client_name))
3403
log.debug("Last checker succeeded, keeping %s"
3404
" enabled", client_name)
2671
3405
try:
2672
3406
client["secret"] = pgp.decrypt(
2673
3407
client["encrypted_secret"],
2674
3408
client_settings[client_name]["secret"])
2675
3409
except PGPError:
2676
3410
# If decryption fails, we use secret from new settings
2677
logger.debug("Failed to decrypt {} old secret".format(
2678
client_name))
3411
log.debug("Failed to decrypt %s old secret",
3412
client_name)
2679
3413
client["secret"] = (client_settings[client_name]
2680
3414
["secret"])
2681
3415
2682
3416
# Add/remove clients based on new changes made to config
2683
3417
for client_name in (set(old_client_settings)
2684
3418
- set(client_settings)):
2686
3420
for client_name in (set(client_settings)
2687
3421
- set(old_client_settings)):
2688
3422
clients_data[client_name] = client_settings[client_name]
2689
3423
2690
3424
# Create all client objects
2691
3425
for client_name, client in clients_data.items():
2692
3426
tcp_server.clients[client_name] = client_class(
2693
name = client_name,
2694
settings = client,
2695
server_settings = server_settings)
2696
3427
name=client_name,
3428
settings=client,
3429
server_settings=server_settings)
3430
2697
3431
if not tcp_server.clients:
2698
logger.warning("No clients defined")
2699
3432
log.warning("No clients defined")
3433
2700
3434
if not foreground:
2701
3435
if pidfile is not None:
3436
pid = os.getpid()
2702
3437
try:
2703
3438
with pidfile:
2704
pid = os.getpid()
2705
pidfile.write("{}\n".format(pid).encode("utf-8"))
3439
print(pid, file=pidfile)
2706
3440
except IOError:
2707
logger.error("Could not write to file %r with PID %d",
2708
pidfilename, pid)
3441
log.error("Could not write to file %r with PID %d",
3442
pidfilename, pid)
2709
3443
del pidfile
2710
3444
del pidfilename
2711
2712
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2713
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2714
3445
3446
for termsig in (signal.SIGHUP, signal.SIGTERM):
3447
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3448
lambda: main_loop.quit() and False)
3449
2715
3450
if use_dbus:
2716
3451
2717
3452
@alternate_dbus_interfaces(
2718
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2719
class MandosDBusService(DBusObjectWithProperties):
3453
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3454
class MandosDBusService(DBusObjectWithObjectManager):
2720
3455
"""A D-Bus proxy object"""
2721
3456
2722
3457
def __init__(self):
2723
3458
dbus.service.Object.__init__(self, bus, "/")
2724
3459
2725
3460
_interface = "se.recompile.Mandos"
2726
2727
@dbus_interface_annotations(_interface)
2728
def _foo(self):
2729
return {
2730
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2731
"false" }
2732
3461
2733
3462
@dbus.service.signal(_interface, signature="o")
2734
3463
def ClientAdded(self, objpath):
2735
3464
"D-Bus signal"
2736
3465
pass
2737
3466
2738
3467
@dbus.service.signal(_interface, signature="ss")
2739
def ClientNotFound(self, fingerprint, address):
3468
def ClientNotFound(self, key_id, address):
2740
3469
"D-Bus signal"
2741
3470
pass
2742
3471
3472
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3473
"true"})
2743
3474
@dbus.service.signal(_interface, signature="os")
2744
3475
def ClientRemoved(self, objpath, name):
2745
3476
"D-Bus signal"
2746
3477
pass
2747
3478
3479
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3480
"true"})
2748
3481
@dbus.service.method(_interface, out_signature="ao")
2749
3482
def GetAllClients(self):
2750
3483
"D-Bus method"
2751
3484
return dbus.Array(c.dbus_object_path for c in
2752
tcp_server.clients.itervalues())
2753
3485
tcp_server.clients.values())
3486
3487
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3488
"true"})
2754
3489
@dbus.service.method(_interface,
2755
3490
out_signature="a{oa{sv}}")
2756
3491
def GetAllClientsWithProperties(self):
2757
3492
"D-Bus method"
2758
3493
return dbus.Dictionary(
2759
{ c.dbus_object_path: c.GetAll("")
2760
for c in tcp_server.clients.itervalues() },
3494
{c.dbus_object_path: c.GetAll(
3495
"se.recompile.Mandos.Client")
3496
for c in tcp_server.clients.values()},
2761
3497
signature="oa{sv}")
2762
3498
2763
3499
@dbus.service.method(_interface, in_signature="o")
2764
3500
def RemoveClient(self, object_path):
2765
3501
"D-Bus method"
2766
for c in tcp_server.clients.itervalues():
3502
for c in tcp_server.clients.values():
2767
3503
if c.dbus_object_path == object_path:
2768
3504
del tcp_server.clients[c.name]
2769
3505
c.remove_from_connection()
2770
# Don't signal anything except ClientRemoved
3506
# Don't signal the disabling
2771
3507
c.disable(quiet=True)
2772
# Emit D-Bus signal
2773
self.ClientRemoved(object_path, c.name)
3508
# Emit D-Bus signal for removal
3509
self.client_removed_signal(c)
2774
3510
return
2775
3511
raise KeyError(object_path)
2776
3512
2777
3513
del _interface
2778
3514
3515
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3516
out_signature="a{oa{sa{sv}}}")
3517
def GetManagedObjects(self):
3518
"""D-Bus method"""
3519
return dbus.Dictionary(
3520
{client.dbus_object_path:
3521
dbus.Dictionary(
3522
{interface: client.GetAll(interface)
3523
for interface in
3524
client._get_all_interface_names()})
3525
for client in tcp_server.clients.values()})
3526
3527
def client_added_signal(self, client):
3528
"""Send the new standard signal and the old signal"""
3529
if use_dbus:
3530
# New standard signal
3531
self.InterfacesAdded(
3532
client.dbus_object_path,
3533
dbus.Dictionary(
3534
{interface: client.GetAll(interface)
3535
for interface in
3536
client._get_all_interface_names()}))
3537
# Old signal
3538
self.ClientAdded(client.dbus_object_path)
3539
3540
def client_removed_signal(self, client):
3541
"""Send the new standard signal and the old signal"""
3542
if use_dbus:
3543
# New standard signal
3544
self.InterfacesRemoved(
3545
client.dbus_object_path,
3546
client._get_all_interface_names())
3547
# Old signal
3548
self.ClientRemoved(client.dbus_object_path,
3549
client.name)
3550
2779
3551
mandos_dbus_service = MandosDBusService()
2780
3552
3553
# Save modules to variables to exempt the modules from being
3554
# unloaded before the function registered with atexit() is run.
3555
mp = multiprocessing
3556
wn = wnull
3557
2781
3558
def cleanup():
2782
3559
"Cleanup function; run on exit"
2783
3560
if zeroconf:
2784
3561
service.cleanup()
2785
2786
multiprocessing.active_children()
2787
wnull.close()
3562
3563
mp.active_children()
3564
wn.close()
2788
3565
if not (tcp_server.clients or client_settings):
2789
3566
return
2790
3567
2791
3568
# Store client before exiting. Secrets are encrypted with key
2792
3569
# based on what config file has. If config file is
2793
3570
# removed/edited, old secret will thus be unrecovable.
2794
3571
clients = {}
2795
3572
with PGPEngine() as pgp:
2796
for client in tcp_server.clients.itervalues():
3573
for client in tcp_server.clients.values():
2797
3574
key = client_settings[client.name]["secret"]
2798
3575
client.encrypted_secret = pgp.encrypt(client.secret,
2799
3576
key)
2800
3577
client_dict = {}
2801
3578
2802
3579
# A list of attributes that can not be pickled
2803
3580
# + secret.
2804
exclude = { "bus", "changedstate", "secret",
2805
"checker", "server_settings" }
3581
exclude = {"bus", "changedstate", "secret",
3582
"checker", "server_settings"}
2806
3583
for name, typ in inspect.getmembers(dbus.service
2807
3584
.Object):
2808
3585
exclude.add(name)
2809
3586
2810
3587
client_dict["encrypted_secret"] = (client
2811
3588
.encrypted_secret)
2812
3589
for attr in client.client_structure:
2813
3590
if attr not in exclude:
2814
3591
client_dict[attr] = getattr(client, attr)
2815
3592
2816
3593
clients[client.name] = client_dict
2817
3594
del client_settings[client.name]["secret"]
2818
3595
2819
3596
try:
2820
3597
with tempfile.NamedTemporaryFile(
2821
mode='wb',
3598
mode="wb",
2822
3599
suffix=".pickle",
2823
prefix='clients-',
3600
prefix="clients-",
2824
3601
dir=os.path.dirname(stored_state_path),
2825
3602
delete=False) as stored_state:
2826
pickle.dump((clients, client_settings), stored_state)
3603
pickle.dump((clients, client_settings), stored_state,
3604
protocol=2)
2827
3605
tempname = stored_state.name
2828
3606
os.rename(tempname, stored_state_path)
2829
3607
except (IOError, OSError) as e:
2833
3611
except NameError:
2834
3612
pass
2835
3613
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2836
logger.warning("Could not save persistent state: {}"
2837
.format(os.strerror(e.errno)))
3614
log.warning("Could not save persistent state: %s",
3615
os.strerror(e.errno))
2838
3616
else:
2839
logger.warning("Could not save persistent state:",
2840
exc_info=e)
3617
log.warning("Could not save persistent state:",
3618
exc_info=e)
2841
3619
raise
2842
3620
2843
3621
# Delete all clients, and settings from config
2844
3622
while tcp_server.clients:
2845
3623
name, client = tcp_server.clients.popitem()
2846
3624
if use_dbus:
2847
3625
client.remove_from_connection()
2848
# Don't signal anything except ClientRemoved
3626
# Don't signal the disabling
2849
3627
client.disable(quiet=True)
3628
# Emit D-Bus signal for removal
2850
3629
if use_dbus:
2851
# Emit D-Bus signal
2852
mandos_dbus_service.ClientRemoved(
2853
client.dbus_object_path, client.name)
3630
mandos_dbus_service.client_removed_signal(client)
2854
3631
client_settings.clear()
2855
3632
2856
3633
atexit.register(cleanup)
2857
2858
for client in tcp_server.clients.itervalues():
3634
3635
for client in tcp_server.clients.values():
2859
3636
if use_dbus:
2860
# Emit D-Bus signal
2861
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3637
# Emit D-Bus signal for adding
3638
mandos_dbus_service.client_added_signal(client)
2862
3639
# Need to initiate checking of clients
2863
3640
if client.enabled:
2864
client.init_checker()
2865
3641
client.init_checker(randomize_start=True)
3642
2866
3643
tcp_server.enable()
2867
3644
tcp_server.server_activate()
2868
3645
2869
3646
# Find out what port we got
2870
3647
if zeroconf:
2871
3648
service.port = tcp_server.socket.getsockname()[1]
2872
3649
if use_ipv6:
2873
logger.info("Now listening on address %r, port %d,"
2874
" flowinfo %d, scope_id %d",
2875
*tcp_server.socket.getsockname())
3650
log.info("Now listening on address %r, port %d, flowinfo %d,"
3651
" scope_id %d", *tcp_server.socket.getsockname())
2876
3652
else: # IPv4
2877
logger.info("Now listening on address %r, port %d",
2878
*tcp_server.socket.getsockname())
2879
2880
#service.interface = tcp_server.socket.getsockname()[3]
2881
3653
log.info("Now listening on address %r, port %d",
3654
*tcp_server.socket.getsockname())
3655
3656
# service.interface = tcp_server.socket.getsockname()[3]
3657
2882
3658
try:
2883
3659
if zeroconf:
2884
3660
# From the Avahi example code
2885
3661
try:
2886
3662
service.activate()
2887
3663
except dbus.exceptions.DBusException as error:
2888
logger.critical("D-Bus Exception", exc_info=error)
3664
log.critical("D-Bus Exception", exc_info=error)
2889
3665
cleanup()
2890
3666
sys.exit(1)
2891
3667
# End of Avahi example code
2892
2893
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2894
lambda *args, **kwargs:
2895
(tcp_server.handle_request
2896
(*args[2:], **kwargs) or True))
2897
2898
logger.debug("Starting main loop")
3668
3669
GLib.io_add_watch(
3670
GLib.IOChannel.unix_new(tcp_server.fileno()),
3671
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3672
lambda *args, **kwargs: (tcp_server.handle_request
3673
(*args[2:], **kwargs) or True))
3674
3675
log.debug("Starting main loop")
2899
3676
main_loop.run()
2900
3677
except AvahiError as error:
2901
logger.critical("Avahi Error", exc_info=error)
3678
log.critical("Avahi Error", exc_info=error)
2902
3679
cleanup()
2903
3680
sys.exit(1)
2904
3681
except KeyboardInterrupt:
2905
3682
if debug:
2906
3683
print("", file=sys.stderr)
2907
logger.debug("Server received KeyboardInterrupt")
2908
logger.debug("Server exiting")
3684
log.debug("Server received KeyboardInterrupt")
3685
log.debug("Server exiting")
2909
3686
# Must run before the D-Bus bus name gets deregistered
2910
3687
cleanup()
2911
3688
2912
2913
if __name__ == '__main__':
2914
main()
3689
3690
def parse_test_args():
3691
# type: () -> argparse.Namespace
3692
parser = argparse.ArgumentParser(add_help=False)
3693
parser.add_argument("--check", action="store_true")
3694
parser.add_argument("--prefix", )
3695
args, unknown_args = parser.parse_known_args()
3696
if args.check:
3697
# Remove test options from sys.argv
3698
sys.argv[1:] = unknown_args
3699
return args
3700
3701
# Add all tests from doctest strings
3702
def load_tests(loader, tests, none):
3703
import doctest
3704
tests.addTests(doctest.DocTestSuite())
3705
return tests
3706
3707
if __name__ == "__main__":
3708
options = parse_test_args()
3709
try:
3710
if options.check:
3711
extra_test_prefix = options.prefix
3712
if extra_test_prefix is not None:
3713
if not (unittest.main(argv=[""], exit=False)
3714
.result.wasSuccessful()):
3715
sys.exit(1)
3716
class ExtraTestLoader(unittest.TestLoader):
3717
testMethodPrefix = extra_test_prefix
3718
# Call using ./scriptname --test [--verbose]
3719
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3720
else:
3721
unittest.main(argv=[""])
3722
else:
3723
main()
3724
finally:
3725
logging.shutdown()
3726
3727
# Local Variables:
3728
# run-tests:
3729
# (lambda (&optional extra)
3730
# (if (not (funcall run-tests-in-test-buffer default-directory
3731
# extra))
3732
# (funcall show-test-buffer-in-test-window)
3733
# (funcall remove-test-window)
3734
# (if extra (message "Extra tests run successfully!"))))
3735
# run-tests-in-test-buffer:
3736
# (lambda (dir &optional extra)
3737
# (with-current-buffer (get-buffer-create "*Test*")
3738
# (setq buffer-read-only nil
3739
# default-directory dir)
3740
# (erase-buffer)
3741
# (compilation-mode))
3742
# (let ((process-result
3743
# (let ((inhibit-read-only t))
3744
# (process-file-shell-command
3745
# (funcall get-command-line extra) nil "*Test*"))))
3746
# (and (numberp process-result)
3747
# (= process-result 0))))
3748
# get-command-line:
3749
# (lambda (&optional extra)
3750
# (let ((quoted-script
3751
# (shell-quote-argument (funcall get-script-name))))
3752
# (format
3753
# (concat "%s --check" (if extra " --prefix=atest" ""))
3754
# quoted-script)))
3755
# get-script-name:
3756
# (lambda ()
3757
# (if (fboundp 'file-local-name)
3758
# (file-local-name (buffer-file-name))
3759
# (or (file-remote-p (buffer-file-name) 'localname)
3760
# (buffer-file-name))))
3761
# remove-test-window:
3762
# (lambda ()
3763
# (let ((test-window (get-buffer-window "*Test*")))
3764
# (if test-window (delete-window test-window))))
3765
# show-test-buffer-in-test-window:
3766
# (lambda ()
3767
# (when (not (get-buffer-window-list "*Test*"))
3768
# (setq next-error-last-buffer (get-buffer "*Test*"))
3769
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3770
# (display-buffer-overriding-action
3771
# `((display-buffer-in-side-window) (side . ,side)
3772
# (window-height . fit-window-to-buffer)
3773
# (window-width . fit-window-to-buffer))))
3774
# (display-buffer "*Test*"))))
3775
# eval:
3776
# (progn
3777
# (let* ((run-extra-tests (lambda () (interactive)
3778
# (funcall run-tests t)))
3779
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3780
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3781
# (setq minor-mode-overriding-map-alist
3782
# (cons `(run-tests . ,outer-keymap)
3783
# minor-mode-overriding-map-alist)))
3784
# (add-hook 'after-save-hook run-tests 90 t))
3785
# End:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0