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