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