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 539
- compare with another revision
- download diff
- download tarball
- view history from revision 539
- Committer: teddy at recompile
- Date: 2011-12-27 14:15:40 UTC
- Revision ID: teddy@recompile.se-20111227141540-ajrabf33q59jfa7t
Reorder TODO entries
- 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-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
16
#
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
23
21
#
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27
25
# GNU General Public License for more details.
28
#
26
#
29
27
# You should have received a copy of the GNU General Public License
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
31
#
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
#
32
31
# Contact the authors at <mandos@recompile.se>.
33
#
32
#
34
33
35
34
from __future__ import (division, absolute_import, print_function,
36
35
unicode_literals)
37
36
38
try:
39
from future_builtins import *
40
except ImportError:
41
pass
42
43
try:
44
import SocketServer as socketserver
45
except ImportError:
46
import socketserver
37
import SocketServer as socketserver
47
38
import socket
48
39
import argparse
49
40
import datetime
50
41
import errno
51
try:
52
import ConfigParser as configparser
53
except ImportError:
54
import configparser
42
import gnutls.crypto
43
import gnutls.connection
44
import gnutls.errors
45
import gnutls.library.functions
46
import gnutls.library.constants
47
import gnutls.library.types
48
import ConfigParser as configparser
55
49
import sys
56
50
import re
57
51
import os
66
60
import struct
67
61
import fcntl
68
62
import functools
69
try:
70
import cPickle as pickle
71
except ImportError:
72
import pickle
63
import cPickle as pickle
73
64
import multiprocessing
74
65
import types
75
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.4"
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
206
147
def __enter__(self):
207
148
return self
208
209
def __exit__(self, exc_type, exc_value, traceback):
149
150
def __exit__ (self, exc_type, exc_value, traceback):
210
151
self._cleanup()
211
152
return False
212
153
213
154
def __del__(self):
214
155
self._cleanup()
215
156
216
157
def _cleanup(self):
217
158
if self.tempdir is not None:
218
159
# Delete contents of tempdir
219
160
for root, dirs, files in os.walk(self.tempdir,
220
topdown=False):
161
topdown = False):
221
162
for filename in files:
222
163
os.remove(os.path.join(root, filename))
223
164
for dirname in dirs:
225
166
# Remove tempdir
226
167
os.rmdir(self.tempdir)
227
168
self.tempdir = None
228
169
229
170
def password_encode(self, password):
230
171
# Passphrase can not be empty and can not contain newlines or
231
172
# 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
173
return b"mandos" + binascii.hexlify(password)
174
240
175
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)
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
178
try:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
183
f.write(data)
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
186
proc.wait()
187
except IOError as e:
188
raise PGPError(e)
189
self.gnupg.passphrase = None
256
190
return ciphertext
257
191
258
192
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)
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
195
try:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
200
f.write(data)
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
203
proc.wait()
204
except IOError as e:
205
raise PGPError(e)
206
self.gnupg.passphrase = None
274
207
return decrypted_plaintext
275
208
276
209
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
210
303
211
class AvahiError(Exception):
304
212
def __init__(self, value, *args, **kwargs):
305
213
self.value = value
306
return super(AvahiError, self).__init__(value, *args,
307
**kwargs)
308
214
super(AvahiError, self).__init__(value, *args, **kwargs)
215
def __unicode__(self):
216
return unicode(repr(self.value))
309
217
310
218
class AvahiServiceError(AvahiError):
311
219
pass
312
220
313
314
221
class AvahiGroupError(AvahiError):
315
222
pass
316
223
317
224
318
225
class AvahiService(object):
319
226
"""An Avahi (Zeroconf) service.
320
227
321
228
Attributes:
322
229
interface: integer; avahi.IF_UNSPEC or an interface index.
323
230
Used to optionally bind to the specified interface.
324
231
name: string; Example: 'Mandos'
325
232
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
233
See <http://www.dns-sd.org/ServiceTypes.html>
327
234
port: integer; what port to announce
328
235
TXT: list of strings; TXT record for the service
329
236
domain: string; Domain to publish on, default to .local if empty.
335
242
server: D-Bus Server
336
243
bus: dbus.SystemBus()
337
244
"""
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):
245
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
246
servicetype = None, port = None, TXT = None,
247
domain = "", host = "", max_renames = 32768,
248
protocol = avahi.PROTO_UNSPEC, bus = None):
350
249
self.interface = interface
351
250
self.name = name
352
251
self.type = servicetype
361
260
self.server = None
362
261
self.bus = bus
363
262
self.entry_group_state_changed_match = None
364
365
def rename(self, remove=True):
263
def rename(self):
366
264
"""Derived from the Avahi example code"""
367
265
if self.rename_count >= self.max_renames:
368
266
logger.critical("No suitable Zeroconf service name found"
369
267
" after %i retries, exiting.",
370
268
self.rename_count)
371
269
raise AvahiServiceError("Too many renames")
372
self.name = str(
373
self.server.GetAlternativeServiceName(self.name))
374
self.rename_count += 1
270
self.name = unicode(self.server
271
.GetAlternativeServiceName(self.name))
375
272
logger.info("Changing Zeroconf service name to %r ...",
376
273
self.name)
377
if remove:
378
self.remove()
274
self.remove()
379
275
try:
380
276
self.add()
381
277
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
278
logger.critical("DBusException: %s", error)
279
self.cleanup()
280
os._exit(1)
281
self.rename_count += 1
391
282
def remove(self):
392
283
"""Derived from the Avahi example code"""
393
284
if self.entry_group_state_changed_match is not None:
395
286
self.entry_group_state_changed_match = None
396
287
if self.group is not None:
397
288
self.group.Reset()
398
399
289
def add(self):
400
290
"""Derived from the Avahi example code"""
401
291
self.remove()
418
308
dbus.UInt16(self.port),
419
309
avahi.string_array_to_txt_array(self.TXT))
420
310
self.group.Commit()
421
422
311
def entry_group_state_changed(self, state, error):
423
312
"""Derived from the Avahi example code"""
424
313
logger.debug("Avahi entry group state change: %i", state)
425
314
426
315
if state == avahi.ENTRY_GROUP_ESTABLISHED:
427
316
logger.debug("Zeroconf service established.")
428
317
elif state == avahi.ENTRY_GROUP_COLLISION:
430
319
self.rename()
431
320
elif state == avahi.ENTRY_GROUP_FAILURE:
432
321
logger.critical("Avahi: Error in group state changed %s",
433
str(error))
434
raise AvahiGroupError("State changed: {!s}".format(error))
435
322
unicode(error))
323
raise AvahiGroupError("State changed: %s"
324
% unicode(error))
436
325
def cleanup(self):
437
326
"""Derived from the Avahi example code"""
438
327
if self.group is not None:
443
332
pass
444
333
self.group = None
445
334
self.remove()
446
447
335
def server_state_changed(self, state, error=None):
448
336
"""Derived from the Avahi example code"""
449
337
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
}
338
bad_states = { avahi.SERVER_INVALID:
339
"Zeroconf server invalid",
340
avahi.SERVER_REGISTERING: None,
341
avahi.SERVER_COLLISION:
342
"Zeroconf server name collision",
343
avahi.SERVER_FAILURE:
344
"Zeroconf server failure" }
456
345
if state in bad_states:
457
346
if bad_states[state] is not None:
458
347
if error is None:
461
350
logger.error(bad_states[state] + ": %r", error)
462
351
self.cleanup()
463
352
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)
353
self.add()
476
354
else:
477
355
if error is None:
478
356
logger.debug("Unknown state: %r", state)
479
357
else:
480
358
logger.debug("Unknown state: %r: %r", state, error)
481
482
359
def activate(self):
483
360
"""Derived from the Avahi example code"""
484
361
if self.server is None:
488
365
follow_name_owner_changes=True),
489
366
avahi.DBUS_INTERFACE_SERVER)
490
367
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
368
self.server_state_changed)
492
369
self.server_state_changed(self.server.GetState())
493
370
494
495
371
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
372
def rename(self):
497
373
"""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)))
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
378
% self.name))
502
379
return ret
503
380
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
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (td.microseconds // 1000))
386
817
387
class Client(object):
818
388
"""A representation of a client host served by this server.
819
389
820
390
Attributes:
821
391
approved: bool(); 'None' if not yet approved/disapproved
822
392
approval_delay: datetime.timedelta(); Time to wait for approval
824
394
checker: subprocess.Popen(); a running checker process used
825
395
to see if the client lives.
826
396
'None' if no process is running.
827
checker_callback_tag: a GLib event source tag, or None
397
checker_callback_tag: a gobject event source tag, or None
828
398
checker_command: string; External command which is run to check
829
399
if client lives. %() expansions are done at
830
400
runtime with vars(self) as dict, so that for
831
401
instance %(name)s can be used in the command.
832
checker_initiator_tag: a GLib event source tag, or None
402
checker_initiator_tag: a gobject event source tag, or None
833
403
created: datetime.datetime(); (UTC) object creation
834
404
client_structure: Object describing what attributes a client has
835
405
and is used for storing the client at exit
836
406
current_checker_command: string; current running checker_command
837
disable_initiator_tag: a GLib event source tag, or None
407
disable_initiator_tag: a gobject event source tag, or None
838
408
enabled: bool()
839
409
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
410
uniquely identify the client
843
411
host: string; available for use by the checker command
844
412
interval: datetime.timedelta(); How often to start a new checker
845
413
last_approval_request: datetime.datetime(); (UTC) or None
846
414
last_checked_ok: datetime.datetime(); (UTC) or None
847
415
last_checker_status: integer between 0 and 255 reflecting exit
848
416
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
417
checker, or None.
852
418
last_enabled: datetime.datetime(); (UTC) or None
853
419
name: string; from the config file, used in log messages and
854
420
D-Bus identifiers
855
421
secret: bytestring; sent verbatim (over TLS) to client
856
422
timeout: datetime.timedelta(); How long from last_checked_ok
857
423
until this client is disabled
858
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
859
425
runtime_expansions: Allowed attributes for runtime expansion.
860
426
expires: datetime.datetime(); time (UTC) when a client will be
861
427
disabled, or None
862
server_settings: The server_settings dict from main()
863
428
"""
864
429
865
430
runtime_expansions = ("approval_delay", "approval_duration",
866
"created", "enabled", "expires", "key_id",
867
"fingerprint", "host", "interval",
868
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
869
433
"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
}
434
client_defaults = { "timeout": "5m",
435
"extended_timeout": "15m",
436
"interval": "2m",
437
"checker": "fping -q -- %%(host)s",
438
"host": "",
439
"approval_delay": "0s",
440
"approval_duration": "1s",
441
"approved_by_default": "True",
442
"enabled": "True",
443
}
444
445
def timeout_milliseconds(self):
446
"Return the 'timeout' attribute in milliseconds"
447
return timedelta_to_milliseconds(self.timeout)
448
449
def extended_timeout_milliseconds(self):
450
"Return the 'extended_timeout' attribute in milliseconds"
451
return timedelta_to_milliseconds(self.extended_timeout)
452
453
def interval_milliseconds(self):
454
"Return the 'interval' attribute in milliseconds"
455
return timedelta_to_milliseconds(self.interval)
456
457
def approval_delay_milliseconds(self):
458
return timedelta_to_milliseconds(self.approval_delay)
881
459
882
460
@staticmethod
883
461
def config_parser(config):
884
"""Construct a new dict of client settings of this form:
462
""" Construct a new dict of client settings of this form:
885
463
{ client_name: {setting_name: value, ...}, ...}
886
with exceptions for any special settings as defined above.
887
NOTE: Must be a pure function. Must return the same result
888
value given the same arguments.
889
"""
464
with exceptions for any special settings as defined above"""
890
465
settings = {}
891
466
for client_name in config.sections():
892
467
section = dict(config.items(client_name))
893
468
client = settings[client_name] = {}
894
469
895
470
client["host"] = section["host"]
896
471
# Reformat values from string types to Python types
897
472
client["approved_by_default"] = config.getboolean(
898
473
client_name, "approved_by_default")
899
client["enabled"] = config.getboolean(client_name,
900
"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(" ", ""))
474
client["enabled"] = config.getboolean(client_name, "enabled")
475
907
476
client["fingerprint"] = (section["fingerprint"].upper()
908
477
.replace(" ", ""))
909
478
if "secret" in section:
910
client["secret"] = codecs.decode(section["secret"]
911
.encode("utf-8"),
912
"base64")
479
client["secret"] = section["secret"].decode("base64")
913
480
elif "secfile" in section:
914
481
with open(os.path.expanduser(os.path.expandvars
915
482
(section["secfile"])),
916
483
"rb") as secfile:
917
484
client["secret"] = secfile.read()
918
485
else:
919
raise TypeError("No secret or secfile for section {}"
920
.format(section))
486
raise TypeError("No secret or secfile for section %s"
487
% section)
921
488
client["timeout"] = string_to_delta(section["timeout"])
922
489
client["extended_timeout"] = string_to_delta(
923
490
section["extended_timeout"])
929
496
client["checker_command"] = section["checker"]
930
497
client["last_approval_request"] = None
931
498
client["last_checked_ok"] = None
932
client["last_checker_status"] = -2
499
client["last_checker_status"] = None
500
if client["enabled"]:
501
client["last_enabled"] = datetime.datetime.utcnow()
502
client["expires"] = (datetime.datetime.utcnow()
503
+ client["timeout"])
504
else:
505
client["last_enabled"] = None
506
client["expires"] = None
933
507
934
508
return settings
935
936
def __init__(self, settings, name=None, server_settings=None):
509
510
511
def __init__(self, settings, name = None):
512
"""Note: the 'checker' key in 'config' sets the
513
'checker_command' attribute and *not* the 'checker'
514
attribute."""
937
515
self.name = name
938
if server_settings is None:
939
server_settings = {}
940
self.server_settings = server_settings
941
516
# adding all client settings
942
for setting, value in settings.items():
517
for setting, value in settings.iteritems():
943
518
setattr(self, setting, value)
944
945
if self.enabled:
946
if not hasattr(self, "last_enabled"):
947
self.last_enabled = datetime.datetime.utcnow()
948
if not hasattr(self, "expires"):
949
self.expires = (datetime.datetime.utcnow()
950
+ self.timeout)
951
else:
952
self.last_enabled = None
953
self.expires = None
954
519
955
520
logger.debug("Creating client %r", self.name)
956
logger.debug(" Key ID: %s", self.key_id)
521
# Uppercase and remove spaces from fingerprint for later
522
# comparison purposes with return value from the fingerprint()
523
# function
957
524
logger.debug(" Fingerprint: %s", self.fingerprint)
958
self.created = settings.get("created",
959
datetime.datetime.utcnow())
525
self.created = settings.get("created", datetime.datetime.utcnow())
960
526
961
527
# attributes specific for this server instance
962
528
self.checker = None
966
532
self.current_checker_command = None
967
533
self.approved = None
968
534
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()
535
self.changedstate = (multiprocessing_manager
536
.Condition(multiprocessing_manager
537
.Lock()))
538
self.client_structure = [attr for attr in
539
self.__dict__.iterkeys()
973
540
if not attr.startswith("_")]
974
541
self.client_structure.append("client_structure")
975
976
for name, t in inspect.getmembers(
977
type(self), lambda obj: isinstance(obj, property)):
542
543
for name, t in inspect.getmembers(type(self),
544
lambda obj:
545
isinstance(obj,
546
property)):
978
547
if not name.startswith("_"):
979
548
self.client_structure.append(name)
980
549
981
550
# Send notice to process children that client state has changed
982
551
def send_changedstate(self):
983
552
with self.changedstate:
984
553
self.changedstate.notify_all()
985
554
986
555
def enable(self):
987
556
"""Start this client's checker and timeout hooks"""
988
557
if getattr(self, "enabled", False):
989
558
# Already enabled
990
559
return
560
self.send_changedstate()
991
561
self.expires = datetime.datetime.utcnow() + self.timeout
992
562
self.enabled = True
993
563
self.last_enabled = datetime.datetime.utcnow()
994
564
self.init_checker()
995
self.send_changedstate()
996
565
997
566
def disable(self, quiet=True):
998
567
"""Disable this client."""
999
568
if not getattr(self, "enabled", False):
1000
569
return False
1001
570
if not quiet:
571
self.send_changedstate()
572
if not quiet:
1002
573
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)
574
if getattr(self, "disable_initiator_tag", False):
575
gobject.source_remove(self.disable_initiator_tag)
1005
576
self.disable_initiator_tag = None
1006
577
self.expires = None
1007
if getattr(self, "checker_initiator_tag", None) is not None:
1008
GLib.source_remove(self.checker_initiator_tag)
578
if getattr(self, "checker_initiator_tag", False):
579
gobject.source_remove(self.checker_initiator_tag)
1009
580
self.checker_initiator_tag = None
1010
581
self.stop_checker()
1011
582
self.enabled = False
1012
if not quiet:
1013
self.send_changedstate()
1014
# Do not run this again if called by a GLib.timeout_add
583
# Do not run this again if called by a gobject.timeout_add
1015
584
return False
1016
585
1017
586
def __del__(self):
1018
587
self.disable()
1019
588
1020
589
def init_checker(self):
1021
590
# Schedule a new checker to be started an 'interval' from now,
1022
591
# 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)
592
self.checker_initiator_tag = (gobject.timeout_add
593
(self.interval_milliseconds(),
594
self.start_checker))
1028
595
# 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)
596
self.disable_initiator_tag = (gobject.timeout_add
597
(self.timeout_milliseconds(),
598
self.disable))
1033
599
# Also start a new checker *right now*.
1034
600
self.start_checker()
1035
1036
def checker_callback(self, source, condition, connection,
1037
command):
601
602
def checker_callback(self, pid, condition, command):
1038
603
"""The checker has completed, so take appropriate actions."""
1039
604
self.checker_callback_tag = None
1040
605
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
606
if os.WIFEXITED(condition):
607
self.last_checker_status = os.WEXITSTATUS(condition)
1048
608
if self.last_checker_status == 0:
1049
609
logger.info("Checker for %(name)s succeeded",
1050
610
vars(self))
1051
611
self.checked_ok()
1052
612
else:
1053
logger.info("Checker for %(name)s failed", vars(self))
613
logger.info("Checker for %(name)s failed",
614
vars(self))
1054
615
else:
1055
616
self.last_checker_status = -1
1056
self.last_checker_signal = -returncode
1057
617
logger.warning("Checker for %(name)s crashed?",
1058
618
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."""
619
620
def checked_ok(self, timeout=None):
621
"""Bump up the timeout for this client.
622
623
This should only be called when the client has been seen,
624
alive and well.
625
"""
1070
626
if timeout is None:
1071
627
timeout = self.timeout
628
self.last_checked_ok = datetime.datetime.utcnow()
1072
629
if self.disable_initiator_tag is not None:
1073
GLib.source_remove(self.disable_initiator_tag)
1074
self.disable_initiator_tag = None
630
gobject.source_remove(self.disable_initiator_tag)
1075
631
if getattr(self, "enabled", False):
1076
self.disable_initiator_tag = GLib.timeout_add(
1077
int(timeout.total_seconds() * 1000), self.disable)
632
self.disable_initiator_tag = (gobject.timeout_add
633
(timedelta_to_milliseconds
634
(timeout), self.disable))
1078
635
self.expires = datetime.datetime.utcnow() + timeout
1079
636
1080
637
def need_approval(self):
1081
638
self.last_approval_request = datetime.datetime.utcnow()
1082
639
1083
640
def start_checker(self):
1084
641
"""Start a new checker subprocess if one is not running.
1085
642
1086
643
If a checker already exists, leave it running and do
1087
644
nothing."""
1088
645
# 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
646
# did that, then if a checker (for some reason) started
647
# running slowly and taking more than 'interval' time, the
648
# client would inevitably timeout, since no checker would get
649
# a chance to run to completion. If we instead leave running
1093
650
# checkers alone, the checker would have to take more time
1094
651
# than 'timeout' for the client to be disabled, which is as it
1095
652
# 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
653
654
# If a checker exists, make sure it is not a zombie
655
try:
656
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
657
except (AttributeError, OSError) as error:
658
if (isinstance(error, OSError)
659
and error.errno != errno.ECHILD):
660
raise error
661
else:
662
if pid:
663
logger.warning("Checker was a zombie")
664
gobject.source_remove(self.checker_callback_tag)
665
self.checker_callback(pid, status,
666
self.current_checker_command)
1101
667
# Start a new checker if needed
1102
668
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
669
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
670
# In case checker_command has exactly one % operator
671
command = self.checker_command % self.host
672
except TypeError:
673
# Escape attributes for the shell
674
escaped_attrs = dict(
675
(attr,
676
re.escape(unicode(str(getattr(self, attr, "")),
677
errors=
678
'replace')))
679
for attr in
680
self.runtime_expansions)
681
682
try:
683
command = self.checker_command % escaped_attrs
684
except TypeError as error:
685
logger.error('Could not format string "%s":'
686
' %s', self.checker_command, error)
687
return True # Try again later
1114
688
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
689
try:
690
logger.info("Starting checker %r for %s",
691
command, self.name)
692
# We don't need to redirect stdout and stderr, since
693
# in normal mode, that is already done by daemon(),
694
# and in debug mode we don't want to. (Stdin is
695
# always replaced by /dev/null.)
696
self.checker = subprocess.Popen(command,
697
close_fds=True,
698
shell=True, cwd="/")
699
self.checker_callback_tag = (gobject.child_watch_add
700
(self.checker.pid,
701
self.checker_callback,
702
data=command))
703
# The checker may have completed before the gobject
704
# watch was added. Check for this.
705
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
706
if pid:
707
gobject.source_remove(self.checker_callback_tag)
708
self.checker_callback(pid, status, command)
709
except OSError as error:
710
logger.error("Failed to start subprocess: %s",
711
error)
712
# Re-run this periodically if run by gobject.timeout_add
1141
713
return True
1142
714
1143
715
def stop_checker(self):
1144
716
"""Force the checker process, if any, to stop."""
1145
717
if self.checker_callback_tag:
1146
GLib.source_remove(self.checker_callback_tag)
718
gobject.source_remove(self.checker_callback_tag)
1147
719
self.checker_callback_tag = None
1148
720
if getattr(self, "checker", None) is None:
1149
721
return
1150
722
logger.debug("Stopping checker for %(name)s", vars(self))
1151
self.checker.terminate()
723
try:
724
os.kill(self.checker.pid, signal.SIGTERM)
725
#time.sleep(0.5)
726
#if self.checker.poll() is None:
727
# os.kill(self.checker.pid, signal.SIGKILL)
728
except OSError as error:
729
if error.errno != errno.ESRCH: # No such process
730
raise
1152
731
self.checker = None
1153
732
1154
733
1155
def dbus_service_property(dbus_interface,
1156
signature="v",
1157
access="readwrite",
1158
byte_arrays=False):
734
def dbus_service_property(dbus_interface, signature="v",
735
access="readwrite", byte_arrays=False):
1159
736
"""Decorators for marking methods of a DBusObjectWithProperties to
1160
737
become properties on the D-Bus.
1161
738
1162
739
The decorated method will be called with no arguments by "Get"
1163
740
and with one argument by "Set".
1164
741
1165
742
The parameters, where they are supported, are the same as
1166
743
dbus.service.method, except there is only "signature", since the
1167
744
type from Get() and the type sent to Set() is the same.
1170
747
# "Set" method, so we fail early here:
1171
748
if byte_arrays and signature != "ay":
1172
749
raise ValueError("Byte arrays not supported for non-'ay'"
1173
" signature {!r}".format(signature))
1174
750
" signature %r" % signature)
1175
751
def decorator(func):
1176
752
func._dbus_is_property = True
1177
753
func._dbus_interface = dbus_interface
1180
756
func._dbus_name = func.__name__
1181
757
if func._dbus_name.endswith("_dbus_property"):
1182
758
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
759
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
760
return func
1229
761
return decorator
1230
762
1231
763
1232
764
class DBusPropertyException(dbus.exceptions.DBusException):
1233
765
"""A base class for D-Bus property-related exceptions
1234
766
"""
1235
pass
767
def __unicode__(self):
768
return unicode(str(self))
1236
769
1237
770
1238
771
class DBusPropertyAccessException(DBusPropertyException):
1247
780
pass
1248
781
1249
782
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):
783
class DBusObjectWithProperties(dbus.service.Object):
1340
784
"""A D-Bus object with properties.
1341
785
1342
786
Classes inheriting from this can use the dbus_service_property
1343
787
decorator to expose methods as D-Bus properties. It exposes the
1344
788
standard Get(), Set(), and GetAll() methods on the D-Bus.
1345
789
"""
1346
790
791
@staticmethod
792
def _is_dbus_property(obj):
793
return getattr(obj, "_dbus_is_property", False)
794
795
def _get_all_dbus_properties(self):
796
"""Returns a generator of (name, attribute) pairs
797
"""
798
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
799
for cls in self.__class__.__mro__
800
for name, prop in
801
inspect.getmembers(cls, self._is_dbus_property))
802
1347
803
def _get_dbus_property(self, interface_name, property_name):
1348
804
"""Returns a bound method if one exists which is a D-Bus
1349
805
property with the specified name and interface.
1350
806
"""
1351
for cls in self.__class__.__mro__:
1352
for name, value in inspect.getmembers(
1353
cls, self._is_dbus_thing("property")):
807
for cls in self.__class__.__mro__:
808
for name, value in (inspect.getmembers
809
(cls, self._is_dbus_property)):
1354
810
if (value._dbus_name == property_name
1355
811
and value._dbus_interface == interface_name):
1356
812
return value.__get__(self)
1357
813
1358
814
# 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",
815
raise DBusPropertyNotFound(self.dbus_object_path + ":"
816
+ interface_name + "."
817
+ property_name)
818
819
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1373
820
out_signature="v")
1374
821
def Get(self, interface_name, property_name):
1375
822
"""Standard D-Bus property Get() method, see D-Bus standard.
1381
828
if not hasattr(value, "variant_level"):
1382
829
return value
1383
830
return type(value)(value, variant_level=value.variant_level+1)
1384
831
1385
832
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1386
833
def Set(self, interface_name, property_name, value):
1387
834
"""Standard D-Bus property Set() method, see D-Bus standard.
1393
840
# The byte_arrays option is not supported yet on
1394
841
# signatures other than "ay".
1395
842
if prop._dbus_signature != "ay":
1396
raise ValueError("Byte arrays not supported for non-"
1397
"'ay' signature {!r}"
1398
.format(prop._dbus_signature))
1399
value = dbus.ByteArray(b''.join(chr(byte)
1400
for byte in value))
843
raise ValueError
844
value = dbus.ByteArray(''.join(unichr(byte)
845
for byte in value))
1401
846
prop(value)
1402
1403
@dbus.service.method(dbus.PROPERTIES_IFACE,
1404
in_signature="s",
847
848
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1405
849
out_signature="a{sv}")
1406
850
def GetAll(self, interface_name):
1407
851
"""Standard D-Bus property GetAll() method, see D-Bus
1408
852
standard.
1409
853
1410
854
Note: Will not include properties with access="write".
1411
855
"""
1412
856
properties = {}
1413
for name, prop in self._get_all_dbus_things("property"):
857
for name, prop in self._get_all_dbus_properties():
1414
858
if (interface_name
1415
859
and interface_name != prop._dbus_interface):
1416
860
# Interface non-empty but did not match
1422
866
if not hasattr(value, "variant_level"):
1423
867
properties[name] = value
1424
868
continue
1425
properties[name] = type(value)(
1426
value, variant_level=value.variant_level + 1)
869
properties[name] = type(value)(value, variant_level=
870
value.variant_level+1)
1427
871
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
872
1437
873
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1438
874
out_signature="s",
1439
875
path_keyword='object_path',
1440
876
connection_keyword='connection')
1441
877
def Introspect(self, object_path, connection):
1442
"""Overloading of standard D-Bus method.
1443
1444
Inserts property tags and interface annotation tags.
878
"""Standard D-Bus method, overloaded to insert property tags.
1445
879
"""
1446
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1447
object_path,
1448
connection)
880
xmlstring = dbus.service.Object.Introspect(self, object_path,
881
connection)
1449
882
try:
1450
883
document = xml.dom.minidom.parseString(xmlstring)
1451
1452
884
def make_tag(document, name, prop):
1453
885
e = document.createElement("property")
1454
886
e.setAttribute("name", name)
1455
887
e.setAttribute("type", prop._dbus_signature)
1456
888
e.setAttribute("access", prop._dbus_access)
1457
889
return e
1458
1459
890
for if_tag in document.getElementsByTagName("interface"):
1460
# Add property tags
1461
891
for tag in (make_tag(document, name, prop)
1462
892
for name, prop
1463
in self._get_all_dbus_things("property")
893
in self._get_all_dbus_properties()
1464
894
if prop._dbus_interface
1465
895
== if_tag.getAttribute("name")):
1466
896
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
897
# Add the names to the return values for the
1484
898
# "org.freedesktop.DBus.Properties" methods
1485
899
if (if_tag.getAttribute("name")
1500
914
except (AttributeError, xml.dom.DOMException,
1501
915
xml.parsers.expat.ExpatError) as error:
1502
916
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):
917
error)
918
return xmlstring
919
920
921
def datetime_to_dbus (dt, variant_level=0):
1579
922
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1580
923
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).
924
return dbus.String("", variant_level = variant_level)
925
return dbus.String(dt.isoformat(),
926
variant_level=variant_level)
927
928
929
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
930
.__metaclass__):
931
"""Applied to an empty subclass of a D-Bus object, this metaclass
932
will add additional D-Bus attributes matching a certain pattern.
1607
933
"""
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):
934
def __new__(mcs, name, bases, attr):
935
# Go through all the base classes which could have D-Bus
936
# methods, signals, or properties in them
937
for base in (b for b in bases
938
if issubclass(b, dbus.service.Object)):
939
# Go though all attributes of the base class
940
for attrname, attribute in inspect.getmembers(base):
1616
941
# Ignore non-D-Bus attributes, and D-Bus attributes
1617
942
# with the wrong interface name
1618
943
if (not hasattr(attribute, "_dbus_interface")
1619
or not attribute._dbus_interface.startswith(
1620
orig_interface_name)):
944
or not attribute._dbus_interface
945
.startswith("se.recompile.Mandos")):
1621
946
continue
1622
947
# Create an alternate D-Bus interface name based on
1623
948
# the current name
1624
alt_interface = attribute._dbus_interface.replace(
1625
orig_interface_name, alt_interface_name)
1626
interface_names.add(alt_interface)
949
alt_interface = (attribute._dbus_interface
950
.replace("se.recompile.Mandos",
951
"se.bsnet.fukt.Mandos"))
1627
952
# Is this a D-Bus signal?
1628
953
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(
954
# Extract the original non-method function by
955
# black magic
956
nonmethod_func = (dict(
1633
957
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)
958
attribute.__closure__))["func"]
959
.cell_contents)
1641
960
# Create a new, but exactly alike, function
1642
961
# object, and decorate it to be a new D-Bus signal
1643
962
# 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
963
new_function = (dbus.service.signal
964
(alt_interface,
965
attribute._dbus_signature)
966
(types.FunctionType(
967
nonmethod_func.func_code,
968
nonmethod_func.func_globals,
969
nonmethod_func.func_name,
970
nonmethod_func.func_defaults,
971
nonmethod_func.func_closure)))
1655
972
# 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
973
# old and new functions, so both the old and new
974
# signals gets sent when the function is called
1659
975
def fixscope(func1, func2):
1660
976
"""This function is a scope container to pass
1661
977
func1 and func2 to the "call_both" function
1662
978
outside of its arguments"""
1663
1664
@functools.wraps(func2)
1665
979
def call_both(*args, **kwargs):
1666
980
"""This function will emit two D-Bus
1667
981
signals by calling func1 and func2"""
1668
982
func1(*args, **kwargs)
1669
983
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
984
return call_both
1677
985
# Create the "call_both" function and add it to
1678
986
# the class
1679
attr[attrname] = fixscope(attribute, new_function)
987
attr[attrname] = fixscope(attribute,
988
new_function)
1680
989
# Is this a D-Bus method?
1681
990
elif getattr(attribute, "_dbus_is_method", False):
1682
991
# Create a new, but exactly alike, function
1683
992
# object. Decorate it to be a new D-Bus method
1684
993
# with the alternate D-Bus interface name. Add it
1685
994
# 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
995
attr[attrname] = (dbus.service.method
996
(alt_interface,
997
attribute._dbus_in_signature,
998
attribute._dbus_out_signature)
999
(types.FunctionType
1000
(attribute.func_code,
1001
attribute.func_globals,
1002
attribute.func_name,
1003
attribute.func_defaults,
1004
attribute.func_closure)))
1698
1005
# Is this a D-Bus property?
1699
1006
elif getattr(attribute, "_dbus_is_property", False):
1700
1007
# Create a new, but exactly alike, function
1701
1008
# object, and decorate it to be a new D-Bus
1702
1009
# property with the alternate D-Bus interface
1703
1010
# 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"})
1011
attr[attrname] = (dbus_service_property
1012
(alt_interface,
1013
attribute._dbus_signature,
1014
attribute._dbus_access,
1015
attribute
1016
._dbus_get_args_options
1017
["byte_arrays"])
1018
(types.FunctionType
1019
(attribute.func_code,
1020
attribute.func_globals,
1021
attribute.func_name,
1022
attribute.func_defaults,
1023
attribute.func_closure)))
1024
return type.__new__(mcs, name, bases, attr)
1025
1026
1756
1027
class ClientDBus(Client, DBusObjectWithProperties):
1757
1028
"""A Client class using D-Bus
1758
1029
1759
1030
Attributes:
1760
1031
dbus_object_path: dbus.ObjectPath
1761
1032
bus: dbus.SystemBus()
1762
1033
"""
1763
1034
1764
1035
runtime_expansions = (Client.runtime_expansions
1765
+ ("dbus_object_path", ))
1766
1767
_interface = "se.recompile.Mandos.Client"
1768
1036
+ ("dbus_object_path",))
1037
1769
1038
# dbus.service.Object doesn't use super(), so we can't either.
1770
1771
def __init__(self, bus=None, *args, **kwargs):
1039
1040
def __init__(self, bus = None, *args, **kwargs):
1772
1041
self.bus = bus
1773
1042
Client.__init__(self, *args, **kwargs)
1043
self._approvals_pending = 0
1044
1045
self._approvals_pending = 0
1774
1046
# Only now, when this client is initialized, can it show up on
1775
1047
# the D-Bus
1776
client_object_name = str(self.name).translate(
1048
client_object_name = unicode(self.name).translate(
1777
1049
{ord("."): ord("_"),
1778
1050
ord("-"): ord("_")})
1779
self.dbus_object_path = dbus.ObjectPath(
1780
"/clients/" + client_object_name)
1051
self.dbus_object_path = (dbus.ObjectPath
1052
("/clients/" + client_object_name))
1781
1053
DBusObjectWithProperties.__init__(self, self.bus,
1782
1054
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):
1055
1056
def notifychangeproperty(transform_func,
1057
dbus_name, type_func=lambda x: x,
1058
variant_level=1):
1789
1059
""" Modify a variable so that it's a property which announces
1790
1060
its changes to DBus.
1791
1061
1792
1062
transform_fun: Function that takes a value and a variant_level
1793
1063
and transforms it to a D-Bus type.
1794
1064
dbus_name: D-Bus name of the variable
1796
1066
to the D-Bus. Default: no transform
1797
1067
variant_level: D-Bus variant level. Default: 1
1798
1068
"""
1799
attrname = "_{}".format(dbus_name)
1800
1069
attrname = "_{0}".format(dbus_name)
1801
1070
def setter(self, value):
1802
1071
if hasattr(self, "dbus_object_path"):
1803
1072
if (not hasattr(self, attrname) or
1804
1073
type_func(getattr(self, attrname, None))
1805
1074
!= 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())
1075
dbus_value = transform_func(type_func(value),
1076
variant_level
1077
=variant_level)
1078
self.PropertyChanged(dbus.String(dbus_name),
1079
dbus_value)
1821
1080
setattr(self, attrname, value)
1822
1081
1823
1082
return property(lambda self: getattr(self, attrname), setter)
1824
1083
1084
1825
1085
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1826
1086
approvals_pending = notifychangeproperty(dbus.Boolean,
1827
1087
"ApprovalPending",
1828
type_func=bool)
1088
type_func = bool)
1829
1089
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1830
1090
last_enabled = notifychangeproperty(datetime_to_dbus,
1831
1091
"LastEnabled")
1832
checker = notifychangeproperty(
1833
dbus.Boolean, "CheckerRunning",
1834
type_func=lambda checker: checker is not None)
1092
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1093
type_func = lambda checker:
1094
checker is not None)
1835
1095
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1836
1096
"LastCheckedOK")
1837
last_checker_status = notifychangeproperty(dbus.Int16,
1838
"LastCheckerStatus")
1839
1097
last_approval_request = notifychangeproperty(
1840
1098
datetime_to_dbus, "LastApprovalRequest")
1841
1099
approved_by_default = notifychangeproperty(dbus.Boolean,
1842
1100
"ApprovedByDefault")
1843
approval_delay = notifychangeproperty(
1844
dbus.UInt64, "ApprovalDelay",
1845
type_func=lambda td: td.total_seconds() * 1000)
1101
approval_delay = notifychangeproperty(dbus.UInt64,
1102
"ApprovalDelay",
1103
type_func =
1104
timedelta_to_milliseconds)
1846
1105
approval_duration = notifychangeproperty(
1847
1106
dbus.UInt64, "ApprovalDuration",
1848
type_func=lambda td: td.total_seconds() * 1000)
1107
type_func = timedelta_to_milliseconds)
1849
1108
host = notifychangeproperty(dbus.String, "Host")
1850
timeout = notifychangeproperty(
1851
dbus.UInt64, "Timeout",
1852
type_func=lambda td: td.total_seconds() * 1000)
1109
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1110
type_func =
1111
timedelta_to_milliseconds)
1853
1112
extended_timeout = notifychangeproperty(
1854
1113
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)
1114
type_func = timedelta_to_milliseconds)
1115
interval = notifychangeproperty(dbus.UInt64,
1116
"Interval",
1117
type_func =
1118
timedelta_to_milliseconds)
1859
1119
checker_command = notifychangeproperty(dbus.String, "Checker")
1860
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1861
invalidate_only=True)
1862
1120
1863
1121
del notifychangeproperty
1864
1122
1865
1123
def __del__(self, *args, **kwargs):
1866
1124
try:
1867
1125
self.remove_from_connection()
1870
1128
if hasattr(DBusObjectWithProperties, "__del__"):
1871
1129
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1872
1130
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:
1131
1132
def checker_callback(self, pid, condition, command,
1133
*args, **kwargs):
1134
self.checker_callback_tag = None
1135
self.checker = None
1136
if os.WIFEXITED(condition):
1137
exitstatus = os.WEXITSTATUS(condition)
1881
1138
# Emit D-Bus signal
1882
1139
self.CheckerCompleted(dbus.Int16(exitstatus),
1883
# This is specific to GNU libC
1884
dbus.Int64(exitstatus << 8),
1140
dbus.Int64(condition),
1885
1141
dbus.String(command))
1886
1142
else:
1887
1143
# Emit D-Bus signal
1888
1144
self.CheckerCompleted(dbus.Int16(-1),
1889
dbus.Int64(
1890
# This is specific to GNU libC
1891
(exitstatus << 8)
1892
| self.last_checker_signal),
1145
dbus.Int64(condition),
1893
1146
dbus.String(command))
1894
return ret
1895
1147
1148
return Client.checker_callback(self, pid, condition, command,
1149
*args, **kwargs)
1150
1896
1151
def start_checker(self, *args, **kwargs):
1897
old_checker_pid = getattr(self.checker, "pid", None)
1152
old_checker = self.checker
1153
if self.checker is not None:
1154
old_checker_pid = self.checker.pid
1155
else:
1156
old_checker_pid = None
1898
1157
r = Client.start_checker(self, *args, **kwargs)
1899
1158
# Only if new checker process was started
1900
1159
if (self.checker is not None
1902
1161
# Emit D-Bus signal
1903
1162
self.CheckerStarted(self.current_checker_command)
1904
1163
return r
1905
1164
1906
1165
def _reset_approved(self):
1907
1166
self.approved = None
1908
1167
return False
1909
1168
1910
1169
def approve(self, value=True):
1170
self.send_changedstate()
1911
1171
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
1172
gobject.timeout_add(timedelta_to_milliseconds
1173
(self.approval_duration),
1174
self._reset_approved)
1175
1176
1177
## D-Bus methods, signals & properties
1178
_interface = "se.recompile.Mandos.Client"
1179
1180
## Signals
1181
1922
1182
# CheckerCompleted - signal
1923
1183
@dbus.service.signal(_interface, signature="nxs")
1924
1184
def CheckerCompleted(self, exitcode, waitstatus, command):
1925
1185
"D-Bus signal"
1926
1186
pass
1927
1187
1928
1188
# CheckerStarted - signal
1929
1189
@dbus.service.signal(_interface, signature="s")
1930
1190
def CheckerStarted(self, command):
1931
1191
"D-Bus signal"
1932
1192
pass
1933
1193
1934
1194
# PropertyChanged - signal
1935
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1936
1195
@dbus.service.signal(_interface, signature="sv")
1937
1196
def PropertyChanged(self, property, value):
1938
1197
"D-Bus signal"
1939
1198
pass
1940
1199
1941
1200
# GotSecret - signal
1942
1201
@dbus.service.signal(_interface)
1943
1202
def GotSecret(self):
1946
1205
server to mandos-client
1947
1206
"""
1948
1207
pass
1949
1208
1950
1209
# Rejected - signal
1951
1210
@dbus.service.signal(_interface, signature="s")
1952
1211
def Rejected(self, reason):
1953
1212
"D-Bus signal"
1954
1213
pass
1955
1214
1956
1215
# NeedApproval - signal
1957
1216
@dbus.service.signal(_interface, signature="tb")
1958
1217
def NeedApproval(self, timeout, default):
1959
1218
"D-Bus signal"
1960
1219
return self.need_approval()
1961
1962
# Methods
1963
1220
1221
# NeRwequest - signal
1222
@dbus.service.signal(_interface, signature="s")
1223
def NewRequest(self, ip):
1224
"""D-Bus signal
1225
Is sent after a client request a password.
1226
"""
1227
pass
1228
1229
## Methods
1230
1964
1231
# Approve - method
1965
1232
@dbus.service.method(_interface, in_signature="b")
1966
1233
def Approve(self, value):
1967
1234
self.approve(value)
1968
1235
1969
1236
# CheckedOK - method
1970
1237
@dbus.service.method(_interface)
1971
1238
def CheckedOK(self):
1972
1239
self.checked_ok()
1973
1240
1974
1241
# Enable - method
1975
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1976
1242
@dbus.service.method(_interface)
1977
1243
def Enable(self):
1978
1244
"D-Bus method"
1979
1245
self.enable()
1980
1246
1981
1247
# StartChecker - method
1982
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1983
1248
@dbus.service.method(_interface)
1984
1249
def StartChecker(self):
1985
1250
"D-Bus method"
1986
1251
self.start_checker()
1987
1252
1988
1253
# Disable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
1254
@dbus.service.method(_interface)
1991
1255
def Disable(self):
1992
1256
"D-Bus method"
1993
1257
self.disable()
1994
1258
1995
1259
# StopChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
1260
@dbus.service.method(_interface)
1998
1261
def StopChecker(self):
1999
1262
self.stop_checker()
2000
2001
# Properties
2002
1263
1264
## Properties
1265
2003
1266
# ApprovalPending - property
2004
1267
@dbus_service_property(_interface, signature="b", access="read")
2005
1268
def ApprovalPending_dbus_property(self):
2006
1269
return dbus.Boolean(bool(self.approvals_pending))
2007
1270
2008
1271
# ApprovedByDefault - property
2009
@dbus_service_property(_interface,
2010
signature="b",
1272
@dbus_service_property(_interface, signature="b",
2011
1273
access="readwrite")
2012
1274
def ApprovedByDefault_dbus_property(self, value=None):
2013
1275
if value is None: # get
2014
1276
return dbus.Boolean(self.approved_by_default)
2015
1277
self.approved_by_default = bool(value)
2016
1278
2017
1279
# ApprovalDelay - property
2018
@dbus_service_property(_interface,
2019
signature="t",
1280
@dbus_service_property(_interface, signature="t",
2020
1281
access="readwrite")
2021
1282
def ApprovalDelay_dbus_property(self, value=None):
2022
1283
if value is None: # get
2023
return dbus.UInt64(self.approval_delay.total_seconds()
2024
* 1000)
1284
return dbus.UInt64(self.approval_delay_milliseconds())
2025
1285
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2026
1286
2027
1287
# ApprovalDuration - property
2028
@dbus_service_property(_interface,
2029
signature="t",
1288
@dbus_service_property(_interface, signature="t",
2030
1289
access="readwrite")
2031
1290
def ApprovalDuration_dbus_property(self, value=None):
2032
1291
if value is None: # get
2033
return dbus.UInt64(self.approval_duration.total_seconds()
2034
* 1000)
1292
return dbus.UInt64(timedelta_to_milliseconds(
1293
self.approval_duration))
2035
1294
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2036
1295
2037
1296
# Name - property
2038
@dbus_annotations(
2039
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2040
1297
@dbus_service_property(_interface, signature="s", access="read")
2041
1298
def Name_dbus_property(self):
2042
1299
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
1300
2051
1301
# Fingerprint - property
2052
@dbus_annotations(
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
1302
@dbus_service_property(_interface, signature="s", access="read")
2055
1303
def Fingerprint_dbus_property(self):
2056
1304
return dbus.String(self.fingerprint)
2057
1305
2058
1306
# Host - property
2059
@dbus_service_property(_interface,
2060
signature="s",
1307
@dbus_service_property(_interface, signature="s",
2061
1308
access="readwrite")
2062
1309
def Host_dbus_property(self, value=None):
2063
1310
if value is None: # get
2064
1311
return dbus.String(self.host)
2065
self.host = str(value)
2066
1312
self.host = unicode(value)
1313
2067
1314
# Created - property
2068
@dbus_annotations(
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
1315
@dbus_service_property(_interface, signature="s", access="read")
2071
1316
def Created_dbus_property(self):
2072
1317
return datetime_to_dbus(self.created)
2073
1318
2074
1319
# LastEnabled - property
2075
1320
@dbus_service_property(_interface, signature="s", access="read")
2076
1321
def LastEnabled_dbus_property(self):
2077
1322
return datetime_to_dbus(self.last_enabled)
2078
1323
2079
1324
# Enabled - property
2080
@dbus_service_property(_interface,
2081
signature="b",
1325
@dbus_service_property(_interface, signature="b",
2082
1326
access="readwrite")
2083
1327
def Enabled_dbus_property(self, value=None):
2084
1328
if value is None: # get
2087
1331
self.enable()
2088
1332
else:
2089
1333
self.disable()
2090
1334
2091
1335
# LastCheckedOK - property
2092
@dbus_service_property(_interface,
2093
signature="s",
1336
@dbus_service_property(_interface, signature="s",
2094
1337
access="readwrite")
2095
1338
def LastCheckedOK_dbus_property(self, value=None):
2096
1339
if value is not None:
2097
1340
self.checked_ok()
2098
1341
return
2099
1342
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
1343
2106
1344
# Expires - property
2107
1345
@dbus_service_property(_interface, signature="s", access="read")
2108
1346
def Expires_dbus_property(self):
2109
1347
return datetime_to_dbus(self.expires)
2110
1348
2111
1349
# LastApprovalRequest - property
2112
1350
@dbus_service_property(_interface, signature="s", access="read")
2113
1351
def LastApprovalRequest_dbus_property(self):
2114
1352
return datetime_to_dbus(self.last_approval_request)
2115
1353
2116
1354
# Timeout - property
2117
@dbus_service_property(_interface,
2118
signature="t",
1355
@dbus_service_property(_interface, signature="t",
2119
1356
access="readwrite")
2120
1357
def Timeout_dbus_property(self, value=None):
2121
1358
if value is None: # get
2122
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2123
old_timeout = self.timeout
1359
return dbus.UInt64(self.timeout_milliseconds())
2124
1360
self.timeout = datetime.timedelta(0, 0, 0, value)
2125
# Reschedule disabling
2126
if self.enabled:
2127
now = datetime.datetime.utcnow()
2128
self.expires += self.timeout - old_timeout
2129
if self.expires <= now:
2130
# The timeout has passed
2131
self.disable()
2132
else:
2133
if (getattr(self, "disable_initiator_tag", None)
2134
is None):
2135
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
1361
if getattr(self, "disable_initiator_tag", None) is None:
1362
return
1363
# Reschedule timeout
1364
gobject.source_remove(self.disable_initiator_tag)
1365
self.disable_initiator_tag = None
1366
self.expires = None
1367
time_to_die = timedelta_to_milliseconds((self
1368
.last_checked_ok
1369
+ self.timeout)
1370
- datetime.datetime
1371
.utcnow())
1372
if time_to_die <= 0:
1373
# The timeout has passed
1374
self.disable()
1375
else:
1376
self.expires = (datetime.datetime.utcnow()
1377
+ datetime.timedelta(milliseconds =
1378
time_to_die))
1379
self.disable_initiator_tag = (gobject.timeout_add
1380
(time_to_die, self.disable))
1381
2141
1382
# ExtendedTimeout - property
2142
@dbus_service_property(_interface,
2143
signature="t",
1383
@dbus_service_property(_interface, signature="t",
2144
1384
access="readwrite")
2145
1385
def ExtendedTimeout_dbus_property(self, value=None):
2146
1386
if value is None: # get
2147
return dbus.UInt64(self.extended_timeout.total_seconds()
2148
* 1000)
1387
return dbus.UInt64(self.extended_timeout_milliseconds())
2149
1388
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2150
1389
2151
1390
# Interval - property
2152
@dbus_service_property(_interface,
2153
signature="t",
1391
@dbus_service_property(_interface, signature="t",
2154
1392
access="readwrite")
2155
1393
def Interval_dbus_property(self, value=None):
2156
1394
if value is None: # get
2157
return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
return dbus.UInt64(self.interval_milliseconds())
2158
1396
self.interval = datetime.timedelta(0, 0, 0, value)
2159
1397
if getattr(self, "checker_initiator_tag", None) is None:
2160
1398
return
2161
1399
if self.enabled:
2162
1400
# 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
1401
gobject.source_remove(self.checker_initiator_tag)
1402
self.checker_initiator_tag = (gobject.timeout_add
1403
(value, self.start_checker))
1404
self.start_checker() # Start one now, too
1405
2168
1406
# Checker - property
2169
@dbus_service_property(_interface,
2170
signature="s",
1407
@dbus_service_property(_interface, signature="s",
2171
1408
access="readwrite")
2172
1409
def Checker_dbus_property(self, value=None):
2173
1410
if value is None: # get
2174
1411
return dbus.String(self.checker_command)
2175
self.checker_command = str(value)
2176
1412
self.checker_command = unicode(value)
1413
2177
1414
# CheckerRunning - property
2178
@dbus_service_property(_interface,
2179
signature="b",
1415
@dbus_service_property(_interface, signature="b",
2180
1416
access="readwrite")
2181
1417
def CheckerRunning_dbus_property(self, value=None):
2182
1418
if value is None: # get
2185
1421
self.start_checker()
2186
1422
else:
2187
1423
self.stop_checker()
2188
1424
2189
1425
# ObjectPath - property
2190
@dbus_annotations(
2191
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2192
"org.freedesktop.DBus.Deprecated": "true"})
2193
1426
@dbus_service_property(_interface, signature="o", access="read")
2194
1427
def ObjectPath_dbus_property(self):
2195
return self.dbus_object_path # is already a dbus.ObjectPath
2196
1428
return self.dbus_object_path # is already a dbus.ObjectPath
1429
2197
1430
# 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)
1431
@dbus_service_property(_interface, signature="ay",
1432
access="write", byte_arrays=True)
2205
1433
def Secret_dbus_property(self, value):
2206
self.secret = bytes(value)
2207
1434
self.secret = str(value)
1435
2208
1436
del _interface
2209
1437
2210
1438
2211
1439
class ProxyClient(object):
2212
def __init__(self, child_pipe, key_id, fpr, address):
1440
def __init__(self, child_pipe, fpr, address):
2213
1441
self._pipe = child_pipe
2214
self._pipe.send(('init', key_id, fpr, address))
1442
self._pipe.send(('init', fpr, address))
2215
1443
if not self._pipe.recv():
2216
raise KeyError(key_id or fpr)
2217
1444
raise KeyError()
1445
2218
1446
def __getattribute__(self, name):
2219
1447
if name == '_pipe':
2220
1448
return super(ProxyClient, self).__getattribute__(name)
2223
1451
if data[0] == 'data':
2224
1452
return data[1]
2225
1453
if data[0] == 'function':
2226
2227
1454
def func(*args, **kwargs):
2228
1455
self._pipe.send(('funcall', name, args, kwargs))
2229
1456
return self._pipe.recv()[1]
2230
2231
1457
return func
2232
1458
2233
1459
def __setattr__(self, name, value):
2234
1460
if name == '_pipe':
2235
1461
return super(ProxyClient, self).__setattr__(name, value)
2236
1462
self._pipe.send(('setattr', name, value))
2237
1463
2238
1464
1465
class ClientDBusTransitional(ClientDBus):
1466
__metaclass__ = AlternateDBusNamesMetaclass
1467
1468
2239
1469
class ClientHandler(socketserver.BaseRequestHandler, object):
2240
1470
"""A class to handle client connections.
2241
1471
2242
1472
Instantiated once for each connection to handle it.
2243
1473
Note: This will run in its own forked process."""
2244
1474
2245
1475
def handle(self):
2246
1476
with contextlib.closing(self.server.child_pipe) as child_pipe:
2247
1477
logger.info("TCP connection from: %s",
2248
str(self.client_address))
1478
unicode(self.client_address))
2249
1479
logger.debug("Pipe FD: %d",
2250
1480
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"))
1481
1482
session = (gnutls.connection
1483
.ClientSession(self.request,
1484
gnutls.connection
1485
.X509Credentials()))
1486
1487
# Note: gnutls.connection.X509Credentials is really a
1488
# generic GnuTLS certificate credentials object so long as
1489
# no X.509 keys are added to it. Therefore, we can use it
1490
# here despite using OpenPGP certificates.
1491
1492
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1493
# "+AES-256-CBC", "+SHA1",
1494
# "+COMP-NULL", "+CTYPE-OPENPGP",
1495
# "+DHE-DSS"))
2258
1496
# Use a fallback default, since this MUST be set.
2259
1497
priority = self.server.gnutls_priority
2260
1498
if priority is None:
2261
1499
priority = "NORMAL"
2262
gnutls.priority_set_direct(session._c_object,
2263
priority.encode("utf-8"),
2264
None)
2265
1500
(gnutls.library.functions
1501
.gnutls_priority_set_direct(session._c_object,
1502
priority, None))
1503
2266
1504
# Start communication using the Mandos protocol
2267
1505
# Get protocol number
2268
1506
line = self.request.makefile().readline()
2269
1507
logger.debug("Protocol version: %r", line)
2270
1508
try:
2271
1509
if int(line.strip().split()[0]) > 1:
2272
raise RuntimeError(line)
1510
raise RuntimeError
2273
1511
except (ValueError, IndexError, RuntimeError) as error:
2274
1512
logger.error("Unknown protocol version: %s", error)
2275
1513
return
2276
1514
2277
1515
# Start GnuTLS connection
2278
1516
try:
2279
1517
session.handshake()
2280
except gnutls.Error as error:
1518
except gnutls.errors.GNUTLSError as error:
2281
1519
logger.warning("Handshake failed: %s", error)
2282
1520
# Do not run session.bye() here: the session is not
2283
1521
# established. Just abandon the request.
2284
1522
return
2285
1523
logger.debug("Handshake succeeded")
2286
1524
2287
1525
approval_required = False
2288
1526
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,
1527
try:
1528
fpr = self.fingerprint(self.peer_certificate
1529
(session))
1530
except (TypeError,
1531
gnutls.errors.GNUTLSError) as error:
1532
logger.warning("Bad certificate: %s", error)
1533
return
1534
logger.debug("Fingerprint: %s", fpr)
1535
1536
try:
1537
client = ProxyClient(child_pipe, fpr,
2311
1538
self.client_address)
2312
1539
except KeyError:
2313
1540
return
2314
1541
1542
if self.server.use_dbus:
1543
# Emit D-Bus signal
1544
client.NewRequest(str(self.client_address))
1545
2315
1546
if client.approval_delay:
2316
1547
delay = client.approval_delay
2317
1548
client.approvals_pending += 1
2318
1549
approval_required = True
2319
1550
2320
1551
while True:
2321
1552
if not client.enabled:
2322
1553
logger.info("Client %s is disabled",
2323
client.name)
1554
client.name)
2324
1555
if self.server.use_dbus:
2325
1556
# Emit D-Bus signal
2326
1557
client.Rejected("Disabled")
2327
1558
return
2328
1559
2329
1560
if client.approved or not client.approval_delay:
2330
# We are approved or approval is disabled
1561
#We are approved or approval is disabled
2331
1562
break
2332
1563
elif client.approved is None:
2333
1564
logger.info("Client %s needs approval",
2335
1566
if self.server.use_dbus:
2336
1567
# Emit D-Bus signal
2337
1568
client.NeedApproval(
2338
client.approval_delay.total_seconds()
2339
* 1000, client.approved_by_default)
1569
client.approval_delay_milliseconds(),
1570
client.approved_by_default)
2340
1571
else:
2341
1572
logger.warning("Client %s was not approved",
2342
1573
client.name)
2344
1575
# Emit D-Bus signal
2345
1576
client.Rejected("Denied")
2346
1577
return
2347
2348
# wait until timeout or approved
1578
1579
#wait until timeout or approved
2349
1580
time = datetime.datetime.now()
2350
1581
client.changedstate.acquire()
2351
client.changedstate.wait(delay.total_seconds())
1582
(client.changedstate.wait
1583
(float(client.timedelta_to_milliseconds(delay)
1584
/ 1000)))
2352
1585
client.changedstate.release()
2353
1586
time2 = datetime.datetime.now()
2354
1587
if (time2 - time) >= delay:
2364
1597
break
2365
1598
else:
2366
1599
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
1600
1601
sent_size = 0
1602
while sent_size < len(client.secret):
1603
try:
1604
sent = session.send(client.secret[sent_size:])
1605
except gnutls.errors.GNUTLSError as error:
1606
logger.warning("gnutls send failed")
1607
return
1608
logger.debug("Sent: %d, remaining: %d",
1609
sent, len(client.secret)
1610
- (sent_size + sent))
1611
sent_size += sent
1612
2375
1613
logger.info("Sending secret to %s", client.name)
2376
1614
# bump the timeout using extended_timeout
2377
client.bump_timeout(client.extended_timeout)
1615
client.checked_ok(client.extended_timeout)
2378
1616
if self.server.use_dbus:
2379
1617
# Emit D-Bus signal
2380
1618
client.GotSecret()
2381
1619
2382
1620
finally:
2383
1621
if approval_required:
2384
1622
client.approvals_pending -= 1
2385
1623
try:
2386
1624
session.bye()
2387
except gnutls.Error as error:
2388
logger.warning("GnuTLS bye failed",
2389
exc_info=error)
2390
1625
except gnutls.errors.GNUTLSError as error:
1626
logger.warning("GnuTLS bye failed")
1627
2391
1628
@staticmethod
2392
1629
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""
1630
"Return the peer's OpenPGP certificate as a bytestring"
1631
# If not an OpenPGP certificate...
1632
if (gnutls.library.functions
1633
.gnutls_certificate_type_get(session._c_object)
1634
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1635
# ...do the normal thing
1636
return session.peer_certificate
2409
1637
list_size = ctypes.c_uint(1)
2410
cert_list = (gnutls.certificate_get_peers
1638
cert_list = (gnutls.library.functions
1639
.gnutls_certificate_get_peers
2411
1640
(session._c_object, ctypes.byref(list_size)))
2412
1641
if not bool(cert_list) and list_size.value != 0:
2413
raise gnutls.Error("error getting peer certificate")
1642
raise gnutls.errors.GNUTLSError("error getting peer"
1643
" certificate")
2414
1644
if list_size.value == 0:
2415
1645
return None
2416
1646
cert = cert_list[0]
2417
1647
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
1648
2453
1649
@staticmethod
2454
1650
def fingerprint(openpgp):
2455
1651
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2456
1652
# 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)))
1653
datum = (gnutls.library.types
1654
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1655
ctypes.POINTER
1656
(ctypes.c_ubyte)),
1657
ctypes.c_uint(len(openpgp))))
2461
1658
# New empty GnuTLS certificate
2462
crt = gnutls.openpgp_crt_t()
2463
gnutls.openpgp_crt_init(ctypes.byref(crt))
1659
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1660
(gnutls.library.functions
1661
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2464
1662
# Import the OpenPGP public key into the certificate
2465
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2466
gnutls.OPENPGP_FMT_RAW)
1663
(gnutls.library.functions
1664
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1665
gnutls.library.constants
1666
.GNUTLS_OPENPGP_FMT_RAW))
2467
1667
# Verify the self signature in the key
2468
1668
crtverify = ctypes.c_uint()
2469
gnutls.openpgp_crt_verify_self(crt, 0,
2470
ctypes.byref(crtverify))
1669
(gnutls.library.functions
1670
.gnutls_openpgp_crt_verify_self(crt, 0,
1671
ctypes.byref(crtverify)))
2471
1672
if crtverify.value != 0:
2472
gnutls.openpgp_crt_deinit(crt)
2473
raise gnutls.CertificateSecurityError(code
2474
=crtverify.value)
1673
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1674
raise (gnutls.errors.CertificateSecurityError
1675
("Verify failed"))
2475
1676
# New buffer for the fingerprint
2476
1677
buf = ctypes.create_string_buffer(20)
2477
1678
buf_len = ctypes.c_size_t()
2478
1679
# Get the fingerprint from the certificate into the buffer
2479
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2480
ctypes.byref(buf_len))
1680
(gnutls.library.functions
1681
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1682
ctypes.byref(buf_len)))
2481
1683
# Deinit the certificate
2482
gnutls.openpgp_crt_deinit(crt)
1684
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2483
1685
# Convert the buffer to a Python bytestring
2484
1686
fpr = ctypes.string_at(buf, buf_len.value)
2485
1687
# Convert the bytestring to hexadecimal notation
2489
1691
2490
1692
class MultiprocessingMixIn(object):
2491
1693
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2492
2493
1694
def sub_process_main(self, request, address):
2494
1695
try:
2495
1696
self.finish_request(request, address)
2496
1697
except Exception:
2497
1698
self.handle_error(request, address)
2498
1699
self.close_request(request)
2499
1700
2500
1701
def process_request(self, request, address):
2501
1702
"""Start a new process to process the request."""
2502
proc = multiprocessing.Process(target=self.sub_process_main,
2503
args=(request, address))
1703
proc = multiprocessing.Process(target = self.sub_process_main,
1704
args = (request,
1705
address))
2504
1706
proc.start()
2505
1707
return proc
2506
1708
2507
1709
2508
1710
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2509
1711
""" adds a pipe to the MixIn """
2510
2511
1712
def process_request(self, request, client_address):
2512
1713
"""Overrides and wraps the original process_request().
2513
1714
2514
1715
This function creates a new pipe in self.pipe
2515
1716
"""
2516
1717
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2517
1718
2518
1719
proc = MultiprocessingMixIn.process_request(self, request,
2519
1720
client_address)
2520
1721
self.child_pipe.close()
2521
1722
self.add_pipe(parent_pipe, proc)
2522
1723
2523
1724
def add_pipe(self, parent_pipe, proc):
2524
1725
"""Dummy function; override as necessary"""
2525
raise NotImplementedError()
1726
raise NotImplementedError
2526
1727
2527
1728
2528
1729
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2529
1730
socketserver.TCPServer, object):
2530
1731
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2531
1732
2532
1733
Attributes:
2533
1734
enabled: Boolean; whether this server is activated yet
2534
1735
interface: None or a network interface name (string)
2535
1736
use_ipv6: Boolean; to use IPv6 or not
2536
1737
"""
2537
2538
1738
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
"""
1739
interface=None, use_ipv6=True):
2545
1740
self.interface = interface
2546
1741
if use_ipv6:
2547
1742
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
1743
socketserver.TCPServer.__init__(self, server_address,
2576
1744
RequestHandlerClass)
2577
2578
1745
def server_bind(self):
2579
1746
"""This overrides the normal server_bind() function
2580
1747
to bind to an interface if one was specified, and also NOT to
2581
1748
bind to an address or port if they were not specified."""
2582
global SO_BINDTODEVICE
2583
1749
if self.interface is not None:
2584
1750
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
1751
logger.error("SO_BINDTODEVICE does not exist;"
1752
" cannot bind to interface %s",
1753
self.interface)
1754
else:
1755
try:
1756
self.socket.setsockopt(socket.SOL_SOCKET,
1757
SO_BINDTODEVICE,
1758
str(self.interface
1759
+ '\0'))
1760
except socket.error as error:
1761
if error[0] == errno.EPERM:
1762
logger.error("No permission to"
1763
" bind to interface %s",
1764
self.interface)
1765
elif error[0] == errno.ENOPROTOOPT:
1766
logger.error("SO_BINDTODEVICE not available;"
1767
" cannot bind to interface %s",
1768
self.interface)
1769
else:
1770
raise
2606
1771
# Only bind(2) the socket if we really need to.
2607
1772
if self.server_address[0] or self.server_address[1]:
2608
1773
if not self.server_address[0]:
2609
1774
if self.address_family == socket.AF_INET6:
2610
any_address = "::" # in6addr_any
1775
any_address = "::" # in6addr_any
2611
1776
else:
2612
any_address = "0.0.0.0" # INADDR_ANY
1777
any_address = socket.INADDR_ANY
2613
1778
self.server_address = (any_address,
2614
1779
self.server_address[1])
2615
1780
elif not self.server_address[1]:
2616
self.server_address = (self.server_address[0], 0)
1781
self.server_address = (self.server_address[0],
1782
0)
2617
1783
# if self.interface:
2618
1784
# self.server_address = (self.server_address[0],
2619
1785
# 0, # port
2625
1791
2626
1792
class MandosServer(IPv6_TCPServer):
2627
1793
"""Mandos server.
2628
1794
2629
1795
Attributes:
2630
1796
clients: set of Client objects
2631
1797
gnutls_priority GnuTLS priority string
2632
1798
use_dbus: Boolean; to emit D-Bus signals or not
2633
2634
Assumes a GLib.MainLoop event loop.
1799
1800
Assumes a gobject.MainLoop event loop.
2635
1801
"""
2636
2637
1802
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):
1803
interface=None, use_ipv6=True, clients=None,
1804
gnutls_priority=None, use_dbus=True):
2644
1805
self.enabled = False
2645
1806
self.clients = clients
2646
1807
if self.clients is None:
2649
1810
self.gnutls_priority = gnutls_priority
2650
1811
IPv6_TCPServer.__init__(self, server_address,
2651
1812
RequestHandlerClass,
2652
interface=interface,
2653
use_ipv6=use_ipv6,
2654
socketfd=socketfd)
2655
1813
interface = interface,
1814
use_ipv6 = use_ipv6)
2656
1815
def server_activate(self):
2657
1816
if self.enabled:
2658
1817
return socketserver.TCPServer.server_activate(self)
2659
1818
2660
1819
def enable(self):
2661
1820
self.enabled = True
2662
1821
2663
1822
def add_pipe(self, parent_pipe, proc):
2664
1823
# 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):
1824
gobject.io_add_watch(parent_pipe.fileno(),
1825
gobject.IO_IN | gobject.IO_HUP,
1826
functools.partial(self.handle_ipc,
1827
parent_pipe =
1828
parent_pipe,
1829
proc = proc))
1830
1831
def handle_ipc(self, source, condition, parent_pipe=None,
1832
proc = None, client_object=None):
1833
condition_names = {
1834
gobject.IO_IN: "IN", # There is data to read.
1835
gobject.IO_OUT: "OUT", # Data can be written (without
1836
# blocking).
1837
gobject.IO_PRI: "PRI", # There is urgent data to read.
1838
gobject.IO_ERR: "ERR", # Error condition.
1839
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1840
# broken, usually for pipes and
1841
# sockets).
1842
}
1843
conditions_string = ' | '.join(name
1844
for cond, name in
1845
condition_names.iteritems()
1846
if cond & condition)
2676
1847
# error, or the other end of multiprocessing.Pipe has closed
2677
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1848
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2678
1849
# Wait for other process to exit
2679
1850
proc.join()
2680
1851
return False
2681
1852
2682
1853
# Read a request from the child
2683
1854
request = parent_pipe.recv()
2684
1855
command = request[0]
2685
1856
2686
1857
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:
1858
fpr = request[1]
1859
address = request[2]
1860
1861
for c in self.clients.itervalues():
1862
if c.fingerprint == fpr:
2698
1863
client = c
2699
1864
break
2700
1865
else:
2701
logger.info("Client not found for key ID: %s, address"
2702
": %s", key_id or fpr, address)
1866
logger.info("Client not found for fingerprint: %s, ad"
1867
"dress: %s", fpr, address)
2703
1868
if self.use_dbus:
2704
1869
# Emit D-Bus signal
2705
mandos_dbus_service.ClientNotFound(key_id or fpr,
1870
mandos_dbus_service.ClientNotFound(fpr,
2706
1871
address[0])
2707
1872
parent_pipe.send(False)
2708
1873
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))
1874
1875
gobject.io_add_watch(parent_pipe.fileno(),
1876
gobject.IO_IN | gobject.IO_HUP,
1877
functools.partial(self.handle_ipc,
1878
parent_pipe =
1879
parent_pipe,
1880
proc = proc,
1881
client_object =
1882
client))
2717
1883
parent_pipe.send(True)
2718
1884
# remove the old hook in favor of the new above hook on
2719
1885
# same fileno
2722
1888
funcname = request[1]
2723
1889
args = request[2]
2724
1890
kwargs = request[3]
2725
1891
2726
1892
parent_pipe.send(('data', getattr(client_object,
2727
1893
funcname)(*args,
2728
**kwargs)))
2729
1894
**kwargs)))
1895
2730
1896
if command == 'getattr':
2731
1897
attrname = request[1]
2732
if isinstance(client_object.__getattribute__(attrname),
2733
collections.Callable):
2734
parent_pipe.send(('function', ))
1898
if callable(client_object.__getattribute__(attrname)):
1899
parent_pipe.send(('function',))
2735
1900
else:
2736
parent_pipe.send((
2737
'data', client_object.__getattribute__(attrname)))
2738
1901
parent_pipe.send(('data', client_object
1902
.__getattribute__(attrname)))
1903
2739
1904
if command == 'setattr':
2740
1905
attrname = request[1]
2741
1906
value = request[2]
2742
1907
setattr(client_object, attrname, value)
2743
1908
2744
1909
return True
2745
1910
2746
1911
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
1912
def string_to_delta(interval):
2847
1913
"""Parse a string and return a datetime.timedelta
2848
1914
2849
1915
>>> string_to_delta('7d')
2850
1916
datetime.timedelta(7)
2851
1917
>>> string_to_delta('60s')
2859
1925
>>> string_to_delta('5m 30s')
2860
1926
datetime.timedelta(0, 330)
2861
1927
"""
2862
2863
try:
2864
return rfc3339_duration_to_delta(interval)
2865
except ValueError:
2866
pass
2867
2868
1928
timevalue = datetime.timedelta(0)
2869
1929
for s in interval.split():
2870
1930
try:
2871
suffix = s[-1]
1931
suffix = unicode(s[-1])
2872
1932
value = int(s[:-1])
2873
1933
if suffix == "d":
2874
1934
delta = datetime.timedelta(value)
2881
1941
elif suffix == "w":
2882
1942
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2883
1943
else:
2884
raise ValueError("Unknown suffix {!r}".format(suffix))
2885
except IndexError as e:
1944
raise ValueError("Unknown suffix %r" % suffix)
1945
except (ValueError, IndexError) as e:
2886
1946
raise ValueError(*(e.args))
2887
1947
timevalue += delta
2888
1948
return timevalue
2889
1949
2890
1950
2891
def daemon(nochdir=False, noclose=False):
1951
def daemon(nochdir = False, noclose = False):
2892
1952
"""See daemon(3). Standard BSD Unix function.
2893
1953
2894
1954
This should really exist as os.daemon, but it doesn't (yet)."""
2895
1955
if os.fork():
2896
1956
sys.exit()
2901
1961
sys.exit()
2902
1962
if not noclose:
2903
1963
# Close all standard open file descriptors
2904
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1964
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2905
1965
if not stat.S_ISCHR(os.fstat(null).st_mode):
2906
1966
raise OSError(errno.ENODEV,
2907
"{} not a character device"
2908
.format(os.devnull))
1967
"%s not a character device"
1968
% os.path.devnull)
2909
1969
os.dup2(null, sys.stdin.fileno())
2910
1970
os.dup2(null, sys.stdout.fileno())
2911
1971
os.dup2(null, sys.stderr.fileno())
2914
1974
2915
1975
2916
1976
def main():
2917
1977
2918
1978
##################################################################
2919
1979
# Parsing of options, both command line and config file
2920
1980
2921
1981
parser = argparse.ArgumentParser()
2922
1982
parser.add_argument("-v", "--version", action="version",
2923
version="%(prog)s {}".format(version),
1983
version = "%%(prog)s %s" % version,
2924
1984
help="show version number and exit")
2925
1985
parser.add_argument("-i", "--interface", metavar="IF",
2926
1986
help="Bind to interface IF")
2932
1992
help="Run self-test")
2933
1993
parser.add_argument("--debug", action="store_true",
2934
1994
help="Debug mode; run in foreground and log"
2935
" to terminal", default=None)
1995
" to terminal")
2936
1996
parser.add_argument("--debuglevel", metavar="LEVEL",
2937
1997
help="Debug level for stdout output")
2938
1998
parser.add_argument("--priority", help="GnuTLS"
2945
2005
" files")
2946
2006
parser.add_argument("--no-dbus", action="store_false",
2947
2007
dest="use_dbus", help="Do not provide D-Bus"
2948
" system bus interface", default=None)
2008
" system bus interface")
2949
2009
parser.add_argument("--no-ipv6", action="store_false",
2950
dest="use_ipv6", help="Do not use IPv6",
2951
default=None)
2010
dest="use_ipv6", help="Do not use IPv6")
2952
2011
parser.add_argument("--no-restore", action="store_false",
2953
2012
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")
2013
" state")
2958
2014
parser.add_argument("--statedir", metavar="DIR",
2959
2015
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
2016
2966
2017
options = parser.parse_args()
2967
2018
2968
2019
if options.check:
2969
2020
import doctest
2970
fail_count, test_count = doctest.testmod()
2971
sys.exit(os.EX_OK if fail_count == 0 else 1)
2972
2021
doctest.testmod()
2022
sys.exit()
2023
2973
2024
# 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
2025
server_defaults = { "interface": "",
2026
"address": "",
2027
"port": "",
2028
"debug": "False",
2029
"priority":
2030
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2031
"servicename": "Mandos",
2032
"use_dbus": "True",
2033
"use_ipv6": "True",
2034
"debuglevel": "",
2035
"restore": "True",
2036
"statedir": "/var/lib/mandos"
2037
}
2038
2997
2039
# Parse config file for server-global settings
2998
2040
server_config = configparser.SafeConfigParser(server_defaults)
2999
2041
del server_defaults
3000
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2042
server_config.read(os.path.join(options.configdir,
2043
"mandos.conf"))
3001
2044
# Convert the SafeConfigParser object to a dict
3002
2045
server_settings = server_config.defaults()
3003
2046
# Use the appropriate methods on the non-string config options
3004
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3005
"foreground", "zeroconf"):
2047
for option in ("debug", "use_dbus", "use_ipv6"):
3006
2048
server_settings[option] = server_config.getboolean("DEFAULT",
3007
2049
option)
3008
2050
if server_settings["port"]:
3009
2051
server_settings["port"] = server_config.getint("DEFAULT",
3010
2052
"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
2053
del server_config
3021
2054
3022
2055
# Override the settings from the config file with command line
3023
2056
# options, if set.
3024
2057
for option in ("interface", "address", "port", "debug",
3025
"priority", "servicename", "configdir", "use_dbus",
3026
"use_ipv6", "debuglevel", "restore", "statedir",
3027
"socket", "foreground", "zeroconf"):
2058
"priority", "servicename", "configdir",
2059
"use_dbus", "use_ipv6", "debuglevel", "restore",
2060
"statedir"):
3028
2061
value = getattr(options, option)
3029
2062
if value is not None:
3030
2063
server_settings[option] = value
3031
2064
del options
3032
2065
# Force all strings to be unicode
3033
2066
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
2067
if type(server_settings[option]) is str:
2068
server_settings[option] = unicode(server_settings[option])
3044
2069
# Now we have our good server settings in "server_settings"
3045
2070
3046
2071
##################################################################
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
2072
3053
2073
# For convenience
3054
2074
debug = server_settings["debug"]
3055
2075
debuglevel = server_settings["debuglevel"]
3057
2077
use_ipv6 = server_settings["use_ipv6"]
3058
2078
stored_state_path = os.path.join(server_settings["statedir"],
3059
2079
stored_state_file)
3060
foreground = server_settings["foreground"]
3061
zeroconf = server_settings["zeroconf"]
3062
2080
3063
2081
if debug:
3064
2082
initlogger(debug, logging.DEBUG)
3065
2083
else:
3068
2086
else:
3069
2087
level = getattr(logging, debuglevel.upper())
3070
2088
initlogger(debug, level)
3071
2089
3072
2090
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
2091
syslogger.setFormatter(logging.Formatter
2092
('Mandos (%s) [%%(process)d]:'
2093
' %%(levelname)s: %%(message)s'
2094
% server_settings["servicename"]))
2095
3078
2096
# Parse config file with clients
3079
client_config = configparser.SafeConfigParser(Client
3080
.client_defaults)
2097
client_config = configparser.SafeConfigParser(Client.client_defaults)
3081
2098
client_config.read(os.path.join(server_settings["configdir"],
3082
2099
"clients.conf"))
3083
2100
3084
2101
global mandos_dbus_service
3085
2102
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
2103
2104
tcp_server = MandosServer((server_settings["address"],
2105
server_settings["port"]),
2106
ClientHandler,
2107
interface=(server_settings["interface"]
2108
or None),
2109
use_ipv6=use_ipv6,
2110
gnutls_priority=
2111
server_settings["priority"],
2112
use_dbus=use_dbus)
2113
if not debug:
2114
pidfilename = "/var/run/mandos.pid"
2115
try:
2116
pidfile = open(pidfilename, "w")
2117
except IOError:
2118
logger.error("Could not open file %r", pidfilename)
2119
2120
try:
2121
uid = pwd.getpwnam("_mandos").pw_uid
2122
gid = pwd.getpwnam("_mandos").pw_gid
2123
except KeyError:
2124
try:
2125
uid = pwd.getpwnam("mandos").pw_uid
2126
gid = pwd.getpwnam("mandos").pw_gid
3116
2127
except KeyError:
3117
continue
3118
else:
3119
uid = 65534
3120
gid = 65534
2128
try:
2129
uid = pwd.getpwnam("nobody").pw_uid
2130
gid = pwd.getpwnam("nobody").pw_gid
2131
except KeyError:
2132
uid = 65534
2133
gid = 65534
3121
2134
try:
3122
2135
os.setgid(gid)
3123
2136
os.setuid(uid)
3124
if debug:
3125
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3126
gid))
3127
2137
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
2138
if error[0] != errno.EPERM:
2139
raise error
2140
3133
2141
if debug:
3134
2142
# Enable all possible GnuTLS debugging
3135
2143
3136
2144
# "Use a log level over 10 to enable all debugging options."
3137
2145
# - GnuTLS manual
3138
gnutls.global_set_log_level(11)
3139
3140
@gnutls.log_func
2146
gnutls.library.functions.gnutls_global_set_log_level(11)
2147
2148
@gnutls.library.types.gnutls_log_func
3141
2149
def debug_gnutls(level, string):
3142
2150
logger.debug("GnuTLS: %s", string[:-1])
3143
3144
gnutls.global_set_log_function(debug_gnutls)
3145
2151
2152
(gnutls.library.functions
2153
.gnutls_global_set_log_function(debug_gnutls))
2154
3146
2155
# Redirect stdin so all checkers get /dev/null
3147
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3148
2157
os.dup2(null, sys.stdin.fileno())
3149
2158
if null > 2:
3150
2159
os.close(null)
3151
2160
3152
2161
# Need to fork before connecting to D-Bus
3153
if not foreground:
2162
if not debug:
3154
2163
# Close all input and output, do double fork, etc.
3155
2164
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
2165
2166
gobject.threads_init()
2167
3161
2168
global main_loop
3162
2169
# From the Avahi example code
3163
DBusGMainLoop(set_as_default=True)
3164
main_loop = GLib.MainLoop()
2170
DBusGMainLoop(set_as_default=True )
2171
main_loop = gobject.MainLoop()
3165
2172
bus = dbus.SystemBus()
3166
2173
# End of Avahi example code
3167
2174
if use_dbus:
3168
2175
try:
3169
2176
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)
2177
bus, do_not_queue=True)
2178
old_bus_name = (dbus.service.BusName
2179
("se.bsnet.fukt.Mandos", bus,
2180
do_not_queue=True))
2181
except dbus.exceptions.NameExistsException as e:
2182
logger.error(unicode(e) + ", disabling D-Bus")
3177
2183
use_dbus = False
3178
2184
server_settings["use_dbus"] = False
3179
2185
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
2186
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2187
service = AvahiServiceToSyslog(name =
2188
server_settings["servicename"],
2189
servicetype = "_mandos._tcp",
2190
protocol = protocol, bus = bus)
2191
if server_settings["interface"]:
2192
service.interface = (if_nametoindex
2193
(str(server_settings["interface"])))
2194
3191
2195
global multiprocessing_manager
3192
2196
multiprocessing_manager = multiprocessing.Manager()
3193
2197
3194
2198
client_class = Client
3195
2199
if use_dbus:
3196
client_class = functools.partial(ClientDBus, bus=bus)
3197
2200
client_class = functools.partial(ClientDBusTransitional,
2201
bus = bus)
2202
3198
2203
client_settings = Client.config_parser(client_config)
3199
2204
old_client_settings = {}
3200
2205
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
2206
3210
2207
# Get client data and settings from last running state.
3211
2208
if server_settings["restore"]:
3212
2209
try:
3213
2210
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"))
2211
clients_data, old_client_settings = (pickle.load
2212
(stored_state))
3263
2213
os.remove(stored_state_path)
3264
2214
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)
2215
logger.warning("Could not load persistent state: {0}"
2216
.format(e))
2217
if e.errno != errno.ENOENT:
3271
2218
raise
3272
2219
except EOFError as e:
3273
2220
logger.warning("Could not load persistent state: "
3274
"EOFError:",
3275
exc_info=e)
3276
2221
"EOFError: {0}".format(e))
2222
3277
2223
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
2224
for client_name, client in clients_data.iteritems():
3283
2225
# Decide which value to use after restoring saved state.
3284
2226
# We have three different values: Old config file,
3285
2227
# new config file, and saved state.
3290
2232
# For each value in new config, check if it
3291
2233
# differs from the old config value (Except for
3292
2234
# the "secret" attribute)
3293
if (name != "secret"
3294
and (value !=
3295
old_client_settings[client_name][name])):
2235
if (name != "secret" and
2236
value != old_client_settings[client_name]
2237
[name]):
3296
2238
client[name] = value
3297
2239
except KeyError:
3298
2240
pass
3299
2241
3300
2242
# 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.
2243
# enabled if its last checker was successful. Clients
2244
# whose checker failed before we stored its state is
2245
# assumed to have failed all checkers during downtime.
3305
2246
if client["enabled"]:
3306
2247
if datetime.datetime.utcnow() >= client["expires"]:
3307
2248
if not client["last_checked_ok"]:
3308
2249
logger.warning(
3309
"disabling client {} - Client never "
3310
"performed a successful checker".format(
3311
client_name))
2250
"disabling client {0} - Client never "
2251
"performed a successfull checker"
2252
.format(client["name"]))
3312
2253
client["enabled"] = False
3313
2254
elif client["last_checker_status"] != 0:
3314
2255
logger.warning(
3315
"disabling client {} - Client last"
3316
" checker failed with error code"
3317
" {}".format(
3318
client_name,
3319
client["last_checker_status"]))
2256
"disabling client {0} - Client "
2257
"last checker failed with error code {1}"
2258
.format(client["name"],
2259
client["last_checker_status"]))
3320
2260
client["enabled"] = False
3321
2261
else:
3322
client["expires"] = (
3323
datetime.datetime.utcnow()
3324
+ client["timeout"])
3325
logger.debug("Last checker succeeded,"
3326
" keeping {} enabled".format(
3327
client_name))
2262
client["expires"] = (datetime.datetime
2263
.utcnow()
2264
+ client["timeout"])
2265
3328
2266
try:
3329
client["secret"] = pgp.decrypt(
3330
client["encrypted_secret"],
3331
client_settings[client_name]["secret"])
2267
client["secret"] = (
2268
pgp.decrypt(client["encrypted_secret"],
2269
client_settings[client_name]
2270
["secret"]))
3332
2271
except PGPError:
3333
2272
# 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"])
2273
logger.debug("Failed to decrypt {0} old secret"
2274
.format(client_name))
2275
client["secret"] = (
2276
client_settings[client_name]["secret"])
3338
2277
2278
3339
2279
# Add/remove clients based on new changes made to config
3340
for client_name in (set(old_client_settings)
3341
- set(client_settings)):
2280
for client_name in set(old_client_settings) - set(client_settings):
3342
2281
del clients_data[client_name]
3343
for client_name in (set(client_settings)
3344
- set(old_client_settings)):
2282
for client_name in set(client_settings) - set(old_client_settings):
3345
2283
clients_data[client_name] = client_settings[client_name]
3346
2284
3347
# Create all client objects
3348
for client_name, client in clients_data.items():
2285
# Create clients all clients
2286
for client_name, client in clients_data.iteritems():
3349
2287
tcp_server.clients[client_name] = client_class(
3350
name=client_name,
3351
settings=client,
3352
server_settings=server_settings)
3353
2288
name = client_name, settings = client)
2289
3354
2290
if not tcp_server.clients:
3355
2291
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
2292
2293
if not debug:
2294
try:
2295
with pidfile:
2296
pid = os.getpid()
2297
pidfile.write(str(pid) + "\n".encode("utf-8"))
2298
del pidfile
2299
except IOError:
2300
logger.error("Could not write to file %r with PID %d",
2301
pidfilename, pid)
2302
except NameError:
2303
# "pidfile" was never created
2304
pass
3367
2305
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
2306
signal.signal(signal.SIGINT, signal.SIG_IGN)
2307
2308
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2309
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2310
3373
2311
if use_dbus:
3374
3375
@alternate_dbus_interfaces(
3376
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3377
class MandosDBusService(DBusObjectWithObjectManager):
2312
class MandosDBusService(dbus.service.Object):
3378
2313
"""A D-Bus proxy object"""
3379
3380
2314
def __init__(self):
3381
2315
dbus.service.Object.__init__(self, bus, "/")
3382
3383
2316
_interface = "se.recompile.Mandos"
3384
2317
3385
2318
@dbus.service.signal(_interface, signature="o")
3386
2319
def ClientAdded(self, objpath):
3387
2320
"D-Bus signal"
3388
2321
pass
3389
2322
3390
2323
@dbus.service.signal(_interface, signature="ss")
3391
def ClientNotFound(self, key_id, address):
2324
def ClientNotFound(self, fingerprint, address):
3392
2325
"D-Bus signal"
3393
2326
pass
3394
3395
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3396
"true"})
2327
3397
2328
@dbus.service.signal(_interface, signature="os")
3398
2329
def ClientRemoved(self, objpath, name):
3399
2330
"D-Bus signal"
3400
2331
pass
3401
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3403
"true"})
2332
3404
2333
@dbus.service.method(_interface, out_signature="ao")
3405
2334
def GetAllClients(self):
3406
2335
"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"})
2336
return dbus.Array(c.dbus_object_path
2337
for c in
2338
tcp_server.clients.itervalues())
2339
3412
2340
@dbus.service.method(_interface,
3413
2341
out_signature="a{oa{sv}}")
3414
2342
def GetAllClientsWithProperties(self):
3415
2343
"D-Bus method"
3416
2344
return dbus.Dictionary(
3417
{c.dbus_object_path: c.GetAll(
3418
"se.recompile.Mandos.Client")
3419
for c in tcp_server.clients.values()},
2345
((c.dbus_object_path, c.GetAll(""))
2346
for c in tcp_server.clients.itervalues()),
3420
2347
signature="oa{sv}")
3421
2348
3422
2349
@dbus.service.method(_interface, in_signature="o")
3423
2350
def RemoveClient(self, object_path):
3424
2351
"D-Bus method"
3425
for c in tcp_server.clients.values():
2352
for c in tcp_server.clients.itervalues():
3426
2353
if c.dbus_object_path == object_path:
3427
2354
del tcp_server.clients[c.name]
3428
2355
c.remove_from_connection()
3429
# Don't signal the disabling
2356
# Don't signal anything except ClientRemoved
3430
2357
c.disable(quiet=True)
3431
# Emit D-Bus signal for removal
3432
self.client_removed_signal(c)
2358
# Emit D-Bus signal
2359
self.ClientRemoved(object_path, c.name)
3433
2360
return
3434
2361
raise KeyError(object_path)
3435
2362
3436
2363
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
2364
2365
class MandosDBusServiceTransitional(MandosDBusService):
2366
__metaclass__ = AlternateDBusNamesMetaclass
2367
mandos_dbus_service = MandosDBusServiceTransitional()
2368
3481
2369
def cleanup():
3482
2370
"Cleanup function; run on exit"
3483
if zeroconf:
3484
service.cleanup()
3485
3486
mp.active_children()
3487
wn.close()
2371
service.cleanup()
2372
2373
multiprocessing.active_children()
3488
2374
if not (tcp_server.clients or client_settings):
3489
2375
return
3490
2376
3491
2377
# Store client before exiting. Secrets are encrypted with key
3492
2378
# based on what config file has. If config file is
3493
2379
# removed/edited, old secret will thus be unrecovable.
3494
2380
clients = {}
3495
2381
with PGPEngine() as pgp:
3496
for client in tcp_server.clients.values():
2382
for client in tcp_server.clients.itervalues():
3497
2383
key = client_settings[client.name]["secret"]
3498
2384
client.encrypted_secret = pgp.encrypt(client.secret,
3499
2385
key)
3500
2386
client_dict = {}
3501
2387
3502
2388
# A list of attributes that can not be pickled
3503
2389
# + secret.
3504
exclude = {"bus", "changedstate", "secret",
3505
"checker", "server_settings"}
3506
for name, typ in inspect.getmembers(dbus.service
3507
.Object):
2390
exclude = set(("bus", "changedstate", "secret",
2391
"checker"))
2392
for name, typ in (inspect.getmembers
2393
(dbus.service.Object)):
3508
2394
exclude.add(name)
3509
2395
3510
2396
client_dict["encrypted_secret"] = (client
3511
2397
.encrypted_secret)
3512
2398
for attr in client.client_structure:
3513
2399
if attr not in exclude:
3514
2400
client_dict[attr] = getattr(client, attr)
3515
2401
3516
2402
clients[client.name] = client_dict
3517
2403
del client_settings[client.name]["secret"]
3518
2404
3519
2405
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
2406
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2407
prefix="clients-",
2408
dir=os.path.dirname
2409
(stored_state_path))
2410
with os.fdopen(tempfd, "wb") as stored_state:
2411
pickle.dump((clients, client_settings), stored_state)
3529
2412
os.rename(tempname, stored_state_path)
3530
2413
except (IOError, OSError) as e:
2414
logger.warning("Could not save persistent state: {0}"
2415
.format(e))
3531
2416
if not debug:
3532
2417
try:
3533
2418
os.remove(tempname)
3534
2419
except NameError:
3535
2420
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
2421
if e.errno not in set((errno.ENOENT, errno.EACCES,
2422
errno.EEXIST)):
2423
raise e
2424
3544
2425
# Delete all clients, and settings from config
3545
2426
while tcp_server.clients:
3546
2427
name, client = tcp_server.clients.popitem()
3547
2428
if use_dbus:
3548
2429
client.remove_from_connection()
3549
# Don't signal the disabling
2430
# Don't signal anything except ClientRemoved
3550
2431
client.disable(quiet=True)
3551
# Emit D-Bus signal for removal
3552
2432
if use_dbus:
3553
mandos_dbus_service.client_removed_signal(client)
2433
# Emit D-Bus signal
2434
mandos_dbus_service.ClientRemoved(client
2435
.dbus_object_path,
2436
client.name)
3554
2437
client_settings.clear()
3555
2438
3556
2439
atexit.register(cleanup)
3557
3558
for client in tcp_server.clients.values():
2440
2441
for client in tcp_server.clients.itervalues():
3559
2442
if use_dbus:
3560
# Emit D-Bus signal for adding
3561
mandos_dbus_service.client_added_signal(client)
2443
# Emit D-Bus signal
2444
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3562
2445
# Need to initiate checking of clients
3563
2446
if client.enabled:
3564
2447
client.init_checker()
3565
2448
3566
2449
tcp_server.enable()
3567
2450
tcp_server.server_activate()
3568
2451
3569
2452
# Find out what port we got
3570
if zeroconf:
3571
service.port = tcp_server.socket.getsockname()[1]
2453
service.port = tcp_server.socket.getsockname()[1]
3572
2454
if use_ipv6:
3573
2455
logger.info("Now listening on address %r, port %d,"
3574
" flowinfo %d, scope_id %d",
3575
*tcp_server.socket.getsockname())
2456
" flowinfo %d, scope_id %d"
2457
% tcp_server.socket.getsockname())
3576
2458
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
2459
logger.info("Now listening on address %r, port %d"
2460
% tcp_server.socket.getsockname())
2461
2462
#service.interface = tcp_server.socket.getsockname()[3]
2463
3582
2464
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
2465
# From the Avahi example code
2466
try:
2467
service.activate()
2468
except dbus.exceptions.DBusException as error:
2469
logger.critical("DBusException: %s", error)
2470
cleanup()
2471
sys.exit(1)
2472
# End of Avahi example code
2473
2474
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2475
lambda *args, **kwargs:
2476
(tcp_server.handle_request
2477
(*args[2:], **kwargs) or True))
2478
3598
2479
logger.debug("Starting main loop")
3599
2480
main_loop.run()
3600
2481
except AvahiError as error:
3601
logger.critical("Avahi Error", exc_info=error)
2482
logger.critical("AvahiError: %s", error)
3602
2483
cleanup()
3603
2484
sys.exit(1)
3604
2485
except KeyboardInterrupt:
3609
2490
# Must run before the D-Bus bus name gets deregistered
3610
2491
cleanup()
3611
2492
3612
3613
2493
if __name__ == '__main__':
3614
2494
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0