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