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