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