Skip to content

Commit e90cae3

Browse files
GangGreenTemperTatumGangGreenTemperTatum
committed
feat: bytecap new repo
0 parents  commit e90cae3

27 files changed

+6378
-0
lines changed

‎.github/workflows/release.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: 🚀 Release
2+
3+
on:
4+
workflow_dispatch:
5+
6+
env:
7+
NODE_VERSION: 20
8+
PNPM_VERSION: 9
9+
10+
jobs:
11+
release:
12+
name: Release
13+
runs-on: ubuntu-latest
14+
permissions:
15+
contents: write
16+
17+
steps:
18+
- name: Checkout project
19+
uses: actions/checkout@v4
20+
21+
- name: Setup Node.js
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: ${{ env.NODE_VERSION }}
25+
26+
- name: Setup pnpm
27+
uses: pnpm/action-setup@v4
28+
with:
29+
version: ${{ env.PNPM_VERSION }}
30+
run_install: true
31+
32+
- name: Build package
33+
run: pnpm build
34+
35+
- name: Sign package
36+
working-directory: dist
37+
run: |
38+
if [[ -z "${{ secrets.PRIVATE_KEY }}" ]]; then
39+
echo "Set an ed25519 key as PRIVATE_KEY in GitHub Action secret to sign."
40+
else
41+
echo "${{ secrets.PRIVATE_KEY }}" > private_key.pem
42+
openssl pkeyutl -sign -inkey private_key.pem -out plugin_package.zip.sig -rawin -in plugin_package.zip
43+
rm private_key.pem
44+
fi
45+
46+
- name: Check version
47+
id: meta
48+
working-directory: dist
49+
run: |
50+
VERSION=$(unzip -p plugin_package.zip manifest.json | jq -r .version)
51+
echo "version=${VERSION}" >> $GITHUB_OUTPUT
52+
53+
- name: Create release
54+
uses: ncipollo/release-action@v1
55+
with:
56+
tag: ${{ steps.meta.outputs.version }}
57+
commit: ${{ github.sha }}
58+
body: 'Release ${{ steps.meta.outputs.version }}'
59+
artifacts: 'dist/plugin_package.zip,dist/plugin_package.zip.sig'

‎.github/workflows/validate.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Validate
2+
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
workflow_call:
8+
9+
concurrency:
10+
group: validate-${{ github.ref_name }}
11+
cancel-in-progress: true
12+
13+
env:
14+
CAIDO_NODE_VERSION: 20
15+
CAIDO_PNPM_VERSION: 9
16+
17+
jobs:
18+
typecheck:
19+
name: 'Typecheck'
20+
runs-on: ubuntu-latest
21+
timeout-minutes: 10
22+
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v3
26+
27+
- name: Setup Node.js
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: ${{ env.CAIDO_NODE_VERSION }}
31+
32+
- name: Setup pnpm
33+
uses: pnpm/[email protected]
34+
with:
35+
version: ${{ env.CAIDO_PNPM_VERSION }}
36+
37+
- name: Install dependencies
38+
run: pnpm install
39+
40+
- name: Run typechecker
41+
run: pnpm typecheck
42+
43+
lint:
44+
name: 'Lint'
45+
runs-on: ubuntu-latest
46+
timeout-minutes: 10
47+
steps:
48+
- name: Checkout repository
49+
uses: actions/checkout@v4
50+
51+
- name: Setup Node.js
52+
uses: actions/setup-node@v4
53+
with:
54+
node-version: ${{ env.CAIDO_NODE_VERSION }}
55+
56+
- name: Setup pnpm
57+
uses: pnpm/[email protected]
58+
with:
59+
version: ${{ env.CAIDO_PNPM_VERSION }}
60+
61+
- name: Install dependencies
62+
run: pnpm install
63+
64+
- name: Run linter
65+
run: pnpm lint

‎.gitignore

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# ─── Node & Package Manager ───────────────────────────────────────────────────
2+
3+
# Node modules
4+
node_modules/
5+
6+
# Yarn v2+ cache
7+
.yarn/cache/
8+
.yarn/unplugged/
9+
.yarn/build-state.yml
10+
.yarn/install-state.gz
11+
12+
# pnpm
13+
.pnpm-store/
14+
15+
# ─── Build Output ──────────────────────────────────────────────────────────────
16+
17+
# TypeScript compiled JS
18+
dist/
19+
build/
20+
21+
# Declaration files
22+
*.d.ts
23+
!src/caido-fixes.d.ts
24+
!packages/*/src/caido-fixes.d.ts
25+
26+
# Source maps
27+
*.js.map
28+
*.ts.map
29+
30+
# Temporary build files
31+
tmp/
32+
out/
33+
34+
# ─── Editor & OS Files ─────────────────────────────────────────────────────────
35+
36+
# macOS
37+
.DS_Store
38+
39+
# Windows
40+
Thumbs.db
41+
ehthumbs.db
42+
Desktop.ini
43+
44+
# IDEs and editors
45+
.vscode/
46+
.idea/
47+
*.suo
48+
*.ntvs*
49+
*.njsproj
50+
*.sln
51+
*.log
52+
*.sw?
53+
54+
# ─── Logs & Runtime ────────────────────────────────────────────────────────────
55+
56+
# Logs
57+
npm-debug.log*
58+
yarn-debug.log*
59+
pnpm-debug.log*
60+
lerna-debug.log*
61+
62+
# Coverage directory used by testing tools
63+
coverage/
64+
65+
# Cache directories
66+
.cache/
67+
.tmp/
68+
69+
# ─── Environment & Secrets ─────────────────────────────────────────────────────
70+
71+
# Environment variables
72+
.env
73+
.env.*.local
74+
75+
# Security / credential files
76+
*.key
77+
*.pem
78+
79+
# ─── Caido-Specific ────────────────────────────────────────────────────────────
80+
81+
# Caido plugin packages
82+
*.caidopkg
83+
plugin_package.json
84+
release_notes.md
85+
86+
# Caido local test state
87+
.caido/
88+
89+
# Development files
90+
91+
dev/
92+
93+
# Python
94+
*.pyc
95+
__pycache__/
96+
*.pyo
97+
*.pyd
98+
*.pdb
99+
*.egg-info/
100+
*.egg
101+
*.whl
102+
*.py[cod]
103+
.venv/
104+
*.env
105+
*.venv/

‎CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @GangGreenTemperTatum

‎LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) 2024 [Author]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Bytecap
2+
3+
<div align="center">
4+
5+
_Caido plugin to cap and split workspace files by size — ideal for proxy and log file uploads with file size limits_
6+
7+
[![GitHub forks](https://img.shields.io/github/forks/GangGreenTemperTatum/Bytecap?style=social)](https://github.com/GangGreenTemperTatum/Bytecap/network/members)
8+
[![GitHub issues](https://img.shields.io/github/issues/GangGreenTemperTatum/Bytecap)](https://github.com/GangGreenTemperTatum/Bytecap/issues)
9+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/GangGreenTemperTatum/Bytecap)](https://github.com/GangGreenTemperTatum/Bytecap/releases)
10+
[![GitHub stars](https://img.shields.io/github/stars/GangGreenTemperTatum/Bytecap?style=social)](https://github.com/GangGreenTemperTatum/Bytecap/stargazers)
11+
[![License](https://img.shields.io/github/license/GangGreenTemperTatum/Bytecap?branch=main)](https://github.com/GangGreenTemperTatum/Bytecap/blob/main/LICENSE)
12+
13+
[Report Bug](https://github.com/GangGreenTemperTatum/Bytecap/issues) •
14+
[Request Feature](https://github.com/GangGreenTemperTatum/Bytecap/issues)
15+
16+
![Bytecheck Panel](./public/images/bytecheck-panel.png)
17+
*Bytecheck*
18+
19+
<!-- TODO Bytecap is now available via the Caido Plugin Library! 🥳 Bytecap has been [submitted to the Caido Plugin Library](https://github.com/caido/store/pull/24) and is currently under review. Once approved, it will be available for installation directly from the Caido interface. In the meantime, you can still install it manually by following the instructions below. -->
20+
21+
</div>
22+
23+
---
24+
25+
- [Bytecap](#bytecap)
26+
- [Overview](#overview)
27+
- [Quick Start](#quick-start)
28+
- [Prerequisites](#prerequisites)
29+
- [Installation](#installation)
30+
- [Usage](#usage)
31+
- [Contributing](#contributing)
32+
- [License](#license)
33+
- [Star History](#star-history)
34+
35+
## Overview
36+
37+
Bytecap is a Caido plugin that helps you monitor and manage workspace file sizes. Perfect for scenarios where you need to upload proxy/logs or data files with strict size limits (IE certain pentesting platforms), Bytecap provides real-time file size monitoring with configurable thresholds and warnings.
38+
39+
---
40+
41+
## Quick Start
42+
43+
### Prerequisites
44+
45+
- Caido (latest version)
46+
- Node.js and pnpm (for development)
47+
48+
### Installation
49+
50+
1. **Clone the repository:**
51+
```bash
52+
git clone https://github.com/GangGreenTemperTatum/Bytecap.git
53+
cd Bytecap
54+
```
55+
56+
2. **Install dependencies:**
57+
```bash
58+
pnpm install
59+
```
60+
61+
3. **Build the plugin:**
62+
```bash
63+
pnpm build
64+
```
65+
66+
4. **Install in Caido:**
67+
- Open Caido
68+
- Go to Settings > Plugins
69+
- Click "Install from file"
70+
- Select the built plugin file from the `dist/` directory
71+
72+
### Usage
73+
74+
1. **Access Bytecap:**
75+
- After installation, find "Bytecap" in your Caido sidebar
76+
- Click to open the file size monitoring interface
77+
78+
2. **Configure your settings:**
79+
- Use the slider to set your file size threshold (1-20GB)
80+
- Enable additional warnings for 75% and 90% thresholds
81+
- Click "Apply Settings" to activate threshold monitoring
82+
- Click "Refresh Files" to scan your workspace
83+
84+
3. **Monitor your files:**
85+
- View all workspace files in the sortable table
86+
- Check color-coded status indicators
87+
- Review alerts and warnings for files exceeding threshold
88+
89+
![Bytecheck Notification](./public/images/bytecheck-popup-alert-1.png)
90+
*Bytecheck notification*
91+
92+
![Bytecheck Notification](./public/images/bytecheck-popup-alert-2.png)
93+
*Bytecheck notification*
94+
95+
## Contributing
96+
97+
1. Fork the repository
98+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
99+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
100+
4. Push to the branch (`git push origin feature/amazing-feature`)
101+
5. Open a Pull Request
102+
103+
## License
104+
105+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
106+
107+
## Star History
108+
109+
[![Star History Chart](https://api.star-history.com/svg?repos=GangGreenTemperTatum/Bytecap&type=Date)](https://star-history.com/#GangGreenTemperTatum/Bytecap&Date)
110+
111+
---
112+
113+
<div align="center">
114+
Made with ❤️ for the Caido community and angry pentesters
115+
</div>

0 commit comments

Comments
 (0)