/* Copyright 2023 The Dapr Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package sqlserver import ( "encoding/json" "errors" "fmt" "time" sqlserverAuth "github.com/dapr/components-contrib/common/authentication/sqlserver" "github.com/dapr/kit/metadata" "github.com/dapr/kit/ptr" ) const ( keyColumnName = "Key" rowVersionColumnName = "RowVersion" defaultKeyLength = 200 defaultTable = "state" defaultMetaTable = "dapr_metadata" defaultCleanupInterval = time.Hour ) type sqlServerMetadata struct { sqlserverAuth.SQLServerAuthMetadata `mapstructure:",squash"` TableName string MetadataTableName string KeyType string KeyLength int IndexedProperties string CleanupInterval *time.Duration `mapstructure:"cleanupInterval" mapstructurealiases:"cleanupIntervalInSeconds"` // Internal properties keyTypeParsed KeyType keyLengthParsed int indexedPropertiesParsed []IndexedProperty } func newMetadata() sqlServerMetadata { return sqlServerMetadata{ TableName: defaultTable, KeyLength: defaultKeyLength, MetadataTableName: defaultMetaTable, CleanupInterval: ptr.Of(defaultCleanupInterval), } } func (m *sqlServerMetadata) Parse(meta map[string]string) error { // Reset first m.SQLServerAuthMetadata.Reset() // Decode the metadata err := metadata.DecodeMetadata(meta, &m) if err != nil { return err } // Validate and parse the auth metadata err = m.SQLServerAuthMetadata.Validate(meta) if err != nil { return err } // Validate and sanitize more values if !sqlserverAuth.IsValidSQLName(m.TableName) { return fmt.Errorf("invalid table name, accepted characters are (A-Z, a-z, 0-9, _)") } if !sqlserverAuth.IsValidSQLName(m.MetadataTableName) { return fmt.Errorf("invalid metadata table name, accepted characters are (A-Z, a-z, 0-9, _)") } err = m.setKeyType() if err != nil { return err } err = m.setIndexedProperties() if err != nil { return err } // Cleanup interval if m.CleanupInterval != nil { // Non-positive value from meta means disable auto cleanup. if *m.CleanupInterval <= 0 { val, _ := metadata.GetMetadataProperty(meta, "cleanupInterval", "cleanupIntervalInSeconds") if val == "" { // Unfortunately the mapstructure decoder decodes an empty string to 0, a missing key would be nil however m.CleanupInterval = ptr.Of(defaultCleanupInterval) } else { m.CleanupInterval = nil } } } return nil } // Validates and returns the key type. func (m *sqlServerMetadata) setKeyType() error { if m.KeyType != "" { kt, err := KeyTypeFromString(m.KeyType) if err != nil { return err } m.keyTypeParsed = kt } else { m.keyTypeParsed = StringKeyType } if m.keyTypeParsed != StringKeyType { return nil } if m.KeyLength <= 0 { return fmt.Errorf("invalid key length value of %d", m.KeyLength) } else { m.keyLengthParsed = m.KeyLength } return nil } // Sets the validated index properties. func (m *sqlServerMetadata) setIndexedProperties() error { if m.IndexedProperties == "" { return nil } var indexedProperties []IndexedProperty err := json.Unmarshal([]byte(m.IndexedProperties), &indexedProperties) if err != nil { return err } err = m.validateIndexedProperties(indexedProperties) if err != nil { return err } m.indexedPropertiesParsed = indexedProperties return nil } // Validates that all the mandator index properties are supplied and that the // values are valid. func (m *sqlServerMetadata) validateIndexedProperties(indexedProperties []IndexedProperty) error { for _, p := range indexedProperties { if p.ColumnName == "" { return errors.New("indexed property column cannot be empty") } if p.Property == "" { return errors.New("indexed property name cannot be empty") } if p.Type == "" { return errors.New("indexed property type cannot be empty") } if !sqlserverAuth.IsValidSQLName(p.ColumnName) { return fmt.Errorf("invalid indexed property column name, accepted characters are (A-Z, a-z, 0-9, _)") } if !isValidIndexedPropertyName(p.Property) { return fmt.Errorf("invalid indexed property name, accepted characters are (A-Z, a-z, 0-9, _, ., [, ])") } if !isValidIndexedPropertyType(p.Type) { return fmt.Errorf("invalid indexed property type, accepted characters are (A-Z, a-z, 0-9, _, (, ))") } } return nil } func isValidIndexedPropertyName(s string) bool { for _, c := range s { if !(sqlserverAuth.IsLetterOrNumber(c) || (c == '_') || (c == '.') || (c == '[') || (c == ']')) { return false } } return true } func isValidIndexedPropertyType(s string) bool { for _, c := range s { if !(sqlserverAuth.IsLetterOrNumber(c) || (c == '(') || (c == ')')) { return false } } return true }