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