Interface Tunnel

Base type for connections to remote services established over a secure tunnel via the Hardpoint network.

All tunnel types contain some common information that may be helpful, depending on the use case.

interface Tunnel {
    encryptionScheme: EncryptionScheme;
    remoteHost: string;
    remotePort: number;
    serviceName: string;
}

Properties

encryptionScheme: EncryptionScheme

The encryption scheme the tunnel is using.

remoteHost: string

The host that we're connected to on the other side of the network.

This could be any IPv4 address, IPv6 address or valid hostname.

This can be necessary for several use-cases, such as:

remotePort: number

The resolved port that we're connected to on the other side of the network.

This could be any valid port number.

serviceName: string

Name of the service.

This corresponds with the name of a service(s) in the Hardpoint Dashboard. See the documentation on services for more information.