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