py-libp2p/libp2p/security/secure_transport_interface.py

36 lines
1.2 KiB
Python
Raw Normal View History

2019-04-28 07:42:05 +08:00
from abc import ABC, abstractmethod
2019-08-01 19:12:11 +08:00
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from .secure_conn_interface import ISecureConn
from libp2p.network.connection.raw_connection_interface import IRawConnection
from libp2p.peer.id import ID
2019-05-02 01:54:19 +08:00
2019-04-28 07:42:05 +08:00
"""
2019-05-02 01:54:19 +08:00
Transport that is used to secure a connection. This transport is
2019-04-28 07:42:05 +08:00
chosen by a security transport multistream module.
Relevant go repo: https://github.com/libp2p/go-conn-security/blob/master/interface.go
"""
2019-08-01 06:00:12 +08:00
class ISecureTransport(ABC):
2019-04-28 07:42:05 +08:00
@abstractmethod
2019-08-01 19:12:11 +08:00
async def secure_inbound(self, conn: "IRawConnection") -> "ISecureConn":
2019-04-28 07:42:05 +08:00
"""
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)
"""
@abstractmethod
2019-08-01 19:12:11 +08:00
async def secure_outbound(
self, conn: "IRawConnection", peer_id: "ID"
) -> "ISecureConn":
2019-04-28 07:42:05 +08:00
"""
Secure the connection, either locally or by communicating with opposing node via conn,
for an inbound connection (i.e. we are the initiator)
:return: secure connection object (that implements secure_conn_interface)
"""