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