Skip to content

Commit

Permalink
add readonly interceptor
Browse files Browse the repository at this point in the history
  • Loading branch information
micbar committed Jun 30, 2021
1 parent bbcb86f commit f74150b
Show file tree
Hide file tree
Showing 3 changed files with 209 additions and 2 deletions.
6 changes: 5 additions & 1 deletion internal/grpc/interceptors/loader/loader.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,8 @@

package loader

// Add your own.
import (
// Load core GRPC services
_ "github.com/cs3org/reva/internal/grpc/interceptors/readonly"
// Add your own service here
)
167 changes: 167 additions & 0 deletions internal/grpc/interceptors/readonly/readonly.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
// Copyright 2018-2021 CERN
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// In applying this license, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.

package readonly

import (
"context"
provider "github.com/cs3org/go-cs3apis/cs3/storage/provider/v1beta1"
registry "github.com/cs3org/go-cs3apis/cs3/storage/registry/v1beta1"
"github.com/cs3org/reva/pkg/appctx"
"github.com/cs3org/reva/pkg/rgrpc"
rstatus "github.com/cs3org/reva/pkg/rgrpc/status"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)

const (
defaultPriority = 200
)

func init() {
rgrpc.RegisterUnaryInterceptor("readonly", NewUnary)
}

// NewUnary returns a new unary interceptor
// that checks grpc calls and blocks write requests.
func NewUnary(map[string]interface{}) (grpc.UnaryServerInterceptor, int, error) {
return func(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
log := appctx.GetLogger(ctx)

switch req.(type){
// handle known non-write request types
case *provider.CreateHomeRequest,
*provider.GetHomeRequest,
*provider.GetPathRequest,
*provider.GetQuotaRequest,
*registry.GetStorageProvidersRequest,
*provider.InitiateFileDownloadRequest,
*provider.ListFileVersionsRequest,
*provider.ListGrantsRequest,
*provider.ListRecycleRequest:
return handler(ctx, req)
case *provider.ListContainerRequest:
resp, err := handler(ctx, req)
if listResp, ok := resp.(*provider.ListContainerResponse); ok && listResp.Infos != nil {
for _, info := range list_resp.Infos {
// use the existing PermissionsSet and change the writes to false
if info.PermissionSet != nil {
info.PermissionSet.AddGrant = false
info.PermissionSet.CreateContainer = false
info.PermissionSet.Delete = false
info.PermissionSet.InitiateFileUpload = false
info.PermissionSet.Move = false
info.PermissionSet.RemoveGrant = false
info.PermissionSet.PurgeRecycle = false
info.PermissionSet.RestoreFileVersion = false
info.PermissionSet.RestoreRecycleItem = false
info.PermissionSet.UpdateGrant = false
}
}
}
return resp, err
case *provider.StatRequest:
resp, err := handler(ctx, req)
if statResp, ok := resp.(*provider.StatResponse); ok && stat_resp.Info != nil && statResp.Info.PermissionSet != nil {
// use the existing PermissionsSet and change the writes to false
stat_resp.Info.PermissionSet.AddGrant = false
stat_resp.Info.PermissionSet.CreateContainer = false
stat_resp.Info.PermissionSet.Delete = false
stat_resp.Info.PermissionSet.InitiateFileUpload = false
stat_resp.Info.PermissionSet.Move = false
stat_resp.Info.PermissionSet.RemoveGrant = false
stat_resp.Info.PermissionSet.PurgeRecycle = false
stat_resp.Info.PermissionSet.RestoreFileVersion = false
stat_resp.Info.PermissionSet.RestoreRecycleItem = false
stat_resp.Info.PermissionSet.UpdateGrant = false
}
return resp, err
//Don't allow the following requests types
case *provider.AddGrantRequest:
return &provider.AddGrantResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to add grant on readonly storage"),
}, nil
case *provider.CreateContainerRequest:
return &provider.CreateContainerResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to create resoure on readonly storage"),
}, nil
case *provider.DeleteRequest:
return &provider.DeleteResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to delete resource on readonly storage"),
}, nil
case *provider.InitiateFileUploadRequest:
return &provider.InitiateFileUploadResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to upload resource on readonly storage"),
}, nil
case *provider.MoveRequest:
return &provider.MoveResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to move resource on readonly storage"),
}, nil
case *provider.PurgeRecycleRequest:
return &provider.PurgeRecycleResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to purge recycle on readonly storage"),
}, nil
case *provider.RemoveGrantRequest:
return &provider.RemoveGrantResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to remove grant on readonly storage"),
}, nil
case *provider.RestoreRecycleItemRequest:
return &provider.RestoreRecycleItemResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to restore recycle item on readonly storage"),
}, nil
case *provider.SetArbitraryMetadataRequest:
return &provider.SetArbitraryMetadataResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to set arbitrary metadata on readonly storage"),
}, nil
case *provider.UnsetArbitraryMetadataRequest:
return &provider.UnsetArbitraryMetadataResponse{
Status: rstatus.NewPermissionDenied(ctx, nil, "permission denied: tried to unset arbitrary metadata on readonly storage"),
}, nil
// block unknown request types and return error
default:
log.Debug().Msg("storage is readonly")
return nil, status.Errorf(codes.PermissionDenied, "permission denied: tried to execute an unknown operation: %T!", req)
}
}, defaultPriority, nil
}

// NewStream returns a new server stream interceptor
// that checks grpc calls and blocks write requests.
func NewStream() grpc.StreamServerInterceptor {
interceptor := func(srv interface{}, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
ctx := ss.Context()

wrapped := newWrappedServerStream(ctx, ss)
return handler(srv, wrapped)
}
return interceptor
}

func newWrappedServerStream(ctx context.Context, ss grpc.ServerStream) *wrappedServerStream {
return &wrappedServerStream{ServerStream: ss, newCtx: ctx}
}

type wrappedServerStream struct {
grpc.ServerStream
newCtx context.Context
}

func (ss *wrappedServerStream) Context() context.Context {
return ss.newCtx
}
38 changes: 37 additions & 1 deletion internal/http/services/owncloud/ocdav/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ const (
SabredavNotAuthenticated
// SabredavPreconditionFailed maps to HTTP 412
SabredavPreconditionFailed
//SabredavPermissionDenied maps to HTTP 403
SabredavPermissionDenied
//SabredavNotFound maps to HTTP 404
SabredavNotFound
)

var (
Expand All @@ -47,6 +51,8 @@ var (
"Sabre\\DAV\\Exception\\MethodNotAllowed",
"Sabre\\DAV\\Exception\\NotAuthenticated",
"Sabre\\DAV\\Exception\\PreconditionFailed",
"Sabre\\DAV\\Exception\\PermissionDenied",
"Sabre\\DAV\\Exception\\NotFound",
}
)

Expand Down Expand Up @@ -79,7 +85,8 @@ type errorXML struct {
Exception string `xml:"s:exception"`
Message string `xml:"s:message"`
InnerXML []byte `xml:",innerxml"`
Header string `xml:"s:header"`
// Header is used to indicate the conflicting request header
Header string `xml:"s:header,omitempty"`
}

var errInvalidPropfind = errors.New("webdav: invalid propfind")
Expand All @@ -94,12 +101,30 @@ func HandleErrorStatus(log *zerolog.Logger, w http.ResponseWriter, s *rpc.Status
case rpc.Code_CODE_NOT_FOUND:
log.Debug().Interface("status", s).Msg("resource not found")
w.WriteHeader(http.StatusNotFound)
b, err := createWebDavError(SabredavPermissionDenied, s.Message, "")
if err != nil {
log.Error().Interface("status", s).Msg("marshaling xml response failed")
w.WriteHeader(http.StatusInternalServerError)
}
w.Write(b)
case rpc.Code_CODE_PERMISSION_DENIED:
log.Debug().Interface("status", s).Msg("permission denied")
w.WriteHeader(http.StatusForbidden)
b, err := createWebDavError(SabredavPermissionDenied, s.Message, "")
if err != nil {
log.Error().Interface("status", s).Msg("marshaling xml response failed")
w.WriteHeader(http.StatusInternalServerError)
}
w.Write(b)
case rpc.Code_CODE_INVALID_ARGUMENT:
log.Debug().Interface("status", s).Msg("bad request")
w.WriteHeader(http.StatusBadRequest)
b, err := createWebDavError(SabredavBadRequest, s.Message, "")
if err != nil {
log.Error().Interface("status", s).Msg("marshaling xml response failed")
w.WriteHeader(http.StatusInternalServerError)
}
w.Write(b)
case rpc.Code_CODE_UNIMPLEMENTED:
log.Debug().Interface("status", s).Msg("not implemented")
w.WriteHeader(http.StatusNotImplemented)
Expand All @@ -111,3 +136,14 @@ func HandleErrorStatus(log *zerolog.Logger, w http.ResponseWriter, s *rpc.Status
w.WriteHeader(http.StatusInternalServerError)
}
}

func createWebDavError(c code, m string, h string) ([]byte, error) {
body, err := Marshal(
exception {
code: c,
message: m,
header: h,
},
)
return body, err
}

0 comments on commit f74150b

Please sign in to comment.