This repository has been archived by the owner on May 13, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 346
/
permissions.go
262 lines (236 loc) · 7.13 KB
/
permissions.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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
package native
import (
"fmt"
"github.com/hyperledger/burrow/execution/engine"
"github.com/hyperledger/burrow/acm"
"github.com/hyperledger/burrow/crypto"
"github.com/hyperledger/burrow/permission"
)
var Permissions = New().MustContract("Permissions",
`* Interface for managing Secure Native authorizations.
* @dev This interface describes the functions exposed by the native permissions layer in burrow.
`,
Function{
Comment: `
* @notice Adds a role to an account
* @param _account account address
* @param _role role name
* @return _result whether role was added
`,
PermFlag: permission.AddRole,
F: addRole,
},
Function{
Comment: `
* @notice Removes a role from an account
* @param _account account address
* @param _role role name
* @return _result whether role was removed
`,
PermFlag: permission.RemoveRole,
F: removeRole,
},
Function{
Comment: `
* @notice Indicates whether an account has a role
* @param _account account address
* @param _role role name
* @return _result whether account has role
`,
PermFlag: permission.HasRole,
F: hasRole,
},
Function{
Comment: `
* @notice Sets the permission flags for an account. Makes them explicitly set (on or off).
* @param _account account address
* @param _permission the base permissions flags to set for the account
* @param _set whether to set or unset the permissions flags at the account level
* @return _result is the permission flag that was set as uint64
`,
PermFlag: permission.SetBase,
F: setBase,
},
Function{
Comment: `
* @notice Unsets the permissions flags for an account. Causes permissions being unset to fall through to global permissions.
* @param _account account address
* @param _permission the permissions flags to unset for the account
* @return _result is the permission flag that was unset as uint64
`,
PermFlag: permission.UnsetBase,
F: unsetBase,
},
Function{
Comment: `
* @notice Indicates whether an account has a subset of permissions set
* @param _account account address
* @param _permission the permissions flags (mask) to check whether enabled against base permissions for the account
* @return _result is whether account has the passed permissions flags set
`,
PermFlag: permission.HasBase,
F: hasBase,
},
Function{Comment: `
* @notice Sets the global (default) permissions flags for the entire chain
* @param _permission the permissions flags to set
* @param _set whether to set (or unset) the permissions flags
* @return _result is the permission flag that was set as uint64
`,
PermFlag: permission.SetGlobal,
F: setGlobal,
},
)
type hasBaseArgs struct {
Account crypto.Address
Permission uint64
}
type hasBaseRets struct {
Result bool
}
func hasBase(ctx Context, args hasBaseArgs) (hasBaseRets, error) {
permN := permission.PermFlag(args.Permission) // already shifted
if !permN.IsValid() {
return hasBaseRets{}, permission.ErrInvalidPermission(permN)
}
hasPermission, err := engine.HasPermission(ctx.State, args.Account, permN)
if err != nil {
return hasBaseRets{}, err
}
ctx.Logger.Trace.Log("function", "hasBase",
"address", args.Account.String(),
"perm_flag", fmt.Sprintf("%b", permN),
"has_permission", hasPermission)
return hasBaseRets{Result: hasPermission}, nil
}
type setBaseArgs struct {
Account crypto.Address
Permission uint64
Set bool
}
type setBaseRets struct {
Result uint64
}
func setBase(ctx Context, args setBaseArgs) (setBaseRets, error) {
permFlag := permission.PermFlag(args.Permission)
if !permFlag.IsValid() {
return setBaseRets{}, permission.ErrInvalidPermission(permFlag)
}
err := engine.UpdateAccount(ctx.State, args.Account, func(acc *acm.Account) error {
err := acc.Permissions.Base.Set(permFlag, args.Set)
return err
})
if err != nil {
return setBaseRets{}, err
}
ctx.Logger.Trace.Log("function", "setBase", "address", args.Account.String(),
"permission_flag", fmt.Sprintf("%b", permFlag),
"permission_value", args.Permission)
return setBaseRets{Result: uint64(permFlag)}, nil
}
type unsetBaseArgs struct {
Account crypto.Address
Permission uint64
}
type unsetBaseRets struct {
Result uint64
}
func unsetBase(ctx Context, args unsetBaseArgs) (unsetBaseRets, error) {
permFlag := permission.PermFlag(args.Permission)
if !permFlag.IsValid() {
return unsetBaseRets{}, permission.ErrInvalidPermission(permFlag)
}
err := engine.UpdateAccount(ctx.State, args.Account, func(acc *acm.Account) error {
return acc.Permissions.Base.Unset(permFlag)
})
if err != nil {
return unsetBaseRets{}, err
}
ctx.Logger.Trace.Log("function", "unsetBase", "address", args.Account.String(),
"perm_flag", fmt.Sprintf("%b", permFlag),
"permission_flag", fmt.Sprintf("%b", permFlag))
return unsetBaseRets{Result: uint64(permFlag)}, nil
}
type setGlobalArgs struct {
Permission uint64
Set bool
}
type setGlobalRets struct {
Result uint64
}
func setGlobal(ctx Context, args setGlobalArgs) (setGlobalRets, error) {
permFlag := permission.PermFlag(args.Permission)
if !permFlag.IsValid() {
return setGlobalRets{}, permission.ErrInvalidPermission(permFlag)
}
err := engine.UpdateAccount(ctx.State, acm.GlobalPermissionsAddress, func(acc *acm.Account) error {
return acc.Permissions.Base.Set(permFlag, args.Set)
})
if err != nil {
return setGlobalRets{}, err
}
ctx.Logger.Trace.Log("function", "setGlobal",
"permission_flag", fmt.Sprintf("%b", permFlag),
"permission_value", args.Set)
return setGlobalRets{Result: uint64(permFlag)}, nil
}
type hasRoleArgs struct {
Account crypto.Address
Role string
}
type hasRoleRets struct {
Result bool
}
func hasRole(ctx Context, args hasRoleArgs) (hasRoleRets, error) {
acc, err := engine.MustAccount(ctx.State, args.Account)
if err != nil {
return hasRoleRets{}, err
}
hasRole := acc.Permissions.HasRole(args.Role)
ctx.Logger.Trace.Log("function", "hasRole", "address", args.Account.String(),
"role", args.Role,
"has_role", hasRole)
return hasRoleRets{Result: hasRole}, nil
}
type addRoleArgs struct {
Account crypto.Address
Role string
}
type addRoleRets struct {
Result bool
}
func addRole(ctx Context, args addRoleArgs) (addRoleRets, error) {
ret := addRoleRets{}
err := engine.UpdateAccount(ctx.State, args.Account, func(account *acm.Account) error {
ret.Result = account.Permissions.AddRole(args.Role)
return nil
})
if err != nil {
return ret, err
}
ctx.Logger.Trace.Log("function", "addRole", "address", args.Account.String(),
"role", args.Role,
"role_added", ret.Result)
return ret, nil
}
type removeRoleArgs struct {
Account crypto.Address
Role string
}
type removeRoleRets struct {
Result bool
}
func removeRole(ctx Context, args removeRoleArgs) (removeRoleRets, error) {
ret := removeRoleRets{}
err := engine.UpdateAccount(ctx.State, args.Account, func(account *acm.Account) error {
ret.Result = account.Permissions.RemoveRole(args.Role)
return nil
})
if err != nil {
return ret, err
}
ctx.Logger.Trace.Log("function", "removeRole", "address", args.Account.String(),
"role", args.Role,
"role_removed", ret.Result)
return ret, nil
}