stdjose

package module

v0.1.0 Latest Latest Go to latest Published: Nov 6, 2021 License: MIT Imports: 7 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/absurdlab/pkg

README ¶

jose

Wrapper around gopkg.in/square/go-jose.v2 for convenient encoding and decoding JWT/JWE needed in OIDC applications.

Install

go get -u github.com/absurdlab/pkg/stdjose

Usage

// encoding
token, _ := stdjose.Encode().Claims(
    new(jwt.Claims).
        GenerateID().
        WithAudience("tester").
        WithExpiryInFuture(600).
        WithIssuedAtNow().
        WithSubject("test"),
    ).
    Claims(etc{Foo: "bar"}).
    Sign(jwks, jwa.ES256).
	CompactSerialize()

// decoding
var (
	standardClaims = new(jwt.Claims)
	extraClaims = new(etc)
)
_ = stdjose.Decode().
	Decrypt(jwks, jwa.RSA1_5).
	Verify(jwks, jwa.ES256).
	Decode(token, standardClaims, extraClaims)

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrDecode = errors.New("decode token error")

View Source

var ErrEncode = errors.New("encode token error")

Functions ¶

func Decode ¶

func Decode() *decodeOptions

Decode is the entrypoint to configure the decoding process.

func Encode ¶

func Encode() *encodeOptions

Encode is the entrypoint for configuring the encoding process.

Types ¶

type Decoder ¶

type Decoder interface {
	// Decode decrypts and/or verifies token and unmarshal the object into the list of destinations.
	Decode(token string, dest ...interface{}) error
}

Decoder abstracts JWS/JWE decoding.

type Encoder ¶

type Encoder interface {
	// CompactSerialize produces a encoded JWT token.
	CompactSerialize() (string, error)
}

Encoder abstracts JWS/JWE encoding.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
jwa
jwk
internal
jwt

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