Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions rules/S5659/go/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{
}
110 changes: 110 additions & 0 deletions rules/S5659/go/rule.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
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, // Noncompliant
jwt.MapClaims{
"foo": "bar",
})
token.SignedString(jwt.UnsafeAllowNoneSignatureType)
}
----

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"
)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
var hmacSecret = ...

func signToken() {
token := jwt.NewWithClaims(jwt.SigningMethodHS256,
jwt.MapClaims{
"foo": "bar",
})
token.SignedString(jwt.UnsafeAllowNoneSignatureType)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
token.SignedString(jwt.UnsafeAllowNoneSignatureType)
token.SignedString(hmacSampleSecret)

}
----

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 hmacSampleSecret, 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[]
Loading