To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 1201
- compare with another revision
- download diff
- download tarball
- view history from revision 1201
- Committer: teddy at recompile
- Date: 2020-02-05 21:39:28 UTC
- Revision ID: teddy@recompile.se-20200205213928-vpvt0fwfg47ikv6f
Allow users to alter ask-password-mandos.service
If a user uses dracut with systemd and wishes to modify the options
passed to password-agent(8mandos) or mandos-client(8mandos), they
should be able to do so by simply creating a file
/etc/systemd/system/ask-password-mandos.service.d/override.conf,
containing, for instance:
[Service]
Environment=MANDOS_CLIENT_OPTIONS=--debug
Adding PASSWORD_AGENT_OPTIONS should also be possible (but should not
normally be needed).
* dracut-module/ask-password-mandos.service ([Service]/ExecStart): Add
$PASSWORD_AGENT_OPTIONS before "--" and "$MANDOS_CLIENT_OPTIONS" to
end of line.
* dracut-module/module-setup.sh (install): Install all files named
/etc/systemd/system/ask-password-mandos.service.d/*.conf if any
exists. Also add --dh-params before $MANDOS_CLIENT_OPTIONS instead
of at end of line.
If a user uses dracut with systemd and wishes to modify the options
passed to password-agent(8mandos) or mandos-client(8mandos), they
should be able to do so by simply creating a file
/etc/systemd/system/ask-password-mandos.service.d/override.conf,
containing, for instance:
[Service]
Environment=MANDOS_CLIENT_OPTIONS=--debug
Adding PASSWORD_AGENT_OPTIONS should also be possible (but should not
normally be needed).
* dracut-module/ask-password-mandos.service ([Service]/ExecStart): Add
$PASSWORD_AGENT_OPTIONS before "--" and "$MANDOS_CLIENT_OPTIONS" to
end of line.
* dracut-module/module-setup.sh (install): Install all files named
/etc/systemd/system/ask-password-mandos.service.d/*.conf if any
exists. Also add --dh-params before $MANDOS_CLIENT_OPTIONS instead
of at end of line.
- files added:
- debian/mandos-client.templates
- debian/tests
- dracut-module
- files removed:
- initramfs-tools-hook-conf
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8 -*-
3
#
1
#!/usr/bin/python3 -bI
2
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
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-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
16
#
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
14
# Copyright © 2008-2019 Teddy Hogeborn
15
# Copyright © 2008-2019 Björn Påhlsson
16
#
17
# This file is part of Mandos.
18
#
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
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)
76
77
import itertools
77
78
import collections
78
79
import codecs
80
import unittest
81
import random
79
82
80
83
import dbus
81
84
import dbus.service
85
import gi
82
86
from gi.repository import GLib
83
87
from dbus.mainloop.glib import DBusGMainLoop
84
88
import ctypes
86
90
import xml.dom.minidom
87
91
import inspect
88
92
93
if sys.version_info.major == 2:
94
__metaclass__ = type
95
str = unicode
96
97
# Show warnings by default
98
if not sys.warnoptions:
99
import warnings
100
warnings.simplefilter("default")
101
89
102
# Try to find the value of SO_BINDTODEVICE:
90
103
try:
91
104
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
111
124
# No value found
112
125
SO_BINDTODEVICE = None
113
126
114
if sys.version_info.major == 2:
115
str = unicode
127
if sys.version_info < (3, 2):
128
configparser.Configparser = configparser.SafeConfigParser
116
129
117
version = "1.7.10"
130
version = "1.8.9"
118
131
stored_state_file = "clients.pickle"
119
132
120
133
logger = logging.getLogger()
134
logging.captureWarnings(True) # Show warnings via the logging system
121
135
syslogger = None
122
136
123
137
try:
124
138
if_nametoindex = ctypes.cdll.LoadLibrary(
125
139
ctypes.util.find_library("c")).if_nametoindex
126
140
except (OSError, AttributeError):
127
141
128
142
def if_nametoindex(interface):
129
143
"Get an interface index the hard way, i.e. using fcntl()"
130
144
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
153
167
154
168
def initlogger(debug, level=logging.WARNING):
155
169
"""init logger and add loglevel"""
156
170
157
171
global syslogger
158
172
syslogger = (logging.handlers.SysLogHandler(
159
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
160
address = "/dev/log"))
173
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
174
address="/dev/log"))
161
175
syslogger.setFormatter(logging.Formatter
162
176
('Mandos [%(process)d]: %(levelname)s:'
163
177
' %(message)s'))
164
178
logger.addHandler(syslogger)
165
179
166
180
if debug:
167
181
console = logging.StreamHandler()
168
182
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
178
192
pass
179
193
180
194
181
class PGPEngine(object):
195
class PGPEngine:
182
196
"""A simple class for OpenPGP symmetric encryption & decryption"""
183
197
184
198
def __init__(self):
185
199
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
186
200
self.gpg = "gpg"
188
202
output = subprocess.check_output(["gpgconf"])
189
203
for line in output.splitlines():
190
204
name, text, path = line.split(b":")
191
if name == "gpg":
205
if name == b"gpg":
192
206
self.gpg = path
193
207
break
194
208
except OSError as e:
199
213
'--force-mdc',
200
214
'--quiet']
201
215
# Only GPG version 1 has the --no-use-agent option.
202
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
216
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
203
217
self.gnupgargs.append("--no-use-agent")
204
218
205
219
def __enter__(self):
206
220
return self
207
221
208
222
def __exit__(self, exc_type, exc_value, traceback):
209
223
self._cleanup()
210
224
return False
211
225
212
226
def __del__(self):
213
227
self._cleanup()
214
228
215
229
def _cleanup(self):
216
230
if self.tempdir is not None:
217
231
# Delete contents of tempdir
218
232
for root, dirs, files in os.walk(self.tempdir,
219
topdown = False):
233
topdown=False):
220
234
for filename in files:
221
235
os.remove(os.path.join(root, filename))
222
236
for dirname in dirs:
224
238
# Remove tempdir
225
239
os.rmdir(self.tempdir)
226
240
self.tempdir = None
227
241
228
242
def password_encode(self, password):
229
243
# Passphrase can not be empty and can not contain newlines or
230
244
# NUL bytes. So we prefix it and hex encode it.
235
249
.replace(b"\n", b"\\n")
236
250
.replace(b"\0", b"\\x00"))
237
251
return encoded
238
252
239
253
def encrypt(self, data, password):
240
254
passphrase = self.password_encode(password)
241
255
with tempfile.NamedTemporaryFile(
246
260
'--passphrase-file',
247
261
passfile.name]
248
262
+ self.gnupgargs,
249
stdin = subprocess.PIPE,
250
stdout = subprocess.PIPE,
251
stderr = subprocess.PIPE)
252
ciphertext, err = proc.communicate(input = data)
263
stdin=subprocess.PIPE,
264
stdout=subprocess.PIPE,
265
stderr=subprocess.PIPE)
266
ciphertext, err = proc.communicate(input=data)
253
267
if proc.returncode != 0:
254
268
raise PGPError(err)
255
269
return ciphertext
256
270
257
271
def decrypt(self, data, password):
258
272
passphrase = self.password_encode(password)
259
273
with tempfile.NamedTemporaryFile(
260
dir = self.tempdir) as passfile:
274
dir=self.tempdir) as passfile:
261
275
passfile.write(passphrase)
262
276
passfile.flush()
263
277
proc = subprocess.Popen([self.gpg, '--decrypt',
264
278
'--passphrase-file',
265
279
passfile.name]
266
280
+ self.gnupgargs,
267
stdin = subprocess.PIPE,
268
stdout = subprocess.PIPE,
269
stderr = subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input = data)
281
stdin=subprocess.PIPE,
282
stdout=subprocess.PIPE,
283
stderr=subprocess.PIPE)
284
decrypted_plaintext, err = proc.communicate(input=data)
271
285
if proc.returncode != 0:
272
286
raise PGPError(err)
273
287
return decrypted_plaintext
274
288
289
275
290
# Pretend that we have an Avahi module
276
class Avahi(object):
277
"""This isn't so much a class as it is a module-like namespace.
278
It is instantiated once, and simulates having an Avahi module."""
279
IF_UNSPEC = -1 # avahi-common/address.h
280
PROTO_UNSPEC = -1 # avahi-common/address.h
281
PROTO_INET = 0 # avahi-common/address.h
282
PROTO_INET6 = 1 # avahi-common/address.h
291
class avahi:
292
"""This isn't so much a class as it is a module-like namespace."""
293
IF_UNSPEC = -1 # avahi-common/address.h
294
PROTO_UNSPEC = -1 # avahi-common/address.h
295
PROTO_INET = 0 # avahi-common/address.h
296
PROTO_INET6 = 1 # avahi-common/address.h
283
297
DBUS_NAME = "org.freedesktop.Avahi"
284
298
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
285
299
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
286
300
DBUS_PATH_SERVER = "/"
287
def string_array_to_txt_array(self, t):
301
302
@staticmethod
303
def string_array_to_txt_array(t):
288
304
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
289
305
for s in t), signature="ay")
290
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
291
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
292
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
293
SERVER_INVALID = 0 # avahi-common/defs.h
294
SERVER_REGISTERING = 1 # avahi-common/defs.h
295
SERVER_RUNNING = 2 # avahi-common/defs.h
296
SERVER_COLLISION = 3 # avahi-common/defs.h
297
SERVER_FAILURE = 4 # avahi-common/defs.h
298
avahi = Avahi()
306
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
307
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
308
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
309
SERVER_INVALID = 0 # avahi-common/defs.h
310
SERVER_REGISTERING = 1 # avahi-common/defs.h
311
SERVER_RUNNING = 2 # avahi-common/defs.h
312
SERVER_COLLISION = 3 # avahi-common/defs.h
313
SERVER_FAILURE = 4 # avahi-common/defs.h
314
299
315
300
316
class AvahiError(Exception):
301
317
def __init__(self, value, *args, **kwargs):
312
328
pass
313
329
314
330
315
class AvahiService(object):
331
class AvahiService:
316
332
"""An Avahi (Zeroconf) service.
317
333
318
334
Attributes:
319
335
interface: integer; avahi.IF_UNSPEC or an interface index.
320
336
Used to optionally bind to the specified interface.
332
348
server: D-Bus Server
333
349
bus: dbus.SystemBus()
334
350
"""
335
351
336
352
def __init__(self,
337
interface = avahi.IF_UNSPEC,
338
name = None,
339
servicetype = None,
340
port = None,
341
TXT = None,
342
domain = "",
343
host = "",
344
max_renames = 32768,
345
protocol = avahi.PROTO_UNSPEC,
346
bus = None):
353
interface=avahi.IF_UNSPEC,
354
name=None,
355
servicetype=None,
356
port=None,
357
TXT=None,
358
domain="",
359
host="",
360
max_renames=32768,
361
protocol=avahi.PROTO_UNSPEC,
362
bus=None):
347
363
self.interface = interface
348
364
self.name = name
349
365
self.type = servicetype
358
374
self.server = None
359
375
self.bus = bus
360
376
self.entry_group_state_changed_match = None
361
377
362
378
def rename(self, remove=True):
363
379
"""Derived from the Avahi example code"""
364
380
if self.rename_count >= self.max_renames:
384
400
logger.critical("D-Bus Exception", exc_info=error)
385
401
self.cleanup()
386
402
os._exit(1)
387
403
388
404
def remove(self):
389
405
"""Derived from the Avahi example code"""
390
406
if self.entry_group_state_changed_match is not None:
392
408
self.entry_group_state_changed_match = None
393
409
if self.group is not None:
394
410
self.group.Reset()
395
411
396
412
def add(self):
397
413
"""Derived from the Avahi example code"""
398
414
self.remove()
415
431
dbus.UInt16(self.port),
416
432
avahi.string_array_to_txt_array(self.TXT))
417
433
self.group.Commit()
418
434
419
435
def entry_group_state_changed(self, state, error):
420
436
"""Derived from the Avahi example code"""
421
437
logger.debug("Avahi entry group state change: %i", state)
422
438
423
439
if state == avahi.ENTRY_GROUP_ESTABLISHED:
424
440
logger.debug("Zeroconf service established.")
425
441
elif state == avahi.ENTRY_GROUP_COLLISION:
429
445
logger.critical("Avahi: Error in group state changed %s",
430
446
str(error))
431
447
raise AvahiGroupError("State changed: {!s}".format(error))
432
448
433
449
def cleanup(self):
434
450
"""Derived from the Avahi example code"""
435
451
if self.group is not None:
440
456
pass
441
457
self.group = None
442
458
self.remove()
443
459
444
460
def server_state_changed(self, state, error=None):
445
461
"""Derived from the Avahi example code"""
446
462
logger.debug("Avahi server state change: %i", state)
475
491
logger.debug("Unknown state: %r", state)
476
492
else:
477
493
logger.debug("Unknown state: %r: %r", state, error)
478
494
479
495
def activate(self):
480
496
"""Derived from the Avahi example code"""
481
497
if self.server is None:
492
508
class AvahiServiceToSyslog(AvahiService):
493
509
def rename(self, *args, **kwargs):
494
510
"""Add the new name to the syslog messages"""
495
ret = AvahiService.rename(self, *args, **kwargs)
511
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
496
512
syslogger.setFormatter(logging.Formatter(
497
513
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
498
514
.format(self.name)))
499
515
return ret
500
516
517
501
518
# Pretend that we have a GnuTLS module
502
class GnuTLS(object):
503
"""This isn't so much a class as it is a module-like namespace.
504
It is instantiated once, and simulates having a GnuTLS module."""
505
506
_library = ctypes.cdll.LoadLibrary(
507
ctypes.util.find_library("gnutls"))
508
_need_version = b"3.3.0"
509
def __init__(self):
510
# Need to use class name "GnuTLS" here, since this method is
511
# called before the assignment to the "gnutls" global variable
512
# happens.
513
if GnuTLS.check_version(self._need_version) is None:
514
raise GnuTLS.Error("Needs GnuTLS {} or later"
515
.format(self._need_version))
516
519
class gnutls:
520
"""This isn't so much a class as it is a module-like namespace."""
521
522
library = ctypes.util.find_library("gnutls")
523
if library is None:
524
library = ctypes.util.find_library("gnutls-deb0")
525
_library = ctypes.cdll.LoadLibrary(library)
526
del library
527
517
528
# Unless otherwise indicated, the constants and types below are
518
529
# all from the gnutls/gnutls.h C header file.
519
530
520
531
# Constants
521
532
E_SUCCESS = 0
522
533
E_INTERRUPTED = -52
523
534
E_AGAIN = -28
524
535
CRT_OPENPGP = 2
536
CRT_RAWPK = 3
525
537
CLIENT = 2
526
538
SHUT_RDWR = 0
527
539
CRD_CERTIFICATE = 1
528
540
E_NO_CERTIFICATE_FOUND = -49
541
X509_FMT_DER = 0
542
NO_TICKETS = 1<<10
543
ENABLE_RAWPK = 1<<18
544
CTYPE_PEERS = 3
545
KEYID_USE_SHA256 = 1 # gnutls/x509.h
529
546
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
530
547
531
548
# Types
532
549
class session_int(ctypes.Structure):
533
550
_fields_ = []
534
551
session_t = ctypes.POINTER(session_int)
552
535
553
class certificate_credentials_st(ctypes.Structure):
536
554
_fields_ = []
537
555
certificate_credentials_t = ctypes.POINTER(
538
556
certificate_credentials_st)
539
557
certificate_type_t = ctypes.c_int
558
540
559
class datum_t(ctypes.Structure):
541
560
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
542
561
('size', ctypes.c_uint)]
562
543
563
class openpgp_crt_int(ctypes.Structure):
544
564
_fields_ = []
545
565
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
546
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
566
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
547
567
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
548
568
credentials_type_t = ctypes.c_int
549
569
transport_ptr_t = ctypes.c_void_p
550
570
close_request_t = ctypes.c_int
551
571
552
572
# Exceptions
553
573
class Error(Exception):
554
# We need to use the class name "GnuTLS" here, since this
555
# exception might be raised from within GnuTLS.__init__,
556
# which is called before the assignment to the "gnutls"
557
# global variable has happened.
558
def __init__(self, message = None, code = None, args=()):
574
def __init__(self, message=None, code=None, args=()):
559
575
# Default usage is by a message string, but if a return
560
576
# code is passed, convert it to a string with
561
577
# gnutls.strerror()
562
578
self.code = code
563
579
if message is None and code is not None:
564
message = GnuTLS.strerror(code)
565
return super(GnuTLS.Error, self).__init__(
580
message = gnutls.strerror(code)
581
return super(gnutls.Error, self).__init__(
566
582
message, *args)
567
583
568
584
class CertificateSecurityError(Error):
569
585
pass
570
586
571
587
# Classes
572
class Credentials(object):
588
class Credentials:
573
589
def __init__(self):
574
590
self._c_object = gnutls.certificate_credentials_t()
575
591
gnutls.certificate_allocate_credentials(
576
592
ctypes.byref(self._c_object))
577
593
self.type = gnutls.CRD_CERTIFICATE
578
594
579
595
def __del__(self):
580
596
gnutls.certificate_free_credentials(self._c_object)
581
582
class ClientSession(object):
583
def __init__(self, socket, credentials = None):
597
598
class ClientSession:
599
def __init__(self, socket, credentials=None):
584
600
self._c_object = gnutls.session_t()
585
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
601
gnutls_flags = gnutls.CLIENT
602
if gnutls.check_version(b"3.5.6"):
603
gnutls_flags |= gnutls.NO_TICKETS
604
if gnutls.has_rawpk:
605
gnutls_flags |= gnutls.ENABLE_RAWPK
606
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
607
del gnutls_flags
586
608
gnutls.set_default_priority(self._c_object)
587
609
gnutls.transport_set_ptr(self._c_object, socket.fileno())
588
610
gnutls.handshake_set_private_extensions(self._c_object,
594
616
ctypes.cast(credentials._c_object,
595
617
ctypes.c_void_p))
596
618
self.credentials = credentials
597
619
598
620
def __del__(self):
599
621
gnutls.deinit(self._c_object)
600
622
601
623
def handshake(self):
602
624
return gnutls.handshake(self._c_object)
603
625
604
626
def send(self, data):
605
627
data = bytes(data)
606
628
data_len = len(data)
608
630
data_len -= gnutls.record_send(self._c_object,
609
631
data[-data_len:],
610
632
data_len)
611
633
612
634
def bye(self):
613
635
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
614
636
615
637
# Error handling functions
616
638
def _error_code(result):
617
639
"""A function to raise exceptions on errors, suitable
619
641
if result >= 0:
620
642
return result
621
643
if result == gnutls.E_NO_CERTIFICATE_FOUND:
622
raise gnutls.CertificateSecurityError(code = result)
623
raise gnutls.Error(code = result)
624
644
raise gnutls.CertificateSecurityError(code=result)
645
raise gnutls.Error(code=result)
646
625
647
def _retry_on_error(result, func, arguments):
626
648
"""A function to retry on some errors, suitable
627
649
for the 'errcheck' attribute on ctypes functions"""
630
652
return _error_code(result)
631
653
result = func(*arguments)
632
654
return result
633
655
634
656
# Unless otherwise indicated, the function declarations below are
635
657
# all from the gnutls/gnutls.h C header file.
636
658
637
659
# Functions
638
660
priority_set_direct = _library.gnutls_priority_set_direct
639
661
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
640
662
ctypes.POINTER(ctypes.c_char_p)]
641
663
priority_set_direct.restype = _error_code
642
664
643
665
init = _library.gnutls_init
644
666
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
645
667
init.restype = _error_code
646
668
647
669
set_default_priority = _library.gnutls_set_default_priority
648
670
set_default_priority.argtypes = [session_t]
649
671
set_default_priority.restype = _error_code
650
672
651
673
record_send = _library.gnutls_record_send
652
674
record_send.argtypes = [session_t, ctypes.c_void_p,
653
675
ctypes.c_size_t]
654
676
record_send.restype = ctypes.c_ssize_t
655
677
record_send.errcheck = _retry_on_error
656
678
657
679
certificate_allocate_credentials = (
658
680
_library.gnutls_certificate_allocate_credentials)
659
681
certificate_allocate_credentials.argtypes = [
660
682
ctypes.POINTER(certificate_credentials_t)]
661
683
certificate_allocate_credentials.restype = _error_code
662
684
663
685
certificate_free_credentials = (
664
686
_library.gnutls_certificate_free_credentials)
665
certificate_free_credentials.argtypes = [certificate_credentials_t]
687
certificate_free_credentials.argtypes = [
688
certificate_credentials_t]
666
689
certificate_free_credentials.restype = None
667
690
668
691
handshake_set_private_extensions = (
669
692
_library.gnutls_handshake_set_private_extensions)
670
693
handshake_set_private_extensions.argtypes = [session_t,
671
694
ctypes.c_int]
672
695
handshake_set_private_extensions.restype = None
673
696
674
697
credentials_set = _library.gnutls_credentials_set
675
698
credentials_set.argtypes = [session_t, credentials_type_t,
676
699
ctypes.c_void_p]
677
700
credentials_set.restype = _error_code
678
701
679
702
strerror = _library.gnutls_strerror
680
703
strerror.argtypes = [ctypes.c_int]
681
704
strerror.restype = ctypes.c_char_p
682
705
683
706
certificate_type_get = _library.gnutls_certificate_type_get
684
707
certificate_type_get.argtypes = [session_t]
685
708
certificate_type_get.restype = _error_code
686
709
687
710
certificate_get_peers = _library.gnutls_certificate_get_peers
688
711
certificate_get_peers.argtypes = [session_t,
689
712
ctypes.POINTER(ctypes.c_uint)]
690
713
certificate_get_peers.restype = ctypes.POINTER(datum_t)
691
714
692
715
global_set_log_level = _library.gnutls_global_set_log_level
693
716
global_set_log_level.argtypes = [ctypes.c_int]
694
717
global_set_log_level.restype = None
695
718
696
719
global_set_log_function = _library.gnutls_global_set_log_function
697
720
global_set_log_function.argtypes = [log_func]
698
721
global_set_log_function.restype = None
699
722
700
723
deinit = _library.gnutls_deinit
701
724
deinit.argtypes = [session_t]
702
725
deinit.restype = None
703
726
704
727
handshake = _library.gnutls_handshake
705
728
handshake.argtypes = [session_t]
706
729
handshake.restype = _error_code
707
730
handshake.errcheck = _retry_on_error
708
731
709
732
transport_set_ptr = _library.gnutls_transport_set_ptr
710
733
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
711
734
transport_set_ptr.restype = None
712
735
713
736
bye = _library.gnutls_bye
714
737
bye.argtypes = [session_t, close_request_t]
715
738
bye.restype = _error_code
716
739
bye.errcheck = _retry_on_error
717
740
718
741
check_version = _library.gnutls_check_version
719
742
check_version.argtypes = [ctypes.c_char_p]
720
743
check_version.restype = ctypes.c_char_p
721
722
# All the function declarations below are from gnutls/openpgp.h
723
724
openpgp_crt_init = _library.gnutls_openpgp_crt_init
725
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
726
openpgp_crt_init.restype = _error_code
727
728
openpgp_crt_import = _library.gnutls_openpgp_crt_import
729
openpgp_crt_import.argtypes = [openpgp_crt_t,
730
ctypes.POINTER(datum_t),
731
openpgp_crt_fmt_t]
732
openpgp_crt_import.restype = _error_code
733
734
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
735
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
736
ctypes.POINTER(ctypes.c_uint)]
737
openpgp_crt_verify_self.restype = _error_code
738
739
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
740
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
741
openpgp_crt_deinit.restype = None
742
743
openpgp_crt_get_fingerprint = (
744
_library.gnutls_openpgp_crt_get_fingerprint)
745
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
746
ctypes.c_void_p,
747
ctypes.POINTER(
748
ctypes.c_size_t)]
749
openpgp_crt_get_fingerprint.restype = _error_code
750
744
745
_need_version = b"3.3.0"
746
if check_version(_need_version) is None:
747
raise self.Error("Needs GnuTLS {} or later"
748
.format(_need_version))
749
750
_tls_rawpk_version = b"3.6.6"
751
has_rawpk = bool(check_version(_tls_rawpk_version))
752
753
if has_rawpk:
754
# Types
755
class pubkey_st(ctypes.Structure):
756
_fields = []
757
pubkey_t = ctypes.POINTER(pubkey_st)
758
759
x509_crt_fmt_t = ctypes.c_int
760
761
# All the function declarations below are from gnutls/abstract.h
762
pubkey_init = _library.gnutls_pubkey_init
763
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
764
pubkey_init.restype = _error_code
765
766
pubkey_import = _library.gnutls_pubkey_import
767
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
768
x509_crt_fmt_t]
769
pubkey_import.restype = _error_code
770
771
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
772
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
773
ctypes.POINTER(ctypes.c_ubyte),
774
ctypes.POINTER(ctypes.c_size_t)]
775
pubkey_get_key_id.restype = _error_code
776
777
pubkey_deinit = _library.gnutls_pubkey_deinit
778
pubkey_deinit.argtypes = [pubkey_t]
779
pubkey_deinit.restype = None
780
else:
781
# All the function declarations below are from gnutls/openpgp.h
782
783
openpgp_crt_init = _library.gnutls_openpgp_crt_init
784
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
785
openpgp_crt_init.restype = _error_code
786
787
openpgp_crt_import = _library.gnutls_openpgp_crt_import
788
openpgp_crt_import.argtypes = [openpgp_crt_t,
789
ctypes.POINTER(datum_t),
790
openpgp_crt_fmt_t]
791
openpgp_crt_import.restype = _error_code
792
793
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
794
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
795
ctypes.POINTER(ctypes.c_uint)]
796
openpgp_crt_verify_self.restype = _error_code
797
798
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
799
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
800
openpgp_crt_deinit.restype = None
801
802
openpgp_crt_get_fingerprint = (
803
_library.gnutls_openpgp_crt_get_fingerprint)
804
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
805
ctypes.c_void_p,
806
ctypes.POINTER(
807
ctypes.c_size_t)]
808
openpgp_crt_get_fingerprint.restype = _error_code
809
810
if check_version(b"3.6.4"):
811
certificate_type_get2 = _library.gnutls_certificate_type_get2
812
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
813
certificate_type_get2.restype = _error_code
814
751
815
# Remove non-public functions
752
816
del _error_code, _retry_on_error
753
# Create the global "gnutls" object, simulating a module
754
gnutls = GnuTLS()
817
755
818
756
819
def call_pipe(connection, # : multiprocessing.Connection
757
820
func, *args, **kwargs):
758
821
"""This function is meant to be called by multiprocessing.Process
759
822
760
823
This function runs func(*args, **kwargs), and writes the resulting
761
824
return value on the provided multiprocessing.Connection.
762
825
"""
763
826
connection.send(func(*args, **kwargs))
764
827
connection.close()
765
828
766
class Client(object):
829
830
class Client:
767
831
"""A representation of a client host served by this server.
768
832
769
833
Attributes:
770
834
approved: bool(); 'None' if not yet approved/disapproved
771
835
approval_delay: datetime.timedelta(); Time to wait for approval
772
836
approval_duration: datetime.timedelta(); Duration of one approval
773
checker: subprocess.Popen(); a running checker process used
774
to see if the client lives.
775
'None' if no process is running.
837
checker: multiprocessing.Process(); a running checker process used
838
to see if the client lives. 'None' if no process is
839
running.
776
840
checker_callback_tag: a GLib event source tag, or None
777
841
checker_command: string; External command which is run to check
778
842
if client lives. %() expansions are done at
786
850
disable_initiator_tag: a GLib event source tag, or None
787
851
enabled: bool()
788
852
fingerprint: string (40 or 32 hexadecimal digits); used to
789
uniquely identify the client
853
uniquely identify an OpenPGP client
854
key_id: string (64 hexadecimal digits); used to uniquely identify
855
a client using raw public keys
790
856
host: string; available for use by the checker command
791
857
interval: datetime.timedelta(); How often to start a new checker
792
858
last_approval_request: datetime.datetime(); (UTC) or None
808
874
disabled, or None
809
875
server_settings: The server_settings dict from main()
810
876
"""
811
877
812
878
runtime_expansions = ("approval_delay", "approval_duration",
813
"created", "enabled", "expires",
879
"created", "enabled", "expires", "key_id",
814
880
"fingerprint", "host", "interval",
815
881
"last_approval_request", "last_checked_ok",
816
882
"last_enabled", "name", "timeout")
825
891
"approved_by_default": "True",
826
892
"enabled": "True",
827
893
}
828
894
829
895
@staticmethod
830
896
def config_parser(config):
831
897
"""Construct a new dict of client settings of this form:
838
904
for client_name in config.sections():
839
905
section = dict(config.items(client_name))
840
906
client = settings[client_name] = {}
841
907
842
908
client["host"] = section["host"]
843
909
# Reformat values from string types to Python types
844
910
client["approved_by_default"] = config.getboolean(
845
911
client_name, "approved_by_default")
846
912
client["enabled"] = config.getboolean(client_name,
847
913
"enabled")
848
849
# Uppercase and remove spaces from fingerprint for later
850
# comparison purposes with return value from the
851
# fingerprint() function
914
915
# Uppercase and remove spaces from key_id and fingerprint
916
# for later comparison purposes with return value from the
917
# key_id() and fingerprint() functions
918
client["key_id"] = (section.get("key_id", "").upper()
919
.replace(" ", ""))
852
920
client["fingerprint"] = (section["fingerprint"].upper()
853
921
.replace(" ", ""))
854
922
if "secret" in section:
875
943
client["last_approval_request"] = None
876
944
client["last_checked_ok"] = None
877
945
client["last_checker_status"] = -2
878
946
879
947
return settings
880
881
def __init__(self, settings, name = None, server_settings=None):
948
949
def __init__(self, settings, name=None, server_settings=None):
882
950
self.name = name
883
951
if server_settings is None:
884
952
server_settings = {}
886
954
# adding all client settings
887
955
for setting, value in settings.items():
888
956
setattr(self, setting, value)
889
957
890
958
if self.enabled:
891
959
if not hasattr(self, "last_enabled"):
892
960
self.last_enabled = datetime.datetime.utcnow()
896
964
else:
897
965
self.last_enabled = None
898
966
self.expires = None
899
967
900
968
logger.debug("Creating client %r", self.name)
969
logger.debug(" Key ID: %s", self.key_id)
901
970
logger.debug(" Fingerprint: %s", self.fingerprint)
902
971
self.created = settings.get("created",
903
972
datetime.datetime.utcnow())
904
973
905
974
# attributes specific for this server instance
906
975
self.checker = None
907
976
self.checker_initiator_tag = None
916
985
for attr in self.__dict__.keys()
917
986
if not attr.startswith("_")]
918
987
self.client_structure.append("client_structure")
919
988
920
989
for name, t in inspect.getmembers(
921
990
type(self), lambda obj: isinstance(obj, property)):
922
991
if not name.startswith("_"):
923
992
self.client_structure.append(name)
924
993
925
994
# Send notice to process children that client state has changed
926
995
def send_changedstate(self):
927
996
with self.changedstate:
928
997
self.changedstate.notify_all()
929
998
930
999
def enable(self):
931
1000
"""Start this client's checker and timeout hooks"""
932
1001
if getattr(self, "enabled", False):
937
1006
self.last_enabled = datetime.datetime.utcnow()
938
1007
self.init_checker()
939
1008
self.send_changedstate()
940
1009
941
1010
def disable(self, quiet=True):
942
1011
"""Disable this client."""
943
1012
if not getattr(self, "enabled", False):
957
1026
self.send_changedstate()
958
1027
# Do not run this again if called by a GLib.timeout_add
959
1028
return False
960
1029
961
1030
def __del__(self):
962
1031
self.disable()
963
1032
964
1033
def init_checker(self):
965
1034
# Schedule a new checker to be started an 'interval' from now,
966
1035
# and every interval from then on.
967
1036
if self.checker_initiator_tag is not None:
968
1037
GLib.source_remove(self.checker_initiator_tag)
969
1038
self.checker_initiator_tag = GLib.timeout_add(
970
int(self.interval.total_seconds() * 1000),
1039
random.randrange(int(self.interval.total_seconds() * 1000
1040
+ 1)),
971
1041
self.start_checker)
972
1042
# Schedule a disable() when 'timeout' has passed
973
1043
if self.disable_initiator_tag is not None:
976
1046
int(self.timeout.total_seconds() * 1000), self.disable)
977
1047
# Also start a new checker *right now*.
978
1048
self.start_checker()
979
1049
980
1050
def checker_callback(self, source, condition, connection,
981
1051
command):
982
1052
"""The checker has completed, so take appropriate actions."""
983
self.checker_callback_tag = None
984
self.checker = None
985
1053
# Read return code from connection (see call_pipe)
986
1054
returncode = connection.recv()
987
1055
connection.close()
988
1056
if self.checker is not None:
1057
self.checker.join()
1058
self.checker_callback_tag = None
1059
self.checker = None
1060
989
1061
if returncode >= 0:
990
1062
self.last_checker_status = returncode
991
1063
self.last_checker_signal = None
1001
1073
logger.warning("Checker for %(name)s crashed?",
1002
1074
vars(self))
1003
1075
return False
1004
1076
1005
1077
def checked_ok(self):
1006
1078
"""Assert that the client has been seen, alive and well."""
1007
1079
self.last_checked_ok = datetime.datetime.utcnow()
1008
1080
self.last_checker_status = 0
1009
1081
self.last_checker_signal = None
1010
1082
self.bump_timeout()
1011
1083
1012
1084
def bump_timeout(self, timeout=None):
1013
1085
"""Bump up the timeout for this client."""
1014
1086
if timeout is None:
1020
1092
self.disable_initiator_tag = GLib.timeout_add(
1021
1093
int(timeout.total_seconds() * 1000), self.disable)
1022
1094
self.expires = datetime.datetime.utcnow() + timeout
1023
1095
1024
1096
def need_approval(self):
1025
1097
self.last_approval_request = datetime.datetime.utcnow()
1026
1098
1027
1099
def start_checker(self):
1028
1100
"""Start a new checker subprocess if one is not running.
1029
1101
1030
1102
If a checker already exists, leave it running and do
1031
1103
nothing."""
1032
1104
# The reason for not killing a running checker is that if we
1037
1109
# checkers alone, the checker would have to take more time
1038
1110
# than 'timeout' for the client to be disabled, which is as it
1039
1111
# should be.
1040
1112
1041
1113
if self.checker is not None and not self.checker.is_alive():
1042
1114
logger.warning("Checker was not alive; joining")
1043
1115
self.checker.join()
1047
1119
# Escape attributes for the shell
1048
1120
escaped_attrs = {
1049
1121
attr: re.escape(str(getattr(self, attr)))
1050
for attr in self.runtime_expansions }
1122
for attr in self.runtime_expansions}
1051
1123
try:
1052
1124
command = self.checker_command % escaped_attrs
1053
1125
except TypeError as error:
1065
1137
# The exception is when not debugging but nevertheless
1066
1138
# running in the foreground; use the previously
1067
1139
# created wnull.
1068
popen_args = { "close_fds": True,
1069
"shell": True,
1070
"cwd": "/" }
1140
popen_args = {"close_fds": True,
1141
"shell": True,
1142
"cwd": "/"}
1071
1143
if (not self.server_settings["debug"]
1072
1144
and self.server_settings["foreground"]):
1073
1145
popen_args.update({"stdout": wnull,
1074
"stderr": wnull })
1075
pipe = multiprocessing.Pipe(duplex = False)
1146
"stderr": wnull})
1147
pipe = multiprocessing.Pipe(duplex=False)
1076
1148
self.checker = multiprocessing.Process(
1077
target = call_pipe,
1078
args = (pipe[1], subprocess.call, command),
1079
kwargs = popen_args)
1149
target=call_pipe,
1150
args=(pipe[1], subprocess.call, command),
1151
kwargs=popen_args)
1080
1152
self.checker.start()
1081
1153
self.checker_callback_tag = GLib.io_add_watch(
1082
pipe[0].fileno(), GLib.IO_IN,
1154
GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1083
1156
self.checker_callback, pipe[0], command)
1084
1157
# Re-run this periodically if run by GLib.timeout_add
1085
1158
return True
1086
1159
1087
1160
def stop_checker(self):
1088
1161
"""Force the checker process, if any, to stop."""
1089
1162
if self.checker_callback_tag:
1102
1175
byte_arrays=False):
1103
1176
"""Decorators for marking methods of a DBusObjectWithProperties to
1104
1177
become properties on the D-Bus.
1105
1178
1106
1179
The decorated method will be called with no arguments by "Get"
1107
1180
and with one argument by "Set".
1108
1181
1109
1182
The parameters, where they are supported, are the same as
1110
1183
dbus.service.method, except there is only "signature", since the
1111
1184
type from Get() and the type sent to Set() is the same.
1115
1188
if byte_arrays and signature != "ay":
1116
1189
raise ValueError("Byte arrays not supported for non-'ay'"
1117
1190
" signature {!r}".format(signature))
1118
1191
1119
1192
def decorator(func):
1120
1193
func._dbus_is_property = True
1121
1194
func._dbus_interface = dbus_interface
1124
1197
func._dbus_name = func.__name__
1125
1198
if func._dbus_name.endswith("_dbus_property"):
1126
1199
func._dbus_name = func._dbus_name[:-14]
1127
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1200
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1128
1201
return func
1129
1202
1130
1203
return decorator
1131
1204
1132
1205
1133
1206
def dbus_interface_annotations(dbus_interface):
1134
1207
"""Decorator for marking functions returning interface annotations
1135
1208
1136
1209
Usage:
1137
1210
1138
1211
@dbus_interface_annotations("org.example.Interface")
1139
1212
def _foo(self): # Function name does not matter
1140
1213
return {"org.freedesktop.DBus.Deprecated": "true",
1141
1214
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1142
1215
"false"}
1143
1216
"""
1144
1217
1145
1218
def decorator(func):
1146
1219
func._dbus_is_interface = True
1147
1220
func._dbus_interface = dbus_interface
1148
1221
func._dbus_name = dbus_interface
1149
1222
return func
1150
1223
1151
1224
return decorator
1152
1225
1153
1226
1154
1227
def dbus_annotations(annotations):
1155
1228
"""Decorator to annotate D-Bus methods, signals or properties
1156
1229
Usage:
1157
1230
1158
1231
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1159
1232
"org.freedesktop.DBus.Property."
1160
1233
"EmitsChangedSignal": "false"})
1162
1235
access="r")
1163
1236
def Property_dbus_property(self):
1164
1237
return dbus.Boolean(False)
1165
1238
1166
1239
See also the DBusObjectWithAnnotations class.
1167
1240
"""
1168
1241
1169
1242
def decorator(func):
1170
1243
func._dbus_annotations = annotations
1171
1244
return func
1172
1245
1173
1246
return decorator
1174
1247
1175
1248
1193
1266
1194
1267
class DBusObjectWithAnnotations(dbus.service.Object):
1195
1268
"""A D-Bus object with annotations.
1196
1269
1197
1270
Classes inheriting from this can use the dbus_annotations
1198
1271
decorator to add annotations to methods or signals.
1199
1272
"""
1200
1273
1201
1274
@staticmethod
1202
1275
def _is_dbus_thing(thing):
1203
1276
"""Returns a function testing if an attribute is a D-Bus thing
1204
1277
1205
1278
If called like _is_dbus_thing("method") it returns a function
1206
1279
suitable for use as predicate to inspect.getmembers().
1207
1280
"""
1208
1281
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1209
1282
False)
1210
1283
1211
1284
def _get_all_dbus_things(self, thing):
1212
1285
"""Returns a generator of (name, attribute) pairs
1213
1286
"""
1216
1289
for cls in self.__class__.__mro__
1217
1290
for name, athing in
1218
1291
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1219
1292
1220
1293
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1221
out_signature = "s",
1222
path_keyword = 'object_path',
1223
connection_keyword = 'connection')
1294
out_signature="s",
1295
path_keyword='object_path',
1296
connection_keyword='connection')
1224
1297
def Introspect(self, object_path, connection):
1225
1298
"""Overloading of standard D-Bus method.
1226
1299
1227
1300
Inserts annotation tags on methods and signals.
1228
1301
"""
1229
1302
xmlstring = dbus.service.Object.Introspect(self, object_path,
1230
1303
connection)
1231
1304
try:
1232
1305
document = xml.dom.minidom.parseString(xmlstring)
1233
1306
1234
1307
for if_tag in document.getElementsByTagName("interface"):
1235
1308
# Add annotation tags
1236
1309
for typ in ("method", "signal"):
1263
1336
if_tag.appendChild(ann_tag)
1264
1337
# Fix argument name for the Introspect method itself
1265
1338
if (if_tag.getAttribute("name")
1266
== dbus.INTROSPECTABLE_IFACE):
1339
== dbus.INTROSPECTABLE_IFACE):
1267
1340
for cn in if_tag.getElementsByTagName("method"):
1268
1341
if cn.getAttribute("name") == "Introspect":
1269
1342
for arg in cn.getElementsByTagName("arg"):
1282
1355
1283
1356
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1284
1357
"""A D-Bus object with properties.
1285
1358
1286
1359
Classes inheriting from this can use the dbus_service_property
1287
1360
decorator to expose methods as D-Bus properties. It exposes the
1288
1361
standard Get(), Set(), and GetAll() methods on the D-Bus.
1289
1362
"""
1290
1363
1291
1364
def _get_dbus_property(self, interface_name, property_name):
1292
1365
"""Returns a bound method if one exists which is a D-Bus
1293
1366
property with the specified name and interface.
1298
1371
if (value._dbus_name == property_name
1299
1372
and value._dbus_interface == interface_name):
1300
1373
return value.__get__(self)
1301
1374
1302
1375
# No such property
1303
1376
raise DBusPropertyNotFound("{}:{}.{}".format(
1304
1377
self.dbus_object_path, interface_name, property_name))
1305
1378
1306
1379
@classmethod
1307
1380
def _get_all_interface_names(cls):
1308
1381
"""Get a sequence of all interfaces supported by an object"""
1311
1384
for x in (inspect.getmro(cls))
1312
1385
for attr in dir(x))
1313
1386
if name is not None)
1314
1387
1315
1388
@dbus.service.method(dbus.PROPERTIES_IFACE,
1316
1389
in_signature="ss",
1317
1390
out_signature="v")
1325
1398
if not hasattr(value, "variant_level"):
1326
1399
return value
1327
1400
return type(value)(value, variant_level=value.variant_level+1)
1328
1401
1329
1402
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1330
1403
def Set(self, interface_name, property_name, value):
1331
1404
"""Standard D-Bus property Set() method, see D-Bus standard.
1340
1413
raise ValueError("Byte arrays not supported for non-"
1341
1414
"'ay' signature {!r}"
1342
1415
.format(prop._dbus_signature))
1343
value = dbus.ByteArray(b''.join(chr(byte)
1344
for byte in value))
1416
value = dbus.ByteArray(bytes(value))
1345
1417
prop(value)
1346
1418
1347
1419
@dbus.service.method(dbus.PROPERTIES_IFACE,
1348
1420
in_signature="s",
1349
1421
out_signature="a{sv}")
1350
1422
def GetAll(self, interface_name):
1351
1423
"""Standard D-Bus property GetAll() method, see D-Bus
1352
1424
standard.
1353
1425
1354
1426
Note: Will not include properties with access="write".
1355
1427
"""
1356
1428
properties = {}
1367
1439
properties[name] = value
1368
1440
continue
1369
1441
properties[name] = type(value)(
1370
value, variant_level = value.variant_level + 1)
1442
value, variant_level=value.variant_level + 1)
1371
1443
return dbus.Dictionary(properties, signature="sv")
1372
1444
1373
1445
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1374
1446
def PropertiesChanged(self, interface_name, changed_properties,
1375
1447
invalidated_properties):
1377
1449
standard.
1378
1450
"""
1379
1451
pass
1380
1452
1381
1453
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1382
1454
out_signature="s",
1383
1455
path_keyword='object_path',
1384
1456
connection_keyword='connection')
1385
1457
def Introspect(self, object_path, connection):
1386
1458
"""Overloading of standard D-Bus method.
1387
1459
1388
1460
Inserts property tags and interface annotation tags.
1389
1461
"""
1390
1462
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1392
1464
connection)
1393
1465
try:
1394
1466
document = xml.dom.minidom.parseString(xmlstring)
1395
1467
1396
1468
def make_tag(document, name, prop):
1397
1469
e = document.createElement("property")
1398
1470
e.setAttribute("name", name)
1399
1471
e.setAttribute("type", prop._dbus_signature)
1400
1472
e.setAttribute("access", prop._dbus_access)
1401
1473
return e
1402
1474
1403
1475
for if_tag in document.getElementsByTagName("interface"):
1404
1476
# Add property tags
1405
1477
for tag in (make_tag(document, name, prop)
1447
1519
exc_info=error)
1448
1520
return xmlstring
1449
1521
1522
1450
1523
try:
1451
1524
dbus.OBJECT_MANAGER_IFACE
1452
1525
except AttributeError:
1453
1526
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1454
1527
1528
1455
1529
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1456
1530
"""A D-Bus object with an ObjectManager.
1457
1531
1458
1532
Classes inheriting from this exposes the standard
1459
1533
GetManagedObjects call and the InterfacesAdded and
1460
1534
InterfacesRemoved signals on the standard
1461
1535
"org.freedesktop.DBus.ObjectManager" interface.
1462
1536
1463
1537
Note: No signals are sent automatically; they must be sent
1464
1538
manually.
1465
1539
"""
1466
1540
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1467
out_signature = "a{oa{sa{sv}}}")
1541
out_signature="a{oa{sa{sv}}}")
1468
1542
def GetManagedObjects(self):
1469
1543
"""This function must be overridden"""
1470
1544
raise NotImplementedError()
1471
1545
1472
1546
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1473
signature = "oa{sa{sv}}")
1547
signature="oa{sa{sv}}")
1474
1548
def InterfacesAdded(self, object_path, interfaces_and_properties):
1475
1549
pass
1476
1477
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1550
1551
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1478
1552
def InterfacesRemoved(self, object_path, interfaces):
1479
1553
pass
1480
1554
1481
1555
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1482
out_signature = "s",
1483
path_keyword = 'object_path',
1484
connection_keyword = 'connection')
1556
out_signature="s",
1557
path_keyword='object_path',
1558
connection_keyword='connection')
1485
1559
def Introspect(self, object_path, connection):
1486
1560
"""Overloading of standard D-Bus method.
1487
1561
1488
1562
Override return argument name of GetManagedObjects to be
1489
1563
"objpath_interfaces_and_properties"
1490
1564
"""
1493
1567
connection)
1494
1568
try:
1495
1569
document = xml.dom.minidom.parseString(xmlstring)
1496
1570
1497
1571
for if_tag in document.getElementsByTagName("interface"):
1498
1572
# Fix argument name for the GetManagedObjects method
1499
1573
if (if_tag.getAttribute("name")
1500
== dbus.OBJECT_MANAGER_IFACE):
1574
== dbus.OBJECT_MANAGER_IFACE):
1501
1575
for cn in if_tag.getElementsByTagName("method"):
1502
1576
if (cn.getAttribute("name")
1503
1577
== "GetManagedObjects"):
1513
1587
except (AttributeError, xml.dom.DOMException,
1514
1588
xml.parsers.expat.ExpatError) as error:
1515
1589
logger.error("Failed to override Introspection method",
1516
exc_info = error)
1590
exc_info=error)
1517
1591
return xmlstring
1518
1592
1593
1519
1594
def datetime_to_dbus(dt, variant_level=0):
1520
1595
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1521
1596
if dt is None:
1522
return dbus.String("", variant_level = variant_level)
1597
return dbus.String("", variant_level=variant_level)
1523
1598
return dbus.String(dt.isoformat(), variant_level=variant_level)
1524
1599
1525
1600
1528
1603
dbus.service.Object, it will add alternate D-Bus attributes with
1529
1604
interface names according to the "alt_interface_names" mapping.
1530
1605
Usage:
1531
1606
1532
1607
@alternate_dbus_interfaces({"org.example.Interface":
1533
1608
"net.example.AlternateInterface"})
1534
1609
class SampleDBusObject(dbus.service.Object):
1535
1610
@dbus.service.method("org.example.Interface")
1536
1611
def SampleDBusMethod():
1537
1612
pass
1538
1613
1539
1614
The above "SampleDBusMethod" on "SampleDBusObject" will be
1540
1615
reachable via two interfaces: "org.example.Interface" and
1541
1616
"net.example.AlternateInterface", the latter of which will have
1542
1617
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1543
1618
"true", unless "deprecate" is passed with a False value.
1544
1619
1545
1620
This works for methods and signals, and also for D-Bus properties
1546
1621
(from DBusObjectWithProperties) and interfaces (from the
1547
1622
dbus_interface_annotations decorator).
1548
1623
"""
1549
1624
1550
1625
def wrapper(cls):
1551
1626
for orig_interface_name, alt_interface_name in (
1552
1627
alt_interface_names.items()):
1592
1667
attribute._dbus_annotations)
1593
1668
except AttributeError:
1594
1669
pass
1670
1595
1671
# Define a creator of a function to call both the
1596
1672
# original and alternate functions, so both the
1597
1673
# original and alternate signals gets sent when
1600
1676
"""This function is a scope container to pass
1601
1677
func1 and func2 to the "call_both" function
1602
1678
outside of its arguments"""
1603
1679
1604
1680
@functools.wraps(func2)
1605
1681
def call_both(*args, **kwargs):
1606
1682
"""This function will emit two D-Bus
1607
1683
signals by calling func1 and func2"""
1608
1684
func1(*args, **kwargs)
1609
1685
func2(*args, **kwargs)
1610
# Make wrapper function look like a D-Bus signal
1686
# Make wrapper function look like a D-Bus
1687
# signal
1611
1688
for name, attr in inspect.getmembers(func2):
1612
1689
if name.startswith("_dbus_"):
1613
1690
setattr(call_both, name, attr)
1614
1691
1615
1692
return call_both
1616
1693
# Create the "call_both" function and add it to
1617
1694
# the class
1663
1740
(copy_function(attribute)))
1664
1741
if deprecate:
1665
1742
# Deprecate all alternate interfaces
1666
iname="_AlternateDBusNames_interface_annotation{}"
1743
iname = "_AlternateDBusNames_interface_annotation{}"
1667
1744
for interface_name in interface_names:
1668
1745
1669
1746
@dbus_interface_annotations(interface_name)
1670
1747
def func(self):
1671
return { "org.freedesktop.DBus.Deprecated":
1672
"true" }
1748
return {"org.freedesktop.DBus.Deprecated":
1749
"true"}
1673
1750
# Find an unused name
1674
1751
for aname in (iname.format(i)
1675
1752
for i in itertools.count()):
1686
1763
cls = type("{}Alternate".format(cls.__name__),
1687
1764
(cls, ), attr)
1688
1765
return cls
1689
1766
1690
1767
return wrapper
1691
1768
1692
1769
1694
1771
"se.bsnet.fukt.Mandos"})
1695
1772
class ClientDBus(Client, DBusObjectWithProperties):
1696
1773
"""A Client class using D-Bus
1697
1774
1698
1775
Attributes:
1699
1776
dbus_object_path: dbus.ObjectPath
1700
1777
bus: dbus.SystemBus()
1701
1778
"""
1702
1779
1703
1780
runtime_expansions = (Client.runtime_expansions
1704
1781
+ ("dbus_object_path", ))
1705
1782
1706
1783
_interface = "se.recompile.Mandos.Client"
1707
1784
1708
1785
# dbus.service.Object doesn't use super(), so we can't either.
1709
1710
def __init__(self, bus = None, *args, **kwargs):
1786
1787
def __init__(self, bus=None, *args, **kwargs):
1711
1788
self.bus = bus
1712
1789
Client.__init__(self, *args, **kwargs)
1713
1790
# Only now, when this client is initialized, can it show up on
1719
1796
"/clients/" + client_object_name)
1720
1797
DBusObjectWithProperties.__init__(self, self.bus,
1721
1798
self.dbus_object_path)
1722
1799
1723
1800
def notifychangeproperty(transform_func, dbus_name,
1724
1801
type_func=lambda x: x,
1725
1802
variant_level=1,
1727
1804
_interface=_interface):
1728
1805
""" Modify a variable so that it's a property which announces
1729
1806
its changes to DBus.
1730
1807
1731
1808
transform_fun: Function that takes a value and a variant_level
1732
1809
and transforms it to a D-Bus type.
1733
1810
dbus_name: D-Bus name of the variable
1736
1813
variant_level: D-Bus variant level. Default: 1
1737
1814
"""
1738
1815
attrname = "_{}".format(dbus_name)
1739
1816
1740
1817
def setter(self, value):
1741
1818
if hasattr(self, "dbus_object_path"):
1742
1819
if (not hasattr(self, attrname) or
1749
1826
else:
1750
1827
dbus_value = transform_func(
1751
1828
type_func(value),
1752
variant_level = variant_level)
1829
variant_level=variant_level)
1753
1830
self.PropertyChanged(dbus.String(dbus_name),
1754
1831
dbus_value)
1755
1832
self.PropertiesChanged(
1756
1833
_interface,
1757
dbus.Dictionary({ dbus.String(dbus_name):
1758
dbus_value }),
1834
dbus.Dictionary({dbus.String(dbus_name):
1835
dbus_value}),
1759
1836
dbus.Array())
1760
1837
setattr(self, attrname, value)
1761
1838
1762
1839
return property(lambda self: getattr(self, attrname), setter)
1763
1840
1764
1841
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1765
1842
approvals_pending = notifychangeproperty(dbus.Boolean,
1766
1843
"ApprovalPending",
1767
type_func = bool)
1844
type_func=bool)
1768
1845
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1769
1846
last_enabled = notifychangeproperty(datetime_to_dbus,
1770
1847
"LastEnabled")
1771
1848
checker = notifychangeproperty(
1772
1849
dbus.Boolean, "CheckerRunning",
1773
type_func = lambda checker: checker is not None)
1850
type_func=lambda checker: checker is not None)
1774
1851
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1775
1852
"LastCheckedOK")
1776
1853
last_checker_status = notifychangeproperty(dbus.Int16,
1781
1858
"ApprovedByDefault")
1782
1859
approval_delay = notifychangeproperty(
1783
1860
dbus.UInt64, "ApprovalDelay",
1784
type_func = lambda td: td.total_seconds() * 1000)
1861
type_func=lambda td: td.total_seconds() * 1000)
1785
1862
approval_duration = notifychangeproperty(
1786
1863
dbus.UInt64, "ApprovalDuration",
1787
type_func = lambda td: td.total_seconds() * 1000)
1864
type_func=lambda td: td.total_seconds() * 1000)
1788
1865
host = notifychangeproperty(dbus.String, "Host")
1789
1866
timeout = notifychangeproperty(
1790
1867
dbus.UInt64, "Timeout",
1791
type_func = lambda td: td.total_seconds() * 1000)
1868
type_func=lambda td: td.total_seconds() * 1000)
1792
1869
extended_timeout = notifychangeproperty(
1793
1870
dbus.UInt64, "ExtendedTimeout",
1794
type_func = lambda td: td.total_seconds() * 1000)
1871
type_func=lambda td: td.total_seconds() * 1000)
1795
1872
interval = notifychangeproperty(
1796
1873
dbus.UInt64, "Interval",
1797
type_func = lambda td: td.total_seconds() * 1000)
1874
type_func=lambda td: td.total_seconds() * 1000)
1798
1875
checker_command = notifychangeproperty(dbus.String, "Checker")
1799
1876
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1800
1877
invalidate_only=True)
1801
1878
1802
1879
del notifychangeproperty
1803
1880
1804
1881
def __del__(self, *args, **kwargs):
1805
1882
try:
1806
1883
self.remove_from_connection()
1809
1886
if hasattr(DBusObjectWithProperties, "__del__"):
1810
1887
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1811
1888
Client.__del__(self, *args, **kwargs)
1812
1889
1813
1890
def checker_callback(self, source, condition,
1814
1891
connection, command, *args, **kwargs):
1815
1892
ret = Client.checker_callback(self, source, condition,
1831
1908
| self.last_checker_signal),
1832
1909
dbus.String(command))
1833
1910
return ret
1834
1911
1835
1912
def start_checker(self, *args, **kwargs):
1836
1913
old_checker_pid = getattr(self.checker, "pid", None)
1837
1914
r = Client.start_checker(self, *args, **kwargs)
1841
1918
# Emit D-Bus signal
1842
1919
self.CheckerStarted(self.current_checker_command)
1843
1920
return r
1844
1921
1845
1922
def _reset_approved(self):
1846
1923
self.approved = None
1847
1924
return False
1848
1925
1849
1926
def approve(self, value=True):
1850
1927
self.approved = value
1851
1928
GLib.timeout_add(int(self.approval_duration.total_seconds()
1852
1929
* 1000), self._reset_approved)
1853
1930
self.send_changedstate()
1854
1855
## D-Bus methods, signals & properties
1856
1857
## Interfaces
1858
1859
## Signals
1860
1931
1932
# D-Bus methods, signals & properties
1933
1934
# Interfaces
1935
1936
# Signals
1937
1861
1938
# CheckerCompleted - signal
1862
1939
@dbus.service.signal(_interface, signature="nxs")
1863
1940
def CheckerCompleted(self, exitcode, waitstatus, command):
1864
1941
"D-Bus signal"
1865
1942
pass
1866
1943
1867
1944
# CheckerStarted - signal
1868
1945
@dbus.service.signal(_interface, signature="s")
1869
1946
def CheckerStarted(self, command):
1870
1947
"D-Bus signal"
1871
1948
pass
1872
1949
1873
1950
# PropertyChanged - signal
1874
1951
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1875
1952
@dbus.service.signal(_interface, signature="sv")
1876
1953
def PropertyChanged(self, property, value):
1877
1954
"D-Bus signal"
1878
1955
pass
1879
1956
1880
1957
# GotSecret - signal
1881
1958
@dbus.service.signal(_interface)
1882
1959
def GotSecret(self):
1885
1962
server to mandos-client
1886
1963
"""
1887
1964
pass
1888
1965
1889
1966
# Rejected - signal
1890
1967
@dbus.service.signal(_interface, signature="s")
1891
1968
def Rejected(self, reason):
1892
1969
"D-Bus signal"
1893
1970
pass
1894
1971
1895
1972
# NeedApproval - signal
1896
1973
@dbus.service.signal(_interface, signature="tb")
1897
1974
def NeedApproval(self, timeout, default):
1898
1975
"D-Bus signal"
1899
1976
return self.need_approval()
1900
1901
## Methods
1902
1977
1978
# Methods
1979
1903
1980
# Approve - method
1904
1981
@dbus.service.method(_interface, in_signature="b")
1905
1982
def Approve(self, value):
1906
1983
self.approve(value)
1907
1984
1908
1985
# CheckedOK - method
1909
1986
@dbus.service.method(_interface)
1910
1987
def CheckedOK(self):
1911
1988
self.checked_ok()
1912
1989
1913
1990
# Enable - method
1914
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1915
1992
@dbus.service.method(_interface)
1916
1993
def Enable(self):
1917
1994
"D-Bus method"
1918
1995
self.enable()
1919
1996
1920
1997
# StartChecker - method
1921
1998
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1922
1999
@dbus.service.method(_interface)
1923
2000
def StartChecker(self):
1924
2001
"D-Bus method"
1925
2002
self.start_checker()
1926
2003
1927
2004
# Disable - method
1928
2005
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1929
2006
@dbus.service.method(_interface)
1930
2007
def Disable(self):
1931
2008
"D-Bus method"
1932
2009
self.disable()
1933
2010
1934
2011
# StopChecker - method
1935
2012
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1936
2013
@dbus.service.method(_interface)
1937
2014
def StopChecker(self):
1938
2015
self.stop_checker()
1939
1940
## Properties
1941
2016
2017
# Properties
2018
1942
2019
# ApprovalPending - property
1943
2020
@dbus_service_property(_interface, signature="b", access="read")
1944
2021
def ApprovalPending_dbus_property(self):
1945
2022
return dbus.Boolean(bool(self.approvals_pending))
1946
2023
1947
2024
# ApprovedByDefault - property
1948
2025
@dbus_service_property(_interface,
1949
2026
signature="b",
1952
2029
if value is None: # get
1953
2030
return dbus.Boolean(self.approved_by_default)
1954
2031
self.approved_by_default = bool(value)
1955
2032
1956
2033
# ApprovalDelay - property
1957
2034
@dbus_service_property(_interface,
1958
2035
signature="t",
1962
2039
return dbus.UInt64(self.approval_delay.total_seconds()
1963
2040
* 1000)
1964
2041
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1965
2042
1966
2043
# ApprovalDuration - property
1967
2044
@dbus_service_property(_interface,
1968
2045
signature="t",
1972
2049
return dbus.UInt64(self.approval_duration.total_seconds()
1973
2050
* 1000)
1974
2051
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1975
2052
1976
2053
# Name - property
1977
2054
@dbus_annotations(
1978
2055
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1979
2056
@dbus_service_property(_interface, signature="s", access="read")
1980
2057
def Name_dbus_property(self):
1981
2058
return dbus.String(self.name)
1982
2059
2060
# KeyID - property
2061
@dbus_annotations(
2062
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2063
@dbus_service_property(_interface, signature="s", access="read")
2064
def KeyID_dbus_property(self):
2065
return dbus.String(self.key_id)
2066
1983
2067
# Fingerprint - property
1984
2068
@dbus_annotations(
1985
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
2070
@dbus_service_property(_interface, signature="s", access="read")
1987
2071
def Fingerprint_dbus_property(self):
1988
2072
return dbus.String(self.fingerprint)
1989
2073
1990
2074
# Host - property
1991
2075
@dbus_service_property(_interface,
1992
2076
signature="s",
1995
2079
if value is None: # get
1996
2080
return dbus.String(self.host)
1997
2081
self.host = str(value)
1998
2082
1999
2083
# Created - property
2000
2084
@dbus_annotations(
2001
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2002
2086
@dbus_service_property(_interface, signature="s", access="read")
2003
2087
def Created_dbus_property(self):
2004
2088
return datetime_to_dbus(self.created)
2005
2089
2006
2090
# LastEnabled - property
2007
2091
@dbus_service_property(_interface, signature="s", access="read")
2008
2092
def LastEnabled_dbus_property(self):
2009
2093
return datetime_to_dbus(self.last_enabled)
2010
2094
2011
2095
# Enabled - property
2012
2096
@dbus_service_property(_interface,
2013
2097
signature="b",
2019
2103
self.enable()
2020
2104
else:
2021
2105
self.disable()
2022
2106
2023
2107
# LastCheckedOK - property
2024
2108
@dbus_service_property(_interface,
2025
2109
signature="s",
2029
2113
self.checked_ok()
2030
2114
return
2031
2115
return datetime_to_dbus(self.last_checked_ok)
2032
2116
2033
2117
# LastCheckerStatus - property
2034
2118
@dbus_service_property(_interface, signature="n", access="read")
2035
2119
def LastCheckerStatus_dbus_property(self):
2036
2120
return dbus.Int16(self.last_checker_status)
2037
2121
2038
2122
# Expires - property
2039
2123
@dbus_service_property(_interface, signature="s", access="read")
2040
2124
def Expires_dbus_property(self):
2041
2125
return datetime_to_dbus(self.expires)
2042
2126
2043
2127
# LastApprovalRequest - property
2044
2128
@dbus_service_property(_interface, signature="s", access="read")
2045
2129
def LastApprovalRequest_dbus_property(self):
2046
2130
return datetime_to_dbus(self.last_approval_request)
2047
2131
2048
2132
# Timeout - property
2049
2133
@dbus_service_property(_interface,
2050
2134
signature="t",
2069
2153
self.disable_initiator_tag = GLib.timeout_add(
2070
2154
int((self.expires - now).total_seconds() * 1000),
2071
2155
self.disable)
2072
2156
2073
2157
# ExtendedTimeout - property
2074
2158
@dbus_service_property(_interface,
2075
2159
signature="t",
2079
2163
return dbus.UInt64(self.extended_timeout.total_seconds()
2080
2164
* 1000)
2081
2165
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2082
2166
2083
2167
# Interval - property
2084
2168
@dbus_service_property(_interface,
2085
2169
signature="t",
2095
2179
GLib.source_remove(self.checker_initiator_tag)
2096
2180
self.checker_initiator_tag = GLib.timeout_add(
2097
2181
value, self.start_checker)
2098
self.start_checker() # Start one now, too
2099
2182
self.start_checker() # Start one now, too
2183
2100
2184
# Checker - property
2101
2185
@dbus_service_property(_interface,
2102
2186
signature="s",
2105
2189
if value is None: # get
2106
2190
return dbus.String(self.checker_command)
2107
2191
self.checker_command = str(value)
2108
2192
2109
2193
# CheckerRunning - property
2110
2194
@dbus_service_property(_interface,
2111
2195
signature="b",
2117
2201
self.start_checker()
2118
2202
else:
2119
2203
self.stop_checker()
2120
2204
2121
2205
# ObjectPath - property
2122
2206
@dbus_annotations(
2123
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2124
2208
"org.freedesktop.DBus.Deprecated": "true"})
2125
2209
@dbus_service_property(_interface, signature="o", access="read")
2126
2210
def ObjectPath_dbus_property(self):
2127
return self.dbus_object_path # is already a dbus.ObjectPath
2128
2211
return self.dbus_object_path # is already a dbus.ObjectPath
2212
2129
2213
# Secret = property
2130
2214
@dbus_annotations(
2131
2215
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2136
2220
byte_arrays=True)
2137
2221
def Secret_dbus_property(self, value):
2138
2222
self.secret = bytes(value)
2139
2223
2140
2224
del _interface
2141
2225
2142
2226
2143
class ProxyClient(object):
2144
def __init__(self, child_pipe, fpr, address):
2227
class ProxyClient:
2228
def __init__(self, child_pipe, key_id, fpr, address):
2145
2229
self._pipe = child_pipe
2146
self._pipe.send(('init', fpr, address))
2230
self._pipe.send(('init', key_id, fpr, address))
2147
2231
if not self._pipe.recv():
2148
raise KeyError(fpr)
2149
2232
raise KeyError(key_id or fpr)
2233
2150
2234
def __getattribute__(self, name):
2151
2235
if name == '_pipe':
2152
2236
return super(ProxyClient, self).__getattribute__(name)
2155
2239
if data[0] == 'data':
2156
2240
return data[1]
2157
2241
if data[0] == 'function':
2158
2242
2159
2243
def func(*args, **kwargs):
2160
2244
self._pipe.send(('funcall', name, args, kwargs))
2161
2245
return self._pipe.recv()[1]
2162
2246
2163
2247
return func
2164
2248
2165
2249
def __setattr__(self, name, value):
2166
2250
if name == '_pipe':
2167
2251
return super(ProxyClient, self).__setattr__(name, value)
2170
2254
2171
2255
class ClientHandler(socketserver.BaseRequestHandler, object):
2172
2256
"""A class to handle client connections.
2173
2257
2174
2258
Instantiated once for each connection to handle it.
2175
2259
Note: This will run in its own forked process."""
2176
2260
2177
2261
def handle(self):
2178
2262
with contextlib.closing(self.server.child_pipe) as child_pipe:
2179
2263
logger.info("TCP connection from: %s",
2180
2264
str(self.client_address))
2181
2265
logger.debug("Pipe FD: %d",
2182
2266
self.server.child_pipe.fileno())
2183
2267
2184
2268
session = gnutls.ClientSession(self.request)
2185
2186
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2187
# "+AES-256-CBC", "+SHA1",
2188
# "+COMP-NULL", "+CTYPE-OPENPGP",
2189
# "+DHE-DSS"))
2269
2270
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2271
# "+AES-256-CBC", "+SHA1",
2272
# "+COMP-NULL", "+CTYPE-OPENPGP",
2273
# "+DHE-DSS"))
2190
2274
# Use a fallback default, since this MUST be set.
2191
2275
priority = self.server.gnutls_priority
2192
2276
if priority is None:
2194
2278
gnutls.priority_set_direct(session._c_object,
2195
2279
priority.encode("utf-8"),
2196
2280
None)
2197
2281
2198
2282
# Start communication using the Mandos protocol
2199
2283
# Get protocol number
2200
2284
line = self.request.makefile().readline()
2205
2289
except (ValueError, IndexError, RuntimeError) as error:
2206
2290
logger.error("Unknown protocol version: %s", error)
2207
2291
return
2208
2292
2209
2293
# Start GnuTLS connection
2210
2294
try:
2211
2295
session.handshake()
2215
2299
# established. Just abandon the request.
2216
2300
return
2217
2301
logger.debug("Handshake succeeded")
2218
2302
2219
2303
approval_required = False
2220
2304
try:
2221
try:
2222
fpr = self.fingerprint(
2223
self.peer_certificate(session))
2224
except (TypeError, gnutls.Error) as error:
2225
logger.warning("Bad certificate: %s", error)
2226
return
2227
logger.debug("Fingerprint: %s", fpr)
2228
2229
try:
2230
client = ProxyClient(child_pipe, fpr,
2305
if gnutls.has_rawpk:
2306
fpr = b""
2307
try:
2308
key_id = self.key_id(
2309
self.peer_certificate(session))
2310
except (TypeError, gnutls.Error) as error:
2311
logger.warning("Bad certificate: %s", error)
2312
return
2313
logger.debug("Key ID: %s", key_id)
2314
2315
else:
2316
key_id = b""
2317
try:
2318
fpr = self.fingerprint(
2319
self.peer_certificate(session))
2320
except (TypeError, gnutls.Error) as error:
2321
logger.warning("Bad certificate: %s", error)
2322
return
2323
logger.debug("Fingerprint: %s", fpr)
2324
2325
try:
2326
client = ProxyClient(child_pipe, key_id, fpr,
2231
2327
self.client_address)
2232
2328
except KeyError:
2233
2329
return
2234
2330
2235
2331
if client.approval_delay:
2236
2332
delay = client.approval_delay
2237
2333
client.approvals_pending += 1
2238
2334
approval_required = True
2239
2335
2240
2336
while True:
2241
2337
if not client.enabled:
2242
2338
logger.info("Client %s is disabled",
2245
2341
# Emit D-Bus signal
2246
2342
client.Rejected("Disabled")
2247
2343
return
2248
2344
2249
2345
if client.approved or not client.approval_delay:
2250
#We are approved or approval is disabled
2346
# We are approved or approval is disabled
2251
2347
break
2252
2348
elif client.approved is None:
2253
2349
logger.info("Client %s needs approval",
2264
2360
# Emit D-Bus signal
2265
2361
client.Rejected("Denied")
2266
2362
return
2267
2268
#wait until timeout or approved
2363
2364
# wait until timeout or approved
2269
2365
time = datetime.datetime.now()
2270
2366
client.changedstate.acquire()
2271
2367
client.changedstate.wait(delay.total_seconds())
2284
2380
break
2285
2381
else:
2286
2382
delay -= time2 - time
2287
2383
2288
2384
try:
2289
2385
session.send(client.secret)
2290
2386
except gnutls.Error as error:
2291
2387
logger.warning("gnutls send failed",
2292
exc_info = error)
2388
exc_info=error)
2293
2389
return
2294
2390
2295
2391
logger.info("Sending secret to %s", client.name)
2296
2392
# bump the timeout using extended_timeout
2297
2393
client.bump_timeout(client.extended_timeout)
2298
2394
if self.server.use_dbus:
2299
2395
# Emit D-Bus signal
2300
2396
client.GotSecret()
2301
2397
2302
2398
finally:
2303
2399
if approval_required:
2304
2400
client.approvals_pending -= 1
2307
2403
except gnutls.Error as error:
2308
2404
logger.warning("GnuTLS bye failed",
2309
2405
exc_info=error)
2310
2406
2311
2407
@staticmethod
2312
2408
def peer_certificate(session):
2313
"Return the peer's OpenPGP certificate as a bytestring"
2314
# If not an OpenPGP certificate...
2315
if (gnutls.certificate_type_get(session._c_object)
2316
!= gnutls.CRT_OPENPGP):
2409
"Return the peer's certificate as a bytestring"
2410
try:
2411
cert_type = gnutls.certificate_type_get2(session._c_object,
2412
gnutls.CTYPE_PEERS)
2413
except AttributeError:
2414
cert_type = gnutls.certificate_type_get(session._c_object)
2415
if gnutls.has_rawpk:
2416
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2417
else:
2418
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2419
# If not a valid certificate type...
2420
if cert_type not in valid_cert_types:
2421
logger.info("Cert type %r not in %r", cert_type,
2422
valid_cert_types)
2317
2423
# ...return invalid data
2318
2424
return b""
2319
2425
list_size = ctypes.c_uint(1)
2325
2431
return None
2326
2432
cert = cert_list[0]
2327
2433
return ctypes.string_at(cert.data, cert.size)
2328
2434
2435
@staticmethod
2436
def key_id(certificate):
2437
"Convert a certificate bytestring to a hexdigit key ID"
2438
# New GnuTLS "datum" with the public key
2439
datum = gnutls.datum_t(
2440
ctypes.cast(ctypes.c_char_p(certificate),
2441
ctypes.POINTER(ctypes.c_ubyte)),
2442
ctypes.c_uint(len(certificate)))
2443
# XXX all these need to be created in the gnutls "module"
2444
# New empty GnuTLS certificate
2445
pubkey = gnutls.pubkey_t()
2446
gnutls.pubkey_init(ctypes.byref(pubkey))
2447
# Import the raw public key into the certificate
2448
gnutls.pubkey_import(pubkey,
2449
ctypes.byref(datum),
2450
gnutls.X509_FMT_DER)
2451
# New buffer for the key ID
2452
buf = ctypes.create_string_buffer(32)
2453
buf_len = ctypes.c_size_t(len(buf))
2454
# Get the key ID from the raw public key into the buffer
2455
gnutls.pubkey_get_key_id(pubkey,
2456
gnutls.KEYID_USE_SHA256,
2457
ctypes.cast(ctypes.byref(buf),
2458
ctypes.POINTER(ctypes.c_ubyte)),
2459
ctypes.byref(buf_len))
2460
# Deinit the certificate
2461
gnutls.pubkey_deinit(pubkey)
2462
2463
# Convert the buffer to a Python bytestring
2464
key_id = ctypes.string_at(buf, buf_len.value)
2465
# Convert the bytestring to hexadecimal notation
2466
hex_key_id = binascii.hexlify(key_id).upper()
2467
return hex_key_id
2468
2329
2469
@staticmethod
2330
2470
def fingerprint(openpgp):
2331
2471
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2346
2486
ctypes.byref(crtverify))
2347
2487
if crtverify.value != 0:
2348
2488
gnutls.openpgp_crt_deinit(crt)
2349
raise gnutls.CertificateSecurityError("Verify failed")
2489
raise gnutls.CertificateSecurityError(code
2490
=crtverify.value)
2350
2491
# New buffer for the fingerprint
2351
2492
buf = ctypes.create_string_buffer(20)
2352
2493
buf_len = ctypes.c_size_t()
2362
2503
return hex_fpr
2363
2504
2364
2505
2365
class MultiprocessingMixIn(object):
2506
class MultiprocessingMixIn:
2366
2507
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2367
2508
2368
2509
def sub_process_main(self, request, address):
2369
2510
try:
2370
2511
self.finish_request(request, address)
2371
2512
except Exception:
2372
2513
self.handle_error(request, address)
2373
2514
self.close_request(request)
2374
2515
2375
2516
def process_request(self, request, address):
2376
2517
"""Start a new process to process the request."""
2377
proc = multiprocessing.Process(target = self.sub_process_main,
2378
args = (request, address))
2518
proc = multiprocessing.Process(target=self.sub_process_main,
2519
args=(request, address))
2379
2520
proc.start()
2380
2521
return proc
2381
2522
2382
2523
2383
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2524
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2384
2525
""" adds a pipe to the MixIn """
2385
2526
2386
2527
def process_request(self, request, client_address):
2387
2528
"""Overrides and wraps the original process_request().
2388
2529
2389
2530
This function creates a new pipe in self.pipe
2390
2531
"""
2391
2532
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2392
2533
2393
2534
proc = MultiprocessingMixIn.process_request(self, request,
2394
2535
client_address)
2395
2536
self.child_pipe.close()
2396
2537
self.add_pipe(parent_pipe, proc)
2397
2538
2398
2539
def add_pipe(self, parent_pipe, proc):
2399
2540
"""Dummy function; override as necessary"""
2400
2541
raise NotImplementedError()
2401
2542
2402
2543
2403
2544
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2404
socketserver.TCPServer, object):
2545
socketserver.TCPServer):
2405
2546
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2406
2547
2407
2548
Attributes:
2408
2549
enabled: Boolean; whether this server is activated yet
2409
2550
interface: None or a network interface name (string)
2410
2551
use_ipv6: Boolean; to use IPv6 or not
2411
2552
"""
2412
2553
2413
2554
def __init__(self, server_address, RequestHandlerClass,
2414
2555
interface=None,
2415
2556
use_ipv6=True,
2425
2566
self.socketfd = socketfd
2426
2567
# Save the original socket.socket() function
2427
2568
self.socket_socket = socket.socket
2569
2428
2570
# To implement --socket, we monkey patch socket.socket.
2429
#
2571
#
2430
2572
# (When socketserver.TCPServer is a new-style class, we
2431
2573
# could make self.socket into a property instead of monkey
2432
2574
# patching socket.socket.)
2433
#
2575
#
2434
2576
# Create a one-time-only replacement for socket.socket()
2435
2577
@functools.wraps(socket.socket)
2436
2578
def socket_wrapper(*args, **kwargs):
2448
2590
# socket_wrapper(), if socketfd was set.
2449
2591
socketserver.TCPServer.__init__(self, server_address,
2450
2592
RequestHandlerClass)
2451
2593
2452
2594
def server_bind(self):
2453
2595
"""This overrides the normal server_bind() function
2454
2596
to bind to an interface if one was specified, and also NOT to
2479
2621
raise
2480
2622
# Only bind(2) the socket if we really need to.
2481
2623
if self.server_address[0] or self.server_address[1]:
2624
if self.server_address[1]:
2625
self.allow_reuse_address = True
2482
2626
if not self.server_address[0]:
2483
2627
if self.address_family == socket.AF_INET6:
2484
any_address = "::" # in6addr_any
2628
any_address = "::" # in6addr_any
2485
2629
else:
2486
any_address = "0.0.0.0" # INADDR_ANY
2630
any_address = "0.0.0.0" # INADDR_ANY
2487
2631
self.server_address = (any_address,
2488
2632
self.server_address[1])
2489
2633
elif not self.server_address[1]:
2499
2643
2500
2644
class MandosServer(IPv6_TCPServer):
2501
2645
"""Mandos server.
2502
2646
2503
2647
Attributes:
2504
2648
clients: set of Client objects
2505
2649
gnutls_priority GnuTLS priority string
2506
2650
use_dbus: Boolean; to emit D-Bus signals or not
2507
2651
2508
2652
Assumes a GLib.MainLoop event loop.
2509
2653
"""
2510
2654
2511
2655
def __init__(self, server_address, RequestHandlerClass,
2512
2656
interface=None,
2513
2657
use_ipv6=True,
2523
2667
self.gnutls_priority = gnutls_priority
2524
2668
IPv6_TCPServer.__init__(self, server_address,
2525
2669
RequestHandlerClass,
2526
interface = interface,
2527
use_ipv6 = use_ipv6,
2528
socketfd = socketfd)
2529
2670
interface=interface,
2671
use_ipv6=use_ipv6,
2672
socketfd=socketfd)
2673
2530
2674
def server_activate(self):
2531
2675
if self.enabled:
2532
2676
return socketserver.TCPServer.server_activate(self)
2533
2677
2534
2678
def enable(self):
2535
2679
self.enabled = True
2536
2680
2537
2681
def add_pipe(self, parent_pipe, proc):
2538
2682
# Call "handle_ipc" for both data and EOF events
2539
2683
GLib.io_add_watch(
2540
parent_pipe.fileno(),
2541
GLib.IO_IN | GLib.IO_HUP,
2684
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2685
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2542
2686
functools.partial(self.handle_ipc,
2543
parent_pipe = parent_pipe,
2544
proc = proc))
2545
2687
parent_pipe=parent_pipe,
2688
proc=proc))
2689
2546
2690
def handle_ipc(self, source, condition,
2547
2691
parent_pipe=None,
2548
proc = None,
2692
proc=None,
2549
2693
client_object=None):
2550
2694
# error, or the other end of multiprocessing.Pipe has closed
2551
2695
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2552
2696
# Wait for other process to exit
2553
2697
proc.join()
2554
2698
return False
2555
2699
2556
2700
# Read a request from the child
2557
2701
request = parent_pipe.recv()
2558
2702
command = request[0]
2559
2703
2560
2704
if command == 'init':
2561
fpr = request[1]
2562
address = request[2]
2563
2705
key_id = request[1].decode("ascii")
2706
fpr = request[2].decode("ascii")
2707
address = request[3]
2708
2564
2709
for c in self.clients.values():
2565
if c.fingerprint == fpr:
2710
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2711
continue
2712
if key_id and c.key_id == key_id:
2713
client = c
2714
break
2715
if fpr and c.fingerprint == fpr:
2566
2716
client = c
2567
2717
break
2568
2718
else:
2569
logger.info("Client not found for fingerprint: %s, ad"
2570
"dress: %s", fpr, address)
2719
logger.info("Client not found for key ID: %s, address"
2720
": %s", key_id or fpr, address)
2571
2721
if self.use_dbus:
2572
2722
# Emit D-Bus signal
2573
mandos_dbus_service.ClientNotFound(fpr,
2723
mandos_dbus_service.ClientNotFound(key_id or fpr,
2574
2724
address[0])
2575
2725
parent_pipe.send(False)
2576
2726
return False
2577
2727
2578
2728
GLib.io_add_watch(
2579
parent_pipe.fileno(),
2580
GLib.IO_IN | GLib.IO_HUP,
2729
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2730
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2581
2731
functools.partial(self.handle_ipc,
2582
parent_pipe = parent_pipe,
2583
proc = proc,
2584
client_object = client))
2732
parent_pipe=parent_pipe,
2733
proc=proc,
2734
client_object=client))
2585
2735
parent_pipe.send(True)
2586
2736
# remove the old hook in favor of the new above hook on
2587
2737
# same fileno
2590
2740
funcname = request[1]
2591
2741
args = request[2]
2592
2742
kwargs = request[3]
2593
2743
2594
2744
parent_pipe.send(('data', getattr(client_object,
2595
2745
funcname)(*args,
2596
2746
**kwargs)))
2597
2747
2598
2748
if command == 'getattr':
2599
2749
attrname = request[1]
2600
2750
if isinstance(client_object.__getattribute__(attrname),
2603
2753
else:
2604
2754
parent_pipe.send((
2605
2755
'data', client_object.__getattribute__(attrname)))
2606
2756
2607
2757
if command == 'setattr':
2608
2758
attrname = request[1]
2609
2759
value = request[2]
2610
2760
setattr(client_object, attrname, value)
2611
2761
2612
2762
return True
2613
2763
2614
2764
2615
2765
def rfc3339_duration_to_delta(duration):
2616
2766
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2617
2618
>>> rfc3339_duration_to_delta("P7D")
2619
datetime.timedelta(7)
2620
>>> rfc3339_duration_to_delta("PT60S")
2621
datetime.timedelta(0, 60)
2622
>>> rfc3339_duration_to_delta("PT60M")
2623
datetime.timedelta(0, 3600)
2624
>>> rfc3339_duration_to_delta("PT24H")
2625
datetime.timedelta(1)
2626
>>> rfc3339_duration_to_delta("P1W")
2627
datetime.timedelta(7)
2628
>>> rfc3339_duration_to_delta("PT5M30S")
2629
datetime.timedelta(0, 330)
2630
>>> rfc3339_duration_to_delta("P1DT3M20S")
2631
datetime.timedelta(1, 200)
2767
2768
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2769
True
2770
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2771
True
2772
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2773
True
2774
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2775
True
2776
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2777
True
2778
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2779
True
2780
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2781
True
2632
2782
"""
2633
2783
2634
2784
# Parsing an RFC 3339 duration with regular expressions is not
2635
2785
# possible - there would have to be multiple places for the same
2636
2786
# values, like seconds. The current code, while more esoteric, is
2637
2787
# cleaner without depending on a parsing library. If Python had a
2638
2788
# built-in library for parsing we would use it, but we'd like to
2639
2789
# avoid excessive use of external libraries.
2640
2790
2641
2791
# New type for defining tokens, syntax, and semantics all-in-one
2642
2792
Token = collections.namedtuple("Token", (
2643
2793
"regexp", # To match token; if "value" is not None, must have
2676
2826
frozenset((token_year, token_month,
2677
2827
token_day, token_time,
2678
2828
token_week)))
2679
# Define starting values
2680
value = datetime.timedelta() # Value so far
2829
# Define starting values:
2830
# Value so far
2831
value = datetime.timedelta()
2681
2832
found_token = None
2682
followers = frozenset((token_duration, )) # Following valid tokens
2683
s = duration # String left to parse
2833
# Following valid tokens
2834
followers = frozenset((token_duration, ))
2835
# String left to parse
2836
s = duration
2684
2837
# Loop until end token is found
2685
2838
while found_token is not token_end:
2686
2839
# Search for any currently valid tokens
2710
2863
2711
2864
def string_to_delta(interval):
2712
2865
"""Parse a string and return a datetime.timedelta
2713
2714
>>> string_to_delta('7d')
2715
datetime.timedelta(7)
2716
>>> string_to_delta('60s')
2717
datetime.timedelta(0, 60)
2718
>>> string_to_delta('60m')
2719
datetime.timedelta(0, 3600)
2720
>>> string_to_delta('24h')
2721
datetime.timedelta(1)
2722
>>> string_to_delta('1w')
2723
datetime.timedelta(7)
2724
>>> string_to_delta('5m 30s')
2725
datetime.timedelta(0, 330)
2866
2867
>>> string_to_delta('7d') == datetime.timedelta(7)
2868
True
2869
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2870
True
2871
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2872
True
2873
>>> string_to_delta('24h') == datetime.timedelta(1)
2874
True
2875
>>> string_to_delta('1w') == datetime.timedelta(7)
2876
True
2877
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2878
True
2726
2879
"""
2727
2880
2728
2881
try:
2729
2882
return rfc3339_duration_to_delta(interval)
2730
2883
except ValueError:
2731
2884
pass
2732
2885
2733
2886
timevalue = datetime.timedelta(0)
2734
2887
for s in interval.split():
2735
2888
try:
2753
2906
return timevalue
2754
2907
2755
2908
2756
def daemon(nochdir = False, noclose = False):
2909
def daemon(nochdir=False, noclose=False):
2757
2910
"""See daemon(3). Standard BSD Unix function.
2758
2911
2759
2912
This should really exist as os.daemon, but it doesn't (yet)."""
2760
2913
if os.fork():
2761
2914
sys.exit()
2779
2932
2780
2933
2781
2934
def main():
2782
2935
2783
2936
##################################################################
2784
2937
# Parsing of options, both command line and config file
2785
2938
2786
2939
parser = argparse.ArgumentParser()
2787
2940
parser.add_argument("-v", "--version", action="version",
2788
version = "%(prog)s {}".format(version),
2941
version="%(prog)s {}".format(version),
2789
2942
help="show version number and exit")
2790
2943
parser.add_argument("-i", "--interface", metavar="IF",
2791
2944
help="Bind to interface IF")
2827
2980
parser.add_argument("--no-zeroconf", action="store_false",
2828
2981
dest="zeroconf", help="Do not use Zeroconf",
2829
2982
default=None)
2830
2983
2831
2984
options = parser.parse_args()
2832
2833
if options.check:
2834
import doctest
2835
fail_count, test_count = doctest.testmod()
2836
sys.exit(os.EX_OK if fail_count == 0 else 1)
2837
2985
2838
2986
# Default values for config file for server-global settings
2839
server_defaults = { "interface": "",
2840
"address": "",
2841
"port": "",
2842
"debug": "False",
2843
"priority":
2844
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2845
":+SIGN-DSA-SHA256",
2846
"servicename": "Mandos",
2847
"use_dbus": "True",
2848
"use_ipv6": "True",
2849
"debuglevel": "",
2850
"restore": "True",
2851
"socket": "",
2852
"statedir": "/var/lib/mandos",
2853
"foreground": "False",
2854
"zeroconf": "True",
2855
}
2856
2987
if gnutls.has_rawpk:
2988
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2989
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2990
else:
2991
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2992
":+SIGN-DSA-SHA256")
2993
server_defaults = {"interface": "",
2994
"address": "",
2995
"port": "",
2996
"debug": "False",
2997
"priority": priority,
2998
"servicename": "Mandos",
2999
"use_dbus": "True",
3000
"use_ipv6": "True",
3001
"debuglevel": "",
3002
"restore": "True",
3003
"socket": "",
3004
"statedir": "/var/lib/mandos",
3005
"foreground": "False",
3006
"zeroconf": "True",
3007
}
3008
del priority
3009
2857
3010
# Parse config file for server-global settings
2858
server_config = configparser.SafeConfigParser(server_defaults)
3011
server_config = configparser.ConfigParser(server_defaults)
2859
3012
del server_defaults
2860
3013
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2861
# Convert the SafeConfigParser object to a dict
3014
# Convert the ConfigParser object to a dict
2862
3015
server_settings = server_config.defaults()
2863
3016
# Use the appropriate methods on the non-string config options
2864
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3017
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3018
"foreground", "zeroconf"):
2865
3019
server_settings[option] = server_config.getboolean("DEFAULT",
2866
3020
option)
2867
3021
if server_settings["port"]:
2877
3031
server_settings["socket"] = os.dup(server_settings
2878
3032
["socket"])
2879
3033
del server_config
2880
3034
2881
3035
# Override the settings from the config file with command line
2882
3036
# options, if set.
2883
3037
for option in ("interface", "address", "port", "debug",
2901
3055
if server_settings["debug"]:
2902
3056
server_settings["foreground"] = True
2903
3057
# Now we have our good server settings in "server_settings"
2904
3058
2905
3059
##################################################################
2906
3060
2907
3061
if (not server_settings["zeroconf"]
2908
3062
and not (server_settings["port"]
2909
3063
or server_settings["socket"] != "")):
2910
3064
parser.error("Needs port or socket to work without Zeroconf")
2911
3065
2912
3066
# For convenience
2913
3067
debug = server_settings["debug"]
2914
3068
debuglevel = server_settings["debuglevel"]
2918
3072
stored_state_file)
2919
3073
foreground = server_settings["foreground"]
2920
3074
zeroconf = server_settings["zeroconf"]
2921
3075
2922
3076
if debug:
2923
3077
initlogger(debug, logging.DEBUG)
2924
3078
else:
2927
3081
else:
2928
3082
level = getattr(logging, debuglevel.upper())
2929
3083
initlogger(debug, level)
2930
3084
2931
3085
if server_settings["servicename"] != "Mandos":
2932
3086
syslogger.setFormatter(
2933
3087
logging.Formatter('Mandos ({}) [%(process)d]:'
2934
3088
' %(levelname)s: %(message)s'.format(
2935
3089
server_settings["servicename"])))
2936
3090
2937
3091
# Parse config file with clients
2938
client_config = configparser.SafeConfigParser(Client
2939
.client_defaults)
3092
client_config = configparser.ConfigParser(Client.client_defaults)
2940
3093
client_config.read(os.path.join(server_settings["configdir"],
2941
3094
"clients.conf"))
2942
3095
2943
3096
global mandos_dbus_service
2944
3097
mandos_dbus_service = None
2945
3098
2946
3099
socketfd = None
2947
3100
if server_settings["socket"] != "":
2948
3101
socketfd = server_settings["socket"]
2964
3117
except IOError as e:
2965
3118
logger.error("Could not open file %r", pidfilename,
2966
3119
exc_info=e)
2967
3120
2968
3121
for name, group in (("_mandos", "_mandos"),
2969
3122
("mandos", "mandos"),
2970
3123
("nobody", "nogroup")):
2988
3141
.format(uid, gid, os.strerror(error.errno)))
2989
3142
if error.errno != errno.EPERM:
2990
3143
raise
2991
3144
2992
3145
if debug:
2993
3146
# Enable all possible GnuTLS debugging
2994
3147
2995
3148
# "Use a log level over 10 to enable all debugging options."
2996
3149
# - GnuTLS manual
2997
3150
gnutls.global_set_log_level(11)
2998
3151
2999
3152
@gnutls.log_func
3000
3153
def debug_gnutls(level, string):
3001
3154
logger.debug("GnuTLS: %s", string[:-1])
3002
3155
3003
3156
gnutls.global_set_log_function(debug_gnutls)
3004
3157
3005
3158
# Redirect stdin so all checkers get /dev/null
3006
3159
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3007
3160
os.dup2(null, sys.stdin.fileno())
3008
3161
if null > 2:
3009
3162
os.close(null)
3010
3163
3011
3164
# Need to fork before connecting to D-Bus
3012
3165
if not foreground:
3013
3166
# Close all input and output, do double fork, etc.
3014
3167
daemon()
3015
3016
# multiprocessing will use threads, so before we use GLib we need
3017
# to inform GLib that threads will be used.
3018
GLib.threads_init()
3019
3168
3169
if gi.version_info < (3, 10, 2):
3170
# multiprocessing will use threads, so before we use GLib we
3171
# need to inform GLib that threads will be used.
3172
GLib.threads_init()
3173
3020
3174
global main_loop
3021
3175
# From the Avahi example code
3022
3176
DBusGMainLoop(set_as_default=True)
3039
3193
if zeroconf:
3040
3194
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3041
3195
service = AvahiServiceToSyslog(
3042
name = server_settings["servicename"],
3043
servicetype = "_mandos._tcp",
3044
protocol = protocol,
3045
bus = bus)
3196
name=server_settings["servicename"],
3197
servicetype="_mandos._tcp",
3198
protocol=protocol,
3199
bus=bus)
3046
3200
if server_settings["interface"]:
3047
3201
service.interface = if_nametoindex(
3048
3202
server_settings["interface"].encode("utf-8"))
3049
3203
3050
3204
global multiprocessing_manager
3051
3205
multiprocessing_manager = multiprocessing.Manager()
3052
3206
3053
3207
client_class = Client
3054
3208
if use_dbus:
3055
client_class = functools.partial(ClientDBus, bus = bus)
3056
3209
client_class = functools.partial(ClientDBus, bus=bus)
3210
3057
3211
client_settings = Client.config_parser(client_config)
3058
3212
old_client_settings = {}
3059
3213
clients_data = {}
3060
3214
3061
3215
# This is used to redirect stdout and stderr for checker processes
3062
3216
global wnull
3063
wnull = open(os.devnull, "w") # A writable /dev/null
3217
wnull = open(os.devnull, "w") # A writable /dev/null
3064
3218
# Only used if server is running in foreground but not in debug
3065
3219
# mode
3066
3220
if debug or not foreground:
3067
3221
wnull.close()
3068
3222
3069
3223
# Get client data and settings from last running state.
3070
3224
if server_settings["restore"]:
3071
3225
try:
3072
3226
with open(stored_state_path, "rb") as stored_state:
3073
if sys.version_info.major == 2:
3227
if sys.version_info.major == 2:
3074
3228
clients_data, old_client_settings = pickle.load(
3075
3229
stored_state)
3076
3230
else:
3077
3231
bytes_clients_data, bytes_old_client_settings = (
3078
pickle.load(stored_state, encoding = "bytes"))
3079
### Fix bytes to strings
3080
## clients_data
3232
pickle.load(stored_state, encoding="bytes"))
3233
# Fix bytes to strings
3234
# clients_data
3081
3235
# .keys()
3082
clients_data = { (key.decode("utf-8")
3083
if isinstance(key, bytes)
3084
else key): value
3085
for key, value in
3086
bytes_clients_data.items() }
3236
clients_data = {(key.decode("utf-8")
3237
if isinstance(key, bytes)
3238
else key): value
3239
for key, value in
3240
bytes_clients_data.items()}
3087
3241
del bytes_clients_data
3088
3242
for key in clients_data:
3089
value = { (k.decode("utf-8")
3090
if isinstance(k, bytes) else k): v
3091
for k, v in
3092
clients_data[key].items() }
3243
value = {(k.decode("utf-8")
3244
if isinstance(k, bytes) else k): v
3245
for k, v in
3246
clients_data[key].items()}
3093
3247
clients_data[key] = value
3094
3248
# .client_structure
3095
3249
value["client_structure"] = [
3096
3250
(s.decode("utf-8")
3097
3251
if isinstance(s, bytes)
3098
3252
else s) for s in
3099
value["client_structure"] ]
3100
# .name & .host
3101
for k in ("name", "host"):
3253
value["client_structure"]]
3254
# .name, .host, and .checker_command
3255
for k in ("name", "host", "checker_command"):
3102
3256
if isinstance(value[k], bytes):
3103
3257
value[k] = value[k].decode("utf-8")
3104
## old_client_settings
3258
if "key_id" not in value:
3259
value["key_id"] = ""
3260
elif "fingerprint" not in value:
3261
value["fingerprint"] = ""
3262
# old_client_settings
3105
3263
# .keys()
3106
3264
old_client_settings = {
3107
3265
(key.decode("utf-8")
3108
3266
if isinstance(key, bytes)
3109
3267
else key): value
3110
3268
for key, value in
3111
bytes_old_client_settings.items() }
3269
bytes_old_client_settings.items()}
3112
3270
del bytes_old_client_settings
3113
# .host
3271
# .host and .checker_command
3114
3272
for value in old_client_settings.values():
3115
if isinstance(value["host"], bytes):
3116
value["host"] = (value["host"]
3117
.decode("utf-8"))
3273
for attribute in ("host", "checker_command"):
3274
if isinstance(value[attribute], bytes):
3275
value[attribute] = (value[attribute]
3276
.decode("utf-8"))
3118
3277
os.remove(stored_state_path)
3119
3278
except IOError as e:
3120
3279
if e.errno == errno.ENOENT:
3128
3287
logger.warning("Could not load persistent state: "
3129
3288
"EOFError:",
3130
3289
exc_info=e)
3131
3290
3132
3291
with PGPEngine() as pgp:
3133
3292
for client_name, client in clients_data.items():
3134
3293
# Skip removed clients
3135
3294
if client_name not in client_settings:
3136
3295
continue
3137
3296
3138
3297
# Decide which value to use after restoring saved state.
3139
3298
# We have three different values: Old config file,
3140
3299
# new config file, and saved state.
3151
3310
client[name] = value
3152
3311
except KeyError:
3153
3312
pass
3154
3313
3155
3314
# Clients who has passed its expire date can still be
3156
3315
# enabled if its last checker was successful. A Client
3157
3316
# whose checker succeeded before we stored its state is
3190
3349
client_name))
3191
3350
client["secret"] = (client_settings[client_name]
3192
3351
["secret"])
3193
3352
3194
3353
# Add/remove clients based on new changes made to config
3195
3354
for client_name in (set(old_client_settings)
3196
3355
- set(client_settings)):
3198
3357
for client_name in (set(client_settings)
3199
3358
- set(old_client_settings)):
3200
3359
clients_data[client_name] = client_settings[client_name]
3201
3360
3202
3361
# Create all client objects
3203
3362
for client_name, client in clients_data.items():
3204
3363
tcp_server.clients[client_name] = client_class(
3205
name = client_name,
3206
settings = client,
3207
server_settings = server_settings)
3208
3364
name=client_name,
3365
settings=client,
3366
server_settings=server_settings)
3367
3209
3368
if not tcp_server.clients:
3210
3369
logger.warning("No clients defined")
3211
3370
3212
3371
if not foreground:
3213
3372
if pidfile is not None:
3214
3373
pid = os.getpid()
3220
3379
pidfilename, pid)
3221
3380
del pidfile
3222
3381
del pidfilename
3223
3382
3224
3383
for termsig in (signal.SIGHUP, signal.SIGTERM):
3225
3384
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3226
3385
lambda: main_loop.quit() and False)
3227
3386
3228
3387
if use_dbus:
3229
3388
3230
3389
@alternate_dbus_interfaces(
3231
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3390
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3232
3391
class MandosDBusService(DBusObjectWithObjectManager):
3233
3392
"""A D-Bus proxy object"""
3234
3393
3235
3394
def __init__(self):
3236
3395
dbus.service.Object.__init__(self, bus, "/")
3237
3396
3238
3397
_interface = "se.recompile.Mandos"
3239
3398
3240
3399
@dbus.service.signal(_interface, signature="o")
3241
3400
def ClientAdded(self, objpath):
3242
3401
"D-Bus signal"
3243
3402
pass
3244
3403
3245
3404
@dbus.service.signal(_interface, signature="ss")
3246
def ClientNotFound(self, fingerprint, address):
3405
def ClientNotFound(self, key_id, address):
3247
3406
"D-Bus signal"
3248
3407
pass
3249
3408
3250
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3251
3410
"true"})
3252
3411
@dbus.service.signal(_interface, signature="os")
3253
3412
def ClientRemoved(self, objpath, name):
3254
3413
"D-Bus signal"
3255
3414
pass
3256
3415
3257
3416
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3258
3417
"true"})
3259
3418
@dbus.service.method(_interface, out_signature="ao")
3261
3420
"D-Bus method"
3262
3421
return dbus.Array(c.dbus_object_path for c in
3263
3422
tcp_server.clients.values())
3264
3423
3265
3424
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3266
3425
"true"})
3267
3426
@dbus.service.method(_interface,
3269
3428
def GetAllClientsWithProperties(self):
3270
3429
"D-Bus method"
3271
3430
return dbus.Dictionary(
3272
{ c.dbus_object_path: c.GetAll(
3431
{c.dbus_object_path: c.GetAll(
3273
3432
"se.recompile.Mandos.Client")
3274
for c in tcp_server.clients.values() },
3433
for c in tcp_server.clients.values()},
3275
3434
signature="oa{sv}")
3276
3435
3277
3436
@dbus.service.method(_interface, in_signature="o")
3278
3437
def RemoveClient(self, object_path):
3279
3438
"D-Bus method"
3287
3446
self.client_removed_signal(c)
3288
3447
return
3289
3448
raise KeyError(object_path)
3290
3449
3291
3450
del _interface
3292
3451
3293
3452
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3294
out_signature = "a{oa{sa{sv}}}")
3453
out_signature="a{oa{sa{sv}}}")
3295
3454
def GetManagedObjects(self):
3296
3455
"""D-Bus method"""
3297
3456
return dbus.Dictionary(
3298
{ client.dbus_object_path:
3299
dbus.Dictionary(
3300
{ interface: client.GetAll(interface)
3301
for interface in
3302
client._get_all_interface_names()})
3303
for client in tcp_server.clients.values()})
3304
3457
{client.dbus_object_path:
3458
dbus.Dictionary(
3459
{interface: client.GetAll(interface)
3460
for interface in
3461
client._get_all_interface_names()})
3462
for client in tcp_server.clients.values()})
3463
3305
3464
def client_added_signal(self, client):
3306
3465
"""Send the new standard signal and the old signal"""
3307
3466
if use_dbus:
3309
3468
self.InterfacesAdded(
3310
3469
client.dbus_object_path,
3311
3470
dbus.Dictionary(
3312
{ interface: client.GetAll(interface)
3313
for interface in
3314
client._get_all_interface_names()}))
3471
{interface: client.GetAll(interface)
3472
for interface in
3473
client._get_all_interface_names()}))
3315
3474
# Old signal
3316
3475
self.ClientAdded(client.dbus_object_path)
3317
3476
3318
3477
def client_removed_signal(self, client):
3319
3478
"""Send the new standard signal and the old signal"""
3320
3479
if use_dbus:
3325
3484
# Old signal
3326
3485
self.ClientRemoved(client.dbus_object_path,
3327
3486
client.name)
3328
3487
3329
3488
mandos_dbus_service = MandosDBusService()
3330
3489
3331
3490
# Save modules to variables to exempt the modules from being
3332
3491
# unloaded before the function registered with atexit() is run.
3333
3492
mp = multiprocessing
3334
3493
wn = wnull
3494
3335
3495
def cleanup():
3336
3496
"Cleanup function; run on exit"
3337
3497
if zeroconf:
3338
3498
service.cleanup()
3339
3499
3340
3500
mp.active_children()
3341
3501
wn.close()
3342
3502
if not (tcp_server.clients or client_settings):
3343
3503
return
3344
3504
3345
3505
# Store client before exiting. Secrets are encrypted with key
3346
3506
# based on what config file has. If config file is
3347
3507
# removed/edited, old secret will thus be unrecovable.
3352
3512
client.encrypted_secret = pgp.encrypt(client.secret,
3353
3513
key)
3354
3514
client_dict = {}
3355
3515
3356
3516
# A list of attributes that can not be pickled
3357
3517
# + secret.
3358
exclude = { "bus", "changedstate", "secret",
3359
"checker", "server_settings" }
3518
exclude = {"bus", "changedstate", "secret",
3519
"checker", "server_settings"}
3360
3520
for name, typ in inspect.getmembers(dbus.service
3361
3521
.Object):
3362
3522
exclude.add(name)
3363
3523
3364
3524
client_dict["encrypted_secret"] = (client
3365
3525
.encrypted_secret)
3366
3526
for attr in client.client_structure:
3367
3527
if attr not in exclude:
3368
3528
client_dict[attr] = getattr(client, attr)
3369
3529
3370
3530
clients[client.name] = client_dict
3371
3531
del client_settings[client.name]["secret"]
3372
3532
3373
3533
try:
3374
3534
with tempfile.NamedTemporaryFile(
3375
3535
mode='wb',
3378
3538
dir=os.path.dirname(stored_state_path),
3379
3539
delete=False) as stored_state:
3380
3540
pickle.dump((clients, client_settings), stored_state,
3381
protocol = 2)
3541
protocol=2)
3382
3542
tempname = stored_state.name
3383
3543
os.rename(tempname, stored_state_path)
3384
3544
except (IOError, OSError) as e:
3394
3554
logger.warning("Could not save persistent state:",
3395
3555
exc_info=e)
3396
3556
raise
3397
3557
3398
3558
# Delete all clients, and settings from config
3399
3559
while tcp_server.clients:
3400
3560
name, client = tcp_server.clients.popitem()
3406
3566
if use_dbus:
3407
3567
mandos_dbus_service.client_removed_signal(client)
3408
3568
client_settings.clear()
3409
3569
3410
3570
atexit.register(cleanup)
3411
3571
3412
3572
for client in tcp_server.clients.values():
3413
3573
if use_dbus:
3414
3574
# Emit D-Bus signal for adding
3416
3576
# Need to initiate checking of clients
3417
3577
if client.enabled:
3418
3578
client.init_checker()
3419
3579
3420
3580
tcp_server.enable()
3421
3581
tcp_server.server_activate()
3422
3582
3423
3583
# Find out what port we got
3424
3584
if zeroconf:
3425
3585
service.port = tcp_server.socket.getsockname()[1]
3430
3590
else: # IPv4
3431
3591
logger.info("Now listening on address %r, port %d",
3432
3592
*tcp_server.socket.getsockname())
3433
3434
#service.interface = tcp_server.socket.getsockname()[3]
3435
3593
3594
# service.interface = tcp_server.socket.getsockname()[3]
3595
3436
3596
try:
3437
3597
if zeroconf:
3438
3598
# From the Avahi example code
3443
3603
cleanup()
3444
3604
sys.exit(1)
3445
3605
# End of Avahi example code
3446
3447
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3448
lambda *args, **kwargs:
3449
(tcp_server.handle_request
3450
(*args[2:], **kwargs) or True))
3451
3606
3607
GLib.io_add_watch(
3608
GLib.IOChannel.unix_new(tcp_server.fileno()),
3609
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3610
lambda *args, **kwargs: (tcp_server.handle_request
3611
(*args[2:], **kwargs) or True))
3612
3452
3613
logger.debug("Starting main loop")
3453
3614
main_loop.run()
3454
3615
except AvahiError as error:
3463
3624
# Must run before the D-Bus bus name gets deregistered
3464
3625
cleanup()
3465
3626
3627
3628
def should_only_run_tests():
3629
parser = argparse.ArgumentParser(add_help=False)
3630
parser.add_argument("--check", action='store_true')
3631
args, unknown_args = parser.parse_known_args()
3632
run_tests = args.check
3633
if run_tests:
3634
# Remove --check argument from sys.argv
3635
sys.argv[1:] = unknown_args
3636
return run_tests
3637
3638
# Add all tests from doctest strings
3639
def load_tests(loader, tests, none):
3640
import doctest
3641
tests.addTests(doctest.DocTestSuite())
3642
return tests
3466
3643
3467
3644
if __name__ == '__main__':
3468
main()
3645
try:
3646
if should_only_run_tests():
3647
# Call using ./mandos --check [--verbose]
3648
unittest.main()
3649
else:
3650
main()
3651
finally:
3652
logging.shutdown()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0