mirror of https://github.com/golang-jwt/jwt.git
updated documenation of SigningMethod interface
This commit is contained in:
parent
9fe8afe96d
commit
127f538a32
|
@ -2,11 +2,11 @@ package jwt
|
||||||
|
|
||||||
var signingMethods = map[string]func() SigningMethod{}
|
var signingMethods = map[string]func() SigningMethod{}
|
||||||
|
|
||||||
// Signing method
|
// Implement SigningMethod to add new methods for signing or verifying tokens.
|
||||||
type SigningMethod interface {
|
type SigningMethod interface {
|
||||||
Verify(signingString, signature string, key interface{}) error
|
Verify(signingString, signature string, key interface{}) error // Returns nil if signature is valid
|
||||||
Sign(signingString string, key interface{}) (string, error)
|
Sign(signingString string, key interface{}) (string, error) // Returns encoded signature or error
|
||||||
Alg() string
|
Alg() string // returns the alg identifier for this method (example: 'HS256')
|
||||||
}
|
}
|
||||||
|
|
||||||
// Register the "alg" name and a factory function for signing method.
|
// Register the "alg" name and a factory function for signing method.
|
||||||
|
|
Loading…
Reference in New Issue