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