Feat: add support for object storage (#33)

* initial configuration changes for object-storage support

* export signer middleware function

* add s3 access and secret keys to credentials struct

Author: glimberea

shared/configuration.go

@@ -5,16 +5,21 @@
 package shared
 
 import (
+	"bytes"
 	"context"
 	"crypto/tls"
 	"crypto/x509"
 	"fmt"
+	"io"
 	"net"
 	"net/http"
 	"net/url"
 	"os"
 	"strings"
 	"time"
+
+	"github.com/aws/aws-sdk-go/aws/credentials"
+	awsv4 "github.com/aws/aws-sdk-go/aws/signer/v4"
 )
 
 var DefaultIonosBasePath = ""
@@ -28,6 +33,8 @@ const (
 	IonosLogLevelEnvVar       = "IONOS_LOG_LEVEL"
 	IonosFilePathEnvVar       = "IONOS_CONFIG_FILE"
 	IonosCurrentProfileEnvVar = "IONOS_CURRENT_PROFILE"
+	IonosS3AccessKeyEnvVar    = "IONOS_S3_ACCESS_KEY"
+	IonosS3SecretKeyEnvVar    = "IONOS_S3_SECRET_KEY"
 	DefaultIonosServerUrl     = "https://api.ionos.com/"
 
 	defaultMaxRetries  = 3
@@ -103,6 +110,15 @@ type ServerConfiguration struct {
 // ServerConfigurations stores multiple ServerConfiguration items
 type ServerConfigurations []ServerConfiguration
 
+// MiddlewareFunction provides way to implement custom middleware in the prepareRequest
+type MiddlewareFunction func(*http.Request)
+
+// MiddlewareFunctionWithError provides way to implement custom middleware with errors in the prepareRequest
+type MiddlewareFunctionWithError func(*http.Request) error
+
+// ResponseMiddlewareFunction provides way to implement custom middleware with errors after the response is received
+type ResponseMiddlewareFunction func(*http.Response, []byte) error
+
 // Configuration stores the configuration of the API client
 type Configuration struct {
 	Host               string            `json:"host,omitempty"`
@@ -119,6 +135,10 @@ type Configuration struct {
 	MaxRetries         int           `json:"maxRetries,omitempty"`
 	WaitTime           time.Duration `json:"waitTime,omitempty"`
 	MaxWaitTime        time.Duration `json:"maxWaitTime,omitempty"`
+
+	Middleware          MiddlewareFunction          `json:"-"`
+	MiddlewareWithError MiddlewareFunctionWithError `json:"-"`
+	ResponseMiddleware  ResponseMiddlewareFunction  `json:"-"`
 }
 
 // NewConfiguration returns a new shared.Configuration object
@@ -161,9 +181,11 @@ type ClientOptions struct {
 
 // Credentials are the credentials that will be used for authentication
 type Credentials struct {
-	Username string `yaml:"username"`
-	Password string `yaml:"password"`
-	Token    string `yaml:"token"`
+	Username    string `yaml:"username"`
+	Password    string `yaml:"password"`
+	Token       string `yaml:"token"`
+	S3AccessKey string `yaml:"s3AccessKey"`
+	S3SecretKey string `yaml:"s3SecretKey"`
 }
 
 // NewConfigurationFromOptions returns a new shared.Configuration object created from the client options
@@ -217,7 +239,10 @@ func CreateTransport(insecure bool, certificate string) *http.Transport {
 }
 
 func NewConfigurationFromEnv() *Configuration {
-	return NewConfiguration(os.Getenv(IonosUsernameEnvVar), os.Getenv(IonosPasswordEnvVar), os.Getenv(IonosTokenEnvVar), os.Getenv(IonosApiUrlEnvVar))
+	return NewConfiguration(
+		os.Getenv(IonosUsernameEnvVar), os.Getenv(IonosPasswordEnvVar), os.Getenv(IonosTokenEnvVar),
+		os.Getenv(IonosApiUrlEnvVar),
+	)
 }
 
 // AddDefaultHeader adds a new HTTP header to the default header in the request
@@ -253,7 +278,10 @@ func (sc ServerConfigurations) URL(index int, variables map[string]string) (stri
 				}
 			}
 			if !found {
-				return "", fmt.Errorf("the variable %s in the server URL has invalid value %v. Must be %v", name, value, variable.EnumValues)
+				return "", fmt.Errorf(
+					"the variable %s in the server URL has invalid value %v. Must be %v", name, value,
+					variable.EnumValues,
+				)
 			}
 			serverUrl = strings.Replace(serverUrl, "{"+name+"}", value, -1)
 		} else {
@@ -305,7 +333,9 @@ func getServerVariables(ctx context.Context) (map[string]string, error) {
 		if variables, ok := sv.(map[string]string); ok {
 			return variables, nil
 		}
-		return nil, reportError("ctx value of ContextServerVariables has invalid type %T should be map[string]string", sv)
+		return nil, reportError(
+			"ctx value of ContextServerVariables has invalid type %T should be map[string]string", sv,
+		)
 	}
 	return nil, nil
 }
@@ -314,7 +344,10 @@ func getServerOperationVariables(ctx context.Context, endpoint string) (map[stri
 	osv := ctx.Value(ContextOperationServerVariables)
 	if osv != nil {
 		if operationVariables, ok := osv.(map[string]map[string]string); !ok {
-			return nil, reportError("ctx value of ContextOperationServerVariables has invalid type %T should be map[string]map[string]string", osv)
+			return nil, reportError(
+				"ctx value of ContextOperationServerVariables has invalid type %T should be map[string]map[string]string",
+				osv,
+			)
 		} else {
 			variables, ok := operationVariables[endpoint]
 			if ok {
@@ -402,10 +435,12 @@ func OverrideLocationFor(configProvider ConfigProvider, location, endpoint strin
 		}
 	}
 	SdkLogger.Printf("[DEBUG] Adding new server configuration for location %s", location)
-	configProvider.GetConfig().Servers = append(configProvider.GetConfig().Servers, ServerConfiguration{
-		URL:         endpoint,
-		Description: EndpointOverridden + location,
-	})
+	configProvider.GetConfig().Servers = append(
+		configProvider.GetConfig().Servers, ServerConfiguration{
+			URL:         endpoint,
+			Description: EndpointOverridden + location,
+		},
+	)
 }
 
 func SetSkipTLSVerify(configProvider ConfigProvider, skipTLSVerify bool) {
@@ -425,3 +460,27 @@ func AddCertsToClient(authorityData string) *x509.CertPool {
 	}
 	return rootCAs
 }
+
+func SignerMiddleware(region, service, accessKey, secretKey string) MiddlewareFunctionWithError {
+	signer := awsv4.NewSigner(credentials.NewStaticCredentials(accessKey, secretKey, ""))
+
+	// Define default values for region and service to maintain backward compatibility
+	if region == "" {
+		region = "eu-central-3"
+	}
+	if service == "" {
+		service = "s3"
+	}
+	return func(r *http.Request) error {
+		var reader io.ReadSeeker
+		if r.Body != nil {
+			bodyBytes, err := io.ReadAll(r.Body)
+			if err != nil {
+				return err
+			}
+			reader = bytes.NewReader(bodyBytes)
+		}
+		_, err := signer.Sign(r, reader, service, region, time.Now())
+		return err
+	}
+}

shared/go.mod

@@ -2,6 +2,11 @@ module github.com/ionos-cloud/sdk-go-bundle/shared
 
 go 1.20
 
+require (
+	github.com/aws/aws-sdk-go v1.55.6 // indirect
+	github.com/jmespath/go-jmespath v0.4.0 // indirect
+)
+
 require (
 	github.com/stretchr/testify v1.10.0
 	gopkg.in/yaml.v3 v3.0.1

shared/go.sum

@@ -1,3 +1,13 @@
+github.com/aws/aws-sdk-go v1.55.6 h1:cSg4pvZ3m8dgYcgqB97MrcdjUmZ1BeMYKUxMMB89IPk=
+github.com/aws/aws-sdk-go v1.55.6/go.mod h1:eRwEWoyTWFMVYVQzKMNHWP5/RV4xIUGMQfXQHfHkpNU=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg=
+github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
+github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=