Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move the HMAC auth policy to an internal package #21579

Merged
merged 1 commit into from
Sep 18, 2023
Merged

Move the HMAC auth policy to an internal package #21579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions sdk/data/azappconfig/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
"github.com/Azure/azure-sdk-for-go/sdk/azcore"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
"github.com/Azure/azure-sdk-for-go/sdk/data/azappconfig/internal/auth"
"github.com/Azure/azure-sdk-for-go/sdk/data/azappconfig/internal/generated"
)

Expand Down Expand Up @@ -46,12 +47,12 @@ func NewClient(endpoint string, cred azcore.TokenCredential, options *ClientOpti

// NewClientFromConnectionString parses the connection string and returns a pointer to a Client object.
func NewClientFromConnectionString(connectionString string, options *ClientOptions) (*Client, error) {
endpoint, credential, secret, err := parseConnectionString(connectionString)
endpoint, credential, secret, err := auth.ParseConnectionString(connectionString)
if err != nil {
return nil, err
}

return newClient(endpoint, newHmacAuthenticationPolicy(credential, secret), options)
return newClient(endpoint, auth.NewHMACPolicy(credential, secret), options)
}

func newClient(endpoint string, authPolicy policy.Policy, options *ClientOptions) (*Client, error) {
Expand Down
17 changes: 11 additions & 6 deletions sdk/data/azappconfig/policy_hmac_auth.go → ...pconfig/internal/auth/policy_hmac_auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

package azappconfig
package auth

import (
"bytes"
Expand All @@ -21,19 +21,23 @@ import (
"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
)

type hmacAuthenticationPolicy struct {
// HMACPolicy is a pipeline policy that implements HMAC authentication.
// https://learn.microsoft.com/en-us/azure/azure-app-configuration/rest-api-authentication-hmac
type HMACPolicy struct {
credential string
secret []byte
}

func newHmacAuthenticationPolicy(credential string, secret []byte) *hmacAuthenticationPolicy {
return &hmacAuthenticationPolicy{
// NewHMACPolicy creates a new instance of [HMACPolicy].
func NewHMACPolicy(credential string, secret []byte) *HMACPolicy {
return &HMACPolicy{
credential: credential,
secret: secret,
}
}

func (policy *hmacAuthenticationPolicy) Do(request *policy.Request) (*http.Response, error) {
// Do implements the policy.Policy interface on the [HMACPolicy] type.
func (policy *HMACPolicy) Do(request *policy.Request) (*http.Response, error) {
req := request.Raw()
id := policy.credential
key := policy.secret
Expand Down Expand Up @@ -97,7 +101,8 @@ func getHmac(content string, key []byte) (string, error) {
return base64.StdEncoding.EncodeToString(hmac.Sum(nil)), nil
}

func parseConnectionString(connectionString string) (endpoint string, credential string, secret []byte, err error) {
// ParseConnectionString parses the provided connection string.
func ParseConnectionString(connectionString string) (endpoint string, credential string, secret []byte, err error) {
const connectionStringEndpointPrefix = "Endpoint="
const connectionStringCredentialPrefix = "Id="
const connectionStringSecretPrefix = "Secret="
Expand Down
20 changes: 10 additions & 10 deletions ...zappconfig/policy_hmac_auth_parse_test.go → ...ernal/auth/policy_hmac_auth_parse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package azappconfig
package auth

import (
"testing"
Expand All @@ -13,7 +13,7 @@ import (
)

func TestHmacAuthParseConnectionString(t *testing.T) {
ep, id, sc, err := parseConnectionString("Endpoint=xX;Id=yY;Secret=ZmZm")
ep, id, sc, err := ParseConnectionString("Endpoint=xX;Id=yY;Secret=ZmZm")
require.NoError(t, err)
require.Equal(t, "xX", ep)
require.Equal(t, "yY", id)
Expand All @@ -25,7 +25,7 @@ func TestHmacAuthParseConnectionString(t *testing.T) {
}

func TestHmacAuthParseConnectionStringMixedOrder(t *testing.T) {
ep, id, sc, err := parseConnectionString("Id=yY;Secret=ZmZm;Endpoint=xX")
ep, id, sc, err := ParseConnectionString("Id=yY;Secret=ZmZm;Endpoint=xX")
require.NoError(t, err)
require.Equal(t, "xX", ep)
require.Equal(t, "yY", id)
Expand All @@ -37,7 +37,7 @@ func TestHmacAuthParseConnectionStringMixedOrder(t *testing.T) {
}

func TestHmacAuthParseConnectionStringExtraProperties(t *testing.T) {
ep, id, sc, err := parseConnectionString("A=aA;Endpoint=xX;B=bB;Id=yY;C=cC;Secret=ZmZm;D=dD;")
ep, id, sc, err := ParseConnectionString("A=aA;Endpoint=xX;B=bB;Id=yY;C=cC;Secret=ZmZm;D=dD;")
require.NoError(t, err)
require.Equal(t, "xX", ep)
require.Equal(t, "yY", id)
Expand All @@ -49,31 +49,31 @@ func TestHmacAuthParseConnectionStringExtraProperties(t *testing.T) {
}

func TestHmacAuthParseConnectionStringMissingEndoint(t *testing.T) {
_, _, _, err := parseConnectionString("Id=yY;Secret=ZmZm")
_, _, _, err := ParseConnectionString("Id=yY;Secret=ZmZm")
require.Error(t, err)
}

func TestHmacAuthParseConnectionStringMissingId(t *testing.T) {
_, _, _, err := parseConnectionString("Endpoint=xX;Secret=ZmZm")
_, _, _, err := ParseConnectionString("Endpoint=xX;Secret=ZmZm")
require.Error(t, err)
}

func TestHmacAuthParseConnectionStringMissingSecret(t *testing.T) {
_, _, _, err := parseConnectionString("Endpoint=xX;Id=yY")
_, _, _, err := ParseConnectionString("Endpoint=xX;Id=yY")
require.Error(t, err)
}

func TestHmacAuthParseConnectionStringDuplicateEndoint(t *testing.T) {
_, _, _, err := parseConnectionString("Endpoint=xX;Endpoint=xX;Id=yY;Secret=ZmZm")
_, _, _, err := ParseConnectionString("Endpoint=xX;Endpoint=xX;Id=yY;Secret=ZmZm")
require.Error(t, err)
}

func TestHmacAuthParseConnectionStringDuplicateId(t *testing.T) {
_, _, _, err := parseConnectionString("Endpoint=xX;Id=yY;Id=yY;Secret=ZmZm")
_, _, _, err := ParseConnectionString("Endpoint=xX;Id=yY;Id=yY;Secret=ZmZm")
require.Error(t, err)
}

func TestHmacAuthParseConnectionStringDuplicateSecret(t *testing.T) {
_, _, _, err := parseConnectionString("Endpoint=xX;Id=yY;Secret=ZmZm;Secret=zZ")
_, _, _, err := ParseConnectionString("Endpoint=xX;Id=yY;Secret=ZmZm;Secret=zZ")
require.Error(t, err)
}