Skip to content

Commit 496ea0a

Browse files
luizomfclaude
andcommitted
docs: add README with project overview and tool descriptions
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 24f2fa8 commit 496ea0a

1 file changed

Lines changed: 95 additions & 1 deletion

File tree

README.md

Lines changed: 95 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,95 @@
1-
# WRITEME
1+
# SSH Toolkit
2+
3+
Toolkit SSH completo no navegador: gere chaves, endureça servidores, configure
4+
clientes e monte túneis. 100% client-side, zero tracking.
5+
6+
**https://sshtoolkit.otaviomiranda.com.br**
7+
8+
---
9+
10+
## Ferramentas
11+
12+
| Ferramenta | Rota | Status |
13+
|------------|------|--------|
14+
| **Tunnel Builder** | [`/tunnels`](https://sshtoolkit.otaviomiranda.com.br/tunnels/) | Disponivel |
15+
| **Server Hardening** | `/hardening` | Em breve |
16+
| **Client Config** | `/config` | Em breve |
17+
| **Key Generator** | `/keygen` | Em breve |
18+
19+
### Tunnel Builder
20+
21+
Monte comandos de SSH Tunnel com diagramas visuais.
22+
23+
- Local Forward (`-L`) — traga uma porta remota pra sua maquina
24+
- Remote Forward (`-R`) — exponha uma porta local pelo servidor
25+
- Dynamic Forward (`-D`) — proxy SOCKS pelo servidor SSH
26+
- Flags: `-N`, `-f`, `-C`, `ExitOnForwardFailure`, keepalive
27+
- Saida: comando SSH, `autossh` persistente, bloco `~/.ssh/config`
28+
- Diagrama visual do fluxo do tunel
29+
30+
### Server Hardening *(em breve)*
31+
32+
Gere um `sshd_config` endurecido com score de seguranca, presets
33+
(Paranoico / Equilibrado / Permissivo) e script de aplicacao.
34+
35+
### Client Config *(em breve)*
36+
37+
Monte seu `~/.ssh/config` com hosts, ProxyJump chains, forwards e wildcards.
38+
Importe um config existente e edite visualmente.
39+
40+
### Key Generator *(em breve)*
41+
42+
Gere pares de chaves Ed25519 e RSA direto no navegador via Web Crypto API.
43+
44+
---
45+
46+
## Privacidade
47+
48+
Tudo roda no seu navegador. Nenhum dado sai da sua maquina. Sem API, sem
49+
cookies, sem analytics. Abra o DevTools e confira a aba Network.
50+
51+
---
52+
53+
## Stack
54+
55+
- [Astro](https://astro.build/) 6.x — static site generator
56+
- TypeScript 5.x
57+
- Web Crypto API (keygen)
58+
- [fflate](https://github.com/101arrowz/fflate) (ZIP)
59+
- [Vitest](https://vitest.dev/) (testes)
60+
- GitHub Pages (deploy)
61+
62+
---
63+
64+
## Desenvolvimento
65+
66+
```bash
67+
# Requisitos: Node.js >= 22.12.0
68+
69+
# Instalar dependencias
70+
npm install
71+
72+
# Dev server
73+
npm run dev
74+
75+
# Rodar testes
76+
npm test
77+
78+
# Build
79+
npm run build
80+
```
81+
82+
---
83+
84+
## Autor
85+
86+
**Otavio Miranda**[otaviomiranda.com.br](https://www.otaviomiranda.com.br)
87+
88+
- [YouTube](https://www.youtube.com/@otaboranern)
89+
- [GitHub](https://github.com/luizomf)
90+
91+
---
92+
93+
## Licenca
94+
95+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)