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