Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RamonGiovane/guiptables
A Graphic User Interface for Linux's Iptables Firewall. Made with Cockpit for CentOS
https://github.com/RamonGiovane/guiptables
Last synced: 21 days ago
JSON representation
A Graphic User Interface for Linux's Iptables Firewall. Made with Cockpit for CentOS
- Host: GitHub
- URL: https://github.com/RamonGiovane/guiptables
- Owner: RamonGiovane
- License: lgpl-2.1
- Created: 2021-01-27T00:20:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T19:35:19.000Z (about 2 months ago)
- Last Synced: 2024-10-26T17:59:59.190Z (about 2 months ago)
- Language: SCSS
- Size: 1.9 MB
- Stars: 16
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - RamonGiovane/guiptables - A Graphic User Interface for Linux's Iptables Firewall. Made with Cockpit for CentOS (SCSS)
README
# guiptables
### :us: [English Manual](#instructions) đź”—
_A Graphic User Interface for Linux's Iptables Firewall. Made with Cockpit for CentOS._
### 🇧🇷 [Manual em Português](#instruções) 🔗
_Uma interface gráfica para o Firewall do Linux, Iptables. Feito usando Cockpit para CentOS._
## Instructions
_guiptables_ is a [Cockpit](https://cockpit-project.org/) plugin.
Cockpit is a web-based graphical interface for Linux systems. Please read its documentation to understand how it works.
## 1. Installing _guiptables_
Access the [**Releases**](https://github.com/RamonGiovane/guiptables/releases) section and choose to download an executable binary package or the source code directly.
### Using the binary package
Currently, only rpm packages for RHEL-like systems are available.
Once the package has been downloaded, simply run:
rpm -i guiptables.rpm
### Using the source code
If you don't use a RHEL-like system, this is the easiest way.
You don't need to compile any code, but you must already have the following dependencies installed:
```yml
- Cockpit >= 224.2
- bash
- yum (optional, used to install Iptables in case it is not already there)
```
After installing Cockpit and downloading the source code, simply copy the repository folder to the directory of applications developed for Cockpit:
```bash
cp -r guiptables/ /usr/share/cockpit/
```
#### :warning: Caution!
The above command will replace all *guiptables* files if they already exist. Make sure to back up your logs and saves if you are installing a new version.
### Accessing the interface
When entering the Cockpit, click on **Iptables UI** to access the dashboard.
Make sure you are logged in as root or have `sudo` privileges.
If your user is not root, you will need to enter the Cockpit Administrative Access mode.
## 2. Installing _Iptables_ via Cockpit
It would sound unusual, but if Iptables is not installed, you could do it via Cockpit when running _guiptables_ for the first time:
After installation you will be asked to reload the page.
Note: this will not work if you don't have **yum** installed.
## 3. Rules list
The basic interface of _guiptables_ shows the rules applied in the firewall tables.
Each applied rule will appear in its respective table, in a line with a set of information:
- Number of packets trafficked
- Portion of data trafficked
- Chain to which it belongs
- Action it performs (job / action / target)
- The protocols that apply
- Advanced options
- Input interface
- Output interface
- Origin address
- Destination address
**All rules shown are retrieved from system memory. This means that any rule applied outside _guiptables_ will also be exhibited.**
By default, all the rules for a table are displayed, but it is possible to filter by **chain**, using the dropdown at the top of the table so that it shows how Iptables would display on the command line.
## 4. Adding a rule
### New rule at the end
To create a new rule, you must first choose one of the available chains for the table at the dropdown. Then click on the blue **âž• Add rule** button.
A window will open with the options available for your rule to be created:
### Insert new rule at position
Since the order of the rules is important, you can apply a rule in a specific order.
To do this, choose a chain from the dropdown, then click the smaller button **âž• Add rule** to the left of one of the rules in the list.
That way you would apply a new rule over the chosen rule.
That is, the new rule will occupy the position of the chosen rule.
The chosen rule will be placed one position below the new rule.
## 5. Deleting rules
To delete a rule, simply click the red **trash can button 🗑️** in the list of rules on the right.
You can also decide to delete ALL rules from ALL chains in a table at once. Just click on the **Flush Table 🗑️** button above the desired table.
## 6. Saving and loading the tables state
### Creating a backup
You may save the tables' state in an external backup file.
This option uses the **iptables-save** command internally.
To manually store the current content of the tables, go to the **config.** screen by clicking on the **blue gear ⚙️ button** at the top of the page.
You may specify the save path or leave it with the default setting. Then, click on **Save current state**.
**Do not confuse this with the Save button at the bottom.**
The **Save** button will keep any changes made at this screen, such as log path or auto-save.
### Autosave feature
You may choose to autosave the tables state on the specified save file every time a new rule is added.
Just remember that the save file will not keep history, will be always **overwritten**.
### Recovering a backup file
In order to restore a save file, just specify it on the same Save path field and then click on **Restore from this**.
After that you will be requested to reload the page.
## 7. Checking logs
You may check the last operations done inside _**guiptables**_ by clicking on the **journal iconned button đź“°**.
### What is logged?
Log is recorded every time:
- a rule is inserted or deleted
- an error occurs while trying to insert or delete a rule
- a table has been flushed
- an error occurs while flushing a table
- Iptables was installed via Cockpit
- an error occurs while installing Iptables
- the configuration file has been changed
- an error occurs while saving chnages on the configuration file
**At the settings ⚙️**, you may change the path where the log text file is saved.
## Instruções
_guiptables_ Ă© um plug-in para [Cockpit](https://cockpit-project.org/).
Cockpit é uma interface gráfica baseada na web para sistemas Linux. Por favor, leia a documentação para entender como ele funciona.
## 1. Instalando o _guiptables_
Acesse a seção de [**Releases**](https://github.com/RamonGiovane/guiptables/releases) e opte por baixar um pacote binário executável ou o código fonte diretamente;
### Usando o pacote binário
Atualmente, apenas pacotes rpm para sistemas RHEL-like estĂŁo disponĂveis.
Depois de baixado o pacote, basta executar:
rpm -i guiptables.rpm
### Usando o cĂłdigo fonte
Se você não utiliza um sistema RHEL-like, essa é a maneira mais fácil.
Não é preciso compilar nenhum código, mas é necessário que você já tenha as seguintes dependências instaladas:
```yml
- Cockpit >= 224.2
- bash
- yum (opcional, usado para instalar o Iptables no caso de nĂŁo estar)
```
Depois de instalar o Cockpit e baixar o cĂłdigo fonte, basta copiar a pasta do repositĂłrio para o diretĂłrio de aplicativos desenvolvidos para Cockpit:
```bash
cp -r guiptables/ /usr/share/cockpit/
```
#### :warning: Cuidado!
O comando acima irá substituir todos os arquivos do *guiptables* se já existirem. Certifique-se de fazer backup dos logs e saves caso esteja instalando uma nova versão.
### Acessando a interface
Ao entrar no Cockpit, clique em **Iptables** UI para acessar o painel.
Assegure-se de que você está logado como root ou tenha privilégio de `sudo`.
Se o seu usuário não for root, será necessário entrar no modo de Acesso Administrativo do Cockpit.
## 2. Instalando o _Iptables_ via Cockpit
Soaria incomum, mas caso o Iptables nĂŁo esteja instalado, vocĂŞ poderia fazĂŞ-lo via Cockpit ao executar o _guiptables_ pela primeira vez:
Após a instalação você será solicitado para recarregar a página.
Nota: isso não funcionará se você não possuir o **yum** instalado.
## 3. Listando as regras
A interface básica do _guiptables_ é mostrar as regras aplicadas nas tabelas do firewall.
Cada regra aplicada aparecerá em sua respectiva tabela, numa linha com um conjunto de informações:
- Quantidade de pacotes trafegados
- Porção de dados trafegados
- Cadeia em que pertence (chain)
- Ação que desempenha (job/action/target)
- Os protocolos que se aplicam
- Opções avançadas
- Interface de entrada
- Interface de saĂda
- Endereço de entrada
- Endereço de saĂda
**Todas as regras mostradas são recuperadas da memória do sistema. Isso significa que regras aplicadas fora do _guiptables_ também serão exibidas.**
Por padrĂŁo, sĂŁo exibidas todas as regras de uma tabela **(Show all)**, mas Ă© possĂvel filtrar pela **cadeia (chain)**, usando o dropdown no topo da tabela de maneira que mostre como o Iptables exibiria em linha de comando.
## 4. Adicionando uma regra
### Nova regra
Para criar uma nova regra, primeiro Ă© preciso escolher uma das cadeias disponĂveis para a tabela no dropdown. Em seguida, clicar no botĂŁo azul **âž• Add rule**.
Uma janela será aberta com as opções disponĂveis para que sua regra seja criada:
Ao clicar em aplicar, uma nova regra será adicionada no fim da tabela.
Uma mensagem de erro será disparada, caso sejam aplicadas opções inválidas para a regra.
### Inserir nova regra em uma posição
Como a ordem das regras Ă© importante, vocĂŞ pode aplicar uma regra em uma ordem especifica.
Para isso, escolha uma cadeia no dropdown, em seguida, clique no botĂŁo menor **âž• Add rule** Ă esquerda de uma das regras da lista.
Dessa forma vocĂŞ aplicaria uma nova regra sobre a regra escolhida.
Ou seja, a nova regra ocupará a posição da regra escolhida.
A regra escolhida ficará um posição adiante, abaixo da nova regra.
## 5. Excluindo regras
Para excluir uma regra, basta clicar no **botão de lixeira 🗑️** em vermelho na lista de regras, à direita.
Você pode optar também por excluir TODAS as regras de TODAS as cadeias de uma tabela de uma vez. Basta clicar no botão **Flush Table 🗑️** acima da tabela desejada.
## 6. Salvando e carregando o estado das tabelas
### Criando um backup
VocĂŞ pode salvar o estado das tabelas em um arquivo de backup.
Essa opção usa internamente o comando **iptables-save**.
Para manualmente gravar o conteúdo atual das tabelas do serviço Iptables, basta ir nas **configurações** clicando no **botão de engrenagem ⚙️ azul**, no topo da página.
VocĂŞ pode especificar um caminho para salvar ou deixar o padrĂŁo. Em seguida, clique em **Save current state**.
**NĂŁo confundir com o botĂŁo Save no canto inferior.**
O botão **Save** guardará as alterações feitas nessa tela de configuração, como o caminho de logs e a opção de auto-salvar.
### A função auto-salvar
VocĂŞ pode optar por auto-salvar o estado das tabelas no arquivo especificado, toda vez que uma regra for inserida.
Lembre-se que o arquivo não guardará histórico, será sempre **sobrescrito**.
### Restaurando um backup
Para restaurar um arquivo de backup, basta especifica-lo no mesmo campo e clicar no botĂŁo **Restore from this**.
Após isso será solicitado que a página seja recarregada.
## 7. Consultando logs
VocĂŞ pode checar as Ăşltimas operações realizadas dentro do _**guiptables**_ clicando no **botĂŁo com Ăcone de jornal đź“°**.
### O que Ă© salvo?
Registra-se log, toda vez que:
- uma regra for inserida ou deletada
- um erro ocorreu tentando inserir ou deletar uma regra
- uma tabela foi limpa (Flush table)
- ocorreu um erro ao limpar uma tabela
- o Iptables foi instalado via Cockpit
- ocorreu um erro ao instalar o Iptables
- alterou-se o arquivo de configuração
- ocorreu um erro ao alterar o arquivo de configuração
Você pode alterar o caminho em que o arquivo texto dos logs é salvo, **nas configurações ⚙️**.