signer

Documentation

Index

• Constants
• Variables
• type AsymmetricSigner
• type Signer
  • func NewKMSSigner(ctx context.Context, asymmetricSigner AsymmetricSigner, keyName string) (Signer, error)
  • func NewNakamaSigner(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule) (Signer, error)
• type TestOnlySigner
  • func NewKMSTestOnlySigner(ctx context.Context, asymmetricSigner AsymmetricSigner, keyName string) (TestOnlySigner, error)

Constants

const (
	AdminAccountID = "00000000-0000-0000-0000-000000000000"
)

Variables

var (
	ErrNoStorageObjectFound       = errors.New("no storage object found")
	ErrTooManyStorageObjectsFound = errors.New("too many storage objects found")
)

Types

type AsymmetricSigner

type AsymmetricSigner interface {
	AsymmetricSign(context.Context, *kmspb.AsymmetricSignRequest, ...gax.CallOption) (
		*kmspb.AsymmetricSignResponse, error,
	)
	GetPublicKey(context.Context, *kmspb.GetPublicKeyRequest, ...gax.CallOption) (*kmspb.PublicKey, error)
}

AsymmetricSigner is implemented by the kms.KeyManagementClient and it mainly exists so that testing can be easily done via a fake version of the kms service.

type Signer

type Signer interface {
	SignTx(ctx context.Context, personaTag string, namespace string, data any) (*sign.Transaction, error)
	SignSystemTx(ctx context.Context, namespace string, data any) (*sign.Transaction, error)
	SignerAddress() string
}

func NewKMSSigner

func NewKMSSigner(ctx context.Context, asymmetricSigner AsymmetricSigner, keyName string) (
	Signer, error,
)

func NewNakamaSigner

func NewNakamaSigner(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule) (
	Signer, error,
)

type TestOnlySigner

type TestOnlySigner interface {
	Signer
	SignTxWithTimestamp(ctx context.Context, personaTag string, namespace string, data any, timestamp int64, salt uint16) (
		*sign.Transaction, error)
}

func NewKMSTestOnlySigner

func NewKMSTestOnlySigner(ctx context.Context, asymmetricSigner AsymmetricSigner, keyName string) (
	TestOnlySigner, error,
)

only use this for testing