ginuerzh
bf4af78ebf
Add Go doc comments for all exported symbols, option functions, and internal types across the bypass package and plugin sub-package, following the style of the admission package.
91 lines
2.0 KiB
Go
91 lines
2.0 KiB
Go
// Package bypass implements plugin-based Bypass using gRPC and HTTP
|
|
// transports. Plugins delegate bypass decisions to an external process
|
|
// or service.
|
|
package bypass
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
"github.com/go-gost/core/bypass"
|
|
"github.com/go-gost/core/logger"
|
|
"github.com/go-gost/plugin/bypass/proto"
|
|
ctxvalue "github.com/go-gost/x/ctx"
|
|
"github.com/go-gost/x/internal/plugin"
|
|
"google.golang.org/grpc"
|
|
)
|
|
|
|
// grpcPlugin delegates bypass decisions to a remote gRPC service.
|
|
// If the connection fails or the client is nil, all addresses bypass
|
|
// the proxy (fail-open).
|
|
type grpcPlugin struct {
|
|
conn grpc.ClientConnInterface
|
|
client proto.BypassClient
|
|
log logger.Logger
|
|
}
|
|
|
|
// NewGRPCPlugin creates a Bypass that delegates decisions to a gRPC
|
|
// bypass service at addr. On connection failure, the plugin logs the
|
|
// error and returns a fail-open instance (all addresses bypass).
|
|
func NewGRPCPlugin(name string, addr string, opts ...plugin.Option) bypass.Bypass {
|
|
var options plugin.Options
|
|
for _, opt := range opts {
|
|
opt(&options)
|
|
}
|
|
|
|
log := logger.Default().WithFields(map[string]any{
|
|
"kind": "bypass",
|
|
"bypass": name,
|
|
})
|
|
conn, err := plugin.NewGRPCConn(addr, &options)
|
|
if err != nil {
|
|
log.Error(err)
|
|
}
|
|
|
|
p := &grpcPlugin{
|
|
conn: conn,
|
|
log: log,
|
|
}
|
|
if conn != nil {
|
|
p.client = proto.NewBypassClient(conn)
|
|
}
|
|
return p
|
|
}
|
|
|
|
func (p *grpcPlugin) Contains(ctx context.Context, network, addr string, opts ...bypass.Option) bool {
|
|
if p.client == nil {
|
|
return true
|
|
}
|
|
|
|
var options bypass.Options
|
|
for _, opt := range opts {
|
|
opt(&options)
|
|
}
|
|
|
|
r, err := p.client.Bypass(ctx,
|
|
&proto.BypassRequest{
|
|
Service: options.Service,
|
|
Network: network,
|
|
Addr: addr,
|
|
Client: string(ctxvalue.ClientIDFromContext(ctx)),
|
|
Host: options.Host,
|
|
Path: options.Path,
|
|
})
|
|
if err != nil {
|
|
p.log.Error(err)
|
|
return true
|
|
}
|
|
return r.Ok
|
|
}
|
|
|
|
func (p *grpcPlugin) Close() error {
|
|
if closer, ok := p.conn.(io.Closer); ok {
|
|
return closer.Close()
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (p *grpcPlugin) IsWhitelist() bool {
|
|
return false
|
|
}
|