ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-24 07:06:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Better docs.

Browse Source
This commit is contained in:
Itamar Turner-Trauring 2022-06-30 14:21:21 -04:00
parent 1154371d22
commit 03c515191e
1 changed files with 32 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/allmydata/protocol_switch.py
View File

@ -1,8 +1,15 @@
""" """
Support for listening with both HTTP and Foolscap on the same port. Support for listening with both HTTPS and Foolscap on the same port.
"""
from typing import Optional The goal is to make the transition from Foolscap to HTTPS-based protocols as
simple as possible, with no extra configuration needed. Listening on the same
port means a user upgrading Tahoe-LAFS will automatically get HTTPS working
with no additional changes.
Use ``create_foolscap_or_http_class()`` to create a new subclass per ``Tub``,
and then ``update_foolscap_or_http_class()`` to add the relevant information to
the subclass once it becomes available later in the configuration process.
"""
from twisted.internet.protocol import Protocol from twisted.internet.protocol import Protocol
from twisted.internet.interfaces import IDelayedCall from twisted.internet.interfaces import IDelayedCall
@ -17,18 +24,26 @@ from .storage.http_server import HTTPServer
from .storage.server import StorageServer from .storage.server import StorageServer
class PretendToBeNegotiation(type): class _PretendToBeNegotiation(type):
"""😱""" """
Metaclass that allows ``_FoolscapOrHttps`` to pretend to be a ``Negotiation``
instance, since Foolscap has some ``assert isinstance(protocol,
Negotiation`` checks.
"""
def __instancecheck__(self, instance): def __instancecheck__(self, instance):
return (instance.__class__ == self) or isinstance(instance, Negotiation) return (instance.__class__ == self) or isinstance(instance, Negotiation)
class FoolscapOrHttp(Protocol, metaclass=PretendToBeNegotiation): class _FoolscapOrHttps(Protocol, metaclass=_PretendToBeNegotiation):
""" """
Based on initial query, decide whether we're talking Foolscap or HTTP. Based on initial query, decide whether we're talking Foolscap or HTTP.
Pretends to be a ``foolscap.negotiate.Negotiation`` instance. Additionally, pretends to be a ``foolscap.negotiate.Negotiation`` instance,
since these are created by Foolscap's ``Tub``, by setting this to be the
tub's ``negotiationClass``.
Do not use directly; this needs to be subclassed per ``Tub``.
""" """
# These three will be set by a subclass in update_foolscap_or_http_class() # These three will be set by a subclass in update_foolscap_or_http_class()
@ -110,13 +125,22 @@ class FoolscapOrHttp(Protocol, metaclass=PretendToBeNegotiation):
def create_foolscap_or_http_class(): def create_foolscap_or_http_class():
class FoolscapOrHttpWithCert(FoolscapOrHttp): """
Create a new Foolscap-or-HTTPS protocol class for a specific ``Tub``
instance.
"""
class FoolscapOrHttpWithCert(_FoolscapOrHttps):
pass pass
return FoolscapOrHttpWithCert return FoolscapOrHttpWithCert
def update_foolscap_or_http_class(cls, certificate, storage_server, swissnum): def update_foolscap_or_http_class(cls, certificate, storage_server, swissnum):
"""
Add the various parameters needed by a ``Tub``-specific
``_FoolscapOrHttps`` subclass.
"""
cls.certificate = certificate cls.certificate = certificate
cls.storage_server = storage_server cls.storage_server = storage_server
cls.swissnum = swissnum cls.swissnum = swissnum