mirror of
https://github.com/labstack/echo.git
synced 2024-12-24 20:14:31 +02:00
Read JWT from cookie
Note: writing token to cookie is out of scope of this middleware (exactly as in other reading methods).
This commit is contained in:
parent
ae09482493
commit
a8b48af608
@ -31,6 +31,7 @@ type (
|
|||||||
// Possible values:
|
// Possible values:
|
||||||
// - "header:<name>"
|
// - "header:<name>"
|
||||||
// - "query:<name>"
|
// - "query:<name>"
|
||||||
|
// - "cookie:<name>"
|
||||||
TokenLookup string `json:"token_lookup"`
|
TokenLookup string `json:"token_lookup"`
|
||||||
|
|
||||||
// HandleEmptyToken is handler executed when there is no token.
|
// HandleEmptyToken is handler executed when there is no token.
|
||||||
@ -71,6 +72,7 @@ var (
|
|||||||
// For empty or invalid `Authorization` header, it sends "400 - Bad Request".
|
// For empty or invalid `Authorization` header, it sends "400 - Bad Request".
|
||||||
//
|
//
|
||||||
// See: https://jwt.io/introduction
|
// See: https://jwt.io/introduction
|
||||||
|
// See `JWTConfig.TokenLookup`
|
||||||
func JWT(key []byte) echo.MiddlewareFunc {
|
func JWT(key []byte) echo.MiddlewareFunc {
|
||||||
c := DefaultJWTConfig
|
c := DefaultJWTConfig
|
||||||
c.SigningKey = key
|
c.SigningKey = key
|
||||||
@ -99,10 +101,14 @@ func JWTWithConfig(config JWTConfig) echo.MiddlewareFunc {
|
|||||||
|
|
||||||
// Initialize
|
// Initialize
|
||||||
parts := strings.Split(config.TokenLookup, ":")
|
parts := strings.Split(config.TokenLookup, ":")
|
||||||
extractor := jwtFromHeader(parts[1])
|
var extractor jwtExtractor
|
||||||
switch parts[0] {
|
switch parts[0] {
|
||||||
case "query":
|
case "query":
|
||||||
extractor = jwtFromQuery(parts[1])
|
extractor = jwtFromQuery(parts[1])
|
||||||
|
case "cookie":
|
||||||
|
extractor = jwtFromCookie(parts[1])
|
||||||
|
default:
|
||||||
|
extractor = jwtFromHeader(parts[1])
|
||||||
}
|
}
|
||||||
|
|
||||||
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
||||||
@ -161,3 +167,14 @@ func jwtFromQuery(param string) jwtExtractor {
|
|||||||
return token, err
|
return token, err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// jwtFromCookie returns a `jwtExtractor` that extracts token from named cookie.
|
||||||
|
func jwtFromCookie(name string) jwtExtractor {
|
||||||
|
return func(c echo.Context) (string, error) {
|
||||||
|
cookie, err := c.Cookie(name)
|
||||||
|
if err != nil {
|
||||||
|
return "", errJWTEmptyToken
|
||||||
|
}
|
||||||
|
return cookie.Value(), nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -29,6 +29,7 @@ func TestJWT(t *testing.T) {
|
|||||||
config JWTConfig
|
config JWTConfig
|
||||||
reqURL string // "/" if empty
|
reqURL string // "/" if empty
|
||||||
hdrAuth string
|
hdrAuth string
|
||||||
|
hdrCookie string // test.Request doesn't provide SetCookie(); use name=val
|
||||||
info string
|
info string
|
||||||
}{
|
}{
|
||||||
{expPanic: true, info: "No signing key provided"},
|
{expPanic: true, info: "No signing key provided"},
|
||||||
@ -117,6 +118,42 @@ func TestJWT(t *testing.T) {
|
|||||||
expErrCode: http.StatusFound,
|
expErrCode: http.StatusFound,
|
||||||
info: "Empty query with redirect",
|
info: "Empty query with redirect",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
config: JWTConfig{
|
||||||
|
SigningKey: validKey,
|
||||||
|
TokenLookup: "cookie:jwt",
|
||||||
|
},
|
||||||
|
hdrCookie: "jwt=" + token,
|
||||||
|
info: "Valid cookie method",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
config: JWTConfig{
|
||||||
|
SigningKey: validKey,
|
||||||
|
TokenLookup: "cookie:jwt",
|
||||||
|
},
|
||||||
|
expErrCode: http.StatusUnauthorized,
|
||||||
|
hdrCookie: "jwt=invalid",
|
||||||
|
info: "Invalid token with cookie method",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
config: JWTConfig{
|
||||||
|
SigningKey: validKey,
|
||||||
|
TokenLookup: "cookie:jwt",
|
||||||
|
},
|
||||||
|
expErrCode: http.StatusBadRequest,
|
||||||
|
hdrCookie: "",
|
||||||
|
info: "Empty cookie",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
config: JWTConfig{
|
||||||
|
SigningKey: validKey,
|
||||||
|
TokenLookup: "cookie:jwt",
|
||||||
|
HandleEmptyToken: redirect,
|
||||||
|
},
|
||||||
|
expErrCode: http.StatusFound,
|
||||||
|
hdrCookie: "",
|
||||||
|
info: "Empty cookie with redirect",
|
||||||
|
},
|
||||||
} {
|
} {
|
||||||
|
|
||||||
if tc.reqURL == "" {
|
if tc.reqURL == "" {
|
||||||
@ -126,6 +163,7 @@ func TestJWT(t *testing.T) {
|
|||||||
req := test.NewRequest(echo.GET, tc.reqURL, nil)
|
req := test.NewRequest(echo.GET, tc.reqURL, nil)
|
||||||
res := test.NewResponseRecorder()
|
res := test.NewResponseRecorder()
|
||||||
req.Header().Set(echo.HeaderAuthorization, tc.hdrAuth)
|
req.Header().Set(echo.HeaderAuthorization, tc.hdrAuth)
|
||||||
|
req.Header().Set(echo.HeaderCookie, tc.hdrCookie)
|
||||||
c := e.NewContext(req, res)
|
c := e.NewContext(req, res)
|
||||||
|
|
||||||
if tc.expPanic {
|
if tc.expPanic {
|
||||||
|
Loading…
Reference in New Issue
Block a user