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