proxy

package
v1.8.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 7, 2025 License: MIT Imports: 28 Imported by: 32

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Addon added in v1.0.0 

type Addon interface {
	// A client has connected to mitmproxy. Note that a connection can correspond to multiple HTTP requests.
	ClientConnected(*ClientConn)

	// A client connection has been closed (either by us or the client).
	ClientDisconnected(*ClientConn)

	// Mitmproxy has connected to a server.
	ServerConnected(*ConnContext)

	// A server connection has been closed (either by us or the server).
	ServerDisconnected(*ConnContext)

	// The TLS handshake with the server has been completed successfully.
	TlsEstablishedServer(*ConnContext)

	// HTTP request headers were successfully read. At this point, the body is empty.
	Requestheaders(*Flow)

	// The full HTTP request has been read.
	Request(*Flow)

	// HTTP response headers were successfully read. At this point, the body is empty.
	Responseheaders(*Flow)

	// The full HTTP response has been read.
	Response(*Flow)

	// Stream request body modifier
	StreamRequestModifier(*Flow, io.Reader) io.Reader

	// Stream response body modifier
	StreamResponseModifier(*Flow, io.Reader) io.Reader

	// onAccessProxyServer
	AccessProxyServer(req *http.Request, res http.ResponseWriter)
}

type BaseAddon added in v1.0.0 

type BaseAddon struct{}

BaseAddon do nothing

func (*BaseAddon) AccessProxyServer added in v1.6.2 

func (addon *BaseAddon) AccessProxyServer(req *http.Request, res http.ResponseWriter)

func (*BaseAddon) ClientConnected added in v1.0.0 

func (addon *BaseAddon) ClientConnected(*ClientConn)

func (*BaseAddon) ClientDisconnected added in v1.0.0 

func (addon *BaseAddon) ClientDisconnected(*ClientConn)

func (*BaseAddon) Request added in v1.0.0 

func (addon *BaseAddon) Request(*Flow)

func (*BaseAddon) Requestheaders added in v1.0.0 

func (addon *BaseAddon) Requestheaders(*Flow)

func (*BaseAddon) Response added in v1.0.0 

func (addon *BaseAddon) Response(*Flow)

func (*BaseAddon) Responseheaders added in v1.0.0 

func (addon *BaseAddon) Responseheaders(*Flow)

func (*BaseAddon) ServerConnected added in v1.0.0 

func (addon *BaseAddon) ServerConnected(*ConnContext)

func (*BaseAddon) ServerDisconnected added in v1.0.0 

func (addon *BaseAddon) ServerDisconnected(*ConnContext)

func (*BaseAddon) StreamRequestModifier added in v1.1.0 

func (addon *BaseAddon) StreamRequestModifier(f *Flow, in io.Reader) io.Reader

func (*BaseAddon) StreamResponseModifier added in v1.1.0 

func (addon *BaseAddon) StreamResponseModifier(f *Flow, in io.Reader) io.Reader

func (*BaseAddon) TlsEstablishedServer added in v1.0.0 

func (addon *BaseAddon) TlsEstablishedServer(*ConnContext)

type ClientConn added in v1.0.0 

type ClientConn struct {
	Id                 uuid.UUID
	Conn               net.Conn
	Tls                bool
	NegotiatedProtocol string
	UpstreamCert       bool // Connect to upstream server to look up certificate details. Default: True
	// contains filtered or unexported fields
}

client connection

func (*ClientConn) MarshalJSON added in v1.0.0 

func (c *ClientConn) MarshalJSON() ([]byte, error)

type ConnContext added in v1.0.0 

type ConnContext struct {
	ClientConn *ClientConn   `json:"clientConn"`
	ServerConn *ServerConn   `json:"serverConn"`
	Intercept  bool          `json:"intercept"` // Indicates whether to parse HTTPS
	FlowCount  atomic.Uint32 `json:"-"`         // Number of HTTP requests made on the same connection
	// contains filtered or unexported fields
}

connection context

func (*ConnContext) Id added in v1.0.0 

func (connCtx *ConnContext) Id() uuid.UUID

type Flow added in v1.0.0 

type Flow struct {
	Id          uuid.UUID
	ConnContext *ConnContext
	Request     *Request
	Response    *Response

	// https://docs.mitmproxy.org/stable/overview-features/#streaming
	// 如果为 true，则不缓冲 Request.Body 和 Response.Body，且不进入之后的 Addon.Request 和 Addon.Response
	Stream            bool
	UseSeparateClient bool // use separate http client to send http request
	// contains filtered or unexported fields
}

flow

func (*Flow) Done added in v1.0.0 

func (f *Flow) Done() <-chan struct{}

func (*Flow) MarshalJSON added in v1.0.0 

func (f *Flow) MarshalJSON() ([]byte, error)

type InstanceLogAddon added in v1.8.6 

type InstanceLogAddon struct {
	BaseAddon
	// contains filtered or unexported fields
}

InstanceLogAddon logs with instance identification

func NewInstanceLogAddonWithFile added in v1.8.6 

func NewInstanceLogAddonWithFile(addr string, instanceName string, logFilePath string) *InstanceLogAddon

NewInstanceLogAddonWithFile creates a new instance-aware log addon with file output

func (*InstanceLogAddon) ClientConnected added in v1.8.6 

func (addon *InstanceLogAddon) ClientConnected(client *ClientConn)

func (*InstanceLogAddon) ClientDisconnected added in v1.8.6 

func (addon *InstanceLogAddon) ClientDisconnected(client *ClientConn)

func (*InstanceLogAddon) Request added in v1.8.6 

func (addon *InstanceLogAddon) Request(f *Flow)

func (*InstanceLogAddon) Requestheaders added in v1.8.6 

func (addon *InstanceLogAddon) Requestheaders(f *Flow)

func (*InstanceLogAddon) Response added in v1.8.6 

func (addon *InstanceLogAddon) Response(f *Flow)

func (*InstanceLogAddon) ServerConnected added in v1.8.6 

func (addon *InstanceLogAddon) ServerConnected(connCtx *ConnContext)

func (*InstanceLogAddon) ServerDisconnected added in v1.8.6 

func (addon *InstanceLogAddon) ServerDisconnected(connCtx *ConnContext)

func (*InstanceLogAddon) SetLogger added in v1.8.6 

func (addon *InstanceLogAddon) SetLogger(logger *InstanceLogger)

SetLogger allows setting a custom instance logger

func (*InstanceLogAddon) TlsEstablishedServer added in v1.8.6 

func (addon *InstanceLogAddon) TlsEstablishedServer(connCtx *ConnContext)

type InstanceLogger added in v1.8.6 

type InstanceLogger struct {
	InstanceID   string
	InstanceName string
	Port         string
	LogFilePath  string
	// contains filtered or unexported fields
}

func NewInstanceLogger added in v1.8.6 

func NewInstanceLogger(addr string, instanceName string) *InstanceLogger

NewInstanceLogger creates a logger with instance identification

func NewInstanceLoggerWithFile added in v1.8.6 

func NewInstanceLoggerWithFile(addr string, instanceName string, logFilePath string) *InstanceLogger

NewInstanceLoggerWithFile creates a logger with instance identification and optional file output

func (*InstanceLogger) Debug added in v1.8.6 

func (il *InstanceLogger) Debug(args ...interface{})

Debug logs at debug level

func (*InstanceLogger) Debugf added in v1.8.6 

func (il *InstanceLogger) Debugf(format string, args ...interface{})

Debugf logs formatted at debug level

func (*InstanceLogger) Error added in v1.8.6 

func (il *InstanceLogger) Error(args ...interface{})

Error logs at error level

func (*InstanceLogger) Errorf added in v1.8.6 

func (il *InstanceLogger) Errorf(format string, args ...interface{})

Errorf logs formatted at error level

func (*InstanceLogger) Fatal added in v1.8.6 

func (il *InstanceLogger) Fatal(args ...interface{})

Fatal logs at fatal level

func (*InstanceLogger) Fatalf added in v1.8.6 

func (il *InstanceLogger) Fatalf(format string, args ...interface{})

Fatalf logs formatted at fatal level

func (*InstanceLogger) GetEntry added in v1.8.6 

func (il *InstanceLogger) GetEntry() *log.Entry

GetEntry returns the underlying logrus entry

func (*InstanceLogger) Info added in v1.8.6 

func (il *InstanceLogger) Info(args ...interface{})

Info logs at info level

func (*InstanceLogger) Infof added in v1.8.6 

func (il *InstanceLogger) Infof(format string, args ...interface{})

Infof logs formatted at info level

func (*InstanceLogger) Warn added in v1.8.6 

func (il *InstanceLogger) Warn(args ...interface{})

Warn logs at warn level

func (*InstanceLogger) Warnf added in v1.8.6 

func (il *InstanceLogger) Warnf(format string, args ...interface{})

Warnf logs formatted at warn level

func (*InstanceLogger) WithFields added in v1.8.6 

func (il *InstanceLogger) WithFields(fields log.Fields) *log.Entry

WithFields adds additional fields to the logger

type LogAddon added in v1.0.0 

type LogAddon struct {
	BaseAddon
}

LogAddon log connection and flow

func (*LogAddon) ClientConnected added in v1.0.0 

func (addon *LogAddon) ClientConnected(client *ClientConn)

func (*LogAddon) ClientDisconnected added in v1.0.0 

func (addon *LogAddon) ClientDisconnected(client *ClientConn)

func (*LogAddon) Requestheaders added in v1.0.0 

func (addon *LogAddon) Requestheaders(f *Flow)

func (*LogAddon) ServerConnected added in v1.0.0 

func (addon *LogAddon) ServerConnected(connCtx *ConnContext)

func (*LogAddon) ServerDisconnected added in v1.0.0 

func (addon *LogAddon) ServerDisconnected(connCtx *ConnContext)

type Options 

type Options struct {
	Debug             int
	Addr              string
	StreamLargeBodies int64 // 当请求或响应体大于此字节时，转为 stream 模式
	SslInsecure       bool
	CaRootPath        string
	NewCaFunc         func() (cert.CA, error) //创建 Ca 的函数
	Upstream          string
	LogFilePath       string // Path to write logs to file
}

type Proxy 

type Proxy struct {
	Opts    *Options
	Version string
	Addons  []Addon
	// contains filtered or unexported fields
}

func NewProxy 

func NewProxy(opts *Options) (*Proxy, error)

func (*Proxy) AddAddon 

func (proxy *Proxy) AddAddon(addon Addon)

func (*Proxy) Close added in v1.3.0 

func (proxy *Proxy) Close() error

func (*Proxy) GetCertificate added in v1.3.4 

func (proxy *Proxy) GetCertificate() x509.Certificate

func (*Proxy) GetCertificateByCN added in v1.8.2 

func (proxy *Proxy) GetCertificateByCN(commonName string) (*tls.Certificate, error)

func (*Proxy) SetAuthProxy added in v1.8.6 

func (proxy *Proxy) SetAuthProxy(fn func(res http.ResponseWriter, req *http.Request) (bool, error))

func (*Proxy) SetShouldInterceptRule added in v1.3.4 

func (proxy *Proxy) SetShouldInterceptRule(rule func(req *http.Request) bool)

func (*Proxy) SetUpstreamProxy added in v1.7.0 

func (proxy *Proxy) SetUpstreamProxy(fn func(req *http.Request) (*url.URL, error))

func (*Proxy) Shutdown added in v1.3.0 

func (proxy *Proxy) Shutdown(ctx context.Context) error

func (*Proxy) Start 

func (proxy *Proxy) Start() error

type Request added in v1.0.0 

type Request struct {
	Method string
	URL    *url.URL
	Proto  string
	Header http.Header
	Body   []byte
	// contains filtered or unexported fields
}

flow http request

func (*Request) MarshalJSON added in v1.0.0 

func (req *Request) MarshalJSON() ([]byte, error)

func (*Request) Raw added in v1.0.0 

func (r *Request) Raw() *http.Request

func (*Request) UnmarshalJSON added in v1.0.0 

func (req *Request) UnmarshalJSON(data []byte) error

type Response added in v1.0.0 

type Response struct {
	StatusCode int         `json:"statusCode"`
	Header     http.Header `json:"header"`
	Body       []byte      `json:"-"`
	BodyReader io.Reader
	// contains filtered or unexported fields
}

flow http response

func (*Response) DecodedBody added in v1.0.0 

func (r *Response) DecodedBody() ([]byte, error)

func (*Response) IsTextContentType added in v1.0.0 

func (r *Response) IsTextContentType() bool

func (*Response) ReplaceToDecodedBody added in v1.0.0 

func (r *Response) ReplaceToDecodedBody()

type ServerConn added in v1.0.0 

type ServerConn struct {
	Id      uuid.UUID
	Address string
	Conn    net.Conn
	// contains filtered or unexported fields
}

server connection

func (*ServerConn) MarshalJSON added in v1.0.0 

func (c *ServerConn) MarshalJSON() ([]byte, error)

func (*ServerConn) TlsState added in v1.0.0 

func (c *ServerConn) TlsState() *tls.ConnectionState

type UpstreamCertAddon added in v1.8.0 

type UpstreamCertAddon struct {
	BaseAddon
	UpstreamCert bool // Connect to upstream server to look up certificate details.
}

func NewUpstreamCertAddon added in v1.8.0 

func NewUpstreamCertAddon(upstreamCert bool) *UpstreamCertAddon

func (*UpstreamCertAddon) ClientConnected added in v1.8.0 

func (addon *UpstreamCertAddon) ClientConnected(conn *ClientConn)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.