README
¶
Portal
A Go implementation of HTTP tunneling through a tunnel
Overview
The main goal of this project is to provide access from cloud to on-prem without opening ports on-prem. This library provides a mechanism to build a 2-node HTTP tunnel.
The tunnel has two sides: client and server. An on-prem application running tunnel client will connect to tunnel server running in cloud. Proxy port can be opened on cloud side to allow access to on-prem via HTTP tunnelling: https://en.wikipedia.org/wiki/HTTP_tunnel
This library only supports HTTPS tunneling that uses HTTP CONNECT to initiate connection.
Install
go get github.com/oatcode/portal
Usage
Establish the connection c and use:
cch := make(chan net.Conn)
portal.TunnelServe(c, cch)
where cch is the channel to handle incoming proxy connection
Examples
Included in the projects are example code to establish a TLS tunnel and make HTTPS connection through it.
To run the examples locally, create certificates for tunnel and https server:
openssl req -x509 -nodes -newkey rsa:2048 -sha256 -keyout tunnel-server.key -out tunnel-server.crt -subj "/C=US/ST=CA/L=SJC/O=Example/OU=Dev/CN=localhost"
openssl req -x509 -nodes -newkey rsa:2048 -sha256 -keyout tunnel-client.key -out tunnel-client.crt -subj "/C=US/ST=CA/L=SJC/O=Example/OU=Dev/CN=client"
openssl req -x509 -nodes -newkey rsa:2048 -sha256 -keyout https-server.key -out https-server.crt -subj "/C=US/ST=CA/L=SJC/O=Example/OU=Dev/CN=localhost"
Run TLS tunnel client and server on port 10001, where proxy is on the TLS tunnel server side on port 10002:
tunnel-server -address :10001 -proxy :10002 -cert tunnel-server.crt -key tunnel-server.key -trust tunnel-client.crt
tunnel-client -address localhost:10001 -cert tunnel-client.crt -key tunnel-client.key -trust tunnel-server.crt
Run HTTPS client and server on port 10003
sample-https-server -address :10003 -cert https-server.crt -key https-server.key
sample-https-client -proxy http://localhost:10002 -url https://localhost:10003/test -trust https-server.crt
Other ways to set proxy
The sample-https-client sets proxy programmatically. But it can be set in other ways. For example:
- export https_proxy=[proxy-host]:[proxy-port]
- java -Dhttps.proxyHost=[proxy-host] -Dhttps.proxyPort=[proxy-port]
Documentation
¶
Overview ¶
Package portal provides ability to build a 2-node HTTP tunnel
Index ¶
- Variables
- func SetPrintf(l func(string, ...interface{}))
- func TunnelServe(c net.Conn, cch <-chan net.Conn)
- type Message
- func (*Message) Descriptor() ([]byte, []int)
- func (m *Message) GetBuf() []byte
- func (m *Message) GetId() int32
- func (m *Message) GetOrigin() Message_Origin
- func (m *Message) GetSocketAddress() string
- func (m *Message) GetType() Message_Type
- func (*Message) ProtoMessage()
- func (m *Message) Reset()
- func (m *Message) String() string
- func (m *Message) XXX_DiscardUnknown()
- func (m *Message) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Message) XXX_Merge(src proto.Message)
- func (m *Message) XXX_Size() int
- func (m *Message) XXX_Unmarshal(b []byte) error
- type Message_Origin
- type Message_Type
Constants ¶
This section is empty.
Variables ¶
var Message_Origin_name = map[int32]string{
0: "ORIGIN_LOCAL",
1: "ORIGIN_REMOTE",
}
var Message_Origin_value = map[string]int32{
"ORIGIN_LOCAL": 0,
"ORIGIN_REMOTE": 1,
}
var Message_Type_name = map[int32]string{
0: "HTTP_CONNECT",
1: "HTTP_CONNECT_OK",
2: "HTTP_SERVICE_UNAVAILABLE",
3: "DISCONNECTED",
4: "DATA",
}
var Message_Type_value = map[string]int32{
"HTTP_CONNECT": 0,
"HTTP_CONNECT_OK": 1,
"HTTP_SERVICE_UNAVAILABLE": 2,
"DISCONNECTED": 3,
"DATA": 4,
}
Functions ¶
Types ¶
type Message ¶
type Message struct {
Type Message_Type `protobuf:"varint,1,opt,name=type,proto3,enum=portal.Message_Type" json:"type,omitempty"`
Origin Message_Origin `protobuf:"varint,2,opt,name=origin,proto3,enum=portal.Message_Origin" json:"origin,omitempty"`
Id int32 `protobuf:"varint,3,opt,name=id,proto3" json:"id,omitempty"`
SocketAddress string `protobuf:"bytes,4,opt,name=socket_address,json=socketAddress,proto3" json:"socket_address,omitempty"`
Buf []byte `protobuf:"bytes,5,opt,name=buf,proto3" json:"buf,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (*Message) Descriptor ¶
func (*Message) GetOrigin ¶
func (m *Message) GetOrigin() Message_Origin
func (*Message) GetSocketAddress ¶
func (*Message) GetType ¶
func (m *Message) GetType() Message_Type
func (*Message) ProtoMessage ¶
func (*Message) ProtoMessage()
func (*Message) XXX_DiscardUnknown ¶
func (m *Message) XXX_DiscardUnknown()
func (*Message) XXX_Marshal ¶
func (*Message) XXX_Unmarshal ¶
type Message_Origin ¶
type Message_Origin int32
const ( Message_ORIGIN_LOCAL Message_Origin = 0 Message_ORIGIN_REMOTE Message_Origin = 1 )
func (Message_Origin) EnumDescriptor ¶
func (Message_Origin) EnumDescriptor() ([]byte, []int)
func (Message_Origin) String ¶
func (x Message_Origin) String() string
type Message_Type ¶
type Message_Type int32
const ( Message_HTTP_CONNECT Message_Type = 0 Message_HTTP_CONNECT_OK Message_Type = 1 Message_HTTP_SERVICE_UNAVAILABLE Message_Type = 2 Message_DISCONNECTED Message_Type = 3 Message_DATA Message_Type = 4 )
func (Message_Type) EnumDescriptor ¶
func (Message_Type) EnumDescriptor() ([]byte, []int)
func (Message_Type) String ¶
func (x Message_Type) String() string
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
sample-https-client
command
|
|
|
sample-https-server
command
|
|
|
tunnel-client
command
|
|
|
tunnel-server
command
|