api

package module

v0.0.0-...-4a6915a Latest Latest Go to latest Published: Oct 29, 2015 License: BSD-3-Clause Imports: 11 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/manifest-destiny/api

README ¶

api

Documentation ¶

Index ¶

Variables
func BearerToken(req *restful.Request) (string, error)
func WriteError(r *restful.Response, err interface{})
type Claimer
type Claims
- func (c *Claims) Valid() error
type DB
- func NewDB(driver, info string) (*DB, error)
type Error
- func NewError(code int, msg string) *Error
- func (e *Error) Error() string
type GoogleIdentityClaims
type JWSVerifyer
- func NewJWSVerifyer(url string) (*JWSVerifyer, error)
- func (v *JWSVerifyer) UpdateKeySet() error
- func (v *JWSVerifyer) Verify(token string, c Claimer) error
type Timestamp
- func (t *Timestamp) MarshalJSON() ([]byte, error)
- func (t *Timestamp) UnmarshalJSON(b []byte) error
type TokenValidator
- func GoogleTokenValidator(aud ...string) (*TokenValidator, error)
type Validator

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// InvalidTokenErr error for an invalid Authorization header value.
	InvalidTokenErr = NewError(http.StatusUnauthorized, "Invalid token")
	// MissingTokenErr error for missing Authorization bearer token.
	MissingTokenErr = NewError(http.StatusBadRequest, "Missing bearer token")
	// InternalServerErr error for any internal server errors.
	InternalServerErr = NewError(http.StatusInternalServerError, "Internal server error")
)

Functions ¶

func BearerToken ¶

func BearerToken(req *restful.Request) (string, error)

BearerToken function returns the bearer token in an Authorization HTTP header.

func WriteError ¶

func WriteError(r *restful.Response, err interface{})

WriteError convenience function for writing error responses.

Types ¶

type Claimer ¶

type Claimer interface {
	Valid() error
}

Claimer represents a set of JWT claims.

type Claims ¶

type Claims struct {
	Validator      *Validator
	Issuer         string    `json:"iss,omitempty"`
	Subject        string    `json:"sub,omitempty"`
	Audience       string    `json:"aud,omitempty"`
	ExpirationTime Timestamp `json:"exp,omitempty"`
	NotBefore      Timestamp `json:"nbf,omitempty"`
	IssuedAt       Timestamp `json:"iat,omitempty"`
	ID             string    `json:"jti,omitempty"`
}

Claims represents a JWT claims set. Includes standard keys with additional Google claims.

func (*Claims) Valid ¶

func (c *Claims) Valid() error

Valid validates a Claims set.

type DB ¶

type DB struct {
	*sqlx.DB
}

DB wrapper for sqlx.DB.

func NewDB ¶

func NewDB(driver, info string) (*DB, error)

NewDB constructor for database connection.

type Error ¶

type Error struct {
	Message string
	// contains filtered or unexported fields
}

Error custom error type.

func NewError ¶

func NewError(code int, msg string) *Error

NewError constructor function for Error.

func (*Error) Error ¶

func (e *Error) Error() string

Error method to satisfy error interface.

type GoogleIdentityClaims ¶

type GoogleIdentityClaims struct {
	*Claims
	Email               string `json:"email,omitempty"`
	EmailVerified       bool   `json:"email_verified,omitempty"`
	Name                string `json:"name,omitempty"`
	GivenName           string `json:"given_name,omitempty"`
	FamilyName          string `json:"family_mame,omitempty"`
	Locale              string `json:"locale,omitempty"`
	Picture             string `json:"picture,omitempty"`
	AuthorizedPresenter string `json:"azp,omitempty"`
	AccessTokenHash     string `json:"at_hash,omitempty"`
}

GoogleIdentityClaims represents Google JWT claims and extends Claims.

type JWSVerifyer ¶

type JWSVerifyer struct {
	*jose.JsonWebKeySet
	// contains filtered or unexported fields
}

JWSVerifyer struct verifies JSON Web Signatures against a JWK Set.

func NewJWSVerifyer ¶

func NewJWSVerifyer(url string) (*JWSVerifyer, error)

NewJWSVerifyer constructs a JWSVerifyer.

func (*JWSVerifyer) UpdateKeySet ¶

func (v *JWSVerifyer) UpdateKeySet() error

UpdateKeySet updates the JWK Set.

func (*JWSVerifyer) Verify ¶

func (v *JWSVerifyer) Verify(token string, c Claimer) error

Verify verifies token against signing key and returns JWT claims.

type Timestamp ¶

type Timestamp struct {
	time.Time
}

Timestamp custom time.Time type with MarshalJSON and UnmarshalJSON methods.

func (*Timestamp) MarshalJSON ¶

func (t *Timestamp) MarshalJSON() ([]byte, error)

MarshalJSON handles Timestamp to byte array conversion.

func (*Timestamp) UnmarshalJSON ¶

func (t *Timestamp) UnmarshalJSON(b []byte) error

UnmarshalJSON handles JSON timestamp string to Timestamp type.

type TokenValidator ¶

type TokenValidator struct {
	Claims     *Validator
	Signatures *JWSVerifyer
}

TokenValidator convenience container for JWSVerifyer and Claimer.

func GoogleTokenValidator ¶

func GoogleTokenValidator(aud ...string) (*TokenValidator, error)

GoogleTokenValidator constructor for a Google TokenValidator.

type Validator ¶

type Validator struct {
	Issuers        []string
	Subjects       []string
	Audiences      []string
	IDs            []string
	CheckExpired   bool
	CheckNotBefore bool
}

Validator defines Claims keys to validate.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
service
user

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