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