authzed/authzed-go

Official SpiceDB client library for Go

authzed-go's Issues

Update `CONTRIBUTING.md` for new mage command

Also include instructions about how to build locally modified protos.

Use CI to enforce that go.mod and remote plugins are synced

In the ideal case, we want the Go dependencies to match the versions used for the buf remote plugins to generate code.

dependabot updates are not mergeable due to go.work.sum in magefiles

because magefiles/go.work includes the parent folder, any dependabot update will not be mergeable without manual intervention because builds will fail as magefiles/go.work.sum needs to be updated.

magefiles/go.work was added so that the various linters can act upon resources in a different folder

Document how to connect to an insecure local SpiceDB

Add examples using gRPC middleware

NewClient supports arbitrary client-side gRPC middleware. The README shows off using grpcutil's middleware, but not a variety of middleware available for things like retries and backoff.

Protobuf import path issue

Posted this to /authzed-rb, but this is the repo linked in https://github.com/authzed/api/blob/main/CONTRIBUTING.md, so I'm posting here as well:

authzed/authzed-rb#75

Readme code example for calling the API is wrong

https://github.com/authzed/authzed-go/blob/main/README.md#performing-an-api-call <- this references a &pb

using this in a project leads to this outcome:

the recommended package is actually wrong, the right way is to simply use &v1 instead, see

Will provide a PR shortly.

remove tests for v0

v0 is now deprecated and no longer being mantained. We can spare the maintenance of v0 tests if delete them.

readme snippets still use v0 API

add / reference authzed-go API usage examples

This repository does not have an exhaustive set of examples on how to use the API. Some examples of how to use the authzed-go SDK are found in https://authzed.com/docs/guides/first-app but are not discoverable from this repository.

add fuzzing test for the new extended object ID

add a test for the new extended object ID regex using Go fuzzing https://go.dev/security/fuzz/

Connect to an insecure local SpiceDB

I have a spicedb instance running locally like so spicedb serve --grpc-preshared-key <preshared-key> but I'm unable to connect to it.

I've tried passing grpc.WithTransportCredentials(insecure.NewCredentials())and grpc.WithInsecure() to authzed.NewClient:

client, err := authzed.NewClient(
		"localhost:50051",
		grpcutil.WithBearerToken(<preshared-key>),
		grpc.WithTransportCredentials(insecure.NewCredentials()),
)

but I always get:
grpc: the credentials require transport level security (use grpc.WithTransportCredentials() to set).

I see there's an open issue to document this process: #53.
What I'm I missing?

Add/re-enable integration tests

There needs to be a GitHub action on this repository that uses action-spicedb for end-to-end testing of clients.

The grpcutil dependency is out of date and broken

The grpcutil dependency is out of date and is still attempting to import a package from the grpc package that no longer exists. The grpcutil repo was already updated, but this repo didn't update the dependency.