indexing.go

package services

import (
	"context"

	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
	"www.velocidex.com/golang/velociraptor/file_store/api"
	"www.velocidex.com/golang/vfilter"
)

func GetIndexer(config_obj *config_proto.Config) (Indexer, error) {
	org_manager, err := GetOrgManager()
	if err != nil {
		return nil, err
	}

	return org_manager.Services(config_obj.OrgId).Indexer()
}

type Indexer interface {
	// Set a search term on a client
	SetIndex(client_id, term string) error

	// Clear a search term on a client
	UnsetIndex(client_id, term string) error

	// Search the index for clients matching the term
	SearchIndexWithPrefix(
		ctx context.Context,
		config_obj *config_proto.Config,
		prefix string) <-chan *api_proto.IndexRecord

	SearchClientsChan(
		ctx context.Context,
		scope vfilter.Scope,
		config_obj *config_proto.Config,
		search_term string, principal string) (chan *api_proto.ApiClient, error)

	SearchClients(
		ctx context.Context,
		config_obj *config_proto.Config,
		in *api_proto.SearchClientsRequest,
		principal string) (*api_proto.SearchClientsResponse, error)

	SetSimpleIndex(
		config_obj *config_proto.Config,
		index_urn api.DSPathSpec,
		entity string,
		keywords []string) error

	UnsetSimpleIndex(
		config_obj *config_proto.Config,
		index_urn api.DSPathSpec,
		entity string,
		keywords []string) error

	CheckSimpleIndex(
		config_obj *config_proto.Config,
		index_urn api.DSPathSpec,
		entity string,
		keywords []string) error

	UpdateMRU(
		config_obj *config_proto.Config,
		user_name string, client_id string) error

	FastGetApiClient(
		ctx context.Context,
		config_obj *config_proto.Config,
		client_id string) (*api_proto.ApiClient, error)

	// Rebuild the index completely from the client info manager.
	RebuildIndex(ctx context.Context,
		config_obj *config_proto.Config) error
}