Skip to main content

Go Client Packages for CYBERCRYPT D1

Go client packages for

D1 Storage Client​

In order to use the D1 Storage client you will need credentials for a user. If you are using the built in Standalone ID Provider you can refer to the Getting Started guide for details on how to obtain these. If you are using an OIDC provider you will need to obtain and ID Token in the usual way.

The client can be configured with an option that provides an implementation of credentials.PerRPCCredentials to easily attach a token to every request. For convenience, we provide an implementation called PerRPCToken which can be any function that fetches a token, for example, after a call to the OIDC provider. There is also an implementation that can be used with the Standalone ID Provider, which can be configured by calling NewStandalonePerRPCToken with the details about accessing and logging in to the Provider as shown in the following example:

client, _ := client.NewStorageClient(endpoint,
        gclient.WithPerRPCCredentials(
            gclient.NewStandalonePerRPCToken(endpoint, uid, password, creds),
        ),
    )

The ID Token can also be attached manually as gRPC metadata via the context:

ctx = metadata.AppendToOutgoingContext(ctx, "authorization", "bearer " + idToken)
client, _ := NewStorageClient(...)
client.Store(ctx, ...)

For more detailed explanations and examples, see the godoc.

D1 Generic Client​

In order to use the D1 Generic client you will need credentials for a user. If you are using the built in Standalone ID Provider you can refer to the Getting Started guide for details on how to obtain these. If you are using an OIDC provider you will need to obtain and ID Token in the usual way.

The client can be configured with an option that provides an implementation of credentials.PerRPCCredentials to easily attach a token to every request. For convenience, we provide an implementation called PerRPCToken which can be any function that fetches a token, for example, after a call to the OIDC provider. There is also an implementation that can be used with the Standalone ID Provider, which can be configured by calling NewStandalonePerRPCToken with the details about accessing and logging in to the Provider as shown in the following example:

client, _ := client.NewGenericClient(endpoint,
        client.WithPerRPCCredentials(
            client.NewStandalonePerRPCToken(endpoint, uid, password, creds),
        ),
    )

The ID Token can also be attached manually as gRPC metadata via the context:

ctx = metadata.AppendToOutgoingContext(ctx, "authorization", "bearer " + idToken)
client, _ := NewGenericClient(...)
client.Encrypt(ctx, ...)

For more detailed explanations and examples, see the godoc.

License​

The software in the CYBERCRYPT d1-client-go repository is licensed under the Apache License 2.0.