forked from etcd-io/etcd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
etcdctl/ctlv3: auth: wildcard terminated paths specify ranges.
Implement wildcard '*' for get and del. When '*' is the last symbol in a key, the key is converted to a prefix range. The wildcard may only appear as the last symbol in a key. Also: fix several fencepost bugs fixed in the range sorting/merge code, including one incorrect test in auth/range_perm_cache_test.go Fixes etcd-io#6359
- Loading branch information
Showing
6 changed files
with
252 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package etcdserverpb | ||
|
|
||
| // See github.com/coreos/etcd/wildcard/wildcard.go | ||
| // for the definition of the BegEndRange interface. | ||
| // The methods allow a uniform treatment of ranges. | ||
|
|
||
| // GetBeg implements part of the BegEndRange interface. | ||
| func (r *RangeRequest) GetBeg() []byte { | ||
| return r.Key | ||
| } | ||
|
|
||
| // SetBeg implements part of the BegEndRange interface. | ||
| func (r *RangeRequest) SetBeg(beg []byte) { | ||
| r.Key = beg | ||
| } | ||
|
|
||
| // GetEnd implements part of the BegEndRange interface. | ||
| func (r *RangeRequest) GetEnd() []byte { | ||
| return r.RangeEnd | ||
| } | ||
|
|
||
| // SetEnd implements part of the BegEndRange interface. | ||
| func (r *RangeRequest) SetEnd(end []byte) { | ||
| r.RangeEnd = end | ||
| } | ||
|
|
||
| // GetBeg implements part of the BegEndRange interface. | ||
| func (r *DeleteRangeRequest) GetBeg() []byte { | ||
| return r.Key | ||
| } | ||
|
|
||
| // SetBeg implements part of the BegEndRange interface. | ||
| func (r *DeleteRangeRequest) SetBeg(beg []byte) { | ||
| r.Key = beg | ||
| } | ||
|
|
||
| // GetEnd implements part of the BegEndRange interface. | ||
| func (r *DeleteRangeRequest) GetEnd() []byte { | ||
| return r.RangeEnd | ||
| } | ||
|
|
||
| // SetEnd implements part of the BegEndRange interface. | ||
| func (r *DeleteRangeRequest) SetEnd(end []byte) { | ||
| r.RangeEnd = end | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| // Copyright 2016 The etcd 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 integration | ||
|
|
||
| import ( | ||
| "golang.org/x/net/context" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestWildcardPathQueries(t *testing.T) { | ||
| clus := NewClusterV3(t, &ClusterConfig{Size: 1}) | ||
| defer clus.Terminate(t) | ||
|
|
||
| cli := clus.RandClient() | ||
| if _, err := cli.Put(context.TODO(), "/home/joe/car", "margaret"); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if _, err := cli.Put(context.TODO(), "/home/joe/boat", "felicity"); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| fetched, err := cli.Get(context.TODO(), "/home/joe/*") | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if fetched.Count != 2 { | ||
| t.Fatalf("expected 2, got %v", fetched.Count) | ||
| } | ||
|
|
||
| // escaped stars do nothing | ||
| esc, err := cli.Delete(context.TODO(), `/home/joe/\*`) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if esc.Deleted != 0 { | ||
| t.Fatalf("expected 0, got %v", esc.Deleted) | ||
| } | ||
|
|
||
| del, err := cli.Delete(context.TODO(), `/home/joe/*`) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if del.Deleted != 2 { | ||
| t.Fatalf("expected 2, got %v", del.Deleted) | ||
| } | ||
|
|
||
| // read back a key that ends in star | ||
| if _, err = cli.Put(context.TODO(), "abc*", "felicity"); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| get, err := cli.Get(context.TODO(), `abc\*`) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if get.Count != 1 { | ||
| t.Fatalf("expected 1, got %v", get.Count) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| // Copyright 2016 The etcd 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. | ||
|
|
||
| /* | ||
| The wildcard package provides support for converting | ||
| single keys ending in the '*' star wildcard character into | ||
| prefix ranges. Backslash escaped '\*' stars are ignored. | ||
| */ | ||
| package wildcard | ||
|
|
||
| // ExpandWildcardToRange enables get '*' to return all | ||
| // keys within the range specified by a prefix. | ||
| // | ||
| // Example: get '/home/user/*' will return all keys with | ||
| // the prefix '/home/user/'. | ||
| // | ||
| // Returns true if conversion/expansion took place. | ||
| // | ||
| // If removeWild is true, then we will remove the wildcard byte | ||
| // before creating the range. | ||
| // Backslash escaped (e.g. `\*`) wildcards will not be changed. | ||
| // | ||
| func ExpandWildcardToRange(r BegEndRange, removeWild bool) bool { | ||
| beg := r.GetBeg() | ||
| end := r.GetEnd() | ||
| lenkey := len(beg) | ||
| lenend := len(end) | ||
| if lenkey == 0 || lenend > 0 { | ||
| return false | ||
| } | ||
| if beg[lenkey-1] != '*' { | ||
| return false | ||
| } | ||
| if lenkey == 1 { | ||
| // request for all keys | ||
| beg = []byte{0} | ||
| end = []byte{0} | ||
| r.SetBeg(beg) | ||
| r.SetEnd(end) | ||
| return true | ||
| } | ||
| if beg[lenkey-2] == '\\' { | ||
| // the star was escaped with a backslash: \* | ||
| beg = beg[:lenkey-1] | ||
| beg[lenkey-2] = '*' | ||
| r.SetBeg(beg) | ||
| return false | ||
| } | ||
|
|
||
| // we have a wildcard query, with keylen >= 2. | ||
| // Fix the begin and end: | ||
| if removeWild { | ||
| beg = beg[:lenkey-1] // remove the '*' | ||
| } | ||
| // setting RangeEnd one bit higher makes a prefix query | ||
| end = make([]byte, lenkey-1) | ||
| copy(end, beg) | ||
| end[lenkey-2]++ | ||
| // check for overflow | ||
| if end[lenkey-2] == 0 { | ||
| // yep, overflowed. | ||
| end = append(end, 1) | ||
| } | ||
| r.SetBeg(beg) | ||
| r.SetEnd(end) | ||
| return true | ||
| } | ||
|
|
||
| // BegEndRange unifies rangePerm, pb.RangeRequest, | ||
| // and pb.DeleteRangeRequest | ||
| type BegEndRange interface { | ||
| GetBeg() []byte | ||
| SetBeg(beg []byte) | ||
|
|
||
| GetEnd() []byte | ||
| SetEnd(end []byte) | ||
| } |