nuclei/v2/pkg/js/libs/net/net.go
Tarun Koyalwar 4f93520e47
javascript protocol for scripting (includes 15+ proto libs) (#4109)
* rebase js-layer PR from @ice3man543

* package restructuring

* working

* fix duplicated event & matcher status

* fix lint error

* fix response field

* add new functions

* multiple minor improvements

* fix incorrect stats in js protocol

* sort output metadata in cli

* remove temp files

* remove dead code

* add unit and integration test

* fix lint error

* add jsdoclint using llm

* fix error in test

* add js lint using llm

* generate docs of libs

* llm lint

* remove duplicated docs

* update generated docs

* update prompt in doclint

* update docs

* temp disable version check test

* fix unit test and add retry

* fix panic in it

* update and move jsdocs

* updated jsdocs

* update docs

* update container platform in test

* dir restructure and adding docs

* add api_reference and remove markdown docs

* fix imports

* add javascript design and contribution docs

* add js protocol documentation

* update integration test and docs

* update doc ext mdx->md

* minor update to docs

* new integration test and more

* move go libs and add docs

* gen new net docs and more

* final docs update

* add new devtool

* use fastdialer

* fix build fail

* use fastdialer + network sandbox support

* add reserved keyword 'Port'

* update Port to new syntax

* misc update

* always enable templatectx in js protocol

* move docs to 'js-proto-docs' repo

* remove scrapefuncs binary

---------

Co-authored-by: sandeep <8293321+ehsandeep@users.noreply.github.com>
2023-09-16 16:02:17 +05:30

158 lines
3.8 KiB
Go

package net
import (
"context"
"crypto/tls"
"encoding/hex"
"errors"
"fmt"
"net"
"syscall"
"time"
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/protocolstate"
"github.com/projectdiscovery/nuclei/v2/pkg/types"
)
// Open opens a new connection to the address with a timeout.
// supported protocols: tcp, udp
func Open(protocol, address string) (*NetConn, error) {
conn, err := protocolstate.Dialer.Dial(context.TODO(), protocol, address)
if err != nil {
return nil, err
}
return &NetConn{conn: conn}, nil
}
// Open opens a new connection to the address with a timeout.
// supported protocols: tcp, udp
func OpenTLS(protocol, address string) (*NetConn, error) {
config := &tls.Config{InsecureSkipVerify: true}
host, _, _ := net.SplitHostPort(address)
if host != "" {
c := config.Clone()
c.ServerName = host
config = c
}
conn, err := protocolstate.Dialer.DialTLSWithConfig(context.TODO(), protocol, address, config)
if err != nil {
return nil, err
}
return &NetConn{conn: conn}, nil
}
// NetConn is a connection to a remote host.
type NetConn struct {
conn net.Conn
timeout time.Duration
}
// Close closes the connection.
func (c *NetConn) Close() error {
err := c.conn.Close()
return err
}
// SetTimeout sets read/write timeout for the connection (in seconds).
func (c *NetConn) SetTimeout(value int) {
c.timeout = time.Duration(value) * time.Second
}
// setDeadLine sets read/write deadline for the connection (in seconds).
// this is intended to be called before every read/write operation.
func (c *NetConn) setDeadLine() {
if c.timeout == 0 {
c.timeout = 5 * time.Second
}
_ = c.conn.SetDeadline(time.Now().Add(c.timeout))
}
// SendArray sends array data to connection
func (c *NetConn) SendArray(data []interface{}) error {
c.setDeadLine()
input := types.ToByteSlice(data)
length, err := c.conn.Write(input)
if err != nil {
return err
}
if length < len(input) {
return fmt.Errorf("failed to write all bytes (%d bytes written, %d bytes expected)", length, len(input))
}
return nil
}
// SendHex sends hex data to connection
func (c *NetConn) SendHex(data string) error {
c.setDeadLine()
bin, err := hex.DecodeString(data)
if err != nil {
return err
}
length, err := c.conn.Write(bin)
if err != nil {
return err
}
if length < len(bin) {
return fmt.Errorf("failed to write all bytes (%d bytes written, %d bytes expected)", length, len(bin))
}
return nil
}
// Send sends data to the connection with a timeout.
func (c *NetConn) Send(data string) error {
c.setDeadLine()
bin := []byte(data)
length, err := c.conn.Write(bin)
if err != nil {
return err
}
if length < len(bin) {
return fmt.Errorf("failed to write all bytes (%d bytes written, %d bytes expected)", length, len(data))
}
return nil
}
// Recv receives data from the connection with a timeout.
// If N is 0, it will read up to 4096 bytes.
func (c *NetConn) Recv(N int) ([]byte, error) {
c.setDeadLine()
var response []byte
if N > 0 {
response = make([]byte, N)
} else {
response = make([]byte, 4096)
}
length, err := c.conn.Read(response)
if err != nil {
var netErr net.Error
if (errors.As(err, &netErr) && netErr.Timeout()) ||
errors.Is(err, syscall.ECONNREFUSED) { // timeout error or connection refused
return response, nil
}
return response[:length], err
}
return response[:length], nil
}
// RecvString receives data from the connection with a timeout
// output is returned as a string.
// If N is 0, it will read up to 4096 bytes.
func (c *NetConn) RecvString(N int) (string, error) {
bin, err := c.Recv(N)
if err != nil {
return "", err
}
return string(bin), nil
}
// RecvHex receives data from the connection with a timeout
// in hex format.
// If N is 0, it will read up to 4096 bytes.
func (c *NetConn) RecvHex(N int) (string, error) {
bin, err := c.Recv(N)
if err != nil {
return "", err
}
return hex.Dump(bin), nil
}