dscursor

Documentation

Overview

Package dscursor contains a set of utilities that help performing common tasks associated with datastore.Cursor.

Index

• type Vault
  • func NewVault(additionalData []byte) Vault
  • func (v *Vault) Cursor(ctx context.Context, pageToken string) (datastore.Cursor, error)
  • func (v *Vault) PageToken(ctx context.Context, cursor datastore.Cursor) (string, error)

Types

type Vault

type Vault struct {
	// contains filtered or unexported fields
}

Vault is a utility type that can convert datastore.Cursor to/from an encrypted, URL safe page token. It uses AEAD to ensure that 1. potential sensitive information contained in the cursor is not leaked. 2. user can not use a page token that is not generated by the server.

func NewVault

func NewVault(additionalData []byte) Vault

NewVault creates a new page token vault with the specified additional data.

Notes: * server/secrets module must be initialized with PrimaryTinkAEADKey during server start up. * The additionalData is used for encryption. Vaults used in different places should have different additional data.

func (*Vault) Cursor

func (v *Vault) Cursor(ctx context.Context, pageToken string) (datastore.Cursor, error)

Cursor converts a page token to a datastore.Cursor. Returns pagination.ErrInvalidPageToken if the token is malformed or can't be decrypted and secrets.ErrNoPrimaryAEAD if the encryption key is not configured.

func (*Vault) PageToken

func (v *Vault) PageToken(ctx context.Context, cursor datastore.Cursor) (string, error)

PageToken converts a datastore.Cursor to an encrypted, URL safe page token.