-
Notifications
You must be signed in to change notification settings - Fork 44
/
grn.go
212 lines (192 loc) · 6.11 KB
/
grn.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
package types
import (
"regexp"
"strings"
sdk "github.com/cosmos/cosmos-sdk/types"
gnfderrors "github.com/bnb-chain/greenfield/types/errors"
"github.com/bnb-chain/greenfield/types/resource"
"github.com/bnb-chain/greenfield/types/s3util"
)
const (
BucketTypeAbbr = "b"
ObjectTypeAbbr = "o"
GroupTypeAbbr = "g"
)
var (
validGRNRegex = regexp.MustCompile("^grn:([bog]):([^:]*):([^:]*)$")
validGRNRegexNoWild = regexp.MustCompile("^grn:([bog]):([^:]*):([^:*]*)$")
)
// GRN define a standard ResourceName format, full name: GreenFieldResourceName
// valid format:
//
// bucket: "grn:b::bucketName"
// object: "grn:o::bucketName/objectName"
// group: "grn:g:ownerAddress:groupName"
//
// Notice: all the name support wildcards
type GRN struct {
resType resource.ResourceType
groupOwner sdk.AccAddress
name string // can be bucketName, bucketName/objectName, groupName
}
// NewBucketGRN use to generate a bucket resource with specify bucketName
// The bucketName support wildcards. E.g. samplebucket, sample*bucket, sample?bucket
func NewBucketGRN(bucketName string) *GRN {
return &GRN{resType: resource.RESOURCE_TYPE_BUCKET, name: bucketName}
}
func NewObjectGRN(bucketName, objectName string) *GRN {
name := strings.Join([]string{bucketName, objectName}, "/")
return &GRN{resType: resource.RESOURCE_TYPE_OBJECT, name: name}
}
func NewGroupGRN(owner sdk.AccAddress, groupName string) *GRN {
return &GRN{resType: resource.RESOURCE_TYPE_GROUP, groupOwner: owner, name: groupName}
}
func (r *GRN) String() string {
var res string
switch r.resType {
case resource.RESOURCE_TYPE_BUCKET:
res = strings.Join([]string{"grn", BucketTypeAbbr, "", r.name}, ":")
case resource.RESOURCE_TYPE_OBJECT:
res = strings.Join([]string{"grn", ObjectTypeAbbr, "", r.name}, ":")
case resource.RESOURCE_TYPE_GROUP:
res = strings.Join([]string{"grn", GroupTypeAbbr, r.groupOwner.String(), r.name}, ":")
default:
return ""
}
return strings.TrimSuffix(res, ":")
}
func (r *GRN) GetBucketName() (string, error) {
switch r.resType {
case resource.RESOURCE_TYPE_BUCKET:
return r.name, nil
case resource.RESOURCE_TYPE_OBJECT:
bucketName, _, err := r.parseBucketAndObjectName(r.name)
if err != nil {
return "", err
}
return bucketName, nil
default:
return "", gnfderrors.ErrGRNTypeMismatch.Wrap("Can not GetBucketName from a non bucket or object resource type")
}
}
func (r *GRN) MustGetBucketName() string {
bucketName, err := r.GetBucketName()
if err != nil {
panic(err)
}
return bucketName
}
func (r *GRN) GetBucketAndObjectName() (string, string, error) {
switch r.resType {
case resource.RESOURCE_TYPE_OBJECT:
bucketName, objectName, err := r.parseBucketAndObjectName(r.name)
if err != nil {
return "", "", err
}
return bucketName, objectName, nil
default:
return "", "", gnfderrors.ErrGRNTypeMismatch.Wrap(
"Can not GetBucketAndObjectName from a non-object resource type")
}
}
func (r *GRN) MustGetBucketAndObjectName() (string, string) {
bucketName, objectName, err := r.GetBucketAndObjectName()
if err != nil {
panic(err)
}
return bucketName, objectName
}
func (r *GRN) GetGroupOwnerAndAccount() (sdk.AccAddress, string, error) {
switch r.resType {
case resource.RESOURCE_TYPE_GROUP:
return r.groupOwner, r.name, nil
default:
return sdk.AccAddress{}, "", gnfderrors.ErrGRNTypeMismatch.Wrap(
"Can not GetGroupOwnerAndAccount from a non-group resource type")
}
}
func (r *GRN) MustGetGroupOwnerAndAccount() (sdk.AccAddress, string) {
account, groupName, err := r.GetGroupOwnerAndAccount()
if err != nil {
panic(err)
}
return account, groupName
}
func (r *GRN) ResourceType() resource.ResourceType {
return r.resType
}
func (r *GRN) ParseFromString(res string, wildcards bool) error {
var result [][]string
if wildcards {
result = validGRNRegex.FindAllStringSubmatch(res, 1)
} else {
result = validGRNRegexNoWild.FindAllStringSubmatch(res, 1)
}
if result == nil || len(result) != 1 || len(result[0]) != 4 {
return gnfderrors.ErrInvalidGRN.Wrapf("regex match error. Res: %s.", res)
}
var err error
abbr := result[0][1]
acc := result[0][2]
name := result[0][3]
if abbr == BucketTypeAbbr {
if acc != "" {
return gnfderrors.ErrInvalidGRN.Wrapf("Not allowed acc non-empty in bucket resource name")
}
r.resType = resource.RESOURCE_TYPE_BUCKET
r.name = name
if strings.Contains(name, "/") {
return gnfderrors.ErrInvalidGRN.Wrapf("Not allowed '/' in bucket resource name")
}
if !wildcards {
err = s3util.CheckValidBucketName(r.name)
if err != nil {
return gnfderrors.ErrInvalidGRN.Wrapf("invalid bucketName: %s, err: %s", r.name, err)
}
}
} else if abbr == ObjectTypeAbbr {
if acc != "" {
return gnfderrors.ErrInvalidGRN.Wrapf("Not allowed acc non-empty in bucket resource name")
}
r.resType = resource.RESOURCE_TYPE_OBJECT
r.name = name
_, _, err = r.parseBucketAndObjectName(r.name)
if err != nil {
return gnfderrors.ErrInvalidGRN.Wrapf("invalid name, err : %s", err)
}
} else if abbr == GroupTypeAbbr {
r.resType = resource.RESOURCE_TYPE_GROUP
r.groupOwner, err = sdk.AccAddressFromHexUnsafe(acc)
if err != nil {
return gnfderrors.ErrInvalidGRN.Wrapf("invalid group owner account, err : %s", err)
}
if !wildcards {
err = s3util.CheckValidGroupName(name)
if err != nil {
return gnfderrors.ErrInvalidGRN.Wrapf("invalid group name, err : %s", err)
}
}
r.name = name
}
return nil
}
func (r *GRN) parseBucketAndObjectName(name string) (string, string, error) {
nameArr := strings.Split(name, "/")
if len(nameArr) < 2 {
return "", "", gnfderrors.ErrInvalidGRN.Wrapf("expect bucketName/object, actual %s", r.name)
}
bucketName := nameArr[0]
objectName, found := strings.CutPrefix(name, bucketName+"/")
if !found {
return "", "", gnfderrors.ErrInvalidGRN.Wrapf("object name not found, grn: %s", name)
}
err := s3util.CheckValidBucketName(bucketName)
if err != nil {
return "", "", gnfderrors.ErrInvalidGRN.Wrapf("invalid bucketName, err: %s", err)
}
err = s3util.CheckValidObjectName(objectName)
if err != nil {
return "", "", gnfderrors.ErrInvalidGRN.Wrapf("invalid objectName, err: %s", err)
}
return bucketName, objectName, nil
}