Go Auth Token

Golang library to simplify generating and parsing the JWT-formatted (Bearer) authentication token. This library is using https://github.com/golang-jwt/jwt.

Goal

The aim of this project is to simplify the generation and parsing of JWT tokens.

Installation

Install the package by using this command.

go get github.com/slzhffktm/go-auth-token

Usage

package main

import (
	"fmt"
	"time"

	authtoken "github.com/slzhffktm/go-auth-token"
)

type Data struct {
	Email string `json:"email"`
}

func main() {
	// For symmetric SigningMethod, e.g. SigningMethodHS256.
	authToken, err := authtoken.New[Data](authtoken.Options{
		SecretKey:     []byte("steve-ao-key"),
		SigningMethod: authtoken.SigningMethodHS256,
	})

	// Generate token which contains the data.
	token, expiresAt, err := authToken.GenerateToken(Data{
		Email: "[email protected]",
	}, time.Minute*5)
	if err != nil {
		// do something with error
	}

	fmt.Printf("Token: %s, will expire at: %s\n", token, expiresAt)

	// Parse the token.
	resData, err := authToken.ParseToken(token)
	if err != nil {
		// do something with error
	}

	fmt.Printf("Email: %s\n", resData.Email)
	// Output: Email: [email protected]
}

For asymmetric SigningMethod (e.g. SigningMethodEdDSA), you need to provide PrivateKey and PublicKey instead of SecretKey.

package main

import (
	"crypto/ed25519"
	"crypto/rand"
	
	authtoken "github.com/slzhffktm/go-auth-token"
)

func main() {
	pub, priv, err := ed25519.GenerateKey(rand.Reader)
	if err != nil {
		// do something with error
    }

	authToken, err := authtoken.New[Data](authtoken.Options{
		SigningMethod: authtoken.SigningMethodEdDSA,
		PrivateKey:    priv,
		PublicKey:     pub,
	})
	
	// Usage is the same as the symmetric SigningMethod.
}

Contributing

Welcome, welcome! We're thrilled that you're interested in contributing to our project. We'll take contributions in any flavor - bug reports, security issues, feature suggestions, documentation improvements, and code contributions are all on the menu.

How to Contribute

Hungry to contribute? Just open an issue or pull request and let us know what's cookin'! We can't wait to see what you bring to the table.

Contact

If you have any questions or concerns about contributing to our project, please reach out to us by email or on GitHub. We appreciate your interest and look forward to working with you!