session

package

v0.0.0-...-789275d Latest Latest Go to latest Published: Apr 27, 2017 License: MIT Imports: 6 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/influx6/backoffice

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ParseToken(val string) (userID string, token string, err error)
type EndSession
type NewSession
type Session
- func New(userID string, expiration time.Time) *Session

Constants ¶

View Source

const (

	// UniqueIndex defines the unique index name used by the models db for model query optimization.
	UniqueIndex = "user_id"

	// UniqueIndexField defines the unique index field used by the model in it's field.
	UniqueIndexField = "user_public_id"
)

Variables ¶

This section is empty.

Functions ¶

func ParseToken ¶

func ParseToken(val string) (userID string, token string, err error)

ParseToken parses the base64 encoded token, which it returns the associated userID and session token.

Types ¶

type EndSession ¶

type EndSession struct {
	UserID string `json:"user_id"`
	Token  string `json:"token"`
}

EndSession defines the set of data received to end a user's session.

type NewSession ¶

type NewSession struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

NewSession defines the set of data received to create a new user's session.

type Session ¶

type Session struct {
	UserID   string    `json:"user_id"`
	PublicID string    `json:"public_id"`
	Token    string    `json:"token"`
	Expires  time.Time `json:"expires"`
}

Session defines a struct which holds the the details of a giving user session.

func New ¶

func New(userID string, expiration time.Time) *Session

New returns a new instance of a session.

func (*Session) Expired ¶

func (u *Session) Expired() bool

Expired returns true/false if the the given session is expired.

func (Session) Fields ¶

func (u Session) Fields() map[string]interface{}

Fields returns a map representing the data of the session.

func (Session) SessionFields ¶

func (u Session) SessionFields() map[string]interface{}

SessionFields returns a map representing the user session.

func (Session) SessionToken ¶

func (u Session) SessionToken() string

SessionToken returns the Session.Token has a base64 encoded string. It returns a base64 encoded version where it contains the UserID:SessionToken.

func (Session) Table ¶

func (u Session) Table() string

Table returns the given table which the given struct corresponds to.

func (Session) ValidateToken ¶

func (u Session) ValidateToken(token string) bool

ValidateToken validates the provide base64 encoded token, that it matches the expected token value with that of the session.

func (*Session) WithFields ¶

func (u *Session) WithFields(fields map[string]interface{}) error

WithFields attempts to syncing the giving data within the provided map into it's own fields.

Source Files ¶

View all Source files

session.go

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