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