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