TaintedPermissionsCheck docs

Author: egregius313

java/ql/lib/semmle/code/java/security/TaintedPermissionsCheckQuery.qll

@@ -20,7 +20,11 @@ private class TypeShiroWildCardPermission extends RefType {
   }
 }
 
+/**
+ * An expression that constructs a permission.
+ */
 abstract class PermissionsConstruction extends Top {
+  /** Gets the input to this permission construction. */
   abstract Expr getInput();
 }
 
@@ -46,6 +50,9 @@ private class WildCardPermissionConstruction extends ClassInstanceExpr, Permissi
   override Expr getInput() { result = this.getArgument(0) }
 }
 
+/**
+ * A configuration for tracking flow from user input to a permissions check.
+ */
 module TaintedPermissionsCheckFlowConfig implements DataFlow::ConfigSig {
   predicate isSource(DataFlow::Node source) { source instanceof UserInput }
 
@@ -54,4 +61,5 @@ module TaintedPermissionsCheckFlowConfig implements DataFlow::ConfigSig {
   }
 }
 
+/** Tracks flow from user input to a permissions check. */
 module TaintedPermissionsCheckFlow = TaintTracking::Global<TaintedPermissionsCheckFlowConfig>;