elastic / protections-artifacts - Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope

Files includes and excluded from analyses

yar

txt

gitattributes

lua

10 extensions are included in analyses: toml, yar, md, txt, gitignore, py, gitattributes, ps1, lua, yaml
1 criterion is used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (8 files).

The source code folder contains 1,693 files:

1,681 files are included in analyses.
12 files are excluded from analyses:

Explore all files....

Overview of Analyzed Files

Basic stats on analyzed files

Intro

For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.

The main category contains all manually created source code files that are being used in the production.
Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
Test source code files are used only for testing of the product. These files are normally not deployed to production.
Build and deployment source code files are used to configure or support build and deployment process.
Generated source code files are automatically generated files that have not been manually changed after generation.
While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.

1,674 files

7 files

Main Code

All manually created or maintained source code that defines logic of the product that is run in a production environment.

yar

lua

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

1674 files match defined criteria (113,130 LOC, 100.0% vs. main code):

1,035 *.toml files (68,216 LOC)
636 *.yar files (41,731 LOC)
1 *.lua files (3,044 LOC)
1 *.ps1 files (78 LOC)
1 *.py files (61 LOC)

" *.toml" is biggest, containing 60.3% of LOC.
" *.py" is smallest, containing 0.05% of LOC.

Other Code

txt

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]md".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*[.]txt".
files with paths like ".*/LICENSE[.][a-z0-9]+".
files with paths like ".*/[.]gitignore".

7 files match defined criteria (214 LOC, 0.2% vs. main code):

6 *.md files (148 LOC)
1 *.txt files (66 LOC)

" *.md" is biggest, containing 69.16% of LOC.
" *.txt" is smallest, containing 30.84% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.toml files are analyzed with DefaultLanguageAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)

No unit size analysis

No conditional complexity analysis

No dependency analysis

*.yar files are analyzed with DefaultLanguageAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)

No unit size analysis

No conditional complexity analysis

No dependency analysis

*.lua files are analyzed with LuaAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)

Unit size analysis

Conditional complexity analysis

No dependency analysis

*.ps1 files are analyzed with DefaultLanguageAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)

No unit size analysis

No conditional complexity analysis

No dependency analysis

*.py files are analyzed with PythonAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)

Unit size analysis

Conditional complexity analysis

Basic heuristic dependency analysis

2025-05-13 20:00