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