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