auth

package

v0.0.0-...-0985497 Latest Latest Go to latest Published: Mar 20, 2024 License: GPL-3.0 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/infomark-org/infomark

Documentation ¶

Index ¶

Variables
func CheckPasswordHash(plainPassword, hash string) bool
func ErrUnauthenticatedWithDetails(err error) render.Renderer
func ErrUnauthorizedWithDetails(err error) render.Renderer
func GenerateToken(length int) string
func HashPassword(plainPassword string) (string, error)
type ErrResponse
- func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrTokenUnauthorized   = errors.New("token unauthorized")
	ErrTokenExpired        = errors.New("token expired")
	ErrInvalidAccessToken  = errors.New("invalid access token")
	ErrInvalidRefreshToken = errors.New("invalid refresh token")
)

The list of jwt token errors presented to the end user.

View Source

var (
	// ErrUnauthenticated means no credentials are given
	ErrUnauthenticated = &ErrResponse{HTTPStatusCode: http.StatusUnauthorized, StatusText: http.StatusText(http.StatusUnauthorized)}

	// ErrUnauthorized returns status 403 Forbidden for unauthorized request.
	// e.g. "User doesn't have enough privilege"
	ErrUnauthorized = &ErrResponse{HTTPStatusCode: http.StatusForbidden, StatusText: http.StatusText(http.StatusForbidden)}
)

Functions ¶

func CheckPasswordHash ¶

func CheckPasswordHash(plainPassword, hash string) bool

CheckPasswordHash tests whether a given plainPassword matches the securely hashed one.

func ErrUnauthenticatedWithDetails ¶

func ErrUnauthenticatedWithDetails(err error) render.Renderer

ErrUnauthenticatedWithDetails renders status 401 Unauthorized with custom error message. The request has no credentials at all.

func ErrUnauthorizedWithDetails ¶

func ErrUnauthorizedWithDetails(err error) render.Renderer

ErrUnauthorizedWithDetails renders status 403 Unauthorized with custom error message. The request is issued with credential, but these are invalid or not sufficient to gain access to a ressource.

func GenerateToken ¶

func GenerateToken(length int) string

GenerateToken generates a random string with a specific length

func HashPassword ¶

func HashPassword(plainPassword string) (string, error)

HashPassword uses bcrypt to securely hash a plain password

Types ¶

type ErrResponse ¶

type ErrResponse struct {
	Err            error `json:"-"` // low-level runtime error
	HTTPStatusCode int   `json:"-"` // http response status code

	StatusText string `json:"status"`          // user-level status message
	AppCode    int64  `json:"code,omitempty"`  // application-specific error code
	ErrorText  string `json:"error,omitempty"` // application-level error message, for debugging
}

ErrResponse renderer type for handling all sorts of errors.

func (*ErrResponse) Render ¶

func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error

Render sets the application-specific error code in AppCode.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
authenticate
authorize

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