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