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