Skip to content

Add support for gNOI File Services (#406) #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hdwhdw wants to merge 1 commit into
base: 202506
Choose a base branch
from
Open

Add support for gNOI File Services (#406) #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 0 additions & 74 deletions gnmi_server/gnoi.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
"encoding/json"
jwt "github.com/dgrijalva/jwt-go"
log "github.com/golang/glog"
gnoi_file_pb "github.com/openconfig/gnoi/file"
gnoi_os_pb "github.com/openconfig/gnoi/os"
spb "github.com/sonic-net/sonic-gnmi/proto/gnoi"
spb_jwt "github.com/sonic-net/sonic-gnmi/proto/gnoi/jwt"
Expand All @@ -15,7 +14,6 @@ import (
"google.golang.org/grpc/status"
"os"
"os/user"
"strconv"
"strings"
"time"
)
Expand All @@ -24,78 +22,6 @@ const (
stateDB string = "STATE_DB"
)

func ReadFileStat(path string) (*gnoi_file_pb.StatInfo, error) {
sc, err := ssc.NewDbusClient()
if err != nil {
return nil, err
}
defer sc.Close()

log.V(2).Infof("Reading file stat at path %s...", path)
data, err := sc.GetFileStat(path)
if err != nil {
log.V(2).Infof("Failed to read file stat at path %s: %v. Error ", path, err)
return nil, err
}
// Parse the data and populate StatInfo
lastModified, err := strconv.ParseUint(data["last_modified"], 10, 64)
if err != nil {
return nil, err
}

permissions, err := strconv.ParseUint(data["permissions"], 8, 32)
if err != nil {
return nil, err
}

size, err := strconv.ParseUint(data["size"], 10, 64)
if err != nil {
return nil, err
}

umaskStr := data["umask"]
if strings.HasPrefix(umaskStr, "o") {
umaskStr = umaskStr[1:] // Remove leading "o"
}
umask, err := strconv.ParseUint(umaskStr, 8, 32)
if err != nil {
return nil, err
}

statInfo := &gnoi_file_pb.StatInfo{
Path: data["path"],
LastModified: lastModified,
Permissions: uint32(permissions),
Size: size,
Umask: uint32(umask),
}
return statInfo, nil
}

func (srv *FileServer) Stat(ctx context.Context, req *gnoi_file_pb.StatRequest) (*gnoi_file_pb.StatResponse, error) {
_, err := authenticate(srv.config, ctx, "gnoi", false)
if err != nil {
return nil, err
}
path := req.GetPath()
log.V(1).Info("gNOI: Read File Stat")
log.V(1).Info("Request: ", req)
statInfo, err := ReadFileStat(path)
if err != nil {
return nil, err
}
resp := &gnoi_file_pb.StatResponse{
Stats: []*gnoi_file_pb.StatInfo{statInfo},
}
return resp, nil
}

// TODO: Support GNOI File Get
func (srv *FileServer) Get(req *gnoi_file_pb.GetRequest, stream gnoi_file_pb.File_GetServer) error {
log.V(1).Info("gNOI: File Get")
return status.Errorf(codes.Unimplemented, "")
}

func (srv *OSServer) Verify(ctx context.Context, req *gnoi_os_pb.VerifyRequest) (*gnoi_os_pb.VerifyResponse, error) {
_, err := authenticate(srv.config, ctx, "gnoi", false)
if err != nil {
Expand Down
148 changes: 148 additions & 0 deletions gnmi_server/gnoi_file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
package gnmi

import (
"context"
"strconv"
"strings"

log "github.com/golang/glog"
gnoi_file_pb "github.com/openconfig/gnoi/file"
ssc "github.com/sonic-net/sonic-gnmi/sonic_service_client"

"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)

func (srv *FileServer) Stat(ctx context.Context, req *gnoi_file_pb.StatRequest) (*gnoi_file_pb.StatResponse, error) {
log.Infof("GNOI File Stat RPC called with request: %+v", req)
_, err := authenticate(srv.config, ctx, "gnoi", false)
if err != nil {
log.Errorf("authentication failed in Stat RPC: %v", err)
return nil, err
}
path := req.GetPath()
log.V(1).Info("Request: ", req)
statInfo, err := readFileStat(path)
if err != nil {
log.Errorf("readFileStat error: %v", err)
return nil, err
}
resp := &gnoi_file_pb.StatResponse{
Stats: []*gnoi_file_pb.StatInfo{statInfo},
}
return resp, nil
}

func readFileStat(path string) (*gnoi_file_pb.StatInfo, error) {
sc, err := ssc.NewDbusClient()
if err != nil {
log.Errorf("DbusClient init failed: %v", err)
return nil, status.Errorf(codes.Internal, "DBus client init failed: %v", err)
}
defer sc.Close()
data, err := sc.GetFileStat(path)
if err != nil {
log.V(2).Infof("Failed to read file stat at path %s: %v. Error ", path, err)
return nil, err
}
// Parse the data and populate StatInfo
lastModified, err := strconv.ParseUint(data["last_modified"], 10, 64)
if err != nil {
log.Errorf("Stat Fails on Invalid last_modified %v", err)
return nil, err
}

permissions, err := strconv.ParseUint(data["permissions"], 8, 32)
if err != nil {
log.Errorf("Stat Fails on Invalid permissions: %v", err)
return nil, err
}

size, err := strconv.ParseUint(data["size"], 10, 64)
if err != nil {
log.Errorf("Stat Fails on Invalid size: %v", err)
return nil, err
}

umaskStr := data["umask"]
if strings.HasPrefix(umaskStr, "o") {
umaskStr = umaskStr[1:] // Remove leading "o"
}
umask, err := strconv.ParseUint(umaskStr, 8, 32)
if err != nil {
log.Errorf("Stat Fails on Invalid umaskStr: %v", err)
return nil, err
}

statInfo := &gnoi_file_pb.StatInfo{
Path: data["path"],
LastModified: lastModified,
Permissions: uint32(permissions),
Size: size,
Umask: uint32(umask),
}
return statInfo, nil
}

// Get RPC is unimplemented.
func (srv *FileServer) Get(req *gnoi_file_pb.GetRequest, stream gnoi_file_pb.File_GetServer) error {
log.Infof("GNOI File Get RPC called with request: %+v", req)
_, err := authenticate(srv.config, stream.Context(), "gnoi", false)
if err != nil {
log.Errorf("authentication failed in Get RPC: %v", err)
return err
}
log.Warning("file.Get RPC is unimplemented")
return status.Errorf(codes.Unimplemented, "Method file.Get is unimplemented.")
}

// TransferToRemote RPC is unimplemented.
func (srv *FileServer) TransferToRemote(ctx context.Context, req *gnoi_file_pb.TransferToRemoteRequest) (*gnoi_file_pb.TransferToRemoteResponse, error) {
log.Infof("GNOI File TransferToRemote RPC called with request: %+v", req)
_, err := authenticate(srv.config, ctx, "gnoi", false)
if err != nil {
log.Errorf("authentication failed in TransferToRemote RPC: %v", err)
return nil, err
}
log.Warning("file.TransferToRemote RPC is unimplemented")
return nil, status.Errorf(codes.Unimplemented, "Method file.TransferToRemote is unimplemented.")
}

// Put RPC is unimplemented.
func (srv *FileServer) Put(stream gnoi_file_pb.File_PutServer) error {
log.Infof("GNOI File Put RPC called")
_, err := authenticate(srv.config, stream.Context(), "gnoi", false)
if err != nil {
log.Errorf("authentication failed in Put RPC: %v", err)
return err
}
log.Warning("file.Put RPC is unimplemented")
return status.Errorf(codes.Unimplemented, "Method file.Put is unimplemented.")
}

// Remove implements the corresponding RPC.
func (srv *FileServer) Remove(ctx context.Context, req *gnoi_file_pb.RemoveRequest) (*gnoi_file_pb.RemoveResponse, error) {
log.Infof("GNOI File Remove RPC called with request: %+v", req)
if req == nil {
log.Errorf("Nil request received")
return nil, status.Error(codes.InvalidArgument, "Invalid nil request.")
}
_, err := authenticate(srv.config, ctx, "gnoi", false)
if err != nil {
log.Errorf("authentication failed in Remove RPC: %v", err)
return nil, err
}
if req.GetRemoteFile() == "" {
log.Errorf("Invalid request: remote_file field is empty")
return nil, status.Error(codes.InvalidArgument, "Invalid request: remote_file field is empty.")
}
sc, err := ssc.NewDbusClient()
if err != nil {
log.Errorf("NewDbusClient error: %v", err)
return nil, err
}
defer sc.Close()
err = sc.RemoveFile(req.GetRemoteFile())
log.Errorf("Remove RPC failed: %v", err)
return &gnoi_file_pb.RemoveResponse{}, err
}
Loading