|
| 1 | +// Copyright 2015 Matthew Holt |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +package certmagic |
| 16 | + |
| 17 | +import ( |
| 18 | + "context" |
| 19 | + "os" |
| 20 | + "path" |
| 21 | + "strings" |
| 22 | + "sync" |
| 23 | + "time" |
| 24 | + |
| 25 | + "golang.org/x/sync/semaphore" |
| 26 | +) |
| 27 | + |
| 28 | +type storageEntry struct { |
| 29 | + i KeyInfo |
| 30 | + d []byte |
| 31 | +} |
| 32 | + |
| 33 | +// memoryStorage is a Storage implemention that exists only in memory |
| 34 | +// it is intended for testing and one-time-deploys where no persistence is needed |
| 35 | +type memoryStorage struct { |
| 36 | + m map[string]storageEntry |
| 37 | + mu sync.RWMutex |
| 38 | + |
| 39 | + kmu *keyMutex |
| 40 | +} |
| 41 | + |
| 42 | +func NewMemoryStorage() Storage { |
| 43 | + return &memoryStorage{ |
| 44 | + m: map[string]storageEntry{}, |
| 45 | + kmu: newKeyMutex(), |
| 46 | + } |
| 47 | +} |
| 48 | + |
| 49 | +// Exists returns true if key exists in s. |
| 50 | +func (s *memoryStorage) Exists(ctx context.Context, key string) bool { |
| 51 | + ans, err := s.List(ctx, key, true) |
| 52 | + if err != nil { |
| 53 | + return false |
| 54 | + } |
| 55 | + return len(ans) != 0 |
| 56 | +} |
| 57 | + |
| 58 | +// Store saves value at key. |
| 59 | +func (s *memoryStorage) Store(_ context.Context, key string, value []byte) error { |
| 60 | + s.m[key] = storageEntry{ |
| 61 | + i: KeyInfo{ |
| 62 | + Key: key, |
| 63 | + Modified: time.Now(), |
| 64 | + Size: int64(len(value)), |
| 65 | + IsTerminal: true, |
| 66 | + }, |
| 67 | + d: value, |
| 68 | + } |
| 69 | + return nil |
| 70 | +} |
| 71 | + |
| 72 | +// Load retrieves the value at key. |
| 73 | +func (s *memoryStorage) Load(_ context.Context, key string) ([]byte, error) { |
| 74 | + val, ok := s.m[key] |
| 75 | + if !ok { |
| 76 | + return nil, os.ErrNotExist |
| 77 | + } |
| 78 | + return val.d, nil |
| 79 | +} |
| 80 | + |
| 81 | +// Delete deletes the value at key. |
| 82 | +func (s *memoryStorage) Delete(_ context.Context, key string) error { |
| 83 | + delete(s.m, key) |
| 84 | + return nil |
| 85 | +} |
| 86 | + |
| 87 | +// List returns all keys that match prefix. |
| 88 | +func (s *memoryStorage) List(ctx context.Context, prefix string, recursive bool) ([]string, error) { |
| 89 | + var keyList []string |
| 90 | + |
| 91 | + keys := make([]string, 0, len(s.m)) |
| 92 | + for k := range s.m { |
| 93 | + if strings.HasPrefix(k, prefix) { |
| 94 | + keys = append(keys, k) |
| 95 | + } |
| 96 | + } |
| 97 | + // adapted from https://github.com/pberkel/caddy-storage-redis/blob/main/storage.go#L369 |
| 98 | + // Iterate over each child key |
| 99 | + for _, k := range keys { |
| 100 | + // Directory keys will have a "/" suffix |
| 101 | + trimmedKey := strings.TrimSuffix(k, "/") |
| 102 | + // Reconstruct the full path of child key |
| 103 | + fullPathKey := path.Join(prefix, trimmedKey) |
| 104 | + // If current key is a directory |
| 105 | + if recursive && k != trimmedKey { |
| 106 | + // Recursively traverse all child directories |
| 107 | + childKeys, err := s.List(ctx, fullPathKey, recursive) |
| 108 | + if err != nil { |
| 109 | + return keyList, err |
| 110 | + } |
| 111 | + keyList = append(keyList, childKeys...) |
| 112 | + } else { |
| 113 | + keyList = append(keyList, fullPathKey) |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + return keys, nil |
| 118 | +} |
| 119 | + |
| 120 | +// Stat returns information about key. |
| 121 | +func (s *memoryStorage) Stat(_ context.Context, key string) (KeyInfo, error) { |
| 122 | + val, ok := s.m[key] |
| 123 | + if !ok { |
| 124 | + return KeyInfo{}, os.ErrNotExist |
| 125 | + } |
| 126 | + return val.i, nil |
| 127 | +} |
| 128 | + |
| 129 | +// Lock obtains a lock named by the given name. It blocks |
| 130 | +// until the lock can be obtained or an error is returned. |
| 131 | +func (s *memoryStorage) Lock(ctx context.Context, name string) error { |
| 132 | + return s.kmu.LockKey(ctx, name) |
| 133 | +} |
| 134 | + |
| 135 | +// Unlock releases the lock for name. |
| 136 | +func (s *memoryStorage) Unlock(_ context.Context, name string) error { |
| 137 | + return s.kmu.UnlockKey(name) |
| 138 | +} |
| 139 | + |
| 140 | +func (s *memoryStorage) String() string { |
| 141 | + return "memoryStorage" |
| 142 | +} |
| 143 | + |
| 144 | +// Interface guard |
| 145 | +var _ Storage = (*memoryStorage)(nil) |
| 146 | + |
| 147 | +type keyMutex struct { |
| 148 | + m map[string]*semaphore.Weighted |
| 149 | + mu sync.Mutex |
| 150 | +} |
| 151 | + |
| 152 | +func newKeyMutex() *keyMutex { |
| 153 | + return &keyMutex{ |
| 154 | + m: map[string]*semaphore.Weighted{}, |
| 155 | + } |
| 156 | +} |
| 157 | + |
| 158 | +func (km *keyMutex) LockKey(ctx context.Context, id string) error { |
| 159 | + select { |
| 160 | + case <-ctx.Done(): |
| 161 | + // as a special case, caddy allows for the cancelled context to be used for a trylock. |
| 162 | + if km.mutex(id).TryAcquire(1) { |
| 163 | + return nil |
| 164 | + } |
| 165 | + return ctx.Err() |
| 166 | + default: |
| 167 | + return km.mutex(id).Acquire(ctx, 1) |
| 168 | + } |
| 169 | +} |
| 170 | + |
| 171 | +// Releases the lock associated with the specified ID. |
| 172 | +func (km *keyMutex) UnlockKey(id string) error { |
| 173 | + km.mutex(id).Release(1) |
| 174 | + return nil |
| 175 | +} |
| 176 | + |
| 177 | +func (km *keyMutex) mutex(id string) *semaphore.Weighted { |
| 178 | + km.mu.Lock() |
| 179 | + defer km.mu.Unlock() |
| 180 | + val, ok := km.m[id] |
| 181 | + if !ok { |
| 182 | + val = semaphore.NewWeighted(1) |
| 183 | + km.m[id] = val |
| 184 | + } |
| 185 | + return val |
| 186 | +} |
0 commit comments