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 738.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 738.1.1
- Committer: Teddy Hogeborn
- Date: 2015-06-28 16:35:27 UTC
- mto: This revision was merged to the branch mainline in revision 759.
- Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.
* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
(CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
plugin helpers provided by the system and/or
by the local administrator.
(PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
environment variable to all plugins.
(PHDIR): New; set to "/lib/mandos/plugin-helpers".
(main/pluginhelperdir): New.
(main/options): New option "--plugin-helper-dir".
(main/parse_opt, main/parse_opt_config_file): Accept new option.
(main): Use new option to set MANDOSPLUGINHELPERDIR environment
variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
(SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
(PLUGINS/WRITING PLUGINS): Document new environment variable
available to plugins.
(ENVIRONMENT): Document new environment variable
"MANDOSPLUGINHELPERDIR" affected by the new
--plugin-helper-dir option.
* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
(CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
plugin helpers provided by the system and/or
by the local administrator.
(PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
environment variable to all plugins.
(PHDIR): New; set to "/lib/mandos/plugin-helpers".
(main/pluginhelperdir): New.
(main/options): New option "--plugin-helper-dir".
(main/parse_opt, main/parse_opt_config_file): Accept new option.
(main): Use new option to set MANDOSPLUGINHELPERDIR environment
variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
(SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
(PLUGINS/WRITING PLUGINS): Document new environment variable
available to plugins.
(ENVIRONMENT): Document new environment variable
"MANDOSPLUGINHELPERDIR" affected by the new
--plugin-helper-dir option.
added
removed
mandos
1
#!/usr/bin/python
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
unicode_literals)
36
36
37
try:
38
from future_builtins import *
39
except ImportError:
40
pass
37
from future_builtins import *
41
38
42
try:
43
import SocketServer as socketserver
44
except ImportError:
45
import socketserver
39
import SocketServer as socketserver
46
40
import socket
47
41
import argparse
48
42
import datetime
49
43
import errno
50
try:
51
import ConfigParser as configparser
52
except ImportError:
53
import configparser
44
import gnutls.crypto
45
import gnutls.connection
46
import gnutls.errors
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
54
51
import sys
55
52
import re
56
53
import os
65
62
import struct
66
63
import fcntl
67
64
import functools
68
try:
69
import cPickle as pickle
70
except ImportError:
71
import pickle
65
import cPickle as pickle
72
66
import multiprocessing
73
67
import types
74
68
import binascii
75
69
import tempfile
76
70
import itertools
77
71
import collections
78
import codecs
79
72
80
73
import dbus
81
74
import dbus.service
82
from gi.repository import GLib
75
import gobject
76
import avahi
83
77
from dbus.mainloop.glib import DBusGMainLoop
84
78
import ctypes
85
79
import ctypes.util
97
91
if sys.version_info.major == 2:
98
92
str = unicode
99
93
100
version = "1.7.7"
94
version = "1.6.9"
101
95
stored_state_file = "clients.pickle"
102
96
103
97
logger = logging.getLogger()
104
98
syslogger = None
105
99
106
100
try:
107
if_nametoindex = ctypes.cdll.LoadLibrary(
108
ctypes.util.find_library("c")).if_nametoindex
101
if_nametoindex = (ctypes.cdll.LoadLibrary
102
(ctypes.util.find_library("c"))
103
.if_nametoindex)
109
104
except (OSError, AttributeError):
110
111
105
def if_nametoindex(interface):
112
106
"Get an interface index the hard way, i.e. using fcntl()"
113
107
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
118
112
return interface_index
119
113
120
114
121
def copy_function(func):
122
"""Make a copy of a function"""
123
if sys.version_info.major == 2:
124
return types.FunctionType(func.func_code,
125
func.func_globals,
126
func.func_name,
127
func.func_defaults,
128
func.func_closure)
129
else:
130
return types.FunctionType(func.__code__,
131
func.__globals__,
132
func.__name__,
133
func.__defaults__,
134
func.__closure__)
135
136
137
115
def initlogger(debug, level=logging.WARNING):
138
116
"""init logger and add loglevel"""
139
117
140
118
global syslogger
141
syslogger = (logging.handlers.SysLogHandler(
142
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
143
address = "/dev/log"))
119
syslogger = (logging.handlers.SysLogHandler
120
(facility =
121
logging.handlers.SysLogHandler.LOG_DAEMON,
122
address = "/dev/log"))
144
123
syslogger.setFormatter(logging.Formatter
145
124
('Mandos [%(process)d]: %(levelname)s:'
146
125
' %(message)s'))
163
142
164
143
class PGPEngine(object):
165
144
"""A simple class for OpenPGP symmetric encryption & decryption"""
166
167
145
def __init__(self):
168
146
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
169
self.gpg = "gpg"
170
try:
171
output = subprocess.check_output(["gpgconf"])
172
for line in output.splitlines():
173
name, text, path = line.split(b":")
174
if name == "gpg":
175
self.gpg = path
176
break
177
except OSError as e:
178
if e.errno != errno.ENOENT:
179
raise
180
147
self.gnupgargs = ['--batch',
181
'--homedir', self.tempdir,
148
'--home', self.tempdir,
182
149
'--force-mdc',
183
150
'--quiet',
184
151
'--no-use-agent']
219
186
220
187
def encrypt(self, data, password):
221
188
passphrase = self.password_encode(password)
222
with tempfile.NamedTemporaryFile(
223
dir=self.tempdir) as passfile:
189
with tempfile.NamedTemporaryFile(dir=self.tempdir
190
) as passfile:
224
191
passfile.write(passphrase)
225
192
passfile.flush()
226
proc = subprocess.Popen([self.gpg, '--symmetric',
193
proc = subprocess.Popen(['gpg', '--symmetric',
227
194
'--passphrase-file',
228
195
passfile.name]
229
196
+ self.gnupgargs,
237
204
238
205
def decrypt(self, data, password):
239
206
passphrase = self.password_encode(password)
240
with tempfile.NamedTemporaryFile(
241
dir = self.tempdir) as passfile:
207
with tempfile.NamedTemporaryFile(dir = self.tempdir
208
) as passfile:
242
209
passfile.write(passphrase)
243
210
passfile.flush()
244
proc = subprocess.Popen([self.gpg, '--decrypt',
211
proc = subprocess.Popen(['gpg', '--decrypt',
245
212
'--passphrase-file',
246
213
passfile.name]
247
214
+ self.gnupgargs,
248
215
stdin = subprocess.PIPE,
249
216
stdout = subprocess.PIPE,
250
217
stderr = subprocess.PIPE)
251
decrypted_plaintext, err = proc.communicate(input = data)
218
decrypted_plaintext, err = proc.communicate(input
219
= data)
252
220
if proc.returncode != 0:
253
221
raise PGPError(err)
254
222
return decrypted_plaintext
255
223
256
# Pretend that we have an Avahi module
257
class Avahi(object):
258
"""This isn't so much a class as it is a module-like namespace.
259
It is instantiated once, and simulates having an Avahi module."""
260
IF_UNSPEC = -1 # avahi-common/address.h
261
PROTO_UNSPEC = -1 # avahi-common/address.h
262
PROTO_INET = 0 # avahi-common/address.h
263
PROTO_INET6 = 1 # avahi-common/address.h
264
DBUS_NAME = "org.freedesktop.Avahi"
265
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
266
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
267
DBUS_PATH_SERVER = "/"
268
def string_array_to_txt_array(self, t):
269
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
270
for s in t), signature="ay")
271
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
272
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
273
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
274
SERVER_INVALID = 0 # avahi-common/defs.h
275
SERVER_REGISTERING = 1 # avahi-common/defs.h
276
SERVER_RUNNING = 2 # avahi-common/defs.h
277
SERVER_COLLISION = 3 # avahi-common/defs.h
278
SERVER_FAILURE = 4 # avahi-common/defs.h
279
avahi = Avahi()
280
224
281
225
class AvahiError(Exception):
282
226
def __init__(self, value, *args, **kwargs):
284
228
return super(AvahiError, self).__init__(value, *args,
285
229
**kwargs)
286
230
287
288
231
class AvahiServiceError(AvahiError):
289
232
pass
290
233
291
292
234
class AvahiGroupError(AvahiError):
293
235
pass
294
236
314
256
bus: dbus.SystemBus()
315
257
"""
316
258
317
def __init__(self,
318
interface = avahi.IF_UNSPEC,
319
name = None,
320
servicetype = None,
321
port = None,
322
TXT = None,
323
domain = "",
324
host = "",
325
max_renames = 32768,
326
protocol = avahi.PROTO_UNSPEC,
327
bus = None):
259
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
servicetype = None, port = None, TXT = None,
261
domain = "", host = "", max_renames = 32768,
262
protocol = avahi.PROTO_UNSPEC, bus = None):
328
263
self.interface = interface
329
264
self.name = name
330
265
self.type = servicetype
347
282
" after %i retries, exiting.",
348
283
self.rename_count)
349
284
raise AvahiServiceError("Too many renames")
350
self.name = str(
351
self.server.GetAlternativeServiceName(self.name))
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
352
287
self.rename_count += 1
353
288
logger.info("Changing Zeroconf service name to %r ...",
354
289
self.name)
409
344
elif state == avahi.ENTRY_GROUP_FAILURE:
410
345
logger.critical("Avahi: Error in group state changed %s",
411
346
str(error))
412
raise AvahiGroupError("State changed: {!s}".format(error))
347
raise AvahiGroupError("State changed: {!s}"
348
.format(error))
413
349
414
350
def cleanup(self):
415
351
"""Derived from the Avahi example code"""
425
361
def server_state_changed(self, state, error=None):
426
362
"""Derived from the Avahi example code"""
427
363
logger.debug("Avahi server state change: %i", state)
428
bad_states = {
429
avahi.SERVER_INVALID: "Zeroconf server invalid",
430
avahi.SERVER_REGISTERING: None,
431
avahi.SERVER_COLLISION: "Zeroconf server name collision",
432
avahi.SERVER_FAILURE: "Zeroconf server failure",
433
}
364
bad_states = { avahi.SERVER_INVALID:
365
"Zeroconf server invalid",
366
avahi.SERVER_REGISTERING: None,
367
avahi.SERVER_COLLISION:
368
"Zeroconf server name collision",
369
avahi.SERVER_FAILURE:
370
"Zeroconf server failure" }
434
371
if state in bad_states:
435
372
if bad_states[state] is not None:
436
373
if error is None:
439
376
logger.error(bad_states[state] + ": %r", error)
440
377
self.cleanup()
441
378
elif state == avahi.SERVER_RUNNING:
442
try:
443
self.add()
444
except dbus.exceptions.DBusException as error:
445
if (error.get_dbus_name()
446
== "org.freedesktop.Avahi.CollisionError"):
447
logger.info("Local Zeroconf service name"
448
" collision.")
449
return self.rename(remove=False)
450
else:
451
logger.critical("D-Bus Exception", exc_info=error)
452
self.cleanup()
453
os._exit(1)
379
self.add()
454
380
else:
455
381
if error is None:
456
382
logger.debug("Unknown state: %r", state)
466
392
follow_name_owner_changes=True),
467
393
avahi.DBUS_INTERFACE_SERVER)
468
394
self.server.connect_to_signal("StateChanged",
469
self.server_state_changed)
395
self.server_state_changed)
470
396
self.server_state_changed(self.server.GetState())
471
397
472
398
474
400
def rename(self, *args, **kwargs):
475
401
"""Add the new name to the syslog messages"""
476
402
ret = AvahiService.rename(self, *args, **kwargs)
477
syslogger.setFormatter(logging.Formatter(
478
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
479
.format(self.name)))
403
syslogger.setFormatter(logging.Formatter
404
('Mandos ({}) [%(process)d]:'
405
' %(levelname)s: %(message)s'
406
.format(self.name)))
480
407
return ret
481
408
482
# Pretend that we have a GnuTLS module
483
class GnuTLS(object):
484
"""This isn't so much a class as it is a module-like namespace.
485
It is instantiated once, and simulates having a GnuTLS module."""
486
487
_library = ctypes.cdll.LoadLibrary(
488
ctypes.util.find_library("gnutls"))
489
_need_version = b"3.3.0"
490
def __init__(self):
491
# Need to use class name "GnuTLS" here, since this method is
492
# called before the assignment to the "gnutls" global variable
493
# happens.
494
if GnuTLS.check_version(self._need_version) is None:
495
raise GnuTLS.Error("Needs GnuTLS {} or later"
496
.format(self._need_version))
497
498
# Unless otherwise indicated, the constants and types below are
499
# all from the gnutls/gnutls.h C header file.
500
501
# Constants
502
E_SUCCESS = 0
503
E_INTERRUPTED = -52
504
E_AGAIN = -28
505
CRT_OPENPGP = 2
506
CLIENT = 2
507
SHUT_RDWR = 0
508
CRD_CERTIFICATE = 1
509
E_NO_CERTIFICATE_FOUND = -49
510
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
511
512
# Types
513
class session_int(ctypes.Structure):
514
_fields_ = []
515
session_t = ctypes.POINTER(session_int)
516
class certificate_credentials_st(ctypes.Structure):
517
_fields_ = []
518
certificate_credentials_t = ctypes.POINTER(
519
certificate_credentials_st)
520
certificate_type_t = ctypes.c_int
521
class datum_t(ctypes.Structure):
522
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
523
('size', ctypes.c_uint)]
524
class openpgp_crt_int(ctypes.Structure):
525
_fields_ = []
526
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
527
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
528
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
529
credentials_type_t = ctypes.c_int
530
transport_ptr_t = ctypes.c_void_p
531
close_request_t = ctypes.c_int
532
533
# Exceptions
534
class Error(Exception):
535
# We need to use the class name "GnuTLS" here, since this
536
# exception might be raised from within GnuTLS.__init__,
537
# which is called before the assignment to the "gnutls"
538
# global variable has happened.
539
def __init__(self, message = None, code = None, args=()):
540
# Default usage is by a message string, but if a return
541
# code is passed, convert it to a string with
542
# gnutls.strerror()
543
self.code = code
544
if message is None and code is not None:
545
message = GnuTLS.strerror(code)
546
return super(GnuTLS.Error, self).__init__(
547
message, *args)
548
549
class CertificateSecurityError(Error):
550
pass
551
552
# Classes
553
class Credentials(object):
554
def __init__(self):
555
self._c_object = gnutls.certificate_credentials_t()
556
gnutls.certificate_allocate_credentials(
557
ctypes.byref(self._c_object))
558
self.type = gnutls.CRD_CERTIFICATE
559
560
def __del__(self):
561
gnutls.certificate_free_credentials(self._c_object)
562
563
class ClientSession(object):
564
def __init__(self, socket, credentials = None):
565
self._c_object = gnutls.session_t()
566
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
567
gnutls.set_default_priority(self._c_object)
568
gnutls.transport_set_ptr(self._c_object, socket.fileno())
569
gnutls.handshake_set_private_extensions(self._c_object,
570
True)
571
self.socket = socket
572
if credentials is None:
573
credentials = gnutls.Credentials()
574
gnutls.credentials_set(self._c_object, credentials.type,
575
ctypes.cast(credentials._c_object,
576
ctypes.c_void_p))
577
self.credentials = credentials
578
579
def __del__(self):
580
gnutls.deinit(self._c_object)
581
582
def handshake(self):
583
return gnutls.handshake(self._c_object)
584
585
def send(self, data):
586
data = bytes(data)
587
data_len = len(data)
588
while data_len > 0:
589
data_len -= gnutls.record_send(self._c_object,
590
data[-data_len:],
591
data_len)
592
593
def bye(self):
594
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
595
596
# Error handling functions
597
def _error_code(result):
598
"""A function to raise exceptions on errors, suitable
599
for the 'restype' attribute on ctypes functions"""
600
if result >= 0:
601
return result
602
if result == gnutls.E_NO_CERTIFICATE_FOUND:
603
raise gnutls.CertificateSecurityError(code = result)
604
raise gnutls.Error(code = result)
605
606
def _retry_on_error(result, func, arguments):
607
"""A function to retry on some errors, suitable
608
for the 'errcheck' attribute on ctypes functions"""
609
while result < 0:
610
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
611
return _error_code(result)
612
result = func(*arguments)
613
return result
614
615
# Unless otherwise indicated, the function declarations below are
616
# all from the gnutls/gnutls.h C header file.
617
618
# Functions
619
priority_set_direct = _library.gnutls_priority_set_direct
620
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
621
ctypes.POINTER(ctypes.c_char_p)]
622
priority_set_direct.restype = _error_code
623
624
init = _library.gnutls_init
625
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
626
init.restype = _error_code
627
628
set_default_priority = _library.gnutls_set_default_priority
629
set_default_priority.argtypes = [session_t]
630
set_default_priority.restype = _error_code
631
632
record_send = _library.gnutls_record_send
633
record_send.argtypes = [session_t, ctypes.c_void_p,
634
ctypes.c_size_t]
635
record_send.restype = ctypes.c_ssize_t
636
record_send.errcheck = _retry_on_error
637
638
certificate_allocate_credentials = (
639
_library.gnutls_certificate_allocate_credentials)
640
certificate_allocate_credentials.argtypes = [
641
ctypes.POINTER(certificate_credentials_t)]
642
certificate_allocate_credentials.restype = _error_code
643
644
certificate_free_credentials = (
645
_library.gnutls_certificate_free_credentials)
646
certificate_free_credentials.argtypes = [certificate_credentials_t]
647
certificate_free_credentials.restype = None
648
649
handshake_set_private_extensions = (
650
_library.gnutls_handshake_set_private_extensions)
651
handshake_set_private_extensions.argtypes = [session_t,
652
ctypes.c_int]
653
handshake_set_private_extensions.restype = None
654
655
credentials_set = _library.gnutls_credentials_set
656
credentials_set.argtypes = [session_t, credentials_type_t,
657
ctypes.c_void_p]
658
credentials_set.restype = _error_code
659
660
strerror = _library.gnutls_strerror
661
strerror.argtypes = [ctypes.c_int]
662
strerror.restype = ctypes.c_char_p
663
664
certificate_type_get = _library.gnutls_certificate_type_get
665
certificate_type_get.argtypes = [session_t]
666
certificate_type_get.restype = _error_code
667
668
certificate_get_peers = _library.gnutls_certificate_get_peers
669
certificate_get_peers.argtypes = [session_t,
670
ctypes.POINTER(ctypes.c_uint)]
671
certificate_get_peers.restype = ctypes.POINTER(datum_t)
672
673
global_set_log_level = _library.gnutls_global_set_log_level
674
global_set_log_level.argtypes = [ctypes.c_int]
675
global_set_log_level.restype = None
676
677
global_set_log_function = _library.gnutls_global_set_log_function
678
global_set_log_function.argtypes = [log_func]
679
global_set_log_function.restype = None
680
681
deinit = _library.gnutls_deinit
682
deinit.argtypes = [session_t]
683
deinit.restype = None
684
685
handshake = _library.gnutls_handshake
686
handshake.argtypes = [session_t]
687
handshake.restype = _error_code
688
handshake.errcheck = _retry_on_error
689
690
transport_set_ptr = _library.gnutls_transport_set_ptr
691
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
692
transport_set_ptr.restype = None
693
694
bye = _library.gnutls_bye
695
bye.argtypes = [session_t, close_request_t]
696
bye.restype = _error_code
697
bye.errcheck = _retry_on_error
698
699
check_version = _library.gnutls_check_version
700
check_version.argtypes = [ctypes.c_char_p]
701
check_version.restype = ctypes.c_char_p
702
703
# All the function declarations below are from gnutls/openpgp.h
704
705
openpgp_crt_init = _library.gnutls_openpgp_crt_init
706
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
707
openpgp_crt_init.restype = _error_code
708
709
openpgp_crt_import = _library.gnutls_openpgp_crt_import
710
openpgp_crt_import.argtypes = [openpgp_crt_t,
711
ctypes.POINTER(datum_t),
712
openpgp_crt_fmt_t]
713
openpgp_crt_import.restype = _error_code
714
715
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
716
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
717
ctypes.POINTER(ctypes.c_uint)]
718
openpgp_crt_verify_self.restype = _error_code
719
720
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
721
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
722
openpgp_crt_deinit.restype = None
723
724
openpgp_crt_get_fingerprint = (
725
_library.gnutls_openpgp_crt_get_fingerprint)
726
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
727
ctypes.c_void_p,
728
ctypes.POINTER(
729
ctypes.c_size_t)]
730
openpgp_crt_get_fingerprint.restype = _error_code
731
732
# Remove non-public functions
733
del _error_code, _retry_on_error
734
# Create the global "gnutls" object, simulating a module
735
gnutls = GnuTLS()
736
737
def call_pipe(connection, # : multiprocessing.Connection
738
func, *args, **kwargs):
739
"""This function is meant to be called by multiprocessing.Process
740
741
This function runs func(*args, **kwargs), and writes the resulting
742
return value on the provided multiprocessing.Connection.
743
"""
744
connection.send(func(*args, **kwargs))
745
connection.close()
746
409
747
410
class Client(object):
748
411
"""A representation of a client host served by this server.
754
417
checker: subprocess.Popen(); a running checker process used
755
418
to see if the client lives.
756
419
'None' if no process is running.
757
checker_callback_tag: a GLib event source tag, or None
420
checker_callback_tag: a gobject event source tag, or None
758
421
checker_command: string; External command which is run to check
759
422
if client lives. %() expansions are done at
760
423
runtime with vars(self) as dict, so that for
761
424
instance %(name)s can be used in the command.
762
checker_initiator_tag: a GLib event source tag, or None
425
checker_initiator_tag: a gobject event source tag, or None
763
426
created: datetime.datetime(); (UTC) object creation
764
427
client_structure: Object describing what attributes a client has
765
428
and is used for storing the client at exit
766
429
current_checker_command: string; current running checker_command
767
disable_initiator_tag: a GLib event source tag, or None
430
disable_initiator_tag: a gobject event source tag, or None
768
431
enabled: bool()
769
432
fingerprint: string (40 or 32 hexadecimal digits); used to
770
433
uniquely identify the client
775
438
last_checker_status: integer between 0 and 255 reflecting exit
776
439
status of last checker. -1 reflects crashed
777
440
checker, -2 means no checker completed yet.
778
last_checker_signal: The signal which killed the last checker, if
779
last_checker_status is -1
780
441
last_enabled: datetime.datetime(); (UTC) or None
781
442
name: string; from the config file, used in log messages and
782
443
D-Bus identifiers
795
456
"fingerprint", "host", "interval",
796
457
"last_approval_request", "last_checked_ok",
797
458
"last_enabled", "name", "timeout")
798
client_defaults = {
799
"timeout": "PT5M",
800
"extended_timeout": "PT15M",
801
"interval": "PT2M",
802
"checker": "fping -q -- %%(host)s",
803
"host": "",
804
"approval_delay": "PT0S",
805
"approval_duration": "PT1S",
806
"approved_by_default": "True",
807
"enabled": "True",
808
}
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
461
"interval": "PT2M",
462
"checker": "fping -q -- %%(host)s",
463
"host": "",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
466
"approved_by_default": "True",
467
"enabled": "True",
468
}
809
469
810
470
@staticmethod
811
471
def config_parser(config):
827
487
client["enabled"] = config.getboolean(client_name,
828
488
"enabled")
829
489
830
# Uppercase and remove spaces from fingerprint for later
831
# comparison purposes with return value from the
832
# fingerprint() function
833
490
client["fingerprint"] = (section["fingerprint"].upper()
834
491
.replace(" ", ""))
835
492
if "secret" in section:
836
client["secret"] = codecs.decode(section["secret"]
837
.encode("utf-8"),
838
"base64")
493
client["secret"] = section["secret"].decode("base64")
839
494
elif "secfile" in section:
840
495
with open(os.path.expanduser(os.path.expandvars
841
496
(section["secfile"])),
879
534
self.expires = None
880
535
881
536
logger.debug("Creating client %r", self.name)
537
# Uppercase and remove spaces from fingerprint for later
538
# comparison purposes with return value from the fingerprint()
539
# function
882
540
logger.debug(" Fingerprint: %s", self.fingerprint)
883
541
self.created = settings.get("created",
884
542
datetime.datetime.utcnow())
891
549
self.current_checker_command = None
892
550
self.approved = None
893
551
self.approvals_pending = 0
894
self.changedstate = multiprocessing_manager.Condition(
895
multiprocessing_manager.Lock())
896
self.client_structure = [attr
897
for attr in self.__dict__.keys()
552
self.changedstate = (multiprocessing_manager
553
.Condition(multiprocessing_manager
554
.Lock()))
555
self.client_structure = [attr for attr in
556
self.__dict__.iterkeys()
898
557
if not attr.startswith("_")]
899
558
self.client_structure.append("client_structure")
900
559
901
for name, t in inspect.getmembers(
902
type(self), lambda obj: isinstance(obj, property)):
560
for name, t in inspect.getmembers(type(self),
561
lambda obj:
562
isinstance(obj,
563
property)):
903
564
if not name.startswith("_"):
904
565
self.client_structure.append(name)
905
566
926
587
if not quiet:
927
588
logger.info("Disabling client %s", self.name)
928
589
if getattr(self, "disable_initiator_tag", None) is not None:
929
GLib.source_remove(self.disable_initiator_tag)
590
gobject.source_remove(self.disable_initiator_tag)
930
591
self.disable_initiator_tag = None
931
592
self.expires = None
932
593
if getattr(self, "checker_initiator_tag", None) is not None:
933
GLib.source_remove(self.checker_initiator_tag)
594
gobject.source_remove(self.checker_initiator_tag)
934
595
self.checker_initiator_tag = None
935
596
self.stop_checker()
936
597
self.enabled = False
937
598
if not quiet:
938
599
self.send_changedstate()
939
# Do not run this again if called by a GLib.timeout_add
600
# Do not run this again if called by a gobject.timeout_add
940
601
return False
941
602
942
603
def __del__(self):
946
607
# Schedule a new checker to be started an 'interval' from now,
947
608
# and every interval from then on.
948
609
if self.checker_initiator_tag is not None:
949
GLib.source_remove(self.checker_initiator_tag)
950
self.checker_initiator_tag = GLib.timeout_add(
951
int(self.interval.total_seconds() * 1000),
952
self.start_checker)
610
gobject.source_remove(self.checker_initiator_tag)
611
self.checker_initiator_tag = (gobject.timeout_add
612
(int(self.interval
613
.total_seconds() * 1000),
614
self.start_checker))
953
615
# Schedule a disable() when 'timeout' has passed
954
616
if self.disable_initiator_tag is not None:
955
GLib.source_remove(self.disable_initiator_tag)
956
self.disable_initiator_tag = GLib.timeout_add(
957
int(self.timeout.total_seconds() * 1000), self.disable)
617
gobject.source_remove(self.disable_initiator_tag)
618
self.disable_initiator_tag = (gobject.timeout_add
619
(int(self.timeout
620
.total_seconds() * 1000),
621
self.disable))
958
622
# Also start a new checker *right now*.
959
623
self.start_checker()
960
624
961
def checker_callback(self, source, condition, connection,
962
command):
625
def checker_callback(self, pid, condition, command):
963
626
"""The checker has completed, so take appropriate actions."""
964
627
self.checker_callback_tag = None
965
628
self.checker = None
966
# Read return code from connection (see call_pipe)
967
returncode = connection.recv()
968
connection.close()
969
970
if returncode >= 0:
971
self.last_checker_status = returncode
972
self.last_checker_signal = None
629
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
973
631
if self.last_checker_status == 0:
974
632
logger.info("Checker for %(name)s succeeded",
975
633
vars(self))
976
634
self.checked_ok()
977
635
else:
978
logger.info("Checker for %(name)s failed", vars(self))
636
logger.info("Checker for %(name)s failed",
637
vars(self))
979
638
else:
980
639
self.last_checker_status = -1
981
self.last_checker_signal = -returncode
982
640
logger.warning("Checker for %(name)s crashed?",
983
641
vars(self))
984
return False
985
642
986
643
def checked_ok(self):
987
644
"""Assert that the client has been seen, alive and well."""
988
645
self.last_checked_ok = datetime.datetime.utcnow()
989
646
self.last_checker_status = 0
990
self.last_checker_signal = None
991
647
self.bump_timeout()
992
648
993
649
def bump_timeout(self, timeout=None):
995
651
if timeout is None:
996
652
timeout = self.timeout
997
653
if self.disable_initiator_tag is not None:
998
GLib.source_remove(self.disable_initiator_tag)
654
gobject.source_remove(self.disable_initiator_tag)
999
655
self.disable_initiator_tag = None
1000
656
if getattr(self, "enabled", False):
1001
self.disable_initiator_tag = GLib.timeout_add(
1002
int(timeout.total_seconds() * 1000), self.disable)
657
self.disable_initiator_tag = (gobject.timeout_add
658
(int(timeout.total_seconds()
659
* 1000), self.disable))
1003
660
self.expires = datetime.datetime.utcnow() + timeout
1004
661
1005
662
def need_approval(self):
1019
676
# than 'timeout' for the client to be disabled, which is as it
1020
677
# should be.
1021
678
1022
if self.checker is not None and not self.checker.is_alive():
1023
logger.warning("Checker was not alive; joining")
1024
self.checker.join()
1025
self.checker = None
679
# If a checker exists, make sure it is not a zombie
680
try:
681
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
except AttributeError:
683
pass
684
except OSError as error:
685
if error.errno != errno.ECHILD:
686
raise
687
else:
688
if pid:
689
logger.warning("Checker was a zombie")
690
gobject.source_remove(self.checker_callback_tag)
691
self.checker_callback(pid, status,
692
self.current_checker_command)
1026
693
# Start a new checker if needed
1027
694
if self.checker is None:
1028
695
# Escape attributes for the shell
1029
escaped_attrs = {
1030
attr: re.escape(str(getattr(self, attr)))
1031
for attr in self.runtime_expansions }
696
escaped_attrs = { attr:
697
re.escape(str(getattr(self, attr)))
698
for attr in self.runtime_expansions }
1032
699
try:
1033
700
command = self.checker_command % escaped_attrs
1034
701
except TypeError as error:
1035
702
logger.error('Could not format string "%s"',
1036
self.checker_command,
703
self.checker_command, exc_info=error)
704
return True # Try again later
705
self.current_checker_command = command
706
try:
707
logger.info("Starting checker %r for %s",
708
command, self.name)
709
# We don't need to redirect stdout and stderr, since
710
# in normal mode, that is already done by daemon(),
711
# and in debug mode we don't want to. (Stdin is
712
# always replaced by /dev/null.)
713
# The exception is when not debugging but nevertheless
714
# running in the foreground; use the previously
715
# created wnull.
716
popen_args = {}
717
if (not self.server_settings["debug"]
718
and self.server_settings["foreground"]):
719
popen_args.update({"stdout": wnull,
720
"stderr": wnull })
721
self.checker = subprocess.Popen(command,
722
close_fds=True,
723
shell=True, cwd="/",
724
**popen_args)
725
except OSError as error:
726
logger.error("Failed to start subprocess",
1037
727
exc_info=error)
1038
return True # Try again later
1039
self.current_checker_command = command
1040
logger.info("Starting checker %r for %s", command,
1041
self.name)
1042
# We don't need to redirect stdout and stderr, since
1043
# in normal mode, that is already done by daemon(),
1044
# and in debug mode we don't want to. (Stdin is
1045
# always replaced by /dev/null.)
1046
# The exception is when not debugging but nevertheless
1047
# running in the foreground; use the previously
1048
# created wnull.
1049
popen_args = { "close_fds": True,
1050
"shell": True,
1051
"cwd": "/" }
1052
if (not self.server_settings["debug"]
1053
and self.server_settings["foreground"]):
1054
popen_args.update({"stdout": wnull,
1055
"stderr": wnull })
1056
pipe = multiprocessing.Pipe(duplex = False)
1057
self.checker = multiprocessing.Process(
1058
target = call_pipe,
1059
args = (pipe[1], subprocess.call, command),
1060
kwargs = popen_args)
1061
self.checker.start()
1062
self.checker_callback_tag = GLib.io_add_watch(
1063
pipe[0].fileno(), GLib.IO_IN,
1064
self.checker_callback, pipe[0], command)
1065
# Re-run this periodically if run by GLib.timeout_add
728
return True
729
self.checker_callback_tag = (gobject.child_watch_add
730
(self.checker.pid,
731
self.checker_callback,
732
data=command))
733
# The checker may have completed before the gobject
734
# watch was added. Check for this.
735
try:
736
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
737
except OSError as error:
738
if error.errno == errno.ECHILD:
739
# This should never happen
740
logger.error("Child process vanished",
741
exc_info=error)
742
return True
743
raise
744
if pid:
745
gobject.source_remove(self.checker_callback_tag)
746
self.checker_callback(pid, status, command)
747
# Re-run this periodically if run by gobject.timeout_add
1066
748
return True
1067
749
1068
750
def stop_checker(self):
1069
751
"""Force the checker process, if any, to stop."""
1070
752
if self.checker_callback_tag:
1071
GLib.source_remove(self.checker_callback_tag)
753
gobject.source_remove(self.checker_callback_tag)
1072
754
self.checker_callback_tag = None
1073
755
if getattr(self, "checker", None) is None:
1074
756
return
1075
757
logger.debug("Stopping checker for %(name)s", vars(self))
1076
self.checker.terminate()
758
try:
759
self.checker.terminate()
760
#time.sleep(0.5)
761
#if self.checker.poll() is None:
762
# self.checker.kill()
763
except OSError as error:
764
if error.errno != errno.ESRCH: # No such process
765
raise
1077
766
self.checker = None
1078
767
1079
768
1080
def dbus_service_property(dbus_interface,
1081
signature="v",
1082
access="readwrite",
1083
byte_arrays=False):
769
def dbus_service_property(dbus_interface, signature="v",
770
access="readwrite", byte_arrays=False):
1084
771
"""Decorators for marking methods of a DBusObjectWithProperties to
1085
772
become properties on the D-Bus.
1086
773
1096
783
if byte_arrays and signature != "ay":
1097
784
raise ValueError("Byte arrays not supported for non-'ay'"
1098
785
" signature {!r}".format(signature))
1099
1100
786
def decorator(func):
1101
787
func._dbus_is_property = True
1102
788
func._dbus_interface = dbus_interface
1107
793
func._dbus_name = func._dbus_name[:-14]
1108
794
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1109
795
return func
1110
1111
796
return decorator
1112
797
1113
798
1122
807
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1123
808
"false"}
1124
809
"""
1125
1126
810
def decorator(func):
1127
811
func._dbus_is_interface = True
1128
812
func._dbus_interface = dbus_interface
1129
813
func._dbus_name = dbus_interface
1130
814
return func
1131
1132
815
return decorator
1133
816
1134
817
1143
826
access="r")
1144
827
def Property_dbus_property(self):
1145
828
return dbus.Boolean(False)
1146
1147
See also the DBusObjectWithAnnotations class.
1148
829
"""
1149
1150
830
def decorator(func):
1151
831
func._dbus_annotations = annotations
1152
832
return func
1153
1154
833
return decorator
1155
834
1156
835
1159
838
"""
1160
839
pass
1161
840
1162
1163
841
class DBusPropertyAccessException(DBusPropertyException):
1164
842
"""A property's access permissions disallows an operation.
1165
843
"""
1172
850
pass
1173
851
1174
852
1175
class DBusObjectWithAnnotations(dbus.service.Object):
1176
"""A D-Bus object with annotations.
853
class DBusObjectWithProperties(dbus.service.Object):
854
"""A D-Bus object with properties.
1177
855
1178
Classes inheriting from this can use the dbus_annotations
1179
decorator to add annotations to methods or signals.
856
Classes inheriting from this can use the dbus_service_property
857
decorator to expose methods as D-Bus properties. It exposes the
858
standard Get(), Set(), and GetAll() methods on the D-Bus.
1180
859
"""
1181
860
1182
861
@staticmethod
1192
871
def _get_all_dbus_things(self, thing):
1193
872
"""Returns a generator of (name, attribute) pairs
1194
873
"""
1195
return ((getattr(athing.__get__(self), "_dbus_name", name),
874
return ((getattr(athing.__get__(self), "_dbus_name",
875
name),
1196
876
athing.__get__(self))
1197
877
for cls in self.__class__.__mro__
1198
878
for name, athing in
1199
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1200
1201
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1202
out_signature = "s",
1203
path_keyword = 'object_path',
1204
connection_keyword = 'connection')
1205
def Introspect(self, object_path, connection):
1206
"""Overloading of standard D-Bus method.
1207
1208
Inserts annotation tags on methods and signals.
1209
"""
1210
xmlstring = dbus.service.Object.Introspect(self, object_path,
1211
connection)
1212
try:
1213
document = xml.dom.minidom.parseString(xmlstring)
1214
1215
for if_tag in document.getElementsByTagName("interface"):
1216
# Add annotation tags
1217
for typ in ("method", "signal"):
1218
for tag in if_tag.getElementsByTagName(typ):
1219
annots = dict()
1220
for name, prop in (self.
1221
_get_all_dbus_things(typ)):
1222
if (name == tag.getAttribute("name")
1223
and prop._dbus_interface
1224
== if_tag.getAttribute("name")):
1225
annots.update(getattr(
1226
prop, "_dbus_annotations", {}))
1227
for name, value in annots.items():
1228
ann_tag = document.createElement(
1229
"annotation")
1230
ann_tag.setAttribute("name", name)
1231
ann_tag.setAttribute("value", value)
1232
tag.appendChild(ann_tag)
1233
# Add interface annotation tags
1234
for annotation, value in dict(
1235
itertools.chain.from_iterable(
1236
annotations().items()
1237
for name, annotations
1238
in self._get_all_dbus_things("interface")
1239
if name == if_tag.getAttribute("name")
1240
)).items():
1241
ann_tag = document.createElement("annotation")
1242
ann_tag.setAttribute("name", annotation)
1243
ann_tag.setAttribute("value", value)
1244
if_tag.appendChild(ann_tag)
1245
# Fix argument name for the Introspect method itself
1246
if (if_tag.getAttribute("name")
1247
== dbus.INTROSPECTABLE_IFACE):
1248
for cn in if_tag.getElementsByTagName("method"):
1249
if cn.getAttribute("name") == "Introspect":
1250
for arg in cn.getElementsByTagName("arg"):
1251
if (arg.getAttribute("direction")
1252
== "out"):
1253
arg.setAttribute("name",
1254
"xml_data")
1255
xmlstring = document.toxml("utf-8")
1256
document.unlink()
1257
except (AttributeError, xml.dom.DOMException,
1258
xml.parsers.expat.ExpatError) as error:
1259
logger.error("Failed to override Introspection method",
1260
exc_info=error)
1261
return xmlstring
1262
1263
1264
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1265
"""A D-Bus object with properties.
1266
1267
Classes inheriting from this can use the dbus_service_property
1268
decorator to expose methods as D-Bus properties. It exposes the
1269
standard Get(), Set(), and GetAll() methods on the D-Bus.
1270
"""
879
inspect.getmembers(cls,
880
self._is_dbus_thing(thing)))
1271
881
1272
882
def _get_dbus_property(self, interface_name, property_name):
1273
883
"""Returns a bound method if one exists which is a D-Bus
1274
884
property with the specified name and interface.
1275
885
"""
1276
for cls in self.__class__.__mro__:
1277
for name, value in inspect.getmembers(
1278
cls, self._is_dbus_thing("property")):
886
for cls in self.__class__.__mro__:
887
for name, value in (inspect.getmembers
888
(cls,
889
self._is_dbus_thing("property"))):
1279
890
if (value._dbus_name == property_name
1280
891
and value._dbus_interface == interface_name):
1281
892
return value.__get__(self)
1282
893
1283
894
# No such property
1284
raise DBusPropertyNotFound("{}:{}.{}".format(
1285
self.dbus_object_path, interface_name, property_name))
1286
1287
@classmethod
1288
def _get_all_interface_names(cls):
1289
"""Get a sequence of all interfaces supported by an object"""
1290
return (name for name in set(getattr(getattr(x, attr),
1291
"_dbus_interface", None)
1292
for x in (inspect.getmro(cls))
1293
for attr in dir(x))
1294
if name is not None)
1295
1296
@dbus.service.method(dbus.PROPERTIES_IFACE,
1297
in_signature="ss",
895
raise DBusPropertyNotFound(self.dbus_object_path + ":"
896
+ interface_name + "."
897
+ property_name)
898
899
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1298
900
out_signature="v")
1299
901
def Get(self, interface_name, property_name):
1300
902
"""Standard D-Bus property Get() method, see D-Bus standard.
1325
927
for byte in value))
1326
928
prop(value)
1327
929
1328
@dbus.service.method(dbus.PROPERTIES_IFACE,
1329
in_signature="s",
930
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1330
931
out_signature="a{sv}")
1331
932
def GetAll(self, interface_name):
1332
933
"""Standard D-Bus property GetAll() method, see D-Bus
1347
948
if not hasattr(value, "variant_level"):
1348
949
properties[name] = value
1349
950
continue
1350
properties[name] = type(value)(
1351
value, variant_level = value.variant_level + 1)
951
properties[name] = type(value)(value, variant_level=
952
value.variant_level+1)
1352
953
return dbus.Dictionary(properties, signature="sv")
1353
954
1354
955
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1368
969
1369
970
Inserts property tags and interface annotation tags.
1370
971
"""
1371
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1372
object_path,
1373
connection)
972
xmlstring = dbus.service.Object.Introspect(self, object_path,
973
connection)
1374
974
try:
1375
975
document = xml.dom.minidom.parseString(xmlstring)
1376
1377
976
def make_tag(document, name, prop):
1378
977
e = document.createElement("property")
1379
978
e.setAttribute("name", name)
1380
979
e.setAttribute("type", prop._dbus_signature)
1381
980
e.setAttribute("access", prop._dbus_access)
1382
981
return e
1383
1384
982
for if_tag in document.getElementsByTagName("interface"):
1385
983
# Add property tags
1386
984
for tag in (make_tag(document, name, prop)
1389
987
if prop._dbus_interface
1390
988
== if_tag.getAttribute("name")):
1391
989
if_tag.appendChild(tag)
1392
# Add annotation tags for properties
1393
for tag in if_tag.getElementsByTagName("property"):
1394
annots = dict()
1395
for name, prop in self._get_all_dbus_things(
1396
"property"):
1397
if (name == tag.getAttribute("name")
1398
and prop._dbus_interface
1399
== if_tag.getAttribute("name")):
1400
annots.update(getattr(
1401
prop, "_dbus_annotations", {}))
1402
for name, value in annots.items():
1403
ann_tag = document.createElement(
1404
"annotation")
1405
ann_tag.setAttribute("name", name)
1406
ann_tag.setAttribute("value", value)
1407
tag.appendChild(ann_tag)
990
# Add annotation tags
991
for typ in ("method", "signal", "property"):
992
for tag in if_tag.getElementsByTagName(typ):
993
annots = dict()
994
for name, prop in (self.
995
_get_all_dbus_things(typ)):
996
if (name == tag.getAttribute("name")
997
and prop._dbus_interface
998
== if_tag.getAttribute("name")):
999
annots.update(getattr
1000
(prop,
1001
"_dbus_annotations",
1002
{}))
1003
for name, value in annots.items():
1004
ann_tag = document.createElement(
1005
"annotation")
1006
ann_tag.setAttribute("name", name)
1007
ann_tag.setAttribute("value", value)
1008
tag.appendChild(ann_tag)
1009
# Add interface annotation tags
1010
for annotation, value in dict(
1011
itertools.chain.from_iterable(
1012
annotations().items()
1013
for name, annotations in
1014
self._get_all_dbus_things("interface")
1015
if name == if_tag.getAttribute("name")
1016
)).items():
1017
ann_tag = document.createElement("annotation")
1018
ann_tag.setAttribute("name", annotation)
1019
ann_tag.setAttribute("value", value)
1020
if_tag.appendChild(ann_tag)
1408
1021
# Add the names to the return values for the
1409
1022
# "org.freedesktop.DBus.Properties" methods
1410
1023
if (if_tag.getAttribute("name")
1428
1041
exc_info=error)
1429
1042
return xmlstring
1430
1043
1431
try:
1432
dbus.OBJECT_MANAGER_IFACE
1433
except AttributeError:
1434
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1435
1436
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1437
"""A D-Bus object with an ObjectManager.
1438
1439
Classes inheriting from this exposes the standard
1440
GetManagedObjects call and the InterfacesAdded and
1441
InterfacesRemoved signals on the standard
1442
"org.freedesktop.DBus.ObjectManager" interface.
1443
1444
Note: No signals are sent automatically; they must be sent
1445
manually.
1446
"""
1447
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1448
out_signature = "a{oa{sa{sv}}}")
1449
def GetManagedObjects(self):
1450
"""This function must be overridden"""
1451
raise NotImplementedError()
1452
1453
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1454
signature = "oa{sa{sv}}")
1455
def InterfacesAdded(self, object_path, interfaces_and_properties):
1456
pass
1457
1458
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1459
def InterfacesRemoved(self, object_path, interfaces):
1460
pass
1461
1462
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1463
out_signature = "s",
1464
path_keyword = 'object_path',
1465
connection_keyword = 'connection')
1466
def Introspect(self, object_path, connection):
1467
"""Overloading of standard D-Bus method.
1468
1469
Override return argument name of GetManagedObjects to be
1470
"objpath_interfaces_and_properties"
1471
"""
1472
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1473
object_path,
1474
connection)
1475
try:
1476
document = xml.dom.minidom.parseString(xmlstring)
1477
1478
for if_tag in document.getElementsByTagName("interface"):
1479
# Fix argument name for the GetManagedObjects method
1480
if (if_tag.getAttribute("name")
1481
== dbus.OBJECT_MANAGER_IFACE):
1482
for cn in if_tag.getElementsByTagName("method"):
1483
if (cn.getAttribute("name")
1484
== "GetManagedObjects"):
1485
for arg in cn.getElementsByTagName("arg"):
1486
if (arg.getAttribute("direction")
1487
== "out"):
1488
arg.setAttribute(
1489
"name",
1490
"objpath_interfaces"
1491
"_and_properties")
1492
xmlstring = document.toxml("utf-8")
1493
document.unlink()
1494
except (AttributeError, xml.dom.DOMException,
1495
xml.parsers.expat.ExpatError) as error:
1496
logger.error("Failed to override Introspection method",
1497
exc_info = error)
1498
return xmlstring
1499
1044
1500
1045
def datetime_to_dbus(dt, variant_level=0):
1501
1046
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1502
1047
if dt is None:
1503
1048
return dbus.String("", variant_level = variant_level)
1504
return dbus.String(dt.isoformat(), variant_level=variant_level)
1049
return dbus.String(dt.isoformat(),
1050
variant_level=variant_level)
1505
1051
1506
1052
1507
1053
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1527
1073
(from DBusObjectWithProperties) and interfaces (from the
1528
1074
dbus_interface_annotations decorator).
1529
1075
"""
1530
1531
1076
def wrapper(cls):
1532
1077
for orig_interface_name, alt_interface_name in (
1533
alt_interface_names.items()):
1078
alt_interface_names.items()):
1534
1079
attr = {}
1535
1080
interface_names = set()
1536
1081
# Go though all attributes of the class
1538
1083
# Ignore non-D-Bus attributes, and D-Bus attributes
1539
1084
# with the wrong interface name
1540
1085
if (not hasattr(attribute, "_dbus_interface")
1541
or not attribute._dbus_interface.startswith(
1542
orig_interface_name)):
1086
or not attribute._dbus_interface
1087
.startswith(orig_interface_name)):
1543
1088
continue
1544
1089
# Create an alternate D-Bus interface name based on
1545
1090
# the current name
1546
alt_interface = attribute._dbus_interface.replace(
1547
orig_interface_name, alt_interface_name)
1091
alt_interface = (attribute._dbus_interface
1092
.replace(orig_interface_name,
1093
alt_interface_name))
1548
1094
interface_names.add(alt_interface)
1549
1095
# Is this a D-Bus signal?
1550
1096
if getattr(attribute, "_dbus_is_signal", False):
1551
1097
# Extract the original non-method undecorated
1552
1098
# function by black magic
1553
if sys.version_info.major == 2:
1554
nonmethod_func = (dict(
1099
nonmethod_func = (dict(
1555
1100
zip(attribute.func_code.co_freevars,
1556
attribute.__closure__))
1557
["func"].cell_contents)
1558
else:
1559
nonmethod_func = (dict(
1560
zip(attribute.__code__.co_freevars,
1561
attribute.__closure__))
1562
["func"].cell_contents)
1101
attribute.__closure__))["func"]
1102
.cell_contents)
1563
1103
# Create a new, but exactly alike, function
1564
1104
# object, and decorate it to be a new D-Bus signal
1565
1105
# with the alternate D-Bus interface name
1566
new_function = copy_function(nonmethod_func)
1567
new_function = (dbus.service.signal(
1568
alt_interface,
1569
attribute._dbus_signature)(new_function))
1106
new_function = (dbus.service.signal
1107
(alt_interface,
1108
attribute._dbus_signature)
1109
(types.FunctionType(
1110
nonmethod_func.func_code,
1111
nonmethod_func.func_globals,
1112
nonmethod_func.func_name,
1113
nonmethod_func.func_defaults,
1114
nonmethod_func.func_closure)))
1570
1115
# Copy annotations, if any
1571
1116
try:
1572
new_function._dbus_annotations = dict(
1573
attribute._dbus_annotations)
1117
new_function._dbus_annotations = (
1118
dict(attribute._dbus_annotations))
1574
1119
except AttributeError:
1575
1120
pass
1576
1121
# Define a creator of a function to call both the
1581
1126
"""This function is a scope container to pass
1582
1127
func1 and func2 to the "call_both" function
1583
1128
outside of its arguments"""
1584
1585
@functools.wraps(func2)
1586
1129
def call_both(*args, **kwargs):
1587
1130
"""This function will emit two D-Bus
1588
1131
signals by calling func1 and func2"""
1589
1132
func1(*args, **kwargs)
1590
1133
func2(*args, **kwargs)
1591
# Make wrapper function look like a D-Bus signal
1592
for name, attr in inspect.getmembers(func2):
1593
if name.startswith("_dbus_"):
1594
setattr(call_both, name, attr)
1595
1596
1134
return call_both
1597
1135
# Create the "call_both" function and add it to
1598
1136
# the class
1603
1141
# object. Decorate it to be a new D-Bus method
1604
1142
# with the alternate D-Bus interface name. Add it
1605
1143
# to the class.
1606
attr[attrname] = (
1607
dbus.service.method(
1608
alt_interface,
1609
attribute._dbus_in_signature,
1610
attribute._dbus_out_signature)
1611
(copy_function(attribute)))
1144
attr[attrname] = (dbus.service.method
1145
(alt_interface,
1146
attribute._dbus_in_signature,
1147
attribute._dbus_out_signature)
1148
(types.FunctionType
1149
(attribute.func_code,
1150
attribute.func_globals,
1151
attribute.func_name,
1152
attribute.func_defaults,
1153
attribute.func_closure)))
1612
1154
# Copy annotations, if any
1613
1155
try:
1614
attr[attrname]._dbus_annotations = dict(
1615
attribute._dbus_annotations)
1156
attr[attrname]._dbus_annotations = (
1157
dict(attribute._dbus_annotations))
1616
1158
except AttributeError:
1617
1159
pass
1618
1160
# Is this a D-Bus property?
1621
1163
# object, and decorate it to be a new D-Bus
1622
1164
# property with the alternate D-Bus interface
1623
1165
# name. Add it to the class.
1624
attr[attrname] = (dbus_service_property(
1625
alt_interface, attribute._dbus_signature,
1626
attribute._dbus_access,
1627
attribute._dbus_get_args_options
1628
["byte_arrays"])
1629
(copy_function(attribute)))
1166
attr[attrname] = (dbus_service_property
1167
(alt_interface,
1168
attribute._dbus_signature,
1169
attribute._dbus_access,
1170
attribute
1171
._dbus_get_args_options
1172
["byte_arrays"])
1173
(types.FunctionType
1174
(attribute.func_code,
1175
attribute.func_globals,
1176
attribute.func_name,
1177
attribute.func_defaults,
1178
attribute.func_closure)))
1630
1179
# Copy annotations, if any
1631
1180
try:
1632
attr[attrname]._dbus_annotations = dict(
1633
attribute._dbus_annotations)
1181
attr[attrname]._dbus_annotations = (
1182
dict(attribute._dbus_annotations))
1634
1183
except AttributeError:
1635
1184
pass
1636
1185
# Is this a D-Bus interface?
1639
1188
# object. Decorate it to be a new D-Bus interface
1640
1189
# with the alternate D-Bus interface name. Add it
1641
1190
# to the class.
1642
attr[attrname] = (
1643
dbus_interface_annotations(alt_interface)
1644
(copy_function(attribute)))
1191
attr[attrname] = (dbus_interface_annotations
1192
(alt_interface)
1193
(types.FunctionType
1194
(attribute.func_code,
1195
attribute.func_globals,
1196
attribute.func_name,
1197
attribute.func_defaults,
1198
attribute.func_closure)))
1645
1199
if deprecate:
1646
1200
# Deprecate all alternate interfaces
1647
1201
iname="_AlternateDBusNames_interface_annotation{}"
1648
1202
for interface_name in interface_names:
1649
1650
1203
@dbus_interface_annotations(interface_name)
1651
1204
def func(self):
1652
1205
return { "org.freedesktop.DBus.Deprecated":
1653
"true" }
1206
"true" }
1654
1207
# Find an unused name
1655
1208
for aname in (iname.format(i)
1656
1209
for i in itertools.count()):
1660
1213
if interface_names:
1661
1214
# Replace the class with a new subclass of it with
1662
1215
# methods, signals, etc. as created above.
1663
if sys.version_info.major == 2:
1664
cls = type(b"{}Alternate".format(cls.__name__),
1665
(cls, ), attr)
1666
else:
1667
cls = type("{}Alternate".format(cls.__name__),
1668
(cls, ), attr)
1216
cls = type(b"{}Alternate".format(cls.__name__),
1217
(cls,), attr)
1669
1218
return cls
1670
1671
1219
return wrapper
1672
1220
1673
1221
1674
1222
@alternate_dbus_interfaces({"se.recompile.Mandos":
1675
"se.bsnet.fukt.Mandos"})
1223
"se.bsnet.fukt.Mandos"})
1676
1224
class ClientDBus(Client, DBusObjectWithProperties):
1677
1225
"""A Client class using D-Bus
1678
1226
1682
1230
"""
1683
1231
1684
1232
runtime_expansions = (Client.runtime_expansions
1685
+ ("dbus_object_path", ))
1233
+ ("dbus_object_path",))
1686
1234
1687
1235
_interface = "se.recompile.Mandos.Client"
1688
1236
1696
1244
client_object_name = str(self.name).translate(
1697
1245
{ord("."): ord("_"),
1698
1246
ord("-"): ord("_")})
1699
self.dbus_object_path = dbus.ObjectPath(
1700
"/clients/" + client_object_name)
1247
self.dbus_object_path = (dbus.ObjectPath
1248
("/clients/" + client_object_name))
1701
1249
DBusObjectWithProperties.__init__(self, self.bus,
1702
1250
self.dbus_object_path)
1703
1251
1704
def notifychangeproperty(transform_func, dbus_name,
1705
type_func=lambda x: x,
1706
variant_level=1,
1707
invalidate_only=False,
1252
def notifychangeproperty(transform_func,
1253
dbus_name, type_func=lambda x: x,
1254
variant_level=1, invalidate_only=False,
1708
1255
_interface=_interface):
1709
1256
""" Modify a variable so that it's a property which announces
1710
1257
its changes to DBus.
1717
1264
variant_level: D-Bus variant level. Default: 1
1718
1265
"""
1719
1266
attrname = "_{}".format(dbus_name)
1720
1721
1267
def setter(self, value):
1722
1268
if hasattr(self, "dbus_object_path"):
1723
1269
if (not hasattr(self, attrname) or
1724
1270
type_func(getattr(self, attrname, None))
1725
1271
!= type_func(value)):
1726
1272
if invalidate_only:
1727
self.PropertiesChanged(
1728
_interface, dbus.Dictionary(),
1729
dbus.Array((dbus_name, )))
1273
self.PropertiesChanged(_interface,
1274
dbus.Dictionary(),
1275
dbus.Array
1276
((dbus_name,)))
1730
1277
else:
1731
dbus_value = transform_func(
1732
type_func(value),
1733
variant_level = variant_level)
1278
dbus_value = transform_func(type_func(value),
1279
variant_level
1280
=variant_level)
1734
1281
self.PropertyChanged(dbus.String(dbus_name),
1735
1282
dbus_value)
1736
self.PropertiesChanged(
1737
_interface,
1738
dbus.Dictionary({ dbus.String(dbus_name):
1739
dbus_value }),
1740
dbus.Array())
1283
self.PropertiesChanged(_interface,
1284
dbus.Dictionary({
1285
dbus.String(dbus_name):
1286
dbus_value }), dbus.Array())
1741
1287
setattr(self, attrname, value)
1742
1288
1743
1289
return property(lambda self: getattr(self, attrname), setter)
1749
1295
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1750
1296
last_enabled = notifychangeproperty(datetime_to_dbus,
1751
1297
"LastEnabled")
1752
checker = notifychangeproperty(
1753
dbus.Boolean, "CheckerRunning",
1754
type_func = lambda checker: checker is not None)
1298
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1299
type_func = lambda checker:
1300
checker is not None)
1755
1301
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1756
1302
"LastCheckedOK")
1757
1303
last_checker_status = notifychangeproperty(dbus.Int16,
1760
1306
datetime_to_dbus, "LastApprovalRequest")
1761
1307
approved_by_default = notifychangeproperty(dbus.Boolean,
1762
1308
"ApprovedByDefault")
1763
approval_delay = notifychangeproperty(
1764
dbus.UInt64, "ApprovalDelay",
1765
type_func = lambda td: td.total_seconds() * 1000)
1309
approval_delay = notifychangeproperty(dbus.UInt64,
1310
"ApprovalDelay",
1311
type_func =
1312
lambda td: td.total_seconds()
1313
* 1000)
1766
1314
approval_duration = notifychangeproperty(
1767
1315
dbus.UInt64, "ApprovalDuration",
1768
1316
type_func = lambda td: td.total_seconds() * 1000)
1769
1317
host = notifychangeproperty(dbus.String, "Host")
1770
timeout = notifychangeproperty(
1771
dbus.UInt64, "Timeout",
1772
type_func = lambda td: td.total_seconds() * 1000)
1318
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1319
type_func = lambda td:
1320
td.total_seconds() * 1000)
1773
1321
extended_timeout = notifychangeproperty(
1774
1322
dbus.UInt64, "ExtendedTimeout",
1775
1323
type_func = lambda td: td.total_seconds() * 1000)
1776
interval = notifychangeproperty(
1777
dbus.UInt64, "Interval",
1778
type_func = lambda td: td.total_seconds() * 1000)
1324
interval = notifychangeproperty(dbus.UInt64,
1325
"Interval",
1326
type_func =
1327
lambda td: td.total_seconds()
1328
* 1000)
1779
1329
checker_command = notifychangeproperty(dbus.String, "Checker")
1780
1330
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1781
1331
invalidate_only=True)
1791
1341
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1792
1342
Client.__del__(self, *args, **kwargs)
1793
1343
1794
def checker_callback(self, source, condition,
1795
connection, command, *args, **kwargs):
1796
ret = Client.checker_callback(self, source, condition,
1797
connection, command, *args,
1798
**kwargs)
1799
exitstatus = self.last_checker_status
1800
if exitstatus >= 0:
1344
def checker_callback(self, pid, condition, command,
1345
*args, **kwargs):
1346
self.checker_callback_tag = None
1347
self.checker = None
1348
if os.WIFEXITED(condition):
1349
exitstatus = os.WEXITSTATUS(condition)
1801
1350
# Emit D-Bus signal
1802
1351
self.CheckerCompleted(dbus.Int16(exitstatus),
1803
# This is specific to GNU libC
1804
dbus.Int64(exitstatus << 8),
1352
dbus.Int64(condition),
1805
1353
dbus.String(command))
1806
1354
else:
1807
1355
# Emit D-Bus signal
1808
1356
self.CheckerCompleted(dbus.Int16(-1),
1809
dbus.Int64(
1810
# This is specific to GNU libC
1811
(exitstatus << 8)
1812
| self.last_checker_signal),
1357
dbus.Int64(condition),
1813
1358
dbus.String(command))
1814
return ret
1359
1360
return Client.checker_callback(self, pid, condition, command,
1361
*args, **kwargs)
1815
1362
1816
1363
def start_checker(self, *args, **kwargs):
1817
1364
old_checker_pid = getattr(self.checker, "pid", None)
1829
1376
1830
1377
def approve(self, value=True):
1831
1378
self.approved = value
1832
GLib.timeout_add(int(self.approval_duration.total_seconds()
1833
* 1000), self._reset_approved)
1379
gobject.timeout_add(int(self.approval_duration.total_seconds()
1380
* 1000), self._reset_approved)
1834
1381
self.send_changedstate()
1835
1382
1836
1383
## D-Bus methods, signals & properties
1892
1439
self.checked_ok()
1893
1440
1894
1441
# Enable - method
1895
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1896
1442
@dbus.service.method(_interface)
1897
1443
def Enable(self):
1898
1444
"D-Bus method"
1899
1445
self.enable()
1900
1446
1901
1447
# StartChecker - method
1902
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1903
1448
@dbus.service.method(_interface)
1904
1449
def StartChecker(self):
1905
1450
"D-Bus method"
1906
1451
self.start_checker()
1907
1452
1908
1453
# Disable - method
1909
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1910
1454
@dbus.service.method(_interface)
1911
1455
def Disable(self):
1912
1456
"D-Bus method"
1913
1457
self.disable()
1914
1458
1915
1459
# StopChecker - method
1916
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1917
1460
@dbus.service.method(_interface)
1918
1461
def StopChecker(self):
1919
1462
self.stop_checker()
1926
1469
return dbus.Boolean(bool(self.approvals_pending))
1927
1470
1928
1471
# ApprovedByDefault - property
1929
@dbus_service_property(_interface,
1930
signature="b",
1472
@dbus_service_property(_interface, signature="b",
1931
1473
access="readwrite")
1932
1474
def ApprovedByDefault_dbus_property(self, value=None):
1933
1475
if value is None: # get
1935
1477
self.approved_by_default = bool(value)
1936
1478
1937
1479
# ApprovalDelay - property
1938
@dbus_service_property(_interface,
1939
signature="t",
1480
@dbus_service_property(_interface, signature="t",
1940
1481
access="readwrite")
1941
1482
def ApprovalDelay_dbus_property(self, value=None):
1942
1483
if value is None: # get
1945
1486
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1946
1487
1947
1488
# ApprovalDuration - property
1948
@dbus_service_property(_interface,
1949
signature="t",
1489
@dbus_service_property(_interface, signature="t",
1950
1490
access="readwrite")
1951
1491
def ApprovalDuration_dbus_property(self, value=None):
1952
1492
if value is None: # get
1955
1495
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1956
1496
1957
1497
# Name - property
1958
@dbus_annotations(
1959
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1960
1498
@dbus_service_property(_interface, signature="s", access="read")
1961
1499
def Name_dbus_property(self):
1962
1500
return dbus.String(self.name)
1963
1501
1964
1502
# Fingerprint - property
1965
@dbus_annotations(
1966
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1967
1503
@dbus_service_property(_interface, signature="s", access="read")
1968
1504
def Fingerprint_dbus_property(self):
1969
1505
return dbus.String(self.fingerprint)
1970
1506
1971
1507
# Host - property
1972
@dbus_service_property(_interface,
1973
signature="s",
1508
@dbus_service_property(_interface, signature="s",
1974
1509
access="readwrite")
1975
1510
def Host_dbus_property(self, value=None):
1976
1511
if value is None: # get
1978
1513
self.host = str(value)
1979
1514
1980
1515
# Created - property
1981
@dbus_annotations(
1982
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1983
1516
@dbus_service_property(_interface, signature="s", access="read")
1984
1517
def Created_dbus_property(self):
1985
1518
return datetime_to_dbus(self.created)
1990
1523
return datetime_to_dbus(self.last_enabled)
1991
1524
1992
1525
# Enabled - property
1993
@dbus_service_property(_interface,
1994
signature="b",
1526
@dbus_service_property(_interface, signature="b",
1995
1527
access="readwrite")
1996
1528
def Enabled_dbus_property(self, value=None):
1997
1529
if value is None: # get
2002
1534
self.disable()
2003
1535
2004
1536
# LastCheckedOK - property
2005
@dbus_service_property(_interface,
2006
signature="s",
1537
@dbus_service_property(_interface, signature="s",
2007
1538
access="readwrite")
2008
1539
def LastCheckedOK_dbus_property(self, value=None):
2009
1540
if value is not None:
2012
1543
return datetime_to_dbus(self.last_checked_ok)
2013
1544
2014
1545
# LastCheckerStatus - property
2015
@dbus_service_property(_interface, signature="n", access="read")
1546
@dbus_service_property(_interface, signature="n",
1547
access="read")
2016
1548
def LastCheckerStatus_dbus_property(self):
2017
1549
return dbus.Int16(self.last_checker_status)
2018
1550
2027
1559
return datetime_to_dbus(self.last_approval_request)
2028
1560
2029
1561
# Timeout - property
2030
@dbus_service_property(_interface,
2031
signature="t",
1562
@dbus_service_property(_interface, signature="t",
2032
1563
access="readwrite")
2033
1564
def Timeout_dbus_property(self, value=None):
2034
1565
if value is None: # get
2046
1577
if (getattr(self, "disable_initiator_tag", None)
2047
1578
is None):
2048
1579
return
2049
GLib.source_remove(self.disable_initiator_tag)
2050
self.disable_initiator_tag = GLib.timeout_add(
2051
int((self.expires - now).total_seconds() * 1000),
2052
self.disable)
1580
gobject.source_remove(self.disable_initiator_tag)
1581
self.disable_initiator_tag = (
1582
gobject.timeout_add(
1583
int((self.expires - now).total_seconds()
1584
* 1000), self.disable))
2053
1585
2054
1586
# ExtendedTimeout - property
2055
@dbus_service_property(_interface,
2056
signature="t",
1587
@dbus_service_property(_interface, signature="t",
2057
1588
access="readwrite")
2058
1589
def ExtendedTimeout_dbus_property(self, value=None):
2059
1590
if value is None: # get
2062
1593
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2063
1594
2064
1595
# Interval - property
2065
@dbus_service_property(_interface,
2066
signature="t",
1596
@dbus_service_property(_interface, signature="t",
2067
1597
access="readwrite")
2068
1598
def Interval_dbus_property(self, value=None):
2069
1599
if value is None: # get
2073
1603
return
2074
1604
if self.enabled:
2075
1605
# Reschedule checker run
2076
GLib.source_remove(self.checker_initiator_tag)
2077
self.checker_initiator_tag = GLib.timeout_add(
2078
value, self.start_checker)
2079
self.start_checker() # Start one now, too
1606
gobject.source_remove(self.checker_initiator_tag)
1607
self.checker_initiator_tag = (gobject.timeout_add
1608
(value, self.start_checker))
1609
self.start_checker() # Start one now, too
2080
1610
2081
1611
# Checker - property
2082
@dbus_service_property(_interface,
2083
signature="s",
1612
@dbus_service_property(_interface, signature="s",
2084
1613
access="readwrite")
2085
1614
def Checker_dbus_property(self, value=None):
2086
1615
if value is None: # get
2088
1617
self.checker_command = str(value)
2089
1618
2090
1619
# CheckerRunning - property
2091
@dbus_service_property(_interface,
2092
signature="b",
1620
@dbus_service_property(_interface, signature="b",
2093
1621
access="readwrite")
2094
1622
def CheckerRunning_dbus_property(self, value=None):
2095
1623
if value is None: # get
2100
1628
self.stop_checker()
2101
1629
2102
1630
# ObjectPath - property
2103
@dbus_annotations(
2104
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2105
"org.freedesktop.DBus.Deprecated": "true"})
2106
1631
@dbus_service_property(_interface, signature="o", access="read")
2107
1632
def ObjectPath_dbus_property(self):
2108
1633
return self.dbus_object_path # is already a dbus.ObjectPath
2109
1634
2110
1635
# Secret = property
2111
@dbus_annotations(
2112
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2113
"invalidates"})
2114
@dbus_service_property(_interface,
2115
signature="ay",
2116
access="write",
2117
byte_arrays=True)
1636
@dbus_service_property(_interface, signature="ay",
1637
access="write", byte_arrays=True)
2118
1638
def Secret_dbus_property(self, value):
2119
1639
self.secret = bytes(value)
2120
1640
2126
1646
self._pipe = child_pipe
2127
1647
self._pipe.send(('init', fpr, address))
2128
1648
if not self._pipe.recv():
2129
raise KeyError(fpr)
1649
raise KeyError()
2130
1650
2131
1651
def __getattribute__(self, name):
2132
1652
if name == '_pipe':
2136
1656
if data[0] == 'data':
2137
1657
return data[1]
2138
1658
if data[0] == 'function':
2139
2140
1659
def func(*args, **kwargs):
2141
1660
self._pipe.send(('funcall', name, args, kwargs))
2142
1661
return self._pipe.recv()[1]
2143
2144
1662
return func
2145
1663
2146
1664
def __setattr__(self, name, value):
2162
1680
logger.debug("Pipe FD: %d",
2163
1681
self.server.child_pipe.fileno())
2164
1682
2165
session = gnutls.ClientSession(self.request)
1683
session = (gnutls.connection
1684
.ClientSession(self.request,
1685
gnutls.connection
1686
.X509Credentials()))
1687
1688
# Note: gnutls.connection.X509Credentials is really a
1689
# generic GnuTLS certificate credentials object so long as
1690
# no X.509 keys are added to it. Therefore, we can use it
1691
# here despite using OpenPGP certificates.
2166
1692
2167
1693
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2168
1694
# "+AES-256-CBC", "+SHA1",
2172
1698
priority = self.server.gnutls_priority
2173
1699
if priority is None:
2174
1700
priority = "NORMAL"
2175
gnutls.priority_set_direct(session._c_object, priority,
2176
None)
1701
(gnutls.library.functions
1702
.gnutls_priority_set_direct(session._c_object,
1703
priority, None))
2177
1704
2178
1705
# Start communication using the Mandos protocol
2179
1706
# Get protocol number
2189
1716
# Start GnuTLS connection
2190
1717
try:
2191
1718
session.handshake()
2192
except gnutls.Error as error:
1719
except gnutls.errors.GNUTLSError as error:
2193
1720
logger.warning("Handshake failed: %s", error)
2194
1721
# Do not run session.bye() here: the session is not
2195
1722
# established. Just abandon the request.
2199
1726
approval_required = False
2200
1727
try:
2201
1728
try:
2202
fpr = self.fingerprint(
2203
self.peer_certificate(session))
2204
except (TypeError, gnutls.Error) as error:
1729
fpr = self.fingerprint(self.peer_certificate
1730
(session))
1731
except (TypeError,
1732
gnutls.errors.GNUTLSError) as error:
2205
1733
logger.warning("Bad certificate: %s", error)
2206
1734
return
2207
1735
logger.debug("Fingerprint: %s", fpr)
2220
1748
while True:
2221
1749
if not client.enabled:
2222
1750
logger.info("Client %s is disabled",
2223
client.name)
1751
client.name)
2224
1752
if self.server.use_dbus:
2225
1753
# Emit D-Bus signal
2226
1754
client.Rejected("Disabled")
2265
1793
else:
2266
1794
delay -= time2 - time
2267
1795
2268
try:
2269
session.send(client.secret)
2270
except gnutls.Error as error:
2271
logger.warning("gnutls send failed",
2272
exc_info = error)
2273
return
1796
sent_size = 0
1797
while sent_size < len(client.secret):
1798
try:
1799
sent = session.send(client.secret[sent_size:])
1800
except gnutls.errors.GNUTLSError as error:
1801
logger.warning("gnutls send failed",
1802
exc_info=error)
1803
return
1804
logger.debug("Sent: %d, remaining: %d",
1805
sent, len(client.secret)
1806
- (sent_size + sent))
1807
sent_size += sent
2274
1808
2275
1809
logger.info("Sending secret to %s", client.name)
2276
1810
# bump the timeout using extended_timeout
2284
1818
client.approvals_pending -= 1
2285
1819
try:
2286
1820
session.bye()
2287
except gnutls.Error as error:
1821
except gnutls.errors.GNUTLSError as error:
2288
1822
logger.warning("GnuTLS bye failed",
2289
1823
exc_info=error)
2290
1824
2292
1826
def peer_certificate(session):
2293
1827
"Return the peer's OpenPGP certificate as a bytestring"
2294
1828
# If not an OpenPGP certificate...
2295
if (gnutls.certificate_type_get(session._c_object)
2296
!= gnutls.CRT_OPENPGP):
2297
# ...return invalid data
2298
return b""
1829
if (gnutls.library.functions
1830
.gnutls_certificate_type_get(session._c_object)
1831
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1832
# ...do the normal thing
1833
return session.peer_certificate
2299
1834
list_size = ctypes.c_uint(1)
2300
cert_list = (gnutls.certificate_get_peers
1835
cert_list = (gnutls.library.functions
1836
.gnutls_certificate_get_peers
2301
1837
(session._c_object, ctypes.byref(list_size)))
2302
1838
if not bool(cert_list) and list_size.value != 0:
2303
raise gnutls.Error("error getting peer certificate")
1839
raise gnutls.errors.GNUTLSError("error getting peer"
1840
" certificate")
2304
1841
if list_size.value == 0:
2305
1842
return None
2306
1843
cert = cert_list[0]
2310
1847
def fingerprint(openpgp):
2311
1848
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2312
1849
# New GnuTLS "datum" with the OpenPGP public key
2313
datum = gnutls.datum_t(
2314
ctypes.cast(ctypes.c_char_p(openpgp),
2315
ctypes.POINTER(ctypes.c_ubyte)),
2316
ctypes.c_uint(len(openpgp)))
1850
datum = (gnutls.library.types
1851
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1852
ctypes.POINTER
1853
(ctypes.c_ubyte)),
1854
ctypes.c_uint(len(openpgp))))
2317
1855
# New empty GnuTLS certificate
2318
crt = gnutls.openpgp_crt_t()
2319
gnutls.openpgp_crt_init(ctypes.byref(crt))
1856
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1857
(gnutls.library.functions
1858
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2320
1859
# Import the OpenPGP public key into the certificate
2321
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2322
gnutls.OPENPGP_FMT_RAW)
1860
(gnutls.library.functions
1861
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1862
gnutls.library.constants
1863
.GNUTLS_OPENPGP_FMT_RAW))
2323
1864
# Verify the self signature in the key
2324
1865
crtverify = ctypes.c_uint()
2325
gnutls.openpgp_crt_verify_self(crt, 0,
2326
ctypes.byref(crtverify))
1866
(gnutls.library.functions
1867
.gnutls_openpgp_crt_verify_self(crt, 0,
1868
ctypes.byref(crtverify)))
2327
1869
if crtverify.value != 0:
2328
gnutls.openpgp_crt_deinit(crt)
2329
raise gnutls.CertificateSecurityError("Verify failed")
1870
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1871
raise (gnutls.errors.CertificateSecurityError
1872
("Verify failed"))
2330
1873
# New buffer for the fingerprint
2331
1874
buf = ctypes.create_string_buffer(20)
2332
1875
buf_len = ctypes.c_size_t()
2333
1876
# Get the fingerprint from the certificate into the buffer
2334
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2335
ctypes.byref(buf_len))
1877
(gnutls.library.functions
1878
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1879
ctypes.byref(buf_len)))
2336
1880
# Deinit the certificate
2337
gnutls.openpgp_crt_deinit(crt)
1881
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2338
1882
# Convert the buffer to a Python bytestring
2339
1883
fpr = ctypes.string_at(buf, buf_len.value)
2340
1884
# Convert the bytestring to hexadecimal notation
2344
1888
2345
1889
class MultiprocessingMixIn(object):
2346
1890
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2347
2348
1891
def sub_process_main(self, request, address):
2349
1892
try:
2350
1893
self.finish_request(request, address)
2362
1905
2363
1906
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2364
1907
""" adds a pipe to the MixIn """
2365
2366
1908
def process_request(self, request, client_address):
2367
1909
"""Overrides and wraps the original process_request().
2368
1910
2389
1931
interface: None or a network interface name (string)
2390
1932
use_ipv6: Boolean; to use IPv6 or not
2391
1933
"""
2392
2393
1934
def __init__(self, server_address, RequestHandlerClass,
2394
interface=None,
2395
use_ipv6=True,
2396
socketfd=None):
1935
interface=None, use_ipv6=True, socketfd=None):
2397
1936
"""If socketfd is set, use that file descriptor instead of
2398
1937
creating a new one with socket.socket().
2399
1938
"""
2440
1979
self.interface)
2441
1980
else:
2442
1981
try:
2443
self.socket.setsockopt(
2444
socket.SOL_SOCKET, SO_BINDTODEVICE,
2445
(self.interface + "\0").encode("utf-8"))
1982
self.socket.setsockopt(socket.SOL_SOCKET,
1983
SO_BINDTODEVICE,
1984
(self.interface + "\0")
1985
.encode("utf-8"))
2446
1986
except socket.error as error:
2447
1987
if error.errno == errno.EPERM:
2448
1988
logger.error("No permission to bind to"
2466
2006
self.server_address = (any_address,
2467
2007
self.server_address[1])
2468
2008
elif not self.server_address[1]:
2469
self.server_address = (self.server_address[0], 0)
2009
self.server_address = (self.server_address[0],
2010
0)
2470
2011
# if self.interface:
2471
2012
# self.server_address = (self.server_address[0],
2472
2013
# 0, # port
2484
2025
gnutls_priority GnuTLS priority string
2485
2026
use_dbus: Boolean; to emit D-Bus signals or not
2486
2027
2487
Assumes a GLib.MainLoop event loop.
2028
Assumes a gobject.MainLoop event loop.
2488
2029
"""
2489
2490
2030
def __init__(self, server_address, RequestHandlerClass,
2491
interface=None,
2492
use_ipv6=True,
2493
clients=None,
2494
gnutls_priority=None,
2495
use_dbus=True,
2496
socketfd=None):
2031
interface=None, use_ipv6=True, clients=None,
2032
gnutls_priority=None, use_dbus=True, socketfd=None):
2497
2033
self.enabled = False
2498
2034
self.clients = clients
2499
2035
if self.clients is None:
2505
2041
interface = interface,
2506
2042
use_ipv6 = use_ipv6,
2507
2043
socketfd = socketfd)
2508
2509
2044
def server_activate(self):
2510
2045
if self.enabled:
2511
2046
return socketserver.TCPServer.server_activate(self)
2515
2050
2516
2051
def add_pipe(self, parent_pipe, proc):
2517
2052
# Call "handle_ipc" for both data and EOF events
2518
GLib.io_add_watch(
2519
parent_pipe.fileno(),
2520
GLib.IO_IN | GLib.IO_HUP,
2521
functools.partial(self.handle_ipc,
2522
parent_pipe = parent_pipe,
2523
proc = proc))
2053
gobject.io_add_watch(parent_pipe.fileno(),
2054
gobject.IO_IN | gobject.IO_HUP,
2055
functools.partial(self.handle_ipc,
2056
parent_pipe =
2057
parent_pipe,
2058
proc = proc))
2524
2059
2525
def handle_ipc(self, source, condition,
2526
parent_pipe=None,
2527
proc = None,
2528
client_object=None):
2060
def handle_ipc(self, source, condition, parent_pipe=None,
2061
proc = None, client_object=None):
2529
2062
# error, or the other end of multiprocessing.Pipe has closed
2530
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2063
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2531
2064
# Wait for other process to exit
2532
2065
proc.join()
2533
2066
return False
2540
2073
fpr = request[1]
2541
2074
address = request[2]
2542
2075
2543
for c in self.clients.values():
2076
for c in self.clients.itervalues():
2544
2077
if c.fingerprint == fpr:
2545
2078
client = c
2546
2079
break
2554
2087
parent_pipe.send(False)
2555
2088
return False
2556
2089
2557
GLib.io_add_watch(
2558
parent_pipe.fileno(),
2559
GLib.IO_IN | GLib.IO_HUP,
2560
functools.partial(self.handle_ipc,
2561
parent_pipe = parent_pipe,
2562
proc = proc,
2563
client_object = client))
2090
gobject.io_add_watch(parent_pipe.fileno(),
2091
gobject.IO_IN | gobject.IO_HUP,
2092
functools.partial(self.handle_ipc,
2093
parent_pipe =
2094
parent_pipe,
2095
proc = proc,
2096
client_object =
2097
client))
2564
2098
parent_pipe.send(True)
2565
2099
# remove the old hook in favor of the new above hook on
2566
2100
# same fileno
2572
2106
2573
2107
parent_pipe.send(('data', getattr(client_object,
2574
2108
funcname)(*args,
2575
**kwargs)))
2109
**kwargs)))
2576
2110
2577
2111
if command == 'getattr':
2578
2112
attrname = request[1]
2579
if isinstance(client_object.__getattribute__(attrname),
2580
collections.Callable):
2581
parent_pipe.send(('function', ))
2113
if callable(client_object.__getattribute__(attrname)):
2114
parent_pipe.send(('function',))
2582
2115
else:
2583
parent_pipe.send((
2584
'data', client_object.__getattribute__(attrname)))
2116
parent_pipe.send(('data', client_object
2117
.__getattribute__(attrname)))
2585
2118
2586
2119
if command == 'setattr':
2587
2120
attrname = request[1]
2618
2151
# avoid excessive use of external libraries.
2619
2152
2620
2153
# New type for defining tokens, syntax, and semantics all-in-one
2621
Token = collections.namedtuple("Token", (
2622
"regexp", # To match token; if "value" is not None, must have
2623
# a "group" containing digits
2624
"value", # datetime.timedelta or None
2625
"followers")) # Tokens valid after this token
2154
Token = collections.namedtuple("Token",
2155
("regexp", # To match token; if
2156
# "value" is not None,
2157
# must have a "group"
2158
# containing digits
2159
"value", # datetime.timedelta or
2160
# None
2161
"followers")) # Tokens valid after
2162
# this token
2626
2163
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2627
2164
# the "duration" ABNF definition in RFC 3339, Appendix A.
2628
2165
token_end = Token(re.compile(r"$"), None, frozenset())
2629
2166
token_second = Token(re.compile(r"(\d+)S"),
2630
2167
datetime.timedelta(seconds=1),
2631
frozenset((token_end, )))
2168
frozenset((token_end,)))
2632
2169
token_minute = Token(re.compile(r"(\d+)M"),
2633
2170
datetime.timedelta(minutes=1),
2634
2171
frozenset((token_second, token_end)))
2650
2187
frozenset((token_month, token_end)))
2651
2188
token_week = Token(re.compile(r"(\d+)W"),
2652
2189
datetime.timedelta(weeks=1),
2653
frozenset((token_end, )))
2190
frozenset((token_end,)))
2654
2191
token_duration = Token(re.compile(r"P"), None,
2655
2192
frozenset((token_year, token_month,
2656
2193
token_day, token_time,
2658
2195
# Define starting values
2659
2196
value = datetime.timedelta() # Value so far
2660
2197
found_token = None
2661
followers = frozenset((token_duration, )) # Following valid tokens
2198
followers = frozenset((token_duration,)) # Following valid tokens
2662
2199
s = duration # String left to parse
2663
2200
# Loop until end token is found
2664
2201
while found_token is not token_end:
2681
2218
break
2682
2219
else:
2683
2220
# No currently valid tokens were found
2684
raise ValueError("Invalid RFC 3339 duration: {!r}"
2685
.format(duration))
2221
raise ValueError("Invalid RFC 3339 duration")
2686
2222
# End token found
2687
2223
return value
2688
2224
2725
2261
elif suffix == "w":
2726
2262
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2727
2263
else:
2728
raise ValueError("Unknown suffix {!r}".format(suffix))
2264
raise ValueError("Unknown suffix {!r}"
2265
.format(suffix))
2729
2266
except IndexError as e:
2730
2267
raise ValueError(*(e.args))
2731
2268
timevalue += delta
2747
2284
# Close all standard open file descriptors
2748
2285
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2749
2286
if not stat.S_ISCHR(os.fstat(null).st_mode):
2750
raise OSError(errno.ENODEV,
2751
"{} not a character device"
2287
raise OSError(errno.ENODEV, "{} not a character device"
2752
2288
.format(os.devnull))
2753
2289
os.dup2(null, sys.stdin.fileno())
2754
2290
os.dup2(null, sys.stdout.fileno())
2820
2356
"port": "",
2821
2357
"debug": "False",
2822
2358
"priority":
2823
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2824
":+SIGN-DSA-SHA256",
2359
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2825
2360
"servicename": "Mandos",
2826
2361
"use_dbus": "True",
2827
2362
"use_ipv6": "True",
2831
2366
"statedir": "/var/lib/mandos",
2832
2367
"foreground": "False",
2833
2368
"zeroconf": "True",
2834
}
2369
}
2835
2370
2836
2371
# Parse config file for server-global settings
2837
2372
server_config = configparser.SafeConfigParser(server_defaults)
2838
2373
del server_defaults
2839
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2374
server_config.read(os.path.join(options.configdir,
2375
"mandos.conf"))
2840
2376
# Convert the SafeConfigParser object to a dict
2841
2377
server_settings = server_config.defaults()
2842
2378
# Use the appropriate methods on the non-string config options
2860
2396
# Override the settings from the config file with command line
2861
2397
# options, if set.
2862
2398
for option in ("interface", "address", "port", "debug",
2863
"priority", "servicename", "configdir", "use_dbus",
2864
"use_ipv6", "debuglevel", "restore", "statedir",
2865
"socket", "foreground", "zeroconf"):
2399
"priority", "servicename", "configdir",
2400
"use_dbus", "use_ipv6", "debuglevel", "restore",
2401
"statedir", "socket", "foreground", "zeroconf"):
2866
2402
value = getattr(options, option)
2867
2403
if value is not None:
2868
2404
server_settings[option] = value
2883
2419
2884
2420
##################################################################
2885
2421
2886
if (not server_settings["zeroconf"]
2887
and not (server_settings["port"]
2888
or server_settings["socket"] != "")):
2889
parser.error("Needs port or socket to work without Zeroconf")
2422
if (not server_settings["zeroconf"] and
2423
not (server_settings["port"]
2424
or server_settings["socket"] != "")):
2425
parser.error("Needs port or socket to work without"
2426
" Zeroconf")
2890
2427
2891
2428
# For convenience
2892
2429
debug = server_settings["debug"]
2908
2445
initlogger(debug, level)
2909
2446
2910
2447
if server_settings["servicename"] != "Mandos":
2911
syslogger.setFormatter(
2912
logging.Formatter('Mandos ({}) [%(process)d]:'
2913
' %(levelname)s: %(message)s'.format(
2914
server_settings["servicename"])))
2448
syslogger.setFormatter(logging.Formatter
2449
('Mandos ({}) [%(process)d]:'
2450
' %(levelname)s: %(message)s'
2451
.format(server_settings
2452
["servicename"])))
2915
2453
2916
2454
# Parse config file with clients
2917
2455
client_config = configparser.SafeConfigParser(Client
2925
2463
socketfd = None
2926
2464
if server_settings["socket"] != "":
2927
2465
socketfd = server_settings["socket"]
2928
tcp_server = MandosServer(
2929
(server_settings["address"], server_settings["port"]),
2930
ClientHandler,
2931
interface=(server_settings["interface"] or None),
2932
use_ipv6=use_ipv6,
2933
gnutls_priority=server_settings["priority"],
2934
use_dbus=use_dbus,
2935
socketfd=socketfd)
2466
tcp_server = MandosServer((server_settings["address"],
2467
server_settings["port"]),
2468
ClientHandler,
2469
interface=(server_settings["interface"]
2470
or None),
2471
use_ipv6=use_ipv6,
2472
gnutls_priority=
2473
server_settings["priority"],
2474
use_dbus=use_dbus,
2475
socketfd=socketfd)
2936
2476
if not foreground:
2937
2477
pidfilename = "/run/mandos.pid"
2938
2478
if not os.path.isdir("/run/."):
2939
2479
pidfilename = "/var/run/mandos.pid"
2940
2480
pidfile = None
2941
2481
try:
2942
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2482
pidfile = open(pidfilename, "w")
2943
2483
except IOError as e:
2944
2484
logger.error("Could not open file %r", pidfilename,
2945
2485
exc_info=e)
2946
2486
2947
for name, group in (("_mandos", "_mandos"),
2948
("mandos", "mandos"),
2949
("nobody", "nogroup")):
2487
for name in ("_mandos", "mandos", "nobody"):
2950
2488
try:
2951
2489
uid = pwd.getpwnam(name).pw_uid
2952
gid = pwd.getpwnam(group).pw_gid
2490
gid = pwd.getpwnam(name).pw_gid
2953
2491
break
2954
2492
except KeyError:
2955
2493
continue
2959
2497
try:
2960
2498
os.setgid(gid)
2961
2499
os.setuid(uid)
2962
if debug:
2963
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2964
gid))
2965
2500
except OSError as error:
2966
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2967
.format(uid, gid, os.strerror(error.errno)))
2968
2501
if error.errno != errno.EPERM:
2969
2502
raise
2970
2503
2973
2506
2974
2507
# "Use a log level over 10 to enable all debugging options."
2975
2508
# - GnuTLS manual
2976
gnutls.global_set_log_level(11)
2509
gnutls.library.functions.gnutls_global_set_log_level(11)
2977
2510
2978
@gnutls.log_func
2511
@gnutls.library.types.gnutls_log_func
2979
2512
def debug_gnutls(level, string):
2980
2513
logger.debug("GnuTLS: %s", string[:-1])
2981
2514
2982
gnutls.global_set_log_function(debug_gnutls)
2515
(gnutls.library.functions
2516
.gnutls_global_set_log_function(debug_gnutls))
2983
2517
2984
2518
# Redirect stdin so all checkers get /dev/null
2985
2519
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2992
2526
# Close all input and output, do double fork, etc.
2993
2527
daemon()
2994
2528
2995
# multiprocessing will use threads, so before we use GLib we need
2996
# to inform GLib that threads will be used.
2997
GLib.threads_init()
2529
# multiprocessing will use threads, so before we use gobject we
2530
# need to inform gobject that threads will be used.
2531
gobject.threads_init()
2998
2532
2999
2533
global main_loop
3000
2534
# From the Avahi example code
3001
2535
DBusGMainLoop(set_as_default=True)
3002
main_loop = GLib.MainLoop()
2536
main_loop = gobject.MainLoop()
3003
2537
bus = dbus.SystemBus()
3004
2538
# End of Avahi example code
3005
2539
if use_dbus:
3006
2540
try:
3007
2541
bus_name = dbus.service.BusName("se.recompile.Mandos",
3008
bus,
3009
do_not_queue=True)
3010
old_bus_name = dbus.service.BusName(
3011
"se.bsnet.fukt.Mandos", bus,
3012
do_not_queue=True)
3013
except dbus.exceptions.DBusException as e:
2542
bus, do_not_queue=True)
2543
old_bus_name = (dbus.service.BusName
2544
("se.bsnet.fukt.Mandos", bus,
2545
do_not_queue=True))
2546
except dbus.exceptions.NameExistsException as e:
3014
2547
logger.error("Disabling D-Bus:", exc_info=e)
3015
2548
use_dbus = False
3016
2549
server_settings["use_dbus"] = False
3017
2550
tcp_server.use_dbus = False
3018
2551
if zeroconf:
3019
2552
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3020
service = AvahiServiceToSyslog(
3021
name = server_settings["servicename"],
3022
servicetype = "_mandos._tcp",
3023
protocol = protocol,
3024
bus = bus)
2553
service = AvahiServiceToSyslog(name =
2554
server_settings["servicename"],
2555
servicetype = "_mandos._tcp",
2556
protocol = protocol, bus = bus)
3025
2557
if server_settings["interface"]:
3026
service.interface = if_nametoindex(
3027
server_settings["interface"].encode("utf-8"))
2558
service.interface = (if_nametoindex
2559
(server_settings["interface"]
2560
.encode("utf-8")))
3028
2561
3029
2562
global multiprocessing_manager
3030
2563
multiprocessing_manager = multiprocessing.Manager()
3049
2582
if server_settings["restore"]:
3050
2583
try:
3051
2584
with open(stored_state_path, "rb") as stored_state:
3052
if sys.version_info.major == 2:
3053
clients_data, old_client_settings = pickle.load(
3054
stored_state)
3055
else:
3056
bytes_clients_data, bytes_old_client_settings = (
3057
pickle.load(stored_state, encoding = "bytes"))
3058
### Fix bytes to strings
3059
## clients_data
3060
# .keys()
3061
clients_data = { (key.decode("utf-8")
3062
if isinstance(key, bytes)
3063
else key): value
3064
for key, value in
3065
bytes_clients_data.items() }
3066
del bytes_clients_data
3067
for key in clients_data:
3068
value = { (k.decode("utf-8")
3069
if isinstance(k, bytes) else k): v
3070
for k, v in
3071
clients_data[key].items() }
3072
clients_data[key] = value
3073
# .client_structure
3074
value["client_structure"] = [
3075
(s.decode("utf-8")
3076
if isinstance(s, bytes)
3077
else s) for s in
3078
value["client_structure"] ]
3079
# .name & .host
3080
for k in ("name", "host"):
3081
if isinstance(value[k], bytes):
3082
value[k] = value[k].decode("utf-8")
3083
## old_client_settings
3084
# .keys()
3085
old_client_settings = {
3086
(key.decode("utf-8")
3087
if isinstance(key, bytes)
3088
else key): value
3089
for key, value in
3090
bytes_old_client_settings.items() }
3091
del bytes_old_client_settings
3092
# .host
3093
for value in old_client_settings.values():
3094
if isinstance(value["host"], bytes):
3095
value["host"] = (value["host"]
3096
.decode("utf-8"))
2585
clients_data, old_client_settings = (pickle.load
2586
(stored_state))
3097
2587
os.remove(stored_state_path)
3098
2588
except IOError as e:
3099
2589
if e.errno == errno.ENOENT:
3100
logger.warning("Could not load persistent state:"
3101
" {}".format(os.strerror(e.errno)))
2590
logger.warning("Could not load persistent state: {}"
2591
.format(os.strerror(e.errno)))
3102
2592
else:
3103
2593
logger.critical("Could not load persistent state:",
3104
2594
exc_info=e)
3105
2595
raise
3106
2596
except EOFError as e:
3107
2597
logger.warning("Could not load persistent state: "
3108
"EOFError:",
3109
exc_info=e)
2598
"EOFError:", exc_info=e)
3110
2599
3111
2600
with PGPEngine() as pgp:
3112
2601
for client_name, client in clients_data.items():
3124
2613
# For each value in new config, check if it
3125
2614
# differs from the old config value (Except for
3126
2615
# the "secret" attribute)
3127
if (name != "secret"
3128
and (value !=
3129
old_client_settings[client_name][name])):
2616
if (name != "secret" and
2617
value != old_client_settings[client_name]
2618
[name]):
3130
2619
client[name] = value
3131
2620
except KeyError:
3132
2621
pass
3133
2622
3134
2623
# Clients who has passed its expire date can still be
3135
# enabled if its last checker was successful. A Client
2624
# enabled if its last checker was successful. Clients
3136
2625
# whose checker succeeded before we stored its state is
3137
2626
# assumed to have successfully run all checkers during
3138
2627
# downtime.
3141
2630
if not client["last_checked_ok"]:
3142
2631
logger.warning(
3143
2632
"disabling client {} - Client never "
3144
"performed a successful checker".format(
3145
client_name))
2633
"performed a successful checker"
2634
.format(client_name))
3146
2635
client["enabled"] = False
3147
2636
elif client["last_checker_status"] != 0:
3148
2637
logger.warning(
3149
2638
"disabling client {} - Client last"
3150
" checker failed with error code"
3151
" {}".format(
3152
client_name,
3153
client["last_checker_status"]))
2639
" checker failed with error code {}"
2640
.format(client_name,
2641
client["last_checker_status"]))
3154
2642
client["enabled"] = False
3155
2643
else:
3156
client["expires"] = (
3157
datetime.datetime.utcnow()
3158
+ client["timeout"])
2644
client["expires"] = (datetime.datetime
2645
.utcnow()
2646
+ client["timeout"])
3159
2647
logger.debug("Last checker succeeded,"
3160
" keeping {} enabled".format(
3161
client_name))
2648
" keeping {} enabled"
2649
.format(client_name))
3162
2650
try:
3163
client["secret"] = pgp.decrypt(
3164
client["encrypted_secret"],
3165
client_settings[client_name]["secret"])
2651
client["secret"] = (
2652
pgp.decrypt(client["encrypted_secret"],
2653
client_settings[client_name]
2654
["secret"]))
3166
2655
except PGPError:
3167
2656
# If decryption fails, we use secret from new settings
3168
logger.debug("Failed to decrypt {} old secret".format(
3169
client_name))
3170
client["secret"] = (client_settings[client_name]
3171
["secret"])
2657
logger.debug("Failed to decrypt {} old secret"
2658
.format(client_name))
2659
client["secret"] = (
2660
client_settings[client_name]["secret"])
3172
2661
3173
2662
# Add/remove clients based on new changes made to config
3174
2663
for client_name in (set(old_client_settings)
3181
2670
# Create all client objects
3182
2671
for client_name, client in clients_data.items():
3183
2672
tcp_server.clients[client_name] = client_class(
3184
name = client_name,
3185
settings = client,
2673
name = client_name, settings = client,
3186
2674
server_settings = server_settings)
3187
2675
3188
2676
if not tcp_server.clients:
3190
2678
3191
2679
if not foreground:
3192
2680
if pidfile is not None:
3193
pid = os.getpid()
3194
2681
try:
3195
2682
with pidfile:
3196
print(pid, file=pidfile)
2683
pid = os.getpid()
2684
pidfile.write("{}\n".format(pid).encode("utf-8"))
3197
2685
except IOError:
3198
2686
logger.error("Could not write to file %r with PID %d",
3199
2687
pidfilename, pid)
3200
2688
del pidfile
3201
2689
del pidfilename
3202
2690
3203
for termsig in (signal.SIGHUP, signal.SIGTERM):
3204
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3205
lambda: main_loop.quit() and False)
2691
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2692
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3206
2693
3207
2694
if use_dbus:
3208
3209
@alternate_dbus_interfaces(
3210
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3211
class MandosDBusService(DBusObjectWithObjectManager):
2695
@alternate_dbus_interfaces({"se.recompile.Mandos":
2696
"se.bsnet.fukt.Mandos"})
2697
class MandosDBusService(DBusObjectWithProperties):
3212
2698
"""A D-Bus proxy object"""
3213
3214
2699
def __init__(self):
3215
2700
dbus.service.Object.__init__(self, bus, "/")
3216
3217
2701
_interface = "se.recompile.Mandos"
3218
2702
2703
@dbus_interface_annotations(_interface)
2704
def _foo(self):
2705
return { "org.freedesktop.DBus.Property"
2706
".EmitsChangedSignal":
2707
"false"}
2708
3219
2709
@dbus.service.signal(_interface, signature="o")
3220
2710
def ClientAdded(self, objpath):
3221
2711
"D-Bus signal"
3226
2716
"D-Bus signal"
3227
2717
pass
3228
2718
3229
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3230
"true"})
3231
2719
@dbus.service.signal(_interface, signature="os")
3232
2720
def ClientRemoved(self, objpath, name):
3233
2721
"D-Bus signal"
3234
2722
pass
3235
2723
3236
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3237
"true"})
3238
2724
@dbus.service.method(_interface, out_signature="ao")
3239
2725
def GetAllClients(self):
3240
2726
"D-Bus method"
3241
return dbus.Array(c.dbus_object_path for c in
3242
tcp_server.clients.values())
2727
return dbus.Array(c.dbus_object_path
2728
for c in
2729
tcp_server.clients.itervalues())
3243
2730
3244
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3245
"true"})
3246
2731
@dbus.service.method(_interface,
3247
2732
out_signature="a{oa{sv}}")
3248
2733
def GetAllClientsWithProperties(self):
3249
2734
"D-Bus method"
3250
2735
return dbus.Dictionary(
3251
{ c.dbus_object_path: c.GetAll(
3252
"se.recompile.Mandos.Client")
3253
for c in tcp_server.clients.values() },
2736
{ c.dbus_object_path: c.GetAll("")
2737
for c in tcp_server.clients.itervalues() },
3254
2738
signature="oa{sv}")
3255
2739
3256
2740
@dbus.service.method(_interface, in_signature="o")
3257
2741
def RemoveClient(self, object_path):
3258
2742
"D-Bus method"
3259
for c in tcp_server.clients.values():
2743
for c in tcp_server.clients.itervalues():
3260
2744
if c.dbus_object_path == object_path:
3261
2745
del tcp_server.clients[c.name]
3262
2746
c.remove_from_connection()
3263
# Don't signal the disabling
2747
# Don't signal anything except ClientRemoved
3264
2748
c.disable(quiet=True)
3265
# Emit D-Bus signal for removal
3266
self.client_removed_signal(c)
2749
# Emit D-Bus signal
2750
self.ClientRemoved(object_path, c.name)
3267
2751
return
3268
2752
raise KeyError(object_path)
3269
2753
3270
2754
del _interface
3271
3272
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3273
out_signature = "a{oa{sa{sv}}}")
3274
def GetManagedObjects(self):
3275
"""D-Bus method"""
3276
return dbus.Dictionary(
3277
{ client.dbus_object_path:
3278
dbus.Dictionary(
3279
{ interface: client.GetAll(interface)
3280
for interface in
3281
client._get_all_interface_names()})
3282
for client in tcp_server.clients.values()})
3283
3284
def client_added_signal(self, client):
3285
"""Send the new standard signal and the old signal"""
3286
if use_dbus:
3287
# New standard signal
3288
self.InterfacesAdded(
3289
client.dbus_object_path,
3290
dbus.Dictionary(
3291
{ interface: client.GetAll(interface)
3292
for interface in
3293
client._get_all_interface_names()}))
3294
# Old signal
3295
self.ClientAdded(client.dbus_object_path)
3296
3297
def client_removed_signal(self, client):
3298
"""Send the new standard signal and the old signal"""
3299
if use_dbus:
3300
# New standard signal
3301
self.InterfacesRemoved(
3302
client.dbus_object_path,
3303
client._get_all_interface_names())
3304
# Old signal
3305
self.ClientRemoved(client.dbus_object_path,
3306
client.name)
3307
2755
3308
2756
mandos_dbus_service = MandosDBusService()
3309
2757
3322
2770
# removed/edited, old secret will thus be unrecovable.
3323
2771
clients = {}
3324
2772
with PGPEngine() as pgp:
3325
for client in tcp_server.clients.values():
2773
for client in tcp_server.clients.itervalues():
3326
2774
key = client_settings[client.name]["secret"]
3327
2775
client.encrypted_secret = pgp.encrypt(client.secret,
3328
2776
key)
3332
2780
# + secret.
3333
2781
exclude = { "bus", "changedstate", "secret",
3334
2782
"checker", "server_settings" }
3335
for name, typ in inspect.getmembers(dbus.service
3336
.Object):
2783
for name, typ in (inspect.getmembers
2784
(dbus.service.Object)):
3337
2785
exclude.add(name)
3338
2786
3339
2787
client_dict["encrypted_secret"] = (client
3346
2794
del client_settings[client.name]["secret"]
3347
2795
3348
2796
try:
3349
with tempfile.NamedTemporaryFile(
3350
mode='wb',
3351
suffix=".pickle",
3352
prefix='clients-',
3353
dir=os.path.dirname(stored_state_path),
3354
delete=False) as stored_state:
3355
pickle.dump((clients, client_settings), stored_state,
3356
protocol = 2)
3357
tempname = stored_state.name
2797
with (tempfile.NamedTemporaryFile
2798
(mode='wb', suffix=".pickle", prefix='clients-',
2799
dir=os.path.dirname(stored_state_path),
2800
delete=False)) as stored_state:
2801
pickle.dump((clients, client_settings), stored_state)
2802
tempname=stored_state.name
3358
2803
os.rename(tempname, stored_state_path)
3359
2804
except (IOError, OSError) as e:
3360
2805
if not debug:
3375
2820
name, client = tcp_server.clients.popitem()
3376
2821
if use_dbus:
3377
2822
client.remove_from_connection()
3378
# Don't signal the disabling
2823
# Don't signal anything except ClientRemoved
3379
2824
client.disable(quiet=True)
3380
# Emit D-Bus signal for removal
3381
2825
if use_dbus:
3382
mandos_dbus_service.client_removed_signal(client)
2826
# Emit D-Bus signal
2827
mandos_dbus_service.ClientRemoved(client
2828
.dbus_object_path,
2829
client.name)
3383
2830
client_settings.clear()
3384
2831
3385
2832
atexit.register(cleanup)
3386
2833
3387
for client in tcp_server.clients.values():
2834
for client in tcp_server.clients.itervalues():
3388
2835
if use_dbus:
3389
# Emit D-Bus signal for adding
3390
mandos_dbus_service.client_added_signal(client)
2836
# Emit D-Bus signal
2837
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3391
2838
# Need to initiate checking of clients
3392
2839
if client.enabled:
3393
2840
client.init_checker()
3419
2866
sys.exit(1)
3420
2867
# End of Avahi example code
3421
2868
3422
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3423
lambda *args, **kwargs:
3424
(tcp_server.handle_request
3425
(*args[2:], **kwargs) or True))
2869
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2870
lambda *args, **kwargs:
2871
(tcp_server.handle_request
2872
(*args[2:], **kwargs) or True))
3426
2873
3427
2874
logger.debug("Starting main loop")
3428
2875
main_loop.run()
3438
2885
# Must run before the D-Bus bus name gets deregistered
3439
2886
cleanup()
3440
2887
3441
3442
2888
if __name__ == '__main__':
3443
2889
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0