-
Notifications
You must be signed in to change notification settings - Fork 10
/
control.py
237 lines (197 loc) · 7.55 KB
/
control.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# -*- coding: utf-8 -*-
# (The MIT License)
#
# Copyright (c) 2013-2020 Kura
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the 'Software'), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Provides control functionality, including socket wrappers."""
try: # pragma: no cover
import ssl
except ImportError: # pragma: no cover
ssl = None
import grp
import logging
import os
import pwd
import socket
from .config import Config
from .exceptions import BlackholeRuntimeException
__all__ = ("pid_permissions", "server", "setgid", "setuid")
"""Tuple all the things."""
logger = logging.getLogger("blackhole.control")
ciphers = [
"ECDHE-ECDSA-AES256-GCM-SHA384",
"ECDHE-RSA-AES256-GCM-SHA384",
"ECDHE-ECDSA-CHACHA20-POLY1305",
"ECDHE-RSA-CHACHA20-POLY1305",
"ECDHE-ECDSA-AES128-GCM-SHA256",
"ECDHE-RSA-AES128-GCM-SHA256",
"ECDHE-ECDSA-AES256-SHA384",
"ECDHE-RSA-AES256-SHA384",
"ECDHE-ECDSA-AES128-SHA256",
"ECDHE-RSA-AES128-SHA256",
]
"""Strong default TLS ciphers."""
def _context(use_tls=False):
"""
Create a TLS context using the certificate, key and dhparams file.
:param bool use_tls: Whether to create a TLS context or not.
Default: ``False``.
:returns: A TLS context or ``None``.
:rtype: :py:class:`ssl.SSLContext` or :py:obj:`None`.
.. note::
Created with:
- :py:obj:`ssl.OP_NO_SSLv2`
- :py:obj:`ssl.OP_NO_SSLv3`
- :py:obj:`ssl.OP_NO_COMPRESSION`
- :py:obj:`ssl.OP_CIPHER_SERVER_PREFERENCE`
Also responsible for loading Diffie Hellman ephemeral parameters if
they're provided -- :py:func:`ssl.SSLContext.load_dh_params`
If the ``-ls`` or ``--less-secure`` option is provided,
:py:obj:`ssl.OP_SINGLE_DH_USE` and :py:obj:`ssl.OP_SINGLE_ECDH_USE`
will be omitted from the context. --
https://kura.github.io/blackhole/configuration.html#command-line-options
-- added in :ref:`2.0.13`
"""
if use_tls is False:
return None
config = Config()
ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
ctx.load_cert_chain(config.tls_cert, config.tls_key)
ctx.options |= ssl.OP_NO_SSLv2
ctx.options |= ssl.OP_NO_SSLv3
ctx.options |= ssl.OP_NO_COMPRESSION
ctx.options |= ssl.OP_CIPHER_SERVER_PREFERENCE
if not config.args.less_secure:
ctx.options |= ssl.OP_SINGLE_DH_USE
ctx.options |= ssl.OP_SINGLE_ECDH_USE
ctx.set_ciphers(":".join(ciphers))
if config.tls_dhparams:
ctx.load_dh_params(config.tls_dhparams)
return ctx
def _socket(addr, port, family):
"""
Create a socket, bind and listen.
:param str addr: The address to use.
:param int port: The port to use.
:param family: The type of socket to use.
:type family: :py:obj:`socket.AF_INET` or :py:obj:`socket.AF_INET6`.
:returns: Bound socket.
:rtype: :py:func:`socket.socket`
:raises BlackholeRuntimeException: When a socket cannot be bound.
"""
sock = socket.socket(family, socket.SOCK_STREAM)
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
try:
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
except (AttributeError, OSError):
pass
if family == socket.AF_INET6:
sock.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 1)
try:
sock.bind((addr, port))
except OSError:
msg = f"Cannot bind to {addr}:{port}."
logger.critical(msg)
sock.close()
raise BlackholeRuntimeException(msg)
os.set_inheritable(sock.fileno(), True)
sock.listen(1024)
sock.setblocking(False)
return sock
def server(addr, port, family, use_tls=False):
"""
Socket and possibly a TLS context.
Create an instance of :py:func:`socket.socket`, bind it and return a
dictionary containing the socket object and a TLS context if configured.
:param str addr: The address to use.
:param int port: The port to use.
:param family: The type of socket to use.
:type family: :py:obj:`socket.AF_INET` or :py:obj:`socket.AF_INET6`.
:param bool use_tls: Whether to create a TLS context or not.
Default: ``False``.
:returns: Bound socket, a TLS context if configured.
:rtype: :py:obj:`dict`
"""
sock = _socket(addr, port, family)
ctx = _context(use_tls=use_tls)
return {"sock": sock, "ssl": ctx}
def pid_permissions():
"""
Change the pid file ownership.
Called before :func:`blackhole.control.setgid` and
:func:`blackhole.control.setuid` are called to stop
:class:`blackhole.daemon.Daemon` losing permissions to modify the pid file.
:raises SystemExit: With exit code :py:obj:`os.EX_USAGE` when a permissions
error occurs.
"""
config = Config()
try:
user = pwd.getpwnam(config.user)
group = grp.getgrnam(config.group)
os.chown(config.pidfile, user.pw_uid, group.gr_gid)
except (KeyError, PermissionError):
logger.error("Unable to change pidfile ownership permissions.")
raise SystemExit(os.EX_USAGE)
def setgid():
"""
Change group.
Change to a less privileged group. Unless you're using it incorrectly --
in which case, don't use it.
:raises SystemExit: Exit code :py:obj:`os.EX_USAGE` when a configuration
error occurs or :py:obj:`os.EX_NOPERM` when a
permission error occurs.
.. note::
MUST be called BEFORE setuid, not after.
"""
config = Config()
try:
gid = grp.getgrnam(config.group).gr_gid
os.setgid(gid)
except KeyError:
logger.error(f"Group '{config.group}' does not exist.")
raise SystemExit(os.EX_USAGE)
except PermissionError:
logger.error(
f"You do not have permission to switch to group '{config.group}'."
)
raise SystemExit(os.EX_NOPERM)
def setuid():
"""
Change user.
Change to a less privileged user.Unless you're using it incorrectly --
inwhich case, don't use it.
:raises SystemExit: Exit code :py:obj:`os.EX_USAGE` when a configuration
error occurs or :py:obj:`os.EX_NOPERM` when a
permission error occurs.
.. note::
MUST be called AFTER setgid, not before.
"""
config = Config()
try:
uid = pwd.getpwnam(config.user).pw_uid
os.setuid(uid)
except KeyError:
logger.error(f"User '{config.user}' does not exist.")
raise SystemExit(os.EX_USAGE)
except PermissionError:
logger.error(
f"You do not have permission to switch to user '{config.user}'."
)
raise SystemExit(os.EX_NOPERM)