README
¶
IAM Go
An opinionated Open Source implementation of the google.iam.v1.IAMPolicy service API, using Cloud Spanner for storage.
Usage
1) Install
$ go get go.einride.tech/iam
2) Include the IAMPolicy mixin in your gRPC service
/* ... */
package your.pkg;
/* ... */
import "google/iam/v1/iam_policy.proto";
import "google/iam/v1/policy.proto";
/* ... */
service YourService {
/* ... */
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
returns (google.iam.v1.Policy);
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
returns (google.iam.v1.Policy);
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
returns (google.iam.v1.TestIamPermissionsResponse);
}
3) Embed the IAMServer implementation in your server
See iamspanner.IAMServer.
// Server implements your gRPC API.
type Server struct {
*iamspanner.IAMServer
// ...
}
// Server now also implements the iam.IAMPolicyServer mixin.
var _ iam.IAMPolicyServer = &Server{}
4) Include the IAM policy bindings table in your Spanner SQL schema
See schema.sql.
5) Annotate your gRPC methods
Coming soon.
6) Generate authorization middleware
Coming soon.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
iamctl
Module
|
|
|
Package iamauthz provides primitives for performing IAM request authorization.
|
Package iamauthz provides primitives for performing IAM request authorization. |
|
Package iamexample provides a reference implementation of a gRPC service that uses IAM for access management.
|
Package iamexample provides a reference implementation of a gRPC service that uses IAM for access management. |
|
iamexampledata
Package iamexampledata provides predefined example data for the IAM example service.
|
Package iamexampledata provides predefined example data for the IAM example service. |
|
Package iamfirebase provides Firebase-specific IAM primitives.
|
Package iamfirebase provides Firebase-specific IAM primitives. |
|
Package iamgoogle provides Google-specific IAM primitives.
|
Package iamgoogle provides Google-specific IAM primitives. |
|
Package iammember provides primitives for IAM member identifiers.
|
Package iammember provides primitives for IAM member identifiers. |
|
Package iammixin provides utilities for registering gRPC servers with IAM mixins.
|
Package iammixin provides utilities for registering gRPC servers with IAM mixins. |
|
Package iampermission provides primitives for working with IAM permissions.
|
Package iampermission provides primitives for working with IAM permissions. |
|
Package iampolicy provides primitives for working with IAM policies.
|
Package iampolicy provides primitives for working with IAM policies. |
|
Package iamregistry provides data structures for resolving IAM roles and permissions.
|
Package iamregistry provides data structures for resolving IAM roles and permissions. |
|
Package iamresource provides primitives for working with IAM resources.
|
Package iamresource provides primitives for working with IAM resources. |
|
Package iamrole provides primitives and operations on IAM roles.
|
Package iamrole provides primitives and operations on IAM roles. |
|
Package iamspanner provides a Spanner-based storage implementation of the IAMPolicy service.
|
Package iamspanner provides a Spanner-based storage implementation of the IAMPolicy service. |
|
Package iamtest provides primitives for unit testing IAM implementations.
|
Package iamtest provides primitives for unit testing IAM implementations. |
|
proto
|
|
Click to show internal directories.
Click to hide internal directories.