From d1b45c0d3144dcd5d37929b444d98273c72c3668 Mon Sep 17 00:00:00 2001 From: nb-ohad Date: Sun, 24 Dec 2023 15:27:45 +0200 Subject: [PATCH] Some minor changes/fixes to ux backend - Move content of services/types package to the services package - Move onboading_tokens content into its own sub-package - Separate msg handling into Distinct functions based on HTTP method - fix onboarding_tokens invalid content type Signed-off-by: nb-ohad --- services/provider/server/server.go | 4 +- services/{types => }/types.go | 2 +- .../handler.go} | 69 +++++++++---------- services/ux-backend/main.go | 11 +-- 4 files changed, 43 insertions(+), 43 deletions(-) rename services/{types => }/types.go (87%) rename services/ux-backend/handlers/{onboarding_tokens.go => onboardingtokens/handler.go} (59%) diff --git a/services/provider/server/server.go b/services/provider/server/server.go index 8dbad0c101..02e6551100 100644 --- a/services/provider/server/server.go +++ b/services/provider/server/server.go @@ -24,7 +24,7 @@ import ( ocsVersion "github.com/red-hat-storage/ocs-operator/v4/version" rookCephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1" - sharedTypes "github.com/red-hat-storage/ocs-operator/v4/services/types" + "github.com/red-hat-storage/ocs-operator/v4/services" "google.golang.org/grpc" "google.golang.org/grpc/codes" "google.golang.org/grpc/credentials" @@ -441,7 +441,7 @@ func validateTicket(ticket string, pubKey *rsa.PublicKey) error { return fmt.Errorf("failed to decode onboarding ticket: %v", err) } - var ticketData sharedTypes.OnboardingTicket + var ticketData services.OnboardingTicket err = json.Unmarshal(message, &ticketData) if err != nil { return fmt.Errorf("failed to unmarshal onboarding ticket message. %v", err) diff --git a/services/types/types.go b/services/types.go similarity index 87% rename from services/types/types.go rename to services/types.go index be67b0fdb5..fdc862f630 100644 --- a/services/types/types.go +++ b/services/types.go @@ -1,4 +1,4 @@ -package types +package services type OnboardingTicket struct { ID string `json:"id"` diff --git a/services/ux-backend/handlers/onboarding_tokens.go b/services/ux-backend/handlers/onboardingtokens/handler.go similarity index 59% rename from services/ux-backend/handlers/onboarding_tokens.go rename to services/ux-backend/handlers/onboardingtokens/handler.go index 0f3e6392b5..bef1c5e044 100644 --- a/services/ux-backend/handlers/onboarding_tokens.go +++ b/services/ux-backend/handlers/onboardingtokens/handler.go @@ -1,4 +1,4 @@ -package handler +package onboardingtokens import ( "crypto" @@ -15,64 +15,64 @@ import ( "time" "github.com/google/uuid" - "github.com/red-hat-storage/ocs-operator/v4/services/types" + "github.com/red-hat-storage/ocs-operator/v4/services" "k8s.io/klog/v2" ) -const onboardingPrivateKeyFilePath = "/etc/private-key/key" - -func OnboardingTokensHandler(w http.ResponseWriter, r *http.Request, tokenLifetimeInHours int) { +const ( + onboardingPrivateKeyFilePath = "/etc/private-key/key" + ContentTypeTextPlain = "text/plain" +) - var err error +func HandleMessage(w http.ResponseWriter, r *http.Request, tokenLifetimeInHours int) { switch r.Method { case "POST": + handlePost(w, tokenLifetimeInHours) + default: + handleUnsupportedMethod(w, r) + } +} - onboardingToken, err := generateOnboardingToken(tokenLifetimeInHours) - if err != nil { - klog.Errorf("failed to get onboardig token: %v", err) - w.WriteHeader(http.StatusInternalServerError) - w.Header().Set("Content-Type", "text/text") - _, err = w.Write([]byte("Failed to generate token")) - - if err != nil { - klog.Errorf("failed write data to response writer, %v", err) - } - return - } +func handlePost(w http.ResponseWriter, tokenLifetimeInHours int) { + if onboardingToken, err := generateOnboardingToken(tokenLifetimeInHours); err != nil { + klog.Errorf("failed to get onboardig token: %v", err) + w.WriteHeader(http.StatusInternalServerError) + w.Header().Set("Content-Type", ContentTypeTextPlain) + if _, err := w.Write([]byte("Failed to generate token")); err != nil { + klog.Errorf("failed write data to response writer, %v", err) + } + } else { klog.Info("onboarding token generated successfully") w.WriteHeader(http.StatusOK) - w.Header().Set("Content-Type", "text/text") + w.Header().Set("Content-Type", ContentTypeTextPlain) - _, err = w.Write([]byte(onboardingToken)) - if err != nil { + if _, err = w.Write([]byte(onboardingToken)); err != nil { klog.Errorf("failed write data to response writer: %v", err) - return } + } +} - default: - klog.Info("Only POST method should be used to send data to this endpoint /onboarding-tokens") - w.WriteHeader(http.StatusMethodNotAllowed) - w.Header().Set("Content-Type", "text/text") - _, err = w.Write([]byte(fmt.Sprintf("Unsupported method : %s", r.Method))) - if err != nil { - klog.Errorf("failed write data to response writer: %v", err) - } - return +func handleUnsupportedMethod(w http.ResponseWriter, r *http.Request) { + klog.Info("Only POST method should be used to send data to this endpoint /onboarding-tokens") + w.WriteHeader(http.StatusMethodNotAllowed) + w.Header().Set("Content-Type", ContentTypeTextPlain) + w.Header().Set("Allow", "POST") + + if _, err := w.Write([]byte(fmt.Sprintf("Unsupported method : %s", r.Method))); err != nil { + klog.Errorf("failed write data to response writer: %v", err) } } func generateOnboardingToken(tokenLifetimeInHours int) (string, error) { - tokenExpirationDate := time.Now(). Add(time.Duration(tokenLifetimeInHours) * time.Hour). Unix() - payload, err := json.Marshal(types.OnboardingTicket{ + payload, err := json.Marshal(services.OnboardingTicket{ ID: uuid.New().String(), ExpirationDate: tokenExpirationDate, }) - if err != nil { return "", fmt.Errorf("failed to marshal the payload: %v", err) } @@ -102,7 +102,6 @@ func generateOnboardingToken(tokenLifetimeInHours int) (string, error) { } func readAndDecodeOnboardingPrivateKey() (*rsa.PrivateKey, error) { - pemString, err := os.ReadFile(onboardingPrivateKeyFilePath) if err != nil { return nil, fmt.Errorf("failed to read onboarding private key: %v", err) diff --git a/services/ux-backend/main.go b/services/ux-backend/main.go index 1b073ee475..f0dc0aaf2a 100644 --- a/services/ux-backend/main.go +++ b/services/ux-backend/main.go @@ -7,8 +7,9 @@ import ( "os" "strconv" - handler "github.com/red-hat-storage/ocs-operator/v4/services/ux-backend/handlers" "k8s.io/klog/v2" + + "github.com/red-hat-storage/ocs-operator/v4/services/ux-backend/handlers/onboardingtokens" ) type serverConfig struct { @@ -26,7 +27,7 @@ func loadAndValidateServerConfig() (*serverConfig, error) { klog.Infof("No user-defined token lifetime provided, defaulting to %d ", defaultTokenLifetimeInHours) config.tokenLifetimeInHours = defaultTokenLifetimeInHours } else if config.tokenLifetimeInHours, err = strconv.Atoi(tokenLifetimeInHoursAsString); err != nil { - return nil, fmt.Errorf("Malformed user-defined Token lifetime: %s. shutting down: %v", tokenLifetimeInHoursAsString, err) + return nil, fmt.Errorf("malformed user-defined Token lifetime %s, %v", tokenLifetimeInHoursAsString, err) } klog.Infof("generated tokens will be valid for %d hours", config.tokenLifetimeInHours) @@ -37,7 +38,7 @@ func loadAndValidateServerConfig() (*serverConfig, error) { klog.Infof("No user-defined server listening port provided, defaulting to %d ", defaultListeningPort) config.listenPort = defaultListeningPort } else if config.listenPort, err = strconv.Atoi(listenPortAsString); err != nil { - return nil, fmt.Errorf("Malformed user-defined listening port: %s. shutting down: %v", listenPortAsString, err) + return nil, fmt.Errorf("malformed user-defined listening port %s, %v", listenPortAsString, err) } return &config, nil @@ -50,11 +51,11 @@ func main() { config, err := loadAndValidateServerConfig() if err != nil { klog.Errorf("failed to load server config: %v", err) + klog.Info("shutting down!") os.Exit(-1) } http.HandleFunc("/onboarding-tokens", func(w http.ResponseWriter, r *http.Request) { - handler.OnboardingTokensHandler(w, r, config.tokenLifetimeInHours) - + onboardingtokens.HandleMessage(w, r, config.tokenLifetimeInHours) }) klog.Info("ux backend server listening on port ", config.listenPort)