fleet/server/service/labels.go
Scott Gress af2de5bc42
Add support for host vitals labels (#30278)
# Details

This PR adds support for a new label membership type, `host_vitals`.
Membership for these labels is based on a database query created from
user-supplied criteria. In this first iteration, the allowed criteria
are very simple: a label can specify either an IdP group or IdP
department, and hosts with linked users with a matching group or
department.

Groundwork is laid here for more complex host vitals queries, including
`and` and `or` logic, different data types and different kinds of vitals
(rather than just the "foreign" vitals of which IdP is an example).

Note that this PR does _not_ include the cron job that will trigger
membership updating, and it doesn't include ; for sake of simplicity in
review that will be done in a follow-on PR.

## Basic flow

### Creating a host vitals label

1. A new label is created via the API / GitOps with membership type
`host_vitals` and a `criteria` property that's a JSON blob. Currently
the JSON can only contain `vital` and `value` keys (and must contain
those keys)
2. The server validates that the specified `vital` exists in our [set of
known host
vitals](https://github.com/fleetdm/fleet/pull/30278/files#diff-b6d4c48f2624b82c2567b2b88db1de51c6b152eeb261d40acfd5b63a890839b7R418-R436).
3. The server validates that the [criteria can be parsed into a
query](https://github.com/fleetdm/fleet/pull/30278/files?diff=unified&w=1#diff-4ac4cfba8bed490e8ef125a0556f5417156f805017bfe93c6e2c61aa94ba8a8cR81-R86).
This also happens during GitOps dry run.
4. The label is saved (criteria is saved as JSON in the db)

### Updating membership for a host vitals label

1. The label's criteria is used to generate a query to run on the
_Fleet_ db.
1. For each vital criteria, check the vital type. Currently only foreign
vitals are supported.
   2. For foreign vitals, add its group to a set we keep track of.
3. Add a `WHERE` clause section for the vital and value, e.g.
`end_user_idp_groups = ?`
4. Once we have all the `WHERE` clauses, create the query as `SELECT %s
FROM %s` + any joins contributed by foreign vitals groups + `WHERE ` +
all the `WHERE` clauses we just calculated. The `%s` provide some
flexibility if we want to use these queries in other contexts.
2. Delete all existing label members
3. Do an `INSERT...SELECT` using the query we calculated from the label
criteria. The query will be `SELECT <label id> as label_id, hosts.id
FROM hosts JOIN ...`

## Future work

### Domestic vitals

These can be anything that we already store in the `hosts` table.
Domestic vitals won't add any `JOIN`s to the calculated label query, and
will simply be e.g. `hosts.hostname = ?`

### Custom vitals

We currently support an `additional_queries` config that will cause
other queries to run on hosts. The data returned from these queries is
stored in a `hosts_additional` table as a JSON blob. We can use MySQL
JSON functions to match values in this data, e.g.
`JSON_EXTRACT(host_additional, `$.some_custom_vital`) = ?`

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
> I'll add the changelog item when I add the cron job PR
- [X] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [X] If database migrations are included, checked table schema to
confirm autoupdate
- For new Fleet configuration settings
- [X] Verified that the setting can be managed via GitOps, or confirmed
that the setting is explicitly being excluded from GitOps. If managing
via Gitops:
- [X] Verified that the setting is exported via `fleetctl
generate-gitops`
- [X] Verified that the setting is cleared on the server if it is not
supplied in a YAML file (or that it is documented as being optional)
- For database migrations:
- [X] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [X] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [X] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [X] Added/updated automated tests
- [X] Manual QA for all new/changed functionality
2025-06-30 09:58:58 -05:00

699 lines
22 KiB
Go

package service
import (
"context"
"encoding/json"
"fmt"
"net/http"
"github.com/fleetdm/fleet/v4/server"
authz_ctx "github.com/fleetdm/fleet/v4/server/contexts/authz"
"github.com/fleetdm/fleet/v4/server/contexts/ctxerr"
"github.com/fleetdm/fleet/v4/server/contexts/license"
"github.com/fleetdm/fleet/v4/server/contexts/viewer"
"github.com/fleetdm/fleet/v4/server/fleet"
"github.com/fleetdm/fleet/v4/server/ptr"
)
////////////////////////////////////////////////////////////////////////////////
// Create Label
////////////////////////////////////////////////////////////////////////////////
type createLabelRequest struct {
fleet.LabelPayload
}
type createLabelResponse struct {
Label labelResponse `json:"label"`
Err error `json:"error,omitempty"`
}
func (r createLabelResponse) Error() error { return r.Err }
func createLabelEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*createLabelRequest)
label, hostIDs, err := svc.NewLabel(ctx, req.LabelPayload)
if err != nil {
return createLabelResponse{Err: err}, nil
}
labelResp, err := labelResponseForLabel(label, hostIDs)
if err != nil {
return createLabelResponse{Err: err}, nil
}
return createLabelResponse{Label: *labelResp}, nil
}
func (svc *Service) NewLabel(ctx context.Context, p fleet.LabelPayload) (*fleet.Label, []uint, error) {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionWrite); err != nil {
return nil, nil, err
}
vc, ok := viewer.FromContext(ctx)
if !ok {
return nil, nil, fleet.ErrNoContext
}
if len(p.Hosts) > 0 && len(p.HostIDs) > 0 {
return nil, nil, fleet.NewInvalidArgumentError("hosts", `Only one of either "hosts" or "host_ids" can be included in the request.`)
}
filter := fleet.TeamFilter{User: vc.User, IncludeObserver: true}
label := &fleet.Label{
LabelType: fleet.LabelTypeRegular,
LabelMembershipType: fleet.LabelMembershipTypeDynamic,
AuthorID: ptr.Uint(vc.UserID()),
}
if p.Name == "" {
return nil, nil, fleet.NewInvalidArgumentError("name", "missing required argument")
}
label.Name = p.Name
if p.Criteria != nil {
if p.Query != "" || (len(p.Hosts) > 0 || len(p.HostIDs) > 0) {
return nil, nil, fleet.NewInvalidArgumentError("criteria", `Only one of "criteria", "query" or "hosts/host_ids" can be included in the request.`)
}
label.LabelMembershipType = fleet.LabelMembershipTypeHostVitals
labelCriteriaJson, err := json.Marshal(p.Criteria)
if err != nil {
return nil, nil, fleet.NewInvalidArgumentError("criteria", fmt.Sprintf("invalid criteria: %s", err.Error()))
}
label.HostVitalsCriteria = ptr.RawMessage(json.RawMessage(labelCriteriaJson))
// Attempt to calculate a query from the criteria.
_, _, err = label.CalculateHostVitalsQuery()
if err != nil {
return nil, nil, fleet.NewInvalidArgumentError("criteria", fmt.Sprintf("invalid criteria: %s", err.Error()))
}
} else {
if p.Query != "" && (len(p.Hosts) > 0 || len(p.HostIDs) > 0) {
return nil, nil, fleet.NewInvalidArgumentError("query", `Only one of "criteria", "query" or "hosts/host_ids" can be included in the request.`)
}
label.Query = p.Query
if p.Query == "" {
label.LabelMembershipType = fleet.LabelMembershipTypeManual
}
}
label.Platform = p.Platform
label.Description = p.Description
for name := range fleet.ReservedLabelNames() {
if label.Name == name {
return nil, nil, fleet.NewInvalidArgumentError("name", fmt.Sprintf("cannot add label '%s' because it conflicts with the name of a built-in label", name))
}
}
// first create the new label, which will fail if the name is not unique
var err error
label, err = svc.ds.NewLabel(ctx, label)
if err != nil {
return nil, nil, err
}
if label.LabelMembershipType == fleet.LabelMembershipTypeManual {
hostIDs := p.HostIDs
if len(p.Hosts) > 0 {
hostIDs, err = svc.ds.HostIDsByIdentifier(ctx, filter, p.Hosts)
if err != nil {
return nil, nil, err
}
}
return svc.ds.UpdateLabelMembershipByHostIDs(ctx, label.ID, hostIDs, filter)
}
return label, nil, nil
}
////////////////////////////////////////////////////////////////////////////////
// Modify Label
////////////////////////////////////////////////////////////////////////////////
type modifyLabelRequest struct {
ID uint `json:"-" url:"id"`
fleet.ModifyLabelPayload
}
type modifyLabelResponse struct {
Label labelResponse `json:"label"`
Err error `json:"error,omitempty"`
}
func (r modifyLabelResponse) Error() error { return r.Err }
func modifyLabelEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*modifyLabelRequest)
label, hostIDs, err := svc.ModifyLabel(ctx, req.ID, req.ModifyLabelPayload)
if err != nil {
return modifyLabelResponse{Err: err}, nil
}
labelResp, err := labelResponseForLabel(label, hostIDs)
if err != nil {
return modifyLabelResponse{Err: err}, nil
}
return modifyLabelResponse{Label: *labelResp}, err
}
func (svc *Service) ModifyLabel(ctx context.Context, id uint, payload fleet.ModifyLabelPayload) (*fleet.Label, []uint, error) {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionWrite); err != nil {
return nil, nil, err
}
vc, ok := viewer.FromContext(ctx)
if !ok {
return nil, nil, fleet.ErrNoContext
}
if len(payload.Hosts) > 0 && len(payload.HostIDs) > 0 {
return nil, nil, fleet.NewInvalidArgumentError("hosts", `Only one of either "hosts" or "host_ids" can be included in the request.`)
}
filter := fleet.TeamFilter{User: vc.User, IncludeObserver: true}
label, _, err := svc.ds.Label(ctx, id, filter)
if err != nil {
return nil, nil, err
}
if label.LabelType == fleet.LabelTypeBuiltIn {
return nil, nil, fleet.NewInvalidArgumentError("label_type", fmt.Sprintf("cannot modify built-in label '%s'", label.Name))
}
if payload.Name != nil {
// Check if the new name is a reserved label name
for name := range fleet.ReservedLabelNames() {
if *payload.Name == name {
return nil, nil, fleet.NewInvalidArgumentError("name", fmt.Sprintf("cannot rename label to '%s' because it conflicts with the name of a built-in label", name))
}
}
label.Name = *payload.Name
}
if payload.Description != nil {
label.Description = *payload.Description
}
hostIDs := payload.HostIDs
if len(payload.Hosts) > 0 {
// If hosts were provided, convert them to IDs.
hostIDs, err = svc.ds.HostIDsByIdentifier(ctx, filter, payload.Hosts)
if err != nil {
return nil, nil, err
}
} else if payload.Hosts != nil {
// If an empry list was provided, create an empty list of IDs
// so that we can remove all hosts from the label.
hostIDs = make([]uint, 0)
}
if len(hostIDs) > 0 && label.LabelMembershipType != fleet.LabelMembershipTypeManual {
return nil, nil, fleet.NewInvalidArgumentError("hosts", "cannot provide a list of hosts for a dynamic label")
}
if hostIDs != nil {
if _, _, err := svc.ds.UpdateLabelMembershipByHostIDs(ctx, label.ID, hostIDs, filter); err != nil {
return nil, nil, err
}
}
return svc.ds.SaveLabel(ctx, label, filter)
}
////////////////////////////////////////////////////////////////////////////////
// Get Label
////////////////////////////////////////////////////////////////////////////////
type getLabelRequest struct {
ID uint `url:"id"`
}
type labelResponse struct {
fleet.Label
DisplayText string `json:"display_text"`
Count int `json:"count"`
HostIDs []uint `json:"host_ids,omitempty"`
}
type getLabelResponse struct {
Label labelResponse `json:"label"`
Err error `json:"error,omitempty"`
}
func (r getLabelResponse) Error() error { return r.Err }
func getLabelEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*getLabelRequest)
label, hostIDs, err := svc.GetLabel(ctx, req.ID)
if err != nil {
return getLabelResponse{Err: err}, nil
}
resp, err := labelResponseForLabel(label, hostIDs)
if err != nil {
return getLabelResponse{Err: err}, nil
}
return getLabelResponse{Label: *resp}, nil
}
func (svc *Service) GetLabel(ctx context.Context, id uint) (*fleet.Label, []uint, error) {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionRead); err != nil {
return nil, nil, err
}
vc, ok := viewer.FromContext(ctx)
if !ok {
return nil, nil, fleet.ErrNoContext
}
filter := fleet.TeamFilter{User: vc.User, IncludeObserver: true}
return svc.ds.Label(ctx, id, filter)
}
////////////////////////////////////////////////////////////////////////////////
// List Labels
////////////////////////////////////////////////////////////////////////////////
type listLabelsRequest struct {
ListOptions fleet.ListOptions `url:"list_options"`
}
type listLabelsResponse struct {
Labels []labelResponse `json:"labels"`
Err error `json:"error,omitempty"`
}
func (r listLabelsResponse) Error() error { return r.Err }
func listLabelsEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*listLabelsRequest)
labels, err := svc.ListLabels(ctx, req.ListOptions)
if err != nil {
return listLabelsResponse{Err: err}, nil
}
resp := listLabelsResponse{}
for _, label := range labels {
labelResp, err := labelResponseForLabel(label, nil)
if err != nil {
return listLabelsResponse{Err: err}, nil
}
resp.Labels = append(resp.Labels, *labelResp)
}
return resp, nil
}
func (svc *Service) ListLabels(ctx context.Context, opt fleet.ListOptions) ([]*fleet.Label, error) {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionRead); err != nil {
return nil, err
}
vc, ok := viewer.FromContext(ctx)
if !ok {
return nil, fleet.ErrNoContext
}
filter := fleet.TeamFilter{User: vc.User, IncludeObserver: true}
// TODO(mna): ListLabels doesn't currently return the hostIDs members of the
// label, the quick approach would be an N+1 queries endpoint. Leaving like
// that for now because we're in a hurry before merge freeze but the solution
// would probably be to do it in 2 queries : grab all label IDs from the
// list, then select hostID+labelID tuples in one query (where labelID IN
// <list of ids>)and fill the hostIDs per label.
return svc.ds.ListLabels(ctx, filter, opt)
}
func labelResponseForLabel(label *fleet.Label, hostIDs []uint) (*labelResponse, error) {
return &labelResponse{
Label: *label,
DisplayText: label.Name,
Count: label.HostCount,
HostIDs: hostIDs,
}, nil
}
////////////////////////////////////////////////////////////////////////////////
// Labels Summary
////////////////////////////////////////////////////////////////////////////////
type getLabelsSummaryResponse struct {
Labels []*fleet.LabelSummary `json:"labels"`
Err error `json:"error,omitempty"`
}
func (r getLabelsSummaryResponse) Error() error { return r.Err }
func getLabelsSummaryEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
labels, err := svc.LabelsSummary(ctx)
if err != nil {
return getLabelsSummaryResponse{Err: err}, nil
}
return getLabelsSummaryResponse{Labels: labels}, nil
}
func (svc *Service) LabelsSummary(ctx context.Context) ([]*fleet.LabelSummary, error) {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionRead); err != nil {
return nil, err
}
return svc.ds.LabelsSummary(ctx)
}
////////////////////////////////////////////////////////////////////////////////
// List Hosts in Label
////////////////////////////////////////////////////////////////////////////////
type listHostsInLabelRequest struct {
ID uint `url:"id"`
ListOptions fleet.HostListOptions `url:"host_options"`
}
func listHostsInLabelEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*listHostsInLabelRequest)
hosts, err := svc.ListHostsInLabel(ctx, req.ID, req.ListOptions)
if err != nil {
return listLabelsResponse{Err: err}, nil
}
var mdmSolution *fleet.MDMSolution
if req.ListOptions.MDMIDFilter != nil {
var err error
mdmSolution, err = svc.GetMDMSolution(ctx, *req.ListOptions.MDMIDFilter)
if err != nil && !fleet.IsNotFound(err) { // ignore not found, just return nil for the MDM solution in that case
return listHostsResponse{Err: err}, nil
}
}
hostResponses := make([]fleet.HostResponse, len(hosts))
for i, host := range hosts {
h := fleet.HostResponseForHost(ctx, svc, host)
hostResponses[i] = *h
}
return listHostsResponse{Hosts: hostResponses, MDMSolution: mdmSolution}, nil
}
func (svc *Service) ListHostsInLabel(ctx context.Context, lid uint, opt fleet.HostListOptions) ([]*fleet.Host, error) {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionRead); err != nil {
return nil, err
}
vc, ok := viewer.FromContext(ctx)
if !ok {
return nil, fleet.ErrNoContext
}
filter := fleet.TeamFilter{User: vc.User, IncludeObserver: true}
hosts, err := svc.ds.ListHostsInLabel(ctx, filter, lid, opt)
if err != nil {
return nil, err
}
premiumLicense := license.IsPremium(ctx)
// If issues are enabled, we need to remove the critical vulnerabilities count for non-premium license.
// If issues are disabled, we need to explicitly set the critical vulnerabilities count to 0 for premium license.
if !opt.DisableIssues && !premiumLicense {
// Remove critical vulnerabilities count if not premium license
for _, host := range hosts {
host.HostIssues.CriticalVulnerabilitiesCount = nil
}
} else if opt.DisableIssues && premiumLicense {
var zero uint64
for _, host := range hosts {
host.HostIssues.CriticalVulnerabilitiesCount = &zero
}
}
return hosts, nil
}
////////////////////////////////////////////////////////////////////////////////
// Delete Label
////////////////////////////////////////////////////////////////////////////////
type deleteLabelRequest struct {
Name string `url:"name"`
}
type deleteLabelResponse struct {
Err error `json:"error,omitempty"`
}
func (r deleteLabelResponse) Error() error { return r.Err }
func deleteLabelEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*deleteLabelRequest)
err := svc.DeleteLabel(ctx, req.Name)
if err != nil {
return deleteLabelResponse{Err: err}, nil
}
return deleteLabelResponse{}, nil
}
func (svc *Service) DeleteLabel(ctx context.Context, name string) error {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionWrite); err != nil {
return err
}
// check if the label is a built-in label
for n := range fleet.ReservedLabelNames() {
if n == name {
return fleet.NewInvalidArgumentError("name", fmt.Sprintf("cannot delete built-in label '%s'", name))
}
}
return svc.ds.DeleteLabel(ctx, name)
}
////////////////////////////////////////////////////////////////////////////////
// Delete Label By ID
////////////////////////////////////////////////////////////////////////////////
type deleteLabelByIDRequest struct {
ID uint `url:"id"`
}
type deleteLabelByIDResponse struct {
Err error `json:"error,omitempty"`
}
func (r deleteLabelByIDResponse) Error() error { return r.Err }
func deleteLabelByIDEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*deleteLabelByIDRequest)
err := svc.DeleteLabelByID(ctx, req.ID)
if err != nil {
return deleteLabelByIDResponse{Err: err}, nil
}
return deleteLabelByIDResponse{}, nil
}
func (svc *Service) DeleteLabelByID(ctx context.Context, id uint) error {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionWrite); err != nil {
return err
}
vc, ok := viewer.FromContext(ctx)
if !ok {
return fleet.ErrNoContext
}
filter := fleet.TeamFilter{User: vc.User, IncludeObserver: true}
label, _, err := svc.ds.Label(ctx, id, filter)
if err != nil {
return err
}
if label.LabelType == fleet.LabelTypeBuiltIn {
return fleet.NewInvalidArgumentError("label_type", fmt.Sprintf("cannot delete built-in label '%s'", label.Name))
}
for name := range fleet.ReservedLabelNames() {
if label.Name == name {
return fleet.NewInvalidArgumentError("name", fmt.Sprintf("cannot delete built-in label '%s'", label.Name))
}
}
return svc.ds.DeleteLabel(ctx, label.Name)
}
////////////////////////////////////////////////////////////////////////////////
// Apply Label Specs
////////////////////////////////////////////////////////////////////////////////
type applyLabelSpecsRequest struct {
Specs []*fleet.LabelSpec `json:"specs"`
}
type applyLabelSpecsResponse struct {
Err error `json:"error,omitempty"`
}
func (r applyLabelSpecsResponse) Error() error { return r.Err }
func applyLabelSpecsEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*applyLabelSpecsRequest)
err := svc.ApplyLabelSpecs(ctx, req.Specs)
if err != nil {
return applyLabelSpecsResponse{Err: err}, nil
}
return applyLabelSpecsResponse{}, nil
}
func (svc *Service) ApplyLabelSpecs(ctx context.Context, specs []*fleet.LabelSpec) error {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionWrite); err != nil {
return err
}
regularSpecs := make([]*fleet.LabelSpec, 0, len(specs))
var builtInSpecs []*fleet.LabelSpec
var builtInSpecNames []string
for _, spec := range specs {
if spec.LabelMembershipType == fleet.LabelMembershipTypeDynamic && len(spec.Hosts) > 0 {
return fleet.NewUserMessageError(
ctxerr.Errorf(ctx, "label %s is declared as dynamic but contains `hosts` key", spec.Name), http.StatusUnprocessableEntity,
)
}
if spec.LabelMembershipType == fleet.LabelMembershipTypeManual && spec.Hosts == nil {
// Hosts list doesn't need to contain anything, but it should at least not be nil.
return fleet.NewUserMessageError(
ctxerr.Errorf(ctx, "label %s is declared as manual but contains no `hosts key`", spec.Name), http.StatusUnprocessableEntity,
)
}
if spec.LabelMembershipType == fleet.LabelMembershipTypeHostVitals && spec.HostVitalsCriteria == nil {
// Criteria is required for host vitals labels.
return fleet.NewUserMessageError(
ctxerr.Errorf(ctx, "label %s is declared as host vitals but contains no `criteria` key", spec.Name), http.StatusUnprocessableEntity,
)
}
if spec.LabelType == fleet.LabelTypeBuiltIn {
// We allow specs to contain built-in labels as long as they are not being modified.
// This allows the user to do the following workflow without manually removing built-in labels:
// 1. fleetctl get labels --yaml > labels.yml
// 2. (Optional) Edit labels.yml
// 3. fleetctl apply -f labels.yml
builtInSpecs = append(builtInSpecs, spec)
builtInSpecNames = append(builtInSpecNames, spec.Name)
continue
}
for name := range fleet.ReservedLabelNames() {
if spec.Name == name {
return fleet.NewUserMessageError(ctxerr.Errorf(ctx, "cannot modify built-in label '%s'", name), http.StatusUnprocessableEntity)
}
}
regularSpecs = append(regularSpecs, spec)
}
// If built-in labels have been provided, ensure that they are not attempted to be modified
if len(builtInSpecs) > 0 {
labelMap, err := svc.ds.LabelsByName(ctx, builtInSpecNames)
if err != nil {
return err
}
for _, spec := range builtInSpecs {
label, ok := labelMap[spec.Name]
if !ok ||
label.Description != spec.Description ||
label.Query != spec.Query ||
label.Platform != spec.Platform ||
label.LabelType != fleet.LabelTypeBuiltIn ||
label.LabelMembershipType != spec.LabelMembershipType {
return fleet.NewUserMessageError(
ctxerr.Errorf(ctx, "cannot modify or add built-in label '%s'", spec.Name), http.StatusUnprocessableEntity,
)
}
}
}
if len(regularSpecs) == 0 {
return nil
}
// Get the user from the context.
user, ok := viewer.FromContext(ctx)
// If we have a user, mark them as the label's author.
if ok {
return svc.ds.ApplyLabelSpecsWithAuthor(ctx, regularSpecs, ptr.Uint(user.UserID()))
}
return svc.ds.ApplyLabelSpecs(ctx, regularSpecs)
}
////////////////////////////////////////////////////////////////////////////////
// Get Label Specs
////////////////////////////////////////////////////////////////////////////////
type getLabelSpecsResponse struct {
Specs []*fleet.LabelSpec `json:"specs"`
Err error `json:"error,omitempty"`
}
func (r getLabelSpecsResponse) Error() error { return r.Err }
func getLabelSpecsEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
specs, err := svc.GetLabelSpecs(ctx)
if err != nil {
return getLabelSpecsResponse{Err: err}, nil
}
return getLabelSpecsResponse{Specs: specs}, nil
}
func (svc *Service) GetLabelSpecs(ctx context.Context) ([]*fleet.LabelSpec, error) {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionRead); err != nil {
return nil, err
}
return svc.ds.GetLabelSpecs(ctx)
}
////////////////////////////////////////////////////////////////////////////////
// Get Label Spec
////////////////////////////////////////////////////////////////////////////////
type getLabelSpecResponse struct {
Spec *fleet.LabelSpec `json:"specs,omitempty"`
Err error `json:"error,omitempty"`
}
func (r getLabelSpecResponse) Error() error { return r.Err }
func getLabelSpecEndpoint(ctx context.Context, request interface{}, svc fleet.Service) (fleet.Errorer, error) {
req := request.(*getGenericSpecRequest)
spec, err := svc.GetLabelSpec(ctx, req.Name)
if err != nil {
return getLabelSpecResponse{Err: err}, nil
}
return getLabelSpecResponse{Spec: spec}, nil
}
func (svc *Service) GetLabelSpec(ctx context.Context, name string) (*fleet.LabelSpec, error) {
if err := svc.authz.Authorize(ctx, &fleet.Label{}, fleet.ActionRead); err != nil {
return nil, err
}
return svc.ds.GetLabelSpec(ctx, name)
}
func (svc *Service) BatchValidateLabels(ctx context.Context, labelNames []string) (map[string]fleet.LabelIdent, error) {
if authctx, ok := authz_ctx.FromContext(ctx); !ok {
return nil, fleet.NewAuthRequiredError("batch validate labels: missing authorization context")
} else if !authctx.Checked() {
return nil, fleet.NewAuthRequiredError("batch validate labels: method requires previous authorization")
}
if len(labelNames) == 0 {
return nil, nil
}
uniqueNames := server.RemoveDuplicatesFromSlice(labelNames)
labels, err := svc.ds.LabelIDsByName(ctx, uniqueNames)
if err != nil {
return nil, ctxerr.Wrap(ctx, err, "getting label IDs by name")
}
if len(labels) != len(uniqueNames) {
return nil, &fleet.BadRequestError{
Message: "some or all the labels provided don't exist",
InternalErr: fmt.Errorf("names provided: %v", labelNames),
}
}
byName := make(map[string]fleet.LabelIdent, len(labels))
for labelName, labelID := range labels {
byName[labelName] = fleet.LabelIdent{
LabelName: labelName,
LabelID: labelID,
}
}
return byName, nil
}