Adding osctrl-api component

Makefile

@@ -10,6 +10,10 @@ ADMIN_DIR = cmd/admin
 ADMIN_NAME = osctrl-admin
 ADMIN_CODE = ${ADMIN_DIR:=/*.go}
 
+API_DIR = cmd/api
+API_NAME = osctrl-api
+API_CODE = ${API_DIR:=/*.go}
+
 CLI_DIR = cmd/cli
 CLI_NAME = osctrl-cli
 CLI_CODE = ${CLI_DIR:=/*.go}
@@ -30,6 +34,7 @@ build:
 	make plugins
 	make tls
 	make admin
+	make api
 	make cli
 
 # Build TLS endpoint
@@ -40,6 +45,10 @@ tls:
 admin:
 	go build -o $(OUTPUT)/$(ADMIN_NAME) $(ADMIN_CODE)
 
+# Build API
+api:
+	go build -o $(OUTPUT)/$(API_NAME) $(API_CODE)
+
 # Build the CLI
 cli:
 	go build -o $(OUTPUT)/$(CLI_NAME) $(CLI_CODE)
@@ -55,6 +64,7 @@ plugins:
 clean:
 	rm -rf $(OUTPUT)/$(TLS_NAME)
 	rm -rf $(OUTPUT)/$(ADMIN_NAME)
+	rm -rf $(OUTPUT)/$(API_NAME)
 	rm -rf $(OUTPUT)/$(CLI_NAME)
 	rm -rf $(PLUGINS_DIR)/*.so
 
@@ -70,6 +80,7 @@ install:
 	make build
 	make install_tls
 	make install_admin
+	make install_api
 	make install_cli
 
 # Install TLS server and restart service
@@ -86,6 +97,13 @@ install_admin:
 	sudo cp $(OUTPUT)/$(ADMIN_NAME) $(DEST)
 	sudo systemctl start $(ADMIN_NAME)
 
+# Install API server and restart service
+# optional DEST=destination_path
+install_api:
+	sudo systemctl stop $(API_NAME)
+	sudo cp $(OUTPUT)/$(API_NAME) $(DEST)
+	sudo systemctl start $(API_NAME)
+
 # Install CLI
 # optional DEST=destination_path
 install_cli:
@@ -99,6 +117,10 @@ logs_tls:
 logs_admin:
 	sudo journalctl -f -t $(ADMIN_NAME)
 
+# Display systemd logs for API server
+logs_api:
+	sudo journalctl -f -t $(API_NAME)
+
 # Build docker containers and run them (also generates new certificates)
 docker_all:
 	./docker/dockerize.sh -u -b -f
@@ -131,6 +153,9 @@ gofmt-tls:
 gofmt-admin:
 	gofmt $(GOFMT_ARGS) ./$(ADMIN_CODE)
 
+gofmt-api:
+	gofmt $(GOFMT_ARGS) ./$(API_CODE)
+
 gofmt-cli:
 	gofmt $(GOFMT_ARGS) ./$(CLI_CODE)
 
@@ -148,8 +173,12 @@ test:
 	cd $(TLS_DIR) && go test . -v
 	# Install dependencies for Admin
 	cd $(ADMIN_DIR) && go test -i . -v
-	# Run TLS tests
+	# Run Admin tests
 	cd $(ADMIN_DIR) && go test . -v
+	# Install dependencies for API
+	cd $(API_DIR) && go test -i . -v
+	# Run API tests
+	cd $(API_DIR) && go test . -v
 	# Install dependencies for CLI
 	cd $(CLI_DIR) && go test -i . -v
 	# Run CLI tests

Vagrantfile

@@ -3,18 +3,20 @@
 
 VAGRANTFILE_API_VERSION = "2"
 
+IP_ADDRESS = "10.10.10.6"
+
 Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   config.vm.box = "ubuntu/bionic64"
-  config.vm.network "private_network", ip: "10.10.10.6"
+  config.vm.network "private_network", ip: IP_ADDRESS
   # If we want to enroll nodes in the same network
   #config.vm.network "forwarded_port", guest: 443, host: 443
   config.vm.hostname = "osctrl-Dev"
   config.ssh.shell = "bash -c 'BASH_ENV=/etc/profile exec bash'"
   config.vm.provision "shell" do |s|
     s.path = "deploy/provision.sh"
     s.args = [
-      "--nginx", "--postgres", "-E", "--metrics", "--tls-hostname",
-      "10.10.10.6", "--admin-hostname", "10.10.10.6", "--password", "admin"
+      "--nginx", "--postgres", "-E", "--metrics", "--all-hostname",
+      IP_ADDRESS, "--password", "admin"
     ]
     privileged = false
   end

cmd/admin/sessions.go

@@ -44,7 +44,7 @@ type UserSession struct {
 	IPAddress string
 	UserAgent string
 	ExpiresAt time.Time
-	Cookie    string        `gorm:"index"`
+	Cookie    string `gorm:"index"`
 	Values    sessionValues `gorm:"-"`
 }
 

cmd/admin/utils.go

@@ -72,6 +72,7 @@ func generateCarveQuery(file string, glob bool) string {
 	return "SELECT * FROM carves WHERE carve=1 AND path = '" + file + "';"
 }
 
+// Helper to verify if a platform is valid
 func checkValidPlatform(platform string) bool {
 	platforms, err := nodesmgr.GetAllPlatforms()
 	if err != nil {

cmd/api/db.go

@@ -0,0 +1,60 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"time"
+
+	"github.com/jinzhu/gorm"
+	_ "github.com/jinzhu/gorm/dialects/postgres"
+	"github.com/jmpsec/osctrl/pkg/types"
+	"github.com/spf13/viper"
+)
+
+// Function to load the DB configuration file and assign to variables
+func loadDBConfiguration(file string) (types.JSONConfigurationDB, error) {
+	var config types.JSONConfigurationDB
+	log.Printf("Loading %s", file)
+	// Load file and read config
+	viper.SetConfigFile(file)
+	err := viper.ReadInConfig()
+	if err != nil {
+		return config, err
+	}
+	// Backend values
+	dbRaw := viper.Sub("db")
+	err = dbRaw.Unmarshal(&config)
+	if err != nil {
+		return config, err
+	}
+	// No errors!
+	return config, nil
+}
+
+// Get PostgreSQL DB using GORM
+func getDB(file string) *gorm.DB {
+	// Load DB configuration
+	dbConfig, err := loadDBConfiguration(file)
+	if err != nil {
+		log.Fatalf("Error loading DB configuration %v", err)
+	}
+	t := "host=%s port=%s dbname=%s user=%s password=%s sslmode=disable"
+	postgresDSN := fmt.Sprintf(
+		t, dbConfig.Host, dbConfig.Port, dbConfig.Name, dbConfig.Username, dbConfig.Password)
+	db, err := gorm.Open("postgres", postgresDSN)
+	if err != nil {
+		log.Fatalf("Failed to open database connection: %v", err)
+	}
+	// Performance settings for DB access
+	db.DB().SetMaxIdleConns(dbConfig.MaxIdleConns)
+	db.DB().SetMaxOpenConns(dbConfig.MaxOpenConns)
+	db.DB().SetConnMaxLifetime(time.Second * time.Duration(dbConfig.ConnMaxLifetime))
+
+	return db
+}
+
+// Automigrate of tables
+func automigrateDB() error {
+	var err error
+	return err
+}

cmd/api/handlers-environments.go

@@ -0,0 +1,55 @@
+package main
+
+import (
+	"log"
+	"net/http"
+
+	"github.com/gorilla/mux"
+	"github.com/jmpsec/osctrl/pkg/settings"
+	"github.com/jmpsec/osctrl/pkg/utils"
+)
+
+// GET Handler for single JSON environment
+func apiEnvironmentHandler(w http.ResponseWriter, r *http.Request) {
+	incMetric(metricAPIReq)
+	utils.DebugHTTPDump(r, settingsmgr.DebugHTTP(settings.ServiceAPI), false)
+	vars := mux.Vars(r)
+	// Extract name
+	name, ok := vars["name"]
+	if !ok {
+		incMetric(metricAPIErr)
+		apiErrorResponse(w, "error getting name", nil)
+		return
+	}
+	// Get environment by name
+	env, err := envs.Get(name)
+	if err != nil {
+		incMetric(metricAPIErr)
+		if err.Error() == "record not found" {
+			log.Printf("environment not found: %s", name)
+			apiHTTPResponse(w, JSONApplicationUTF8, http.StatusNotFound, ApiErrorResponse{Error: "environment not found"})
+		} else {
+			apiErrorResponse(w, "error getting environment", err)
+		}
+		return
+	}
+	// Header to serve JSON
+	apiHTTPResponse(w, JSONApplicationUTF8, http.StatusOK, env)
+	incMetric(metricAPIOK)
+}
+
+// GET Handler for multiple JSON environments
+func apiEnvironmentsHandler(w http.ResponseWriter, r *http.Request) {
+	incMetric(metricAPIReq)
+	utils.DebugHTTPDump(r, settingsmgr.DebugHTTP(settings.ServiceAPI), false)
+	// Get platforms
+	envAll, err := envs.All()
+	if err != nil {
+		incMetric(metricAPIErr)
+		apiErrorResponse(w, "error getting environments", err)
+		return
+	}
+	// Header to serve JSON
+	apiHTTPResponse(w, JSONApplicationUTF8, http.StatusOK, envAll)
+	incMetric(metricAPIOK)
+}

cmd/api/handlers-nodes.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"log"
+	"net/http"
+
+	"github.com/gorilla/mux"
+	"github.com/jmpsec/osctrl/pkg/settings"
+	"github.com/jmpsec/osctrl/pkg/utils"
+)
+
+// GET Handler for single JSON nodes
+func apiNodeHandler(w http.ResponseWriter, r *http.Request) {
+	incMetric(metricAPIReq)
+	utils.DebugHTTPDump(r, settingsmgr.DebugHTTP(settings.ServiceAPI), false)
+	vars := mux.Vars(r)
+	// Extract uuid
+	uuid, ok := vars["uuid"]
+	if !ok {
+		incMetric(metricAPIErr)
+		apiErrorResponse(w, "error getting uuid", nil)
+		return
+	}
+	// Get node by UUID
+	node, err := nodesmgr.GetByUUID(uuid)
+	if err != nil {
+		incMetric(metricAPIErr)
+		if err.Error() == "record not found" {
+			log.Printf("node not found: %s", uuid)
+			apiHTTPResponse(w, JSONApplicationUTF8, http.StatusNotFound, ApiErrorResponse{Error: "node not found"})
+		} else {
+			apiErrorResponse(w, "error getting node", err)
+		}
+		return
+	}
+	// Serialize and serve JSON
+	apiHTTPResponse(w, JSONApplicationUTF8, http.StatusOK, node)
+	incMetric(metricAPIOK)
+}
+
+// GET Handler for multiple JSON nodes
+func apiNodesHandler(w http.ResponseWriter, r *http.Request) {
+	incMetric(metricAPIReq)
+	utils.DebugHTTPDump(r, settingsmgr.DebugHTTP(settings.ServiceAPI), false)
+	// Get nodes
+	nodes, err := nodesmgr.Gets("all", 0)
+	if err != nil {
+		incMetric(metricAPIErr)
+		apiErrorResponse(w, "error getting nodes", err)
+		return
+	}
+	if len(nodes) == 0 {
+		incMetric(metricAPIErr)
+		log.Printf("no nodes")
+		apiHTTPResponse(w, JSONApplicationUTF8, http.StatusNotFound, ApiErrorResponse{Error: "no nodes"})
+		return
+	}
+	// Serialize and serve JSON
+	apiHTTPResponse(w, JSONApplicationUTF8, http.StatusOK, nodes)
+	incMetric(metricAPIOK)
+}

cmd/api/handlers-platforms.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"net/http"
+
+	"github.com/jmpsec/osctrl/pkg/settings"
+	"github.com/jmpsec/osctrl/pkg/utils"
+)
+
+// GET Handler for multiple JSON platforms
+func apiPlatformsHandler(w http.ResponseWriter, r *http.Request) {
+	incMetric(metricAPIReq)
+	utils.DebugHTTPDump(r, settingsmgr.DebugHTTP(settings.ServiceAPI), false)
+	// Get platforms
+	platforms, err := nodesmgr.GetAllPlatforms()
+	if err != nil {
+		incMetric(metricAPIErr)
+		apiErrorResponse(w, "error getting platforms", err)
+		return
+	}
+	// Serialize and serve JSON
+	apiHTTPResponse(w, JSONApplicationUTF8, http.StatusOK, platforms)
+	incMetric(metricAPIOK)
+}