Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Lib/socketserver.py
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,13 @@ def server_bind(self):
May be overridden.

"""
if self.allow_reuse_address and hasattr(socket, "SO_REUSEADDR"):
# SO_REUSEADDR is only useful when rebinding a fixed port that may
# still have connections in TIME_WAIT. For port 0 the kernel only
# hands out ports that are not in use, so setting it just lets
# another process claim the port between bind() and listen().
if (self.allow_reuse_address and hasattr(socket, "SO_REUSEADDR")
and not (self.address_family in (socket.AF_INET, socket.AF_INET6)
and self.server_address[1] == 0)):
self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
# Since Linux 6.12.9, SO_REUSEPORT is not allowed
# on other address families than AF_INET/AF_INET6.
Expand Down
53 changes: 53 additions & 0 deletions Lib/test/test_socketserver.py
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,59 @@ def test_tcpserver_bind_leak(self):
socketserver.TCPServer((HOST, -1),
socketserver.StreamRequestHandler)

def test_port_zero_no_reuse_address(self):
# gh-162256: binding port 0 must not set SO_REUSEADDR, or another
# process could claim the port between bind() and listen().
class MyServer(socketserver.TCPServer):
allow_reuse_address = True

server = MyServer((HOST, 0), socketserver.StreamRequestHandler,
bind_and_activate=False)
try:
server.server_bind()
self.assertEqual(server.socket.getsockopt(socket.SOL_SOCKET,
socket.SO_REUSEADDR), 0)
port = server.server_address[1]
other = socket.socket()
try:
other.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
with self.assertRaises(OSError):
other.bind((HOST, port))
finally:
other.close()
server.server_activate()
finally:
server.server_close()

if socket_helper.IPV6_ENABLED:
class MyServer6(socketserver.TCPServer):
address_family = socket.AF_INET6
allow_reuse_address = True

server = MyServer6(('::1', 0), socketserver.StreamRequestHandler,
bind_and_activate=False)
try:
server.server_bind()
self.assertEqual(server.socket.getsockopt(
socket.SOL_SOCKET, socket.SO_REUSEADDR), 0)
server.server_activate()
finally:
server.server_close()

# A fixed port still gets SO_REUSEADDR. Check for non-zero rather
# than 1: on macOS getsockopt returns the raw flag value 4.
server = MyServer((HOST, 0), socketserver.StreamRequestHandler)
port = server.server_address[1]
server.server_close()
server = MyServer((HOST, port), socketserver.StreamRequestHandler,
bind_and_activate=False)
try:
server.server_bind()
self.assertNotEqual(server.socket.getsockopt(socket.SOL_SOCKET,
socket.SO_REUSEADDR), 0)
finally:
server.server_close()

def test_context_manager(self):
with socketserver.TCPServer((HOST, 0),
socketserver.StreamRequestHandler) as server:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:mod:`socketserver` servers no longer set ``SO_REUSEADDR`` when binding
port 0, so another process cannot claim the port between ``bind()`` and
``listen()``. This fixes :class:`http.server.HTTPServer` failing with
``EADDRINUSE`` when started on port 0.
Loading