Skip to content

Commit

Permalink
fix: Support unsafeSsl and enable ssl verification as default (kedaco…
Browse files Browse the repository at this point in the history 
…re#4006)

Signed-off-by: Jorge Turrado <jorge_turrado@hotmail.es>

Signed-off-by: Jorge Turrado <jorge_turrado@hotmail.es>
Signed-off-by: Jorge Turrado Ferrero <Jorge_turrado@hotmail.es>
  • Loading branch information
@JorTurFer
JorTurFer committed Jan 18, 2023
1 parent fde94f9 commit 3414fe5
Show file tree
Hide file tree
Showing 5 changed files with 240 additions and 31 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To learn more about our roadmap, we recommend reading [this document](ROADMAP.md

### Fixes

- TODO ([#XXX](https://github.com/kedacore/keda/issue/XXX))
- **Redis Scalers**: Support `unsafeSsl` and enable ssl verification as default ([#4005](https://github.com/kedacore/keda/issues/4005))

### Deprecations

Expand Down
53 changes: 23 additions & 30 deletions pkg/scalers/redis_scaler.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ type redisConnectionInfo struct {
hosts []string
ports []string
enableTLS bool
unsafeSsl bool
}

type redisMetadata struct {
Expand Down Expand Up @@ -95,6 +96,7 @@ func NewRedisScaler(ctx context.Context, isClustered, isSentinel bool, config *S
if err != nil {
return nil, fmt.Errorf("error parsing redis metadata: %s", err)
}

return createRedisScaler(ctx, meta, luaScript, metricType, logger)
}

Expand Down Expand Up @@ -183,6 +185,24 @@ func parseRedisMetadata(config *ScalerConfig, parserFn redisAddressParser) (*red
connectionInfo: connInfo,
}

meta.connectionInfo.enableTLS = defaultEnableTLS
if val, ok := config.TriggerMetadata["enableTLS"]; ok {
tls, err := strconv.ParseBool(val)
if err != nil {
return nil, fmt.Errorf("enableTLS parsing error %s", err.Error())
}
meta.connectionInfo.enableTLS = tls
}

meta.connectionInfo.unsafeSsl = false
if val, ok := config.TriggerMetadata["unsafeSsl"]; ok {
parsedVal, err := strconv.ParseBool(val)
if err != nil {
return nil, fmt.Errorf("error parsing unsafeSsl: %s", err)
}
meta.connectionInfo.unsafeSsl = parsedVal
}

meta.listLength = defaultListLength
if val, ok := config.TriggerMetadata["listLength"]; ok {
listLength, err := strconv.ParseInt(val, 10, 64)
Expand Down Expand Up @@ -316,15 +336,6 @@ func parseRedisAddress(metadata, resolvedEnv, authParams map[string]string) (red
info.password = resolvedEnv[metadata["passwordFromEnv"]]
}

info.enableTLS = defaultEnableTLS
if val, ok := metadata["enableTLS"]; ok {
tls, err := strconv.ParseBool(val)
if err != nil {
return info, fmt.Errorf("enableTLS parsing error %s", err.Error())
}
info.enableTLS = tls
}

return info, nil
}

Expand Down Expand Up @@ -394,15 +405,6 @@ func parseRedisClusterAddress(metadata, resolvedEnv, authParams map[string]strin
info.password = resolvedEnv[metadata["passwordFromEnv"]]
}

info.enableTLS = defaultEnableTLS
if val, ok := metadata["enableTLS"]; ok {
tls, err := strconv.ParseBool(val)
if err != nil {
return info, fmt.Errorf("enableTLS parsing error %s", err.Error())
}
info.enableTLS = tls
}

return info, nil
}

Expand Down Expand Up @@ -451,15 +453,6 @@ func parseRedisSentinelAddress(metadata, resolvedEnv, authParams map[string]stri
info.sentinelMaster = resolvedEnv[metadata["sentinelMasterFromEnv"]]
}

info.enableTLS = defaultEnableTLS
if val, ok := metadata["enableTLS"]; ok {
tls, err := strconv.ParseBool(val)
if err != nil {
return info, fmt.Errorf("enableTLS parsing error %s", err.Error())
}
info.enableTLS = tls
}

return info, nil
}

Expand All @@ -471,7 +464,7 @@ func getRedisClusterClient(ctx context.Context, info redisConnectionInfo) (*redi
}
if info.enableTLS {
options.TLSConfig = &tls.Config{
InsecureSkipVerify: info.enableTLS,
InsecureSkipVerify: info.unsafeSsl,
}
}

Expand All @@ -495,7 +488,7 @@ func getRedisSentinelClient(ctx context.Context, info redisConnectionInfo, dbInd
}
if info.enableTLS {
options.TLSConfig = &tls.Config{
InsecureSkipVerify: info.enableTLS,
InsecureSkipVerify: info.unsafeSsl,
}
}

Expand All @@ -516,7 +509,7 @@ func getRedisClient(ctx context.Context, info redisConnectionInfo, dbIndex int)
}
if info.enableTLS {
options.TLSConfig = &tls.Config{
InsecureSkipVerify: info.enableTLS,
InsecureSkipVerify: info.unsafeSsl,
}
}

Expand Down
82 changes: 82 additions & 0 deletions pkg/scalers/redis_scaler_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,47 @@ func TestParseRedisClusterMetadata(t *testing.T) {
},
wantErr: nil,
},
{
name: "tls enabled without setting unsafeSsl",
metadata: map[string]string{
"listName": "mylist",
"enableTLS": "true",
},
authParams: map[string]string{
"addresses": ":7001, :7002",
},
wantMeta: &redisMetadata{
listLength: 5,
listName: "mylist",
connectionInfo: redisConnectionInfo{
addresses: []string{":7001", ":7002"},
enableTLS: true,
unsafeSsl: false,
},
},
wantErr: nil,
},
{
name: "tls enabled with unsafeSsl true",
metadata: map[string]string{
"listName": "mylist",
"enableTLS": "true",
"unsafeSsl": "true",
},
authParams: map[string]string{
"addresses": ":7001, :7002",
},
wantMeta: &redisMetadata{
listLength: 5,
listName: "mylist",
connectionInfo: redisConnectionInfo{
addresses: []string{":7001", ":7002"},
enableTLS: true,
unsafeSsl: true,
},
},
wantErr: nil,
},
}

for _, testCase := range cases {
Expand Down Expand Up @@ -697,6 +738,47 @@ func TestParseRedisSentinelMetadata(t *testing.T) {
},
wantErr: nil,
},
{
name: "tls enabled without setting unsafeSsl",
metadata: map[string]string{
"listName": "mylist",
"enableTLS": "true",
},
authParams: map[string]string{
"addresses": ":7001, :7002",
},
wantMeta: &redisMetadata{
listLength: 5,
listName: "mylist",
connectionInfo: redisConnectionInfo{
addresses: []string{":7001", ":7002"},
enableTLS: true,
unsafeSsl: false,
},
},
wantErr: nil,
},
{
name: "tls enabled with unsafeSsl true",
metadata: map[string]string{
"listName": "mylist",
"enableTLS": "true",
"unsafeSsl": "true",
},
authParams: map[string]string{
"addresses": ":7001, :7002",
},
wantMeta: &redisMetadata{
listLength: 5,
listName: "mylist",
connectionInfo: redisConnectionInfo{
addresses: []string{":7001", ":7002"},
enableTLS: true,
unsafeSsl: true,
},
},
wantErr: nil,
},
}

for _, testCase := range cases {
Expand Down
20 changes: 20 additions & 0 deletions pkg/scalers/redis_streams_scaler.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,25 @@ func parseRedisStreamsMetadata(config *ScalerConfig, parseFn redisAddressParser)
meta := redisStreamsMetadata{
connectionInfo: connInfo,
}

meta.connectionInfo.enableTLS = defaultEnableTLS
if val, ok := config.TriggerMetadata["enableTLS"]; ok {
tls, err := strconv.ParseBool(val)
if err != nil {
return nil, fmt.Errorf("enableTLS parsing error %s", err.Error())
}
meta.connectionInfo.enableTLS = tls
}

meta.connectionInfo.unsafeSsl = false
if val, ok := config.TriggerMetadata["unsafeSsl"]; ok {
parsedVal, err := strconv.ParseBool(val)
if err != nil {
return nil, fmt.Errorf("error parsing unsafeSsl: %s", err)
}
meta.connectionInfo.unsafeSsl = parsedVal
}

meta.targetPendingEntriesCount = defaultTargetPendingEntriesCount

if val, ok := config.TriggerMetadata[pendingEntriesCountMetadata]; ok {
Expand Down Expand Up @@ -190,6 +209,7 @@ func parseRedisStreamsMetadata(config *ScalerConfig, parseFn redisAddressParser)
}
meta.databaseIndex = int(dbIndex)
}

meta.scalerIndex = config.ScalerIndex
return &meta, nil
}
Expand Down
114 changes: 114 additions & 0 deletions pkg/scalers/redis_streams_scaler_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,63 @@ func TestParseRedisClusterStreamsMetadata(t *testing.T) {
},
wantErr: nil,
},
{
name: "tls enabled without setting unsafeSsl",
metadata: map[string]string{
"hosts": "a, b, c",
"ports": "1, 2, 3",
"stream": "my-stream",
"pendingEntriesCount": "10",
"consumerGroup": "consumer1",
"enableTLS": "true",
},
authParams: map[string]string{
"password": "password",
},
wantMeta: &redisStreamsMetadata{
streamName: "my-stream",
targetPendingEntriesCount: 10,
consumerGroupName: "consumer1",
connectionInfo: redisConnectionInfo{
addresses: []string{"a:1", "b:2", "c:3"},
hosts: []string{"a", "b", "c"},
ports: []string{"1", "2", "3"},
password: "password",
enableTLS: true,
unsafeSsl: false,
},
},
wantErr: nil,
},
{
name: "tls enabled with unsafeSsl true",
metadata: map[string]string{
"hosts": "a, b, c",
"ports": "1, 2, 3",
"stream": "my-stream",
"pendingEntriesCount": "10",
"consumerGroup": "consumer1",
"enableTLS": "true",
"unsafeSsl": "true",
},
authParams: map[string]string{
"password": "password",
},
wantMeta: &redisStreamsMetadata{
streamName: "my-stream",
targetPendingEntriesCount: 10,
consumerGroupName: "consumer1",
connectionInfo: redisConnectionInfo{
addresses: []string{"a:1", "b:2", "c:3"},
hosts: []string{"a", "b", "c"},
ports: []string{"1", "2", "3"},
password: "password",
enableTLS: true,
unsafeSsl: true,
},
},
wantErr: nil,
},
}

for _, testCase := range cases {
Expand Down Expand Up @@ -815,6 +872,63 @@ func TestParseRedisSentinelStreamsMetadata(t *testing.T) {
},
wantErr: nil,
},
{
name: "tls enabled without setting unsafeSsl",
metadata: map[string]string{
"hosts": "a, b, c",
"ports": "1, 2, 3",
"stream": "my-stream",
"pendingEntriesCount": "10",
"consumerGroup": "consumer1",
"enableTLS": "true",
},
authParams: map[string]string{
"password": "password",
},
wantMeta: &redisStreamsMetadata{
streamName: "my-stream",
targetPendingEntriesCount: 10,
consumerGroupName: "consumer1",
connectionInfo: redisConnectionInfo{
addresses: []string{"a:1", "b:2", "c:3"},
hosts: []string{"a", "b", "c"},
ports: []string{"1", "2", "3"},
password: "password",
enableTLS: true,
unsafeSsl: false,
},
},
wantErr: nil,
},
{
name: "tls enabled with unsafeSsl true",
metadata: map[string]string{
"hosts": "a, b, c",
"ports": "1, 2, 3",
"stream": "my-stream",
"pendingEntriesCount": "10",
"consumerGroup": "consumer1",
"enableTLS": "true",
"unsafeSsl": "true",
},
authParams: map[string]string{
"password": "password",
},
wantMeta: &redisStreamsMetadata{
streamName: "my-stream",
targetPendingEntriesCount: 10,
consumerGroupName: "consumer1",
connectionInfo: redisConnectionInfo{
addresses: []string{"a:1", "b:2", "c:3"},
hosts: []string{"a", "b", "c"},
ports: []string{"1", "2", "3"},
password: "password",
enableTLS: true,
unsafeSsl: true,
},
},
wantErr: nil,
},
}

for _, testCase := range cases {
Expand Down

0 comments on commit 3414fe5

Please sign in to comment.