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