accesstoken

package

v0.0.0-...-6d4bf48 Latest Latest Go to latest Published: Feb 3, 2023 License: AGPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Onyx-Protocol/Onyx

Links

Open Source Insights

Documentation ¶

Overview ¶

Package accesstoken provides storage and validation of Chain Core credentials.

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrBadID is returned when Create is called on an invalid id string.
	ErrBadID = errors.New("invalid id")
	// ErrDuplicateID is returned when Create is called on an existing ID.
	ErrDuplicateID = errors.New("duplicate access token ID")
	// ErrBadType is returned when Create is called with a bad type.
	ErrBadType = errors.New("type must be client or network")
)

Functions ¶

This section is empty.

Types ¶

type CredentialStore ¶

type CredentialStore struct {
	DB pg.DB
}

func (*CredentialStore) Check ¶

func (cs *CredentialStore) Check(ctx context.Context, id string, secret []byte) (bool, error)

Check returns whether or not an id-secret pair is a valid access token.

func (*CredentialStore) Create ¶

func (cs *CredentialStore) Create(ctx context.Context, id, typ string) (*Token, error)

Create generates a new access token with the given ID.

func (*CredentialStore) Delete ¶

func (cs *CredentialStore) Delete(ctx context.Context, id string) error

Delete deletes an access token by id.

func (*CredentialStore) Exists ¶

func (cs *CredentialStore) Exists(ctx context.Context, id string) bool

Exists returns whether an id is part of a valid access token. It does not validate a secret.

func (*CredentialStore) List ¶

func (cs *CredentialStore) List(ctx context.Context, typ, after string, limit int) ([]*Token, string, error)

List lists all access tokens.

type Token ¶

type Token struct {
	ID      string    `json:"id"`
	Token   string    `json:"token,omitempty"`
	Type    string    `json:"type,omitempty"` // deprecated in 1.2
	Created time.Time `json:"created_at"`
	// contains filtered or unexported fields
}

Source Files ¶

View all Source files

accesstoken.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL