v1hmac

package

v0.0.0-...-97c5a11 Latest Latest Go to latest Published: Apr 18, 2024 License: BSD-3-Clause, MIT Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Authenticator struct {
	// contains filtered or unexported fields
}

Authenticator represents an authentication.Authenticator implementation using v1HMAC signatures

func NewAuthenticator(apiKeyID string, secretAPIKey string) (*Authenticator, error)

NewAuthenticator creates an Authenticator with the given apiKeyID and secretAPIKey

The apiKeyID is an identifier for the secret API key. The apiKeyID can be retrieved from the Configuration Center This identifier is visible in the HTTP request and is also used to identify the correct account.
secretAPIKey is a shared secret. The shared secret can be retrieved from the Configuration Center. An apiKeyID and secretAPIKey always go hand-in-hand, the difference is that secretAPIKey is never visible in the HTTP request. This secret is used as input for the HMAC algorithm.

func (a Authenticator) GetAuthorization(httpMethod string, resourceURI url.URL, requestHeaders []communication.Header) (string, error)

GetAuthorization creates an authentication signature for the given httpMethod, resourceURI and requestHeaders