ovpn admin

OVPN-Admin

UI da web simples para gerenciar usuários OpenVPN, seus certificados e rotas no Linux. Enquanto o back -end é escrito em Go, o front -end é baseado no vue.js.

ISENÇÃO DE RESPONSABILIDADE! Este projeto foi criado para usuários experientes (administradores de sistemas) e apenas ambientes privados (por exemplo, protegidos por políticas de rede). Portanto, não é implementado com a segurança em mente (por exemplo, não verifica estritamente todos os parâmetros passados ​​pelos usuários, etc.). Ele também depende muito de arquivos e falha se os arquivos necessários não estiverem disponíveis.

Características

• Adicionando, excluindo usuários do OpenVPN (gerando certificados para eles);
• Revogando/restaurando/rotativo de certificados de usuários;
• Gerando arquivos de configuração prontos para usuários;
• Fornecendo métricas para o Prometeu, incluindo a data de expiração dos certificados, número de usuários (conectados/total), informações sobre usuários conectados;
• (Opcionalmente) especificando CCD ( client-config-dir ) para cada usuário;
• (opcionalmente) operando em um modo mestre/escravo (sincronizando os certificados & ccd com outro servidor);
• (Opcionalmente) especificando/alterando a senha para autorização adicional no OpenVPN;
• (Opcionalmente) especificando o Kubernetes loadBalancer se for usado na frente do servidor OpenVPN (para obter um remote automaticamente definido no modelo client.conf.tpl ).
• (Opcionalmente) Armazenamento de certificados e outros arquivos nos segredos Kubernetes ( atenção, esse recurso é experimental! ).

Capturas de tela

Gerenciando usuários no OVPN-Admin:

Um exemplo de painel feito usando métricas OVPN-Admin:

Instalação

1. Docker

Existe um Docker-Compose.yaml pronto para uso, para que você possa alterar/adicionar valores que precisa e iniciá-lo com start.sh.

Requisitos: você precisa do Docker e do Docker-Compose instalados.

Comandos para executar:

git clone https://github.com/palark/ovpn-admin.git
cd ovpn-admin
./start.sh

1.1

Imagens prontas do Docker disponíveis no Docker Hub. As tags são simples: $VERSION ou latest para ovpn-admin e openvpn-$VERSION ou openvpn-latest for openvpn-server

2. Construindo da fonte

Requisitos. Você precisa do Linux com os seguintes componentes instalados:

• Golang
• Packr2
• NodeJS/NPM

Comandos para executar:

git clone https://github.com/palark/ovpn-admin.git
cd ovpn-admin
./bootstrap.sh
./build.sh
./ovpn-admin 

(Por favor, não se esqueça de configurar todos os parâmetros necessários com antecedência.)

3. Binário pré -construído

Você também pode baixar e usar binários pré -construídos na página de lançamentos - basta escolher um arquivo tar.gz relevante.

Notas

• Essa ferramenta usa chamadas externas para bash , coreutils e easy-rsa , portanto, os sistemas Linux são suportados apenas no momento.
• Para ativar a autenticação de senha adicional, forneça --auth e --auth.db="/etc/easyrsa/pki/users.db " sinalizadores e instale o OpenVPN-user. Esta ferramenta deve estar disponível no seu $PATH e seu binário deve ser executável ( +x ).
• A sincronização mestre -replica não funciona com --storage.backend=kubernetes.secrets -WIP
• A autenticação de senha adicional não funciona com --storage.backend=kubernetes.secrets -WIP
• Se você usa --ccd e --ccd.path="/etc/openvpn/ccd" ABD planeja usar a configuração de endereço estático para os usuários não se esqueça de fornecer --ovpn.network="172.16.100.0/24" com válido Rede OpenVPN-Server
• testado apenas com as versões OpenVPN-Server 2.4 e 2.5 com apenas o modo TLS-Auth
• Não testado com a versão Easyrsa> 3.0.8
• Status dos usuários As conexões atualizam a cada 28 segundos ( sem necessidade de perguntar por que =) )

Uso

 usage: ovpn-admin [<flags>]

Flags:
  --help                       show context-sensitive help (try also --help-long and --help-man)

  --listen.host="0.0.0.0"      host for ovpn-admin
  (or OVPN_LISTEN_HOST)

  --listen.port="8080"         port for ovpn-admin
  (or OVPN_LISTEN_PORT)

  --listen.base-url="/"        base URL for ovpn-admin web files
  (or $OVPN_LISTEN_BASE_URL)

  --role="master"              server role, master or slave
  (or OVPN_ROLE)

  --master.host="http://127.0.0.1"  
  (or OVPN_MASTER_HOST)       URL for the master server

  --master.basic-auth.user=""  user for master server's Basic Auth
  (or OVPN_MASTER_USER)
 
  --master.basic-auth.password=""  
  (or OVPN_MASTER_PASSWORD)   password for master server's Basic Auth

  --master.sync-frequency=600  master host data sync frequency in seconds
  (or OVPN_MASTER_SYNC_FREQUENCY)

  --master.sync-token=TOKEN    master host data sync security token
  (or OVPN_MASTER_TOKEN)

  --ovpn.network="172.16.100.0/24"  
  (or OVPN_NETWORK)           NETWORK/MASK_PREFIX for OpenVPN server

  --ovpn.server=HOST:PORT:PROTOCOL ...  
  (or OVPN_SERVER)            HOST:PORT:PROTOCOL for OpenVPN server
                               can have multiple values

  --ovpn.server.behindLB       enable if your OpenVPN server is behind Kubernetes
  (or OVPN_LB)                Service having the LoadBalancer type

  --ovpn.service="openvpn-external"  
  (or OVPN_LB_SERVICE)        the name of Kubernetes Service having the LoadBalancer
                               type if your OpenVPN server is behind it

  --mgmt=main=127.0.0.1:8989 ...  
  (or OVPN_MGMT)              ALIAS=HOST:PORT for OpenVPN server mgmt interface;
                               can have multiple values

  --metrics.path="/metrics"    URL path for exposing collected metrics
  (or OVPN_METRICS_PATH)

  --easyrsa.path="./easyrsa/"  path to easyrsa dir
  (or EASYRSA_PATH)

  --easyrsa.index-path="./easyrsa/pki/index.txt"  
  (or OVPN_INDEX_PATH)        path to easyrsa index file

  --ccd                        enable client-config-dir
  (or OVPN_CCD)

  --ccd.path="./ccd"           path to client-config-dir
  (or OVPN_CCD_PATH)

  --templates.clientconfig-path=""  
  (or OVPN_TEMPLATES_CC_PATH) path to custom client.conf.tpl

  --templates.ccd-path=""      path to custom ccd.tpl
  (or OVPN_TEMPLATES_CCD_PATH)

  --auth.password              enable additional password authorization
  (or OVPN_AUTH)

  --auth.db="./easyrsa/pki/users.db"
  (or OVPN_AUTH_DB_PATH)      database path for password authorization
  
  --log.level                  set log level: trace, debug, info, warn, error (default info)
  (or LOG_LEVEL)
  
  --log.format                 set log format: text, json (default text)
  (or LOG_FORMAT)
  
  --storage.backend            storage backend: filesystem, kubernetes.secrets (default filesystem)
  (or STORAGE_BACKEND)
 
  --version                    show application version

Autores

O OVPN-Admin foi criado originalmente em FLANT e usado internamente por anos.

Em março de 2021, tornou -se público e ainda foi desenvolvido em FLANT. Ou seja, @Vitaliy-Sn criou sua primeira versão no Python, e @Pashcovich a reescreveu em Go.

Em novembro de 2024, este projeto foi transferido para Palark, que atualmente é responsável por sua manutenção e desenvolvimento.