Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add feroxbuster (forced browsing security tool) #716

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions feroxbuster/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: feroxbuster
homepage: https://github.com/epi052/feroxbuster
tagline: |
feroxbuster: A tool designed to perform Forced Browsing.
---

To update or switch versions, run `webi feroxbuster@stable` (or `@v2`, `@beta`,
etc).

### Files

These are the files / directories that are created and/or modified with this
install:

```text
~/.config/feroxbuster/ferox-config.toml
~/.local/bin/feroxbuster
```

## Cheat Sheet

> `feroxbuster` is a tool designed for Forced Browsing. Forced browsing is an
> attack where the aim is to enumerate and access resources that are not
> referenced by the web application but are still accessible by an attacker.

To run feroxbuster:

```sh
feroxbuster -u [target]
```

### Include Headers

To run feroxbuster with custom headers:

```sh
feroxbuster -u [target] -H Accept:application/json "Authorization: Bearer {token}"
```

### Proxy Traffic Through Burp

To proxy traffic through Burp:

```sh
feroxbuster -u [target] --insecure --proxy http://127.0.0.1:8080
```
55 changes: 55 additions & 0 deletions feroxbuster/install.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
#!/usr/bin/env pwsh

#######################
# Install feroxbuster #
#######################

# Every package should define these variables
$pkg_cmd_name = "feroxbuster"

$pkg_dst_cmd = "$Env:USERPROFILE\.local\bin\feroxbuster.exe"
$pkg_dst = "$pkg_dst_cmd"

$pkg_src_cmd = "$Env:USERPROFILE\.local\opt\feroxbuster-v$Env:WEBI_VERSION\bin\feroxbuster.exe"
$pkg_src_bin = "$Env:USERPROFILE\.local\opt\feroxbuster-v$Env:WEBI_VERSION\bin"
$pkg_src_dir = "$Env:USERPROFILE\.local\opt\feroxbuster-v$Env:WEBI_VERSION"
$pkg_src = "$pkg_src_cmd"

New-Item "$Env:USERPROFILE\Downloads\webi" -ItemType Directory -Force | Out-Null
$pkg_download = "$Env:USERPROFILE\Downloads\webi\$Env:WEBI_PKG_FILE"

# Fetch archive
IF (!(Test-Path -Path "$pkg_download")) {
Write-Host "Downloading feroxbuster from $Env:WEBI_PKG_URL to $pkg_download"
& curl.exe -A "$Env:WEBI_UA" -fsSL "$Env:WEBI_PKG_URL" -o "$pkg_download.part"
& move "$pkg_download.part" "$pkg_download"
}

IF (!(Test-Path -Path "$pkg_src_cmd")) {
Write-Verbose "Installing feroxbuster"

# TODO: create package-specific temp directory
# Enter tmp
pushd .local\tmp

# Remove any leftover tmp cruft
Remove-Item -Path ".\feroxbuster-v*" -Recurse -ErrorAction Ignore
Remove-Item -Path ".\feroxbuster.exe" -Recurse -ErrorAction Ignore

# Unpack archive file into this temporary directory
# Windows BSD-tar handles zip. Imagine that.
Write-Verbose "Unpacking $pkg_download"
& tar xf "$pkg_download"

# Settle unpacked archive into place
Write-Verbose "Install Location: $pkg_src_cmd"
New-Item "$pkg_src_bin" -ItemType Directory -Force | Out-Null
Move-Item -Path ".\feroxbuster-*\feroxbuster.exe" -Destination "$pkg_src_bin"

# Exit tmp
popd
}

Write-Host "Copying into '$pkg_dst_cmd' from '$pkg_src_cmd'"
Remove-Item -Path "$pkg_dst_cmd" -Recurse -ErrorAction Ignore | Out-Null
Copy-Item -Path "$pkg_src" -Destination "$pkg_dst" -Recurse
46 changes: 46 additions & 0 deletions feroxbuster/install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
#!/bin/sh

# shellcheck disable=SC2034
# "'pkg_cmd_name' appears unused. Verify it or export it."

__init_feroxbuster() {
set -e
set -u

##################
# Install feroxbuster #
##################

# Every package should define these 6 variables
pkg_cmd_name="feroxbuster"

pkg_dst_cmd="$HOME/.local/bin/feroxbuster"
pkg_dst="$pkg_dst_cmd"

pkg_src_cmd="$HOME/.local/opt/feroxbuster-v$WEBI_VERSION/bin/feroxbuster"
pkg_src_dir="$HOME/.local/opt/feroxbuster-v$WEBI_VERSION"
pkg_src="$pkg_src_cmd"

# pkg_install must be defined by every package
pkg_install() {
# ~/.local/opt/feroxbuster-v0.99.9/bin
mkdir -p "$(dirname "${pkg_src_cmd}")"

# mv ./feroxbuster-*/feroxbuster ~/.local/opt/feroxbuster-v0.99.9/bin/feroxbuster
mv ./feroxbuster "${pkg_src_cmd}"
}

# pkg_get_current_version is recommended, but not required
pkg_get_current_version() {
# 'feroxbuster --version' has output in this format:
# feroxbuster 0.99.9 (rev abcdef0123)
# This trims it down to just the version number:
# 0.99.9
feroxbuster --version 2> /dev/null |
head -n 1 |
cut -d ' ' -f 2
}

}

__init_feroxbuster
20 changes: 20 additions & 0 deletions feroxbuster/releases.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
'use strict';

var github = require('../_common/github.js');
var owner = 'epi052';
var repo = 'feroxbuster';

module.exports = function (request) {
return github(request, owner, repo).then(function (all) {
return all;
});
};

if (module === require.main) {
module.exports(require('@root/request')).then(function (all) {
all = require('../_webi/normalize.js')(all);
// just select the first 5 for demonstration
all.releases = all.releases.slice(0, 5);
console.info(JSON.stringify(all, null, 2));
});
}
32 changes: 22 additions & 10 deletions powershell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,22 @@ tagline: |

To update or switch versions, run `webi pwsh@stable` (or `@v7.4`, `@beta`, etc).

## Cheat Sheet

> The core benefit of running `pwsh` on Mac or Linux is that you get a way to
> debug Windows scripts without having to boot up Windows.

For example, if you want to create a `curl.exe -A "windows" | powershell` script
for Windows (as we do), it's helpful to be able to do some level of debugging on
other platforms.

## Table of Contents

- Files
- vim
- lint
- fmt

### Files

These are the files / directories that are created and/or modified with this
Expand All @@ -15,18 +31,10 @@ install:
```text
~/.config/envman/PATH.env
~/.local/opt/pwsh/
~/.local/share/powershell/Modules
~/.local/share/powershell/Modules/
~/.local/opt/pwsh/Modules/
```

## Cheat Sheet

> The core benefit of running `pwsh` on Mac or Linux is that you get a way to
> debug Windows scripts without having to boot up Windows.

For example, if you want to create a `curl.exe -A "windows" | powershell` script
for Windows (as we do), it's helpful to be able to do some level of debugging on
other platforms.

### How to Use PowerShell with Vim

Assuming you have [vim-ale](../vim-ale/) installed - which is included with
Expand All @@ -35,6 +43,10 @@ Assuming you have [vim-ale](../vim-ale/) installed - which is included with

See the "Lint & Fmt" section below.

### How to Use PowerShell with VSCode

_VS Code_ should also automatically recognize and use `PSScriptAnalyzer`.

### How to Lint & Fmt ps1 Files

You must install `PSScriptAnalyzer`. Then you can use `Invoke-ScriptAnalyzer`
Expand Down
25 changes: 25 additions & 0 deletions psscriptanalyzer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: PSScriptAnalyzer
homepage: https://github.com/PowerShell/PSScriptAnalyzer
tagline: |
PSScriptAnalyzer is Formatter & Linter for PowerShell.
---

To update or switch versions, run `webi psscriptanalyzer`.

## Cheat Sheet

### Files

These are the files / directories that are created and/or modified with this
install:

```text
~/.local/share/powershell/Modules/
```

## Check the Installed Version

```pwsh
Get-Module -ListAvailable
```
15 changes: 15 additions & 0 deletions psscriptanalyzer/install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/sh
set -e
set -x

__install_psscriptanalyzer() {
echo "Checking for pwsh (PowerShell Core)..."
if ! command -v pwsh > /dev/null; then
"$HOME/.local/bin/webi" pwsh
export PATH="$HOME/.local/opt/pwsh:$PATH"
fi

pwsh -Command "Install-Module -Name PSScriptAnalyzer -Scope CurrentUser -AllowClobber"
}

__install_psscriptanalyzer