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