hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-28 10:15:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix some instances of ql/pred-doc-style for JS

Browse Source
This commit is contained in:
Erik Krogh Kristensen
2022-02-21 15:02:21 +01:00
parent 11bbd872f3
commit 1407b49a8f
33 changed files with 54 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
javascript/ql/examples/queries/dataflow/StoredXss/StoredXssTypeTracking.ql
View File

@@ -13,7 +13,7 @@ import semmle.javascript.security.dataflow.StoredXssQuery
import DataFlow::PathGraph
/**
* An instance of `mysql.createConnection()`, tracked globally.
* Gets an instance of `mysql.createConnection()`, tracked globally.
*/
DataFlow::SourceNode mysqlConnection(DataFlow::TypeTracker t) {
t.start() and
@@ -23,7 +23,7 @@ DataFlow::SourceNode mysqlConnection(DataFlow::TypeTracker t) {
}
/**
* An instance of `mysql.createConnection()`, tracked globally.
* Gets an instance of `mysql.createConnection()`, tracked globally.
*/
DataFlow::SourceNode mysqlConnection() { result = mysqlConnection(DataFlow::TypeTracker::end()) }

2
javascript/ql/experimental/adaptivethreatmodeling/lib/experimental/adaptivethreatmodeling/FunctionBodyFeatures.qll
View File

@@ -134,7 +134,7 @@ int getNumCharsInFunction(Function f) {
}
/**
* The maximum number of characters a feature can be.
* Gets the maximum number of characters a feature can be.
* The evaluator string limit is 5395415 characters. We choose a limit lower than this.
*/
private int getMaxChars() { result = 1000000 }

2
javascript/ql/experimental/adaptivethreatmodeling/modelbuilding/extraction/ExtractMisclassifiedEndpointFeatures.ql
View File

@@ -12,7 +12,7 @@ import experimental.adaptivethreatmodeling.EndpointFeatures as EndpointFeatures
import experimental.adaptivethreatmodeling.EndpointTypes
import semmle.javascript.security.dataflow.NosqlInjectionCustomizations
/** The positive endpoint type for which you wish to find misclassified examples. */
/** Gets the positive endpoint type for which you wish to find misclassified examples. */
EndpointType getEndpointType() { result instanceof NosqlInjectionSinkType }
/** Get a positive endpoint. This will be run through the classifier to determine whether it is misclassified. */

4
javascript/ql/lib/semmle/javascript/Arrays.qll
View File

@@ -16,7 +16,7 @@ module ArrayTaintTracking {
}
/**
* A taint propagating data flow edge from `pred` to `succ` caused by a call `call` to a builtin array functions.
* Holds if there is a taint propagating data flow edge from `pred` to `succ` caused by a call `call` to a builtin array functions.
*/
predicate arrayFunctionTaintStep(DataFlow::Node pred, DataFlow::Node succ, DataFlow::CallNode call) {
// `array.map(function (elt, i, ary) { ... })`: if `array` is tainted, then so are
@@ -357,7 +357,7 @@ private module ArrayLibraries {
}
/**
* A call to a library that copies the elements of an array into another array.
* Gets a call to a library that copies the elements of an array into another array.
* E.g. `array-union` that creates a union of multiple arrays, or `array-uniq` that creates an array with unique elements.
*/
DataFlow::CallNode arrayCopyCall(DataFlow::Node array) {

2
javascript/ql/lib/semmle/javascript/DOM.qll
View File

@@ -300,7 +300,7 @@ module DOM {
}
/**
* A data flow node that might refer to some form.
* Gets a data flow node that might refer to some form.
* Either by a read like `document.forms[0]`, or a property read from `document` with some constant property-name.
* E.g. if `<form name="foobar">..</form>` exists, then `document.foobar` refers to that form.
*/

4
javascript/ql/lib/semmle/javascript/JsonSchema.qll
View File

@@ -56,7 +56,7 @@ module JsonSchema {
/** Provides a model of the `ajv` library. */
module Ajv {
/** A method on `Ajv` that returns `this`. */
/** Gets a method on `Ajv` that returns `this`. */
private string chainedMethod() {
result =
["addSchema", "addMetaSchema", "removeSchema", "addFormat", "addKeyword", "removeKeyword"]
@@ -141,7 +141,7 @@ module JsonSchema {
/** Provides a model for working with the [`joi`](https://npmjs.org/package/joi) library. */
module Joi {
/** A schema created using `joi.object()` or other schemas that might refer an object schema. */
/** Gets a schema created using `joi.object()` or other schemas that might refer an object schema. */
private API::Node objectSchema() {
// A call that creates a schema that might be an object schema.
result =

2
javascript/ql/lib/semmle/javascript/SSA.qll
View File

@@ -503,7 +503,7 @@ class SsaExplicitDefinition extends SsaDefinition, TExplicitDef {
/** This SSA definition corresponds to the definition of `v` at `def`. */
predicate defines(VarDef d, SsaSourceVariable v) { this = TExplicitDef(_, _, d, v) }
/** The variable definition wrapped by this SSA definition. */
/** Gets the variable definition wrapped by this SSA definition. */
VarDef getDef() { this = TExplicitDef(_, _, result, _) }
/** Gets the basic block to which this definition belongs. */

8
javascript/ql/lib/semmle/javascript/dataflow/Nodes.qll
View File

@@ -787,16 +787,16 @@ class MemberKind extends string {
}
module MemberKind {
/** The kind of a method, such as `m() {}` */
/** Gets the kind of a method, such as `m() {}` */
MemberKind method() { result = "method" }
/** The kind of a getter accessor, such as `get f() {}`. */
/** Gets the kind of a getter accessor, such as `get f() {}`. */
MemberKind getter() { result = "getter" }
/** The kind of a setter accessor, such as `set f() {}`. */
/** Gets the kind of a setter accessor, such as `set f() {}`. */
MemberKind setter() { result = "setter" }
/** The `getter` and `setter` kinds. */
/** Gets the `getter` and `setter` kinds. */
MemberKind accessor() { result = getter() or result = setter() }
/**

4
javascript/ql/lib/semmle/javascript/dataflow/TaintTracking.qll
View File

@@ -804,13 +804,13 @@ module TaintTracking {
}
/**
* A pseudo-property a `URL` that stores a value that can be obtained
* Gets a pseudo-property a `URL` that stores a value that can be obtained
* with a `get` or `getAll` call to the `searchParams` property.
*/
private string hiddenUrlPseudoProperty() { result = "$hiddenSearchPararms" }
/**
* A pseudo-property on a `URLSearchParams` that can be obtained
* Gets a pseudo-property on a `URLSearchParams` that can be obtained
* with a `get` or `getAll` call.
*/
private string getableUrlPseudoProperty() { result = "$gettableSearchPararms" }

2
javascript/ql/lib/semmle/javascript/dataflow/internal/FlowSteps.qll
View File

@@ -480,7 +480,7 @@ private module CachedSteps {
}
/**
* A step from `pred` to `succ` through a call to an identity function.
* Holds if there is a step from `pred` to `succ` through a call to an identity function.
*/
cached
predicate identityFunctionStep(DataFlow::Node pred, DataFlow::CallNode succ) {

2
javascript/ql/lib/semmle/javascript/dependencies/Dependencies.qll
View File

@@ -21,7 +21,7 @@ abstract class Dependency extends Locatable {
abstract predicate info(string id, string v);
/**
* A use of this dependency, which is of the given `kind`.
* Gets a use of this dependency, which is of the given `kind`.
*
* Currently, the only supported kinds are `"import"` and `"use"`.
*/

2
javascript/ql/lib/semmle/javascript/frameworks/Bundling.qll
View File

@@ -99,7 +99,7 @@ private predicate isBrowserifyDependencyMap(ObjectExpr deps) {
}
/**
* A function that looks like a bundled module created
* Holds if `m` is a function that looks like a bundled module created
* by Webpack.
*
* Parameters must be named either `module` or `exports`,

4
javascript/ql/lib/semmle/javascript/frameworks/Cheerio.qll
View File

@@ -6,14 +6,14 @@ import javascript
private import semmle.javascript.security.dataflow.Xss as Xss
module Cheerio {
/** A reference to the `cheerio` function, possibly with a loaded DOM. */
/** Gets a reference to the `cheerio` function, possibly with a loaded DOM. */
private API::Node cheerioApi() {
result = API::moduleImport("cheerio")
or
result = cheerioApi().getMember(["load", "parseHTML"]).getReturn()
}
/** A reference to the `cheerio` function, possibly with a loaded DOM. */
/** Gets a reference to the `cheerio` function, possibly with a loaded DOM. */
DataFlow::SourceNode cheerioRef() { result = cheerioApi().getAUse() }
/**

2
javascript/ql/lib/semmle/javascript/frameworks/ClientRequests.qll
View File

@@ -807,7 +807,7 @@ module ClientRequest {
*/
private module ApolloClient {
/**
* A function from `apollo-client` that accepts an options object that may contain a `uri` property.
* Gets a function from `apollo-client` that accepts an options object that may contain a `uri` property.
*/
API::Node apolloUriCallee() {
result = API::moduleImport("apollo-link-http").getMember(["HttpLink", "createHttpLink"])

4
javascript/ql/lib/semmle/javascript/frameworks/CookieLibraries.qll
View File

@@ -51,12 +51,12 @@ module CookieWrites {
}
/**
* The flag that indicates that a cookie is secure.
* Gets the flag that indicates that a cookie is secure.
*/
string secure() { result = "secure" }
/**
* The flag that indicates that a cookie is HttpOnly.
* Gets the flag that indicates that a cookie is HttpOnly.
*/
string httpOnly() { result = "httpOnly" }
}

4
javascript/ql/lib/semmle/javascript/frameworks/Immutable.qll
View File

@@ -22,7 +22,7 @@ private module Immutable {
}
/**
* An import of the `Immutable` library.
* Gets an import of the `Immutable` library.
*/
API::Node immutableImport() {
result = API::moduleImport("immutable")
@@ -31,7 +31,7 @@ private module Immutable {
}
/**
* An instance of any immutable collection.
* Gets an instance of any immutable collection.
*
* This predicate keeps track of which values in the program are Immutable collections.
*/

4
javascript/ql/lib/semmle/javascript/frameworks/LdapJS.qll
View File

@@ -36,10 +36,10 @@ module LdapJS {
/** A creation of an LDAPjs filter, or object containing a filter, that doesn't sanitizes the input. */
abstract class TaintPreservingLdapFilterStep extends DataFlow::Node {
/** The input that creates (part of) an LDAPjs filter. */
/** Gets the input that creates (part of) an LDAPjs filter. */
abstract DataFlow::Node getInput();
/** The resulting LDAPjs filter. */
/** Gets the resulting LDAPjs filter. */
abstract DataFlow::Node getOutput();
}

4
javascript/ql/lib/semmle/javascript/frameworks/Markdown.qll
View File

@@ -80,7 +80,7 @@ module Markdown {
*/
private module Unified {
/**
* The creation of a parser from `unified`.
* Gets a parser from `unified`.
* The `remark` module is a shorthand that initializes `unified` with a markdown parser.
*/
DataFlow::CallNode unified() {
@@ -152,7 +152,7 @@ module Markdown {
*/
private module MarkdownIt {
/**
* The creation of a parser from `markdown-it`.
* Gets a creation of a parser from `markdown-it`.
*/
private API::Node markdownIt() {
exists(API::InvokeNode call |

2
javascript/ql/lib/semmle/javascript/frameworks/Micro.qll
View File

@@ -8,7 +8,7 @@ private module Micro {
private import DataFlow
/**
* A node that should be interpreted as a route handler, to use as starting
* Gets a node that should be interpreted as a route handler, to use as starting
* point for back-tracking.
*/
Node microRouteHandlerSink() {

2
javascript/ql/lib/semmle/javascript/frameworks/NodeJSLib.qll
View File

@@ -493,7 +493,7 @@ module NodeJSLib {
*/
module FS {
/**
* A member `member` from module `fs` or its drop-in replacements `graceful-fs`, `fs-extra`, `original-fs`.
* Gets a member `member` from module `fs` or its drop-in replacements `graceful-fs`, `fs-extra`, `original-fs`.
*/
DataFlow::SourceNode moduleMember(string member) {
result = fsModule(DataFlow::TypeTracker::end()).getAPropertyRead(member)

10
javascript/ql/lib/semmle/javascript/frameworks/Puppeteer.qll
View File

@@ -9,12 +9,12 @@ import javascript
*/
module Puppeteer {
/**
* A reference to a module import of puppeteer.
* Gets a reference to a module import of puppeteer.
*/
private API::Node puppeteer() { result = API::moduleImport(["puppeteer", "puppeteer-core"]) }
/**
* A reference to a `Browser` from puppeteer.
* Gets a reference to a `Browser` from puppeteer.
*/
private API::Node browser() {
result = API::Node::ofType("puppeteer", "Browser")
@@ -25,7 +25,7 @@ module Puppeteer {
}
/**
* A reference to a `Page` from puppeteer.
* Gets a reference to a `Page` from puppeteer.
*/
API::Node page() {
result = API::Node::ofType("puppeteer", "Page")
@@ -38,7 +38,7 @@ module Puppeteer {
}
/**
* A reference to a `Target` from puppeteer.
* Gets a reference to a `Target` from puppeteer.
*/
private API::Node target() {
result = API::Node::ofType("puppeteer", "Target")
@@ -51,7 +51,7 @@ module Puppeteer {
}
/**
* A reference to a `BrowserContext` from puppeteer.
* Gets a reference to a `BrowserContext` from puppeteer.
*/
private API::Node context() {
result = API::Node::ofType("puppeteer", "BrowserContext")

2
javascript/ql/lib/semmle/javascript/frameworks/Redux.qll
View File

@@ -27,7 +27,7 @@ module Redux {
importer.getADependenciesObject("").getADependency(dependency.getPackageName(), _)
}
/** A package that can be considered an entry point for a Redux app. */
/** Gets a package that can be considered an entry point for a Redux app. */
private PackageJSON entryPointPackage() {
result = getPackageJson(any(StoreCreation c).getFile())
or

2
javascript/ql/lib/semmle/javascript/frameworks/SQL.qll
View File

@@ -376,7 +376,7 @@ private module Sqlite {
result = API::Node::ofType("sqlite3", "Database")
}
/** A call to a query method on a Sqlite database instance that returns the same instance. */
/** Gets a call to a query method on a Sqlite database instance that returns the same instance. */
private API::Node getAChainingQueryCall() {
result = database().getMember(["all", "each", "exec", "get", "run"]).getReturn()
}

4
javascript/ql/lib/semmle/javascript/frameworks/Vue.qll
View File

@@ -43,7 +43,7 @@ module Vue {
*/
DataFlow::SourceNode vue() { result = vueLibrary().getAnImmediateUse() }
/** An API node referring to a component or `Vue`. */
/** Gets an API node referring to a component or `Vue`. */
private API::Node component() {
result = vueLibrary()
or
@@ -683,7 +683,7 @@ module Vue {
}
}
/** An API node referring to a `RouteConfig` being passed to `vue-router`. */
/** Gets an API node referring to a `RouteConfig` being passed to `vue-router`. */
private API::Node routeConfig() {
result = API::moduleImport("vue-router").getParameter(0).getMember("routes").getAMember()
or

2
javascript/ql/lib/semmle/javascript/frameworks/Vuex.qll
View File

@@ -376,7 +376,7 @@ module Vuex {
importer.getADependenciesObject("").getADependency(dependency.getPackageName(), _)
}
/** A package that can be considered an entry point for a Vuex app. */
/** Gets a package that can be considered an entry point for a Vuex app. */
private PackageJSON entryPointPackage() {
result = getPackageJson(storeRef().getAnImmediateUse().getFile())
or

6
javascript/ql/lib/semmle/javascript/frameworks/XmlParsers.qll
View File

@@ -60,7 +60,7 @@ module XML {
}
/**
* A document from the `libxmljs` library.
* Gets a document from the `libxmljs` library.
* The API is based on https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/libxmljs/index.d.ts
*/
private API::Node doc() {
@@ -74,7 +74,7 @@ module XML {
}
/**
* An `Element` from the `libxmljs` library.
* Gets an `Element` from the `libxmljs` library.
*/
private API::Node element() {
result = doc().getMember(["child", "get", "node", "root"]).getReturn()
@@ -91,7 +91,7 @@ module XML {
}
/**
* An `Attr` from the `libxmljs` library.
* Gets an `Attr` from the `libxmljs` library.
*/
private API::Node attr() {
result = element().getMember("attr").getReturn()

2
javascript/ql/lib/semmle/javascript/frameworks/jQuery.qll
View File

@@ -525,7 +525,7 @@ module JQuery {
}
}
/** A source of jQuery objects from the AST-based `JQueryObject` class. */
/** Gets a source of jQuery objects from the AST-based `JQueryObject` class. */
private DataFlow::SourceNode legacyObjectSource() {
result = any(JQueryObjectInternal e).flow().getALocalSource()
}

4
javascript/ql/lib/semmle/javascript/security/dataflow/IndirectCommandInjectionCustomizations.qll
View File

@@ -83,7 +83,7 @@ module IndirectCommandInjection {
}
/**
* A command line parsing step from `pred` to `succ`.
* Holds if there is a command line parsing step from `pred` to `succ`.
* E.g: `var succ = require("minimist")(pred)`.
*/
predicate argsParseStep(DataFlow::Node pred, DataFlow::Node succ) {
@@ -97,7 +97,7 @@ module IndirectCommandInjection {
}
/**
* A Command instance from the `commander` library.
* Gets a Command instance from the `commander` library.
*/
private API::Node commander() {
result = API::moduleImport("commander")

2
javascript/ql/lib/semmle/javascript/security/dataflow/PrototypePollutingAssignmentCustomizations.qll
View File

@@ -25,7 +25,7 @@ module PrototypePollutingAssignment {
*/
abstract class Sink extends DataFlow::Node {
/**
* The flow label relevant for this sink.
* Gets the flow label relevant for this sink.
*
* Use the `taint` label for untrusted property names, and the `ObjectPrototype` label for
* object mutations.

2
javascript/ql/lib/semmle/javascript/security/dataflow/XssThroughDomCustomizations.qll
View File

@@ -136,7 +136,7 @@ module XssThroughDom {
*/
module Forms {
/**
* A reference to an import of `Formik`.
* Gets a reference to an import of `Formik`.
*/
private DataFlow::SourceNode formik() {
result = DataFlow::moduleImport("formik")

4
javascript/ql/src/Security/CWE-352/MissingCsrfMiddleware.ql
View File

@@ -30,7 +30,7 @@ predicate isRouteHandlerUsingCookies(Routing::RouteHandler handler) {
}
/**
* Checks if `route` is preceded by the cookie middleware `cookie`.
* Holds if `route` is preceded by the cookie middleware `cookie`.
*
* A router handler following after cookie parsing is assumed to depend on
* cookies, and thus require CSRF protection.
@@ -135,7 +135,7 @@ API::CallNode passportAuthenticateCall() {
}
/**
* A call of form `passport.authenticate(..., { session: false })`, implying that the incoming
* Gets a call of form `passport.authenticate(..., { session: false })`, implying that the incoming
* request must carry its credentials rather than relying on cookies.
*
* In principle such routes should not be preceded by a cookie-parsing middleware, but to

2
javascript/ql/src/Security/CWE-730/ServerCrash.ql
View File

@@ -172,7 +172,7 @@ query predicate edges(ASTNode pred, ASTNode succ) {
}
/**
* A node in the `edge/2` relation above.
* Holds if `node` is in the `edge/2` relation above.
*/
query predicate nodes(ASTNode node) {
edges(node, _) or

2
javascript/ql/src/printAst.ql
View File

@@ -12,7 +12,7 @@ import semmle.javascript.PrintAst
import definitions
/**
* The source file to generate an AST from.
* Gets the source file to generate an AST from.
*/
external string selectedSourceFile();