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