Git LFS support v2 (#122)
* Import github.com/git-lfs/lfs-test-server as lfs module base Imported commit is 3968aac269a77b73924649b9412ae03f7ccd3198 Removed: Dockerfile CONTRIBUTING.md mgmt* script/ vendor/ kvlogger.go .dockerignore .gitignore README.md * Remove config, add JWT support from github.com/mgit-at/lfs-test-server Imported commit f0cdcc5a01599c5a955dc1bbf683bb4acecdba83 * Add LFS settings * Add LFS meta object model * Add LFS routes and initialization * Import github.com/dgrijalva/jwt-go into vendor/ * Adapt LFS module: handlers, routing, meta store * Move LFS routes to /user/repo/info/lfs/* * Add request header checks to LFS BatchHandler / PostHandler * Implement LFS basic authentication * Rework JWT secret generation / load * Implement LFS SSH token authentication with JWT Specification: https://github.com/github/git-lfs/tree/master/docs/api * Integrate LFS settings into install process * Remove LFS objects when repository is deleted Only removes objects from content store when deleted repo is the only referencing repository * Make LFS module stateless Fixes bug where LFS would not work after installation without restarting Gitea * Change 500 'Internal Server Error' to 400 'Bad Request' * Change sql query to xorm call * Remove unneeded type from LFS module * Change internal imports to code.gitea.io/gitea/ * Add Gitea authors copyright * Change basic auth realm to "gitea-lfs" * Add unique indexes to LFS model * Use xorm count function in LFS check on repository delete * Return io.ReadCloser from content store and close after usage * Add LFS info to runWeb() * Export LFS content store base path * LFS file download from UI * Work around git-lfs client issue with unauthenticated requests Returning a dummy Authorization header for unauthenticated requests lets git-lfs client skip asking for auth credentials See: https://github.com/github/git-lfs/issues/1088 * Fix unauthenticated UI downloads from public repositories * Authentication check order, Finish LFS file view logic * Ignore LFS hooks if installed for current OS user Fixes Gitea UI actions for repositories tracking LFS files. Checks for minimum needed git version by parsing the semantic version string. * Hide LFS metafile diff from commit view, marking as binary * Show LFS notice if file in commit view is tracked * Add notbefore/nbf JWT claim * Correct lint suggestions - comments for structs and functions - Add comments to LFS model - Function comment for GetRandomBytesAsBase64 - LFS server function comments and lint variable suggestion * Move secret generation code out of conditional Ensures no LFS code may run with an empty secret * Do not hand out JWT tokens if LFS server support is disabledtokarchuk/v1.17
Fabian Zaremba
8 years ago
committed by
Lunny Xiao
parent
4b7594d9fa
commit
2e7ccecfe6
@ -0,0 +1,122 @@ |
|||||||
|
package models |
||||||
|
|
||||||
|
import ( |
||||||
|
"errors" |
||||||
|
"github.com/go-xorm/xorm" |
||||||
|
"time" |
||||||
|
) |
||||||
|
|
||||||
|
// LFSMetaObject stores metadata for LFS tracked files.
|
||||||
|
type LFSMetaObject struct { |
||||||
|
ID int64 `xorm:"pk autoincr"` |
||||||
|
Oid string `xorm:"UNIQUE(s) INDEX NOT NULL"` |
||||||
|
Size int64 `xorm:"NOT NULL"` |
||||||
|
RepositoryID int64 `xorm:"UNIQUE(s) INDEX NOT NULL"` |
||||||
|
Existing bool `xorm:"-"` |
||||||
|
Created time.Time `xorm:"-"` |
||||||
|
CreatedUnix int64 |
||||||
|
} |
||||||
|
|
||||||
|
// LFSTokenResponse defines the JSON structure in which the JWT token is stored.
|
||||||
|
// This structure is fetched via SSH and passed by the Git LFS client to the server
|
||||||
|
// endpoint for authorization.
|
||||||
|
type LFSTokenResponse struct { |
||||||
|
Header map[string]string `json:"header"` |
||||||
|
Href string `json:"href"` |
||||||
|
} |
||||||
|
|
||||||
|
var ( |
||||||
|
// ErrLFSObjectNotExist is returned from lfs models functions in order
|
||||||
|
// to differentiate between database and missing object errors.
|
||||||
|
ErrLFSObjectNotExist = errors.New("LFS Meta object does not exist") |
||||||
|
) |
||||||
|
|
||||||
|
const ( |
||||||
|
// LFSMetaFileIdentifier is the string appearing at the first line of LFS pointer files.
|
||||||
|
// https://github.com/git-lfs/git-lfs/blob/master/docs/spec.md
|
||||||
|
LFSMetaFileIdentifier = "version https://git-lfs.github.com/spec/v1" |
||||||
|
|
||||||
|
// LFSMetaFileOidPrefix appears in LFS pointer files on a line before the sha256 hash.
|
||||||
|
LFSMetaFileOidPrefix = "oid sha256:" |
||||||
|
) |
||||||
|
|
||||||
|
// NewLFSMetaObject stores a given populated LFSMetaObject structure in the database
|
||||||
|
// if it is not already present.
|
||||||
|
func NewLFSMetaObject(m *LFSMetaObject) (*LFSMetaObject, error) { |
||||||
|
var err error |
||||||
|
|
||||||
|
has, err := x.Get(m) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
if has { |
||||||
|
m.Existing = true |
||||||
|
return m, nil |
||||||
|
} |
||||||
|
|
||||||
|
sess := x.NewSession() |
||||||
|
defer sessionRelease(sess) |
||||||
|
if err = sess.Begin(); err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
if _, err = sess.Insert(m); err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
return m, sess.Commit() |
||||||
|
} |
||||||
|
|
||||||
|
// GetLFSMetaObjectByOid selects a LFSMetaObject entry from database by its OID.
|
||||||
|
// It may return ErrLFSObjectNotExist or a database error. If the error is nil,
|
||||||
|
// the returned pointer is a valid LFSMetaObject.
|
||||||
|
func GetLFSMetaObjectByOid(oid string) (*LFSMetaObject, error) { |
||||||
|
if len(oid) == 0 { |
||||||
|
return nil, ErrLFSObjectNotExist |
||||||
|
} |
||||||
|
|
||||||
|
m := &LFSMetaObject{Oid: oid} |
||||||
|
has, err := x.Get(m) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} else if !has { |
||||||
|
return nil, ErrLFSObjectNotExist |
||||||
|
} |
||||||
|
return m, nil |
||||||
|
} |
||||||
|
|
||||||
|
// RemoveLFSMetaObjectByOid removes a LFSMetaObject entry from database by its OID.
|
||||||
|
// It may return ErrLFSObjectNotExist or a database error.
|
||||||
|
func RemoveLFSMetaObjectByOid(oid string) error { |
||||||
|
if len(oid) == 0 { |
||||||
|
return ErrLFSObjectNotExist |
||||||
|
} |
||||||
|
|
||||||
|
sess := x.NewSession() |
||||||
|
defer sessionRelease(sess) |
||||||
|
if err := sess.Begin(); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
m := &LFSMetaObject{Oid: oid} |
||||||
|
|
||||||
|
if _, err := sess.Delete(m); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
return sess.Commit() |
||||||
|
} |
||||||
|
|
||||||
|
// BeforeInsert sets the time at which the LFSMetaObject was created.
|
||||||
|
func (m *LFSMetaObject) BeforeInsert() { |
||||||
|
m.CreatedUnix = time.Now().Unix() |
||||||
|
} |
||||||
|
|
||||||
|
// AfterSet stores the LFSMetaObject creation time in the database as local time.
|
||||||
|
func (m *LFSMetaObject) AfterSet(colName string, _ xorm.Cell) { |
||||||
|
switch colName { |
||||||
|
case "created_unix": |
||||||
|
m.Created = time.Unix(m.CreatedUnix, 0).Local() |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,20 @@ |
|||||||
|
Copyright (c) 2016 The Gitea Authors |
||||||
|
Copyright (c) GitHub, Inc. and LFS Test Server contributors |
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||||
|
of this software and associated documentation files (the "Software"), to deal |
||||||
|
in the Software without restriction, including without limitation the rights |
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||||
|
copies of the Software, and to permit persons to whom the Software is |
||||||
|
furnished to do so, subject to the following conditions: |
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all |
||||||
|
copies or substantial portions of the Software. |
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||||
|
SOFTWARE. |
||||||
@ -0,0 +1,94 @@ |
|||||||
|
package lfs |
||||||
|
|
||||||
|
import ( |
||||||
|
"code.gitea.io/gitea/models" |
||||||
|
"crypto/sha256" |
||||||
|
"encoding/hex" |
||||||
|
"errors" |
||||||
|
"io" |
||||||
|
"os" |
||||||
|
"path/filepath" |
||||||
|
) |
||||||
|
|
||||||
|
var ( |
||||||
|
errHashMismatch = errors.New("Content hash does not match OID") |
||||||
|
errSizeMismatch = errors.New("Content size does not match") |
||||||
|
) |
||||||
|
|
||||||
|
// ContentStore provides a simple file system based storage.
|
||||||
|
type ContentStore struct { |
||||||
|
BasePath string |
||||||
|
} |
||||||
|
|
||||||
|
// Get takes a Meta object and retreives the content from the store, returning
|
||||||
|
// it as an io.Reader. If fromByte > 0, the reader starts from that byte
|
||||||
|
func (s *ContentStore) Get(meta *models.LFSMetaObject, fromByte int64) (io.ReadCloser, error) { |
||||||
|
path := filepath.Join(s.BasePath, transformKey(meta.Oid)) |
||||||
|
|
||||||
|
f, err := os.Open(path) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
if fromByte > 0 { |
||||||
|
_, err = f.Seek(fromByte, os.SEEK_CUR) |
||||||
|
} |
||||||
|
return f, err |
||||||
|
} |
||||||
|
|
||||||
|
// Put takes a Meta object and an io.Reader and writes the content to the store.
|
||||||
|
func (s *ContentStore) Put(meta *models.LFSMetaObject, r io.Reader) error { |
||||||
|
path := filepath.Join(s.BasePath, transformKey(meta.Oid)) |
||||||
|
tmpPath := path + ".tmp" |
||||||
|
|
||||||
|
dir := filepath.Dir(path) |
||||||
|
if err := os.MkdirAll(dir, 0750); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
file, err := os.OpenFile(tmpPath, os.O_CREATE|os.O_WRONLY|os.O_EXCL, 0640) |
||||||
|
if err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
defer os.Remove(tmpPath) |
||||||
|
|
||||||
|
hash := sha256.New() |
||||||
|
hw := io.MultiWriter(hash, file) |
||||||
|
|
||||||
|
written, err := io.Copy(hw, r) |
||||||
|
if err != nil { |
||||||
|
file.Close() |
||||||
|
return err |
||||||
|
} |
||||||
|
file.Close() |
||||||
|
|
||||||
|
if written != meta.Size { |
||||||
|
return errSizeMismatch |
||||||
|
} |
||||||
|
|
||||||
|
shaStr := hex.EncodeToString(hash.Sum(nil)) |
||||||
|
if shaStr != meta.Oid { |
||||||
|
return errHashMismatch |
||||||
|
} |
||||||
|
|
||||||
|
if err := os.Rename(tmpPath, path); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// Exists returns true if the object exists in the content store.
|
||||||
|
func (s *ContentStore) Exists(meta *models.LFSMetaObject) bool { |
||||||
|
path := filepath.Join(s.BasePath, transformKey(meta.Oid)) |
||||||
|
if _, err := os.Stat(path); os.IsNotExist(err) { |
||||||
|
return false |
||||||
|
} |
||||||
|
return true |
||||||
|
} |
||||||
|
|
||||||
|
func transformKey(key string) string { |
||||||
|
if len(key) < 5 { |
||||||
|
return key |
||||||
|
} |
||||||
|
|
||||||
|
return filepath.Join(key[0:2], key[2:4], key[4:len(key)]) |
||||||
|
} |
||||||
@ -0,0 +1,549 @@ |
|||||||
|
package lfs |
||||||
|
|
||||||
|
import ( |
||||||
|
"encoding/base64" |
||||||
|
"encoding/json" |
||||||
|
"fmt" |
||||||
|
"io" |
||||||
|
"net/http" |
||||||
|
"regexp" |
||||||
|
"strconv" |
||||||
|
"strings" |
||||||
|
"time" |
||||||
|
|
||||||
|
"code.gitea.io/gitea/models" |
||||||
|
"code.gitea.io/gitea/modules/context" |
||||||
|
"code.gitea.io/gitea/modules/log" |
||||||
|
"code.gitea.io/gitea/modules/setting" |
||||||
|
"github.com/dgrijalva/jwt-go" |
||||||
|
"gopkg.in/macaron.v1" |
||||||
|
) |
||||||
|
|
||||||
|
const ( |
||||||
|
contentMediaType = "application/vnd.git-lfs" |
||||||
|
metaMediaType = contentMediaType + "+json" |
||||||
|
) |
||||||
|
|
||||||
|
// RequestVars contain variables from the HTTP request. Variables from routing, json body decoding, and
|
||||||
|
// some headers are stored.
|
||||||
|
type RequestVars struct { |
||||||
|
Oid string |
||||||
|
Size int64 |
||||||
|
User string |
||||||
|
Password string |
||||||
|
Repo string |
||||||
|
Authorization string |
||||||
|
} |
||||||
|
|
||||||
|
// BatchVars contains multiple RequestVars processed in one batch operation.
|
||||||
|
// https://github.com/git-lfs/git-lfs/blob/master/docs/api/batch.md
|
||||||
|
type BatchVars struct { |
||||||
|
Transfers []string `json:"transfers,omitempty"` |
||||||
|
Operation string `json:"operation"` |
||||||
|
Objects []*RequestVars `json:"objects"` |
||||||
|
} |
||||||
|
|
||||||
|
// BatchResponse contains multiple object metadata Representation structures
|
||||||
|
// for use with the batch API.
|
||||||
|
type BatchResponse struct { |
||||||
|
Transfer string `json:"transfer,omitempty"` |
||||||
|
Objects []*Representation `json:"objects"` |
||||||
|
} |
||||||
|
|
||||||
|
// Representation is object medata as seen by clients of the lfs server.
|
||||||
|
type Representation struct { |
||||||
|
Oid string `json:"oid"` |
||||||
|
Size int64 `json:"size"` |
||||||
|
Actions map[string]*link `json:"actions"` |
||||||
|
Error *ObjectError `json:"error,omitempty"` |
||||||
|
} |
||||||
|
|
||||||
|
// ObjectError defines the JSON structure returned to the client in case of an error
|
||||||
|
type ObjectError struct { |
||||||
|
Code int `json:"code"` |
||||||
|
Message string `json:"message"` |
||||||
|
} |
||||||
|
|
||||||
|
// ObjectLink builds a URL linking to the object.
|
||||||
|
func (v *RequestVars) ObjectLink() string { |
||||||
|
return fmt.Sprintf("%s%s/%s/info/lfs/objects/%s", setting.AppURL, v.User, v.Repo, v.Oid) |
||||||
|
} |
||||||
|
|
||||||
|
// link provides a structure used to build a hypermedia representation of an HTTP link.
|
||||||
|
type link struct { |
||||||
|
Href string `json:"href"` |
||||||
|
Header map[string]string `json:"header,omitempty"` |
||||||
|
ExpiresAt time.Time `json:"expires_at,omitempty"` |
||||||
|
} |
||||||
|
|
||||||
|
// ObjectOidHandler is the main request routing entry point into LFS server functions
|
||||||
|
func ObjectOidHandler(ctx *context.Context) { |
||||||
|
|
||||||
|
if !setting.LFS.StartServer { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if ctx.Req.Method == "GET" || ctx.Req.Method == "HEAD" { |
||||||
|
if MetaMatcher(ctx.Req) { |
||||||
|
GetMetaHandler(ctx) |
||||||
|
return |
||||||
|
} |
||||||
|
if ContentMatcher(ctx.Req) || len(ctx.Params("filename")) > 0 { |
||||||
|
GetContentHandler(ctx) |
||||||
|
return |
||||||
|
} |
||||||
|
} else if ctx.Req.Method == "PUT" && ContentMatcher(ctx.Req) { |
||||||
|
PutHandler(ctx) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
} |
||||||
|
|
||||||
|
// GetContentHandler gets the content from the content store
|
||||||
|
func GetContentHandler(ctx *context.Context) { |
||||||
|
|
||||||
|
rv := unpack(ctx) |
||||||
|
|
||||||
|
meta, err := models.GetLFSMetaObjectByOid(rv.Oid) |
||||||
|
if err != nil { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
repository, err := models.GetRepositoryByID(meta.RepositoryID) |
||||||
|
|
||||||
|
if err != nil { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if !authenticate(ctx, repository, rv.Authorization, false) { |
||||||
|
requireAuth(ctx) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
// Support resume download using Range header
|
||||||
|
var fromByte int64 |
||||||
|
statusCode := 200 |
||||||
|
if rangeHdr := ctx.Req.Header.Get("Range"); rangeHdr != "" { |
||||||
|
regex := regexp.MustCompile(`bytes=(\d+)\-.*`) |
||||||
|
match := regex.FindStringSubmatch(rangeHdr) |
||||||
|
if match != nil && len(match) > 1 { |
||||||
|
statusCode = 206 |
||||||
|
fromByte, _ = strconv.ParseInt(match[1], 10, 32) |
||||||
|
ctx.Resp.Header().Set("Content-Range", fmt.Sprintf("bytes %d-%d/%d", fromByte, meta.Size-1, int64(meta.Size)-fromByte)) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
contentStore := &ContentStore{BasePath: setting.LFS.ContentPath} |
||||||
|
content, err := contentStore.Get(meta, fromByte) |
||||||
|
if err != nil { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Resp.Header().Set("Content-Length", strconv.FormatInt(meta.Size, 10)) |
||||||
|
ctx.Resp.Header().Set("Content-Type", "application/octet-stream") |
||||||
|
|
||||||
|
filename := ctx.Params("filename") |
||||||
|
if len(filename) > 0 { |
||||||
|
decodedFilename, err := base64.RawURLEncoding.DecodeString(filename) |
||||||
|
if err == nil { |
||||||
|
ctx.Resp.Header().Set("Content-Disposition", "attachment; filename=\""+string(decodedFilename)+"\"") |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Resp.WriteHeader(statusCode) |
||||||
|
io.Copy(ctx.Resp, content) |
||||||
|
content.Close() |
||||||
|
logRequest(ctx.Req, statusCode) |
||||||
|
} |
||||||
|
|
||||||
|
// GetMetaHandler retrieves metadata about the object
|
||||||
|
func GetMetaHandler(ctx *context.Context) { |
||||||
|
|
||||||
|
rv := unpack(ctx) |
||||||
|
|
||||||
|
meta, err := models.GetLFSMetaObjectByOid(rv.Oid) |
||||||
|
if err != nil { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
repository, err := models.GetRepositoryByID(meta.RepositoryID) |
||||||
|
|
||||||
|
if err != nil { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if !authenticate(ctx, repository, rv.Authorization, false) { |
||||||
|
requireAuth(ctx) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Resp.Header().Set("Content-Type", metaMediaType) |
||||||
|
|
||||||
|
if ctx.Req.Method == "GET" { |
||||||
|
enc := json.NewEncoder(ctx.Resp) |
||||||
|
enc.Encode(Represent(rv, meta, true, false)) |
||||||
|
} |
||||||
|
|
||||||
|
logRequest(ctx.Req, 200) |
||||||
|
} |
||||||
|
|
||||||
|
// PostHandler instructs the client how to upload data
|
||||||
|
func PostHandler(ctx *context.Context) { |
||||||
|
|
||||||
|
if !setting.LFS.StartServer { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if !MetaMatcher(ctx.Req) { |
||||||
|
writeStatus(ctx, 400) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
rv := unpack(ctx) |
||||||
|
|
||||||
|
repositoryString := rv.User + "/" + rv.Repo |
||||||
|
repository, err := models.GetRepositoryByRef(repositoryString) |
||||||
|
|
||||||
|
if err != nil { |
||||||
|
log.Debug("Could not find repository: %s - %s", repositoryString, err) |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if !authenticate(ctx, repository, rv.Authorization, true) { |
||||||
|
requireAuth(ctx) |
||||||
|
} |
||||||
|
|
||||||
|
meta, err := models.NewLFSMetaObject(&models.LFSMetaObject{Oid: rv.Oid, Size: rv.Size, RepositoryID: repository.ID}) |
||||||
|
|
||||||
|
if err != nil { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Resp.Header().Set("Content-Type", metaMediaType) |
||||||
|
|
||||||
|
sentStatus := 202 |
||||||
|
contentStore := &ContentStore{BasePath: setting.LFS.ContentPath} |
||||||
|
if meta.Existing && contentStore.Exists(meta) { |
||||||
|
sentStatus = 200 |
||||||
|
} |
||||||
|
ctx.Resp.WriteHeader(sentStatus) |
||||||
|
|
||||||
|
enc := json.NewEncoder(ctx.Resp) |
||||||
|
enc.Encode(Represent(rv, meta, meta.Existing, true)) |
||||||
|
logRequest(ctx.Req, sentStatus) |
||||||
|
} |
||||||
|
|
||||||
|
// BatchHandler provides the batch api
|
||||||
|
func BatchHandler(ctx *context.Context) { |
||||||
|
|
||||||
|
if !setting.LFS.StartServer { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if !MetaMatcher(ctx.Req) { |
||||||
|
writeStatus(ctx, 400) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
bv := unpackbatch(ctx) |
||||||
|
|
||||||
|
var responseObjects []*Representation |
||||||
|
|
||||||
|
// Create a response object
|
||||||
|
for _, object := range bv.Objects { |
||||||
|
|
||||||
|
repositoryString := object.User + "/" + object.Repo |
||||||
|
repository, err := models.GetRepositoryByRef(repositoryString) |
||||||
|
|
||||||
|
if err != nil { |
||||||
|
log.Debug("Could not find repository: %s - %s", repositoryString, err) |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
requireWrite := false |
||||||
|
if bv.Operation == "upload" { |
||||||
|
requireWrite = true |
||||||
|
} |
||||||
|
|
||||||
|
if !authenticate(ctx, repository, object.Authorization, requireWrite) { |
||||||
|
requireAuth(ctx) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
meta, err := models.GetLFSMetaObjectByOid(object.Oid) |
||||||
|
|
||||||
|
contentStore := &ContentStore{BasePath: setting.LFS.ContentPath} |
||||||
|
if err == nil && contentStore.Exists(meta) { // Object is found and exists
|
||||||
|
responseObjects = append(responseObjects, Represent(object, meta, true, false)) |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
// Object is not found
|
||||||
|
meta, err = models.NewLFSMetaObject(&models.LFSMetaObject{Oid: object.Oid, Size: object.Size, RepositoryID: repository.ID}) |
||||||
|
|
||||||
|
if err == nil { |
||||||
|
responseObjects = append(responseObjects, Represent(object, meta, meta.Existing, true)) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Resp.Header().Set("Content-Type", metaMediaType) |
||||||
|
|
||||||
|
respobj := &BatchResponse{Objects: responseObjects} |
||||||
|
|
||||||
|
enc := json.NewEncoder(ctx.Resp) |
||||||
|
enc.Encode(respobj) |
||||||
|
logRequest(ctx.Req, 200) |
||||||
|
} |
||||||
|
|
||||||
|
// PutHandler receives data from the client and puts it into the content store
|
||||||
|
func PutHandler(ctx *context.Context) { |
||||||
|
rv := unpack(ctx) |
||||||
|
|
||||||
|
meta, err := models.GetLFSMetaObjectByOid(rv.Oid) |
||||||
|
|
||||||
|
if err != nil { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
repository, err := models.GetRepositoryByID(meta.RepositoryID) |
||||||
|
|
||||||
|
if err != nil { |
||||||
|
writeStatus(ctx, 404) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if !authenticate(ctx, repository, rv.Authorization, true) { |
||||||
|
requireAuth(ctx) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
contentStore := &ContentStore{BasePath: setting.LFS.ContentPath} |
||||||
|
if err := contentStore.Put(meta, ctx.Req.Body().ReadCloser()); err != nil { |
||||||
|
models.RemoveLFSMetaObjectByOid(rv.Oid) |
||||||
|
ctx.Resp.WriteHeader(500) |
||||||
|
fmt.Fprintf(ctx.Resp, `{"message":"%s"}`, err) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
logRequest(ctx.Req, 200) |
||||||
|
} |
||||||
|
|
||||||
|
// Represent takes a RequestVars and Meta and turns it into a Representation suitable
|
||||||
|
// for json encoding
|
||||||
|
func Represent(rv *RequestVars, meta *models.LFSMetaObject, download, upload bool) *Representation { |
||||||
|
rep := &Representation{ |
||||||
|
Oid: meta.Oid, |
||||||
|
Size: meta.Size, |
||||||
|
Actions: make(map[string]*link), |
||||||
|
} |
||||||
|
|
||||||
|
header := make(map[string]string) |
||||||
|
header["Accept"] = contentMediaType |
||||||
|
|
||||||
|
if rv.Authorization == "" { |
||||||
|
//https://github.com/github/git-lfs/issues/1088
|
||||||
|
header["Authorization"] = "Authorization: Basic dummy" |
||||||
|
} else { |
||||||
|
header["Authorization"] = rv.Authorization |
||||||
|
} |
||||||
|
|
||||||
|
if download { |
||||||
|
rep.Actions["download"] = &link{Href: rv.ObjectLink(), Header: header} |
||||||
|
} |
||||||
|
|
||||||
|
if upload { |
||||||
|
rep.Actions["upload"] = &link{Href: rv.ObjectLink(), Header: header} |
||||||
|
} |
||||||
|
|
||||||
|
return rep |
||||||
|
} |
||||||
|
|
||||||
|
// ContentMatcher provides a mux.MatcherFunc that only allows requests that contain
|
||||||
|
// an Accept header with the contentMediaType
|
||||||
|
func ContentMatcher(r macaron.Request) bool { |
||||||
|
mediaParts := strings.Split(r.Header.Get("Accept"), ";") |
||||||
|
mt := mediaParts[0] |
||||||
|
return mt == contentMediaType |
||||||
|
} |
||||||
|
|
||||||
|
// MetaMatcher provides a mux.MatcherFunc that only allows requests that contain
|
||||||
|
// an Accept header with the metaMediaType
|
||||||
|
func MetaMatcher(r macaron.Request) bool { |
||||||
|
mediaParts := strings.Split(r.Header.Get("Accept"), ";") |
||||||
|
mt := mediaParts[0] |
||||||
|
return mt == metaMediaType |
||||||
|
} |
||||||
|
|
||||||
|
func unpack(ctx *context.Context) *RequestVars { |
||||||
|
r := ctx.Req |
||||||
|
rv := &RequestVars{ |
||||||
|
User: ctx.Params("username"), |
||||||
|
Repo: strings.TrimSuffix(ctx.Params("reponame"), ".git"), |
||||||
|
Oid: ctx.Params("oid"), |
||||||
|
Authorization: r.Header.Get("Authorization"), |
||||||
|
} |
||||||
|
|
||||||
|
if r.Method == "POST" { // Maybe also check if +json
|
||||||
|
var p RequestVars |
||||||
|
dec := json.NewDecoder(r.Body().ReadCloser()) |
||||||
|
err := dec.Decode(&p) |
||||||
|
if err != nil { |
||||||
|
return rv |
||||||
|
} |
||||||
|
|
||||||
|
rv.Oid = p.Oid |
||||||
|
rv.Size = p.Size |
||||||
|
} |
||||||
|
|
||||||
|
return rv |
||||||
|
} |
||||||
|
|
||||||
|
// TODO cheap hack, unify with unpack
|
||||||
|
func unpackbatch(ctx *context.Context) *BatchVars { |
||||||
|
|
||||||
|
r := ctx.Req |
||||||
|
var bv BatchVars |
||||||
|
|
||||||
|
dec := json.NewDecoder(r.Body().ReadCloser()) |
||||||
|
err := dec.Decode(&bv) |
||||||
|
if err != nil { |
||||||
|
return &bv |
||||||
|
} |
||||||
|
|
||||||
|
for i := 0; i < len(bv.Objects); i++ { |
||||||
|
bv.Objects[i].User = ctx.Params("username") |
||||||
|
bv.Objects[i].Repo = strings.TrimSuffix(ctx.Params("reponame"), ".git") |
||||||
|
bv.Objects[i].Authorization = r.Header.Get("Authorization") |
||||||
|
} |
||||||
|
|
||||||
|
return &bv |
||||||
|
} |
||||||
|
|
||||||
|
func writeStatus(ctx *context.Context, status int) { |
||||||
|
message := http.StatusText(status) |
||||||
|
|
||||||
|
mediaParts := strings.Split(ctx.Req.Header.Get("Accept"), ";") |
||||||
|
mt := mediaParts[0] |
||||||
|
if strings.HasSuffix(mt, "+json") { |
||||||
|
message = `{"message":"` + message + `"}` |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Resp.WriteHeader(status) |
||||||
|
fmt.Fprint(ctx.Resp, message) |
||||||
|
logRequest(ctx.Req, status) |
||||||
|
} |
||||||
|
|
||||||
|
func logRequest(r macaron.Request, status int) { |
||||||
|
log.Debug("LFS request - Method: %s, URL: %s, Status %d", r.Method, r.URL, status) |
||||||
|
} |
||||||
|
|
||||||
|
// authenticate uses the authorization string to determine whether
|
||||||
|
// or not to proceed. This server assumes an HTTP Basic auth format.
|
||||||
|
func authenticate(ctx *context.Context, repository *models.Repository, authorization string, requireWrite bool) bool { |
||||||
|
|
||||||
|
accessMode := models.AccessModeRead |
||||||
|
if requireWrite { |
||||||
|
accessMode = models.AccessModeWrite |
||||||
|
} |
||||||
|
|
||||||
|
if !repository.IsPrivate && !requireWrite { |
||||||
|
return true |
||||||
|
} |
||||||
|
|
||||||
|
if ctx.IsSigned { |
||||||
|
accessCheck, _ := models.HasAccess(ctx.User, repository, accessMode) |
||||||
|
return accessCheck |
||||||
|
} |
||||||
|
|
||||||
|
if authorization == "" { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
if authenticateToken(repository, authorization, requireWrite) { |
||||||
|
return true |
||||||
|
} |
||||||
|
|
||||||
|
if !strings.HasPrefix(authorization, "Basic ") { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
c, err := base64.StdEncoding.DecodeString(strings.TrimPrefix(authorization, "Basic ")) |
||||||
|
if err != nil { |
||||||
|
return false |
||||||
|
} |
||||||
|
cs := string(c) |
||||||
|
i := strings.IndexByte(cs, ':') |
||||||
|
if i < 0 { |
||||||
|
return false |
||||||
|
} |
||||||
|
user, password := cs[:i], cs[i+1:] |
||||||
|
|
||||||
|
userModel, err := models.GetUserByName(user) |
||||||
|
if err != nil { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
if !userModel.ValidatePassword(password) { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
accessCheck, _ := models.HasAccess(userModel, repository, accessMode) |
||||||
|
return accessCheck |
||||||
|
} |
||||||
|
|
||||||
|
func authenticateToken(repository *models.Repository, authorization string, requireWrite bool) bool { |
||||||
|
if !strings.HasPrefix(authorization, "Bearer ") { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
token, err := jwt.Parse(authorization[7:], func(t *jwt.Token) (interface{}, error) { |
||||||
|
if _, ok := t.Method.(*jwt.SigningMethodHMAC); !ok { |
||||||
|
return nil, fmt.Errorf("unexpected signing method: %v", t.Header["alg"]) |
||||||
|
} |
||||||
|
return setting.LFS.JWTSecretBytes, nil |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
return false |
||||||
|
} |
||||||
|
claims, claimsOk := token.Claims.(jwt.MapClaims) |
||||||
|
if !token.Valid || !claimsOk { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
opStr, ok := claims["op"].(string) |
||||||
|
if !ok { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
if requireWrite && opStr != "upload" { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
repoID, ok := claims["repo"].(float64) |
||||||
|
if !ok { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
if repository.ID != int64(repoID) { |
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
return true |
||||||
|
} |
||||||
|
|
||||||
|
func requireAuth(ctx *context.Context) { |
||||||
|
ctx.Resp.Header().Set("WWW-Authenticate", "Basic realm=gitea-lfs") |
||||||
|
writeStatus(ctx, 401) |
||||||
|
} |
||||||
@ -0,0 +1,8 @@ |
|||||||
|
Copyright (c) 2012 Dave Grijalva |
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: |
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. |
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||||
|
|
||||||
@ -0,0 +1,97 @@ |
|||||||
|
## Migration Guide from v2 -> v3 |
||||||
|
|
||||||
|
Version 3 adds several new, frequently requested features. To do so, it introduces a few breaking changes. We've worked to keep these as minimal as possible. This guide explains the breaking changes and how you can quickly update your code. |
||||||
|
|
||||||
|
### `Token.Claims` is now an interface type |
||||||
|
|
||||||
|
The most requested feature from the 2.0 verison of this library was the ability to provide a custom type to the JSON parser for claims. This was implemented by introducing a new interface, `Claims`, to replace `map[string]interface{}`. We also included two concrete implementations of `Claims`: `MapClaims` and `StandardClaims`. |
||||||
|
|
||||||
|
`MapClaims` is an alias for `map[string]interface{}` with built in validation behavior. It is the default claims type when using `Parse`. The usage is unchanged except you must type cast the claims property. |
||||||
|
|
||||||
|
The old example for parsing a token looked like this.. |
||||||
|
|
||||||
|
```go |
||||||
|
if token, err := jwt.Parse(tokenString, keyLookupFunc); err == nil { |
||||||
|
fmt.Printf("Token for user %v expires %v", token.Claims["user"], token.Claims["exp"]) |
||||||
|
} |
||||||
|
``` |
||||||
|
|
||||||
|
is now directly mapped to... |
||||||
|
|
||||||
|
```go |
||||||
|
if token, err := jwt.Parse(tokenString, keyLookupFunc); err == nil { |
||||||
|
claims := token.Claims.(jwt.MapClaims) |
||||||
|
fmt.Printf("Token for user %v expires %v", claims["user"], claims["exp"]) |
||||||
|
} |
||||||
|
``` |
||||||
|
|
||||||
|
`StandardClaims` is designed to be embedded in your custom type. You can supply a custom claims type with the new `ParseWithClaims` function. Here's an example of using a custom claims type. |
||||||
|
|
||||||
|
```go |
||||||
|
type MyCustomClaims struct { |
||||||
|
User string |
||||||
|
*StandardClaims |
||||||
|
} |
||||||
|
|
||||||
|
if token, err := jwt.ParseWithClaims(tokenString, &MyCustomClaims{}, keyLookupFunc); err == nil { |
||||||
|
claims := token.Claims.(*MyCustomClaims) |
||||||
|
fmt.Printf("Token for user %v expires %v", claims.User, claims.StandardClaims.ExpiresAt) |
||||||
|
} |
||||||
|
``` |
||||||
|
|
||||||
|
### `ParseFromRequest` has been moved |
||||||
|
|
||||||
|
To keep this library focused on the tokens without becoming overburdened with complex request processing logic, `ParseFromRequest` and its new companion `ParseFromRequestWithClaims` have been moved to a subpackage, `request`. The method signatues have also been augmented to receive a new argument: `Extractor`. |
||||||
|
|
||||||
|
`Extractors` do the work of picking the token string out of a request. The interface is simple and composable. |
||||||
|
|
||||||
|
This simple parsing example: |
||||||
|
|
||||||
|
```go |
||||||
|
if token, err := jwt.ParseFromRequest(tokenString, req, keyLookupFunc); err == nil { |
||||||
|
fmt.Printf("Token for user %v expires %v", token.Claims["user"], token.Claims["exp"]) |
||||||
|
} |
||||||
|
``` |
||||||
|
|
||||||
|
is directly mapped to: |
||||||
|
|
||||||
|
```go |
||||||
|
if token, err := request.ParseFromRequest(req, request.OAuth2Extractor, keyLookupFunc); err == nil { |
||||||
|
claims := token.Claims.(jwt.MapClaims) |
||||||
|
fmt.Printf("Token for user %v expires %v", claims["user"], claims["exp"]) |
||||||
|
} |
||||||
|
``` |
||||||
|
|
||||||
|
There are several concrete `Extractor` types provided for your convenience: |
||||||
|
|
||||||
|
* `HeaderExtractor` will search a list of headers until one contains content. |
||||||
|
* `ArgumentExtractor` will search a list of keys in request query and form arguments until one contains content. |
||||||
|
* `MultiExtractor` will try a list of `Extractors` in order until one returns content. |
||||||
|
* `AuthorizationHeaderExtractor` will look in the `Authorization` header for a `Bearer` token. |
||||||
|
* `OAuth2Extractor` searches the places an OAuth2 token would be specified (per the spec): `Authorization` header and `access_token` argument |
||||||
|
* `PostExtractionFilter` wraps an `Extractor`, allowing you to process the content before it's parsed. A simple example is stripping the `Bearer ` text from a header |
||||||
|
|
||||||
|
|
||||||
|
### RSA signing methods no longer accept `[]byte` keys |
||||||
|
|
||||||
|
Due to a [critical vulnerability](https://auth0.com/blog/2015/03/31/critical-vulnerabilities-in-json-web-token-libraries/), we've decided the convenience of accepting `[]byte` instead of `rsa.PublicKey` or `rsa.PrivateKey` isn't worth the risk of misuse. |
||||||
|
|
||||||
|
To replace this behavior, we've added two helper methods: `ParseRSAPrivateKeyFromPEM(key []byte) (*rsa.PrivateKey, error)` and `ParseRSAPublicKeyFromPEM(key []byte) (*rsa.PublicKey, error)`. These are just simple helpers for unpacking PEM encoded PKCS1 and PKCS8 keys. If your keys are encoded any other way, all you need to do is convert them to the `crypto/rsa` package's types. |
||||||
|
|
||||||
|
```go |
||||||
|
func keyLookupFunc(*Token) (interface{}, error) { |
||||||
|
// Don't forget to validate the alg is what you expect: |
||||||
|
if _, ok := token.Method.(*jwt.SigningMethodRSA); !ok { |
||||||
|
return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"]) |
||||||
|
} |
||||||
|
|
||||||
|
// Look up key |
||||||
|
key, err := lookupPublicKey(token.Header["kid"]) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
// Unpack key from PEM encoded PKCS8 |
||||||
|
return jwt.ParseRSAPublicKeyFromPEM(key) |
||||||
|
} |
||||||
|
``` |
||||||
@ -0,0 +1,85 @@ |
|||||||
|
A [go](http://www.golang.org) (or 'golang' for search engine friendliness) implementation of [JSON Web Tokens](http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html) |
||||||
|
|
||||||
|
[](https://travis-ci.org/dgrijalva/jwt-go) |
||||||
|
|
||||||
|
**BREAKING CHANGES:*** Version 3.0.0 is here. It includes _a lot_ of changes including a few that break the API. We've tried to break as few things as possible, so there should just be a few type signature changes. A full list of breaking changes is available in `VERSION_HISTORY.md`. See `MIGRATION_GUIDE.md` for more information on updating your code. |
||||||
|
|
||||||
|
**NOTICE:** A vulnerability in JWT was [recently published](https://auth0.com/blog/2015/03/31/critical-vulnerabilities-in-json-web-token-libraries/). As this library doesn't force users to validate the `alg` is what they expected, it's possible your usage is effected. There will be an update soon to remedy this, and it will likey require backwards-incompatible changes to the API. In the short term, please make sure your implementation verifies the `alg` is what you expect. |
||||||
|
|
||||||
|
|
||||||
|
## What the heck is a JWT? |
||||||
|
|
||||||
|
JWT.io has [a great introduction](https://jwt.io/introduction) to JSON Web Tokens. |
||||||
|
|
||||||
|
In short, it's a signed JSON object that does something useful (for example, authentication). It's commonly used for `Bearer` tokens in Oauth 2. A token is made of three parts, separated by `.`'s. The first two parts are JSON objects, that have been [base64url](http://tools.ietf.org/html/rfc4648) encoded. The last part is the signature, encoded the same way. |
||||||
|
|
||||||
|
The first part is called the header. It contains the necessary information for verifying the last part, the signature. For example, which encryption method was used for signing and what key was used. |
||||||
|
|
||||||
|
The part in the middle is the interesting bit. It's called the Claims and contains the actual stuff you care about. Refer to [the RFC](http://self-issued.info/docs/draft-jones-json-web-token.html) for information about reserved keys and the proper way to add your own. |
||||||
|
|
||||||
|
## What's in the box? |
||||||
|
|
||||||
|
This library supports the parsing and verification as well as the generation and signing of JWTs. Current supported signing algorithms are HMAC SHA, RSA, RSA-PSS, and ECDSA, though hooks are present for adding your own. |
||||||
|
|
||||||
|
## Examples |
||||||
|
|
||||||
|
See [the project documentation](https://godoc.org/github.com/dgrijalva/jwt-go) for examples of usage: |
||||||
|
|
||||||
|
* [Simple example of parsing and validating a token](https://godoc.org/github.com/dgrijalva/jwt-go#example-Parse--Hmac) |
||||||
|
* [Simple example of building and signing a token](https://godoc.org/github.com/dgrijalva/jwt-go#example-New--Hmac) |
||||||
|
* [Directory of Examples](https://godoc.org/github.com/dgrijalva/jwt-go#pkg-examples) |
||||||
|
|
||||||
|
## Extensions |
||||||
|
|
||||||
|
This library publishes all the necessary components for adding your own signing methods. Simply implement the `SigningMethod` interface and register a factory method using `RegisterSigningMethod`. |
||||||
|
|
||||||
|
Here's an example of an extension that integrates with the Google App Engine signing tools: https://github.com/someone1/gcp-jwt-go |
||||||
|
|
||||||
|
## Compliance |
||||||
|
|
||||||
|
This library was last reviewed to comply with [RTF 7519](http://www.rfc-editor.org/info/rfc7519) dated May 2015 with a few notable differences: |
||||||
|
|
||||||
|
* In order to protect against accidental use of [Unsecured JWTs](http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#UnsecuredJWT), tokens using `alg=none` will only be accepted if the constant `jwt.UnsafeAllowNoneSignatureType` is provided as the key. |
||||||
|
|
||||||
|
## Project Status & Versioning |
||||||
|
|
||||||
|
This library is considered production ready. Feedback and feature requests are appreciated. The API should be considered stable. There should be very few backwards-incompatible changes outside of major version updates (and only with good reason). |
||||||
|
|
||||||
|
This project uses [Semantic Versioning 2.0.0](http://semver.org). Accepted pull requests will land on `master`. Periodically, versions will be tagged from `master`. You can find all the releases on [the project releases page](https://github.com/dgrijalva/jwt-go/releases). |
||||||
|
|
||||||
|
While we try to make it obvious when we make breaking changes, there isn't a great mechanism for pushing announcements out to users. You may want to use this alternative package include: `gopkg.in/dgrijalva/jwt-go.v2`. It will do the right thing WRT semantic versioning. |
||||||
|
|
||||||
|
## Usage Tips |
||||||
|
|
||||||
|
### Signing vs Encryption |
||||||
|
|
||||||
|
A token is simply a JSON object that is signed by its author. this tells you exactly two things about the data: |
||||||
|
|
||||||
|
* The author of the token was in the possession of the signing secret |
||||||
|
* The data has not been modified since it was signed |
||||||
|
|
||||||
|
It's important to know that JWT does not provide encryption, which means anyone who has access to the token can read its contents. If you need to protect (encrypt) the data, there is a companion spec, `JWE`, that provides this functionality. JWE is currently outside the scope of this library. |
||||||
|
|
||||||
|
### Choosing a Signing Method |
||||||
|
|
||||||
|
There are several signing methods available, and you should probably take the time to learn about the various options before choosing one. The principal design decision is most likely going to be symmetric vs asymmetric. |
||||||
|
|
||||||
|
Symmetric signing methods, such as HSA, use only a single secret. This is probably the simplest signing method to use since any `[]byte` can be used as a valid secret. They are also slightly computationally faster to use, though this rarely is enough to matter. Symmetric signing methods work the best when both producers and consumers of tokens are trusted, or even the same system. Since the same secret is used to both sign and validate tokens, you can't easily distribute the key for validation. |
||||||
|
|
||||||
|
Asymmetric signing methods, such as RSA, use different keys for signing and verifying tokens. This makes it possible to produce tokens with a private key, and allow any consumer to access the public key for verification. |
||||||
|
|
||||||
|
### JWT and OAuth |
||||||
|
|
||||||
|
It's worth mentioning that OAuth and JWT are not the same thing. A JWT token is simply a signed JSON object. It can be used anywhere such a thing is useful. There is some confusion, though, as JWT is the most common type of bearer token used in OAuth2 authentication. |
||||||
|
|
||||||
|
Without going too far down the rabbit hole, here's a description of the interaction of these technologies: |
||||||
|
|
||||||
|
* OAuth is a protocol for allowing an identity provider to be separate from the service a user is logging in to. For example, whenever you use Facebook to log into a different service (Yelp, Spotify, etc), you are using OAuth. |
||||||
|
* OAuth defines several options for passing around authentication data. One popular method is called a "bearer token". A bearer token is simply a string that _should_ only be held by an authenticated user. Thus, simply presenting this token proves your identity. You can probably derive from here why a JWT might make a good bearer token. |
||||||
|
* Because bearer tokens are used for authentication, it's important they're kept secret. This is why transactions that use bearer tokens typically happen over SSL. |
||||||
|
|
||||||
|
## More |
||||||
|
|
||||||
|
Documentation can be found [on godoc.org](http://godoc.org/github.com/dgrijalva/jwt-go). |
||||||
|
|
||||||
|
The command line utility included in this project (cmd/jwt) provides a straightforward example of token creation and parsing as well as a useful tool for debugging your own integration. You'll also find several implementation examples in to documentation. |
||||||
@ -0,0 +1,105 @@ |
|||||||
|
## `jwt-go` Version History |
||||||
|
|
||||||
|
#### 3.0.0 |
||||||
|
|
||||||
|
* **Compatibility Breaking Changes**: See MIGRATION_GUIDE.md for tips on updating your code |
||||||
|
* Dropped support for `[]byte` keys when using RSA signing methods. This convenience feature could contribute to security vulnerabilities involving mismatched key types with signing methods. |
||||||
|
* `ParseFromRequest` has been moved to `request` subpackage and usage has changed |
||||||
|
* The `Claims` property on `Token` is now type `Claims` instead of `map[string]interface{}`. The default value is type `MapClaims`, which is an alias to `map[string]interface{}`. This makes it possible to use a custom type when decoding claims. |
||||||
|
* Other Additions and Changes |
||||||
|
* Added `Claims` interface type to allow users to decode the claims into a custom type |
||||||
|
* Added `ParseWithClaims`, which takes a third argument of type `Claims`. Use this function instead of `Parse` if you have a custom type you'd like to decode into. |
||||||
|
* Dramatically improved the functionality and flexibility of `ParseFromRequest`, which is now in the `request` subpackage |
||||||
|
* Added `ParseFromRequestWithClaims` which is the `FromRequest` equivalent of `ParseWithClaims` |
||||||
|
* Added new interface type `Extractor`, which is used for extracting JWT strings from http requests. Used with `ParseFromRequest` and `ParseFromRequestWithClaims`. |
||||||
|
* Added several new, more specific, validation errors to error type bitmask |
||||||
|
* Moved examples from README to executable example files |
||||||
|
* Signing method registry is now thread safe |
||||||
|
* Added new property to `ValidationError`, which contains the raw error returned by calls made by parse/verify (such as those returned by keyfunc or json parser) |
||||||
|
|
||||||
|
#### 2.7.0 |
||||||
|
|
||||||
|
This will likely be the last backwards compatible release before 3.0.0, excluding essential bug fixes. |
||||||
|
|
||||||
|
* Added new option `-show` to the `jwt` command that will just output the decoded token without verifying |
||||||
|
* Error text for expired tokens includes how long it's been expired |
||||||
|
* Fixed incorrect error returned from `ParseRSAPublicKeyFromPEM` |
||||||
|
* Documentation updates |
||||||
|
|
||||||
|
#### 2.6.0 |
||||||
|
|
||||||
|
* Exposed inner error within ValidationError |
||||||
|
* Fixed validation errors when using UseJSONNumber flag |
||||||
|
* Added several unit tests |
||||||
|
|
||||||
|
#### 2.5.0 |
||||||
|
|
||||||
|
* Added support for signing method none. You shouldn't use this. The API tries to make this clear. |
||||||
|
* Updated/fixed some documentation |
||||||
|
* Added more helpful error message when trying to parse tokens that begin with `BEARER ` |
||||||
|
|
||||||
|
#### 2.4.0 |
||||||
|
|
||||||
|
* Added new type, Parser, to allow for configuration of various parsing parameters |
||||||
|
* You can now specify a list of valid signing methods. Anything outside this set will be rejected. |
||||||
|
* You can now opt to use the `json.Number` type instead of `float64` when parsing token JSON |
||||||
|
* Added support for [Travis CI](https://travis-ci.org/dgrijalva/jwt-go) |
||||||
|
* Fixed some bugs with ECDSA parsing |
||||||
|
|
||||||
|
#### 2.3.0 |
||||||
|
|
||||||
|
* Added support for ECDSA signing methods |
||||||
|
* Added support for RSA PSS signing methods (requires go v1.4) |
||||||
|
|
||||||
|
#### 2.2.0 |
||||||
|
|
||||||
|
* Gracefully handle a `nil` `Keyfunc` being passed to `Parse`. Result will now be the parsed token and an error, instead of a panic. |
||||||
|
|
||||||
|
#### 2.1.0 |
||||||
|
|
||||||
|
Backwards compatible API change that was missed in 2.0.0. |
||||||
|
|
||||||
|
* The `SignedString` method on `Token` now takes `interface{}` instead of `[]byte` |
||||||
|
|
||||||
|
#### 2.0.0 |
||||||
|
|
||||||
|
There were two major reasons for breaking backwards compatibility with this update. The first was a refactor required to expand the width of the RSA and HMAC-SHA signing implementations. There will likely be no required code changes to support this change. |
||||||
|
|
||||||
|
The second update, while unfortunately requiring a small change in integration, is required to open up this library to other signing methods. Not all keys used for all signing methods have a single standard on-disk representation. Requiring `[]byte` as the type for all keys proved too limiting. Additionally, this implementation allows for pre-parsed tokens to be reused, which might matter in an application that parses a high volume of tokens with a small set of keys. Backwards compatibilty has been maintained for passing `[]byte` to the RSA signing methods, but they will also accept `*rsa.PublicKey` and `*rsa.PrivateKey`. |
||||||
|
|
||||||
|
It is likely the only integration change required here will be to change `func(t *jwt.Token) ([]byte, error)` to `func(t *jwt.Token) (interface{}, error)` when calling `Parse`. |
||||||
|
|
||||||
|
* **Compatibility Breaking Changes** |
||||||
|
* `SigningMethodHS256` is now `*SigningMethodHMAC` instead of `type struct` |
||||||
|
* `SigningMethodRS256` is now `*SigningMethodRSA` instead of `type struct` |
||||||
|
* `KeyFunc` now returns `interface{}` instead of `[]byte` |
||||||
|
* `SigningMethod.Sign` now takes `interface{}` instead of `[]byte` for the key |
||||||
|
* `SigningMethod.Verify` now takes `interface{}` instead of `[]byte` for the key |
||||||
|
* Renamed type `SigningMethodHS256` to `SigningMethodHMAC`. Specific sizes are now just instances of this type. |
||||||
|
* Added public package global `SigningMethodHS256` |
||||||
|
* Added public package global `SigningMethodHS384` |
||||||
|
* Added public package global `SigningMethodHS512` |
||||||
|
* Renamed type `SigningMethodRS256` to `SigningMethodRSA`. Specific sizes are now just instances of this type. |
||||||
|
* Added public package global `SigningMethodRS256` |
||||||
|
* Added public package global `SigningMethodRS384` |
||||||
|
* Added public package global `SigningMethodRS512` |
||||||
|
* Moved sample private key for HMAC tests from an inline value to a file on disk. Value is unchanged. |
||||||
|
* Refactored the RSA implementation to be easier to read |
||||||
|
* Exposed helper methods `ParseRSAPrivateKeyFromPEM` and `ParseRSAPublicKeyFromPEM` |
||||||
|
|
||||||
|
#### 1.0.2 |
||||||
|
|
||||||
|
* Fixed bug in parsing public keys from certificates |
||||||
|
* Added more tests around the parsing of keys for RS256 |
||||||
|
* Code refactoring in RS256 implementation. No functional changes |
||||||
|
|
||||||
|
#### 1.0.1 |
||||||
|
|
||||||
|
* Fixed panic if RS256 signing method was passed an invalid key |
||||||
|
|
||||||
|
#### 1.0.0 |
||||||
|
|
||||||
|
* First versioned release |
||||||
|
* API stabilized |
||||||
|
* Supports creating, signing, parsing, and validating JWT tokens |
||||||
|
* Supports RS256 and HS256 signing methods |
||||||
@ -0,0 +1,134 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto/subtle" |
||||||
|
"fmt" |
||||||
|
"time" |
||||||
|
) |
||||||
|
|
||||||
|
// For a type to be a Claims object, it must just have a Valid method that determines
|
||||||
|
// if the token is invalid for any supported reason
|
||||||
|
type Claims interface { |
||||||
|
Valid() error |
||||||
|
} |
||||||
|
|
||||||
|
// Structured version of Claims Section, as referenced at
|
||||||
|
// https://tools.ietf.org/html/rfc7519#section-4.1
|
||||||
|
// See examples for how to use this with your own claim types
|
||||||
|
type StandardClaims struct { |
||||||
|
Audience string `json:"aud,omitempty"` |
||||||
|
ExpiresAt int64 `json:"exp,omitempty"` |
||||||
|
Id string `json:"jti,omitempty"` |
||||||
|
IssuedAt int64 `json:"iat,omitempty"` |
||||||
|
Issuer string `json:"iss,omitempty"` |
||||||
|
NotBefore int64 `json:"nbf,omitempty"` |
||||||
|
Subject string `json:"sub,omitempty"` |
||||||
|
} |
||||||
|
|
||||||
|
// Validates time based claims "exp, iat, nbf".
|
||||||
|
// There is no accounting for clock skew.
|
||||||
|
// As well, if any of the above claims are not in the token, it will still
|
||||||
|
// be considered a valid claim.
|
||||||
|
func (c StandardClaims) Valid() error { |
||||||
|
vErr := new(ValidationError) |
||||||
|
now := TimeFunc().Unix() |
||||||
|
|
||||||
|
// The claims below are optional, by default, so if they are set to the
|
||||||
|
// default value in Go, let's not fail the verification for them.
|
||||||
|
if c.VerifyExpiresAt(now, false) == false { |
||||||
|
delta := time.Unix(now, 0).Sub(time.Unix(c.ExpiresAt, 0)) |
||||||
|
vErr.Inner = fmt.Errorf("token is expired by %v", delta) |
||||||
|
vErr.Errors |= ValidationErrorExpired |
||||||
|
} |
||||||
|
|
||||||
|
if c.VerifyIssuedAt(now, false) == false { |
||||||
|
vErr.Inner = fmt.Errorf("Token used before issued") |
||||||
|
vErr.Errors |= ValidationErrorIssuedAt |
||||||
|
} |
||||||
|
|
||||||
|
if c.VerifyNotBefore(now, false) == false { |
||||||
|
vErr.Inner = fmt.Errorf("token is not valid yet") |
||||||
|
vErr.Errors |= ValidationErrorNotValidYet |
||||||
|
} |
||||||
|
|
||||||
|
if vErr.valid() { |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
return vErr |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the aud claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (c *StandardClaims) VerifyAudience(cmp string, req bool) bool { |
||||||
|
return verifyAud(c.Audience, cmp, req) |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the exp claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (c *StandardClaims) VerifyExpiresAt(cmp int64, req bool) bool { |
||||||
|
return verifyExp(c.ExpiresAt, cmp, req) |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the iat claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (c *StandardClaims) VerifyIssuedAt(cmp int64, req bool) bool { |
||||||
|
return verifyIat(c.IssuedAt, cmp, req) |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the iss claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (c *StandardClaims) VerifyIssuer(cmp string, req bool) bool { |
||||||
|
return verifyIss(c.Issuer, cmp, req) |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the nbf claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (c *StandardClaims) VerifyNotBefore(cmp int64, req bool) bool { |
||||||
|
return verifyNbf(c.NotBefore, cmp, req) |
||||||
|
} |
||||||
|
|
||||||
|
// ----- helpers
|
||||||
|
|
||||||
|
func verifyAud(aud string, cmp string, required bool) bool { |
||||||
|
if aud == "" { |
||||||
|
return !required |
||||||
|
} |
||||||
|
if subtle.ConstantTimeCompare([]byte(aud), []byte(cmp)) != 0 { |
||||||
|
return true |
||||||
|
} else { |
||||||
|
return false |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
func verifyExp(exp int64, now int64, required bool) bool { |
||||||
|
if exp == 0 { |
||||||
|
return !required |
||||||
|
} |
||||||
|
return now <= exp |
||||||
|
} |
||||||
|
|
||||||
|
func verifyIat(iat int64, now int64, required bool) bool { |
||||||
|
if iat == 0 { |
||||||
|
return !required |
||||||
|
} |
||||||
|
return now >= iat |
||||||
|
} |
||||||
|
|
||||||
|
func verifyIss(iss string, cmp string, required bool) bool { |
||||||
|
if iss == "" { |
||||||
|
return !required |
||||||
|
} |
||||||
|
if subtle.ConstantTimeCompare([]byte(iss), []byte(cmp)) != 0 { |
||||||
|
return true |
||||||
|
} else { |
||||||
|
return false |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
func verifyNbf(nbf int64, now int64, required bool) bool { |
||||||
|
if nbf == 0 { |
||||||
|
return !required |
||||||
|
} |
||||||
|
return now >= nbf |
||||||
|
} |
||||||
@ -0,0 +1,4 @@ |
|||||||
|
// Package jwt is a Go implementation of JSON Web Tokens: http://self-issued.info/docs/draft-jones-json-web-token.html
|
||||||
|
//
|
||||||
|
// See README.md for more info.
|
||||||
|
package jwt |
||||||
@ -0,0 +1,147 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto" |
||||||
|
"crypto/ecdsa" |
||||||
|
"crypto/rand" |
||||||
|
"errors" |
||||||
|
"math/big" |
||||||
|
) |
||||||
|
|
||||||
|
var ( |
||||||
|
// Sadly this is missing from crypto/ecdsa compared to crypto/rsa
|
||||||
|
ErrECDSAVerification = errors.New("crypto/ecdsa: verification error") |
||||||
|
) |
||||||
|
|
||||||
|
// Implements the ECDSA family of signing methods signing methods
|
||||||
|
type SigningMethodECDSA struct { |
||||||
|
Name string |
||||||
|
Hash crypto.Hash |
||||||
|
KeySize int |
||||||
|
CurveBits int |
||||||
|
} |
||||||
|
|
||||||
|
// Specific instances for EC256 and company
|
||||||
|
var ( |
||||||
|
SigningMethodES256 *SigningMethodECDSA |
||||||
|
SigningMethodES384 *SigningMethodECDSA |
||||||
|
SigningMethodES512 *SigningMethodECDSA |
||||||
|
) |
||||||
|
|
||||||
|
func init() { |
||||||
|
// ES256
|
||||||
|
SigningMethodES256 = &SigningMethodECDSA{"ES256", crypto.SHA256, 32, 256} |
||||||
|
RegisterSigningMethod(SigningMethodES256.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodES256 |
||||||
|
}) |
||||||
|
|
||||||
|
// ES384
|
||||||
|
SigningMethodES384 = &SigningMethodECDSA{"ES384", crypto.SHA384, 48, 384} |
||||||
|
RegisterSigningMethod(SigningMethodES384.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodES384 |
||||||
|
}) |
||||||
|
|
||||||
|
// ES512
|
||||||
|
SigningMethodES512 = &SigningMethodECDSA{"ES512", crypto.SHA512, 66, 521} |
||||||
|
RegisterSigningMethod(SigningMethodES512.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodES512 |
||||||
|
}) |
||||||
|
} |
||||||
|
|
||||||
|
func (m *SigningMethodECDSA) Alg() string { |
||||||
|
return m.Name |
||||||
|
} |
||||||
|
|
||||||
|
// Implements the Verify method from SigningMethod
|
||||||
|
// For this verify method, key must be an ecdsa.PublicKey struct
|
||||||
|
func (m *SigningMethodECDSA) Verify(signingString, signature string, key interface{}) error { |
||||||
|
var err error |
||||||
|
|
||||||
|
// Decode the signature
|
||||||
|
var sig []byte |
||||||
|
if sig, err = DecodeSegment(signature); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
// Get the key
|
||||||
|
var ecdsaKey *ecdsa.PublicKey |
||||||
|
switch k := key.(type) { |
||||||
|
case *ecdsa.PublicKey: |
||||||
|
ecdsaKey = k |
||||||
|
default: |
||||||
|
return ErrInvalidKeyType |
||||||
|
} |
||||||
|
|
||||||
|
if len(sig) != 2*m.KeySize { |
||||||
|
return ErrECDSAVerification |
||||||
|
} |
||||||
|
|
||||||
|
r := big.NewInt(0).SetBytes(sig[:m.KeySize]) |
||||||
|
s := big.NewInt(0).SetBytes(sig[m.KeySize:]) |
||||||
|
|
||||||
|
// Create hasher
|
||||||
|
if !m.Hash.Available() { |
||||||
|
return ErrHashUnavailable |
||||||
|
} |
||||||
|
hasher := m.Hash.New() |
||||||
|
hasher.Write([]byte(signingString)) |
||||||
|
|
||||||
|
// Verify the signature
|
||||||
|
if verifystatus := ecdsa.Verify(ecdsaKey, hasher.Sum(nil), r, s); verifystatus == true { |
||||||
|
return nil |
||||||
|
} else { |
||||||
|
return ErrECDSAVerification |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Implements the Sign method from SigningMethod
|
||||||
|
// For this signing method, key must be an ecdsa.PrivateKey struct
|
||||||
|
func (m *SigningMethodECDSA) Sign(signingString string, key interface{}) (string, error) { |
||||||
|
// Get the key
|
||||||
|
var ecdsaKey *ecdsa.PrivateKey |
||||||
|
switch k := key.(type) { |
||||||
|
case *ecdsa.PrivateKey: |
||||||
|
ecdsaKey = k |
||||||
|
default: |
||||||
|
return "", ErrInvalidKeyType |
||||||
|
} |
||||||
|
|
||||||
|
// Create the hasher
|
||||||
|
if !m.Hash.Available() { |
||||||
|
return "", ErrHashUnavailable |
||||||
|
} |
||||||
|
|
||||||
|
hasher := m.Hash.New() |
||||||
|
hasher.Write([]byte(signingString)) |
||||||
|
|
||||||
|
// Sign the string and return r, s
|
||||||
|
if r, s, err := ecdsa.Sign(rand.Reader, ecdsaKey, hasher.Sum(nil)); err == nil { |
||||||
|
curveBits := ecdsaKey.Curve.Params().BitSize |
||||||
|
|
||||||
|
if m.CurveBits != curveBits { |
||||||
|
return "", ErrInvalidKey |
||||||
|
} |
||||||
|
|
||||||
|
keyBytes := curveBits / 8 |
||||||
|
if curveBits%8 > 0 { |
||||||
|
keyBytes += 1 |
||||||
|
} |
||||||
|
|
||||||
|
// We serialize the outpus (r and s) into big-endian byte arrays and pad
|
||||||
|
// them with zeros on the left to make sure the sizes work out. Both arrays
|
||||||
|
// must be keyBytes long, and the output must be 2*keyBytes long.
|
||||||
|
rBytes := r.Bytes() |
||||||
|
rBytesPadded := make([]byte, keyBytes) |
||||||
|
copy(rBytesPadded[keyBytes-len(rBytes):], rBytes) |
||||||
|
|
||||||
|
sBytes := s.Bytes() |
||||||
|
sBytesPadded := make([]byte, keyBytes) |
||||||
|
copy(sBytesPadded[keyBytes-len(sBytes):], sBytes) |
||||||
|
|
||||||
|
out := append(rBytesPadded, sBytesPadded...) |
||||||
|
|
||||||
|
return EncodeSegment(out), nil |
||||||
|
} else { |
||||||
|
return "", err |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,67 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto/ecdsa" |
||||||
|
"crypto/x509" |
||||||
|
"encoding/pem" |
||||||
|
"errors" |
||||||
|
) |
||||||
|
|
||||||
|
var ( |
||||||
|
ErrNotECPublicKey = errors.New("Key is not a valid ECDSA public key") |
||||||
|
ErrNotECPrivateKey = errors.New("Key is not a valid ECDSA private key") |
||||||
|
) |
||||||
|
|
||||||
|
// Parse PEM encoded Elliptic Curve Private Key Structure
|
||||||
|
func ParseECPrivateKeyFromPEM(key []byte) (*ecdsa.PrivateKey, error) { |
||||||
|
var err error |
||||||
|
|
||||||
|
// Parse PEM block
|
||||||
|
var block *pem.Block |
||||||
|
if block, _ = pem.Decode(key); block == nil { |
||||||
|
return nil, ErrKeyMustBePEMEncoded |
||||||
|
} |
||||||
|
|
||||||
|
// Parse the key
|
||||||
|
var parsedKey interface{} |
||||||
|
if parsedKey, err = x509.ParseECPrivateKey(block.Bytes); err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
var pkey *ecdsa.PrivateKey |
||||||
|
var ok bool |
||||||
|
if pkey, ok = parsedKey.(*ecdsa.PrivateKey); !ok { |
||||||
|
return nil, ErrNotECPrivateKey |
||||||
|
} |
||||||
|
|
||||||
|
return pkey, nil |
||||||
|
} |
||||||
|
|
||||||
|
// Parse PEM encoded PKCS1 or PKCS8 public key
|
||||||
|
func ParseECPublicKeyFromPEM(key []byte) (*ecdsa.PublicKey, error) { |
||||||
|
var err error |
||||||
|
|
||||||
|
// Parse PEM block
|
||||||
|
var block *pem.Block |
||||||
|
if block, _ = pem.Decode(key); block == nil { |
||||||
|
return nil, ErrKeyMustBePEMEncoded |
||||||
|
} |
||||||
|
|
||||||
|
// Parse the key
|
||||||
|
var parsedKey interface{} |
||||||
|
if parsedKey, err = x509.ParsePKIXPublicKey(block.Bytes); err != nil { |
||||||
|
if cert, err := x509.ParseCertificate(block.Bytes); err == nil { |
||||||
|
parsedKey = cert.PublicKey |
||||||
|
} else { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
var pkey *ecdsa.PublicKey |
||||||
|
var ok bool |
||||||
|
if pkey, ok = parsedKey.(*ecdsa.PublicKey); !ok { |
||||||
|
return nil, ErrNotECPublicKey |
||||||
|
} |
||||||
|
|
||||||
|
return pkey, nil |
||||||
|
} |
||||||
@ -0,0 +1,59 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"errors" |
||||||
|
) |
||||||
|
|
||||||
|
// Error constants
|
||||||
|
var ( |
||||||
|
ErrInvalidKey = errors.New("key is invalid") |
||||||
|
ErrInvalidKeyType = errors.New("key is of invalid type") |
||||||
|
ErrHashUnavailable = errors.New("the requested hash function is unavailable") |
||||||
|
) |
||||||
|
|
||||||
|
// The errors that might occur when parsing and validating a token
|
||||||
|
const ( |
||||||
|
ValidationErrorMalformed uint32 = 1 << iota // Token is malformed
|
||||||
|
ValidationErrorUnverifiable // Token could not be verified because of signing problems
|
||||||
|
ValidationErrorSignatureInvalid // Signature validation failed
|
||||||
|
|
||||||
|
// Standard Claim validation errors
|
||||||
|
ValidationErrorAudience // AUD validation failed
|
||||||
|
ValidationErrorExpired // EXP validation failed
|
||||||
|
ValidationErrorIssuedAt // IAT validation failed
|
||||||
|
ValidationErrorIssuer // ISS validation failed
|
||||||
|
ValidationErrorNotValidYet // NBF validation failed
|
||||||
|
ValidationErrorId // JTI validation failed
|
||||||
|
ValidationErrorClaimsInvalid // Generic claims validation error
|
||||||
|
) |
||||||
|
|
||||||
|
// Helper for constructing a ValidationError with a string error message
|
||||||
|
func NewValidationError(errorText string, errorFlags uint32) *ValidationError { |
||||||
|
return &ValidationError{ |
||||||
|
text: errorText, |
||||||
|
Errors: errorFlags, |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// The error from Parse if token is not valid
|
||||||
|
type ValidationError struct { |
||||||
|
Inner error // stores the error returned by external dependencies, i.e.: KeyFunc
|
||||||
|
Errors uint32 // bitfield. see ValidationError... constants
|
||||||
|
text string // errors that do not have a valid error just have text
|
||||||
|
} |
||||||
|
|
||||||
|
// Validation error is an error type
|
||||||
|
func (e ValidationError) Error() string { |
||||||
|
if e.Inner != nil { |
||||||
|
return e.Inner.Error() |
||||||
|
} else if e.text != "" { |
||||||
|
return e.text |
||||||
|
} else { |
||||||
|
return "token is invalid" |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// No errors
|
||||||
|
func (e *ValidationError) valid() bool { |
||||||
|
return e.Errors == 0 |
||||||
|
} |
||||||
@ -0,0 +1,94 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto" |
||||||
|
"crypto/hmac" |
||||||
|
"errors" |
||||||
|
) |
||||||
|
|
||||||
|
// Implements the HMAC-SHA family of signing methods signing methods
|
||||||
|
type SigningMethodHMAC struct { |
||||||
|
Name string |
||||||
|
Hash crypto.Hash |
||||||
|
} |
||||||
|
|
||||||
|
// Specific instances for HS256 and company
|
||||||
|
var ( |
||||||
|
SigningMethodHS256 *SigningMethodHMAC |
||||||
|
SigningMethodHS384 *SigningMethodHMAC |
||||||
|
SigningMethodHS512 *SigningMethodHMAC |
||||||
|
ErrSignatureInvalid = errors.New("signature is invalid") |
||||||
|
) |
||||||
|
|
||||||
|
func init() { |
||||||
|
// HS256
|
||||||
|
SigningMethodHS256 = &SigningMethodHMAC{"HS256", crypto.SHA256} |
||||||
|
RegisterSigningMethod(SigningMethodHS256.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodHS256 |
||||||
|
}) |
||||||
|
|
||||||
|
// HS384
|
||||||
|
SigningMethodHS384 = &SigningMethodHMAC{"HS384", crypto.SHA384} |
||||||
|
RegisterSigningMethod(SigningMethodHS384.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodHS384 |
||||||
|
}) |
||||||
|
|
||||||
|
// HS512
|
||||||
|
SigningMethodHS512 = &SigningMethodHMAC{"HS512", crypto.SHA512} |
||||||
|
RegisterSigningMethod(SigningMethodHS512.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodHS512 |
||||||
|
}) |
||||||
|
} |
||||||
|
|
||||||
|
func (m *SigningMethodHMAC) Alg() string { |
||||||
|
return m.Name |
||||||
|
} |
||||||
|
|
||||||
|
// Verify the signature of HSXXX tokens. Returns nil if the signature is valid.
|
||||||
|
func (m *SigningMethodHMAC) Verify(signingString, signature string, key interface{}) error { |
||||||
|
// Verify the key is the right type
|
||||||
|
keyBytes, ok := key.([]byte) |
||||||
|
if !ok { |
||||||
|
return ErrInvalidKeyType |
||||||
|
} |
||||||
|
|
||||||
|
// Decode signature, for comparison
|
||||||
|
sig, err := DecodeSegment(signature) |
||||||
|
if err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
// Can we use the specified hashing method?
|
||||||
|
if !m.Hash.Available() { |
||||||
|
return ErrHashUnavailable |
||||||
|
} |
||||||
|
|
||||||
|
// This signing method is symmetric, so we validate the signature
|
||||||
|
// by reproducing the signature from the signing string and key, then
|
||||||
|
// comparing that against the provided signature.
|
||||||
|
hasher := hmac.New(m.Hash.New, keyBytes) |
||||||
|
hasher.Write([]byte(signingString)) |
||||||
|
if !hmac.Equal(sig, hasher.Sum(nil)) { |
||||||
|
return ErrSignatureInvalid |
||||||
|
} |
||||||
|
|
||||||
|
// No validation errors. Signature is good.
|
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// Implements the Sign method from SigningMethod for this signing method.
|
||||||
|
// Key must be []byte
|
||||||
|
func (m *SigningMethodHMAC) Sign(signingString string, key interface{}) (string, error) { |
||||||
|
if keyBytes, ok := key.([]byte); ok { |
||||||
|
if !m.Hash.Available() { |
||||||
|
return "", ErrHashUnavailable |
||||||
|
} |
||||||
|
|
||||||
|
hasher := hmac.New(m.Hash.New, keyBytes) |
||||||
|
hasher.Write([]byte(signingString)) |
||||||
|
|
||||||
|
return EncodeSegment(hasher.Sum(nil)), nil |
||||||
|
} |
||||||
|
|
||||||
|
return "", ErrInvalidKey |
||||||
|
} |
||||||
@ -0,0 +1,94 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"encoding/json" |
||||||
|
"errors" |
||||||
|
// "fmt"
|
||||||
|
) |
||||||
|
|
||||||
|
// Claims type that uses the map[string]interface{} for JSON decoding
|
||||||
|
// This is the default claims type if you don't supply one
|
||||||
|
type MapClaims map[string]interface{} |
||||||
|
|
||||||
|
// Compares the aud claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (m MapClaims) VerifyAudience(cmp string, req bool) bool { |
||||||
|
aud, _ := m["aud"].(string) |
||||||
|
return verifyAud(aud, cmp, req) |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the exp claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (m MapClaims) VerifyExpiresAt(cmp int64, req bool) bool { |
||||||
|
switch exp := m["exp"].(type) { |
||||||
|
case float64: |
||||||
|
return verifyExp(int64(exp), cmp, req) |
||||||
|
case json.Number: |
||||||
|
v, _ := exp.Int64() |
||||||
|
return verifyExp(v, cmp, req) |
||||||
|
} |
||||||
|
return req == false |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the iat claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (m MapClaims) VerifyIssuedAt(cmp int64, req bool) bool { |
||||||
|
switch iat := m["iat"].(type) { |
||||||
|
case float64: |
||||||
|
return verifyIat(int64(iat), cmp, req) |
||||||
|
case json.Number: |
||||||
|
v, _ := iat.Int64() |
||||||
|
return verifyIat(v, cmp, req) |
||||||
|
} |
||||||
|
return req == false |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the iss claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (m MapClaims) VerifyIssuer(cmp string, req bool) bool { |
||||||
|
iss, _ := m["iss"].(string) |
||||||
|
return verifyIss(iss, cmp, req) |
||||||
|
} |
||||||
|
|
||||||
|
// Compares the nbf claim against cmp.
|
||||||
|
// If required is false, this method will return true if the value matches or is unset
|
||||||
|
func (m MapClaims) VerifyNotBefore(cmp int64, req bool) bool { |
||||||
|
switch nbf := m["nbf"].(type) { |
||||||
|
case float64: |
||||||
|
return verifyNbf(int64(nbf), cmp, req) |
||||||
|
case json.Number: |
||||||
|
v, _ := nbf.Int64() |
||||||
|
return verifyNbf(v, cmp, req) |
||||||
|
} |
||||||
|
return req == false |
||||||
|
} |
||||||
|
|
||||||
|
// Validates time based claims "exp, iat, nbf".
|
||||||
|
// There is no accounting for clock skew.
|
||||||
|
// As well, if any of the above claims are not in the token, it will still
|
||||||
|
// be considered a valid claim.
|
||||||
|
func (m MapClaims) Valid() error { |
||||||
|
vErr := new(ValidationError) |
||||||
|
now := TimeFunc().Unix() |
||||||
|
|
||||||
|
if m.VerifyExpiresAt(now, false) == false { |
||||||
|
vErr.Inner = errors.New("Token is expired") |
||||||
|
vErr.Errors |= ValidationErrorExpired |
||||||
|
} |
||||||
|
|
||||||
|
if m.VerifyIssuedAt(now, false) == false { |
||||||
|
vErr.Inner = errors.New("Token used before issued") |
||||||
|
vErr.Errors |= ValidationErrorIssuedAt |
||||||
|
} |
||||||
|
|
||||||
|
if m.VerifyNotBefore(now, false) == false { |
||||||
|
vErr.Inner = errors.New("Token is not valid yet") |
||||||
|
vErr.Errors |= ValidationErrorNotValidYet |
||||||
|
} |
||||||
|
|
||||||
|
if vErr.valid() { |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
return vErr |
||||||
|
} |
||||||
@ -0,0 +1,52 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
// Implements the none signing method. This is required by the spec
|
||||||
|
// but you probably should never use it.
|
||||||
|
var SigningMethodNone *signingMethodNone |
||||||
|
|
||||||
|
const UnsafeAllowNoneSignatureType unsafeNoneMagicConstant = "none signing method allowed" |
||||||
|
|
||||||
|
var NoneSignatureTypeDisallowedError error |
||||||
|
|
||||||
|
type signingMethodNone struct{} |
||||||
|
type unsafeNoneMagicConstant string |
||||||
|
|
||||||
|
func init() { |
||||||
|
SigningMethodNone = &signingMethodNone{} |
||||||
|
NoneSignatureTypeDisallowedError = NewValidationError("'none' signature type is not allowed", ValidationErrorSignatureInvalid) |
||||||
|
|
||||||
|
RegisterSigningMethod(SigningMethodNone.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodNone |
||||||
|
}) |
||||||
|
} |
||||||
|
|
||||||
|
func (m *signingMethodNone) Alg() string { |
||||||
|
return "none" |
||||||
|
} |
||||||
|
|
||||||
|
// Only allow 'none' alg type if UnsafeAllowNoneSignatureType is specified as the key
|
||||||
|
func (m *signingMethodNone) Verify(signingString, signature string, key interface{}) (err error) { |
||||||
|
// Key must be UnsafeAllowNoneSignatureType to prevent accidentally
|
||||||
|
// accepting 'none' signing method
|
||||||
|
if _, ok := key.(unsafeNoneMagicConstant); !ok { |
||||||
|
return NoneSignatureTypeDisallowedError |
||||||
|
} |
||||||
|
// If signing method is none, signature must be an empty string
|
||||||
|
if signature != "" { |
||||||
|
return NewValidationError( |
||||||
|
"'none' signing method with non-empty signature", |
||||||
|
ValidationErrorSignatureInvalid, |
||||||
|
) |
||||||
|
} |
||||||
|
|
||||||
|
// Accept 'none' signing method.
|
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// Only allow 'none' signing if UnsafeAllowNoneSignatureType is specified as the key
|
||||||
|
func (m *signingMethodNone) Sign(signingString string, key interface{}) (string, error) { |
||||||
|
if _, ok := key.(unsafeNoneMagicConstant); ok { |
||||||
|
return "", nil |
||||||
|
} |
||||||
|
return "", NoneSignatureTypeDisallowedError |
||||||
|
} |
||||||
@ -0,0 +1,131 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"bytes" |
||||||
|
"encoding/json" |
||||||
|
"fmt" |
||||||
|
"strings" |
||||||
|
) |
||||||
|
|
||||||
|
type Parser struct { |
||||||
|
ValidMethods []string // If populated, only these methods will be considered valid
|
||||||
|
UseJSONNumber bool // Use JSON Number format in JSON decoder
|
||||||
|
SkipClaimsValidation bool // Skip claims validation during token parsing
|
||||||
|
} |
||||||
|
|
||||||
|
// Parse, validate, and return a token.
|
||||||
|
// keyFunc will receive the parsed token and should return the key for validating.
|
||||||
|
// If everything is kosher, err will be nil
|
||||||
|
func (p *Parser) Parse(tokenString string, keyFunc Keyfunc) (*Token, error) { |
||||||
|
return p.ParseWithClaims(tokenString, MapClaims{}, keyFunc) |
||||||
|
} |
||||||
|
|
||||||
|
func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error) { |
||||||
|
parts := strings.Split(tokenString, ".") |
||||||
|
if len(parts) != 3 { |
||||||
|
return nil, NewValidationError("token contains an invalid number of segments", ValidationErrorMalformed) |
||||||
|
} |
||||||
|
|
||||||
|
var err error |
||||||
|
token := &Token{Raw: tokenString} |
||||||
|
|
||||||
|
// parse Header
|
||||||
|
var headerBytes []byte |
||||||
|
if headerBytes, err = DecodeSegment(parts[0]); err != nil { |
||||||
|
if strings.HasPrefix(strings.ToLower(tokenString), "bearer ") { |
||||||
|
return token, NewValidationError("tokenstring should not contain 'bearer '", ValidationErrorMalformed) |
||||||
|
} |
||||||
|
return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed} |
||||||
|
} |
||||||
|
if err = json.Unmarshal(headerBytes, &token.Header); err != nil { |
||||||
|
return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed} |
||||||
|
} |
||||||
|
|
||||||
|
// parse Claims
|
||||||
|
var claimBytes []byte |
||||||
|
token.Claims = claims |
||||||
|
|
||||||
|
if claimBytes, err = DecodeSegment(parts[1]); err != nil { |
||||||
|
return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed} |
||||||
|
} |
||||||
|
dec := json.NewDecoder(bytes.NewBuffer(claimBytes)) |
||||||
|
if p.UseJSONNumber { |
||||||
|
dec.UseNumber() |
||||||
|
} |
||||||
|
// JSON Decode. Special case for map type to avoid weird pointer behavior
|
||||||
|
if c, ok := token.Claims.(MapClaims); ok { |
||||||
|
err = dec.Decode(&c) |
||||||
|
} else { |
||||||
|
err = dec.Decode(&claims) |
||||||
|
} |
||||||
|
// Handle decode error
|
||||||
|
if err != nil { |
||||||
|
return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed} |
||||||
|
} |
||||||
|
|
||||||
|
// Lookup signature method
|
||||||
|
if method, ok := token.Header["alg"].(string); ok { |
||||||
|
if token.Method = GetSigningMethod(method); token.Method == nil { |
||||||
|
return token, NewValidationError("signing method (alg) is unavailable.", ValidationErrorUnverifiable) |
||||||
|
} |
||||||
|
} else { |
||||||
|
return token, NewValidationError("signing method (alg) is unspecified.", ValidationErrorUnverifiable) |
||||||
|
} |
||||||
|
|
||||||
|
// Verify signing method is in the required set
|
||||||
|
if p.ValidMethods != nil { |
||||||
|
var signingMethodValid = false |
||||||
|
var alg = token.Method.Alg() |
||||||
|
for _, m := range p.ValidMethods { |
||||||
|
if m == alg { |
||||||
|
signingMethodValid = true |
||||||
|
break |
||||||
|
} |
||||||
|
} |
||||||
|
if !signingMethodValid { |
||||||
|
// signing method is not in the listed set
|
||||||
|
return token, NewValidationError(fmt.Sprintf("signing method %v is invalid", alg), ValidationErrorSignatureInvalid) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Lookup key
|
||||||
|
var key interface{} |
||||||
|
if keyFunc == nil { |
||||||
|
// keyFunc was not provided. short circuiting validation
|
||||||
|
return token, NewValidationError("no Keyfunc was provided.", ValidationErrorUnverifiable) |
||||||
|
} |
||||||
|
if key, err = keyFunc(token); err != nil { |
||||||
|
// keyFunc returned an error
|
||||||
|
return token, &ValidationError{Inner: err, Errors: ValidationErrorUnverifiable} |
||||||
|
} |
||||||
|
|
||||||
|
vErr := &ValidationError{} |
||||||
|
|
||||||
|
// Validate Claims
|
||||||
|
if !p.SkipClaimsValidation { |
||||||
|
if err := token.Claims.Valid(); err != nil { |
||||||
|
|
||||||
|
// If the Claims Valid returned an error, check if it is a validation error,
|
||||||
|
// If it was another error type, create a ValidationError with a generic ClaimsInvalid flag set
|
||||||
|
if e, ok := err.(*ValidationError); !ok { |
||||||
|
vErr = &ValidationError{Inner: err, Errors: ValidationErrorClaimsInvalid} |
||||||
|
} else { |
||||||
|
vErr = e |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Perform validation
|
||||||
|
token.Signature = parts[2] |
||||||
|
if err = token.Method.Verify(strings.Join(parts[0:2], "."), token.Signature, key); err != nil { |
||||||
|
vErr.Inner = err |
||||||
|
vErr.Errors |= ValidationErrorSignatureInvalid |
||||||
|
} |
||||||
|
|
||||||
|
if vErr.valid() { |
||||||
|
token.Valid = true |
||||||
|
return token, nil |
||||||
|
} |
||||||
|
|
||||||
|
return token, vErr |
||||||
|
} |
||||||
@ -0,0 +1,100 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto" |
||||||
|
"crypto/rand" |
||||||
|
"crypto/rsa" |
||||||
|
) |
||||||
|
|
||||||
|
// Implements the RSA family of signing methods signing methods
|
||||||
|
type SigningMethodRSA struct { |
||||||
|
Name string |
||||||
|
Hash crypto.Hash |
||||||
|
} |
||||||
|
|
||||||
|
// Specific instances for RS256 and company
|
||||||
|
var ( |
||||||
|
SigningMethodRS256 *SigningMethodRSA |
||||||
|
SigningMethodRS384 *SigningMethodRSA |
||||||
|
SigningMethodRS512 *SigningMethodRSA |
||||||
|
) |
||||||
|
|
||||||
|
func init() { |
||||||
|
// RS256
|
||||||
|
SigningMethodRS256 = &SigningMethodRSA{"RS256", crypto.SHA256} |
||||||
|
RegisterSigningMethod(SigningMethodRS256.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodRS256 |
||||||
|
}) |
||||||
|
|
||||||
|
// RS384
|
||||||
|
SigningMethodRS384 = &SigningMethodRSA{"RS384", crypto.SHA384} |
||||||
|
RegisterSigningMethod(SigningMethodRS384.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodRS384 |
||||||
|
}) |
||||||
|
|
||||||
|
// RS512
|
||||||
|
SigningMethodRS512 = &SigningMethodRSA{"RS512", crypto.SHA512} |
||||||
|
RegisterSigningMethod(SigningMethodRS512.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodRS512 |
||||||
|
}) |
||||||
|
} |
||||||
|
|
||||||
|
func (m *SigningMethodRSA) Alg() string { |
||||||
|
return m.Name |
||||||
|
} |
||||||
|
|
||||||
|
// Implements the Verify method from SigningMethod
|
||||||
|
// For this signing method, must be an rsa.PublicKey structure.
|
||||||
|
func (m *SigningMethodRSA) Verify(signingString, signature string, key interface{}) error { |
||||||
|
var err error |
||||||
|
|
||||||
|
// Decode the signature
|
||||||
|
var sig []byte |
||||||
|
if sig, err = DecodeSegment(signature); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
var rsaKey *rsa.PublicKey |
||||||
|
var ok bool |
||||||
|
|
||||||
|
if rsaKey, ok = key.(*rsa.PublicKey); !ok { |
||||||
|
return ErrInvalidKeyType |
||||||
|
} |
||||||
|
|
||||||
|
// Create hasher
|
||||||
|
if !m.Hash.Available() { |
||||||
|
return ErrHashUnavailable |
||||||
|
} |
||||||
|
hasher := m.Hash.New() |
||||||
|
hasher.Write([]byte(signingString)) |
||||||
|
|
||||||
|
// Verify the signature
|
||||||
|
return rsa.VerifyPKCS1v15(rsaKey, m.Hash, hasher.Sum(nil), sig) |
||||||
|
} |
||||||
|
|
||||||
|
// Implements the Sign method from SigningMethod
|
||||||
|
// For this signing method, must be an rsa.PrivateKey structure.
|
||||||
|
func (m *SigningMethodRSA) Sign(signingString string, key interface{}) (string, error) { |
||||||
|
var rsaKey *rsa.PrivateKey |
||||||
|
var ok bool |
||||||
|
|
||||||
|
// Validate type of key
|
||||||
|
if rsaKey, ok = key.(*rsa.PrivateKey); !ok { |
||||||
|
return "", ErrInvalidKey |
||||||
|
} |
||||||
|
|
||||||
|
// Create the hasher
|
||||||
|
if !m.Hash.Available() { |
||||||
|
return "", ErrHashUnavailable |
||||||
|
} |
||||||
|
|
||||||
|
hasher := m.Hash.New() |
||||||
|
hasher.Write([]byte(signingString)) |
||||||
|
|
||||||
|
// Sign the string and return the encoded bytes
|
||||||
|
if sigBytes, err := rsa.SignPKCS1v15(rand.Reader, rsaKey, m.Hash, hasher.Sum(nil)); err == nil { |
||||||
|
return EncodeSegment(sigBytes), nil |
||||||
|
} else { |
||||||
|
return "", err |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,126 @@ |
|||||||
|
// +build go1.4
|
||||||
|
|
||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto" |
||||||
|
"crypto/rand" |
||||||
|
"crypto/rsa" |
||||||
|
) |
||||||
|
|
||||||
|
// Implements the RSAPSS family of signing methods signing methods
|
||||||
|
type SigningMethodRSAPSS struct { |
||||||
|
*SigningMethodRSA |
||||||
|
Options *rsa.PSSOptions |
||||||
|
} |
||||||
|
|
||||||
|
// Specific instances for RS/PS and company
|
||||||
|
var ( |
||||||
|
SigningMethodPS256 *SigningMethodRSAPSS |
||||||
|
SigningMethodPS384 *SigningMethodRSAPSS |
||||||
|
SigningMethodPS512 *SigningMethodRSAPSS |
||||||
|
) |
||||||
|
|
||||||
|
func init() { |
||||||
|
// PS256
|
||||||
|
SigningMethodPS256 = &SigningMethodRSAPSS{ |
||||||
|
&SigningMethodRSA{ |
||||||
|
Name: "PS256", |
||||||
|
Hash: crypto.SHA256, |
||||||
|
}, |
||||||
|
&rsa.PSSOptions{ |
||||||
|
SaltLength: rsa.PSSSaltLengthAuto, |
||||||
|
Hash: crypto.SHA256, |
||||||
|
}, |
||||||
|
} |
||||||
|
RegisterSigningMethod(SigningMethodPS256.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodPS256 |
||||||
|
}) |
||||||
|
|
||||||
|
// PS384
|
||||||
|
SigningMethodPS384 = &SigningMethodRSAPSS{ |
||||||
|
&SigningMethodRSA{ |
||||||
|
Name: "PS384", |
||||||
|
Hash: crypto.SHA384, |
||||||
|
}, |
||||||
|
&rsa.PSSOptions{ |
||||||
|
SaltLength: rsa.PSSSaltLengthAuto, |
||||||
|
Hash: crypto.SHA384, |
||||||
|
}, |
||||||
|
} |
||||||
|
RegisterSigningMethod(SigningMethodPS384.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodPS384 |
||||||
|
}) |
||||||
|
|
||||||
|
// PS512
|
||||||
|
SigningMethodPS512 = &SigningMethodRSAPSS{ |
||||||
|
&SigningMethodRSA{ |
||||||
|
Name: "PS512", |
||||||
|
Hash: crypto.SHA512, |
||||||
|
}, |
||||||
|
&rsa.PSSOptions{ |
||||||
|
SaltLength: rsa.PSSSaltLengthAuto, |
||||||
|
Hash: crypto.SHA512, |
||||||
|
}, |
||||||
|
} |
||||||
|
RegisterSigningMethod(SigningMethodPS512.Alg(), func() SigningMethod { |
||||||
|
return SigningMethodPS512 |
||||||
|
}) |
||||||
|
} |
||||||
|
|
||||||
|
// Implements the Verify method from SigningMethod
|
||||||
|
// For this verify method, key must be an rsa.PublicKey struct
|
||||||
|
func (m *SigningMethodRSAPSS) Verify(signingString, signature string, key interface{}) error { |
||||||
|
var err error |
||||||
|
|
||||||
|
// Decode the signature
|
||||||
|
var sig []byte |
||||||
|
if sig, err = DecodeSegment(signature); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
var rsaKey *rsa.PublicKey |
||||||
|
switch k := key.(type) { |
||||||
|
case *rsa.PublicKey: |
||||||
|
rsaKey = k |
||||||
|
default: |
||||||
|
return ErrInvalidKey |
||||||
|
} |
||||||
|
|
||||||
|
// Create hasher
|
||||||
|
if !m.Hash.Available() { |
||||||
|
return ErrHashUnavailable |
||||||
|
} |
||||||
|
hasher := m.Hash.New() |
||||||
|
hasher.Write([]byte(signingString)) |
||||||
|
|
||||||
|
return rsa.VerifyPSS(rsaKey, m.Hash, hasher.Sum(nil), sig, m.Options) |
||||||
|
} |
||||||
|
|
||||||
|
// Implements the Sign method from SigningMethod
|
||||||
|
// For this signing method, key must be an rsa.PrivateKey struct
|
||||||
|
func (m *SigningMethodRSAPSS) Sign(signingString string, key interface{}) (string, error) { |
||||||
|
var rsaKey *rsa.PrivateKey |
||||||
|
|
||||||
|
switch k := key.(type) { |
||||||
|
case *rsa.PrivateKey: |
||||||
|
rsaKey = k |
||||||
|
default: |
||||||
|
return "", ErrInvalidKeyType |
||||||
|
} |
||||||
|
|
||||||
|
// Create the hasher
|
||||||
|
if !m.Hash.Available() { |
||||||
|
return "", ErrHashUnavailable |
||||||
|
} |
||||||
|
|
||||||
|
hasher := m.Hash.New() |
||||||
|
hasher.Write([]byte(signingString)) |
||||||
|
|
||||||
|
// Sign the string and return the encoded bytes
|
||||||
|
if sigBytes, err := rsa.SignPSS(rand.Reader, rsaKey, m.Hash, hasher.Sum(nil), m.Options); err == nil { |
||||||
|
return EncodeSegment(sigBytes), nil |
||||||
|
} else { |
||||||
|
return "", err |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,69 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto/rsa" |
||||||
|
"crypto/x509" |
||||||
|
"encoding/pem" |
||||||
|
"errors" |
||||||
|
) |
||||||
|
|
||||||
|
var ( |
||||||
|
ErrKeyMustBePEMEncoded = errors.New("Invalid Key: Key must be PEM encoded PKCS1 or PKCS8 private key") |
||||||
|
ErrNotRSAPrivateKey = errors.New("Key is not a valid RSA private key") |
||||||
|
ErrNotRSAPublicKey = errors.New("Key is not a valid RSA public key") |
||||||
|
) |
||||||
|
|
||||||
|
// Parse PEM encoded PKCS1 or PKCS8 private key
|
||||||
|
func ParseRSAPrivateKeyFromPEM(key []byte) (*rsa.PrivateKey, error) { |
||||||
|
var err error |
||||||
|
|
||||||
|
// Parse PEM block
|
||||||
|
var block *pem.Block |
||||||
|
if block, _ = pem.Decode(key); block == nil { |
||||||
|
return nil, ErrKeyMustBePEMEncoded |
||||||
|
} |
||||||
|
|
||||||
|
var parsedKey interface{} |
||||||
|
if parsedKey, err = x509.ParsePKCS1PrivateKey(block.Bytes); err != nil { |
||||||
|
if parsedKey, err = x509.ParsePKCS8PrivateKey(block.Bytes); err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
var pkey *rsa.PrivateKey |
||||||
|
var ok bool |
||||||
|
if pkey, ok = parsedKey.(*rsa.PrivateKey); !ok { |
||||||
|
return nil, ErrNotRSAPrivateKey |
||||||
|
} |
||||||
|
|
||||||
|
return pkey, nil |
||||||
|
} |
||||||
|
|
||||||
|
// Parse PEM encoded PKCS1 or PKCS8 public key
|
||||||
|
func ParseRSAPublicKeyFromPEM(key []byte) (*rsa.PublicKey, error) { |
||||||
|
var err error |
||||||
|
|
||||||
|
// Parse PEM block
|
||||||
|
var block *pem.Block |
||||||
|
if block, _ = pem.Decode(key); block == nil { |
||||||
|
return nil, ErrKeyMustBePEMEncoded |
||||||
|
} |
||||||
|
|
||||||
|
// Parse the key
|
||||||
|
var parsedKey interface{} |
||||||
|
if parsedKey, err = x509.ParsePKIXPublicKey(block.Bytes); err != nil { |
||||||
|
if cert, err := x509.ParseCertificate(block.Bytes); err == nil { |
||||||
|
parsedKey = cert.PublicKey |
||||||
|
} else { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
var pkey *rsa.PublicKey |
||||||
|
var ok bool |
||||||
|
if pkey, ok = parsedKey.(*rsa.PublicKey); !ok { |
||||||
|
return nil, ErrNotRSAPublicKey |
||||||
|
} |
||||||
|
|
||||||
|
return pkey, nil |
||||||
|
} |
||||||
@ -0,0 +1,35 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"sync" |
||||||
|
) |
||||||
|
|
||||||
|
var signingMethods = map[string]func() SigningMethod{} |
||||||
|
var signingMethodLock = new(sync.RWMutex) |
||||||
|
|
||||||
|
// Implement SigningMethod to add new methods for signing or verifying tokens.
|
||||||
|
type SigningMethod interface { |
||||||
|
Verify(signingString, signature string, key interface{}) error // Returns nil if signature is valid
|
||||||
|
Sign(signingString string, key interface{}) (string, error) // Returns encoded signature or error
|
||||||
|
Alg() string // returns the alg identifier for this method (example: 'HS256')
|
||||||
|
} |
||||||
|
|
||||||
|
// Register the "alg" name and a factory function for signing method.
|
||||||
|
// This is typically done during init() in the method's implementation
|
||||||
|
func RegisterSigningMethod(alg string, f func() SigningMethod) { |
||||||
|
signingMethodLock.Lock() |
||||||
|
defer signingMethodLock.Unlock() |
||||||
|
|
||||||
|
signingMethods[alg] = f |
||||||
|
} |
||||||
|
|
||||||
|
// Get a signing method from an "alg" string
|
||||||
|
func GetSigningMethod(alg string) (method SigningMethod) { |
||||||
|
signingMethodLock.RLock() |
||||||
|
defer signingMethodLock.RUnlock() |
||||||
|
|
||||||
|
if methodF, ok := signingMethods[alg]; ok { |
||||||
|
method = methodF() |
||||||
|
} |
||||||
|
return |
||||||
|
} |
||||||
@ -0,0 +1,108 @@ |
|||||||
|
package jwt |
||||||
|
|
||||||
|
import ( |
||||||
|
"encoding/base64" |
||||||
|
"encoding/json" |
||||||
|
"strings" |
||||||
|
"time" |
||||||
|
) |
||||||
|
|
||||||
|
// TimeFunc provides the current time when parsing token to validate "exp" claim (expiration time).
|
||||||
|
// You can override it to use another time value. This is useful for testing or if your
|
||||||
|
// server uses a different time zone than your tokens.
|
||||||
|
var TimeFunc = time.Now |
||||||
|
|
||||||
|
// Parse methods use this callback function to supply
|
||||||
|
// the key for verification. The function receives the parsed,
|
||||||
|
// but unverified Token. This allows you to use properties in the
|
||||||
|
// Header of the token (such as `kid`) to identify which key to use.
|
||||||
|
type Keyfunc func(*Token) (interface{}, error) |
||||||
|
|
||||||
|
// A JWT Token. Different fields will be used depending on whether you're
|
||||||
|
// creating or parsing/verifying a token.
|
||||||
|
type Token struct { |
||||||
|
Raw string // The raw token. Populated when you Parse a token
|
||||||
|
Method SigningMethod // The signing method used or to be used
|
||||||
|
Header map[string]interface{} // The first segment of the token
|
||||||
|
Claims Claims // The second segment of the token
|
||||||
|
Signature string // The third segment of the token. Populated when you Parse a token
|
||||||
|
Valid bool // Is the token valid? Populated when you Parse/Verify a token
|
||||||
|
} |
||||||
|
|
||||||
|
// Create a new Token. Takes a signing method
|
||||||
|
func New(method SigningMethod) *Token { |
||||||
|
return NewWithClaims(method, MapClaims{}) |
||||||
|
} |
||||||
|
|
||||||
|
func NewWithClaims(method SigningMethod, claims Claims) *Token { |
||||||
|
return &Token{ |
||||||
|
Header: map[string]interface{}{ |
||||||
|
"typ": "JWT", |
||||||
|
"alg": method.Alg(), |
||||||
|
}, |
||||||
|
Claims: claims, |
||||||
|
Method: method, |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Get the complete, signed token
|
||||||
|
func (t *Token) SignedString(key interface{}) (string, error) { |
||||||
|
var sig, sstr string |
||||||
|
var err error |
||||||
|
if sstr, err = t.SigningString(); err != nil { |
||||||
|
return "", err |
||||||
|
} |
||||||
|
if sig, err = t.Method.Sign(sstr, key); err != nil { |
||||||
|
return "", err |
||||||
|
} |
||||||
|
return strings.Join([]string{sstr, sig}, "."), nil |
||||||
|
} |
||||||
|
|
||||||
|
// Generate the signing string. This is the
|
||||||
|
// most expensive part of the whole deal. Unless you
|
||||||
|
// need this for something special, just go straight for
|
||||||
|
// the SignedString.
|
||||||
|
func (t *Token) SigningString() (string, error) { |
||||||
|
var err error |
||||||
|
parts := make([]string, 2) |
||||||
|
for i, _ := range parts { |
||||||
|
var jsonValue []byte |
||||||
|
if i == 0 { |
||||||
|
if jsonValue, err = json.Marshal(t.Header); err != nil { |
||||||
|
return "", err |
||||||
|
} |
||||||
|
} else { |
||||||
|
if jsonValue, err = json.Marshal(t.Claims); err != nil { |
||||||
|
return "", err |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
parts[i] = EncodeSegment(jsonValue) |
||||||
|
} |
||||||
|
return strings.Join(parts, "."), nil |
||||||
|
} |
||||||
|
|
||||||
|
// Parse, validate, and return a token.
|
||||||
|
// keyFunc will receive the parsed token and should return the key for validating.
|
||||||
|
// If everything is kosher, err will be nil
|
||||||
|
func Parse(tokenString string, keyFunc Keyfunc) (*Token, error) { |
||||||
|
return new(Parser).Parse(tokenString, keyFunc) |
||||||
|
} |
||||||
|
|
||||||
|
func ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error) { |
||||||
|
return new(Parser).ParseWithClaims(tokenString, claims, keyFunc) |
||||||
|
} |
||||||
|
|
||||||
|
// Encode JWT specific base64url encoding with padding stripped
|
||||||
|
func EncodeSegment(seg []byte) string { |
||||||
|
return strings.TrimRight(base64.URLEncoding.EncodeToString(seg), "=") |
||||||
|
} |
||||||
|
|
||||||
|
// Decode JWT specific base64url encoding with padding stripped
|
||||||
|
func DecodeSegment(seg string) ([]byte, error) { |
||||||
|
if l := len(seg) % 4; l > 0 { |
||||||
|
seg += strings.Repeat("=", 4-l) |
||||||
|
} |
||||||
|
|
||||||
|
return base64.URLEncoding.DecodeString(seg) |
||||||
|
} |
||||||
Loading…
Reference in new issue