Skip to content

Commit 9e4fa90

Browse files
committed
Java: Refer to Java types in qldoc instead of ql types.
1 parent 2650288 commit 9e4fa90

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

java/ql/src/experimental/Security/CWE/CWE-347/MissingJWTSignatureCheck.ql

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class TypeJwtHandlerAdapter extends Class {
3232
TypeJwtHandlerAdapter() { this.hasQualifiedName("io.jsonwebtoken", "JwtHandlerAdapter") }
3333
}
3434

35-
/** The `parse(token, handler)` method defined in `TypeJwtParser`. */
35+
/** The `parse(token, handler)` method defined in `JwtParser`. */
3636
private class JwtParserParseHandlerMethod extends Method {
3737
JwtParserParseHandlerMethod() {
3838
this.hasName("parse") and
@@ -41,7 +41,7 @@ private class JwtParserParseHandlerMethod extends Method {
4141
}
4242
}
4343

44-
/** The `parse(token)`, `parseClaimsJwt(token)` and `parsePlaintextJwt(token)` methods defined in `TypeJwtParser`. */
44+
/** The `parse(token)`, `parseClaimsJwt(token)` and `parsePlaintextJwt(token)` methods defined in `JwtParser`. */
4545
private class JwtParserInsecureParseMethods extends Method {
4646
JwtParserInsecureParseMethods() {
4747
this.hasName(["parse", "parseClaimsJwt", "parsePlaintextJwt"]) and
@@ -50,7 +50,7 @@ private class JwtParserInsecureParseMethods extends Method {
5050
}
5151
}
5252

53-
/** The `onClaimsJwt(jwt)` and `onPlaintextJwt(jwt)` methods defined in `TypeJwtHandler`. */
53+
/** The `onClaimsJwt(jwt)` and `onPlaintextJwt(jwt)` methods defined in `JwtHandler`. */
5454
private class JwtHandlerOnJwtMethods extends Method {
5555
JwtHandlerOnJwtMethods() {
5656
this.hasName(["onClaimsJwt", "onPlaintextJwt"]) and
@@ -59,7 +59,7 @@ private class JwtHandlerOnJwtMethods extends Method {
5959
}
6060
}
6161

62-
/** The `onClaimsJwt(jwt)` and `onPlaintextJwt(jwt)` methods defined in `TypeJwtHandlerAdapter`. */
62+
/** The `onClaimsJwt(jwt)` and `onPlaintextJwt(jwt)` methods defined in `JwtHandlerAdapter`. */
6363
private class JwtHandlerAdapterOnJwtMethods extends Method {
6464
JwtHandlerAdapterOnJwtMethods() {
6565
this.hasName(["onClaimsJwt", "onPlaintextJwt"]) and
@@ -100,24 +100,24 @@ private class JwtParserInsecureParseMethodAccess extends MethodAccess {
100100
}
101101

102102
/**
103-
* Holds if `signingMa` directly or indirectly sets a signing key for `expr`, which is a `TypeJwtParser`.
104-
* The `setSigningKey` and `setSigningKeyResolver` methods set a signing key for a `TypeJwtParser`.
103+
* Holds if `signingMa` directly or indirectly sets a signing key for `expr`, which is a `JwtParser`.
104+
* The `setSigningKey` and `setSigningKeyResolver` methods set a signing key for a `JwtParser`.
105105
* Directly means code like this:
106106
* ```java
107107
* Jwts.parser().setSigningKey(key).parse(token);
108108
* ```
109-
* Here the signing key is set directly on a `TypeJwtParser`.
109+
* Here the signing key is set directly on a `JwtParser`.
110110
* Indirectly means code like this:
111111
* ```java
112112
* Jwts.parserBuilder().setSigningKey(key).build().parse(token);
113113
* ```
114-
* In this case, the signing key is set on a `TypeJwtParserBuilder` indirectly setting the key of `TypeJwtParser` that is created by the call to `build`.
114+
* In this case, the signing key is set on a `JwtParserBuilder` indirectly setting the key of `JwtParser` that is created by the call to `build`.
115115
*/
116116
private predicate isSigningKeySet(Expr expr, MethodAccess signingMa) {
117117
any(SigningToExprDataFlow s).hasFlow(DataFlow::exprNode(signingMa), DataFlow::exprNode(expr))
118118
}
119119

120-
/** An expr that is a `TypeJwtParser` for which a signing key has been set. */
120+
/** An expr that is a `JwtParser` for which a signing key has been set. */
121121
private class JwtParserWithSigningKeyExpr extends Expr {
122122
MethodAccess signingMa;
123123

@@ -131,8 +131,8 @@ private class JwtParserWithSigningKeyExpr extends Expr {
131131
}
132132

133133
/**
134-
* Models flow from `SigningKeyMethodAccess`es to expressions that are a (sub-type of) `TypeJwtParser`.
135-
* This is used to determine whether a `TypeJwtParser` has a signing key set.
134+
* Models flow from `SigningKeyMethodAccess`es to expressions that are a (sub-type of) `JwtParser`.
135+
* This is used to determine whether a `JwtParser` has a signing key set.
136136
*/
137137
private class SigningToExprDataFlow extends DataFlow::Configuration {
138138
SigningToExprDataFlow() { this = "SigningToExprDataFlow" }
@@ -145,7 +145,7 @@ private class SigningToExprDataFlow extends DataFlow::Configuration {
145145
sink.asExpr().getType().(RefType).getASourceSupertype*() instanceof TypeJwtParser
146146
}
147147

148-
/** Models the builder style of `TypeJwtParser` and `TypeJwtParserBuilder`. */
148+
/** Models the builder style of `JwtParser` and `JwtParserBuilder`. */
149149
override predicate isAdditionalFlowStep(DataFlow::Node pred, DataFlow::Node succ) {
150150
(
151151
pred.asExpr().getType().(RefType).getASourceSupertype*() instanceof TypeJwtParser or
@@ -155,7 +155,7 @@ private class SigningToExprDataFlow extends DataFlow::Configuration {
155155
}
156156
}
157157

158-
/** An access to the `setSigningKey` or `setSigningKeyResolver` method (or an overriden method) defined in `TypeJwtParser` and `TypeJwtParserBuilder`. */
158+
/** An access to the `setSigningKey` or `setSigningKeyResolver` method (or an overriden method) defined in `JwtParser` and `JwtParserBuilder`. */
159159
private class SigningKeyMethodAccess extends MethodAccess {
160160
SigningKeyMethodAccess() {
161161
exists(Method m |

0 commit comments

Comments
 (0)