Skip to content

Commit 2cb0afe

Browse files
committed
fix some qldocs and some spells
1 parent 1aa4494 commit 2cb0afe

File tree

3 files changed

+20
-22
lines changed

3 files changed

+20
-22
lines changed

go/ql/src/experimental/CWE-522-DecompressionBombs/DecompressionBombs.ql

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
*/
1313

1414
import go
15-
import semmle.go.dataflow.Properties
1615
import MultipartAndFormRemoteSource
1716
import experimental.frameworks.DecompressionBombs
1817

@@ -28,7 +27,7 @@ module DecompressionBombsConfig implements DataFlow::StateConfigSig {
2827
sink instanceof DecompressionBombs::Sink and
2928
state =
3029
[
31-
"ZstdNewReader", "XzNewReader", "GzipNewReader", "S2NewReader", "SnapyNewReader",
30+
"ZstdNewReader", "XzNewReader", "GzipNewReader", "S2NewReader", "SnappyNewReader",
3231
"ZlibNewReader", "FlateNewReader", "Bzip2NewReader", "ZipOpenReader", "ZipKlauspost"
3332
]
3433
}

go/ql/src/experimental/CWE-522-DecompressionBombs/MultipartAndFormRemoteSource.qll

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import go
2-
import semmle.go.dataflow.Properties
32

43
class MimeMultipartFileHeader extends UntrustedFlowSource::Range {
54
MimeMultipartFileHeader() {

go/ql/src/experimental/frameworks/DecompressionBombs.qll

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ module DecompressionBombs {
55
FlowState() {
66
this =
77
[
8-
"ZstdNewReader", "XzNewReader", "GzipNewReader", "S2NewReader", "SnapyNewReader",
8+
"ZstdNewReader", "XzNewReader", "GzipNewReader", "S2NewReader", "SnappyNewReader",
99
"ZlibNewReader", "FlateNewReader", "Bzip2NewReader", "ZipOpenReader", "ZipKlauspost", ""
1010
]
1111
}
@@ -36,7 +36,7 @@ module DecompressionBombs {
3636
abstract class Sink extends DataFlow::Node { }
3737

3838
/**
39-
* Provides Decompression Sinks and additional flow steps for `github.com/DataDog/zstd` package
39+
* Provides decompression bomb sinks and additional flow steps for `github.com/DataDog/zstd` package
4040
*/
4141
module DataDogZstd {
4242
class TheSink extends Sink {
@@ -71,7 +71,7 @@ module DecompressionBombs {
7171
}
7272

7373
/**
74-
* Provides Decompression Sinks and additional flow steps for `github.com/klauspost/compress/zstd` package
74+
* Provides decompression bomb sinks and additional flow steps for `github.com/klauspost/compress/zstd` package
7575
*/
7676
module KlauspostZstd {
7777
class TheSink extends Sink {
@@ -181,7 +181,7 @@ module DecompressionBombs {
181181
}
182182

183183
/**
184-
* Provides Decompression Sinks and additional taint steps for `github.com/ulikunitz/xz` package
184+
* Provides decompression bomb sinks and additional flow steps for `github.com/ulikunitz/xz` package
185185
*/
186186
module UlikunitzXz {
187187
class TheSink extends Sink {
@@ -215,7 +215,7 @@ module DecompressionBombs {
215215
}
216216

217217
/**
218-
* Provides Decompression Sinks and additional taint steps for `compress/gzip` package
218+
* Provides decompression bomb sinks and additional flow steps for `compress/gzip` package
219219
*/
220220
module CompressGzip {
221221
class TheSink extends Sink {
@@ -250,7 +250,7 @@ module DecompressionBombs {
250250
}
251251

252252
/**
253-
* Provides Decompression Sinks and additional taint steps for `github.com/klauspost/compress/gzip` package
253+
* Provides decompression bomb sinks and additional flow steps for `github.com/klauspost/compress/gzip` package
254254
*/
255255
module KlauspostGzip {
256256
class TheSink extends Sink {
@@ -295,7 +295,7 @@ module DecompressionBombs {
295295
}
296296

297297
/**
298-
* Provides Decompression Sinks and additional taint steps for `compress/bzip2` package
298+
* Provides decompression bomb sinks and additional flow steps for `compress/bzip2` package
299299
*/
300300
module CompressBzip2 {
301301
class TheSink extends Sink {
@@ -330,7 +330,7 @@ module DecompressionBombs {
330330
}
331331

332332
/**
333-
* Provides Decompression Sinks and additional taint steps for `github.com/dsnet/compress/bzip2` package
333+
* Provides decompression bomb sinks and additional flow steps for `github.com/dsnet/compress/bzip2` package
334334
*/
335335
module DsnetBzip2 {
336336
class TheSink extends Sink {
@@ -365,7 +365,7 @@ module DecompressionBombs {
365365
}
366366

367367
/**
368-
* Provides Decompression Sinks and additional taint steps for `github.com/dsnet/compress/flate` package
368+
* Provides decompression bomb sinks and additional flow steps for `github.com/dsnet/compress/flate` package
369369
*/
370370
module DsnetFlate {
371371
class TheSink extends Sink {
@@ -400,7 +400,7 @@ module DecompressionBombs {
400400
}
401401

402402
/**
403-
* Provides Decompression Sinks and additional taint steps for `compress/flate` package
403+
* Provides decompression bomb sinks and additional flow steps for `compress/flate` package
404404
*/
405405
module CompressFlate {
406406
class TheSink extends Sink {
@@ -435,7 +435,7 @@ module DecompressionBombs {
435435
}
436436

437437
/**
438-
* Provides Decompression Sinks and additional taint steps for `github.com/klauspost/compress/flate` package
438+
* Provides decompression bomb sinks and additional flow steps for `github.com/klauspost/compress/flate` package
439439
*/
440440
module KlauspostFlate {
441441
class TheSink extends Sink {
@@ -472,7 +472,7 @@ module DecompressionBombs {
472472
}
473473

474474
/**
475-
* Provides Decompression Sinks and additional taint steps for `github.com/klauspost/compress/zlib` package
475+
* Provides decompression bomb sinks and additional flow steps for `github.com/klauspost/compress/zlib` package
476476
*/
477477
module KlauspostZlib {
478478
class TheSink extends Sink {
@@ -509,7 +509,7 @@ module DecompressionBombs {
509509
}
510510

511511
/**
512-
* Provides Decompression Sinks and additional taint steps for `compress/zlib` package
512+
* Provides decompression bomb sinks and additional flow steps for `compress/zlib` package
513513
*/
514514
module CompressZlib {
515515
class TheSink extends Sink {
@@ -544,7 +544,7 @@ module DecompressionBombs {
544544
}
545545

546546
/**
547-
* Provides Decompression Sinks and additional taint steps for `github.com/golang/snappy` package
547+
* Provides decompression bomb sinks and additional flow steps for `github.com/golang/snappy` package
548548
*/
549549
module GolangSnappy {
550550
class TheSink extends Sink {
@@ -570,7 +570,7 @@ module DecompressionBombs {
570570
fromNode = call.getArgument(0) and
571571
toNode = call.getResult(0) and
572572
fromState = "" and
573-
toState = "SnapyNewReader"
573+
toState = "SnappyNewReader"
574574
)
575575
}
576576

@@ -581,7 +581,7 @@ module DecompressionBombs {
581581
}
582582

583583
/**
584-
* Provides Decompression additional taint steps for `github.com/klauspost/compress/snappy` package
584+
* Provides decompression bombs sinks and additional flow steps for `github.com/klauspost/compress/snappy` package
585585
*/
586586
module KlauspostSnappy {
587587
class TheAdditionalTaintStep extends AdditionalTaintStep {
@@ -597,7 +597,7 @@ module DecompressionBombs {
597597
fromNode = call.getArgument(0) and
598598
toNode = call.getResult(0) and
599599
fromState = "" and
600-
toState = "SnapyNewReader"
600+
toState = "SnappyNewReader"
601601
)
602602
}
603603

@@ -619,7 +619,7 @@ module DecompressionBombs {
619619
}
620620

621621
/**
622-
* Provides Decompression Sinks and additional taint steps for `github.com/klauspost/compress/s2` package
622+
* Provides decompression bomb sinks and additional flow steps for `github.com/klauspost/compress/s2` package
623623
*/
624624
module KlauspostS2 {
625625
class TheSink extends DataFlow::Node {
@@ -658,7 +658,7 @@ module DecompressionBombs {
658658
}
659659

660660
/**
661-
* Provides Decompression Sinks for packages that use some standard IO interfaces/methods for reading decompressed data
661+
* Provides decompression bomb sinks for packages that use some standard IO interfaces/methods for reading decompressed data
662662
*/
663663
module GeneralReadIoSink {
664664
class TheSink extends Sink {

0 commit comments

Comments
 (0)