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