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