Skip to content

Commit 3ae3a87

Browse files
Fix qldoc grammar and style mistakes
Co-authored-by: intrigus-lgtm <[email protected]>
1 parent 408db41 commit 3ae3a87

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

java/ql/src/semmle/code/java/security/LdapInjection.qll

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ abstract class LdapInjectionSanitizer extends DataFlow::Node { }
1616
/**
1717
* A unit class for adding additional taint steps.
1818
*
19-
* Extend this class to add additional taint steps that should apply to the LdapInjectionFlowConfig.
19+
* Extend this class to add additional taint steps that should apply to the `LdapInjectionFlowConfig`.
2020
*/
2121
class LdapInjectionAdditionalTaintStep extends TaintTracking::Unit {
2222
/**
2323
* Holds if the step from `node1` to `node2` should be considered a taint
24-
* step for the LdapInjectionFlowConfig configuration.
24+
* step for the `LdapInjectionFlowConfig` configuration.
2525
*/
2626
abstract predicate step(DataFlow::Node node1, DataFlow::Node node2);
2727
}
@@ -37,22 +37,22 @@ private class DefaultLdapInjectionSink extends LdapInjectionSink {
3737
}
3838
}
3939

40-
/** Holds if the method parameter at index is susceptible to a LDAP injection attack. */
40+
/** Holds if the method parameter at `index` is susceptible to an LDAP injection attack. */
4141
private predicate ldapInjectionSinkMethod(Method m, int index) {
4242
jndiLdapInjectionSinkMethod(m, index) or
4343
unboundIdLdapInjectionSinkMethod(m, index) or
4444
springLdapInjectionSinkMethod(m, index) or
4545
apacheLdapInjectionSinkMethod(m, index)
4646
}
4747

48-
/** Holds if the JNDI method parameter at index is susceptible to a LDAP injection attack. */
48+
/** Holds if the JNDI method parameter at `index` is susceptible to an LDAP injection attack. */
4949
private predicate jndiLdapInjectionSinkMethod(Method m, int index) {
5050
m.getDeclaringType().getAnAncestor() instanceof TypeDirContext and
5151
m.hasName("search") and
5252
index in [0 .. 1]
5353
}
5454

55-
/** Holds if the UnboundID method parameter at `index` is susceptible to a LDAP injection attack. */
55+
/** Holds if the UnboundID method parameter at `index` is susceptible to an LDAP injection attack. */
5656
private predicate unboundIdLdapInjectionSinkMethod(Method m, int index) {
5757
exists(Parameter param | m.getParameter(index) = param and not param.isVarargs() |
5858
m instanceof MethodUnboundIdLDAPConnectionSearch or
@@ -61,7 +61,7 @@ private predicate unboundIdLdapInjectionSinkMethod(Method m, int index) {
6161
)
6262
}
6363

64-
/** Holds if the Spring method parameter at `index` is susceptible to a LDAP injection attack. */
64+
/** Holds if the Spring method parameter at `index` is susceptible to an LDAP injection attack. */
6565
private predicate springLdapInjectionSinkMethod(Method m, int index) {
6666
// LdapTemplate.authenticate, LdapTemplate.find* or LdapTemplate.search* method
6767
(
@@ -84,15 +84,15 @@ private predicate springLdapInjectionSinkMethod(Method m, int index) {
8484
)
8585
}
8686

87-
/** Holds if the Apache LDAP API method parameter at `index` is susceptible to a LDAP injection attack. */
87+
/** Holds if the Apache LDAP API method parameter at `index` is susceptible to an LDAP injection attack. */
8888
private predicate apacheLdapInjectionSinkMethod(Method m, int index) {
8989
exists(Parameter param | m.getParameter(index) = param and not param.isVarargs() |
9090
m.getDeclaringType().getAnAncestor() instanceof TypeApacheLdapConnection and
9191
m.hasName("search")
9292
)
9393
}
9494

95-
/** A sanitizer that clears the taint on (boxed) primitive types */
95+
/** A sanitizer that clears the taint on (boxed) primitive types. */
9696
private class DefaultLdapSanitizer extends LdapInjectionSanitizer {
9797
DefaultLdapSanitizer() {
9898
this.getType() instanceof PrimitiveType or

0 commit comments

Comments
 (0)