gopot

README

gopot

Platform of Trust utility functions for go.

Getting the library

go get -u github.com/holdatech/gopot/v2

Usage

package main

import (
	"fmt"

	"github.com/holdatech/gopot/v2"
)

func main() {
	secret := []byte("secret123")

	payload := struct {
		Hello string `json:"hello"`
	}{
		Hello: "World",
	}

	signature, err := gopot.CreateSignature(payload, secret)
	if err != nil {
		panic(err)
	}

	fmt.Println(signature)
}

Documentation

Index

• Variables
• func CreateSignature(d interface{}, secret []byte) (string, error)
• func JSONAddSpaces(src []byte) []byte
• func Marshal(d interface{}) ([]byte, error)
• func SignatureVerifierMiddleware(secret []byte) func(h http.Handler) http.Handler
• func VerifySignatureFromRequest(r *http.Request, secret []byte) error

Variables

var (
	// ErrNoBody is returned when there's no body provided to the signature function
	ErrNoBody = errors.New("No body")
	// ErrInvalidSignature is returned when the signatures don't match
	ErrInvalidSignature = errors.New("Invalid signature")
	// ErrNoSecret is returned when there's no secret provided
	ErrNoSecret = errors.New("No secret provided")
	// ErrNoSignature is returned when there's no signature found in the request headers
	ErrNoSignature = errors.New("No signature provided")
)

Functions

func CreateSignature

func CreateSignature(d interface{}, secret []byte) (string, error)

CreateSignature creates a pot signature with the given secret

func JSONAddSpaces

func JSONAddSpaces(src []byte) []byte

JSONAddSpaces ands spaces after the value declarations in json

func Marshal

func Marshal(d interface{}) ([]byte, error)

Marshal marshals json with the POT separators added.

func SignatureVerifierMiddleware

func SignatureVerifierMiddleware(secret []byte) func(h http.Handler) http.Handler

SignatureVerifierMiddleware creates a middleware with the provided secret to verify the signatures in the incoming requests

func VerifySignatureFromRequest

func VerifySignatureFromRequest(r *http.Request, secret []byte) error

VerifySignatureFromRequest can be used to verify the signature in the http request. It signs the request body and compares it to the signature provided in the header