-
Notifications
You must be signed in to change notification settings - Fork 32
/
primitive.go
370 lines (321 loc) · 10.6 KB
/
primitive.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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
// Package primitive contains definitions of the primitive types used
// in ag.
package primitive
import (
"time"
"github.com/arigatomachine/cli/base64"
"github.com/arigatomachine/cli/identity"
"github.com/arigatomachine/cli/pathexp"
)
// v1Schema embeds in other structs to indicate their schema version is 1.
type v1Schema struct{}
// Version returns the schema version of structs that embed this type.
func (v *v1Schema) Version() int {
return 1
}
// User is the body of a user object
type User struct {
v1Schema
Username string `json:"username"`
Name string `json:"name"`
Email string `json:"email"`
State string `json:"state"`
Password *UserPassword `json:"password"`
Master *UserMaster `json:"master"`
}
// UserMaster is the body.master object for a user
type UserMaster struct {
Value *base64.Value `json:"value"`
Alg string `json:"alg"`
}
// UserPassword is the body.password object for a user
type UserPassword struct {
Salt string `json:"salt"`
Value *base64.Value `json:"value"`
Alg string `json:"alg"`
}
// Type returns the enumerated byte representation of User.
func (u *User) Type() byte {
return byte(0x01)
}
// Signature is an immutable object, but not technically a payload. Its fields
// must be ordered properly so that ID generation is correct.
//
// If PublicKeyID is nil, the signature is self-signed.
type Signature struct {
Algorithm string `json:"alg"`
PublicKeyID *identity.ID `json:"public_key_id"`
Value *base64.Value `json:"value"`
}
// Immutable object payloads. Their fields must be lexicographically ordered by
// the json value, so we can correctly calculate the signature.
// PrivateKeyValue holds the encrypted value of the PrivateKey.
type PrivateKeyValue struct {
Algorithm string `json:"alg"`
Value *base64.Value `json:"value"`
}
// PrivateKey is the private portion of an asymetric key.
type PrivateKey struct {
v1Schema
Key PrivateKeyValue `json:"key"`
OrgID *identity.ID `json:"org_id"`
OwnerID *identity.ID `json:"owner_id"`
PNonce *base64.Value `json:"pnonce"`
PublicKeyID *identity.ID `json:"public_key_id"`
}
// Type returns the enumerated byte representation of PrivateKey.
func (pk *PrivateKey) Type() byte {
return byte(0x07)
}
// PublicKeyValue is the actual value of a PublicKey.
type PublicKeyValue struct {
Value *base64.Value `json:"value"`
}
// PublicKey is the public portion of an asymetric key.
type PublicKey struct {
v1Schema
Algorithm string `json:"alg"`
Created time.Time `json:"created_at"`
Expires time.Time `json:"expires_at"`
Key PublicKeyValue `json:"key"`
OrgID *identity.ID `json:"org_id"`
OwnerID *identity.ID `json:"owner_id"`
KeyType string `json:"type"`
}
// Type returns the enumerated byte representation of PublicKey.
func (pk *PublicKey) Type() byte {
return byte(0x06)
}
// Types of claims that can be made against public keys.
const (
SignatureClaimType = "signature"
RevocationClaimType = "revocation"
)
// Claim is a signature or revocation claim against a public key.
type Claim struct {
v1Schema
Created time.Time `json:"created_at"`
OrgID *identity.ID `json:"org_id"`
OwnerID *identity.ID `json:"owner_id"`
Previous *identity.ID `json:"previous"`
PublicKeyID *identity.ID `json:"public_key_id"`
KeyType string `json:"type"`
}
// Type returns the enumerated byte representation of Claim.
func (c *Claim) Type() byte {
return byte(0x08)
}
// NewClaim returns a new Claim, with the created time set to now
func NewClaim(orgID, ownerID, previous, pubKeyID *identity.ID,
keyType string) *Claim {
return &Claim{
OrgID: orgID,
OwnerID: ownerID,
Previous: previous,
PublicKeyID: pubKeyID,
KeyType: keyType,
Created: time.Now().UTC(),
}
}
// Credential is a secret value shared between a group of services based
// on users identity, operating environment, project, and organization
type Credential struct {
v1Schema
Credential *CredentialValue `json:"credential"`
KeyringID *identity.ID `json:"keyring_id"`
Name string `json:"name"`
Nonce *base64.Value `json:"nonce"`
OrgID *identity.ID `json:"org_id"`
PathExp *pathexp.PathExp `json:"pathexp"`
Previous *identity.ID `json:"previous"`
ProjectID *identity.ID `json:"project_id"`
CredentialVersion int `json:"version"`
}
// Type returns the enumerated byte representation of Credential
func (c *Credential) Type() byte {
return byte(0xb)
}
// CredentialValue is the secretbox encrypted value of the containing
// Credential.
type CredentialValue struct {
Algorithm string `json:"alg"`
Nonce *base64.Value `json:"nonce"`
Value *base64.Value `json:"value"`
}
// Keyring is a mechanism for sharing a shared secret between many different
// users and machines at a position in the credential path.
//
// Credentials belong to Keyrings
type Keyring struct {
v1Schema
Created time.Time `json:"created_at"`
OrgID *identity.ID `json:"org_id"`
PathExp *pathexp.PathExp `json:"pathexp"`
Previous *identity.ID `json:"previous"`
ProjectID *identity.ID `json:"project_id"`
KeyringVersion int `json:"version"`
}
// Type returns the enumerated byte representation of Keyring
func (k *Keyring) Type() byte {
return byte(0x09)
}
// KeyringMember is a record of sharing a master secret key with a user or
// machine.
//
// KeyringMember belongs to a Keyring
type KeyringMember struct {
v1Schema
Created time.Time `json:"created_at"`
EncryptingKeyID *identity.ID `json:"encrypting_key_id"`
Key *KeyringMemberKey `json:"key"`
KeyringID *identity.ID `json:"keyring_id"`
OrgID *identity.ID `json:"org_id"`
OwnerID *identity.ID `json:"owner_id"`
ProjectID *identity.ID `json:"project_id"`
PublicKeyID *identity.ID `json:"public_key_id"`
}
// Type returns the enumerated byte representation of KeyringMember
func (km *KeyringMember) Type() byte {
return byte(0x0a)
}
// KeyringMemberKey is the keyring master encryption key, encrypted for the
// owner of a KeyringMember
type KeyringMemberKey struct {
Algorithm string `json:"alg"`
Nonce *base64.Value `json:"nonce"`
Value *base64.Value `json:"value"`
}
// Org is a grouping of users that collaborate with each other
type Org struct {
v1Schema
Name string `json:"name"`
}
// Type returns the enumerated byte representation of Org
func (o *Org) Type() byte {
return byte(0xd)
}
// Org Invitations exist in four states: pending, associated,
// accepted, and approved.
const (
OrgInvitePendingState = "pending"
OrgInviteAssociatedState = "associated"
OrgInviteAcceptedState = "accepted"
OrgInviteApprovedState = "approved"
)
// OrgInvite is an invitation for an individual to join an organization
type OrgInvite struct {
v1Schema
OrgID *identity.ID `json:"org_id"`
Email string `json:"email"`
InviterID *identity.ID `json:"inviter_id"`
InviteeID *identity.ID `json:"invitee_id"`
ApproverID *identity.ID `json:"approver_id"`
State string `json:"state"`
Code *struct {
Alg string `json:"alg"`
Salt *base64.Value `json:"salt"`
Value *base64.Value `json:"value"`
} `json:"code"`
PendingTeams []identity.ID `json:"pending_teams"`
Created *time.Time `json:"created_at"`
Accepted *time.Time `json:"accepted_at"`
Approved *time.Time `json:"approved_at"`
}
// Type returns the numerated byte representation of OrgInvite
func (o *OrgInvite) Type() byte {
return byte(0x13)
}
// Project is an entity that represents a group of services
type Project struct {
v1Schema
Name string `json:"name"`
OrgID *identity.ID `json:"org_id"`
}
// Type returns the enumerated byte representation of Project
func (t *Project) Type() byte {
return byte(0x04)
}
// Policy is an entity that represents a group of statements for acl
type Policy struct {
v1Schema
PolicyType string `json:"type"`
Previous *identity.ID `json:"previous"`
OrgID *identity.ID `json:"org_id"`
Policy *struct {
Name string `json:"name"`
Description string `json:"description"`
Statements []PolicyStatement `json:"statements"`
} `json:"policy"`
}
// Type returns the enumerated byte representation of Policy
func (t *Policy) Type() byte {
return byte(0x11)
}
// PolicyStatement is an acl statement on a policy object
type PolicyStatement struct {
Effect string `json:"effect"`
Action []string `json:"action"` // XXX: This could potentially be a string and not []string
Resource string `json:"resource"`
}
// PolicyAttachment is an entity that represents the link between policies and teams
type PolicyAttachment struct {
v1Schema
OwnerID *identity.ID `json:"owner_id"`
PolicyID *identity.ID `json:"policy_id"`
OrgID *identity.ID `json:"org_id"`
}
// Type returns the enumerated byte representation of PolicyAttchment
func (t *PolicyAttachment) Type() byte {
return byte(0x12)
}
// Service is an entity that represents a group of processes
type Service struct {
v1Schema
Name string `json:"name"`
OrgID *identity.ID `json:"org_id"`
ProjectID *identity.ID `json:"project_id"`
}
// Type returns the enumerated byte representation of Service
func (t *Service) Type() byte {
return byte(0x03)
}
// Environment is an entity that represents a group of processes
type Environment struct {
v1Schema
Name string `json:"name"`
OrgID *identity.ID `json:"org_id"`
ProjectID *identity.ID `json:"project_id"`
}
// Type returns the enumerated byte representation of Environment
func (t *Environment) Type() byte {
return byte(0x05)
}
// There are two types of teams: system and user. System teams are
// managed by the Arigato registry.
const (
SystemTeam = "system"
UserTeam = "user"
)
// Team is an entity that represents a group of users
type Team struct {
v1Schema
Name string `json:"name"`
OrgID *identity.ID `json:"org_id"`
TeamType string `json:"type"`
}
// Type returns the enumerated byte representation of Team
func (t *Team) Type() byte {
return byte(0x0f)
}
// Membership is an entity that represents whether a user or
// machine is a part of a team in an organization.
type Membership struct {
v1Schema
OrgID *identity.ID `json:"org_id"`
OwnerID *identity.ID `json:"owner_id"`
TeamID *identity.ID `json:"team_id"`
}
// Type returns the enumerated byte representation of Membership
func (m *Membership) Type() byte {
return byte(0x0e)
}