Skip to content

Commit

Permalink
Merge pull request #617 from bcho/fix-doc/auth-jwt
Browse files Browse the repository at this point in the history
auth/jwt: minor doc update
  • Loading branch information
ChrisHines committed Sep 26, 2017
2 parents 0d313fb + 492a87e commit 9ed3743
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
14 changes: 7 additions & 7 deletions auth/jwt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ will be added to the context via the `jwt.JWTClaimsContextKey`.
```go
import (
stdjwt "github.com/dgrijalva/jwt-go"

"github.com/go-kit/kit/auth/jwt"
"github.com/go-kit/kit/endpoint"
)
Expand All @@ -23,7 +23,7 @@ func main() {
{
kf := func(token *stdjwt.Token) (interface{}, error) { return []byte("SigningString"), nil }
exampleEndpoint = MakeExampleEndpoint(service)
exampleEndpoint = jwt.NewParser(kf, stdjwt.SigningMethodHS256)(exampleEndpoint)
exampleEndpoint = jwt.NewParser(kf, stdjwt.SigningMethodHS256, jwt.StandardClaimsFactory)(exampleEndpoint)
}
}
```
Expand All @@ -35,7 +35,7 @@ the token string and add it to the context via the `jwt.JWTTokenContextKey`.
```go
import (
stdjwt "github.com/dgrijalva/jwt-go"

"github.com/go-kit/kit/auth/jwt"
"github.com/go-kit/kit/endpoint"
)
Expand All @@ -45,9 +45,9 @@ func main() {
{
exampleEndpoint = grpctransport.NewClient(...).Endpoint()
exampleEndpoint = jwt.NewSigner(
"kid-header",
[]byte("SigningString"),
stdjwt.SigningMethodHS256,
"kid-header",
[]byte("SigningString"),
stdjwt.SigningMethodHS256,
jwt.Claims{},
)(exampleEndpoint)
}
Expand All @@ -67,7 +67,7 @@ Example of use in a client:
import (
stdjwt "github.com/dgrijalva/jwt-go"

grpctransport "github.com/go-kit/kit/transport/grpc"
grpctransport "github.com/go-kit/kit/transport/grpc"
"github.com/go-kit/kit/auth/jwt"
"github.com/go-kit/kit/endpoint"
)
Expand Down
10 changes: 5 additions & 5 deletions auth/jwt/middleware.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,21 @@ func NewSigner(kid string, key []byte, method jwt.SigningMethod, claims jwt.Clai
// Useful in NewParser middleware.
type ClaimsFactory func() jwt.Claims

// MapClaimsFactory is a ClaimsFactory that returns
// MapClaimsFactory is a ClaimsFactory that returns
// an empty jwt.MapClaims.
func MapClaimsFactory() jwt.Claims {
return jwt.MapClaims{}
return jwt.MapClaims{}
}

// StandardClaimsFactory is a ClaimsFactory that returns
// StandardClaimsFactory is a ClaimsFactory that returns
// an empty jwt.StandardClaims.
func StandardClaimsFactory() jwt.Claims {
return &jwt.StandardClaims{}
return &jwt.StandardClaims{}
}

// NewParser creates a new JWT token parsing middleware, specifying a
// jwt.Keyfunc interface, the signing method and the claims type to be used. NewParser
// adds the resulting claims to endpoint context or returns error on invalid token.
// adds the resulting claims to endpoint context or returns error on invalid token.
// Particularly useful for servers.
func NewParser(keyFunc jwt.Keyfunc, method jwt.SigningMethod, newClaims ClaimsFactory) endpoint.Middleware {
return func(next endpoint.Endpoint) endpoint.Endpoint {
Expand Down

0 comments on commit 9ed3743

Please sign in to comment.