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