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