fleet/server/service/client_hosts.go

146 lines
4.5 KiB
Go
Raw Normal View History

package service
import (
"encoding/csv"
"fmt"
"net/url"
"strings"
"github.com/fleetdm/fleet/v4/server/fleet"
"github.com/fleetdm/fleet/v4/server/ptr"
)
// GetHosts retrieves the list of all Hosts
func (c *Client) GetHosts(query string) ([]fleet.HostResponse, error) {
verb, path := "GET", "/api/latest/fleet/hosts"
var responseBody listHostsResponse
err := c.authenticatedRequestWithQuery(nil, verb, path, &responseBody, query)
return responseBody.Hosts, err
}
func (c *Client) GetHost(id uint) (*HostDetailResponse, error) {
verb, path := "GET", fmt.Sprintf("/api/latest/fleet/hosts/%d", id)
var responseBody getHostResponse
err := c.authenticatedRequest(nil, verb, path, &responseBody)
return responseBody.Host, err
}
// HostByIdentifier retrieves a host by the uuid, osquery_host_id, hostname, or
// node_key.
Add host details in API responses (#223) Add label and pack information for the returned hosts in the single-host API endpoints. Example: ``` curl -k 'https://localhost:8080/api/v1/kolide/hosts/7' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2tleSI6Ii9oNEZ4MUpEVmlvQWhtMC8wNUJKbzZpdldsUDZpMDhjQVBuZXRLeFIvWjNOUGgvMW9VdCsxQnFlNU1CVDVsMlU3ckVGMm5Sb1VxS3ZSUllzSmJJR2lBPT0ifQ.GQQsJgBU3JA1H1o4Y8fPjyfF78F_VY4c9AbrP5k0sCg' { "host": { "created_at": "2021-01-16T00:22:33Z", "updated_at": "2021-01-16T00:22:51Z", "id": 7, "detail_updated_at": "1970-01-02T00:00:00Z", "label_updated_at": "1970-01-02T00:00:00Z", "last_enrolled_at": "2021-01-16T00:22:33Z", "seen_time": "2021-01-16T00:22:51Z", "hostname": "55d91fc9c303", "uuid": "853a4588-0000-0000-a061-7d494d04e9c4", "platform": "ubuntu", "osquery_version": "4.6.0", "os_version": "Ubuntu 20.04.0", "build": "", "platform_like": "debian", "code_name": "", "uptime": 0, "memory": 16794206208, "cpu_type": "x86_64", "cpu_subtype": "158", "cpu_brand": "Intel(R) Core(TM) i9-9980HK CPU @ 2.40GHz\u0000\u0000\u0000\u0000\u0000\u0000\u0000", "cpu_physical_cores": 8, "cpu_logical_cores": 8, "hardware_vendor": "", "hardware_model": "", "hardware_version": "", "hardware_serial": "", "computer_name": "55d91fc9c303", "primary_ip": "", "primary_mac": "", "distributed_interval": 10, "config_tls_refresh": 0, "logger_tls_period": 10, "enroll_secret_name": "default", "labels": [ { "created_at": "2020-12-22T01:22:47Z", "updated_at": "2020-12-22T01:22:47Z", "id": 6, "name": "All Hosts", "description": "All hosts which have enrolled in Fleet", "query": "select 1;", "label_type": "builtin", "label_membership_type": "dynamic" } ], "packs": [ { "created_at": "2021-01-20T16:36:42Z", "updated_at": "2021-01-20T16:36:42Z", "id": 2, "name": "test" } ], "status": "offline", "display_text": "55d91fc9c303" } } ```
2021-01-25 21:05:02 +00:00
func (c *Client) HostByIdentifier(identifier string) (*HostDetailResponse, error) {
verb, path := "GET", "/api/latest/fleet/hosts/identifier/"+identifier
var responseBody getHostResponse
err := c.authenticatedRequest(nil, verb, path, &responseBody)
return responseBody.Host, err
}
func (c *Client) translateTransferHostsToIDs(hosts []string, label string, team string) ([]uint, uint, uint, error) {
verb, path := "POST", "/api/latest/fleet/translate"
var responseBody translatorResponse
var translatePayloads []fleet.TranslatePayload
for _, host := range hosts {
translatedPayload, err := encodeTranslatedPayload(fleet.TranslatorTypeHost, host)
if err != nil {
return nil, 0, 0, err
}
translatePayloads = append(translatePayloads, translatedPayload)
}
if label != "" {
translatedPayload, err := encodeTranslatedPayload(fleet.TranslatorTypeLabel, label)
if err != nil {
return nil, 0, 0, err
}
translatePayloads = append(translatePayloads, translatedPayload)
}
translatedPayload, err := encodeTranslatedPayload(fleet.TranslatorTypeTeam, team)
if err != nil {
return nil, 0, 0, err
}
translatePayloads = append(translatePayloads, translatedPayload)
params := translatorRequest{List: translatePayloads}
err = c.authenticatedRequest(&params, verb, path, &responseBody)
if err != nil {
return nil, 0, 0, err
}
var hostIDs []uint
var labelID uint
var teamID uint
for _, payload := range responseBody.List {
switch payload.Type {
case fleet.TranslatorTypeLabel:
labelID = payload.Payload.ID
case fleet.TranslatorTypeTeam:
teamID = payload.Payload.ID
case fleet.TranslatorTypeHost:
hostIDs = append(hostIDs, payload.Payload.ID)
}
}
return hostIDs, labelID, teamID, nil
}
func encodeTranslatedPayload(translatorType string, identifier string) (fleet.TranslatePayload, error) {
translatedPayload := fleet.TranslatePayload{
Type: translatorType,
Payload: fleet.StringIdentifierToIDPayload{Identifier: identifier},
}
return translatedPayload, nil
}
func (c *Client) TransferHosts(hosts []string, label string, status, searchQuery string, team string) error {
hostIDs, labelID, teamID, err := c.translateTransferHostsToIDs(hosts, label, team)
if err != nil {
return err
}
if len(hosts) != 0 {
verb, path := "POST", "/api/latest/fleet/hosts/transfer"
var responseBody addHostsToTeamResponse
params := addHostsToTeamRequest{TeamID: ptr.Uint(teamID), HostIDs: hostIDs}
return c.authenticatedRequest(params, verb, path, &responseBody)
}
var labelIDPtr *uint
if label != "" {
labelIDPtr = &labelID
}
verb, path := "POST", "/api/latest/fleet/hosts/transfer/filter"
var responseBody addHostsToTeamByFilterResponse
params := addHostsToTeamByFilterRequest{TeamID: ptr.Uint(teamID), Filters: struct {
MatchQuery string `json:"query"`
Status fleet.HostStatus `json:"status"`
LabelID *uint `json:"label_id"`
}{MatchQuery: searchQuery, Status: fleet.HostStatus(status), LabelID: labelIDPtr}}
return c.authenticatedRequest(params, verb, path, &responseBody)
}
// GetHosts returns a report of all hosts.
//
// The first row holds the name of the columns and each subsequent row are
// the column values for each host.
func (c *Client) GetHostsReport(columns ...string) ([][]string, error) {
verb, path := "GET", "/api/latest/fleet/hosts/report"
query := make(url.Values)
query.Add("format", "csv")
if len(columns) > 0 {
query.Add("columns", strings.Join(columns, ","))
}
response, err := c.AuthenticatedDo(verb, path, query.Encode(), nil)
if err != nil {
return nil, err
}
csvReader := csv.NewReader(response.Body)
records, err := csvReader.ReadAll()
if err != nil {
return nil, err
}
return records, nil
}