Create rule S5659: JWT should be signed and verified with strong cipher algorithms for Go (#4668)

* Add go to rule S5659

* SONARGO-211: Add RSPEC for S5659 for Go

* Improve code examples

* Update rules/S5659/go/rule.adoc

Co-authored-by: teemu-rytilahti-sonarsource <teemu.rytilahti@sonarsource.com>

---------

Co-authored-by: daniel-teuchert-sonarsource <daniel-teuchert-sonarsource@users.noreply.github.com>
Co-authored-by: Daniel Teuchert <daniel.teuchert@sonarsource.com>
Co-authored-by: daniel-teuchert-sonarsource <141642369+daniel-teuchert-sonarsource@users.noreply.github.com>
Co-authored-by: teemu-rytilahti-sonarsource <teemu.rytilahti@sonarsource.com>
This commit is contained in:
github-actions[bot] 2025-02-25 16:42:12 +01:00 committed by GitHub
parent 5e6349e3a1
commit de3124561f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 113 additions and 0 deletions

View File

@ -0,0 +1,2 @@
{
}

111
rules/S5659/go/rule.adoc Normal file
View File

@ -0,0 +1,111 @@
include::../summary.adoc[]
== Why is this an issue?
include::../rationale.adoc[]
include::../impact.adoc[]
== How to fix it
=== Code examples
==== Noncompliant code example
The following example uses the `SigningMethodNone` method to sign a token. This method does not sign the token, which means that the token is not protected against tampering.
[source,go,diff-id=1,diff-type=noncompliant]
----
import (
jwt "github.com/golang-jwt/jwt/v5"
)
func signToken() {
token := jwt.NewWithClaims(jwt.SigningMethodNone,
jwt.MapClaims{
"foo": "bar",
})
token.SignedString(jwt.UnsafeAllowNoneSignatureType) // Noncompliant
}
----
The following example uses the `UnsafeAllowNoneSignatureType` method to verify a token. This method does not verify the token, which means that the token is not protected against tampering.
[source,go,diff-id=2,diff-type=noncompliant]
----
import (
jwt "github.com/golang-jwt/jwt/v5"
)
func verifyToken(string tokenString) {
token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
return jwt.UnsafeAllowNoneSignatureType, nil // Noncompliant
})
}
----
==== Compliant solution
The following example uses the `HS256` method to sign a token. This method signs the token using the HMAC algorithm with the secret key.
[source,go,diff-id=1,diff-type=compliant]
----
import (
jwt "github.com/golang-jwt/jwt/v5"
)
var hmacSecret = ...
func signToken() {
token := jwt.NewWithClaims(jwt.SigningMethodHS256,
jwt.MapClaims{
"foo": "bar",
})
token.SignedString(hmacSecret)
}
----
The following example first checks that the signing method is HMAC and then returns the secret key to verify the token.
[source,go,diff-id=2,diff-type=compliant]
----
import (
jwt "github.com/golang-jwt/jwt/v5"
)
var hmacSecret = ...
func verifyToken(string tokenString) {
token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
// Check the signing method
if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
return nil, fmt.Errorf("unexpected signing method: %v", token.Header["alg"])
}
return hmacSecret, nil
})
}
----
=== How does this work?
include::../common/fix/decode.adoc[]
=== Going the extra mile
include::../common/extra-mile/key-storage.adoc[]
include::../common/extra-mile/key-rotation.adoc[]
== Resources
include::../common/resources/standards.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
endif::env-github,rspecator-view[]