token

Documentation

Overview

SPDX-Copyright: Copyright (c) Brad Rydzewski, project contributors, Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Brad Rydzewski, project contributors, Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func CheckCsrf(r *http.Request, fn SecretFunc) error
• type SecretFunc
• type Token
  • func New(kind, text string) *Token
  • func Parse(raw string, fn SecretFunc) (*Token, error)
  • func ParseRequest(r *http.Request, fn SecretFunc) (*Token, error)
  • func (t *Token) Sign(secret string) (string, error)
  • func (t *Token) SignExpires(secret string, exp int64) (string, error)

Constants

const (
	UserToken = "user"
	SessToken = "sess"
	HookToken = "hook"
	CsrfToken = "csrf"
)

const SignerAlgo = "HS256"

Default algorithm used to sign JWT tokens.

Functions

func CheckCsrf

func CheckCsrf(r *http.Request, fn SecretFunc) error

Types

type SecretFunc

type SecretFunc func(*Token) (string, error)

type Token

type Token struct {
	Kind string
	Text string
}

func New

func New(kind, text string) *Token

func Parse

func Parse(raw string, fn SecretFunc) (*Token, error)

func ParseRequest

func ParseRequest(r *http.Request, fn SecretFunc) (*Token, error)

func (*Token) Sign

func (t *Token) Sign(secret string) (string, error)

Sign signs the token using the given secret hash and returns the string value.

func (*Token) SignExpires

func (t *Token) SignExpires(secret string, exp int64) (string, error)

Sign signs the token using the given secret hash with an expiration date.