wirepact

package

v1.1.0 Latest Latest Go to latest Published: Jan 3, 2022 License: Apache-2.0 Imports: 8 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/WirePact/go-translator

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CreateSignedJWTForUser(config *JWTConfig, userID string) (string, error)
func GetJWTUserSubject(wirePactJWT string) (string, error)
type JWTConfig

Constants ¶

View Source

const (
	// IdentityHeader defines the header that is transmitted
	// as the WirePact identity. This is a RSA256 signed JSONWebToken (JWT).
	IdentityHeader = "x-wirepact-identity"

	// AuthorizationHeader is the default HTTP header for authorization.
	AuthorizationHeader = "authorization"
)

Variables ¶

This section is empty.

Functions ¶

func CreateSignedJWTForUser ¶

func CreateSignedJWTForUser(config *JWTConfig, userID string) (string, error)

CreateSignedJWTForUser creates a valid signed JWT for the given userID. The JWT is signed with the private key (RSA256) from the key material. Additionally, the optional headers "x5c" and "x5t" (https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.6) are added - as they are required by WirePact - to enable the receiver to validate the presented signature. The audience is always set to "WirePact".

func GetJWTUserSubject ¶

func GetJWTUserSubject(wirePactJWT string) (string, error)

GetJWTUserSubject takes the WirePact encoded JWT and extracts the user subject. First, the function checks the x5c and x5t headers and validates the JWT signature against its own CA certificate. Then, if the JWT is valid the subject is extracted. If any error occurs (missing certificate headers, wrong certificate or other errors) the error is returned with an empty string.

Types ¶

type JWTConfig ¶

type JWTConfig struct {
	// The issuer that is inserted into the JWT.
	Issuer string

	// The lifetime of the token in a go duration.
	// If omitted, 60 seconds are used.
	Lifetime time.Duration
}

JWTConfig contains specialized configuration for the CreateSignedJWTForUser method.

Source Files ¶

View all Source files

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