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