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