drone/internal/api/guard/guard.repo.go

71 lines
2.5 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 (
"errors"
"net/http"
"github.com/harness/gitness/internal/api/render"
"github.com/harness/gitness/internal/api/request"
"github.com/harness/gitness/types/enum"
)
/*
* 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 {
render.InternalError(w, errors.New("Expected repository to be available."))
return
}
// Enforce permission (renders error)
if !(orPublic && rep.IsPublic) && !g.EnforceRepo(w, r, permission, rep.Fqn) {
return
}
// executed guarded function
guarded(w, r)
}
}
/*
* Enforces that the executing principal has requested permission on the repository.
* returns true if it's the case, otherwise renders the appropriate error and returns false.
*/
func (g *Guard) EnforceRepo(w http.ResponseWriter, r *http.Request, permission enum.Permission, fqn string) bool {
return g.Enforce(w, r, enum.ResourceTypeRepo, fqn, 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, fqn string) error {
return g.Check(r, enum.ResourceTypeRepo, fqn, permission)
}