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