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