ws: support websocket server mode

This commit is contained in:
nadoo committed 2020-10-19 20:45:57 +08:00
1 parent 13babd9305
commit beec9d205f
11 files changed
+312 -138

No files matched your search

+42 -56
View File
@@ -2,50 +2,62 @@ package ws
import (
"bufio"
"crypto/rand"
"crypto/sha1"
"encoding/base64"
"errors"
"io"
"net"
"net/textproto"
"strings"
"github.com/nadoo/glider/pool"
"github.com/nadoo/glider/proxy"
)
var keyGUID = []byte("258EAFA5-E914-47DA-95CA-C5AB0DC85B11")
// Client is ws client struct.
type Client struct {
host string
path string
func init() {
proxy.RegisterDialer("ws", NewWSDialer)
}
// Conn is a connection to ws server.
type Conn struct {
// NewWSDialer returns a ws proxy dialer.
func NewWSDialer(s string, d proxy.Dialer) (proxy.Dialer, error) {
return NewWS(s, d, nil)
}
// Addr returns forwarder's address.
func (s *WS) Addr() string {
if s.addr == "" {
return s.dialer.Addr()
}
return s.addr
}
// Dial connects to the address addr on the network net via the proxy.
func (s *WS) Dial(network, addr string) (net.Conn, error) {
rc, err := s.dialer.Dial("tcp", s.addr)
if err != nil {
return nil, err
}
return s.NewClientConn(rc)
}
// DialUDP connects to the given address via the proxy.
func (s *WS) DialUDP(network, addr string) (net.PacketConn, net.Addr, error) {
return nil, nil, errors.New("[ws] ws client does not support udp now")
}
// ClientConn is a connection to ws server.
type ClientConn struct {
net.Conn
reader io.Reader
writer io.Writer
}
// NewClient creates a new ws client.
func NewClient(host, path string) (*Client, error) {
if path == "" {
path = "/"
}
c := &Client{host: host, path: path}
return c, nil
}
// NewConn creates a new ws client connection.
func (c *Client) NewConn(rc net.Conn, target string) (*Conn, error) {
conn := &Conn{Conn: rc}
return conn, conn.Handshake(c.host, c.path)
// NewClientConn creates a new ws client connection.
func (s *WS) NewClientConn(rc net.Conn) (*ClientConn, error) {
conn := &ClientConn{Conn: rc}
return conn, conn.Handshake(s.host, s.path)
}
// Handshake handshakes with the server using HTTP to request a protocol upgrade.
func (c *Conn) Handshake(host, path string) error {
func (c *ClientConn) Handshake(host, path string) error {
clientKey := generateClientKey()
buf := pool.GetWriteBuffer()
@@ -89,42 +101,16 @@ func (c *Conn) Handshake(host, path string) error {
return nil
}
func (c *Conn) Write(b []byte) (n int, err error) {
func (c *ClientConn) Write(b []byte) (n int, err error) {
if c.writer == nil {
c.writer = FrameWriter(c.Conn)
c.writer = FrameWriter(c.Conn, true)
}
return c.writer.Write(b)
}
func (c *Conn) Read(b []byte) (n int, err error) {
func (c *ClientConn) Read(b []byte) (n int, err error) {
if c.reader == nil {
c.reader = FrameReader(c.Conn)
c.reader = FrameReader(c.Conn, true)
}
return c.reader.Read(b)
}
// parseFirstLine parses "GET /foo HTTP/1.1" OR "HTTP/1.1 200 OK" into its three parts.
// TODO: move to separate http lib package for reuse(also for http proxy module)
func parseFirstLine(line string) (r1, r2, r3 string, ok bool) {
s1 := strings.Index(line, " ")
s2 := strings.Index(line[s1+1:], " ")
if s1 < 0 || s2 < 0 {
return
}
s2 += s1 + 1
return line[:s1], line[s1+1 : s2], line[s2+1:], true
}
func generateClientKey() string {
p := pool.GetBuffer(16)
defer pool.PutBuffer(p)
rand.Read(p)
return base64.StdEncoding.EncodeToString(p)
}
func computeServerKey(clientKey string) string {
h := sha1.New()
h.Write([]byte(clientKey))
h.Write(keyGUID)
return base64.StdEncoding.EncodeToString(h.Sum(nil))
}
+58 -26
View File
@@ -30,28 +30,32 @@ import (
)
const (
defaultFrameSize = 4096
maxFrameHeaderSize = 2 + 8 + 4 // Fixed header + length + mask
maskKeyLen = 4
defaultFrameSize = 4096
maxHeaderSize = 2 + 8 + 4 // Fixed header + length + mask
// byte 0
finalBit byte = 1 << 7
maskBit byte = 1 << 7
opCodeBinary byte = 2
// byte 1
maskBit byte = 1 << 7
)
type frameWriter struct {
io.Writer
buf []byte
maskKey [maskKeyLen]byte
client bool
maskKey [4]byte
}
// FrameWriter returns a frame writer.
func FrameWriter(w io.Writer) io.Writer {
func FrameWriter(w io.Writer, client bool) io.Writer {
n := rand.Uint32()
return &frameWriter{
Writer: w,
buf: make([]byte, maxFrameHeaderSize+defaultFrameSize),
maskKey: [...]byte{byte(n), byte(n >> 8), byte(n >> 16), byte(n >> 24)},
buf: make([]byte, maxHeaderSize+defaultFrameSize),
client: client,
maskKey: [4]byte{byte(n), byte(n >> 8), byte(n >> 16), byte(n >> 24)},
}
}
@@ -63,13 +67,18 @@ func (w *frameWriter) Write(b []byte) (int, error) {
func (w *frameWriter) ReadFrom(r io.Reader) (n int64, err error) {
for {
buf := w.buf
payloadBuf := buf[maxFrameHeaderSize:]
payloadBuf := buf[maxHeaderSize:]
nr, er := r.Read(payloadBuf)
if nr > 0 {
n += int64(nr)
buf[0] = finalBit | opCodeBinary
buf[1] = maskBit
buf[0] = opCodeBinary
buf[1] = 0
if w.client {
buf[0] |= finalBit
buf[1] = maskBit
}
lengthFieldLen := 0
switch {
@@ -92,17 +101,20 @@ func (w *frameWriter) ReadFrom(r io.Reader) (n int64, err error) {
break
}
// maskkey
_, ew = w.Writer.Write(w.maskKey[:])
if ew != nil {
err = ew
break
}
// payload
payloadBuf = payloadBuf[:nr]
for i := range payloadBuf {
payloadBuf[i] = payloadBuf[i] ^ w.maskKey[i%4]
if w.client {
// maskkey
_, ew = w.Writer.Write(w.maskKey[:])
if ew != nil {
err = ew
break
}
// payload mask
for i := range payloadBuf {
payloadBuf[i] = payloadBuf[i] ^ w.maskKey[i%4]
}
}
_, ew = w.Writer.Write(payloadBuf)
@@ -126,17 +138,21 @@ func (w *frameWriter) ReadFrom(r io.Reader) (n int64, err error) {
type frameReader struct {
io.Reader
buf [8]byte
left int64
buf [8]byte
left int64
server bool
maskKey [4]byte
maskOffset int
}
// FrameReader returns a chunked reader.
func FrameReader(r io.Reader) io.Reader {
return &frameReader{Reader: r}
func FrameReader(r io.Reader, client bool) io.Reader {
return &frameReader{Reader: r, server: !client}
}
func (r *frameReader) Read(b []byte) (int, error) {
if r.left == 0 {
// get msg header
_, err := io.ReadFull(r.Reader, r.buf[:2])
if err != nil {
@@ -145,7 +161,8 @@ func (r *frameReader) Read(b []byte) (int, error) {
// final := r.buf[0]&finalBit != 0
// frameType := int(r.buf[0] & 0xf)
// mask := r.buf[1]&maskBit != 0
// r.mask = r.buf[1]&maskBit != 0
r.left = int64(r.buf[1] & 0x7f)
switch r.left {
case 126:
@@ -161,6 +178,14 @@ func (r *frameReader) Read(b []byte) (int, error) {
}
r.left = int64(binary.BigEndian.Uint64(r.buf[:8]))
}
if r.server {
_, err := io.ReadFull(r.Reader, r.maskKey[:])
if err != nil {
return 0, err
}
r.maskOffset = 0
}
}
readLen := int64(len(b))
@@ -173,6 +198,13 @@ func (r *frameReader) Read(b []byte) (int, error) {
return 0, err
}
if r.server {
for i := range b[:m] {
b[i] = b[i] ^ r.maskKey[(i+r.maskOffset)%4]
}
r.maskOffset = (m + r.maskOffset) % 4
}
r.left -= int64(m)
return m, err
}
+144
View File
@@ -0,0 +1,144 @@
package ws
import (
"bufio"
"errors"
"io"
"net"
"net/textproto"
"strings"
"github.com/nadoo/glider/log"
"github.com/nadoo/glider/pool"
"github.com/nadoo/glider/proxy"
)
func init() {
proxy.RegisterServer("ws", NewWSServer)
}
// NewWSServer returns a ws transport server.
func NewWSServer(s string, p proxy.Proxy) (proxy.Server, error) {
transport := strings.Split(s, ",")
// prepare transport listener
// TODO: check here
if len(transport) < 2 {
return nil, errors.New("[tls] malformd listener:" + s)
}
w, err := NewWS(transport[0], nil, p)
if err != nil {
return nil, err
}
w.server, err = proxy.ServerFromURL(transport[1], p)
if err != nil {
return nil, err
}
return w, nil
}
// ListenAndServe listens on server's addr and serves connections.
func (s *WS) ListenAndServe() {
l, err := net.Listen("tcp", s.addr)
if err != nil {
log.F("[ws] failed to listen on %s: %v", s.addr, err)
return
}
defer l.Close()
log.F("[ws] listening TCP on %s", s.addr)
for {
c, err := l.Accept()
if err != nil {
log.F("[ws] failed to accept: %v", err)
continue
}
go s.Serve(c)
}
}
// Serve serves a connection.
func (s *WS) Serve(c net.Conn) {
// we know the internal server will close the connection after serve
// defer c.Close()
if s.server != nil {
sc, err := s.NewServerConn(c)
if err != nil {
return
}
s.server.Serve(sc)
}
}
// ServerConn is a connection to ws client.
type ServerConn struct {
net.Conn
reader io.Reader
writer io.Writer
}
// NewServerConn creates a new ws server connection.
func (s *WS) NewServerConn(rc net.Conn) (*ServerConn, error) {
sc := &ServerConn{Conn: rc}
err := sc.Handshake(s.host, s.path)
return sc, err
}
// Handshake handshakes with the client.
func (c *ServerConn) Handshake(host, path string) error {
tpr := textproto.NewReader(bufio.NewReader(c.Conn))
line, err := tpr.ReadLine()
if err != nil {
return err
}
_, path, _, ok := parseFirstLine(line)
if !ok || path != path {
return errors.New("[ws] error in ws handshake parseFirstLine")
}
reqHeader, err := tpr.ReadMIMEHeader()
if err != nil {
return err
}
if reqHeader.Get("Host") != host {
return errors.New("[ws] got wrong host")
}
clientKey := reqHeader.Get("Sec-WebSocket-Key")
serverKey := computeServerKey(clientKey)
buf := pool.GetWriteBuffer()
defer pool.PutWriteBuffer(buf)
buf.WriteString("HTTP/1.1 101 Switching Protocols\r\n")
buf.WriteString("Upgrade: websocket\r\n")
buf.WriteString("Connection: Upgrade\r\n")
buf.WriteString("Sec-WebSocket-Accept: " + serverKey + "\r\n")
buf.WriteString("Sec-WebSocket-Protocol: binary\r\n")
buf.WriteString(("\r\n"))
_, err = c.Conn.Write(buf.Bytes())
return err
}
func (c *ServerConn) Write(b []byte) (n int, err error) {
if c.writer == nil {
c.writer = FrameWriter(c.Conn, false)
}
return c.writer.Write(b)
}
func (c *ServerConn) Read(b []byte) (n int, err error) {
if c.reader == nil {
c.reader = FrameReader(c.Conn, false)
}
return c.reader.Read(b)
}
+38 -36
View File
@@ -2,29 +2,33 @@
package ws
import (
"errors"
"crypto/rand"
"crypto/sha1"
"encoding/base64"
"net"
"net/url"
"strings"
"github.com/nadoo/glider/log"
"github.com/nadoo/glider/pool"
"github.com/nadoo/glider/proxy"
)
var keyGUID = []byte("258EAFA5-E914-47DA-95CA-C5AB0DC85B11")
// WS is the base ws proxy struct.
type WS struct {
dialer proxy.Dialer
proxy proxy.Proxy
addr string
host string
path string
client *Client
}
func init() {
proxy.RegisterDialer("ws", NewWSDialer)
server proxy.Server
}
// NewWS returns a websocket proxy.
func NewWS(s string, d proxy.Dialer) (*WS, error) {
func NewWS(s string, d proxy.Dialer, p proxy.Proxy) (*WS, error) {
u, err := url.Parse(s)
if err != nil {
log.F("[ws] parse url err: %s", err)
@@ -38,49 +42,47 @@ func NewWS(s string, d proxy.Dialer) (*WS, error) {
addr = d.Addr()
}
p := &WS{
w := &WS{
dialer: d,
proxy: p,
addr: addr,
host: u.Query().Get("host"),
path: u.Path,
}
if p.host == "" {
p.host, _, _ = net.SplitHostPort(addr)
if w.host == "" {
w.host, _, _ = net.SplitHostPort(addr)
}
p.client, err = NewClient(p.host, u.Path)
if err != nil {
log.F("[ws] create ws client error: %s", err)
return nil, err
if w.path == "" {
w.path = "/"
}
return p, nil
return w, nil
}
// NewWSDialer returns a ws proxy dialer.
func NewWSDialer(s string, d proxy.Dialer) (proxy.Dialer, error) {
return NewWS(s, d)
}
// Addr returns forwarder's address.
func (s *WS) Addr() string {
if s.addr == "" {
return s.dialer.Addr()
// parseFirstLine parses "GET /foo HTTP/1.1" OR "HTTP/1.1 200 OK" into its three parts.
// TODO: move to separate http lib package for reuse(also for http proxy module)
func parseFirstLine(line string) (r1, r2, r3 string, ok bool) {
s1 := strings.Index(line, " ")
s2 := strings.Index(line[s1+1:], " ")
if s1 < 0 || s2 < 0 {
return
}
return s.addr
s2 += s1 + 1
return line[:s1], line[s1+1 : s2], line[s2+1:], true
}
// Dial connects to the address addr on the network net via the proxy.
func (s *WS) Dial(network, addr string) (net.Conn, error) {
rc, err := s.dialer.Dial("tcp", s.addr)
if err != nil {
return nil, err
}
return s.client.NewConn(rc, addr)
func generateClientKey() string {
p := pool.GetBuffer(16)
defer pool.PutBuffer(p)
rand.Read(p)
return base64.StdEncoding.EncodeToString(p)
}
// DialUDP connects to the given address via the proxy.
func (s *WS) DialUDP(network, addr string) (net.PacketConn, net.Addr, error) {
return nil, nil, errors.New("[ws] ws client does not support udp now")
func computeServerKey(clientKey string) string {
h := sha1.New()
h.Write([]byte(clientKey))
h.Write(keyGUID)
return base64.StdEncoding.EncodeToString(h.Sum(nil))
}