Spaces:
Running
Running
File size: 5,198 Bytes
b110593 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
// _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
//
// CONTACT: [email protected]
//
package apikey
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/weaviate/weaviate/usecases/config"
)
func Test_APIKeyClient(t *testing.T) {
type test struct {
name string
config config.APIKey
expectConfigErr bool
expectConfigErrMsg string
validate func(t *testing.T, c *Client)
}
tests := []test{
{
name: "not enabled",
config: config.APIKey{
Enabled: false,
},
expectConfigErr: false,
},
{
name: "key, but no user",
config: config.APIKey{
Enabled: true,
AllowedKeys: []string{"secret-key"},
Users: []string{},
},
expectConfigErr: true,
expectConfigErrMsg: "need at least one user",
},
{
name: "zero length key",
config: config.APIKey{
Enabled: true,
AllowedKeys: []string{""},
Users: []string{"gooduser"},
},
expectConfigErr: true,
expectConfigErrMsg: "keys cannot have length 0",
},
{
name: "user, but no key",
config: config.APIKey{
Enabled: true,
AllowedKeys: []string{},
Users: []string{"johnnyBeAllowed"},
},
expectConfigErr: true,
expectConfigErrMsg: "need at least one valid allowed key",
},
{
name: "zero length user",
config: config.APIKey{
Enabled: true,
AllowedKeys: []string{"secret-key"},
Users: []string{""},
},
expectConfigErr: true,
expectConfigErrMsg: "users cannot have length 0",
},
{
name: "one user, one key",
config: config.APIKey{
Enabled: true,
AllowedKeys: []string{"secret-key"},
Users: []string{"mrRoboto"},
},
expectConfigErr: false,
validate: func(t *testing.T, c *Client) {
p, err := c.ValidateAndExtract("secret-key", nil)
require.Nil(t, err)
assert.Equal(t, "mrRoboto", p.Username)
_, err = c.ValidateAndExtract("", nil)
require.NotNil(t, err)
_, err = c.ValidateAndExtract("other-key", nil)
require.NotNil(t, err)
},
},
{
// this is allowed, this means that all keys point to the same user for
// authZ purposes
name: "one user, multiple keys",
config: config.APIKey{
Enabled: true,
AllowedKeys: []string{"secret-key", "another-secret-key", "third-key"},
Users: []string{"jane"},
},
expectConfigErr: false,
validate: func(t *testing.T, c *Client) {
p, err := c.ValidateAndExtract("secret-key", nil)
require.Nil(t, err)
assert.Equal(t, "jane", p.Username)
p, err = c.ValidateAndExtract("another-secret-key", nil)
require.Nil(t, err)
assert.Equal(t, "jane", p.Username)
p, err = c.ValidateAndExtract("third-key", nil)
require.Nil(t, err)
assert.Equal(t, "jane", p.Username)
_, err = c.ValidateAndExtract("", nil)
require.NotNil(t, err)
_, err = c.ValidateAndExtract("other-key", nil)
require.NotNil(t, err)
},
},
{
// this is allowed, this means that each key at pos i points to user at
// pos i for authZ purposes
name: "multiple user, multiple keys",
config: config.APIKey{
Enabled: true,
AllowedKeys: []string{"secret-key", "another-secret-key", "third-key"},
Users: []string{"jane", "jessica", "jennifer"},
},
expectConfigErr: false,
validate: func(t *testing.T, c *Client) {
p, err := c.ValidateAndExtract("secret-key", nil)
require.Nil(t, err)
assert.Equal(t, "jane", p.Username)
p, err = c.ValidateAndExtract("another-secret-key", nil)
require.Nil(t, err)
assert.Equal(t, "jessica", p.Username)
p, err = c.ValidateAndExtract("third-key", nil)
require.Nil(t, err)
assert.Equal(t, "jennifer", p.Username)
_, err = c.ValidateAndExtract("", nil)
require.NotNil(t, err)
_, err = c.ValidateAndExtract("other-key", nil)
require.NotNil(t, err)
},
},
{
// this is invalid, the keys cannot be mapped to the users
name: "2 users, 3 keys",
config: config.APIKey{
Enabled: true,
AllowedKeys: []string{"secret-key", "another-secret-key", "third-key"},
Users: []string{"jane", "jessica"},
},
expectConfigErr: true,
expectConfigErrMsg: "length of users and keys must match, alternatively provide single user for all keys",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
c, err := New(config.Config{
Authentication: config.Authentication{
APIKey: test.config,
},
})
if test.expectConfigErr {
require.NotNil(t, err)
assert.Contains(t, err.Error(), test.expectConfigErrMsg)
return
}
if test.validate != nil {
test.validate(t, c)
}
})
}
}
|