mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-06-08 07:26:48 +00:00
context: Add authenticated HTTP credentials (#892)
* gRPC: context overide * exchanges: continue update * exchange: Update context handling *Add setter methods for API credentials *Shift credentials functionality to its own file in exchanges package *Add tests *Refactor function DeployCredentialsToContext for library usage *Add function to process credential metadata from API boundary to internal use context value. *Add OTP rpc handling * exchanges: reverts to old style in GetFeeByType, reverts some code I accidently deleted. Plus things and other. XD * template: update * exchanges: fix linter issues * REMOVE THAT AWESOME NEW LINE! * gct: fix some tests * I cant spell :( * exchanges/gctscript: fix more tests * coinnut: fix tests * Update exchanges/credentials.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update exchanges/credentials.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update exchanges/credentials.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update exchanges/credentials.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update exchanges/credentials.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * glorious: nits * exchanges/gctcli: stop applying empty credentials * fix linters * exchanges: add test * rpceserver: actually check error for errors * rpcserver: fix up tests * Update exchanges/credentials.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * exchanges/creds: move tests to corresponding files, add protection and segration for Credentials struct & ptr values * exchanges/creds: allow subaccount to override default credentials via gRPC * exchanges/credentials: don't return nil in GetCredentials * creds: spelling * exchanges: fix glorious NITS! * credentials: Add in test and refactor IsEmpty method. * credentials: change type positioning (glorious) * exchange_template: Fix template changes * DOCS: Refresh * docs: fix spelling * DOCS: fix alignment and add package * DOCS: ALIGN! Co-authored-by: Ryan O'Hara-Reid <ryan.oharareid@thrasher.io> Co-authored-by: Scott <gloriousCode@users.noreply.github.com>
This commit is contained in:
Ryan O'Hara-Reid
GitHub
487
exchanges/credentials_test.go
Normal file
487
exchanges/credentials_test.go
Normal file
@@ -0,0 +1,487 @@
|
||||
package exchange
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
|
||||
"github.com/thrasher-corp/gocryptotrader/config"
|
||||
"google.golang.org/grpc/metadata"
|
||||
)
|
||||
|
||||
func TestParseCredentialsMetadata(t *testing.T) {
|
||||
t.Parallel()
|
||||
_, err := ParseCredentialsMetadata(context.Background(), nil)
|
||||
if !errors.Is(err, errMetaDataIsNil) {
|
||||
t.Fatalf("received: '%v' but expected: '%v'", err, errMetaDataIsNil)
|
||||
}
|
||||
|
||||
_, err = ParseCredentialsMetadata(context.Background(), metadata.MD{})
|
||||
if !errors.Is(err, nil) {
|
||||
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
|
||||
}
|
||||
|
||||
ctx := metadata.AppendToOutgoingContext(context.Background(),
|
||||
string(contextCredentialsFlag), "wow", string(contextCredentialsFlag), "wow2")
|
||||
nortyMD, _ := metadata.FromOutgoingContext(ctx)
|
||||
|
||||
_, err = ParseCredentialsMetadata(context.Background(), nortyMD)
|
||||
if !errors.Is(err, errInvalidCredentialMetaDataLength) {
|
||||
t.Fatalf("received: '%v' but expected: '%v'", err, errInvalidCredentialMetaDataLength)
|
||||
}
|
||||
|
||||
ctx = metadata.AppendToOutgoingContext(context.Background(),
|
||||
string(contextCredentialsFlag), "brokenstring")
|
||||
nortyMD, _ = metadata.FromOutgoingContext(ctx)
|
||||
|
||||
_, err = ParseCredentialsMetadata(context.Background(), nortyMD)
|
||||
if !errors.Is(err, errMissingInfo) {
|
||||
t.Fatalf("received: '%v' but expected: '%v'", err, errMissingInfo)
|
||||
}
|
||||
|
||||
beforeCreds := Credentials{
|
||||
Key: "superkey",
|
||||
Secret: "supersecret",
|
||||
SubAccount: "supersub",
|
||||
ClientID: "superclient",
|
||||
PEMKey: "superpem",
|
||||
OneTimePassword: "superOneTimePasssssss",
|
||||
}
|
||||
|
||||
flag, outGoing := beforeCreds.GetMetaData()
|
||||
ctx = metadata.AppendToOutgoingContext(context.Background(), flag, outGoing)
|
||||
lovelyMD, _ := metadata.FromOutgoingContext(ctx)
|
||||
|
||||
ctx, err = ParseCredentialsMetadata(context.Background(), lovelyMD)
|
||||
if !errors.Is(err, nil) {
|
||||
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
|
||||
}
|
||||
|
||||
store, ok := ctx.Value(contextCredentialsFlag).(*contextCredentialsStore)
|
||||
if !ok {
|
||||
t.Fatal("should have processed")
|
||||
}
|
||||
|
||||
afterCreds := store.Get()
|
||||
|
||||
if afterCreds.Key != "superkey" &&
|
||||
afterCreds.Secret != "supersecret" &&
|
||||
afterCreds.SubAccount != "supersub" &&
|
||||
afterCreds.ClientID != "superclient" &&
|
||||
afterCreds.PEMKey != "superpem" &&
|
||||
afterCreds.OneTimePassword != "superOneTimePasssssss" {
|
||||
t.Fatal("unexpected values")
|
||||
}
|
||||
|
||||
// subaccount override
|
||||
subaccount := Credentials{
|
||||
SubAccount: "supersub",
|
||||
}
|
||||
|
||||
flag, outGoing = subaccount.GetMetaData()
|
||||
ctx = metadata.AppendToOutgoingContext(context.Background(), flag, outGoing)
|
||||
lovelyMD, _ = metadata.FromOutgoingContext(ctx)
|
||||
|
||||
ctx, err = ParseCredentialsMetadata(context.Background(), lovelyMD)
|
||||
if !errors.Is(err, nil) {
|
||||
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
|
||||
}
|
||||
|
||||
sa, ok := ctx.Value(contextSubAccountFlag).(string)
|
||||
if !ok {
|
||||
t.Fatal("should have processed")
|
||||
}
|
||||
|
||||
if sa != "supersub" {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetCredentials(t *testing.T) {
|
||||
t.Parallel()
|
||||
var b Base
|
||||
_, err := b.GetCredentials(context.Background())
|
||||
if !errors.Is(err, ErrCredentialsAreEmpty) {
|
||||
t.Fatalf("received: %v but expected: %v", err, ErrCredentialsAreEmpty)
|
||||
}
|
||||
|
||||
b.API.CredentialsValidator.RequiresKey = true
|
||||
ctx := DeployCredentialsToContext(context.Background(), &Credentials{Secret: "wow"})
|
||||
_, err = b.GetCredentials(ctx)
|
||||
if !errors.Is(err, errRequiresAPIKey) {
|
||||
t.Fatalf("received: %v but expected: %v", err, errRequiresAPIKey)
|
||||
}
|
||||
|
||||
b.API.CredentialsValidator.RequiresSecret = true
|
||||
ctx = DeployCredentialsToContext(context.Background(), &Credentials{Key: "wow"})
|
||||
_, err = b.GetCredentials(ctx)
|
||||
if !errors.Is(err, errRequiresAPISecret) {
|
||||
t.Fatalf("received: %v but expected: %v", err, errRequiresAPISecret)
|
||||
}
|
||||
|
||||
ctx = context.WithValue(context.Background(), contextCredentialsFlag, "pewpew")
|
||||
_, err = b.GetCredentials(ctx)
|
||||
if !errors.Is(err, errContextCredentialsFailure) {
|
||||
t.Fatalf("received: %v but expected: %v", err, errContextCredentialsFailure)
|
||||
}
|
||||
|
||||
fullCred := Credentials{
|
||||
Key: "superkey",
|
||||
Secret: "supersecret",
|
||||
SubAccount: "supersub",
|
||||
ClientID: "superclient",
|
||||
PEMKey: "superpem",
|
||||
OneTimePassword: "superOneTimePasssssss",
|
||||
}
|
||||
|
||||
flag, store := fullCred.getInternal()
|
||||
|
||||
ctx = context.WithValue(context.Background(), flag, store)
|
||||
creds, err := b.GetCredentials(ctx)
|
||||
if !errors.Is(err, nil) {
|
||||
t.Fatalf("received: %v but expected: %v", err, nil)
|
||||
}
|
||||
|
||||
if creds.Key != "superkey" &&
|
||||
creds.Secret != "supersecret" &&
|
||||
creds.SubAccount != "supersub" &&
|
||||
creds.ClientID != "superclient" &&
|
||||
creds.PEMKey != "superpem" &&
|
||||
creds.OneTimePassword != "superOneTimePasssssss" {
|
||||
t.Fatal("unexpected values")
|
||||
}
|
||||
|
||||
lonelyCred := Credentials{
|
||||
Key: "superkey",
|
||||
Secret: "supersecret",
|
||||
SubAccount: "supersub",
|
||||
PEMKey: "superpem",
|
||||
OneTimePassword: "superOneTimePasssssss",
|
||||
}
|
||||
|
||||
flag, store = lonelyCred.getInternal()
|
||||
|
||||
ctx = context.WithValue(context.Background(), flag, store)
|
||||
b.API.CredentialsValidator.RequiresClientID = true
|
||||
_, err = b.GetCredentials(ctx)
|
||||
if !errors.Is(err, errRequiresAPIClientID) {
|
||||
t.Fatalf("received: %v but expected: %v", err, errRequiresAPIClientID)
|
||||
}
|
||||
|
||||
b.API.SetKey("hello")
|
||||
b.API.SetSecret("sir")
|
||||
b.API.SetClientID("1337")
|
||||
ctx = deploySubAccountOverrideToContext(context.Background(), "superaccount")
|
||||
overridedSA, err := b.GetCredentials(ctx)
|
||||
if !errors.Is(err, nil) {
|
||||
t.Fatalf("received: %v but expected: %v", err, nil)
|
||||
}
|
||||
|
||||
if overridedSA.Key != "hello" &&
|
||||
overridedSA.Secret != "sir" &&
|
||||
overridedSA.ClientID != "1337" &&
|
||||
overridedSA.SubAccount != "superaccount" {
|
||||
t.Fatal("unexpected values")
|
||||
}
|
||||
|
||||
notOverrided, err := b.GetCredentials(context.Background())
|
||||
if !errors.Is(err, nil) {
|
||||
t.Fatalf("received: %v but expected: %v", err, nil)
|
||||
}
|
||||
|
||||
if notOverrided.Key != "hello" &&
|
||||
notOverrided.Secret != "sir" &&
|
||||
notOverrided.ClientID != "1337" &&
|
||||
notOverrided.SubAccount != "" {
|
||||
t.Fatal("unexpected values")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAreCredentialsValid(t *testing.T) {
|
||||
t.Parallel()
|
||||
var b Base
|
||||
if b.AreCredentialsValid(context.Background()) {
|
||||
t.Fatal("should not be valid")
|
||||
}
|
||||
ctx := DeployCredentialsToContext(context.Background(), &Credentials{Key: "hello"})
|
||||
if !b.AreCredentialsValid(ctx) {
|
||||
t.Fatal("should be valid")
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateAPICredentials(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var b Base
|
||||
type tester struct {
|
||||
Key string
|
||||
Secret string
|
||||
ClientID string
|
||||
PEMKey string
|
||||
RequiresPEM bool
|
||||
RequiresKey bool
|
||||
RequiresSecret bool
|
||||
RequiresClientID bool
|
||||
RequiresBase64DecodeSecret bool
|
||||
Expected error
|
||||
}
|
||||
|
||||
testCases := []tester{
|
||||
// Empty credentials
|
||||
{Expected: ErrCredentialsAreEmpty},
|
||||
// test key
|
||||
{RequiresKey: true, Expected: errRequiresAPIKey, Secret: "bruh"},
|
||||
{RequiresKey: true, Key: "k3y"},
|
||||
// test secret
|
||||
{RequiresSecret: true, Expected: errRequiresAPISecret, Key: "bruh"},
|
||||
{RequiresSecret: true, Secret: "s3cr3t"},
|
||||
// test pem
|
||||
{RequiresPEM: true, Expected: errRequiresAPIPEMKey, Key: "bruh"},
|
||||
{RequiresPEM: true, PEMKey: "p3mK3y"},
|
||||
// test clientID
|
||||
{RequiresClientID: true, Expected: errRequiresAPIClientID, Key: "bruh"},
|
||||
{RequiresClientID: true, ClientID: "cli3nt1D"},
|
||||
// test requires base64 decode secret
|
||||
{RequiresBase64DecodeSecret: true, RequiresSecret: true, Expected: errRequiresAPISecret, Key: "bruh"},
|
||||
{RequiresBase64DecodeSecret: true, Secret: "%%", Expected: errBase64DecodeFailure},
|
||||
{RequiresBase64DecodeSecret: true, Secret: "aGVsbG8gd29ybGQ="},
|
||||
}
|
||||
|
||||
setupBase := func(b *Base, tData *tester) {
|
||||
b.API.SetKey(tData.Key)
|
||||
b.API.SetSecret(tData.Secret)
|
||||
b.API.SetClientID(tData.ClientID)
|
||||
b.API.SetPEMKey(tData.PEMKey)
|
||||
b.API.CredentialsValidator.RequiresKey = tData.RequiresKey
|
||||
b.API.CredentialsValidator.RequiresSecret = tData.RequiresSecret
|
||||
b.API.CredentialsValidator.RequiresPEM = tData.RequiresPEM
|
||||
b.API.CredentialsValidator.RequiresClientID = tData.RequiresClientID
|
||||
b.API.CredentialsValidator.RequiresBase64DecodeSecret = tData.RequiresBase64DecodeSecret
|
||||
}
|
||||
|
||||
for x := range testCases {
|
||||
testData := &testCases[x]
|
||||
t.Run("", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
setupBase(&b, testData)
|
||||
if err := b.ValidateAPICredentials(b.API.credentials); !errors.Is(err, testData.Expected) {
|
||||
t.Errorf("Test %d: expected: %v: got %v", x+1, testData.Expected, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckCredentials(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
b := Base{
|
||||
SkipAuthCheck: true,
|
||||
API: API{credentials: &Credentials{}},
|
||||
}
|
||||
|
||||
// Test SkipAuthCheck
|
||||
err := b.CheckCredentials(&Credentials{}, false)
|
||||
if !errors.Is(err, nil) {
|
||||
t.Errorf("received '%v' expected '%v'", err, nil)
|
||||
}
|
||||
|
||||
// Test credentials failure
|
||||
b.SkipAuthCheck = false
|
||||
b.API.CredentialsValidator.RequiresKey = true
|
||||
b.API.credentials.OneTimePassword = "wow"
|
||||
err = b.CheckCredentials(b.API.credentials, false)
|
||||
if !errors.Is(err, errRequiresAPIKey) {
|
||||
t.Errorf("received '%v' expected '%v'", err, errRequiresAPIKey)
|
||||
}
|
||||
b.API.credentials.OneTimePassword = ""
|
||||
|
||||
// Test bot usage with authenticated API support disabled, but with
|
||||
// valid credentials
|
||||
b.LoadedByConfig = true
|
||||
b.API.credentials.Key = "k3y"
|
||||
err = b.CheckCredentials(b.API.credentials, false)
|
||||
if !errors.Is(err, ErrAuthenticationSupportNotEnabled) {
|
||||
t.Errorf("received '%v' expected '%v'", err, ErrAuthenticationSupportNotEnabled)
|
||||
}
|
||||
|
||||
// Test enabled authenticated API support and loaded by config
|
||||
// but invalid credentials
|
||||
b.API.AuthenticatedSupport = true
|
||||
b.API.credentials.Key = ""
|
||||
err = b.CheckCredentials(b.API.credentials, false)
|
||||
if !errors.Is(err, ErrCredentialsAreEmpty) {
|
||||
t.Errorf("received '%v' expected '%v'", err, ErrCredentialsAreEmpty)
|
||||
}
|
||||
|
||||
// Finally a valid one
|
||||
b.API.credentials.Key = "k3y"
|
||||
err = b.CheckCredentials(b.API.credentials, false)
|
||||
if !errors.Is(err, nil) {
|
||||
t.Errorf("received '%v' expected '%v'", err, nil)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetInternal(t *testing.T) {
|
||||
t.Parallel()
|
||||
flag, store := (&Credentials{}).getInternal()
|
||||
if flag != "" {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
if store != nil {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
flag, store = (&Credentials{Key: "wow"}).getInternal()
|
||||
if flag != contextCredentialsFlag {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
if store == nil {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
if store.Get().Key != "wow" {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPISetters(t *testing.T) {
|
||||
t.Parallel()
|
||||
api := API{}
|
||||
api.SetKey(key)
|
||||
if api.credentials.Key != key {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
|
||||
api = API{}
|
||||
api.SetSecret(secret)
|
||||
if api.credentials.Secret != secret {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
|
||||
api = API{}
|
||||
api.SetClientID((clientID))
|
||||
if api.credentials.ClientID != clientID {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
|
||||
api = API{}
|
||||
api.SetPEMKey(_PEMKey)
|
||||
if api.credentials.PEMKey != _PEMKey {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
|
||||
api = API{}
|
||||
api.SetSubAccount(subAccount)
|
||||
if api.credentials.SubAccount != subAccount {
|
||||
t.Fatal("unexpected value")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetCredentials(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
b := Base{
|
||||
Name: "TESTNAME",
|
||||
Enabled: false,
|
||||
API: API{
|
||||
AuthenticatedSupport: false,
|
||||
AuthenticatedWebsocketSupport: false,
|
||||
},
|
||||
}
|
||||
|
||||
b.SetCredentials("RocketMan", "Digereedoo", "007", "", "", "")
|
||||
if b.API.credentials.Key != "RocketMan" &&
|
||||
b.API.credentials.Secret != "Digereedoo" &&
|
||||
b.API.credentials.ClientID != "007" {
|
||||
t.Error("invalid API credentials")
|
||||
}
|
||||
|
||||
// Invalid secret
|
||||
b.API.CredentialsValidator.RequiresBase64DecodeSecret = true
|
||||
b.API.AuthenticatedSupport = true
|
||||
b.SetCredentials("RocketMan", "%%", "007", "", "", "")
|
||||
if b.API.AuthenticatedSupport || b.API.AuthenticatedWebsocketSupport {
|
||||
t.Error("invalid secret should disable authenticated API support")
|
||||
}
|
||||
|
||||
// valid secret
|
||||
b.API.CredentialsValidator.RequiresBase64DecodeSecret = true
|
||||
b.API.AuthenticatedSupport = true
|
||||
b.SetCredentials("RocketMan", "aGVsbG8gd29ybGQ=", "007", "", "", "")
|
||||
if !b.API.AuthenticatedSupport && b.API.credentials.Secret != "hello world" {
|
||||
t.Error("invalid secret should disable authenticated API support")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetDefaultCredentials(t *testing.T) {
|
||||
var b Base
|
||||
if b.GetDefaultCredentials() != nil {
|
||||
t.Fatal("unexpected return")
|
||||
}
|
||||
b.SetCredentials("test", "", "", "", "", "")
|
||||
if b.GetDefaultCredentials() == nil {
|
||||
t.Fatal("unexpected return")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetAPICredentialDefaults(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
b := Base{
|
||||
Config: &config.Exchange{},
|
||||
}
|
||||
b.API.CredentialsValidator.RequiresKey = true
|
||||
b.API.CredentialsValidator.RequiresSecret = true
|
||||
b.API.CredentialsValidator.RequiresBase64DecodeSecret = true
|
||||
b.API.CredentialsValidator.RequiresClientID = true
|
||||
b.API.CredentialsValidator.RequiresPEM = true
|
||||
b.SetAPICredentialDefaults()
|
||||
|
||||
if !b.Config.API.CredentialsValidator.RequiresKey ||
|
||||
!b.Config.API.CredentialsValidator.RequiresSecret ||
|
||||
!b.Config.API.CredentialsValidator.RequiresBase64DecodeSecret ||
|
||||
!b.Config.API.CredentialsValidator.RequiresClientID ||
|
||||
!b.Config.API.CredentialsValidator.RequiresPEM {
|
||||
t.Error("incorrect values")
|
||||
}
|
||||
}
|
||||
|
||||
// TestGetAuthenticatedAPISupport logic test
|
||||
func TestGetAuthenticatedAPISupport(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
base := Base{
|
||||
API: API{
|
||||
AuthenticatedSupport: true,
|
||||
AuthenticatedWebsocketSupport: false,
|
||||
},
|
||||
}
|
||||
|
||||
if !base.GetAuthenticatedAPISupport(RestAuthentication) {
|
||||
t.Fatal("Expected RestAuthentication to return true")
|
||||
}
|
||||
if base.GetAuthenticatedAPISupport(WebsocketAuthentication) {
|
||||
t.Fatal("Expected WebsocketAuthentication to return false")
|
||||
}
|
||||
base.API.AuthenticatedWebsocketSupport = true
|
||||
if !base.GetAuthenticatedAPISupport(WebsocketAuthentication) {
|
||||
t.Fatal("Expected WebsocketAuthentication to return true")
|
||||
}
|
||||
if base.GetAuthenticatedAPISupport(2) {
|
||||
t.Fatal("Expected default case of 'false' to be returned")
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsEmpty(t *testing.T) {
|
||||
var c *Credentials
|
||||
if !c.IsEmpty() {
|
||||
t.Fatalf("expected: %v but received: %v", true, c.IsEmpty())
|
||||
}
|
||||
c = new(Credentials)
|
||||
if !c.IsEmpty() {
|
||||
t.Fatalf("expected: %v but received: %v", true, c.IsEmpty())
|
||||
}
|
||||
|
||||
c.SubAccount = "woow"
|
||||
if c.IsEmpty() {
|
||||
t.Fatalf("expected: %v but received: %v", false, c.IsEmpty())
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user