Update the ISecureConn interface following the reference and simplify accordingly

This commit is contained in:
Alex Stokes
2019-08-02 16:04:46 -07:00
parent ab7653526f
commit 1e5357a1e1
7 changed files with 45 additions and 98 deletions

View File

@ -1,10 +1,7 @@
from typing import cast
from libp2p.network.connection.raw_connection_interface import IRawConnection
from libp2p.peer.id import ID
from libp2p.security.secure_conn_interface import ISecureConn
from libp2p.security.secure_transport_interface import ISecureTransport
from libp2p.security.typing import TSecurityDetails
class InsecureTransport(ISecureTransport):
@ -13,19 +10,13 @@ class InsecureTransport(ISecureTransport):
i.e. the upgraded transport does not add any additional security.
"""
transport_id: str
def __init__(self, transport_id: str) -> None:
self.transport_id = transport_id
async def secure_inbound(self, conn: IRawConnection) -> ISecureConn:
"""
Secure the connection, either locally or by communicating with opposing node via conn,
for an inbound connection (i.e. we are not the initiator)
:return: secure connection object (that implements secure_conn_interface)
"""
insecure_conn = InsecureConn(conn, self.transport_id)
return insecure_conn
return conn
async def secure_outbound(self, conn: IRawConnection, peer_id: ID) -> ISecureConn:
"""
@ -33,27 +24,4 @@ class InsecureTransport(ISecureTransport):
for an inbound connection (i.e. we are the initiator)
:return: secure connection object (that implements secure_conn_interface)
"""
insecure_conn = InsecureConn(conn, self.transport_id)
return insecure_conn
class InsecureConn(ISecureConn):
conn: IRawConnection
details: TSecurityDetails
def __init__(self, conn: IRawConnection, conn_id: str) -> None:
self.conn = conn
self.details = cast(TSecurityDetails, {})
self.details["id"] = conn_id
def get_conn(self) -> IRawConnection:
"""
:return: connection object that has been made secure
"""
return self.conn
def get_security_details(self) -> TSecurityDetails:
"""
:return: map containing details about the connections security
"""
return self.details
return conn

View File

@ -1,7 +1,7 @@
from abc import ABC, abstractmethod
from libp2p.peer.id import ID
from libp2p.network.connection.raw_connection_interface import IRawConnection
from libp2p.security.typing import TSecurityDetails
"""
@ -12,15 +12,23 @@ Relevant go repo: https://github.com/libp2p/go-conn-security/blob/master/interfa
"""
class ISecureConn(ABC):
class AbstractSecureConn(ABC):
@abstractmethod
def get_conn(self) -> IRawConnection:
"""
:return: the underlying raw connection
"""
def get_local_peer(self) -> ID:
pass
@abstractmethod
def get_security_details(self) -> TSecurityDetails:
"""
:return: map containing details about the connections security
"""
def get_local_private_key(self) -> bytes:
pass
@abstractmethod
def get_remote_peer(self) -> ID:
pass
@abstractmethod
def get_remote_public_key(self) -> bytes:
pass
class ISecureConn(AbstractSecureConn, IRawConnection):
pass

View File

@ -23,11 +23,14 @@ class SecurityMultistream(ABC):
multiselect: Multiselect
multiselect_client: MultiselectClient
def __init__(self) -> None:
def __init__(self, secure_transports_by_protocol) -> None:
self.transports = {}
self.multiselect = Multiselect()
self.multiselect_client = MultiselectClient()
for protocol, transport in secure_transports_by_protocol.items():
self.add_transport(protocol, transport)
def add_transport(self, protocol: TProtocol, transport: ISecureTransport) -> None:
self.transports[protocol] = transport

View File

@ -1,11 +1,9 @@
import asyncio
from typing import cast
from libp2p.network.connection.raw_connection_interface import IRawConnection
from libp2p.peer.id import ID
from libp2p.security.secure_conn_interface import ISecureConn
from libp2p.security.secure_transport_interface import ISecureTransport
from libp2p.security.typing import TSecurityDetails
class SimpleSecurityTransport(ISecureTransport):
@ -28,8 +26,7 @@ class SimpleSecurityTransport(ISecureTransport):
"Key phrase differed between nodes. Expected " + self.key_phrase
)
secure_conn = SimpleSecureConn(conn, self.key_phrase)
return secure_conn
return conn
async def secure_outbound(self, conn: IRawConnection, peer_id: ID) -> ISecureConn:
"""
@ -49,28 +46,4 @@ class SimpleSecurityTransport(ISecureTransport):
"Key phrase differed between nodes. Expected " + self.key_phrase
)
secure_conn = SimpleSecureConn(conn, self.key_phrase)
return secure_conn
class SimpleSecureConn(ISecureConn):
conn: IRawConnection
key_phrase: str
details: TSecurityDetails
def __init__(self, conn: IRawConnection, key_phrase: str) -> None:
self.conn = conn
self.details = cast(TSecurityDetails, {})
self.details["key_phrase"] = key_phrase
def get_conn(self) -> IRawConnection:
"""
:return: connection object that has been made secure
"""
return self.conn
def get_security_details(self) -> TSecurityDetails:
"""
:return: map containing details about the connections security
"""
return self.details
return conn