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