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