drone/internal/api/guard/guard.repo.go
Johannes Batzill 1115a5083b Add Paths support and error improvements (#11)
This change is adding the concept of Paths.
A repository and space always have a Primary Path which always is represents the ancestry to the root space.
All access history / resource visibility / child listings / UI traversal / etc. is done via that path.

Additionally, repos and spaces can have Alias Paths, which as the name states are aliases. via the primary path.
They sole impact is that a space or repo can be reached via different paths from the UI / rest apis / git apis.
This fulfills two major purposes:
- Customers can rename or move projects and spaces without breaking any existing references from CI pipeliens / code bases / local repos / ...
- Customer can create shorter aliases for important repos when in harness embeded mode! (acc/org/proj/repo can be shortened to acc/repo, or acc/repo'

Apart from the path changes, this PR adds:

Improved User facing errors
Improved internal error handling and wrapping
update / rename operation for repo and space
path list / delete / create operation for repo and space
2022-09-08 21:39:15 -07:00

108 lines
3.4 KiB
Go

// Copyright 2021 Harness Inc. All rights reserved.
// Use of this source code is governed by the Polyform Free Trial License
// that can be found in the LICENSE.md file for this repository.
package guard
import (
"net/http"
"github.com/harness/gitness/internal/api/render"
"github.com/harness/gitness/internal/api/request"
"github.com/harness/gitness/internal/paths"
"github.com/harness/gitness/types"
"github.com/harness/gitness/types/enum"
"github.com/harness/gitness/types/errs"
"github.com/pkg/errors"
"github.com/rs/zerolog/hlog"
"github.com/rs/zerolog/log"
)
/*
* Returns a middleware that guards repository related handlers from being executed.
* Only principals that are authorized are able to execute the handler, everyone else is forbidden,
* unless orPublic is configured and the repository is public.
*
* Assumes the repository is already available in the request context.
*/
func (e *Guard) ForRepo(requiredPermission enum.Permission, orPublic bool) func(http.Handler) http.Handler {
return func(h http.Handler) http.Handler {
return e.Repo(requiredPermission, orPublic, h.ServeHTTP)
}
}
/*
* Returns an http.HandlerFunc that guards a repository related http.HandlerFunc from being executed.
* Only principals that are authorized are able to execute the handler, everyone else is forbidden,
* unless orPublic is configured and the repository is public.
*
* Assumes the repository is already available in the request context.
*/
func (g *Guard) Repo(permission enum.Permission, orPublic bool, guarded http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()
rep, ok := request.RepoFrom(ctx)
if !ok {
// log error for debugging
log := hlog.FromRequest(r)
log.Error().Msg("Method expects the repository to be availabe in the request context, but it wasnt.")
render.InternalError(w, errs.Internal)
return
}
// Enforce permission (renders error)
if !(orPublic && rep.IsPublic) && !g.EnforceRepo(w, r, permission, rep.Path) {
return
}
// executed guarded function
guarded(w, r)
}
}
/*
* Enforces that the executing principal has requested permission on the repository.
* Returns true if that is the case, otherwise renders the appropriate error and returns false.
*/
func (g *Guard) EnforceRepo(w http.ResponseWriter, r *http.Request, permission enum.Permission, path string) bool {
spacePath, name, err := paths.Disect(path)
if err != nil {
// log error for debugging
hlog.FromRequest(r)
log.Err(err).Msgf("Failed to disect path '%s'.", path)
render.InternalError(w, errs.Internal)
return false
}
scope := &types.Scope{SpacePath: spacePath}
resource := &types.Resource{
Type: enum.ResourceTypeRepo,
Name: name,
}
return g.Enforce(w, r, scope, resource, permission)
}
/*
* Checks whether the principal executing the request has the requested permission on the repository.
* Returns nil if the user is confirmed to be permitted to execute the action, otherwise returns errors
* NotAuthenticated, NotAuthorized, or any unerlaying error.
*/
func (g *Guard) CheckRepo(r *http.Request, permission enum.Permission, path string) error {
parentSpace, name, err := paths.Disect(path)
if err != nil {
return errors.Wrapf(err, "Failed to disect path '%s'", path)
}
scope := &types.Scope{SpacePath: parentSpace}
resource := &types.Resource{
Type: enum.ResourceTypeRepo,
Name: name,
}
return g.Check(r, scope, resource, permission)
}