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