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 1221
- compare with another revision
- download diff
- download tarball
- view history from revision 1221
- Committer: teddy at recompile
- Date: 2020-11-29 21:54:00 UTC
- Revision ID: teddy@recompile.se-20201129215400-1zkzmiadisa8whx2
Change URL of systemd "Password Agents" specification
The URL of the systemd "Password Agents" specification changed from
<https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents> to
<https://systemd.io/PASSWORD_AGENTS/>.
* dracut-module/password-agent.c: Change URL in code comments.
* dracut-module/password-agent.xml: Change URL.
* intro.xml (SYSTEMD): - '' -
The URL of the systemd "Password Agents" specification changed from
<https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents> to
<https://systemd.io/PASSWORD_AGENTS/>.
* dracut-module/password-agent.c: Change URL in code comments.
* dracut-module/password-agent.xml: Change URL.
* intro.xml (SYSTEMD): - '' -
- files added:
- bugs.xml
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8 -*-
3
#
1
#!/usr/bin/python3 -bI
2
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
#
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
#
12
#
13
13
# Everything else is
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 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
import SocketServer as socketserver
38
try:
39
from future_builtins import *
40
except ImportError:
41
pass
42
43
try:
44
import SocketServer as socketserver
45
except ImportError:
46
import socketserver
38
47
import socket
39
48
import argparse
40
49
import datetime
41
50
import errno
42
import gnutls.crypto
43
import gnutls.connection
44
import gnutls.errors
45
import gnutls.library.functions
46
import gnutls.library.constants
47
import gnutls.library.types
48
import ConfigParser as configparser
51
try:
52
import ConfigParser as configparser
53
except ImportError:
54
import configparser
49
55
import sys
50
56
import re
51
57
import os
60
66
import struct
61
67
import fcntl
62
68
import functools
63
import cPickle as pickle
69
try:
70
import cPickle as pickle
71
except ImportError:
72
import pickle
64
73
import multiprocessing
65
74
import types
66
import hashlib
75
import binascii
76
import tempfile
77
import itertools
78
import collections
79
import codecs
80
import unittest
81
import random
82
import shlex
67
83
68
84
import dbus
69
85
import dbus.service
70
import gobject
71
import avahi
86
import gi
87
from gi.repository import GLib
72
88
from dbus.mainloop.glib import DBusGMainLoop
73
89
import ctypes
74
90
import ctypes.util
75
91
import xml.dom.minidom
76
92
import inspect
77
import Crypto.Cipher.AES
78
79
try:
93
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:
80
122
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
81
123
except AttributeError:
82
124
try:
125
# This is where SO_BINDTODEVICE was up to and including Python
126
# 2.6, and also 3.2:
83
127
from IN import SO_BINDTODEVICE
84
128
except ImportError:
85
SO_BINDTODEVICE = None
86
87
88
version = "1.4.1"
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.12"
147
stored_state_file = "clients.pickle"
89
148
90
149
logger = logging.getLogger()
91
stored_state_path = "/var/lib/mandos/clients.pickle"
92
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
96
syslogger.setFormatter(logging.Formatter
97
('Mandos [%(process)d]: %(levelname)s:'
98
' %(message)s'))
99
logger.addHandler(syslogger)
100
101
console = logging.StreamHandler()
102
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
103
' [%(process)d]:'
104
' %(levelname)s:'
105
' %(message)s'))
106
logger.addHandler(console)
150
logging.captureWarnings(True) # Show warnings via the logging system
151
syslogger = None
152
153
try:
154
if_nametoindex = ctypes.cdll.LoadLibrary(
155
ctypes.util.find_library("c")).if_nametoindex
156
except (OSError, AttributeError):
157
158
def if_nametoindex(interface):
159
"Get an interface index the hard way, i.e. using fcntl()"
160
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
161
with contextlib.closing(socket.socket()) as s:
162
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
163
struct.pack(b"16s16x", interface))
164
interface_index = struct.unpack("I", ifreq[16:20])[0]
165
return interface_index
166
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
184
def initlogger(debug, level=logging.WARNING):
185
"""init logger and add loglevel"""
186
187
global syslogger
188
syslogger = (logging.handlers.SysLogHandler(
189
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
address="/dev/log"))
191
syslogger.setFormatter(logging.Formatter
192
('Mandos [%(process)d]: %(levelname)s:'
193
' %(message)s'))
194
logger.addHandler(syslogger)
195
196
if debug:
197
console = logging.StreamHandler()
198
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
199
' [%(process)d]:'
200
' %(levelname)s:'
201
' %(message)s'))
202
logger.addHandler(console)
203
logger.setLevel(level)
204
205
206
class PGPError(Exception):
207
"""Exception if encryption/decryption fails"""
208
pass
209
210
211
class PGPEngine:
212
"""A simple class for OpenPGP symmetric encryption & decryption"""
213
214
def __init__(self):
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
227
self.gnupgargs = ['--batch',
228
'--homedir', self.tempdir,
229
'--force-mdc',
230
'--quiet']
231
# Only GPG version 1 has the --no-use-agent option.
232
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
233
self.gnupgargs.append("--no-use-agent")
234
235
def __enter__(self):
236
return self
237
238
def __exit__(self, exc_type, exc_value, traceback):
239
self._cleanup()
240
return False
241
242
def __del__(self):
243
self._cleanup()
244
245
def _cleanup(self):
246
if self.tempdir is not None:
247
# Delete contents of tempdir
248
for root, dirs, files in os.walk(self.tempdir,
249
topdown=False):
250
for filename in files:
251
os.remove(os.path.join(root, filename))
252
for dirname in dirs:
253
os.rmdir(os.path.join(root, dirname))
254
# Remove tempdir
255
os.rmdir(self.tempdir)
256
self.tempdir = None
257
258
def password_encode(self, password):
259
# Passphrase can not be empty and can not contain newlines or
260
# NUL bytes. So we prefix it and hex encode it.
261
encoded = b"mandos" + binascii.hexlify(password)
262
if len(encoded) > 2048:
263
# GnuPG can't handle long passwords, so encode differently
264
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
265
.replace(b"\n", b"\\n")
266
.replace(b"\0", b"\\x00"))
267
return encoded
268
269
def encrypt(self, data, password):
270
passphrase = self.password_encode(password)
271
with tempfile.NamedTemporaryFile(
272
dir=self.tempdir) as passfile:
273
passfile.write(passphrase)
274
passfile.flush()
275
proc = subprocess.Popen([self.gpg, '--symmetric',
276
'--passphrase-file',
277
passfile.name]
278
+ self.gnupgargs,
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
283
if proc.returncode != 0:
284
raise PGPError(err)
285
return ciphertext
286
287
def decrypt(self, data, password):
288
passphrase = self.password_encode(password)
289
with tempfile.NamedTemporaryFile(
290
dir=self.tempdir) as passfile:
291
passfile.write(passphrase)
292
passfile.flush()
293
proc = subprocess.Popen([self.gpg, '--decrypt',
294
'--passphrase-file',
295
passfile.name]
296
+ self.gnupgargs,
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
301
if proc.returncode != 0:
302
raise PGPError(err)
303
return decrypted_plaintext
304
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
107
330
108
331
109
332
class AvahiError(Exception):
110
333
def __init__(self, value, *args, **kwargs):
111
334
self.value = value
112
super(AvahiError, self).__init__(value, *args, **kwargs)
113
def __unicode__(self):
114
return unicode(repr(self.value))
335
return super(AvahiError, self).__init__(value, *args,
336
**kwargs)
337
115
338
116
339
class AvahiServiceError(AvahiError):
117
340
pass
118
341
342
119
343
class AvahiGroupError(AvahiError):
120
344
pass
121
345
122
346
123
class AvahiService(object):
347
class AvahiService:
124
348
"""An Avahi (Zeroconf) service.
125
349
126
350
Attributes:
127
351
interface: integer; avahi.IF_UNSPEC or an interface index.
128
352
Used to optionally bind to the specified interface.
129
353
name: string; Example: 'Mandos'
130
354
type: string; Example: '_mandos._tcp'.
131
See <http://www.dns-sd.org/ServiceTypes.html>
355
See <https://www.iana.org/assignments/service-names-port-numbers>
132
356
port: integer; what port to announce
133
357
TXT: list of strings; TXT record for the service
134
358
domain: string; Domain to publish on, default to .local if empty.
140
364
server: D-Bus Server
141
365
bus: dbus.SystemBus()
142
366
"""
143
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
144
servicetype = None, port = None, TXT = None,
145
domain = "", host = "", max_renames = 32768,
146
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):
147
379
self.interface = interface
148
380
self.name = name
149
381
self.type = servicetype
158
390
self.server = None
159
391
self.bus = bus
160
392
self.entry_group_state_changed_match = None
161
def rename(self):
393
394
def rename(self, remove=True):
162
395
"""Derived from the Avahi example code"""
163
396
if self.rename_count >= self.max_renames:
164
397
logger.critical("No suitable Zeroconf service name found"
165
398
" after %i retries, exiting.",
166
399
self.rename_count)
167
400
raise AvahiServiceError("Too many renames")
168
self.name = unicode(self.server
169
.GetAlternativeServiceName(self.name))
401
self.name = str(
402
self.server.GetAlternativeServiceName(self.name))
403
self.rename_count += 1
170
404
logger.info("Changing Zeroconf service name to %r ...",
171
405
self.name)
172
self.remove()
406
if remove:
407
self.remove()
173
408
try:
174
409
self.add()
175
410
except dbus.exceptions.DBusException as error:
176
logger.critical("DBusException: %s", error)
177
self.cleanup()
178
os._exit(1)
179
self.rename_count += 1
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
180
420
def remove(self):
181
421
"""Derived from the Avahi example code"""
182
422
if self.entry_group_state_changed_match is not None:
184
424
self.entry_group_state_changed_match = None
185
425
if self.group is not None:
186
426
self.group.Reset()
427
187
428
def add(self):
188
429
"""Derived from the Avahi example code"""
189
430
self.remove()
206
447
dbus.UInt16(self.port),
207
448
avahi.string_array_to_txt_array(self.TXT))
208
449
self.group.Commit()
450
209
451
def entry_group_state_changed(self, state, error):
210
452
"""Derived from the Avahi example code"""
211
453
logger.debug("Avahi entry group state change: %i", state)
212
454
213
455
if state == avahi.ENTRY_GROUP_ESTABLISHED:
214
456
logger.debug("Zeroconf service established.")
215
457
elif state == avahi.ENTRY_GROUP_COLLISION:
217
459
self.rename()
218
460
elif state == avahi.ENTRY_GROUP_FAILURE:
219
461
logger.critical("Avahi: Error in group state changed %s",
220
unicode(error))
221
raise AvahiGroupError("State changed: %s"
222
% unicode(error))
462
str(error))
463
raise AvahiGroupError("State changed: {!s}".format(error))
464
223
465
def cleanup(self):
224
466
"""Derived from the Avahi example code"""
225
467
if self.group is not None:
226
468
try:
227
469
self.group.Free()
228
470
except (dbus.exceptions.UnknownMethodException,
229
dbus.exceptions.DBusException) as e:
471
dbus.exceptions.DBusException):
230
472
pass
231
473
self.group = None
232
474
self.remove()
475
233
476
def server_state_changed(self, state, error=None):
234
477
"""Derived from the Avahi example code"""
235
478
logger.debug("Avahi server state change: %i", state)
236
bad_states = { avahi.SERVER_INVALID:
237
"Zeroconf server invalid",
238
avahi.SERVER_REGISTERING: None,
239
avahi.SERVER_COLLISION:
240
"Zeroconf server name collision",
241
avahi.SERVER_FAILURE:
242
"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
}
243
485
if state in bad_states:
244
486
if bad_states[state] is not None:
245
487
if error is None:
248
490
logger.error(bad_states[state] + ": %r", error)
249
491
self.cleanup()
250
492
elif state == avahi.SERVER_RUNNING:
251
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)
252
505
else:
253
506
if error is None:
254
507
logger.debug("Unknown state: %r", state)
255
508
else:
256
509
logger.debug("Unknown state: %r: %r", state, error)
510
257
511
def activate(self):
258
512
"""Derived from the Avahi example code"""
259
513
if self.server is None:
263
517
follow_name_owner_changes=True),
264
518
avahi.DBUS_INTERFACE_SERVER)
265
519
self.server.connect_to_signal("StateChanged",
266
self.server_state_changed)
520
self.server_state_changed)
267
521
self.server_state_changed(self.server.GetState())
268
522
523
269
524
class AvahiServiceToSyslog(AvahiService):
270
def rename(self):
525
def rename(self, *args, **kwargs):
271
526
"""Add the new name to the syslog messages"""
272
ret = AvahiService.rename(self)
273
syslogger.setFormatter(logging.Formatter
274
('Mandos (%s) [%%(process)d]:'
275
' %%(levelname)s: %%(message)s'
276
% 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)))
277
532
return ret
278
533
279
def _timedelta_to_milliseconds(td):
280
"Convert a datetime.timedelta() to milliseconds"
281
return ((td.days * 24 * 60 * 60 * 1000)
282
+ (td.seconds * 1000)
283
+ (td.microseconds // 1000))
284
285
class Client(object):
534
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:
286
854
"""A representation of a client host served by this server.
287
855
288
856
Attributes:
289
_approved: bool(); 'None' if not yet approved/disapproved
857
approved: bool(); 'None' if not yet approved/disapproved
290
858
approval_delay: datetime.timedelta(); Time to wait for approval
291
859
approval_duration: datetime.timedelta(); Duration of one approval
292
checker: subprocess.Popen(); a running checker process used
293
to see if the client lives.
294
'None' if no process is running.
295
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
296
864
checker_command: string; External command which is run to check
297
865
if client lives. %() expansions are done at
298
866
runtime with vars(self) as dict, so that for
299
867
instance %(name)s can be used in the command.
300
checker_initiator_tag: a gobject event source tag, or None
868
checker_initiator_tag: a GLib event source tag, or None
301
869
created: datetime.datetime(); (UTC) object creation
302
870
client_structure: Object describing what attributes a client has
303
871
and is used for storing the client at exit
304
872
current_checker_command: string; current running checker_command
305
disable_initiator_tag: a gobject event source tag, or None
873
disable_initiator_tag: a GLib event source tag, or None
306
874
enabled: bool()
307
875
fingerprint: string (40 or 32 hexadecimal digits); used to
308
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
309
879
host: string; available for use by the checker command
310
880
interval: datetime.timedelta(); How often to start a new checker
311
881
last_approval_request: datetime.datetime(); (UTC) or None
312
882
last_checked_ok: datetime.datetime(); (UTC) or None
313
last_checker_status: integer between 0 and 255 reflecting exit status
314
of last checker. -1 reflect crashed checker,
315
or None.
316
last_enabled: datetime.datetime(); (UTC)
883
last_checker_status: integer between 0 and 255 reflecting exit
884
status of last checker. -1 reflects crashed
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
888
last_enabled: datetime.datetime(); (UTC) or None
317
889
name: string; from the config file, used in log messages and
318
890
D-Bus identifiers
319
891
secret: bytestring; sent verbatim (over TLS) to client
320
892
timeout: datetime.timedelta(); How long from last_checked_ok
321
893
until this client is disabled
322
extended_timeout: extra long timeout when password has been sent
894
extended_timeout: extra long timeout when secret has been sent
323
895
runtime_expansions: Allowed attributes for runtime expansion.
324
896
expires: datetime.datetime(); time (UTC) when a client will be
325
897
disabled, or None
898
server_settings: The server_settings dict from main()
326
899
"""
327
900
328
901
runtime_expansions = ("approval_delay", "approval_duration",
329
"created", "enabled", "fingerprint",
330
"host", "interval", "last_checked_ok",
902
"created", "enabled", "expires", "key_id",
903
"fingerprint", "host", "interval",
904
"last_approval_request", "last_checked_ok",
331
905
"last_enabled", "name", "timeout")
332
333
def timeout_milliseconds(self):
334
"Return the 'timeout' attribute in milliseconds"
335
return _timedelta_to_milliseconds(self.timeout)
336
337
def extended_timeout_milliseconds(self):
338
"Return the 'extended_timeout' attribute in milliseconds"
339
return _timedelta_to_milliseconds(self.extended_timeout)
340
341
def interval_milliseconds(self):
342
"Return the 'interval' attribute in milliseconds"
343
return _timedelta_to_milliseconds(self.interval)
344
345
def approval_delay_milliseconds(self):
346
return _timedelta_to_milliseconds(self.approval_delay)
347
348
def __init__(self, name = None, config=None):
349
"""Note: the 'checker' key in 'config' sets the
350
'checker_command' attribute and *not* the 'checker'
351
attribute."""
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
918
@staticmethod
919
def config_parser(config):
920
"""Construct a new dict of client settings of this form:
921
{ client_name: {setting_name: value, ...}, ...}
922
with exceptions for any special settings as defined above.
923
NOTE: Must be a pure function. Must return the same result
924
value given the same arguments.
925
"""
926
settings = {}
927
for client_name in config.sections():
928
section = dict(config.items(client_name))
929
client = settings[client_name] = {}
930
931
client["host"] = section["host"]
932
# Reformat values from string types to Python types
933
client["approved_by_default"] = config.getboolean(
934
client_name, "approved_by_default")
935
client["enabled"] = config.getboolean(client_name,
936
"enabled")
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(" ", ""))
943
client["fingerprint"] = (section["fingerprint"].upper()
944
.replace(" ", ""))
945
if "secret" in section:
946
client["secret"] = codecs.decode(section["secret"]
947
.encode("utf-8"),
948
"base64")
949
elif "secfile" in section:
950
with open(os.path.expanduser(os.path.expandvars
951
(section["secfile"])),
952
"rb") as secfile:
953
client["secret"] = secfile.read()
954
else:
955
raise TypeError("No secret or secfile for section {}"
956
.format(section))
957
client["timeout"] = string_to_delta(section["timeout"])
958
client["extended_timeout"] = string_to_delta(
959
section["extended_timeout"])
960
client["interval"] = string_to_delta(section["interval"])
961
client["approval_delay"] = string_to_delta(
962
section["approval_delay"])
963
client["approval_duration"] = string_to_delta(
964
section["approval_duration"])
965
client["checker_command"] = section["checker"]
966
client["last_approval_request"] = None
967
client["last_checked_ok"] = None
968
client["last_checker_status"] = -2
969
970
return settings
971
972
def __init__(self, settings, name=None, server_settings=None):
352
973
self.name = name
353
if config is None:
354
config = {}
974
if server_settings is None:
975
server_settings = {}
976
self.server_settings = server_settings
977
# adding all client settings
978
for setting, value in settings.items():
979
setattr(self, setting, value)
980
981
if self.enabled:
982
if not hasattr(self, "last_enabled"):
983
self.last_enabled = datetime.datetime.utcnow()
984
if not hasattr(self, "expires"):
985
self.expires = (datetime.datetime.utcnow()
986
+ self.timeout)
987
else:
988
self.last_enabled = None
989
self.expires = None
990
355
991
logger.debug("Creating client %r", self.name)
356
# Uppercase and remove spaces from fingerprint for later
357
# comparison purposes with return value from the fingerprint()
358
# function
359
self.fingerprint = (config["fingerprint"].upper()
360
.replace(" ", ""))
992
logger.debug(" Key ID: %s", self.key_id)
361
993
logger.debug(" Fingerprint: %s", self.fingerprint)
362
if "secret" in config:
363
self.secret = config["secret"].decode("base64")
364
elif "secfile" in config:
365
with open(os.path.expanduser(os.path.expandvars
366
(config["secfile"])),
367
"rb") as secfile:
368
self.secret = secfile.read()
369
else:
370
raise TypeError("No secret or secfile for client %s"
371
% self.name)
372
self.host = config.get("host", "")
373
self.created = datetime.datetime.utcnow()
374
self.enabled = True
375
self.last_approval_request = None
376
self.last_enabled = datetime.datetime.utcnow()
377
self.last_checked_ok = None
378
self.last_checker_status = None
379
self.timeout = string_to_delta(config["timeout"])
380
self.extended_timeout = string_to_delta(config
381
["extended_timeout"])
382
self.interval = string_to_delta(config["interval"])
994
self.created = settings.get("created",
995
datetime.datetime.utcnow())
996
997
# attributes specific for this server instance
383
998
self.checker = None
384
999
self.checker_initiator_tag = None
385
1000
self.disable_initiator_tag = None
386
self.expires = datetime.datetime.utcnow() + self.timeout
387
1001
self.checker_callback_tag = None
388
self.checker_command = config["checker"]
389
1002
self.current_checker_command = None
390
self._approved = None
391
self.approved_by_default = config.get("approved_by_default",
392
True)
1003
self.approved = None
393
1004
self.approvals_pending = 0
394
self.approval_delay = string_to_delta(
395
config["approval_delay"])
396
self.approval_duration = string_to_delta(
397
config["approval_duration"])
398
self.changedstate = (multiprocessing_manager
399
.Condition(multiprocessing_manager
400
.Lock()))
401
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
1005
self.changedstate = multiprocessing_manager.Condition(
1006
multiprocessing_manager.Lock())
1007
self.client_structure = [attr
1008
for attr in self.__dict__.keys()
1009
if not attr.startswith("_")]
402
1010
self.client_structure.append("client_structure")
403
1011
404
405
for name, t in inspect.getmembers(type(self),
406
lambda obj: isinstance(obj, property)):
1012
for name, t in inspect.getmembers(
1013
type(self), lambda obj: isinstance(obj, property)):
407
1014
if not name.startswith("_"):
408
1015
self.client_structure.append(name)
409
1016
410
1017
# Send notice to process children that client state has changed
411
1018
def send_changedstate(self):
412
1019
with self.changedstate:
413
1020
self.changedstate.notify_all()
414
1021
415
1022
def enable(self):
416
1023
"""Start this client's checker and timeout hooks"""
417
1024
if getattr(self, "enabled", False):
418
1025
# Already enabled
419
1026
return
420
self.send_changedstate()
421
1027
self.expires = datetime.datetime.utcnow() + self.timeout
422
1028
self.enabled = True
423
1029
self.last_enabled = datetime.datetime.utcnow()
424
1030
self.init_checker()
425
1031
self.send_changedstate()
1032
426
1033
def disable(self, quiet=True):
427
1034
"""Disable this client."""
428
1035
if not getattr(self, "enabled", False):
429
1036
return False
430
1037
if not quiet:
431
self.send_changedstate()
432
if not quiet:
433
1038
logger.info("Disabling client %s", self.name)
434
if getattr(self, "disable_initiator_tag", False):
435
gobject.source_remove(self.disable_initiator_tag)
1039
if getattr(self, "disable_initiator_tag", None) is not None:
1040
GLib.source_remove(self.disable_initiator_tag)
436
1041
self.disable_initiator_tag = None
437
1042
self.expires = None
438
if getattr(self, "checker_initiator_tag", False):
439
gobject.source_remove(self.checker_initiator_tag)
1043
if getattr(self, "checker_initiator_tag", None) is not None:
1044
GLib.source_remove(self.checker_initiator_tag)
440
1045
self.checker_initiator_tag = None
441
1046
self.stop_checker()
442
1047
self.enabled = False
443
# Do not run this again if called by a gobject.timeout_add
1048
if not quiet:
1049
self.send_changedstate()
1050
# Do not run this again if called by a GLib.timeout_add
444
1051
return False
445
1052
446
1053
def __del__(self):
447
1054
self.disable()
448
1055
449
1056
def init_checker(self):
450
1057
# Schedule a new checker to be started an 'interval' from now,
451
1058
# and every interval from then on.
452
self.checker_initiator_tag = (gobject.timeout_add
453
(self.interval_milliseconds(),
454
self.start_checker))
1059
if self.checker_initiator_tag is not None:
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)
455
1065
# Schedule a disable() when 'timeout' has passed
456
self.disable_initiator_tag = (gobject.timeout_add
457
(self.timeout_milliseconds(),
458
self.disable))
1066
if self.disable_initiator_tag is not None:
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)
459
1070
# Also start a new checker *right now*.
460
1071
self.start_checker()
461
1072
462
463
def checker_callback(self, pid, condition, command):
1073
def checker_callback(self, source, condition, connection,
1074
command):
464
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()
465
1081
self.checker_callback_tag = None
466
1082
self.checker = None
467
if os.WIFEXITED(condition):
468
self.last_checker_status = os.WEXITSTATUS(condition)
1083
1084
if returncode >= 0:
1085
self.last_checker_status = returncode
1086
self.last_checker_signal = None
469
1087
if self.last_checker_status == 0:
470
1088
logger.info("Checker for %(name)s succeeded",
471
1089
vars(self))
472
1090
self.checked_ok()
473
1091
else:
474
logger.info("Checker for %(name)s failed",
475
vars(self))
1092
logger.info("Checker for %(name)s failed", vars(self))
476
1093
else:
477
1094
self.last_checker_status = -1
1095
self.last_checker_signal = -returncode
478
1096
logger.warning("Checker for %(name)s crashed?",
479
1097
vars(self))
480
481
def checked_ok(self, timeout=None):
482
"""Bump up the timeout for this client.
483
484
This should only be called when the client has been seen,
485
alive and well.
486
"""
1098
return False
1099
1100
def checked_ok(self):
1101
"""Assert that the client has been seen, alive and well."""
1102
self.last_checked_ok = datetime.datetime.utcnow()
1103
self.last_checker_status = 0
1104
self.last_checker_signal = None
1105
self.bump_timeout()
1106
1107
def bump_timeout(self, timeout=None):
1108
"""Bump up the timeout for this client."""
487
1109
if timeout is None:
488
1110
timeout = self.timeout
489
self.last_checked_ok = datetime.datetime.utcnow()
490
1111
if self.disable_initiator_tag is not None:
491
gobject.source_remove(self.disable_initiator_tag)
1112
GLib.source_remove(self.disable_initiator_tag)
1113
self.disable_initiator_tag = None
492
1114
if getattr(self, "enabled", False):
493
self.disable_initiator_tag = (gobject.timeout_add
494
(_timedelta_to_milliseconds
495
(timeout), self.disable))
1115
self.disable_initiator_tag = GLib.timeout_add(
1116
int(timeout.total_seconds() * 1000), self.disable)
496
1117
self.expires = datetime.datetime.utcnow() + timeout
497
1118
498
1119
def need_approval(self):
499
1120
self.last_approval_request = datetime.datetime.utcnow()
500
1121
501
1122
def start_checker(self):
502
1123
"""Start a new checker subprocess if one is not running.
503
1124
504
1125
If a checker already exists, leave it running and do
505
1126
nothing."""
506
1127
# The reason for not killing a running checker is that if we
507
# did that, then if a checker (for some reason) started
508
# running slowly and taking more than 'interval' time, the
509
# client would inevitably timeout, since no checker would get
510
# a chance to run to completion. If we instead leave running
1128
# did that, and if a checker (for some reason) started running
1129
# slowly and taking more than 'interval' time, then the client
1130
# would inevitably timeout, since no checker would get a
1131
# chance to run to completion. If we instead leave running
511
1132
# checkers alone, the checker would have to take more time
512
1133
# than 'timeout' for the client to be disabled, which is as it
513
1134
# should be.
514
515
# If a checker exists, make sure it is not a zombie
516
try:
517
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
518
except (AttributeError, OSError) as error:
519
if (isinstance(error, OSError)
520
and error.errno != errno.ECHILD):
521
raise error
522
else:
523
if pid:
524
logger.warning("Checker was a zombie")
525
gobject.source_remove(self.checker_callback_tag)
526
self.checker_callback(pid, status,
527
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
528
1140
# Start a new checker if needed
529
1141
if self.checker is None:
1142
# Escape attributes for the shell
1143
escaped_attrs = {
1144
attr: shlex.quote(str(getattr(self, attr)))
1145
for attr in self.runtime_expansions}
530
1146
try:
531
# In case checker_command has exactly one % operator
532
command = self.checker_command % self.host
533
except TypeError:
534
# Escape attributes for the shell
535
escaped_attrs = dict(
536
(attr,
537
re.escape(unicode(str(getattr(self, attr, "")),
538
errors=
539
'replace')))
540
for attr in
541
self.runtime_expansions)
542
543
try:
544
command = self.checker_command % escaped_attrs
545
except TypeError as error:
546
logger.error('Could not format string "%s":'
547
' %s', self.checker_command, error)
548
return True # Try again later
1147
command = self.checker_command % escaped_attrs
1148
except TypeError as error:
1149
logger.error('Could not format string "%s"',
1150
self.checker_command,
1151
exc_info=error)
1152
return True # Try again later
549
1153
self.current_checker_command = command
550
try:
551
logger.info("Starting checker %r for %s",
552
command, self.name)
553
# We don't need to redirect stdout and stderr, since
554
# in normal mode, that is already done by daemon(),
555
# and in debug mode we don't want to. (Stdin is
556
# always replaced by /dev/null.)
557
self.checker = subprocess.Popen(command,
558
close_fds=True,
559
shell=True, cwd="/")
560
self.checker_callback_tag = (gobject.child_watch_add
561
(self.checker.pid,
562
self.checker_callback,
563
data=command))
564
# The checker may have completed before the gobject
565
# watch was added. Check for this.
566
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
567
if pid:
568
gobject.source_remove(self.checker_callback_tag)
569
self.checker_callback(pid, status, command)
570
except OSError as error:
571
logger.error("Failed to start subprocess: %s",
572
error)
573
# 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
574
1181
return True
575
1182
576
1183
def stop_checker(self):
577
1184
"""Force the checker process, if any, to stop."""
578
1185
if self.checker_callback_tag:
579
gobject.source_remove(self.checker_callback_tag)
1186
GLib.source_remove(self.checker_callback_tag)
580
1187
self.checker_callback_tag = None
581
1188
if getattr(self, "checker", None) is None:
582
1189
return
583
1190
logger.debug("Stopping checker for %(name)s", vars(self))
584
try:
585
os.kill(self.checker.pid, signal.SIGTERM)
586
#time.sleep(0.5)
587
#if self.checker.poll() is None:
588
# os.kill(self.checker.pid, signal.SIGKILL)
589
except OSError as error:
590
if error.errno != errno.ESRCH: # No such process
591
raise
1191
self.checker.terminate()
592
1192
self.checker = None
593
1193
594
# Encrypts a client secret and stores it in a varible encrypted_secret
595
def encrypt_secret(self, key):
596
# Encryption-key need to be of a specific size, so we hash inputed key
597
hasheng = hashlib.sha256()
598
hasheng.update(key)
599
encryptionkey = hasheng.digest()
600
601
# Create validation hash so we know at decryption if it was sucessful
602
hasheng = hashlib.sha256()
603
hasheng.update(self.secret)
604
validationhash = hasheng.digest()
605
606
# Encrypt secret
607
iv = os.urandom(Crypto.Cipher.AES.block_size)
608
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
609
Crypto.Cipher.AES.MODE_CFB, iv)
610
ciphertext = ciphereng.encrypt(validationhash+self.secret)
611
self.encrypted_secret = (ciphertext, iv)
612
613
# Decrypt a encrypted client secret
614
def decrypt_secret(self, key):
615
# Decryption-key need to be of a specific size, so we hash inputed key
616
hasheng = hashlib.sha256()
617
hasheng.update(key)
618
encryptionkey = hasheng.digest()
619
620
# Decrypt encrypted secret
621
ciphertext, iv = self.encrypted_secret
622
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
623
Crypto.Cipher.AES.MODE_CFB, iv)
624
plain = ciphereng.decrypt(ciphertext)
625
626
# Validate decrypted secret to know if it was succesful
627
hasheng = hashlib.sha256()
628
validationhash = plain[:hasheng.digest_size]
629
secret = plain[hasheng.digest_size:]
630
hasheng.update(secret)
631
632
# if validation fails, we use key as new secret. Otherwhise, we use
633
# the decrypted secret
634
if hasheng.digest() == validationhash:
635
self.secret = secret
636
else:
637
self.secret = key
638
del self.encrypted_secret
639
640
641
def dbus_service_property(dbus_interface, signature="v",
642
access="readwrite", byte_arrays=False):
1194
1195
def dbus_service_property(dbus_interface,
1196
signature="v",
1197
access="readwrite",
1198
byte_arrays=False):
643
1199
"""Decorators for marking methods of a DBusObjectWithProperties to
644
1200
become properties on the D-Bus.
645
1201
646
1202
The decorated method will be called with no arguments by "Get"
647
1203
and with one argument by "Set".
648
1204
649
1205
The parameters, where they are supported, are the same as
650
1206
dbus.service.method, except there is only "signature", since the
651
1207
type from Get() and the type sent to Set() is the same.
654
1210
# "Set" method, so we fail early here:
655
1211
if byte_arrays and signature != "ay":
656
1212
raise ValueError("Byte arrays not supported for non-'ay'"
657
" signature %r" % signature)
1213
" signature {!r}".format(signature))
1214
658
1215
def decorator(func):
659
1216
func._dbus_is_property = True
660
1217
func._dbus_interface = dbus_interface
663
1220
func._dbus_name = func.__name__
664
1221
if func._dbus_name.endswith("_dbus_property"):
665
1222
func._dbus_name = func._dbus_name[:-14]
666
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
667
return func
1223
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1224
return func
1225
1226
return decorator
1227
1228
1229
def dbus_interface_annotations(dbus_interface):
1230
"""Decorator for marking functions returning interface annotations
1231
1232
Usage:
1233
1234
@dbus_interface_annotations("org.example.Interface")
1235
def _foo(self): # Function name does not matter
1236
return {"org.freedesktop.DBus.Deprecated": "true",
1237
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1238
"false"}
1239
"""
1240
1241
def decorator(func):
1242
func._dbus_is_interface = True
1243
func._dbus_interface = dbus_interface
1244
func._dbus_name = dbus_interface
1245
return func
1246
1247
return decorator
1248
1249
1250
def dbus_annotations(annotations):
1251
"""Decorator to annotate D-Bus methods, signals or properties
1252
Usage:
1253
1254
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1255
"org.freedesktop.DBus.Property."
1256
"EmitsChangedSignal": "false"})
1257
@dbus_service_property("org.example.Interface", signature="b",
1258
access="r")
1259
def Property_dbus_property(self):
1260
return dbus.Boolean(False)
1261
1262
See also the DBusObjectWithAnnotations class.
1263
"""
1264
1265
def decorator(func):
1266
func._dbus_annotations = annotations
1267
return func
1268
668
1269
return decorator
669
1270
670
1271
671
1272
class DBusPropertyException(dbus.exceptions.DBusException):
672
1273
"""A base class for D-Bus property-related exceptions
673
1274
"""
674
def __unicode__(self):
675
return unicode(str(self))
1275
pass
676
1276
677
1277
678
1278
class DBusPropertyAccessException(DBusPropertyException):
687
1287
pass
688
1288
689
1289
690
class DBusObjectWithProperties(dbus.service.Object):
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.
1295
"""
1296
1297
@staticmethod
1298
def _is_dbus_thing(thing):
1299
"""Returns a function testing if an attribute is a D-Bus thing
1300
1301
If called like _is_dbus_thing("method") it returns a function
1302
suitable for use as predicate to inspect.getmembers().
1303
"""
1304
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1305
False)
1306
1307
def _get_all_dbus_things(self, thing):
1308
"""Returns a generator of (name, attribute) pairs
1309
"""
1310
return ((getattr(athing.__get__(self), "_dbus_name", name),
1311
athing.__get__(self))
1312
for cls in self.__class__.__mro__
1313
for name, athing in
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):
691
1380
"""A D-Bus object with properties.
692
1381
693
1382
Classes inheriting from this can use the dbus_service_property
694
1383
decorator to expose methods as D-Bus properties. It exposes the
695
1384
standard Get(), Set(), and GetAll() methods on the D-Bus.
696
1385
"""
697
698
@staticmethod
699
def _is_dbus_property(obj):
700
return getattr(obj, "_dbus_is_property", False)
701
702
def _get_all_dbus_properties(self):
703
"""Returns a generator of (name, attribute) pairs
704
"""
705
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
706
for cls in self.__class__.__mro__
707
for name, prop in
708
inspect.getmembers(cls, self._is_dbus_property))
709
1386
710
1387
def _get_dbus_property(self, interface_name, property_name):
711
1388
"""Returns a bound method if one exists which is a D-Bus
712
1389
property with the specified name and interface.
713
1390
"""
714
for cls in self.__class__.__mro__:
715
for name, value in (inspect.getmembers
716
(cls, self._is_dbus_property)):
1391
for cls in self.__class__.__mro__:
1392
for name, value in inspect.getmembers(
1393
cls, self._is_dbus_thing("property")):
717
1394
if (value._dbus_name == property_name
718
1395
and value._dbus_interface == interface_name):
719
1396
return value.__get__(self)
720
1397
721
1398
# No such property
722
raise DBusPropertyNotFound(self.dbus_object_path + ":"
723
+ interface_name + "."
724
+ property_name)
725
726
@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",
727
1413
out_signature="v")
728
1414
def Get(self, interface_name, property_name):
729
1415
"""Standard D-Bus property Get() method, see D-Bus standard.
735
1421
if not hasattr(value, "variant_level"):
736
1422
return value
737
1423
return type(value)(value, variant_level=value.variant_level+1)
738
1424
739
1425
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
740
1426
def Set(self, interface_name, property_name, value):
741
1427
"""Standard D-Bus property Set() method, see D-Bus standard.
747
1433
# The byte_arrays option is not supported yet on
748
1434
# signatures other than "ay".
749
1435
if prop._dbus_signature != "ay":
750
raise ValueError
751
value = dbus.ByteArray(''.join(unichr(byte)
752
for byte in value))
1436
raise ValueError("Byte arrays not supported for non-"
1437
"'ay' signature {!r}"
1438
.format(prop._dbus_signature))
1439
value = dbus.ByteArray(bytes(value))
753
1440
prop(value)
754
755
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1441
1442
@dbus.service.method(dbus.PROPERTIES_IFACE,
1443
in_signature="s",
756
1444
out_signature="a{sv}")
757
1445
def GetAll(self, interface_name):
758
1446
"""Standard D-Bus property GetAll() method, see D-Bus
759
1447
standard.
760
1448
761
1449
Note: Will not include properties with access="write".
762
1450
"""
763
all = {}
764
for name, prop in self._get_all_dbus_properties():
1451
properties = {}
1452
for name, prop in self._get_all_dbus_things("property"):
765
1453
if (interface_name
766
1454
and interface_name != prop._dbus_interface):
767
1455
# Interface non-empty but did not match
771
1459
continue
772
1460
value = prop()
773
1461
if not hasattr(value, "variant_level"):
774
all[name] = value
1462
properties[name] = value
775
1463
continue
776
all[name] = type(value)(value, variant_level=
777
value.variant_level+1)
778
return dbus.Dictionary(all, signature="sv")
779
1464
properties[name] = type(value)(
1465
value, variant_level=value.variant_level + 1)
1466
return dbus.Dictionary(properties, signature="sv")
1467
1468
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1469
def PropertiesChanged(self, interface_name, changed_properties,
1470
invalidated_properties):
1471
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1472
standard.
1473
"""
1474
pass
1475
780
1476
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
781
1477
out_signature="s",
782
1478
path_keyword='object_path',
783
1479
connection_keyword='connection')
784
1480
def Introspect(self, object_path, connection):
785
"""Standard D-Bus method, overloaded to insert property tags.
1481
"""Overloading of standard D-Bus method.
1482
1483
Inserts property tags and interface annotation tags.
786
1484
"""
787
xmlstring = dbus.service.Object.Introspect(self, object_path,
788
connection)
1485
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1486
object_path,
1487
connection)
789
1488
try:
790
1489
document = xml.dom.minidom.parseString(xmlstring)
1490
791
1491
def make_tag(document, name, prop):
792
1492
e = document.createElement("property")
793
1493
e.setAttribute("name", name)
794
1494
e.setAttribute("type", prop._dbus_signature)
795
1495
e.setAttribute("access", prop._dbus_access)
796
1496
return e
1497
797
1498
for if_tag in document.getElementsByTagName("interface"):
1499
# Add property tags
798
1500
for tag in (make_tag(document, name, prop)
799
1501
for name, prop
800
in self._get_all_dbus_properties()
1502
in self._get_all_dbus_things("property")
801
1503
if prop._dbus_interface
802
1504
== if_tag.getAttribute("name")):
803
1505
if_tag.appendChild(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)
804
1522
# Add the names to the return values for the
805
1523
# "org.freedesktop.DBus.Properties" methods
806
1524
if (if_tag.getAttribute("name")
821
1539
except (AttributeError, xml.dom.DOMException,
822
1540
xml.parsers.expat.ExpatError) as error:
823
1541
logger.error("Failed to override Introspection method",
824
error)
825
return xmlstring
826
827
828
def datetime_to_dbus (dt, variant_level=0):
1542
exc_info=error)
1543
return xmlstring
1544
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
1617
def datetime_to_dbus(dt, variant_level=0):
829
1618
"""Convert a UTC datetime.datetime() to a D-Bus type."""
830
1619
if dt is None:
831
return dbus.String("", variant_level = variant_level)
832
return dbus.String(dt.isoformat(),
833
variant_level=variant_level)
834
835
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
836
.__metaclass__):
837
"""Applied to an empty subclass of a D-Bus object, this metaclass
838
will add additional D-Bus attributes matching a certain pattern.
1620
return dbus.String("", variant_level=variant_level)
1621
return dbus.String(dt.isoformat(), variant_level=variant_level)
1622
1623
1624
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1625
"""A class decorator; applied to a subclass of
1626
dbus.service.Object, it will add alternate D-Bus attributes with
1627
interface names according to the "alt_interface_names" mapping.
1628
Usage:
1629
1630
@alternate_dbus_interfaces({"org.example.Interface":
1631
"net.example.AlternateInterface"})
1632
class SampleDBusObject(dbus.service.Object):
1633
@dbus.service.method("org.example.Interface")
1634
def SampleDBusMethod():
1635
pass
1636
1637
The above "SampleDBusMethod" on "SampleDBusObject" will be
1638
reachable via two interfaces: "org.example.Interface" and
1639
"net.example.AlternateInterface", the latter of which will have
1640
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1641
"true", unless "deprecate" is passed with a False value.
1642
1643
This works for methods and signals, and also for D-Bus properties
1644
(from DBusObjectWithProperties) and interfaces (from the
1645
dbus_interface_annotations decorator).
839
1646
"""
840
def __new__(mcs, name, bases, attr):
841
# Go through all the base classes which could have D-Bus
842
# methods, signals, or properties in them
843
for base in (b for b in bases
844
if issubclass(b, dbus.service.Object)):
845
# Go though all attributes of the base class
846
for attrname, attribute in inspect.getmembers(base):
1647
1648
def wrapper(cls):
1649
for orig_interface_name, alt_interface_name in (
1650
alt_interface_names.items()):
1651
attr = {}
1652
interface_names = set()
1653
# Go though all attributes of the class
1654
for attrname, attribute in inspect.getmembers(cls):
847
1655
# Ignore non-D-Bus attributes, and D-Bus attributes
848
1656
# with the wrong interface name
849
1657
if (not hasattr(attribute, "_dbus_interface")
850
or not attribute._dbus_interface
851
.startswith("se.recompile.Mandos")):
1658
or not attribute._dbus_interface.startswith(
1659
orig_interface_name)):
852
1660
continue
853
1661
# Create an alternate D-Bus interface name based on
854
1662
# the current name
855
alt_interface = (attribute._dbus_interface
856
.replace("se.recompile.Mandos",
857
"se.bsnet.fukt.Mandos"))
1663
alt_interface = attribute._dbus_interface.replace(
1664
orig_interface_name, alt_interface_name)
1665
interface_names.add(alt_interface)
858
1666
# Is this a D-Bus signal?
859
1667
if getattr(attribute, "_dbus_is_signal", False):
860
# Extract the original non-method function by
861
# black magic
862
nonmethod_func = (dict(
1668
# Extract the original non-method undecorated
1669
# function by black magic
1670
if sys.version_info.major == 2:
1671
nonmethod_func = (dict(
863
1672
zip(attribute.func_code.co_freevars,
864
attribute.__closure__))["func"]
865
.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)
866
1680
# Create a new, but exactly alike, function
867
1681
# object, and decorate it to be a new D-Bus signal
868
1682
# with the alternate D-Bus interface name
869
new_function = (dbus.service.signal
870
(alt_interface,
871
attribute._dbus_signature)
872
(types.FunctionType(
873
nonmethod_func.func_code,
874
nonmethod_func.func_globals,
875
nonmethod_func.func_name,
876
nonmethod_func.func_defaults,
877
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))
1687
# Copy annotations, if any
1688
try:
1689
new_function._dbus_annotations = dict(
1690
attribute._dbus_annotations)
1691
except AttributeError:
1692
pass
1693
878
1694
# Define a creator of a function to call both the
879
# old and new functions, so both the old and new
880
# signals gets sent when the function is called
1695
# original and alternate functions, so both the
1696
# original and alternate signals gets sent when
1697
# the function is called
881
1698
def fixscope(func1, func2):
882
1699
"""This function is a scope container to pass
883
1700
func1 and func2 to the "call_both" function
884
1701
outside of its arguments"""
1702
1703
@functools.wraps(func2)
885
1704
def call_both(*args, **kwargs):
886
1705
"""This function will emit two D-Bus
887
1706
signals by calling func1 and func2"""
888
1707
func1(*args, **kwargs)
889
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
890
1715
return call_both
891
1716
# Create the "call_both" function and add it to
892
1717
# the class
893
attr[attrname] = fixscope(attribute,
894
new_function)
1718
attr[attrname] = fixscope(attribute, new_function)
895
1719
# Is this a D-Bus method?
896
1720
elif getattr(attribute, "_dbus_is_method", False):
897
1721
# Create a new, but exactly alike, function
898
1722
# object. Decorate it to be a new D-Bus method
899
1723
# with the alternate D-Bus interface name. Add it
900
1724
# to the class.
901
attr[attrname] = (dbus.service.method
902
(alt_interface,
903
attribute._dbus_in_signature,
904
attribute._dbus_out_signature)
905
(types.FunctionType
906
(attribute.func_code,
907
attribute.func_globals,
908
attribute.func_name,
909
attribute.func_defaults,
910
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)))
1731
# Copy annotations, if any
1732
try:
1733
attr[attrname]._dbus_annotations = dict(
1734
attribute._dbus_annotations)
1735
except AttributeError:
1736
pass
911
1737
# Is this a D-Bus property?
912
1738
elif getattr(attribute, "_dbus_is_property", False):
913
1739
# Create a new, but exactly alike, function
914
1740
# object, and decorate it to be a new D-Bus
915
1741
# property with the alternate D-Bus interface
916
1742
# name. Add it to the class.
917
attr[attrname] = (dbus_service_property
918
(alt_interface,
919
attribute._dbus_signature,
920
attribute._dbus_access,
921
attribute
922
._dbus_get_args_options
923
["byte_arrays"])
924
(types.FunctionType
925
(attribute.func_code,
926
attribute.func_globals,
927
attribute.func_name,
928
attribute.func_defaults,
929
attribute.func_closure)))
930
return type.__new__(mcs, name, bases, attr)
931
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)))
1749
# Copy annotations, if any
1750
try:
1751
attr[attrname]._dbus_annotations = dict(
1752
attribute._dbus_annotations)
1753
except AttributeError:
1754
pass
1755
# Is this a D-Bus interface?
1756
elif getattr(attribute, "_dbus_is_interface", False):
1757
# Create a new, but exactly alike, function
1758
# object. Decorate it to be a new D-Bus interface
1759
# with the alternate D-Bus interface name. Add it
1760
# to the class.
1761
attr[attrname] = (
1762
dbus_interface_annotations(alt_interface)
1763
(copy_function(attribute)))
1764
if deprecate:
1765
# Deprecate all alternate interfaces
1766
iname = "_AlternateDBusNames_interface_annotation{}"
1767
for interface_name in interface_names:
1768
1769
@dbus_interface_annotations(interface_name)
1770
def func(self):
1771
return {"org.freedesktop.DBus.Deprecated":
1772
"true"}
1773
# Find an unused name
1774
for aname in (iname.format(i)
1775
for i in itertools.count()):
1776
if aname not in attr:
1777
attr[aname] = func
1778
break
1779
if interface_names:
1780
# Replace the class with a new subclass of it with
1781
# methods, signals, etc. as created above.
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)
1788
return cls
1789
1790
return wrapper
1791
1792
1793
@alternate_dbus_interfaces({"se.recompile.Mandos":
1794
"se.bsnet.fukt.Mandos"})
932
1795
class ClientDBus(Client, DBusObjectWithProperties):
933
1796
"""A Client class using D-Bus
934
1797
935
1798
Attributes:
936
1799
dbus_object_path: dbus.ObjectPath
937
1800
bus: dbus.SystemBus()
938
1801
"""
939
1802
940
1803
runtime_expansions = (Client.runtime_expansions
941
+ ("dbus_object_path",))
942
1804
+ ("dbus_object_path", ))
1805
1806
_interface = "se.recompile.Mandos.Client"
1807
943
1808
# dbus.service.Object doesn't use super(), so we can't either.
944
945
def __init__(self, bus = None, *args, **kwargs):
1809
1810
def __init__(self, bus=None, *args, **kwargs):
946
1811
self.bus = bus
947
1812
Client.__init__(self, *args, **kwargs)
948
949
self._approvals_pending = 0
950
1813
# Only now, when this client is initialized, can it show up on
951
1814
# the D-Bus
952
client_object_name = unicode(self.name).translate(
1815
client_object_name = str(self.name).translate(
953
1816
{ord("."): ord("_"),
954
1817
ord("-"): ord("_")})
955
self.dbus_object_path = (dbus.ObjectPath
956
("/clients/" + client_object_name))
1818
self.dbus_object_path = dbus.ObjectPath(
1819
"/clients/" + client_object_name)
957
1820
DBusObjectWithProperties.__init__(self, self.bus,
958
1821
self.dbus_object_path)
959
960
def notifychangeproperty(transform_func,
961
dbus_name, type_func=lambda x: x,
962
variant_level=1):
1822
1823
def notifychangeproperty(transform_func, dbus_name,
1824
type_func=lambda x: x,
1825
variant_level=1,
1826
invalidate_only=False,
1827
_interface=_interface):
963
1828
""" Modify a variable so that it's a property which announces
964
1829
its changes to DBus.
965
1830
970
1835
to the D-Bus. Default: no transform
971
1836
variant_level: D-Bus variant level. Default: 1
972
1837
"""
973
attrname = "_{0}".format(dbus_name)
1838
attrname = "_{}".format(dbus_name)
1839
974
1840
def setter(self, value):
975
1841
if hasattr(self, "dbus_object_path"):
976
1842
if (not hasattr(self, attrname) or
977
1843
type_func(getattr(self, attrname, None))
978
1844
!= type_func(value)):
979
dbus_value = transform_func(type_func(value),
980
variant_level
981
=variant_level)
982
self.PropertyChanged(dbus.String(dbus_name),
983
dbus_value)
1845
if invalidate_only:
1846
self.PropertiesChanged(
1847
_interface, dbus.Dictionary(),
1848
dbus.Array((dbus_name, )))
1849
else:
1850
dbus_value = transform_func(
1851
type_func(value),
1852
variant_level=variant_level)
1853
self.PropertyChanged(dbus.String(dbus_name),
1854
dbus_value)
1855
self.PropertiesChanged(
1856
_interface,
1857
dbus.Dictionary({dbus.String(dbus_name):
1858
dbus_value}),
1859
dbus.Array())
984
1860
setattr(self, attrname, value)
985
1861
986
1862
return property(lambda self: getattr(self, attrname), setter)
987
988
1863
989
1864
expires = notifychangeproperty(datetime_to_dbus, "Expires")
990
1865
approvals_pending = notifychangeproperty(dbus.Boolean,
991
1866
"ApprovalPending",
992
type_func = bool)
1867
type_func=bool)
993
1868
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
994
1869
last_enabled = notifychangeproperty(datetime_to_dbus,
995
1870
"LastEnabled")
996
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
997
type_func = lambda checker:
998
checker is not None)
1871
checker = notifychangeproperty(
1872
dbus.Boolean, "CheckerRunning",
1873
type_func=lambda checker: checker is not None)
999
1874
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1000
1875
"LastCheckedOK")
1876
last_checker_status = notifychangeproperty(dbus.Int16,
1877
"LastCheckerStatus")
1001
1878
last_approval_request = notifychangeproperty(
1002
1879
datetime_to_dbus, "LastApprovalRequest")
1003
1880
approved_by_default = notifychangeproperty(dbus.Boolean,
1004
1881
"ApprovedByDefault")
1005
approval_delay = notifychangeproperty(dbus.UInt16,
1006
"ApprovalDelay",
1007
type_func =
1008
_timedelta_to_milliseconds)
1882
approval_delay = notifychangeproperty(
1883
dbus.UInt64, "ApprovalDelay",
1884
type_func=lambda td: td.total_seconds() * 1000)
1009
1885
approval_duration = notifychangeproperty(
1010
dbus.UInt16, "ApprovalDuration",
1011
type_func = _timedelta_to_milliseconds)
1886
dbus.UInt64, "ApprovalDuration",
1887
type_func=lambda td: td.total_seconds() * 1000)
1012
1888
host = notifychangeproperty(dbus.String, "Host")
1013
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1014
type_func =
1015
_timedelta_to_milliseconds)
1889
timeout = notifychangeproperty(
1890
dbus.UInt64, "Timeout",
1891
type_func=lambda td: td.total_seconds() * 1000)
1016
1892
extended_timeout = notifychangeproperty(
1017
dbus.UInt16, "ExtendedTimeout",
1018
type_func = _timedelta_to_milliseconds)
1019
interval = notifychangeproperty(dbus.UInt16,
1020
"Interval",
1021
type_func =
1022
_timedelta_to_milliseconds)
1893
dbus.UInt64, "ExtendedTimeout",
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)
1023
1898
checker_command = notifychangeproperty(dbus.String, "Checker")
1024
1899
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1900
invalidate_only=True)
1901
1025
1902
del notifychangeproperty
1026
1903
1027
1904
def __del__(self, *args, **kwargs):
1028
1905
try:
1029
1906
self.remove_from_connection()
1032
1909
if hasattr(DBusObjectWithProperties, "__del__"):
1033
1910
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1034
1911
Client.__del__(self, *args, **kwargs)
1035
1036
def checker_callback(self, pid, condition, command,
1037
*args, **kwargs):
1038
self.checker_callback_tag = None
1039
self.checker = None
1040
if os.WIFEXITED(condition):
1041
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:
1042
1920
# Emit D-Bus signal
1043
1921
self.CheckerCompleted(dbus.Int16(exitstatus),
1044
dbus.Int64(condition),
1922
# This is specific to GNU libC
1923
dbus.Int64(exitstatus << 8),
1045
1924
dbus.String(command))
1046
1925
else:
1047
1926
# Emit D-Bus signal
1048
1927
self.CheckerCompleted(dbus.Int16(-1),
1049
dbus.Int64(condition),
1928
dbus.Int64(
1929
# This is specific to GNU libC
1930
(exitstatus << 8)
1931
| self.last_checker_signal),
1050
1932
dbus.String(command))
1051
1052
return Client.checker_callback(self, pid, condition, command,
1053
*args, **kwargs)
1054
1933
return ret
1934
1055
1935
def start_checker(self, *args, **kwargs):
1056
old_checker = self.checker
1057
if self.checker is not None:
1058
old_checker_pid = self.checker.pid
1059
else:
1060
old_checker_pid = None
1936
old_checker_pid = getattr(self.checker, "pid", None)
1061
1937
r = Client.start_checker(self, *args, **kwargs)
1062
1938
# Only if new checker process was started
1063
1939
if (self.checker is not None
1065
1941
# Emit D-Bus signal
1066
1942
self.CheckerStarted(self.current_checker_command)
1067
1943
return r
1068
1944
1069
1945
def _reset_approved(self):
1070
self._approved = None
1946
self.approved = None
1071
1947
return False
1072
1948
1073
1949
def approve(self, value=True):
1950
self.approved = value
1951
GLib.timeout_add(int(self.approval_duration.total_seconds()
1952
* 1000), self._reset_approved)
1074
1953
self.send_changedstate()
1075
self._approved = value
1076
gobject.timeout_add(_timedelta_to_milliseconds
1077
(self.approval_duration),
1078
self._reset_approved)
1079
1080
1081
## D-Bus methods, signals & properties
1082
_interface = "se.recompile.Mandos.Client"
1083
1084
## Signals
1085
1954
1955
# D-Bus methods, signals & properties
1956
1957
# Interfaces
1958
1959
# Signals
1960
1086
1961
# CheckerCompleted - signal
1087
1962
@dbus.service.signal(_interface, signature="nxs")
1088
1963
def CheckerCompleted(self, exitcode, waitstatus, command):
1089
1964
"D-Bus signal"
1090
1965
pass
1091
1966
1092
1967
# CheckerStarted - signal
1093
1968
@dbus.service.signal(_interface, signature="s")
1094
1969
def CheckerStarted(self, command):
1095
1970
"D-Bus signal"
1096
1971
pass
1097
1972
1098
1973
# PropertyChanged - signal
1974
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1099
1975
@dbus.service.signal(_interface, signature="sv")
1100
1976
def PropertyChanged(self, property, value):
1101
1977
"D-Bus signal"
1102
1978
pass
1103
1979
1104
1980
# GotSecret - signal
1105
1981
@dbus.service.signal(_interface)
1106
1982
def GotSecret(self):
1109
1985
server to mandos-client
1110
1986
"""
1111
1987
pass
1112
1988
1113
1989
# Rejected - signal
1114
1990
@dbus.service.signal(_interface, signature="s")
1115
1991
def Rejected(self, reason):
1116
1992
"D-Bus signal"
1117
1993
pass
1118
1994
1119
1995
# NeedApproval - signal
1120
1996
@dbus.service.signal(_interface, signature="tb")
1121
1997
def NeedApproval(self, timeout, default):
1122
1998
"D-Bus signal"
1123
1999
return self.need_approval()
1124
1125
## Methods
1126
2000
2001
# Methods
2002
1127
2003
# Approve - method
1128
2004
@dbus.service.method(_interface, in_signature="b")
1129
2005
def Approve(self, value):
1130
2006
self.approve(value)
1131
2007
1132
2008
# CheckedOK - method
1133
2009
@dbus.service.method(_interface)
1134
2010
def CheckedOK(self):
1135
2011
self.checked_ok()
1136
2012
1137
2013
# Enable - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1138
2015
@dbus.service.method(_interface)
1139
2016
def Enable(self):
1140
2017
"D-Bus method"
1141
2018
self.enable()
1142
2019
1143
2020
# StartChecker - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1144
2022
@dbus.service.method(_interface)
1145
2023
def StartChecker(self):
1146
2024
"D-Bus method"
1147
2025
self.start_checker()
1148
2026
1149
2027
# Disable - method
2028
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1150
2029
@dbus.service.method(_interface)
1151
2030
def Disable(self):
1152
2031
"D-Bus method"
1153
2032
self.disable()
1154
2033
1155
2034
# StopChecker - method
2035
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1156
2036
@dbus.service.method(_interface)
1157
2037
def StopChecker(self):
1158
2038
self.stop_checker()
1159
1160
## Properties
1161
2039
2040
# Properties
2041
1162
2042
# ApprovalPending - property
1163
2043
@dbus_service_property(_interface, signature="b", access="read")
1164
2044
def ApprovalPending_dbus_property(self):
1165
2045
return dbus.Boolean(bool(self.approvals_pending))
1166
2046
1167
2047
# ApprovedByDefault - property
1168
@dbus_service_property(_interface, signature="b",
2048
@dbus_service_property(_interface,
2049
signature="b",
1169
2050
access="readwrite")
1170
2051
def ApprovedByDefault_dbus_property(self, value=None):
1171
2052
if value is None: # get
1172
2053
return dbus.Boolean(self.approved_by_default)
1173
2054
self.approved_by_default = bool(value)
1174
2055
1175
2056
# ApprovalDelay - property
1176
@dbus_service_property(_interface, signature="t",
2057
@dbus_service_property(_interface,
2058
signature="t",
1177
2059
access="readwrite")
1178
2060
def ApprovalDelay_dbus_property(self, value=None):
1179
2061
if value is None: # get
1180
return dbus.UInt64(self.approval_delay_milliseconds())
2062
return dbus.UInt64(self.approval_delay.total_seconds()
2063
* 1000)
1181
2064
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1182
2065
1183
2066
# ApprovalDuration - property
1184
@dbus_service_property(_interface, signature="t",
2067
@dbus_service_property(_interface,
2068
signature="t",
1185
2069
access="readwrite")
1186
2070
def ApprovalDuration_dbus_property(self, value=None):
1187
2071
if value is None: # get
1188
return dbus.UInt64(_timedelta_to_milliseconds(
1189
self.approval_duration))
2072
return dbus.UInt64(self.approval_duration.total_seconds()
2073
* 1000)
1190
2074
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1191
2075
1192
2076
# Name - property
2077
@dbus_annotations(
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1193
2079
@dbus_service_property(_interface, signature="s", access="read")
1194
2080
def Name_dbus_property(self):
1195
2081
return dbus.String(self.name)
1196
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
1197
2090
# Fingerprint - property
2091
@dbus_annotations(
2092
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1198
2093
@dbus_service_property(_interface, signature="s", access="read")
1199
2094
def Fingerprint_dbus_property(self):
1200
2095
return dbus.String(self.fingerprint)
1201
2096
1202
2097
# Host - property
1203
@dbus_service_property(_interface, signature="s",
2098
@dbus_service_property(_interface,
2099
signature="s",
1204
2100
access="readwrite")
1205
2101
def Host_dbus_property(self, value=None):
1206
2102
if value is None: # get
1207
2103
return dbus.String(self.host)
1208
self.host = value
1209
2104
self.host = str(value)
2105
1210
2106
# Created - property
2107
@dbus_annotations(
2108
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1211
2109
@dbus_service_property(_interface, signature="s", access="read")
1212
2110
def Created_dbus_property(self):
1213
return dbus.String(datetime_to_dbus(self.created))
1214
2111
return datetime_to_dbus(self.created)
2112
1215
2113
# LastEnabled - property
1216
2114
@dbus_service_property(_interface, signature="s", access="read")
1217
2115
def LastEnabled_dbus_property(self):
1218
2116
return datetime_to_dbus(self.last_enabled)
1219
2117
1220
2118
# Enabled - property
1221
@dbus_service_property(_interface, signature="b",
2119
@dbus_service_property(_interface,
2120
signature="b",
1222
2121
access="readwrite")
1223
2122
def Enabled_dbus_property(self, value=None):
1224
2123
if value is None: # get
1227
2126
self.enable()
1228
2127
else:
1229
2128
self.disable()
1230
2129
1231
2130
# LastCheckedOK - property
1232
@dbus_service_property(_interface, signature="s",
2131
@dbus_service_property(_interface,
2132
signature="s",
1233
2133
access="readwrite")
1234
2134
def LastCheckedOK_dbus_property(self, value=None):
1235
2135
if value is not None:
1236
2136
self.checked_ok()
1237
2137
return
1238
2138
return datetime_to_dbus(self.last_checked_ok)
1239
2139
2140
# LastCheckerStatus - property
2141
@dbus_service_property(_interface, signature="n", access="read")
2142
def LastCheckerStatus_dbus_property(self):
2143
return dbus.Int16(self.last_checker_status)
2144
1240
2145
# Expires - property
1241
2146
@dbus_service_property(_interface, signature="s", access="read")
1242
2147
def Expires_dbus_property(self):
1243
2148
return datetime_to_dbus(self.expires)
1244
2149
1245
2150
# LastApprovalRequest - property
1246
2151
@dbus_service_property(_interface, signature="s", access="read")
1247
2152
def LastApprovalRequest_dbus_property(self):
1248
2153
return datetime_to_dbus(self.last_approval_request)
1249
2154
1250
2155
# Timeout - property
1251
@dbus_service_property(_interface, signature="t",
2156
@dbus_service_property(_interface,
2157
signature="t",
1252
2158
access="readwrite")
1253
2159
def Timeout_dbus_property(self, value=None):
1254
2160
if value is None: # get
1255
return dbus.UInt64(self.timeout_milliseconds())
2161
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2162
old_timeout = self.timeout
1256
2163
self.timeout = datetime.timedelta(0, 0, 0, value)
1257
if getattr(self, "disable_initiator_tag", None) is None:
1258
return
1259
# Reschedule timeout
1260
gobject.source_remove(self.disable_initiator_tag)
1261
self.disable_initiator_tag = None
1262
self.expires = None
1263
time_to_die = _timedelta_to_milliseconds((self
1264
.last_checked_ok
1265
+ self.timeout)
1266
- datetime.datetime
1267
.utcnow())
1268
if time_to_die <= 0:
1269
# The timeout has passed
1270
self.disable()
1271
else:
1272
self.expires = (datetime.datetime.utcnow()
1273
+ datetime.timedelta(milliseconds =
1274
time_to_die))
1275
self.disable_initiator_tag = (gobject.timeout_add
1276
(time_to_die, self.disable))
1277
2164
# Reschedule disabling
2165
if self.enabled:
2166
now = datetime.datetime.utcnow()
2167
self.expires += self.timeout - old_timeout
2168
if self.expires <= now:
2169
# The timeout has passed
2170
self.disable()
2171
else:
2172
if (getattr(self, "disable_initiator_tag", None)
2173
is None):
2174
return
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
1278
2180
# ExtendedTimeout - property
1279
@dbus_service_property(_interface, signature="t",
2181
@dbus_service_property(_interface,
2182
signature="t",
1280
2183
access="readwrite")
1281
2184
def ExtendedTimeout_dbus_property(self, value=None):
1282
2185
if value is None: # get
1283
return dbus.UInt64(self.extended_timeout_milliseconds())
2186
return dbus.UInt64(self.extended_timeout.total_seconds()
2187
* 1000)
1284
2188
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1285
2189
1286
2190
# Interval - property
1287
@dbus_service_property(_interface, signature="t",
2191
@dbus_service_property(_interface,
2192
signature="t",
1288
2193
access="readwrite")
1289
2194
def Interval_dbus_property(self, value=None):
1290
2195
if value is None: # get
1291
return dbus.UInt64(self.interval_milliseconds())
2196
return dbus.UInt64(self.interval.total_seconds() * 1000)
1292
2197
self.interval = datetime.timedelta(0, 0, 0, value)
1293
2198
if getattr(self, "checker_initiator_tag", None) is None:
1294
2199
return
1295
# Reschedule checker run
1296
gobject.source_remove(self.checker_initiator_tag)
1297
self.checker_initiator_tag = (gobject.timeout_add
1298
(value, self.start_checker))
1299
self.start_checker() # Start one now, too
1300
2200
if self.enabled:
2201
# Reschedule checker run
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
1301
2207
# Checker - property
1302
@dbus_service_property(_interface, signature="s",
2208
@dbus_service_property(_interface,
2209
signature="s",
1303
2210
access="readwrite")
1304
2211
def Checker_dbus_property(self, value=None):
1305
2212
if value is None: # get
1306
2213
return dbus.String(self.checker_command)
1307
self.checker_command = value
1308
2214
self.checker_command = str(value)
2215
1309
2216
# CheckerRunning - property
1310
@dbus_service_property(_interface, signature="b",
2217
@dbus_service_property(_interface,
2218
signature="b",
1311
2219
access="readwrite")
1312
2220
def CheckerRunning_dbus_property(self, value=None):
1313
2221
if value is None: # get
1316
2224
self.start_checker()
1317
2225
else:
1318
2226
self.stop_checker()
1319
2227
1320
2228
# ObjectPath - property
2229
@dbus_annotations(
2230
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2231
"org.freedesktop.DBus.Deprecated": "true"})
1321
2232
@dbus_service_property(_interface, signature="o", access="read")
1322
2233
def ObjectPath_dbus_property(self):
1323
return self.dbus_object_path # is already a dbus.ObjectPath
1324
2234
return self.dbus_object_path # is already a dbus.ObjectPath
2235
1325
2236
# Secret = property
1326
@dbus_service_property(_interface, signature="ay",
1327
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)
1328
2244
def Secret_dbus_property(self, value):
1329
self.secret = str(value)
1330
2245
self.secret = bytes(value)
2246
1331
2247
del _interface
1332
2248
1333
2249
1334
class ProxyClient(object):
1335
def __init__(self, child_pipe, fpr, address):
2250
class ProxyClient:
2251
def __init__(self, child_pipe, key_id, fpr, address):
1336
2252
self._pipe = child_pipe
1337
self._pipe.send(('init', fpr, address))
2253
self._pipe.send(('init', key_id, fpr, address))
1338
2254
if not self._pipe.recv():
1339
raise KeyError()
1340
2255
raise KeyError(key_id or fpr)
2256
1341
2257
def __getattribute__(self, name):
1342
if(name == '_pipe'):
2258
if name == '_pipe':
1343
2259
return super(ProxyClient, self).__getattribute__(name)
1344
2260
self._pipe.send(('getattr', name))
1345
2261
data = self._pipe.recv()
1346
2262
if data[0] == 'data':
1347
2263
return data[1]
1348
2264
if data[0] == 'function':
2265
1349
2266
def func(*args, **kwargs):
1350
2267
self._pipe.send(('funcall', name, args, kwargs))
1351
2268
return self._pipe.recv()[1]
2269
1352
2270
return func
1353
2271
1354
2272
def __setattr__(self, name, value):
1355
if(name == '_pipe'):
2273
if name == '_pipe':
1356
2274
return super(ProxyClient, self).__setattr__(name, value)
1357
2275
self._pipe.send(('setattr', name, value))
1358
2276
1359
class ClientDBusTransitional(ClientDBus):
1360
__metaclass__ = AlternateDBusNamesMetaclass
1361
2277
1362
2278
class ClientHandler(socketserver.BaseRequestHandler, object):
1363
2279
"""A class to handle client connections.
1364
2280
1365
2281
Instantiated once for each connection to handle it.
1366
2282
Note: This will run in its own forked process."""
1367
2283
1368
2284
def handle(self):
1369
2285
with contextlib.closing(self.server.child_pipe) as child_pipe:
1370
2286
logger.info("TCP connection from: %s",
1371
unicode(self.client_address))
2287
str(self.client_address))
1372
2288
logger.debug("Pipe FD: %d",
1373
2289
self.server.child_pipe.fileno())
1374
1375
session = (gnutls.connection
1376
.ClientSession(self.request,
1377
gnutls.connection
1378
.X509Credentials()))
1379
1380
# Note: gnutls.connection.X509Credentials is really a
1381
# generic GnuTLS certificate credentials object so long as
1382
# no X.509 keys are added to it. Therefore, we can use it
1383
# here despite using OpenPGP certificates.
1384
1385
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1386
# "+AES-256-CBC", "+SHA1",
1387
# "+COMP-NULL", "+CTYPE-OPENPGP",
1388
# "+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"))
1389
2297
# Use a fallback default, since this MUST be set.
1390
2298
priority = self.server.gnutls_priority
1391
2299
if priority is None:
1392
2300
priority = "NORMAL"
1393
(gnutls.library.functions
1394
.gnutls_priority_set_direct(session._c_object,
1395
priority, None))
1396
2301
gnutls.priority_set_direct(session._c_object,
2302
priority.encode("utf-8"),
2303
None)
2304
1397
2305
# Start communication using the Mandos protocol
1398
2306
# Get protocol number
1399
2307
line = self.request.makefile().readline()
1400
2308
logger.debug("Protocol version: %r", line)
1401
2309
try:
1402
2310
if int(line.strip().split()[0]) > 1:
1403
raise RuntimeError
2311
raise RuntimeError(line)
1404
2312
except (ValueError, IndexError, RuntimeError) as error:
1405
2313
logger.error("Unknown protocol version: %s", error)
1406
2314
return
1407
2315
1408
2316
# Start GnuTLS connection
1409
2317
try:
1410
2318
session.handshake()
1411
except gnutls.errors.GNUTLSError as error:
2319
except gnutls.Error as error:
1412
2320
logger.warning("Handshake failed: %s", error)
1413
2321
# Do not run session.bye() here: the session is not
1414
2322
# established. Just abandon the request.
1415
2323
return
1416
2324
logger.debug("Handshake succeeded")
1417
2325
1418
2326
approval_required = False
1419
2327
try:
1420
try:
1421
fpr = self.fingerprint(self.peer_certificate
1422
(session))
1423
except (TypeError,
1424
gnutls.errors.GNUTLSError) as error:
1425
logger.warning("Bad certificate: %s", error)
1426
return
1427
logger.debug("Fingerprint: %s", fpr)
1428
1429
try:
1430
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,
1431
2350
self.client_address)
1432
2351
except KeyError:
1433
2352
return
1434
2353
1435
2354
if client.approval_delay:
1436
2355
delay = client.approval_delay
1437
2356
client.approvals_pending += 1
1438
2357
approval_required = True
1439
2358
1440
2359
while True:
1441
2360
if not client.enabled:
1442
2361
logger.info("Client %s is disabled",
1443
client.name)
2362
client.name)
1444
2363
if self.server.use_dbus:
1445
2364
# Emit D-Bus signal
1446
2365
client.Rejected("Disabled")
1447
2366
return
1448
1449
if client._approved or not client.approval_delay:
1450
#We are approved or approval is disabled
2367
2368
if client.approved or not client.approval_delay:
2369
# We are approved or approval is disabled
1451
2370
break
1452
elif client._approved is None:
2371
elif client.approved is None:
1453
2372
logger.info("Client %s needs approval",
1454
2373
client.name)
1455
2374
if self.server.use_dbus:
1456
2375
# Emit D-Bus signal
1457
2376
client.NeedApproval(
1458
client.approval_delay_milliseconds(),
1459
client.approved_by_default)
2377
client.approval_delay.total_seconds()
2378
* 1000, client.approved_by_default)
1460
2379
else:
1461
2380
logger.warning("Client %s was not approved",
1462
2381
client.name)
1464
2383
# Emit D-Bus signal
1465
2384
client.Rejected("Denied")
1466
2385
return
1467
1468
#wait until timeout or approved
2386
2387
# wait until timeout or approved
1469
2388
time = datetime.datetime.now()
1470
2389
client.changedstate.acquire()
1471
(client.changedstate.wait
1472
(float(client._timedelta_to_milliseconds(delay)
1473
/ 1000)))
2390
client.changedstate.wait(delay.total_seconds())
1474
2391
client.changedstate.release()
1475
2392
time2 = datetime.datetime.now()
1476
2393
if (time2 - time) >= delay:
1486
2403
break
1487
2404
else:
1488
2405
delay -= time2 - time
1489
1490
sent_size = 0
1491
while sent_size < len(client.secret):
1492
try:
1493
sent = session.send(client.secret[sent_size:])
1494
except gnutls.errors.GNUTLSError as error:
1495
logger.warning("gnutls send failed")
1496
return
1497
logger.debug("Sent: %d, remaining: %d",
1498
sent, len(client.secret)
1499
- (sent_size + sent))
1500
sent_size += sent
1501
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
1502
2414
logger.info("Sending secret to %s", client.name)
1503
2415
# bump the timeout using extended_timeout
1504
client.checked_ok(client.extended_timeout)
2416
client.bump_timeout(client.extended_timeout)
1505
2417
if self.server.use_dbus:
1506
2418
# Emit D-Bus signal
1507
2419
client.GotSecret()
1508
2420
1509
2421
finally:
1510
2422
if approval_required:
1511
2423
client.approvals_pending -= 1
1512
2424
try:
1513
2425
session.bye()
1514
except gnutls.errors.GNUTLSError as error:
1515
logger.warning("GnuTLS bye failed")
1516
2426
except gnutls.Error as error:
2427
logger.warning("GnuTLS bye failed",
2428
exc_info=error)
2429
1517
2430
@staticmethod
1518
2431
def peer_certificate(session):
1519
"Return the peer's OpenPGP certificate as a bytestring"
1520
# If not an OpenPGP certificate...
1521
if (gnutls.library.functions
1522
.gnutls_certificate_type_get(session._c_object)
1523
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1524
# ...do the normal thing
1525
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""
1526
2448
list_size = ctypes.c_uint(1)
1527
cert_list = (gnutls.library.functions
1528
.gnutls_certificate_get_peers
2449
cert_list = (gnutls.certificate_get_peers
1529
2450
(session._c_object, ctypes.byref(list_size)))
1530
2451
if not bool(cert_list) and list_size.value != 0:
1531
raise gnutls.errors.GNUTLSError("error getting peer"
1532
" certificate")
2452
raise gnutls.Error("error getting peer certificate")
1533
2453
if list_size.value == 0:
1534
2454
return None
1535
2455
cert = cert_list[0]
1536
2456
return ctypes.string_at(cert.data, cert.size)
1537
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
1538
2493
@staticmethod
1539
2494
def fingerprint(openpgp):
1540
2495
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1541
2496
# New GnuTLS "datum" with the OpenPGP public key
1542
datum = (gnutls.library.types
1543
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1544
ctypes.POINTER
1545
(ctypes.c_ubyte)),
1546
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)))
1547
2501
# New empty GnuTLS certificate
1548
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1549
(gnutls.library.functions
1550
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2502
crt = gnutls.openpgp_crt_t()
2503
gnutls.openpgp_crt_init(ctypes.byref(crt))
1551
2504
# Import the OpenPGP public key into the certificate
1552
(gnutls.library.functions
1553
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1554
gnutls.library.constants
1555
.GNUTLS_OPENPGP_FMT_RAW))
2505
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2506
gnutls.OPENPGP_FMT_RAW)
1556
2507
# Verify the self signature in the key
1557
2508
crtverify = ctypes.c_uint()
1558
(gnutls.library.functions
1559
.gnutls_openpgp_crt_verify_self(crt, 0,
1560
ctypes.byref(crtverify)))
2509
gnutls.openpgp_crt_verify_self(crt, 0,
2510
ctypes.byref(crtverify))
1561
2511
if crtverify.value != 0:
1562
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1563
raise (gnutls.errors.CertificateSecurityError
1564
("Verify failed"))
2512
gnutls.openpgp_crt_deinit(crt)
2513
raise gnutls.CertificateSecurityError(code
2514
=crtverify.value)
1565
2515
# New buffer for the fingerprint
1566
2516
buf = ctypes.create_string_buffer(20)
1567
2517
buf_len = ctypes.c_size_t()
1568
2518
# Get the fingerprint from the certificate into the buffer
1569
(gnutls.library.functions
1570
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1571
ctypes.byref(buf_len)))
2519
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2520
ctypes.byref(buf_len))
1572
2521
# Deinit the certificate
1573
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2522
gnutls.openpgp_crt_deinit(crt)
1574
2523
# Convert the buffer to a Python bytestring
1575
2524
fpr = ctypes.string_at(buf, buf_len.value)
1576
2525
# Convert the bytestring to hexadecimal notation
1577
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2526
hex_fpr = binascii.hexlify(fpr).upper()
1578
2527
return hex_fpr
1579
2528
1580
2529
1581
class MultiprocessingMixIn(object):
2530
class MultiprocessingMixIn:
1582
2531
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2532
1583
2533
def sub_process_main(self, request, address):
1584
2534
try:
1585
2535
self.finish_request(request, address)
1586
except:
2536
except Exception:
1587
2537
self.handle_error(request, address)
1588
2538
self.close_request(request)
1589
2539
1590
2540
def process_request(self, request, address):
1591
2541
"""Start a new process to process the request."""
1592
proc = multiprocessing.Process(target = self.sub_process_main,
1593
args = (request,
1594
address))
2542
proc = multiprocessing.Process(target=self.sub_process_main,
2543
args=(request, address))
1595
2544
proc.start()
1596
2545
return proc
1597
2546
1598
2547
1599
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2548
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1600
2549
""" adds a pipe to the MixIn """
2550
1601
2551
def process_request(self, request, client_address):
1602
2552
"""Overrides and wraps the original process_request().
1603
2553
1604
2554
This function creates a new pipe in self.pipe
1605
2555
"""
1606
2556
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1607
2557
1608
2558
proc = MultiprocessingMixIn.process_request(self, request,
1609
2559
client_address)
1610
2560
self.child_pipe.close()
1611
2561
self.add_pipe(parent_pipe, proc)
1612
2562
1613
2563
def add_pipe(self, parent_pipe, proc):
1614
2564
"""Dummy function; override as necessary"""
1615
raise NotImplementedError
2565
raise NotImplementedError()
1616
2566
1617
2567
1618
2568
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1619
socketserver.TCPServer, object):
2569
socketserver.TCPServer):
1620
2570
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1621
2571
1622
2572
Attributes:
1623
2573
enabled: Boolean; whether this server is activated yet
1624
2574
interface: None or a network interface name (string)
1625
2575
use_ipv6: Boolean; to use IPv6 or not
1626
2576
"""
2577
1627
2578
def __init__(self, server_address, RequestHandlerClass,
1628
interface=None, use_ipv6=True):
2579
interface=None,
2580
use_ipv6=True,
2581
socketfd=None):
2582
"""If socketfd is set, use that file descriptor instead of
2583
creating a new one with socket.socket().
2584
"""
1629
2585
self.interface = interface
1630
2586
if use_ipv6:
1631
2587
self.address_family = socket.AF_INET6
2588
if socketfd is not None:
2589
# Save the file descriptor
2590
self.socketfd = socketfd
2591
# Save the original socket.socket() function
2592
self.socket_socket = socket.socket
2593
2594
# To implement --socket, we monkey patch socket.socket.
2595
#
2596
# (When socketserver.TCPServer is a new-style class, we
2597
# could make self.socket into a property instead of monkey
2598
# patching socket.socket.)
2599
#
2600
# Create a one-time-only replacement for socket.socket()
2601
@functools.wraps(socket.socket)
2602
def socket_wrapper(*args, **kwargs):
2603
# Restore original function so subsequent calls are
2604
# not affected.
2605
socket.socket = self.socket_socket
2606
del self.socket_socket
2607
# This time only, return a new socket object from the
2608
# saved file descriptor.
2609
return socket.fromfd(self.socketfd, *args, **kwargs)
2610
# Replace socket.socket() function with wrapper
2611
socket.socket = socket_wrapper
2612
# The socketserver.TCPServer.__init__ will call
2613
# socket.socket(), which might be our replacement,
2614
# socket_wrapper(), if socketfd was set.
1632
2615
socketserver.TCPServer.__init__(self, server_address,
1633
2616
RequestHandlerClass)
2617
1634
2618
def server_bind(self):
1635
2619
"""This overrides the normal server_bind() function
1636
2620
to bind to an interface if one was specified, and also NOT to
1637
2621
bind to an address or port if they were not specified."""
2622
global SO_BINDTODEVICE
1638
2623
if self.interface is not None:
1639
2624
if SO_BINDTODEVICE is None:
1640
logger.error("SO_BINDTODEVICE does not exist;"
1641
" cannot bind to interface %s",
1642
self.interface)
1643
else:
1644
try:
1645
self.socket.setsockopt(socket.SOL_SOCKET,
1646
SO_BINDTODEVICE,
1647
str(self.interface
1648
+ '\0'))
1649
except socket.error as error:
1650
if error[0] == errno.EPERM:
1651
logger.error("No permission to"
1652
" bind to interface %s",
1653
self.interface)
1654
elif error[0] == errno.ENOPROTOOPT:
1655
logger.error("SO_BINDTODEVICE not available;"
1656
" cannot bind to interface %s",
1657
self.interface)
1658
else:
1659
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
1660
2646
# Only bind(2) the socket if we really need to.
1661
2647
if self.server_address[0] or self.server_address[1]:
2648
if self.server_address[1]:
2649
self.allow_reuse_address = True
1662
2650
if not self.server_address[0]:
1663
2651
if self.address_family == socket.AF_INET6:
1664
any_address = "::" # in6addr_any
2652
any_address = "::" # in6addr_any
1665
2653
else:
1666
any_address = socket.INADDR_ANY
2654
any_address = "0.0.0.0" # INADDR_ANY
1667
2655
self.server_address = (any_address,
1668
2656
self.server_address[1])
1669
2657
elif not self.server_address[1]:
1670
self.server_address = (self.server_address[0],
1671
0)
2658
self.server_address = (self.server_address[0], 0)
1672
2659
# if self.interface:
1673
2660
# self.server_address = (self.server_address[0],
1674
2661
# 0, # port
1680
2667
1681
2668
class MandosServer(IPv6_TCPServer):
1682
2669
"""Mandos server.
1683
2670
1684
2671
Attributes:
1685
2672
clients: set of Client objects
1686
2673
gnutls_priority GnuTLS priority string
1687
2674
use_dbus: Boolean; to emit D-Bus signals or not
1688
1689
Assumes a gobject.MainLoop event loop.
2675
2676
Assumes a GLib.MainLoop event loop.
1690
2677
"""
2678
1691
2679
def __init__(self, server_address, RequestHandlerClass,
1692
interface=None, use_ipv6=True, clients=None,
1693
gnutls_priority=None, use_dbus=True):
2680
interface=None,
2681
use_ipv6=True,
2682
clients=None,
2683
gnutls_priority=None,
2684
use_dbus=True,
2685
socketfd=None):
1694
2686
self.enabled = False
1695
2687
self.clients = clients
1696
2688
if self.clients is None:
1699
2691
self.gnutls_priority = gnutls_priority
1700
2692
IPv6_TCPServer.__init__(self, server_address,
1701
2693
RequestHandlerClass,
1702
interface = interface,
1703
use_ipv6 = use_ipv6)
2694
interface=interface,
2695
use_ipv6=use_ipv6,
2696
socketfd=socketfd)
2697
1704
2698
def server_activate(self):
1705
2699
if self.enabled:
1706
2700
return socketserver.TCPServer.server_activate(self)
1707
2701
1708
2702
def enable(self):
1709
2703
self.enabled = True
1710
2704
1711
2705
def add_pipe(self, parent_pipe, proc):
1712
2706
# Call "handle_ipc" for both data and EOF events
1713
gobject.io_add_watch(parent_pipe.fileno(),
1714
gobject.IO_IN | gobject.IO_HUP,
1715
functools.partial(self.handle_ipc,
1716
parent_pipe =
1717
parent_pipe,
1718
proc = proc))
1719
1720
def handle_ipc(self, source, condition, parent_pipe=None,
1721
proc = None, client_object=None):
1722
condition_names = {
1723
gobject.IO_IN: "IN", # There is data to read.
1724
gobject.IO_OUT: "OUT", # Data can be written (without
1725
# blocking).
1726
gobject.IO_PRI: "PRI", # There is urgent data to read.
1727
gobject.IO_ERR: "ERR", # Error condition.
1728
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1729
# broken, usually for pipes and
1730
# sockets).
1731
}
1732
conditions_string = ' | '.join(name
1733
for cond, name in
1734
condition_names.iteritems()
1735
if cond & condition)
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):
1736
2718
# error, or the other end of multiprocessing.Pipe has closed
1737
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2719
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1738
2720
# Wait for other process to exit
1739
2721
proc.join()
1740
2722
return False
1741
2723
1742
2724
# Read a request from the child
1743
2725
request = parent_pipe.recv()
1744
2726
command = request[0]
1745
2727
1746
2728
if command == 'init':
1747
fpr = request[1]
1748
address = request[2]
1749
1750
for c in self.clients.itervalues():
1751
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:
1752
2741
client = c
1753
2742
break
1754
2743
else:
1755
logger.info("Client not found for fingerprint: %s, ad"
1756
"dress: %s", fpr, address)
2744
logger.info("Client not found for key ID: %s, address"
2745
": %s", key_id or fpr, address)
1757
2746
if self.use_dbus:
1758
2747
# Emit D-Bus signal
1759
mandos_dbus_service.ClientNotFound(fpr,
2748
mandos_dbus_service.ClientNotFound(key_id or fpr,
1760
2749
address[0])
1761
2750
parent_pipe.send(False)
1762
2751
return False
1763
1764
gobject.io_add_watch(parent_pipe.fileno(),
1765
gobject.IO_IN | gobject.IO_HUP,
1766
functools.partial(self.handle_ipc,
1767
parent_pipe =
1768
parent_pipe,
1769
proc = proc,
1770
client_object =
1771
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))
1772
2760
parent_pipe.send(True)
1773
2761
# remove the old hook in favor of the new above hook on
1774
2762
# same fileno
1777
2765
funcname = request[1]
1778
2766
args = request[2]
1779
2767
kwargs = request[3]
1780
2768
1781
2769
parent_pipe.send(('data', getattr(client_object,
1782
2770
funcname)(*args,
1783
**kwargs)))
1784
2771
**kwargs)))
2772
1785
2773
if command == 'getattr':
1786
2774
attrname = request[1]
1787
if callable(client_object.__getattribute__(attrname)):
1788
parent_pipe.send(('function',))
2775
if isinstance(client_object.__getattribute__(attrname),
2776
collections.abc.Callable):
2777
parent_pipe.send(('function', ))
1789
2778
else:
1790
parent_pipe.send(('data', client_object
1791
.__getattribute__(attrname)))
1792
2779
parent_pipe.send((
2780
'data', client_object.__getattribute__(attrname)))
2781
1793
2782
if command == 'setattr':
1794
2783
attrname = request[1]
1795
2784
value = request[2]
1796
2785
setattr(client_object, attrname, value)
1797
2786
1798
2787
return True
1799
2788
1800
2789
2790
def rfc3339_duration_to_delta(duration):
2791
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
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
2809
"""
2810
2811
# Parsing an RFC 3339 duration with regular expressions is not
2812
# possible - there would have to be multiple places for the same
2813
# values, like seconds. The current code, while more esoteric, is
2814
# cleaner without depending on a parsing library. If Python had a
2815
# built-in library for parsing we would use it, but we'd like to
2816
# avoid excessive use of external libraries.
2817
2818
# New type for defining tokens, syntax, and semantics all-in-one
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
2824
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2825
# the "duration" ABNF definition in RFC 3339, Appendix A.
2826
token_end = Token(re.compile(r"$"), None, frozenset())
2827
token_second = Token(re.compile(r"(\d+)S"),
2828
datetime.timedelta(seconds=1),
2829
frozenset((token_end, )))
2830
token_minute = Token(re.compile(r"(\d+)M"),
2831
datetime.timedelta(minutes=1),
2832
frozenset((token_second, token_end)))
2833
token_hour = Token(re.compile(r"(\d+)H"),
2834
datetime.timedelta(hours=1),
2835
frozenset((token_minute, token_end)))
2836
token_time = Token(re.compile(r"T"),
2837
None,
2838
frozenset((token_hour, token_minute,
2839
token_second)))
2840
token_day = Token(re.compile(r"(\d+)D"),
2841
datetime.timedelta(days=1),
2842
frozenset((token_time, token_end)))
2843
token_month = Token(re.compile(r"(\d+)M"),
2844
datetime.timedelta(weeks=4),
2845
frozenset((token_day, token_end)))
2846
token_year = Token(re.compile(r"(\d+)Y"),
2847
datetime.timedelta(weeks=52),
2848
frozenset((token_month, token_end)))
2849
token_week = Token(re.compile(r"(\d+)W"),
2850
datetime.timedelta(weeks=1),
2851
frozenset((token_end, )))
2852
token_duration = Token(re.compile(r"P"), None,
2853
frozenset((token_year, token_month,
2854
token_day, token_time,
2855
token_week)))
2856
# Define starting values:
2857
# Value so far
2858
value = datetime.timedelta()
2859
found_token = None
2860
# Following valid tokens
2861
followers = frozenset((token_duration, ))
2862
# String left to parse
2863
s = duration
2864
# Loop until end token is found
2865
while found_token is not token_end:
2866
# Search for any currently valid tokens
2867
for token in followers:
2868
match = token.regexp.match(s)
2869
if match is not None:
2870
# Token found
2871
if token.value is not None:
2872
# Value found, parse digits
2873
factor = int(match.group(1), 10)
2874
# Add to value so far
2875
value += factor * token.value
2876
# Strip token from string
2877
s = token.regexp.sub("", s, 1)
2878
# Go to found token
2879
found_token = token
2880
# Set valid next tokens
2881
followers = found_token.followers
2882
break
2883
else:
2884
# No currently valid tokens were found
2885
raise ValueError("Invalid RFC 3339 duration: {!r}"
2886
.format(duration))
2887
# End token found
2888
return value
2889
2890
1801
2891
def string_to_delta(interval):
1802
2892
"""Parse a string and return a datetime.timedelta
1803
1804
>>> string_to_delta('7d')
1805
datetime.timedelta(7)
1806
>>> string_to_delta('60s')
1807
datetime.timedelta(0, 60)
1808
>>> string_to_delta('60m')
1809
datetime.timedelta(0, 3600)
1810
>>> string_to_delta('24h')
1811
datetime.timedelta(1)
1812
>>> string_to_delta('1w')
1813
datetime.timedelta(7)
1814
>>> string_to_delta('5m 30s')
1815
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
1816
2906
"""
2907
2908
try:
2909
return rfc3339_duration_to_delta(interval)
2910
except ValueError:
2911
pass
2912
1817
2913
timevalue = datetime.timedelta(0)
1818
2914
for s in interval.split():
1819
2915
try:
1820
suffix = unicode(s[-1])
2916
suffix = s[-1]
1821
2917
value = int(s[:-1])
1822
2918
if suffix == "d":
1823
2919
delta = datetime.timedelta(value)
1830
2926
elif suffix == "w":
1831
2927
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1832
2928
else:
1833
raise ValueError("Unknown suffix %r" % suffix)
1834
except (ValueError, IndexError) as e:
2929
raise ValueError("Unknown suffix {!r}".format(suffix))
2930
except IndexError as e:
1835
2931
raise ValueError(*(e.args))
1836
2932
timevalue += delta
1837
2933
return timevalue
1838
2934
1839
2935
1840
def if_nametoindex(interface):
1841
"""Call the C function if_nametoindex(), or equivalent
1842
1843
Note: This function cannot accept a unicode string."""
1844
global if_nametoindex
1845
try:
1846
if_nametoindex = (ctypes.cdll.LoadLibrary
1847
(ctypes.util.find_library("c"))
1848
.if_nametoindex)
1849
except (OSError, AttributeError):
1850
logger.warning("Doing if_nametoindex the hard way")
1851
def if_nametoindex(interface):
1852
"Get an interface index the hard way, i.e. using fcntl()"
1853
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1854
with contextlib.closing(socket.socket()) as s:
1855
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1856
struct.pack(str("16s16x"),
1857
interface))
1858
interface_index = struct.unpack(str("I"),
1859
ifreq[16:20])[0]
1860
return interface_index
1861
return if_nametoindex(interface)
1862
1863
1864
def daemon(nochdir = False, noclose = False):
2936
def daemon(nochdir=False, noclose=False):
1865
2937
"""See daemon(3). Standard BSD Unix function.
1866
2938
1867
2939
This should really exist as os.daemon, but it doesn't (yet)."""
1868
2940
if os.fork():
1869
2941
sys.exit()
1874
2946
sys.exit()
1875
2947
if not noclose:
1876
2948
# Close all standard open file descriptors
1877
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2949
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1878
2950
if not stat.S_ISCHR(os.fstat(null).st_mode):
1879
2951
raise OSError(errno.ENODEV,
1880
"%s not a character device"
1881
% os.path.devnull)
2952
"{} not a character device"
2953
.format(os.devnull))
1882
2954
os.dup2(null, sys.stdin.fileno())
1883
2955
os.dup2(null, sys.stdout.fileno())
1884
2956
os.dup2(null, sys.stderr.fileno())
1887
2959
1888
2960
1889
2961
def main():
1890
2962
1891
2963
##################################################################
1892
2964
# Parsing of options, both command line and config file
1893
2965
1894
2966
parser = argparse.ArgumentParser()
1895
2967
parser.add_argument("-v", "--version", action="version",
1896
version = "%%(prog)s %s" % version,
2968
version="%(prog)s {}".format(version),
1897
2969
help="show version number and exit")
1898
2970
parser.add_argument("-i", "--interface", metavar="IF",
1899
2971
help="Bind to interface IF")
1905
2977
help="Run self-test")
1906
2978
parser.add_argument("--debug", action="store_true",
1907
2979
help="Debug mode; run in foreground and log"
1908
" to terminal")
2980
" to terminal", default=None)
1909
2981
parser.add_argument("--debuglevel", metavar="LEVEL",
1910
2982
help="Debug level for stdout output")
1911
2983
parser.add_argument("--priority", help="GnuTLS"
1918
2990
" files")
1919
2991
parser.add_argument("--no-dbus", action="store_false",
1920
2992
dest="use_dbus", help="Do not provide D-Bus"
1921
" system bus interface")
2993
" system bus interface", default=None)
1922
2994
parser.add_argument("--no-ipv6", action="store_false",
1923
dest="use_ipv6", help="Do not use IPv6")
2995
dest="use_ipv6", help="Do not use IPv6",
2996
default=None)
1924
2997
parser.add_argument("--no-restore", action="store_false",
1925
dest="restore", help="Do not restore stored state",
1926
default=True)
2998
dest="restore", help="Do not restore stored"
2999
" state", default=None)
3000
parser.add_argument("--socket", type=int,
3001
help="Specify a file descriptor to a network"
3002
" socket to use instead of creating one")
3003
parser.add_argument("--statedir", metavar="DIR",
3004
help="Directory to save/restore state in")
3005
parser.add_argument("--foreground", action="store_true",
3006
help="Run in foreground", default=None)
3007
parser.add_argument("--no-zeroconf", action="store_false",
3008
dest="zeroconf", help="Do not use Zeroconf",
3009
default=None)
1927
3010
1928
3011
options = parser.parse_args()
1929
1930
if options.check:
1931
import doctest
1932
doctest.testmod()
1933
sys.exit()
1934
3012
1935
3013
# Default values for config file for server-global settings
1936
server_defaults = { "interface": "",
1937
"address": "",
1938
"port": "",
1939
"debug": "False",
1940
"priority":
1941
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1942
"servicename": "Mandos",
1943
"use_dbus": "True",
1944
"use_ipv6": "True",
1945
"debuglevel": "",
1946
}
1947
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
1948
3037
# Parse config file for server-global settings
1949
server_config = configparser.SafeConfigParser(server_defaults)
3038
server_config = configparser.ConfigParser(server_defaults)
1950
3039
del server_defaults
1951
server_config.read(os.path.join(options.configdir,
1952
"mandos.conf"))
1953
# 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
1954
3042
server_settings = server_config.defaults()
1955
3043
# Use the appropriate methods on the non-string config options
1956
for option in ("debug", "use_dbus", "use_ipv6"):
3044
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3045
"foreground", "zeroconf"):
1957
3046
server_settings[option] = server_config.getboolean("DEFAULT",
1958
3047
option)
1959
3048
if server_settings["port"]:
1960
3049
server_settings["port"] = server_config.getint("DEFAULT",
1961
3050
"port")
3051
if server_settings["socket"]:
3052
server_settings["socket"] = server_config.getint("DEFAULT",
3053
"socket")
3054
# Later, stdin will, and stdout and stderr might, be dup'ed
3055
# over with an opened os.devnull. But we don't want this to
3056
# happen with a supplied network socket.
3057
if 0 <= server_settings["socket"] <= 2:
3058
server_settings["socket"] = os.dup(server_settings
3059
["socket"])
1962
3060
del server_config
1963
3061
1964
3062
# Override the settings from the config file with command line
1965
3063
# options, if set.
1966
3064
for option in ("interface", "address", "port", "debug",
1967
"priority", "servicename", "configdir",
1968
"use_dbus", "use_ipv6", "debuglevel", "restore"):
3065
"priority", "servicename", "configdir", "use_dbus",
3066
"use_ipv6", "debuglevel", "restore", "statedir",
3067
"socket", "foreground", "zeroconf"):
1969
3068
value = getattr(options, option)
1970
3069
if value is not None:
1971
3070
server_settings[option] = value
1972
3071
del options
1973
3072
# Force all strings to be unicode
1974
3073
for option in server_settings.keys():
1975
if type(server_settings[option]) is str:
1976
server_settings[option] = unicode(server_settings[option])
3074
if isinstance(server_settings[option], bytes):
3075
server_settings[option] = (server_settings[option]
3076
.decode("utf-8"))
3077
# Force all boolean options to be boolean
3078
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3079
"foreground", "zeroconf"):
3080
server_settings[option] = bool(server_settings[option])
3081
# Debug implies foreground
3082
if server_settings["debug"]:
3083
server_settings["foreground"] = True
1977
3084
# Now we have our good server settings in "server_settings"
1978
3085
1979
3086
##################################################################
1980
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
1981
3093
# For convenience
1982
3094
debug = server_settings["debug"]
1983
3095
debuglevel = server_settings["debuglevel"]
1984
3096
use_dbus = server_settings["use_dbus"]
1985
3097
use_ipv6 = server_settings["use_ipv6"]
1986
3098
stored_state_path = os.path.join(server_settings["statedir"],
3099
stored_state_file)
3100
foreground = server_settings["foreground"]
3101
zeroconf = server_settings["zeroconf"]
3102
3103
if debug:
3104
initlogger(debug, logging.DEBUG)
3105
else:
3106
if not debuglevel:
3107
initlogger(debug)
3108
else:
3109
level = getattr(logging, debuglevel.upper())
3110
initlogger(debug, level)
3111
1987
3112
if server_settings["servicename"] != "Mandos":
1988
syslogger.setFormatter(logging.Formatter
1989
('Mandos (%s) [%%(process)d]:'
1990
' %%(levelname)s: %%(message)s'
1991
% server_settings["servicename"]))
1992
3113
syslogger.setFormatter(
3114
logging.Formatter('Mandos ({}) [%(process)d]:'
3115
' %(levelname)s: %(message)s'.format(
3116
server_settings["servicename"])))
3117
1993
3118
# Parse config file with clients
1994
client_defaults = { "timeout": "5m",
1995
"extended_timeout": "15m",
1996
"interval": "2m",
1997
"checker": "fping -q -- %%(host)s",
1998
"host": "",
1999
"approval_delay": "0s",
2000
"approval_duration": "1s",
2001
}
2002
client_config = configparser.SafeConfigParser(client_defaults)
3119
client_config = configparser.ConfigParser(Client.client_defaults)
2003
3120
client_config.read(os.path.join(server_settings["configdir"],
2004
3121
"clients.conf"))
2005
3122
2006
3123
global mandos_dbus_service
2007
3124
mandos_dbus_service = None
2008
2009
tcp_server = MandosServer((server_settings["address"],
2010
server_settings["port"]),
2011
ClientHandler,
2012
interface=(server_settings["interface"]
2013
or None),
2014
use_ipv6=use_ipv6,
2015
gnutls_priority=
2016
server_settings["priority"],
2017
use_dbus=use_dbus)
2018
if not debug:
2019
pidfilename = "/var/run/mandos.pid"
2020
try:
2021
pidfile = open(pidfilename, "w")
2022
except IOError:
2023
logger.error("Could not open file %r", pidfilename)
2024
2025
try:
2026
uid = pwd.getpwnam("_mandos").pw_uid
2027
gid = pwd.getpwnam("_mandos").pw_gid
2028
except KeyError:
2029
try:
2030
uid = pwd.getpwnam("mandos").pw_uid
2031
gid = pwd.getpwnam("mandos").pw_gid
3125
3126
socketfd = None
3127
if server_settings["socket"] != "":
3128
socketfd = server_settings["socket"]
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)
3137
if not foreground:
3138
pidfilename = "/run/mandos.pid"
3139
if not os.path.isdir("/run/."):
3140
pidfilename = "/var/run/mandos.pid"
3141
pidfile = None
3142
try:
3143
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3144
except IOError as e:
3145
logger.error("Could not open file %r", pidfilename,
3146
exc_info=e)
3147
3148
for name, group in (("_mandos", "_mandos"),
3149
("mandos", "mandos"),
3150
("nobody", "nogroup")):
3151
try:
3152
uid = pwd.getpwnam(name).pw_uid
3153
gid = pwd.getpwnam(group).pw_gid
3154
break
2032
3155
except KeyError:
2033
try:
2034
uid = pwd.getpwnam("nobody").pw_uid
2035
gid = pwd.getpwnam("nobody").pw_gid
2036
except KeyError:
2037
uid = 65534
2038
gid = 65534
3156
continue
3157
else:
3158
uid = 65534
3159
gid = 65534
2039
3160
try:
2040
3161
os.setgid(gid)
2041
3162
os.setuid(uid)
3163
if debug:
3164
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3165
gid))
2042
3166
except OSError as error:
2043
if error[0] != errno.EPERM:
2044
raise error
2045
2046
if not debug and not debuglevel:
2047
logger.setLevel(logging.WARNING)
2048
if debuglevel:
2049
level = getattr(logging, debuglevel.upper())
2050
logger.setLevel(level)
2051
3167
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3168
.format(uid, gid, os.strerror(error.errno)))
3169
if error.errno != errno.EPERM:
3170
raise
3171
2052
3172
if debug:
2053
logger.setLevel(logging.DEBUG)
2054
3173
# Enable all possible GnuTLS debugging
2055
3174
2056
3175
# "Use a log level over 10 to enable all debugging options."
2057
3176
# - GnuTLS manual
2058
gnutls.library.functions.gnutls_global_set_log_level(11)
2059
2060
@gnutls.library.types.gnutls_log_func
3177
gnutls.global_set_log_level(11)
3178
3179
@gnutls.log_func
2061
3180
def debug_gnutls(level, string):
2062
3181
logger.debug("GnuTLS: %s", string[:-1])
2063
2064
(gnutls.library.functions
2065
.gnutls_global_set_log_function(debug_gnutls))
2066
3182
3183
gnutls.global_set_log_function(debug_gnutls)
3184
2067
3185
# Redirect stdin so all checkers get /dev/null
2068
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3186
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2069
3187
os.dup2(null, sys.stdin.fileno())
2070
3188
if null > 2:
2071
3189
os.close(null)
2072
else:
2073
# No console logging
2074
logger.removeHandler(console)
2075
3190
2076
3191
# Need to fork before connecting to D-Bus
2077
if not debug:
3192
if not foreground:
2078
3193
# Close all input and output, do double fork, etc.
2079
3194
daemon()
2080
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
2081
3201
global main_loop
2082
3202
# From the Avahi example code
2083
DBusGMainLoop(set_as_default=True )
2084
main_loop = gobject.MainLoop()
3203
DBusGMainLoop(set_as_default=True)
3204
main_loop = GLib.MainLoop()
2085
3205
bus = dbus.SystemBus()
2086
3206
# End of Avahi example code
2087
3207
if use_dbus:
2088
3208
try:
2089
3209
bus_name = dbus.service.BusName("se.recompile.Mandos",
2090
bus, do_not_queue=True)
2091
old_bus_name = (dbus.service.BusName
2092
("se.bsnet.fukt.Mandos", bus,
2093
do_not_queue=True))
2094
except dbus.exceptions.NameExistsException as e:
2095
logger.error(unicode(e) + ", disabling D-Bus")
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:
3216
logger.error("Disabling D-Bus:", exc_info=e)
2096
3217
use_dbus = False
2097
3218
server_settings["use_dbus"] = False
2098
3219
tcp_server.use_dbus = False
2099
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2100
service = AvahiServiceToSyslog(name =
2101
server_settings["servicename"],
2102
servicetype = "_mandos._tcp",
2103
protocol = protocol, bus = bus)
2104
if server_settings["interface"]:
2105
service.interface = (if_nametoindex
2106
(str(server_settings["interface"])))
2107
3220
if zeroconf:
3221
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3222
service = AvahiServiceToSyslog(
3223
name=server_settings["servicename"],
3224
servicetype="_mandos._tcp",
3225
protocol=protocol,
3226
bus=bus)
3227
if server_settings["interface"]:
3228
service.interface = if_nametoindex(
3229
server_settings["interface"].encode("utf-8"))
3230
2108
3231
global multiprocessing_manager
2109
3232
multiprocessing_manager = multiprocessing.Manager()
2110
3233
2111
3234
client_class = Client
2112
3235
if use_dbus:
2113
client_class = functools.partial(ClientDBusTransitional,
2114
bus = bus)
2115
2116
special_settings = {
2117
# Some settings need to be accessd by special methods;
2118
# booleans need .getboolean(), etc. Here is a list of them:
2119
"approved_by_default":
2120
lambda section:
2121
client_config.getboolean(section, "approved_by_default"),
2122
}
2123
# Construct a new dict of client settings of this form:
2124
# { client_name: {setting_name: value, ...}, ...}
2125
# with exceptions for any special settings as defined above
2126
client_settings = dict((clientname,
2127
dict((setting,
2128
(value if setting not in special_settings
2129
else special_settings[setting](clientname)))
2130
for setting, value in client_config.items(clientname)))
2131
for clientname in client_config.sections())
2132
3236
client_class = functools.partial(ClientDBus, bus=bus)
3237
3238
client_settings = Client.config_parser(client_config)
2133
3239
old_client_settings = {}
2134
clients_data = []
2135
2136
# Get client data and settings from last running state.
3240
clients_data = {}
3241
3242
# This is used to redirect stdout and stderr for checker processes
3243
global wnull
3244
wnull = open(os.devnull, "w") # A writable /dev/null
3245
# Only used if server is running in foreground but not in debug
3246
# mode
3247
if debug or not foreground:
3248
wnull.close()
3249
3250
# Get client data and settings from last running state.
2137
3251
if server_settings["restore"]:
2138
3252
try:
2139
3253
with open(stored_state_path, "rb") as stored_state:
2140
clients_data, old_client_settings = pickle.load(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"))
2141
3304
os.remove(stored_state_path)
2142
3305
except IOError as e:
2143
logger.warning("Could not load persistant state: {0}".format(e))
2144
if e.errno != errno.ENOENT:
3306
if e.errno == errno.ENOENT:
3307
logger.warning("Could not load persistent state:"
3308
" {}".format(os.strerror(e.errno)))
3309
else:
3310
logger.critical("Could not load persistent state:",
3311
exc_info=e)
2145
3312
raise
2146
2147
for client in clients_data:
2148
client_name = client["name"]
2149
2150
# Decide which value to use after restoring saved state.
2151
# We have three different values: Old config file,
2152
# new config file, and saved state.
2153
# New config value takes precedence if it differs from old
2154
# config value, otherwise use saved state.
2155
for name, value in client_settings[client_name].items():
3313
except EOFError as e:
3314
logger.warning("Could not load persistent state: "
3315
"EOFError:",
3316
exc_info=e)
3317
3318
with PGPEngine() as pgp:
3319
for client_name, client in clients_data.items():
3320
# Skip removed clients
3321
if client_name not in client_settings:
3322
continue
3323
3324
# Decide which value to use after restoring saved state.
3325
# We have three different values: Old config file,
3326
# new config file, and saved state.
3327
# New config value takes precedence if it differs from old
3328
# config value, otherwise use saved state.
3329
for name, value in client_settings[client_name].items():
3330
try:
3331
# For each value in new config, check if it
3332
# differs from the old config value (Except for
3333
# the "secret" attribute)
3334
if (name != "secret"
3335
and (value !=
3336
old_client_settings[client_name][name])):
3337
client[name] = value
3338
except KeyError:
3339
pass
3340
3341
# Clients who has passed its expire date can still be
3342
# enabled if its last checker was successful. A Client
3343
# whose checker succeeded before we stored its state is
3344
# assumed to have successfully run all checkers during
3345
# downtime.
3346
if client["enabled"]:
3347
if datetime.datetime.utcnow() >= client["expires"]:
3348
if not client["last_checked_ok"]:
3349
logger.warning(
3350
"disabling client {} - Client never "
3351
"performed a successful checker".format(
3352
client_name))
3353
client["enabled"] = False
3354
elif client["last_checker_status"] != 0:
3355
logger.warning(
3356
"disabling client {} - Client last"
3357
" checker failed with error code"
3358
" {}".format(
3359
client_name,
3360
client["last_checker_status"]))
3361
client["enabled"] = False
3362
else:
3363
client["expires"] = (
3364
datetime.datetime.utcnow()
3365
+ client["timeout"])
3366
logger.debug("Last checker succeeded,"
3367
" keeping {} enabled".format(
3368
client_name))
2156
3369
try:
2157
# For each value in new config, check if it differs
2158
# from the old config value (Except for the "secret"
2159
# attribute)
2160
if name != "secret" and value != old_client_settings[client_name][name]:
2161
setattr(client, name, value)
2162
except KeyError:
2163
pass
2164
2165
# Clients who has passed its expire date, can still be enabled if its
2166
# last checker was sucessful. Clients who checkers failed before we
2167
# stored it state is asumed to had failed checker during downtime.
2168
if client["enabled"] and client["last_checked_ok"]:
2169
if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2170
> client["interval"]):
2171
if client["last_checker_status"] != 0:
2172
client["enabled"] = False
2173
else:
2174
client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2175
2176
client["changedstate"] = (multiprocessing_manager
2177
.Condition(multiprocessing_manager
2178
.Lock()))
2179
if use_dbus:
2180
new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2181
tcp_server.clients[client_name] = new_client
2182
new_client.bus = bus
2183
for name, value in client.iteritems():
2184
setattr(new_client, name, value)
2185
client_object_name = unicode(client_name).translate(
2186
{ord("."): ord("_"),
2187
ord("-"): ord("_")})
2188
new_client.dbus_object_path = (dbus.ObjectPath
2189
("/clients/" + client_object_name))
2190
DBusObjectWithProperties.__init__(new_client,
2191
new_client.bus,
2192
new_client.dbus_object_path)
2193
else:
2194
tcp_server.clients[client_name] = Client.__new__(Client)
2195
for name, value in client.iteritems():
2196
setattr(tcp_server.clients[client_name], name, value)
2197
2198
tcp_server.clients[client_name].decrypt_secret(
2199
client_settings[client_name]["secret"])
2200
2201
# Create/remove clients based on new changes made to config
2202
for clientname in set(old_client_settings) - set(client_settings):
2203
del tcp_server.clients[clientname]
2204
for clientname in set(client_settings) - set(old_client_settings):
2205
tcp_server.clients[clientname] = (client_class(name = clientname,
2206
config =
2207
client_settings
2208
[clientname]))
2209
3370
client["secret"] = pgp.decrypt(
3371
client["encrypted_secret"],
3372
client_settings[client_name]["secret"])
3373
except PGPError:
3374
# If decryption fails, we use secret from new settings
3375
logger.debug("Failed to decrypt {} old secret".format(
3376
client_name))
3377
client["secret"] = (client_settings[client_name]
3378
["secret"])
3379
3380
# Add/remove clients based on new changes made to config
3381
for client_name in (set(old_client_settings)
3382
- set(client_settings)):
3383
del clients_data[client_name]
3384
for client_name in (set(client_settings)
3385
- set(old_client_settings)):
3386
clients_data[client_name] = client_settings[client_name]
3387
3388
# Create all client objects
3389
for client_name, client in clients_data.items():
3390
tcp_server.clients[client_name] = client_class(
3391
name=client_name,
3392
settings=client,
3393
server_settings=server_settings)
2210
3394
2211
3395
if not tcp_server.clients:
2212
3396
logger.warning("No clients defined")
2213
2214
if not debug:
2215
try:
2216
with pidfile:
2217
pid = os.getpid()
2218
pidfile.write(str(pid) + "\n".encode("utf-8"))
2219
del pidfile
2220
except IOError:
2221
logger.error("Could not write to file %r with PID %d",
2222
pidfilename, pid)
2223
except NameError:
2224
# "pidfile" was never created
2225
pass
3397
3398
if not foreground:
3399
if pidfile is not None:
3400
pid = os.getpid()
3401
try:
3402
with pidfile:
3403
print(pid, file=pidfile)
3404
except IOError:
3405
logger.error("Could not write to file %r with PID %d",
3406
pidfilename, pid)
3407
del pidfile
2226
3408
del pidfilename
2227
2228
signal.signal(signal.SIGINT, signal.SIG_IGN)
2229
2230
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2231
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2232
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
2233
3414
if use_dbus:
2234
class MandosDBusService(dbus.service.Object):
3415
3416
@alternate_dbus_interfaces(
3417
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3418
class MandosDBusService(DBusObjectWithObjectManager):
2235
3419
"""A D-Bus proxy object"""
3420
2236
3421
def __init__(self):
2237
3422
dbus.service.Object.__init__(self, bus, "/")
3423
2238
3424
_interface = "se.recompile.Mandos"
2239
3425
2240
3426
@dbus.service.signal(_interface, signature="o")
2241
3427
def ClientAdded(self, objpath):
2242
3428
"D-Bus signal"
2243
3429
pass
2244
3430
2245
3431
@dbus.service.signal(_interface, signature="ss")
2246
def ClientNotFound(self, fingerprint, address):
3432
def ClientNotFound(self, key_id, address):
2247
3433
"D-Bus signal"
2248
3434
pass
2249
3435
3436
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3437
"true"})
2250
3438
@dbus.service.signal(_interface, signature="os")
2251
3439
def ClientRemoved(self, objpath, name):
2252
3440
"D-Bus signal"
2253
3441
pass
2254
3442
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3444
"true"})
2255
3445
@dbus.service.method(_interface, out_signature="ao")
2256
3446
def GetAllClients(self):
2257
3447
"D-Bus method"
2258
return dbus.Array(c.dbus_object_path
2259
for c in
2260
tcp_server.clients.itervalues())
2261
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"})
2262
3453
@dbus.service.method(_interface,
2263
3454
out_signature="a{oa{sv}}")
2264
3455
def GetAllClientsWithProperties(self):
2265
3456
"D-Bus method"
2266
3457
return dbus.Dictionary(
2267
((c.dbus_object_path, c.GetAll(""))
2268
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()},
2269
3461
signature="oa{sv}")
2270
3462
2271
3463
@dbus.service.method(_interface, in_signature="o")
2272
3464
def RemoveClient(self, object_path):
2273
3465
"D-Bus method"
2274
for c in tcp_server.clients.itervalues():
3466
for c in tcp_server.clients.values():
2275
3467
if c.dbus_object_path == object_path:
2276
3468
del tcp_server.clients[c.name]
2277
3469
c.remove_from_connection()
2278
# Don't signal anything except ClientRemoved
3470
# Don't signal the disabling
2279
3471
c.disable(quiet=True)
2280
# Emit D-Bus signal
2281
self.ClientRemoved(object_path, c.name)
3472
# Emit D-Bus signal for removal
3473
self.client_removed_signal(c)
2282
3474
return
2283
3475
raise KeyError(object_path)
2284
3476
2285
3477
del _interface
2286
2287
class MandosDBusServiceTransitional(MandosDBusService):
2288
__metaclass__ = AlternateDBusNamesMetaclass
2289
mandos_dbus_service = MandosDBusServiceTransitional()
2290
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
3515
mandos_dbus_service = MandosDBusService()
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
2291
3522
def cleanup():
2292
3523
"Cleanup function; run on exit"
2293
service.cleanup()
2294
2295
multiprocessing.active_children()
3524
if zeroconf:
3525
service.cleanup()
3526
3527
mp.active_children()
3528
wn.close()
2296
3529
if not (tcp_server.clients or client_settings):
2297
3530
return
2298
3531
2299
# Store client before exiting. Secrets are encrypted with key based
2300
# on what config file has. If config file is removed/edited, old
2301
# secret will thus be unrecovable.
2302
clients = []
2303
for client in tcp_server.clients.itervalues():
2304
client.encrypt_secret(client_settings[client.name]["secret"])
2305
2306
client_dict = {}
2307
2308
# A list of attributes that will not be stored when shuting down.
2309
exclude = set(("bus", "changedstate", "secret"))
2310
for name, typ in inspect.getmembers(dbus.service.Object):
2311
exclude.add(name)
2312
2313
client_dict["encrypted_secret"] = client.encrypted_secret
2314
for attr in client.client_structure:
2315
if attr not in exclude:
2316
client_dict[attr] = getattr(client, attr)
2317
2318
clients.append(client_dict)
2319
del client_settings[client.name]["secret"]
2320
3532
# Store client before exiting. Secrets are encrypted with key
3533
# based on what config file has. If config file is
3534
# removed/edited, old secret will thus be unrecovable.
3535
clients = {}
3536
with PGPEngine() as pgp:
3537
for client in tcp_server.clients.values():
3538
key = client_settings[client.name]["secret"]
3539
client.encrypted_secret = pgp.encrypt(client.secret,
3540
key)
3541
client_dict = {}
3542
3543
# A list of attributes that can not be pickled
3544
# + secret.
3545
exclude = {"bus", "changedstate", "secret",
3546
"checker", "server_settings"}
3547
for name, typ in inspect.getmembers(dbus.service
3548
.Object):
3549
exclude.add(name)
3550
3551
client_dict["encrypted_secret"] = (client
3552
.encrypted_secret)
3553
for attr in client.client_structure:
3554
if attr not in exclude:
3555
client_dict[attr] = getattr(client, attr)
3556
3557
clients[client.name] = client_dict
3558
del client_settings[client.name]["secret"]
3559
2321
3560
try:
2322
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2323
pickle.dump((clients, client_settings), stored_state)
2324
except IOError as e:
2325
logger.warning("Could not save persistant state: {0}".format(e))
2326
if e.errno != errno.ENOENT:
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
3570
os.rename(tempname, stored_state_path)
3571
except (IOError, OSError) as e:
3572
if not debug:
3573
try:
3574
os.remove(tempname)
3575
except NameError:
3576
pass
3577
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3578
logger.warning("Could not save persistent state: {}"
3579
.format(os.strerror(e.errno)))
3580
else:
3581
logger.warning("Could not save persistent state:",
3582
exc_info=e)
2327
3583
raise
2328
3584
2329
3585
# Delete all clients, and settings from config
2331
3587
name, client = tcp_server.clients.popitem()
2332
3588
if use_dbus:
2333
3589
client.remove_from_connection()
2334
# Don't signal anything except ClientRemoved
3590
# Don't signal the disabling
2335
3591
client.disable(quiet=True)
3592
# Emit D-Bus signal for removal
2336
3593
if use_dbus:
2337
# Emit D-Bus signal
2338
mandos_dbus_service.ClientRemoved(client
2339
.dbus_object_path,
2340
client.name)
3594
mandos_dbus_service.client_removed_signal(client)
2341
3595
client_settings.clear()
2342
3596
2343
3597
atexit.register(cleanup)
2344
2345
for client in tcp_server.clients.itervalues():
3598
3599
for client in tcp_server.clients.values():
2346
3600
if use_dbus:
2347
# Emit D-Bus signal
2348
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3601
# Emit D-Bus signal for adding
3602
mandos_dbus_service.client_added_signal(client)
2349
3603
# Need to initiate checking of clients
2350
3604
if client.enabled:
2351
3605
client.init_checker()
2352
3606
2353
2354
3607
tcp_server.enable()
2355
3608
tcp_server.server_activate()
2356
3609
2357
3610
# Find out what port we got
2358
service.port = tcp_server.socket.getsockname()[1]
3611
if zeroconf:
3612
service.port = tcp_server.socket.getsockname()[1]
2359
3613
if use_ipv6:
2360
3614
logger.info("Now listening on address %r, port %d,"
2361
" flowinfo %d, scope_id %d"
2362
% tcp_server.socket.getsockname())
3615
" flowinfo %d, scope_id %d",
3616
*tcp_server.socket.getsockname())
2363
3617
else: # IPv4
2364
logger.info("Now listening on address %r, port %d"
2365
% tcp_server.socket.getsockname())
2366
2367
#service.interface = tcp_server.socket.getsockname()[3]
2368
3618
logger.info("Now listening on address %r, port %d",
3619
*tcp_server.socket.getsockname())
3620
3621
# service.interface = tcp_server.socket.getsockname()[3]
3622
2369
3623
try:
2370
# From the Avahi example code
2371
try:
2372
service.activate()
2373
except dbus.exceptions.DBusException as error:
2374
logger.critical("DBusException: %s", error)
2375
cleanup()
2376
sys.exit(1)
2377
# End of Avahi example code
2378
2379
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2380
lambda *args, **kwargs:
2381
(tcp_server.handle_request
2382
(*args[2:], **kwargs) or True))
2383
3624
if zeroconf:
3625
# From the Avahi example code
3626
try:
3627
service.activate()
3628
except dbus.exceptions.DBusException as error:
3629
logger.critical("D-Bus Exception", exc_info=error)
3630
cleanup()
3631
sys.exit(1)
3632
# End of Avahi example code
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
2384
3640
logger.debug("Starting main loop")
2385
3641
main_loop.run()
2386
3642
except AvahiError as error:
2387
logger.critical("AvahiError: %s", error)
3643
logger.critical("Avahi Error", exc_info=error)
2388
3644
cleanup()
2389
3645
sys.exit(1)
2390
3646
except KeyboardInterrupt:
2395
3651
# Must run before the D-Bus bus name gets deregistered
2396
3652
cleanup()
2397
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
2398
3670
2399
3671
if __name__ == '__main__':
2400
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