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