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