How lolbas-project/lolbas works
Project type and purpose
• This is a data‐driven, static content repository. Its sole purpose is to host and maintain the YAML definitions (LOLBins, LOLScripts, LOLLibs) that power a fancy public frontend (https://lolbas-project.github.io). It is not a “traditional” full-stack app with a runtime backend. Instead, it is essentially:
• A GitHub repo of source data (YML files)
• A CI/CD pipeline (GitHub Actions) that validates and publishes those files as a static site via GitHub Pages
File structure
• Top‐level:
• .github/workflows/ → CI workflows: yaml‐linting.yml (validates every YML), gh-pages.yml (build/deploy to GitHub Pages)
• YML‐Schema.yml & YML‐Template.yml → Schema & sample template for each entry
• yml/… → All the categorized data files that document each binary/script/library
• README.md, CONTRIBUTING.md, LICENSE, NOTICE.md, Backlog.txt → Documentation & governance
• No backend code or “src” folder—this is purely content + CI config.
README for additional insights
• The README confirms the goal: “document every binary, script, and library…used for Living Off The Land techniques.”
• It calls out two major technical “runtime” components:
a) The CI pipelines that lint and publish the content
b) The static site (hosted on GitHub Pages) that consumes the YML
Main components and relationships
A. Actors
1. Contributor (local machine)
2. End-user (browser)
B. Data Source
• yml/ directory (hundreds of .yml files)
• YML‐Schema.yml & YML‐Template.yml
C. CI/CD
1. GitHub Actions – YAML Linting workflow
2. GitHub Actions – GH Pages deployment workflow
D. Hosting & Delivery
• gh-pages branch (or /docs)
• GitHub Pages serving static HTML/CSS/JS
E. (Optional external) Frontend code
– The “fancy frontend” may be part of this repo’s Pages site (using Jekyll/JavaScript) or a separate project that pulls from these YML files
1. Contributor commits new/updated YML → pushes to origin/master
2. GitHub Actions “yaml-linting.yml” triggers → runs schema validation & lint rules
• On failure: PR is blocked, errors reported
• On success: proceeds
3. GitHub Actions “gh-pages.yml” triggers → builds static site (Jekyll, Eleventy, or custom script consuming the yml/) → pushes output to gh-pages branch
4. GitHub Pages detects gh-pages branch → serves the site at https://lolbas-project.github.io
5. End-users browse the site → dynamic client-side code reads pre-built JSON/HTML pages generated from the yml files
Architectural patterns & design principles
• Data-as-code: Every piece of content is plain YAML, versioned in Git
• CI/CD pipeline: Lint → Build → Deploy
• Static Site Generation: No dynamic backend at runtime, only client-side or Jekyll processing
• Schema‐driven: YML‐Schema.yml enforces consistency across hundreds of entries
Relevant technologies/frameworks/libraries
• Git, GitHub
• GitHub Actions (YAML linting, Pages deploy)
• YAML schema validation (JSON Schema or custom linter)
• GitHub Pages (Jekyll or static HTML/JS)
• Browser (client-side JS to enhance navigation/search)