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