mirror of https://github.com/k3s-io/k3s
65 lines
1.9 KiB
Go
65 lines
1.9 KiB
Go
/*
|
|
Copyright 2017 The Kubernetes 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 store
|
|
|
|
import (
|
|
"fmt"
|
|
"regexp"
|
|
)
|
|
|
|
const (
|
|
keyMaxLength = 250
|
|
|
|
keyCharFmt string = "[A-Za-z0-9]"
|
|
keyExtCharFmt string = "[-A-Za-z0-9_.]"
|
|
qualifiedKeyFmt string = "(" + keyCharFmt + keyExtCharFmt + "*)?" + keyCharFmt
|
|
)
|
|
|
|
var (
|
|
// Key must consist of alphanumeric characters, '-', '_' or '.', and must start
|
|
// and end with an alphanumeric character.
|
|
keyRegex = regexp.MustCompile("^" + qualifiedKeyFmt + "$")
|
|
|
|
// ErrKeyNotFound is the error returned if key is not found in Store.
|
|
ErrKeyNotFound = fmt.Errorf("key is not found")
|
|
)
|
|
|
|
// Store provides the interface for storing keyed data.
|
|
// Store must be thread-safe
|
|
type Store interface {
|
|
// key must contain one or more characters in [A-Za-z0-9]
|
|
// Write writes data with key.
|
|
Write(key string, data []byte) error
|
|
// Read retrieves data with key
|
|
// Read must return ErrKeyNotFound if key is not found.
|
|
Read(key string) ([]byte, error)
|
|
// Delete deletes data by key
|
|
// Delete must not return error if key does not exist
|
|
Delete(key string) error
|
|
// List lists all existing keys.
|
|
List() ([]string, error)
|
|
}
|
|
|
|
// ValidateKey returns an error if the given key does not meet the requirement
|
|
// of the key format and length.
|
|
func ValidateKey(key string) error {
|
|
if len(key) <= keyMaxLength && keyRegex.MatchString(key) {
|
|
return nil
|
|
}
|
|
return fmt.Errorf("invalid key: %q", key)
|
|
}
|