Files
threshold/internal/servers/controller/handlers/hosts/host_service.go
T
Jeff Mitchell 727d1c7085 Add "no-op" action and use it as default for scope permissions (#1138)
Because of listing visibility, if no actions are assigned to a user for
an individual resource, it's excluded from the list. This is fine and
good. However, when we made a change in 0.2.0 to restrict the
information returned from listing for the anonymous user for scopes and
auth methods, it exposed the fact that because of the way this
visibility works we had to add `read` to scopes by default -- thereby
rather defeating the purpose of restricting what goes back to `u_anon`
requests.

The purpose of "no-op" is to never be used for real actions within the
API, but as something that can be granted to specifically enable
visibility for the targeted user. This makes the controls over list
visibility much more granular.
2021-04-23 10:13:37 -04:00

463 lines
16 KiB
Go

package hosts
import (
"context"
"fmt"
"net"
"strings"
"github.com/hashicorp/boundary/internal/auth"
"github.com/hashicorp/boundary/internal/errors"
pb "github.com/hashicorp/boundary/internal/gen/controller/api/resources/hosts"
pbs "github.com/hashicorp/boundary/internal/gen/controller/api/services"
"github.com/hashicorp/boundary/internal/host"
"github.com/hashicorp/boundary/internal/host/static"
"github.com/hashicorp/boundary/internal/host/static/store"
"github.com/hashicorp/boundary/internal/perms"
"github.com/hashicorp/boundary/internal/servers/controller/common"
"github.com/hashicorp/boundary/internal/servers/controller/handlers"
"github.com/hashicorp/boundary/internal/types/action"
"github.com/hashicorp/boundary/internal/types/resource"
"google.golang.org/grpc/codes"
"google.golang.org/protobuf/types/known/wrapperspb"
)
var (
maskManager handlers.MaskManager
// IdActions contains the set of actions that can be performed on
// individual resources
IdActions = action.ActionSet{
action.NoOp,
action.Read,
action.Update,
action.Delete,
}
// CollectionActions contains the set of actions that can be performed on
// this collection
CollectionActions = action.ActionSet{
action.Create,
action.List,
}
)
func init() {
var err error
if maskManager, err = handlers.NewMaskManager(&store.Host{}, &pb.Host{}, &pb.StaticHostAttributes{}); err != nil {
panic(err)
}
}
type Service struct {
pbs.UnimplementedHostServiceServer
staticRepoFn common.StaticRepoFactory
}
var _ pbs.HostServiceServer = Service{}
// NewService returns a host Service which handles host related requests to boundary and uses the provided
// repositories for storage and retrieval.
func NewService(repoFn common.StaticRepoFactory) (Service, error) {
const op = "hosts.NewService"
if repoFn == nil {
return Service{}, errors.New(errors.InvalidParameter, op, "missing static repository")
}
return Service{staticRepoFn: repoFn}, nil
}
func (s Service) ListHosts(ctx context.Context, req *pbs.ListHostsRequest) (*pbs.ListHostsResponse, error) {
if err := validateListRequest(req); err != nil {
return nil, err
}
_, authResults := s.parentAndAuthResult(ctx, req.GetHostCatalogId(), action.List)
if authResults.Error != nil {
return nil, authResults.Error
}
hl, err := s.listFromRepo(ctx, req.GetHostCatalogId())
if err != nil {
return nil, err
}
filter, err := handlers.NewFilter(req.GetFilter())
if err != nil {
return nil, err
}
finalItems := make([]*pb.Host, 0, len(hl))
res := &perms.Resource{
ScopeId: authResults.Scope.Id,
Type: resource.Host,
Pin: req.GetHostCatalogId(),
}
for _, item := range hl {
item.Scope = authResults.Scope
item.AuthorizedActions = authResults.FetchActionSetForId(ctx, item.Id, IdActions, auth.WithResource(res)).Strings()
if len(item.AuthorizedActions) == 0 {
continue
}
if filter.Match(item) {
finalItems = append(finalItems, item)
}
}
return &pbs.ListHostsResponse{Items: finalItems}, nil
}
// GetHost implements the interface pbs.HostServiceServer.
func (s Service) GetHost(ctx context.Context, req *pbs.GetHostRequest) (*pbs.GetHostResponse, error) {
if err := validateGetRequest(req); err != nil {
return nil, err
}
_, authResults := s.parentAndAuthResult(ctx, req.GetId(), action.Read)
if authResults.Error != nil {
return nil, authResults.Error
}
hc, err := s.getFromRepo(ctx, req.GetId())
if err != nil {
return nil, err
}
hc.Scope = authResults.Scope
hc.AuthorizedActions = authResults.FetchActionSetForId(ctx, hc.Id, IdActions).Strings()
return &pbs.GetHostResponse{Item: hc}, nil
}
// CreateHost implements the interface pbs.HostServiceServer.
func (s Service) CreateHost(ctx context.Context, req *pbs.CreateHostRequest) (*pbs.CreateHostResponse, error) {
if err := validateCreateRequest(req); err != nil {
return nil, err
}
_, authResults := s.parentAndAuthResult(ctx, req.GetItem().GetHostCatalogId(), action.Create)
if authResults.Error != nil {
return nil, authResults.Error
}
h, err := s.createInRepo(ctx, authResults.Scope.GetId(), req.GetItem().GetHostCatalogId(), req.GetItem())
if err != nil {
return nil, err
}
h.Scope = authResults.Scope
h.AuthorizedActions = authResults.FetchActionSetForId(ctx, h.Id, IdActions).Strings()
return &pbs.CreateHostResponse{
Item: h,
Uri: fmt.Sprintf("hosts/%s", h.GetId()),
}, nil
}
// UpdateHost implements the interface pbs.HostServiceServer.
func (s Service) UpdateHost(ctx context.Context, req *pbs.UpdateHostRequest) (*pbs.UpdateHostResponse, error) {
if err := validateUpdateRequest(req); err != nil {
return nil, err
}
cat, authResults := s.parentAndAuthResult(ctx, req.GetId(), action.Update)
if authResults.Error != nil {
return nil, authResults.Error
}
hc, err := s.updateInRepo(ctx, authResults.Scope.GetId(), cat.GetPublicId(), req.GetId(), req.GetUpdateMask().GetPaths(), req.GetItem())
if err != nil {
return nil, err
}
hc.Scope = authResults.Scope
hc.AuthorizedActions = authResults.FetchActionSetForId(ctx, hc.Id, IdActions).Strings()
return &pbs.UpdateHostResponse{Item: hc}, nil
}
// DeleteHost implements the interface pbs.HostServiceServer.
func (s Service) DeleteHost(ctx context.Context, req *pbs.DeleteHostRequest) (*pbs.DeleteHostResponse, error) {
if err := validateDeleteRequest(req); err != nil {
return nil, err
}
_, authResults := s.parentAndAuthResult(ctx, req.GetId(), action.Delete)
if authResults.Error != nil {
return nil, authResults.Error
}
_, err := s.deleteFromRepo(ctx, authResults.Scope.GetId(), req.GetId())
if err != nil {
return nil, err
}
return &pbs.DeleteHostResponse{}, nil
}
func (s Service) getFromRepo(ctx context.Context, id string) (*pb.Host, error) {
repo, err := s.staticRepoFn()
if err != nil {
return nil, err
}
h, err := repo.LookupHost(ctx, id)
if err != nil {
return nil, err
}
if h == nil {
return nil, handlers.NotFoundErrorf("Host %q doesn't exist.", id)
}
return toProto(h, nil)
}
func (s Service) createInRepo(ctx context.Context, scopeId, catalogId string, item *pb.Host) (*pb.Host, error) {
const op = "hosts.(Service).createInRepo"
ha := &pb.StaticHostAttributes{}
if err := handlers.StructToProto(item.GetAttributes(), ha); err != nil {
return nil, handlers.ApiErrorWithCodeAndMessage(codes.Internal, "Failed converting attributes to subtype proto: %s", err)
}
var opts []static.Option
if ha.GetAddress() != nil {
opts = append(opts, static.WithAddress(ha.GetAddress().GetValue()))
}
if item.GetName() != nil {
opts = append(opts, static.WithName(item.GetName().GetValue()))
}
if item.GetDescription() != nil {
opts = append(opts, static.WithDescription(item.GetDescription().GetValue()))
}
h, err := static.NewHost(catalogId, opts...)
if err != nil {
return nil, errors.Wrap(err, op, errors.WithMsg("Unable to build host for creation"))
}
repo, err := s.staticRepoFn()
if err != nil {
return nil, errors.Wrap(err, op)
}
out, err := repo.CreateHost(ctx, scopeId, h)
if err != nil {
return nil, errors.Wrap(err, op, errors.WithMsg("Unable to create host"))
}
if out == nil {
return nil, handlers.ApiErrorWithCodeAndMessage(codes.Internal, "Unable to create host but no error returned from repository.")
}
return toProto(out, nil)
}
func (s Service) updateInRepo(ctx context.Context, scopeId, catalogId, id string, mask []string, item *pb.Host) (*pb.Host, error) {
const op = "hosts.(Service).updateInRepo"
ha := &pb.StaticHostAttributes{}
if err := handlers.StructToProto(item.GetAttributes(), ha); err != nil {
return nil, handlers.ApiErrorWithCodeAndMessage(codes.Internal, "Failed converting attributes to subtype proto: %s", err)
}
var opts []static.Option
if desc := item.GetDescription(); desc != nil {
opts = append(opts, static.WithDescription(desc.GetValue()))
}
if name := item.GetName(); name != nil {
opts = append(opts, static.WithName(name.GetValue()))
}
if addr := ha.GetAddress(); addr != nil {
opts = append(opts, static.WithAddress(addr.GetValue()))
}
h, err := static.NewHost(catalogId, opts...)
if err != nil {
return nil, errors.Wrap(err, op, errors.WithMsg("Unable to build host for update"))
}
h.PublicId = id
dbMask := maskManager.Translate(mask)
if len(dbMask) == 0 {
return nil, handlers.InvalidArgumentErrorf("No valid fields included in the update mask.", map[string]string{"update_mask": "No valid fields provided in the update mask."})
}
repo, err := s.staticRepoFn()
if err != nil {
return nil, err
}
out, rowsUpdated, err := repo.UpdateHost(ctx, scopeId, h, item.GetVersion(), dbMask)
if err != nil {
return nil, errors.Wrap(err, op, errors.WithMsg("unable to update host"))
}
if rowsUpdated == 0 {
return nil, handlers.NotFoundErrorf("Host %q doesn't exist or incorrect version provided.", id)
}
return toProto(out, nil)
}
func (s Service) deleteFromRepo(ctx context.Context, scopeId, id string) (bool, error) {
const op = "hosts.(Service).deleteFromRepo"
repo, err := s.staticRepoFn()
if err != nil {
return false, err
}
rows, err := repo.DeleteHost(ctx, scopeId, id)
if err != nil {
return false, errors.Wrap(err, op, errors.WithMsg("unable to delete host"))
}
return rows > 0, nil
}
func (s Service) listFromRepo(ctx context.Context, catalogId string) ([]*pb.Host, error) {
repo, err := s.staticRepoFn()
if err != nil {
return nil, err
}
hl, err := repo.ListHosts(ctx, catalogId)
if err != nil {
return nil, err
}
var outHl []*pb.Host
for _, h := range hl {
p, err := toProto(h, nil)
if err != nil {
return nil, err
}
outHl = append(outHl, p)
}
return outHl, nil
}
func (s Service) parentAndAuthResult(ctx context.Context, id string, a action.Type) (*static.HostCatalog, auth.VerifyResults) {
res := auth.VerifyResults{}
repo, err := s.staticRepoFn()
if err != nil {
res.Error = err
return nil, res
}
var parentId string
opts := []auth.Option{auth.WithType(resource.Host), auth.WithAction(a)}
switch a {
case action.List, action.Create:
parentId = id
default:
h, err := repo.LookupHost(ctx, id)
if err != nil {
res.Error = err
return nil, res
}
if h == nil {
res.Error = handlers.NotFoundError()
return nil, res
}
parentId = h.GetCatalogId()
opts = append(opts, auth.WithId(id))
}
cat, err := repo.LookupCatalog(ctx, parentId)
if err != nil {
res.Error = err
return nil, res
}
if cat == nil {
res.Error = handlers.NotFoundError()
return nil, res
}
opts = append(opts, auth.WithScopeId(cat.GetScopeId()), auth.WithPin(parentId))
return cat, auth.Verify(ctx, opts...)
}
func toProto(in *static.Host, members []*static.HostSet) (*pb.Host, error) {
out := pb.Host{
Id: in.GetPublicId(),
HostCatalogId: in.GetCatalogId(),
Type: host.StaticSubtype.String(),
CreatedTime: in.GetCreateTime().GetTimestamp(),
UpdatedTime: in.GetUpdateTime().GetTimestamp(),
Version: in.GetVersion(),
}
if in.GetDescription() != "" {
out.Description = wrapperspb.String(in.GetDescription())
}
if in.GetName() != "" {
out.Name = wrapperspb.String(in.GetName())
}
for _, m := range members {
out.HostSetIds = append(out.HostSetIds, m.GetPublicId())
}
st, err := handlers.ProtoToStruct(&pb.StaticHostAttributes{Address: wrapperspb.String(in.GetAddress())})
if err != nil {
return nil, handlers.ApiErrorWithCodeAndMessage(codes.Internal, "Unable to convert static attribute to struct: %s", err)
}
out.Attributes = st
return &out, nil
}
// A validateX method should exist for each method above. These methods do not make calls to any backing service but enforce
// requirements on the structure of the request. They verify that:
// * The path passed in is correctly formatted
// * All required parameters are set
// * There are no conflicting parameters provided
// * The type asserted by the ID and/or field is known
// * If relevant, the type derived from the id prefix matches what is claimed by the type field
func validateGetRequest(req *pbs.GetHostRequest) error {
return handlers.ValidateGetRequest(func() map[string]string {
badFields := map[string]string{}
ct := host.SubtypeFromId(req.GetId())
if ct == host.UnknownSubtype {
badFields["id"] = "Improperly formatted identifier used."
}
return badFields
}, req, static.HostPrefix)
}
func validateCreateRequest(req *pbs.CreateHostRequest) error {
return handlers.ValidateCreateRequest(req.GetItem(), func() map[string]string {
badFields := map[string]string{}
if !handlers.ValidId(handlers.Id(req.GetItem().GetHostCatalogId()), static.HostCatalogPrefix) {
badFields["host_catalog_id"] = "The field is incorrectly formatted."
}
switch host.SubtypeFromId(req.GetItem().GetHostCatalogId()) {
case host.StaticSubtype:
if req.GetItem().GetType() != "" && req.GetItem().GetType() != host.StaticSubtype.String() {
badFields["type"] = "Doesn't match the parent resource's type."
}
attrs := &pb.StaticHostAttributes{}
if err := handlers.StructToProto(req.GetItem().GetAttributes(), attrs); err != nil {
badFields["attributes"] = "Attribute fields do not match the expected format."
}
if attrs.GetAddress() == nil ||
len(attrs.GetAddress().GetValue()) < static.MinHostAddressLength ||
len(attrs.GetAddress().GetValue()) > static.MaxHostAddressLength {
badFields["attributes.address"] = fmt.Sprintf("Address length must be between %d and %d characters.", static.MinHostAddressLength, static.MaxHostAddressLength)
}
_, _, err := net.SplitHostPort(attrs.GetAddress().GetValue())
switch {
case err == nil:
badFields["attributes.address"] = "Address for static hosts does not support a port."
case strings.Contains(err.Error(), "missing port in address"):
// Bare hostname, which we want
default:
badFields["attributes.address"] = fmt.Sprintf("Error parsing address: %v.", err)
}
}
return badFields
})
}
func validateUpdateRequest(req *pbs.UpdateHostRequest) error {
return handlers.ValidateUpdateRequest(req, req.GetItem(), func() map[string]string {
badFields := map[string]string{}
switch host.SubtypeFromId(req.GetId()) {
case host.StaticSubtype:
if req.GetItem().GetType() != "" && req.GetItem().GetType() != host.StaticSubtype.String() {
badFields["type"] = "Cannot modify the resource type."
attrs := &pb.StaticHostAttributes{}
if err := handlers.StructToProto(req.GetItem().GetAttributes(), attrs); err != nil {
badFields["attributes"] = "Attribute fields do not match the expected format."
}
if handlers.MaskContains(req.GetUpdateMask().GetPaths(), "attributes.address") {
if attrs.GetAddress() == nil ||
len(strings.TrimSpace(attrs.GetAddress().GetValue())) < static.MinHostAddressLength ||
len(strings.TrimSpace(attrs.GetAddress().GetValue())) > static.MaxHostAddressLength {
badFields["attributes.address"] = fmt.Sprintf("Address length must be between %d and %d characters.", static.MinHostAddressLength, static.MaxHostAddressLength)
}
}
}
default:
badFields["id"] = "Improperly formatted identifier used."
}
return badFields
}, static.HostPrefix)
}
func validateDeleteRequest(req *pbs.DeleteHostRequest) error {
return handlers.ValidateDeleteRequest(handlers.NoopValidatorFn, req, static.HostPrefix)
}
func validateListRequest(req *pbs.ListHostsRequest) error {
badFields := map[string]string{}
if !handlers.ValidId(handlers.Id(req.GetHostCatalogId()), static.HostCatalogPrefix) {
badFields["host_catalog_id"] = "The field is incorrectly formatted."
}
if _, err := handlers.NewFilter(req.GetFilter()); err != nil {
badFields["filter"] = fmt.Sprintf("This field could not be parsed. %v", err)
}
if len(badFields) > 0 {
return handlers.InvalidArgumentErrorf("Improperly formatted identifier.", badFields)
}
return nil
}