Refactored codebase. (Velocidex#45)

Moved config protobuf into config directory. Added a server_vql tag to prevent server plugins from building in client context.
simiaoxiaoseng · Aug 13, 2019 · 274faf9 · 274faf9
1 parent 36117b1
commit 274faf9
Show file tree

Hide file tree

Showing 117 changed files with 2,742 additions and 2,623 deletions.
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/actions/actions.go b/actions/actions.go
@@ -22,12 +22,12 @@ package actions
 import (
 	"context"
 
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	crypto_proto "www.velocidex.com/golang/velociraptor/crypto/proto"
 )
 
 type ClientAction interface {
-	Run(config *api_proto.Config,
+	Run(config *config_proto.Config,
 		ctx context.Context,
 		args *crypto_proto.GrrMessage,
 		output chan<- *crypto_proto.GrrMessage)

diff --git a/actions/admin.go b/actions/admin.go
@@ -22,18 +22,18 @@ import (
 	"runtime"
 	"strings"
 
-	"github.com/Showmax/go-fqdn"
+	fqdn "github.com/Showmax/go-fqdn"
 	"github.com/shirou/gopsutil/host"
 	actions_proto "www.velocidex.com/golang/velociraptor/actions/proto"
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	crypto_proto "www.velocidex.com/golang/velociraptor/crypto/proto"
 	"www.velocidex.com/golang/velociraptor/responder"
 )
 
 type GetHostname struct{}
 
 func (self *GetHostname) Run(
-	config *api_proto.Config,
+	config *config_proto.Config,
 	ctx context.Context,
 	msg *crypto_proto.GrrMessage,
 	output chan<- *crypto_proto.GrrMessage) {
@@ -55,7 +55,7 @@ func (self *GetHostname) Run(
 type GetPlatformInfo struct{}
 
 func (self *GetPlatformInfo) Run(
-	config *api_proto.Config,
+	config *config_proto.Config,
 	ctx context.Context,
 	msg *crypto_proto.GrrMessage,
 	output chan<- *crypto_proto.GrrMessage) {

diff --git a/actions/admin_test.go b/actions/admin_test.go
@@ -26,14 +26,14 @@ import (
 	assert "github.com/stretchr/testify/assert"
 	"www.velocidex.com/golang/velociraptor/actions"
 	actions_proto "www.velocidex.com/golang/velociraptor/actions/proto"
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
 	"www.velocidex.com/golang/velociraptor/config"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	crypto_proto "www.velocidex.com/golang/velociraptor/crypto/proto"
 	"www.velocidex.com/golang/velociraptor/responder"
 )
 
 func GetResponsesFromAction(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	action actions.ClientAction,
 	ctx context.Context,
 	args *crypto_proto.GrrMessage) []*crypto_proto.GrrMessage {

diff --git a/actions/common.go b/actions/common.go
@@ -21,16 +21,16 @@ import (
 	"context"
 
 	actions_proto "www.velocidex.com/golang/velociraptor/actions/proto"
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
 	config "www.velocidex.com/golang/velociraptor/config"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	crypto_proto "www.velocidex.com/golang/velociraptor/crypto/proto"
 	"www.velocidex.com/golang/velociraptor/responder"
 )
 
 type GetClientInfo struct{}
 
 func (self *GetClientInfo) Run(
-	config *api_proto.Config,
+	config *config_proto.Config,
 	ctx context.Context,
 	args *crypto_proto.GrrMessage,
 	output chan<- *crypto_proto.GrrMessage) {
@@ -47,7 +47,7 @@ func (self *GetClientInfo) Run(
 type UpdateForeman struct{}
 
 func (self *UpdateForeman) Run(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	ctx context.Context,
 	msg *crypto_proto.GrrMessage,
 	output chan<- *crypto_proto.GrrMessage) {

diff --git a/actions/events.go b/actions/events.go
@@ -31,7 +31,7 @@ import (
 	"sync"
 
 	actions_proto "www.velocidex.com/golang/velociraptor/actions/proto"
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	crypto_proto "www.velocidex.com/golang/velociraptor/crypto/proto"
 	"www.velocidex.com/golang/velociraptor/logging"
 	"www.velocidex.com/golang/velociraptor/responder"
@@ -91,7 +91,7 @@ func NewEventTable(
 type UpdateEventTable struct{}
 
 func (self *UpdateEventTable) Run(
-	config *api_proto.Config,
+	config *config_proto.Config,
 	ctx context.Context,
 	msg *crypto_proto.GrrMessage,
 	output chan<- *crypto_proto.GrrMessage) {

diff --git a/actions/vql.go b/actions/vql.go
@@ -27,8 +27,8 @@ import (
 
 	humanize "github.com/dustin/go-humanize"
 	actions_proto "www.velocidex.com/golang/velociraptor/actions/proto"
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
 	artifacts "www.velocidex.com/golang/velociraptor/artifacts"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	crypto_proto "www.velocidex.com/golang/velociraptor/crypto/proto"
 	"www.velocidex.com/golang/velociraptor/logging"
 	"www.velocidex.com/golang/velociraptor/responder"
@@ -38,7 +38,7 @@ import (
 )
 
 type LogWriter struct {
-	config_obj *api_proto.Config
+	config_obj *config_proto.Config
 	responder  *responder.Responder
 }
 
@@ -54,7 +54,7 @@ func (self *LogWriter) Write(b []byte) (int, error) {
 type VQLClientAction struct{}
 
 func (self *VQLClientAction) Run(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	ctx context.Context,
 	msg *crypto_proto.GrrMessage,
 	output chan<- *crypto_proto.GrrMessage) {
@@ -69,7 +69,7 @@ func (self *VQLClientAction) Run(
 }
 
 func (self *VQLClientAction) StartQuery(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	ctx context.Context,
 	responder *responder.Responder,
 	arg *actions_proto.VQLCollectorArgs) {

diff --git a/api/api.go b/api/api.go
@@ -38,6 +38,7 @@ import (
 	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
 	"www.velocidex.com/golang/velociraptor/artifacts"
 	artifacts_proto "www.velocidex.com/golang/velociraptor/artifacts/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	"www.velocidex.com/golang/velociraptor/constants"
 	"www.velocidex.com/golang/velociraptor/datastore"
 	"www.velocidex.com/golang/velociraptor/flows"
@@ -50,7 +51,7 @@ import (
 )
 
 type ApiServer struct {
-	config     *api_proto.Config
+	config     *config_proto.Config
 	server_obj *server.Server
 	ca_pool    *x509.CertPool
 }
@@ -624,7 +625,7 @@ func (self *ApiServer) SetClientMonitoringState(
 	return in, err
 }
 
-func StartServer(config_obj *api_proto.Config, server_obj *server.Server) error {
+func StartServer(config_obj *config_proto.Config, server_obj *server.Server) error {
 	bind_addr := config_obj.API.BindAddress
 	switch config_obj.API.BindScheme {
 	case "tcp":
@@ -678,7 +679,7 @@ func StartServer(config_obj *api_proto.Config, server_obj *server.Server) error
 	return nil
 }
 
-func StartMonitoringService(config_obj *api_proto.Config) {
+func StartMonitoringService(config_obj *config_proto.Config) {
 	bind_addr := fmt.Sprintf("%s:%d",
 		config_obj.Monitoring.BindAddress,
 		config_obj.Monitoring.BindPort)

diff --git a/api/artifacts.go b/api/artifacts.go
@@ -27,6 +27,7 @@ import (
 	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
 	"www.velocidex.com/golang/velociraptor/artifacts"
 	artifacts_proto "www.velocidex.com/golang/velociraptor/artifacts/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	"www.velocidex.com/golang/velociraptor/constants"
 	file_store "www.velocidex.com/golang/velociraptor/file_store"
 )
@@ -61,7 +62,7 @@ reports:
 )
 
 func getArtifactFile(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	name string) (string, error) {
 
 	repository, err := artifacts.GetGlobalRepository(config_obj)
@@ -92,7 +93,7 @@ func getArtifactFile(
 	return artifact.Raw, nil
 }
 
-func setArtifactFile(config_obj *api_proto.Config,
+func setArtifactFile(config_obj *config_proto.Config,
 	in *api_proto.SetArtifactRequest) (
 	*artifacts_proto.Artifact, error) {
 
@@ -153,7 +154,7 @@ func setArtifactFile(config_obj *api_proto.Config,
 }
 
 func searchArtifact(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	terms []string,
 	artifact_type string,
 	number_of_results uint64) (

diff --git a/api/assets.go b/api/assets.go
@@ -26,11 +26,11 @@ import (
 	"net/http"
 	"time"
 
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	"www.velocidex.com/golang/velociraptor/gui/assets"
 )
 
-func install_static_assets(config_obj *api_proto.Config, mux *http.ServeMux) {
+func install_static_assets(config_obj *config_proto.Config, mux *http.ServeMux) {
 	dir := "/static/"
 	mux.Handle(dir, http.FileServer(assets.HTTP))
 	mux.Handle("/favicon.png",
@@ -39,7 +39,7 @@ func install_static_assets(config_obj *api_proto.Config, mux *http.ServeMux) {
 }
 
 func GetTemplateHandler(
-	config_obj *api_proto.Config, template_name string) (http.Handler, error) {
+	config_obj *config_proto.Config, template_name string) (http.Handler, error) {
 	data, err := assets.ReadFile(template_name)
 	if err != nil {
 		return nil, err

diff --git a/api/assets_filesystem.go b/api/assets_filesystem.go
@@ -30,11 +30,11 @@ import (
 	"net/http"
 	"time"
 
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	"www.velocidex.com/golang/velociraptor/logging"
 )
 
-func install_static_assets(config_obj *api_proto.Config, mux *http.ServeMux) {
+func install_static_assets(config_obj *config_proto.Config, mux *http.ServeMux) {
 	logging.GetLogger(config_obj, &logging.FrontendComponent).
 		Info("GUI will serve files from directory gui/static")
 	mux.Handle("/static/", http.StripPrefix("/static/", http.FileServer(
@@ -44,7 +44,7 @@ func install_static_assets(config_obj *api_proto.Config, mux *http.ServeMux) {
 			http.StatusMovedPermanently))
 }
 
-func GetTemplateHandler(config_obj *api_proto.Config,
+func GetTemplateHandler(config_obj *config_proto.Config,
 	template_name string) (http.Handler, error) {
 	tmpl, err := template.ParseFiles("gui" + template_name)
 	if err != nil {

diff --git a/api/auth.go b/api/auth.go
@@ -26,8 +26,8 @@ import (
 	"google.golang.org/grpc/metadata"
 	"google.golang.org/grpc/peer"
 	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	"www.velocidex.com/golang/velociraptor/constants"
-	"www.velocidex.com/golang/velociraptor/logging"
 	users "www.velocidex.com/golang/velociraptor/users"
 )
 
@@ -36,7 +36,7 @@ var (
 )
 
 func checkUserCredentialsHandler(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	parent http.Handler) http.Handler {
 
 	// We are supposed to do the oauth thing.
@@ -81,21 +81,21 @@ func checkUserCredentialsHandler(
 
 		// Need to call logging after auth so it can access
 		// the USER value in the context.
-		logging.GetLoggingHandler(config_obj)(parent).ServeHTTP(
+		GetLoggingHandler(config_obj)(parent).ServeHTTP(
 			w, r.WithContext(ctx))
 	})
 }
 
 // TODO: Implement this properly.
 func IsUserApprovedForClient(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	md *metadata.MD,
 	client_id string) bool {
 	return true
 }
 
 func getClientApprovalForUser(
-	config *api_proto.Config,
+	config *config_proto.Config,
 	md *metadata.MD,
 	client_id string) *api_proto.ApprovalList {
 	result := api_proto.ApprovalList{
@@ -138,7 +138,7 @@ func GetGRPCUserInfo(ctx context.Context) *api_proto.VelociraptorUser {
 	return result
 }
 
-func NewDefaultUserObject(config_obj *api_proto.Config) *api_proto.ApiGrrUser {
+func NewDefaultUserObject(config_obj *config_proto.Config) *api_proto.ApiGrrUser {
 	result := &api_proto.ApiGrrUser{
 		InterfaceTraits: &api_proto.ApiGrrUserInterfaceTraits{
 			CronJobsNavItemEnabled:                true,

diff --git a/api/client_monitoring.go b/api/client_monitoring.go
@@ -1,14 +1,14 @@
 package api
 
 import (
-	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	"www.velocidex.com/golang/velociraptor/constants"
 	"www.velocidex.com/golang/velociraptor/datastore"
 	flows_proto "www.velocidex.com/golang/velociraptor/flows/proto"
 	"www.velocidex.com/golang/velociraptor/services"
 )
 
-func getClientMonitoringState(config_obj *api_proto.Config) (
+func getClientMonitoringState(config_obj *config_proto.Config) (
 	*flows_proto.ArtifactCollectorArgs, error) {
 	db, err := datastore.GetDB(config_obj)
 	if err != nil {
@@ -25,7 +25,7 @@ func getClientMonitoringState(config_obj *api_proto.Config) (
 }
 
 func setClientMonitoringState(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	args *flows_proto.ArtifactCollectorArgs) error {
 	return services.UpdateClientEventTable(config_obj, args)
 }
diff --git a/api/clients.go b/api/clients.go
@@ -25,14 +25,15 @@ import (
 
 	actions_proto "www.velocidex.com/golang/velociraptor/actions/proto"
 	api_proto "www.velocidex.com/golang/velociraptor/api/proto"
+	config_proto "www.velocidex.com/golang/velociraptor/config/proto"
 	"www.velocidex.com/golang/velociraptor/constants"
 	"www.velocidex.com/golang/velociraptor/datastore"
 	"www.velocidex.com/golang/velociraptor/server"
 	urns "www.velocidex.com/golang/velociraptor/urns"
 )
 
 func GetApiClient(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	server_obj *server.Server,
 	client_id string, detailed bool) (
 	*api_proto.ApiClient, error) {
@@ -122,7 +123,7 @@ func GetApiClient(
 }
 
 func LabelClients(
-	config_obj *api_proto.Config,
+	config_obj *config_proto.Config,
 	in *api_proto.LabelClientsRequest) (*api_proto.APIResponse, error) {
 	db, err := datastore.GetDB(config_obj)
 	if err != nil {