feat(grpc): support gNMI basic auth and subscription modes #125
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,19 +9,42 @@ import ( | |
| "time" | ||
|
|
||
| gnmi "github.com/openconfig/gnmi/proto/gnmi" | ||
| auth "github.com/universal-tool-calling-protocol/go-utcp/src/auth" | ||
| "github.com/universal-tool-calling-protocol/go-utcp/src/grpcpb" | ||
| . "github.com/universal-tool-calling-protocol/go-utcp/src/providers/base" | ||
| providers "github.com/universal-tool-calling-protocol/go-utcp/src/providers/grpc" | ||
| transports "github.com/universal-tool-calling-protocol/go-utcp/src/transports/grpc" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/metadata" | ||
| ) | ||
|
|
||
| type UnifiedServer struct { | ||
| gnmi.UnimplementedGNMIServer | ||
| grpcpb.UnimplementedUTCPServiceServer | ||
| } | ||
|
|
||
| const ( | ||
| user = "alice" | ||
| pass = "secret" | ||
| ) | ||
|
|
||
| func checkCreds(ctx context.Context) error { | ||
| md, ok := metadata.FromIncomingContext(ctx) | ||
| if !ok { | ||
| return fmt.Errorf("missing metadata") | ||
| } | ||
| u := md.Get("username") | ||
| p := md.Get("password") | ||
| if len(u) == 0 || len(p) == 0 || u[0] != user || p[0] != pass { | ||
| return fmt.Errorf("unauthorized") | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (s *UnifiedServer) CallTool(ctx context.Context, req *grpcpb.ToolCallRequest) (*grpcpb.ToolCallResponse, error) { | ||
| if err := checkCreds(ctx); err != nil { | ||
| return nil, err | ||
| } | ||
| // Simple implementation - could be expanded based on tool name | ||
| return &grpcpb.ToolCallResponse{ | ||
| ResultJson: `{"status": "not implemented for non-streaming"}`, | ||
|
|
@@ -31,6 +54,10 @@ func (s *UnifiedServer) CallTool(ctx context.Context, req *grpcpb.ToolCallReques | |
| func (s *UnifiedServer) CallToolStream(req *grpcpb.ToolCallRequest, stream grpcpb.UTCPService_CallToolStreamServer) error { | ||
| ctx := stream.Context() | ||
|
|
||
| if err := checkCreds(ctx); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if req.Tool == "gnmi_subscribe" { | ||
| // Parse args from JSON | ||
| var args map[string]interface{} | ||
|
|
@@ -52,10 +79,12 @@ func (s *UnifiedServer) CallToolStream(req *grpcpb.ToolCallRequest, stream grpcp | |
|
|
||
| // Create a mock update response | ||
| update := map[string]interface{}{ | ||
| "timestamp": time.Now().UnixNano(), | ||
| "path": args["path"], | ||
| "value": fmt.Sprintf("mock_value_%d", counter), | ||
| "mode": args["mode"], | ||
| "sub_mode": args["sub_mode"], | ||
| "sample_interval_ns": args["sample_interval_ns"], | ||
| } | ||
|
|
||
| updateJson, err := json.Marshal(update) | ||
|
|
@@ -84,10 +113,16 @@ func (s *UnifiedServer) CallToolStream(req *grpcpb.ToolCallRequest, stream grpcp | |
| } | ||
|
|
||
| func (s *UnifiedServer) Capabilities(ctx context.Context, req *gnmi.CapabilityRequest) (*gnmi.CapabilityResponse, error) { | ||
| if err := checkCreds(ctx); err != nil { | ||
| return nil, err | ||
| } | ||
| return &gnmi.CapabilityResponse{}, nil | ||
| } | ||
|
|
||
| func (s *UnifiedServer) GetManual(ctx context.Context, e *grpcpb.Empty) (*grpcpb.Manual, error) { | ||
| if err := checkCreds(ctx); err != nil { | ||
| return nil, err | ||
| } | ||
| return &grpcpb.Manual{ | ||
| Version: "1.2", | ||
| Tools: []*grpcpb.Tool{ | ||
|
|
@@ -97,14 +132,22 @@ func (s *UnifiedServer) GetManual(ctx context.Context, e *grpcpb.Empty) (*grpcpb | |
| } | ||
|
|
||
| func (s *UnifiedServer) Subscribe(stream gnmi.GNMI_SubscribeServer) error { | ||
| ctx := stream.Context() | ||
|
|
||
| if err := checkCreds(ctx); err != nil { | ||
| return err | ||
| } | ||
| if _, err := stream.Recv(); err != nil { | ||
| return err | ||
| } | ||
| resp := &gnmi.SubscribeResponse{ | ||
| Response: &gnmi.SubscribeResponse_Update{ | ||
| Update: &gnmi.Notification{Update: []*gnmi.Update{{ | ||
| Path: &gnmi.Path{Elem: []*gnmi.PathElem{ | ||
| {Name: "interfaces"}, | ||
| {Name: "interface", Key: map[string]string{"name": "eth0"}}, | ||
| }}, | ||
| Val: &gnmi.TypedValue{Value: &gnmi.TypedValue_StringVal{StringVal: "UP"}}, | ||
| }}}, | ||
| }, | ||
| } | ||
|
|
@@ -130,14 +173,15 @@ func main() { | |
|
|
||
| logger := func(format string, args ...interface{}) { log.Printf(format, args...) } | ||
| tr := transports.NewGRPCClientTransport(logger) | ||
| var a auth.Auth = auth.NewBasicAuth(user, pass) | ||
| prov := &providers.GRPCProvider{BaseProvider: BaseProvider{Name: "g", ProviderType: ProviderGRPC}, Host: "127.0.0.1", Port: 9339, ServiceName: "gnmi.gNMI", MethodName: "Subscribe", Auth: &a} | ||
|
|
||
| ctx := context.Background() | ||
| if _, err := tr.RegisterToolProvider(ctx, prov); err != nil { | ||
| log.Fatalf("register: %v", err) | ||
| } | ||
|
|
||
| stream, err := tr.CallToolStream(ctx, "gnmi_subscribe", map[string]any{"path": "/interfaces/interface[name=eth0]", "mode": "STREAM", "sub_mode": "SAMPLE", "sample_interval_ns": 500000000}, prov) | ||
| if err != nil { | ||
| log.Fatalf("call stream: %v", err) | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Returning a generic fmt.Errorf here causes gRPC to translate the error to status code "Unknown", so the client cannot properly detect an authentication failure. Use status.Error(codes.Unauthenticated, …) instead to return the correct gRPC status code.
Prompt for AI agents