Skip to content

Commit

Permalink
Migrate to New Security Model
Browse files Browse the repository at this point in the history
Having access to the compute service should not require direct access to
the region service endpoints.  Move things so privilege is escalated in
the controller/API and not granted to the user directly.
  • Loading branch information
spjmurray committed Nov 5, 2024
1 parent db4c3e0 commit 6fcebbb
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 19 deletions.
2 changes: 2 additions & 0 deletions charts/compute/templates/server/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ spec:
{{- include "unikorn.otlp.flags" . | nindent 8 }}
{{- include "unikorn.identity.flags" . | nindent 8 }}
{{- include "unikorn.region.flags" . | nindent 8 }}
- --client-certificate-namespace={{ .Release.Namespace }}
- --client-certificate-name=unikorn-compute-client-certificate
ports:
- name: http
containerPort: 6080
Expand Down
6 changes: 3 additions & 3 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ require (
github.com/oapi-codegen/runtime v1.1.1
github.com/spf13/pflag v1.0.5
github.com/unikorn-cloud/core v0.1.77
github.com/unikorn-cloud/identity v0.2.42
github.com/unikorn-cloud/region v0.1.44
github.com/unikorn-cloud/identity v0.2.44
github.com/unikorn-cloud/region v0.1.45
go.opentelemetry.io/otel/sdk v1.31.0
k8s.io/api v0.31.1
k8s.io/apimachinery v0.31.1
k8s.io/utils v0.0.0-20240921022957-49e7df575cb6
sigs.k8s.io/controller-runtime v0.19.0
)

Expand Down Expand Up @@ -88,7 +89,6 @@ require (
k8s.io/client-go v0.31.1 // indirect
k8s.io/klog/v2 v2.130.1 // indirect
k8s.io/kube-openapi v0.0.0-20241009091222-67ed5848f094 // indirect
k8s.io/utils v0.0.0-20240921022957-49e7df575cb6 // indirect
sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 // indirect
sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
sigs.k8s.io/yaml v1.4.0 // indirect
Expand Down
8 changes: 4 additions & 4 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,10 @@ github.com/ugorji/go/codec v1.2.12 h1:9LC83zGrHhuUA9l16C9AHXAqEV/2wBQ4nkvumAE65E
github.com/ugorji/go/codec v1.2.12/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg=
github.com/unikorn-cloud/core v0.1.77 h1:DHxIOuS5RAZylzxHF/kUt955TdmE5kJiY/Z2yqC0/e0=
github.com/unikorn-cloud/core v0.1.77/go.mod h1:S9AF4PwTQljImb9w0P2jKjzRe8fLM+rx+ZbxrAHw/yE=
github.com/unikorn-cloud/identity v0.2.42 h1:9amEcydDq23RZYO4rTtxOhVgw/BH1mdXQgq0fWT+RM0=
github.com/unikorn-cloud/identity v0.2.42/go.mod h1:JMbS6iTYzt0OVt5AkqZys3WVnpLabGvUl8kGWcxzFZI=
github.com/unikorn-cloud/region v0.1.44 h1:GJnUHFBkxnOAssHd7NBXY9Zpva6lB5ozKPesHnORVzo=
github.com/unikorn-cloud/region v0.1.44/go.mod h1:N5wS4Js49JR5WARnRwzeVXRL//M+WVKZBAiqQVA7Yao=
github.com/unikorn-cloud/identity v0.2.44 h1:tXV/qsJ77Dkx8ba8gnBFXHWUgBNsJ2oo/5TjnyhkH7U=
github.com/unikorn-cloud/identity v0.2.44/go.mod h1:JMbS6iTYzt0OVt5AkqZys3WVnpLabGvUl8kGWcxzFZI=
github.com/unikorn-cloud/region v0.1.45 h1:qpUwB+s/SEZNHZqwHTYovtWUVdJB2AKEl06NbiIwnOw=
github.com/unikorn-cloud/region v0.1.45/go.mod h1:QqWLEfB8bNRIUAU7h5JjkQsjyJdTV+2ltDYksRjKMds=
github.com/x448/float16 v0.8.4 h1:qLwI1I70+NjRFUR3zs1JPUCgaCXSh3SW62uAKT1mSBM=
github.com/x448/float16 v0.8.4/go.mod h1:14CWIYCyZA/cWjXOioeEpHeN/83MdbZDRQHoFcYsOfg=
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
Expand Down
4 changes: 2 additions & 2 deletions pkg/provisioners/managers/cluster/provisioner.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,14 @@ func (p *Provisioner) getRegionClient(ctx context.Context, traceName string) (co

tokenIssuer := identityclient.NewTokenIssuer(cli, p.options.identityOptions, &p.options.clientOptions, constants.Application, constants.Version)

ctx, err = tokenIssuer.Context(ctx, traceName)
token, err := tokenIssuer.Issue(ctx, traceName)
if err != nil {
return nil, nil, err
}

getter := regionclient.New(cli, p.options.regionOptions, &p.options.clientOptions)

client, err := getter.Client(ctx)
client, err := getter.Client(ctx, token)
if err != nil {
return nil, nil, err
}
Expand Down
42 changes: 33 additions & 9 deletions pkg/server/handler/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,19 @@ limitations under the License.
package handler

import (
"context"
"net/http"
"slices"

"github.com/unikorn-cloud/compute/pkg/openapi"
"github.com/unikorn-cloud/compute/pkg/server/handler/cluster"
"github.com/unikorn-cloud/core/pkg/server/errors"
"github.com/unikorn-cloud/core/pkg/server/util"
identityclient "github.com/unikorn-cloud/identity/pkg/client"
identityapi "github.com/unikorn-cloud/identity/pkg/openapi"
"github.com/unikorn-cloud/identity/pkg/rbac"
regionclient "github.com/unikorn-cloud/region/pkg/client"
regionapi "github.com/unikorn-cloud/region/pkg/openapi"

"sigs.k8s.io/controller-runtime/pkg/client"
)
Expand All @@ -42,21 +45,40 @@ type Handler struct {
// options allows behaviour to be defined on the CLI.
options *Options

// issuer provides privilge escallation for the API so the end user doesn't
// have to be granted unnecessary privilige.
issuer *identityclient.TokenIssuer

// region is a client to access regions.
region *regionclient.Client
}

func New(client client.Client, namespace string, options *Options, region *regionclient.Client) (*Handler, error) {
func New(client client.Client, namespace string, options *Options, issuer *identityclient.TokenIssuer, region *regionclient.Client) (*Handler, error) {
h := &Handler{
client: client,
namespace: namespace,
options: options,
issuer: issuer,
region: region,
}

return h, nil
}

func (h *Handler) regionClient(ctx context.Context) (*regionapi.ClientWithResponses, error) {
token, err := h.issuer.Issue(ctx, "kubernetes-api")
if err != nil {
return nil, err
}

region, err := h.region.Client(ctx, token)
if err != nil {
return nil, err
}

return region, nil
}

/*
func (h *Handler) setCacheable(w http.ResponseWriter) {
w.Header().Add("Cache-Control", fmt.Sprintf("max-age=%d", h.options.CacheMaxAge/time.Second))
Expand All @@ -69,7 +91,7 @@ func (h *Handler) setUncacheable(w http.ResponseWriter) {
}

func (h *Handler) GetApiV1OrganizationsOrganizationIDClusters(w http.ResponseWriter, r *http.Request, organizationID openapi.OrganizationIDParameter) {
region, err := h.region.Client(r.Context())
region, err := h.regionClient(r.Context())
if err != nil {
errors.HandleError(w, r, err)
return
Expand All @@ -81,16 +103,18 @@ func (h *Handler) GetApiV1OrganizationsOrganizationIDClusters(w http.ResponseWri
return
}

ctx := r.Context()

result = slices.DeleteFunc(result, func(resource openapi.ComputeClusterRead) bool {
return rbac.AllowProjectScope(r.Context(), "computeclusters", identityapi.Read, organizationID, resource.Metadata.ProjectId) != nil
return rbac.AllowProjectScope(ctx, "compute:clusters", identityapi.Read, organizationID, resource.Metadata.ProjectId) != nil
})

h.setUncacheable(w)
util.WriteJSONResponse(w, r, http.StatusOK, result)
}

func (h *Handler) PostApiV1OrganizationsOrganizationIDProjectsProjectIDClusters(w http.ResponseWriter, r *http.Request, organizationID openapi.OrganizationIDParameter, projectID openapi.ProjectIDParameter) {
if err := rbac.AllowProjectScope(r.Context(), "computeclusters", identityapi.Create, organizationID, projectID); err != nil {
if err := rbac.AllowProjectScope(r.Context(), "compute:clusters", identityapi.Create, organizationID, projectID); err != nil {
errors.HandleError(w, r, err)
return
}
Expand All @@ -102,7 +126,7 @@ func (h *Handler) PostApiV1OrganizationsOrganizationIDProjectsProjectIDClusters(
return
}

region, err := h.region.Client(r.Context())
region, err := h.regionClient(r.Context())
if err != nil {
errors.HandleError(w, r, err)
return
Expand All @@ -119,12 +143,12 @@ func (h *Handler) PostApiV1OrganizationsOrganizationIDProjectsProjectIDClusters(
}

func (h *Handler) DeleteApiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterID(w http.ResponseWriter, r *http.Request, organizationID openapi.OrganizationIDParameter, projectID openapi.ProjectIDParameter, clusterID openapi.ClusterIDParameter) {
if err := rbac.AllowProjectScope(r.Context(), "computeclusters", identityapi.Delete, organizationID, projectID); err != nil {
if err := rbac.AllowProjectScope(r.Context(), "compute:clusters", identityapi.Delete, organizationID, projectID); err != nil {
errors.HandleError(w, r, err)
return
}

region, err := h.region.Client(r.Context())
region, err := h.regionClient(r.Context())
if err != nil {
errors.HandleError(w, r, err)
return
Expand All @@ -140,7 +164,7 @@ func (h *Handler) DeleteApiV1OrganizationsOrganizationIDProjectsProjectIDCluster
}

func (h *Handler) PutApiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterID(w http.ResponseWriter, r *http.Request, organizationID openapi.OrganizationIDParameter, projectID openapi.ProjectIDParameter, clusterID openapi.ClusterIDParameter) {
if err := rbac.AllowProjectScope(r.Context(), "computeclusters", identityapi.Update, organizationID, projectID); err != nil {
if err := rbac.AllowProjectScope(r.Context(), "compute:clusters", identityapi.Update, organizationID, projectID); err != nil {
errors.HandleError(w, r, err)
return
}
Expand All @@ -152,7 +176,7 @@ func (h *Handler) PutApiV1OrganizationsOrganizationIDProjectsProjectIDClustersCl
return
}

region, err := h.region.Client(r.Context())
region, err := h.regionClient(r.Context())
if err != nil {
errors.HandleError(w, r, err)
return
Expand Down
6 changes: 5 additions & 1 deletion pkg/server/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,13 @@ func (s *Server) GetServer(client client.Client) (*http.Server, error) {
},
}

// NOTE: any clients that are used, must issue new tokens as this service to
// prevent the user having to be granted excessive privilege.
issuer := identityclient.NewTokenIssuer(client, s.IdentityOptions, &s.ClientOptions, constants.Application, constants.Version)

region := regionclient.New(client, s.RegionOptions, &s.ClientOptions)

handlerInterface, err := handler.New(client, s.Options.Namespace, &s.HandlerOptions, region)
handlerInterface, err := handler.New(client, s.Options.Namespace, &s.HandlerOptions, issuer, region)
if err != nil {
return nil, err
}
Expand Down

0 comments on commit 6fcebbb

Please sign in to comment.