Add API key management functionality with views, forms, and templates

This commit is contained in:
Eduardo Silva
2026-02-09 21:59:16 -03:00
parent 533fed2bec
commit a7985ba065
8 changed files with 383 additions and 8 deletions

71
api_v2/forms.py Normal file
View File

@@ -0,0 +1,71 @@
from crispy_forms.helper import FormHelper
from crispy_forms.layout import Column, HTML, Layout, Row, Submit
from django import forms
from django.urls import reverse
from django.utils.translation import gettext_lazy as _
from .models import ApiKey
class ApiKeyForm(forms.ModelForm):
class Meta:
model = ApiKey
fields = [
'name',
'allowed_instances',
'allow_restart',
'allow_reload',
'allow_export',
'enabled',
]
def __init__(self, *args, **kwargs):
self.user = kwargs.pop('user', None)
super().__init__(*args, **kwargs)
self.helper = FormHelper()
self.helper.form_method = 'post'
back_label = _("Back")
delete_label = _("Delete")
regenerate_label = _("Regenerate Token")
if self.instance.pk:
delete_url = reverse('api_v2_delete', kwargs={'uuid': self.instance.uuid})
delete_html = f"<a href='{delete_url}' class='btn btn-outline-danger'>{delete_label}</a>"
regenerate_html = f'<button type="submit" name="regenerate_token" value="true" class="btn btn-warning" onclick="return confirm(\'{_("Are you sure you want to regenerate the token? The old token will stop working immediately.")}\')">{regenerate_label}</button>'
else:
delete_html = ''
regenerate_html = ''
self.helper.layout = Layout(
Row(
Column('name', css_class='form-group col-md-12 mb-0'),
css_class='form-row'
),
Row(
Column('allowed_instances', css_class='form-group col-md-12 mb-0'),
css_class='form-row'
),
Row(
Column('allow_restart', css_class='form-group col-md-4 mb-0'),
Column('allow_reload', css_class='form-group col-md-4 mb-0'),
Column('allow_export', css_class='form-group col-md-4 mb-0'),
css_class='form-row'
),
Row(
Column('enabled', css_class='form-group col-md-12 mb-0'),
css_class='form-row'
),
Row(
Column(
Submit('submit', _('Save'), css_class='btn btn-success'),
HTML(f' {regenerate_html} ') if regenerate_html else HTML(''),
HTML(f' <a class="btn btn-secondary" href="/manage_api/v2/list/">{back_label}</a> '),
HTML(f' {delete_html} '),
css_class='col-md-12'
),
css_class='form-row'
)
)

View File

@@ -0,0 +1,51 @@
# Generated by Django 5.2.11 on 2026-02-10 00:54
import uuid
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('api_v2', '0001_initial'),
('wireguard', '0032_remove_peer_enabled_by_schedule'),
]
operations = [
migrations.AlterField(
model_name='apikey',
name='allow_export',
field=models.BooleanField(default=True, verbose_name='Allow Export'),
),
migrations.AlterField(
model_name='apikey',
name='allow_reload',
field=models.BooleanField(default=True, verbose_name='Allow Reload'),
),
migrations.AlterField(
model_name='apikey',
name='allow_restart',
field=models.BooleanField(default=True, verbose_name='Allow Restart'),
),
migrations.AlterField(
model_name='apikey',
name='allowed_instances',
field=models.ManyToManyField(blank=True, related_name='api_keys', to='wireguard.wireguardinstance', verbose_name='Allowed Instances'),
),
migrations.AlterField(
model_name='apikey',
name='enabled',
field=models.BooleanField(default=True, verbose_name='Enabled'),
),
migrations.AlterField(
model_name='apikey',
name='name',
field=models.CharField(max_length=64, unique=True, verbose_name='Name'),
),
migrations.AlterField(
model_name='apikey',
name='token',
field=models.UUIDField(default=uuid.uuid4, unique=True, verbose_name='Token'),
),
]

View File

@@ -1,21 +1,23 @@
import uuid
from django.db import models
from django.utils.translation import gettext_lazy as _
from wireguard.models import WireGuardInstance
class ApiKey(models.Model):
name = models.CharField(max_length=64, unique=True)
token = models.UUIDField(default=uuid.uuid4, unique=True)
allowed_instances = models.ManyToManyField(WireGuardInstance, blank=True, related_name='api_keys')
allow_restart = models.BooleanField(default=True)
allow_reload = models.BooleanField(default=True)
allow_export = models.BooleanField(default=True)
enabled = models.BooleanField(default=True)
name = models.CharField(max_length=64, unique=True, verbose_name=_("Name"))
token = models.UUIDField(default=uuid.uuid4, unique=True, verbose_name=_("Token"))
allowed_instances = models.ManyToManyField(WireGuardInstance, blank=True, related_name='api_keys', verbose_name=_("Allowed Instances"))
allow_restart = models.BooleanField(default=True, verbose_name=_("Allow Restart"))
allow_reload = models.BooleanField(default=True, verbose_name=_("Allow Reload"))
allow_export = models.BooleanField(default=True, verbose_name=_("Allow Export"))
enabled = models.BooleanField(default=True, verbose_name=_("Enabled"))
uuid = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)
created = models.DateTimeField(auto_now_add=True)
updated = models.DateTimeField(auto_now=True)
def __str__(self):
return self.name

View File

@@ -1 +1,96 @@
# Create your views here.
import uuid as uuid_lib
from django.contrib import messages
from django.contrib.auth.decorators import login_required
from django.shortcuts import get_object_or_404, redirect, render
from django.utils.translation import gettext_lazy as _
from user_manager.models import UserAcl
from .forms import ApiKeyForm
from .models import ApiKey
@login_required
def view_api_key_list(request):
if not UserAcl.objects.filter(user=request.user).filter(user_level__gte=50).exists():
return render(request, 'access_denied.html', {'page_title': _('Access Denied')})
page_title = _('API Keys')
api_keys = ApiKey.objects.all().order_by('name')
context = {'page_title': page_title, 'api_keys': api_keys}
return render(request, 'api_v2/list.html', context)
@login_required
def view_manage_api_key(request):
if not UserAcl.objects.filter(user=request.user).filter(user_level__gte=50).exists():
return render(request, 'access_denied.html', {'page_title': _('Access Denied')})
api_key = None
if 'uuid' in request.GET:
api_key = get_object_or_404(ApiKey, uuid=request.GET['uuid'])
page_title = _('Edit API Key: ') + api_key.name
else:
page_title = _('Add API Key')
if request.method == 'POST':
if api_key:
form = ApiKeyForm(request.POST, instance=api_key, user=request.user)
else:
form = ApiKeyForm(request.POST, user=request.user)
if request.POST.get('regenerate_token') == 'true' and api_key:
api_key.token = uuid_lib.uuid4()
api_key.save()
messages.success(request, _('Token regenerated successfully.'))
return redirect('/manage_api/v2/list/')
if form.is_valid():
form.save()
messages.success(request, _('API Key saved successfully.'))
return redirect('/manage_api/v2/list/')
else:
if api_key:
form = ApiKeyForm(instance=api_key, user=request.user)
else:
form = ApiKeyForm(user=request.user)
form_description = {
'size': '',
'content': _('''
<h5>API Keys</h5>
<p>API Keys allow external applications to interact with the WireGuard WebAdmin API.</p>
<p><strong>Token:</strong> The secret token used for authentication. Keep this secure.</p>
<p><strong>Allowed Instances:</strong> The WireGuard instances this key can manage. If none are selected, the key has access to ALL instances.</p>
<p><strong>Permissions:</strong> specific actions allowed for this key.</p>
''')
}
context = {
'page_title': page_title,
'form': form,
'instance': api_key,
'form_description': form_description
}
return render(request, 'api_v2/api_key_form.html', context)
@login_required
def view_delete_api_key(request, uuid):
if not UserAcl.objects.filter(user=request.user).filter(user_level__gte=50).exists():
return render(request, 'access_denied.html', {'page_title': _('Access Denied')})
api_key = get_object_or_404(ApiKey, uuid=uuid)
if request.method == 'POST':
api_key.delete()
messages.success(request, _('API Key deleted successfully.'))
return redirect('api_v2_list')
context = {
'object': api_key,
'title': _('Delete API Key'),
'cancel_url': f"/manage_api/v2/manage/?uuid={api_key.uuid}",
'text': _('Are you sure you want to delete the API Key "%(name)s"?') % {'name': api_key.name}
}
return render(request, 'generic_delete_confirmation.html', context)

View File

@@ -0,0 +1,41 @@
{% extends 'base.html' %}
{% load crispy_forms_tags %}
{% load i18n %}
{% block content %}
<div class='row'>
<div class='{% if form_size %}{{ form_size }}{% else %}col-lg-6{% endif %}'>
<div class="card card-primary card-outline">
{% if page_title %}
<div class="card-header">
<h3 class="card-title">{{ page_title }}</h3>
</div>
{% endif %}
<div class="card-body row">
<div class="col-lg-12">
{% csrf_token %}
{% crispy form %}
</div>
</div>
</div>
</div>
{% if form_description %}
<div class='{% if form_description.size %}{{ form_description.size }}{% else %}col-lg-6{% endif %}'>
<div class="card card-primary card-outline">
<div class="card-body row">
<div class="col-lg-12">
{{ form_description.content|safe }}
</div>
</div>
</div>
</div>
{% endif %}
</div>
{% endblock %}
{% block custom_page_scripts %}
{% endblock %}

101
templates/api_v2/list.html Normal file
View File

@@ -0,0 +1,101 @@
{% extends "base.html" %}
{% load i18n %}
{% block content %}
<table class="table table-striped table-bordered">
<thead>
<tr>
<th>{% trans 'Name' %}</th>
<th>{% trans 'Token' %}</th>
<th>{% trans 'Allowed Instances' %}</th>
<th class="text-center">{% trans 'Enabled' %}</th>
<th class="text-center"><i class="fas fa-power-off" title="{% trans 'Allow Restart' %}"></i></th>
<th class="text-center"><i class="fas fa-sync" title="{% trans 'Allow Reload' %}"></i></th>
<th class="text-center"><i class="fas fa-download" title="{% trans 'Allow Export' %}"></i></th>
<th class="text-center"><i class="far fa-edit"></i></th>
</tr>
</thead>
<tbody>
{% for key in api_keys %}
<tr>
<td>{{ key.name }}</td>
<td>
<div class="input-group input-group-sm" style="max-width: 300px;">
<input type="password" class="form-control token-input" value="{{ key.token }}" readonly>
<div class="input-group-append">
<button class="btn btn-outline-secondary" type="button" onclick="toggleListToken(this)">
<i class="fas fa-eye"></i>
</button>
</div>
</div>
</td>
<td>
{% for instance in key.allowed_instances.all %}
<span class="badge badge-info">{{ instance }}</span>
{% empty %}
<span class="badge badge-success">{% trans 'All' %}</span>
{% endfor %}
</td>
<td class="text-center">
{% if key.enabled %}
<i class="fas fa-check text-success" title="{% trans 'Enabled' %}"></i>
{% else %}
<i class="fas fa-times text-danger" title="{% trans 'Disabled' %}"></i>
{% endif %}
</td>
<td class="text-center">
{% if key.allow_restart %}
<i class="fas fa-check text-success"></i>
{% else %}
<i class="fas fa-times text-danger"></i>
{% endif %}
</td>
<td class="text-center">
{% if key.allow_reload %}
<i class="fas fa-check text-success"></i>
{% else %}
<i class="fas fa-times text-danger"></i>
{% endif %}
</td>
<td class="text-center">
{% if key.allow_export %}
<i class="fas fa-check text-success"></i>
{% else %}
<i class="fas fa-times text-danger"></i>
{% endif %}
</td>
<td class="text-center" style="width: 1%; white-space: nowrap;">
<a href="/manage_api/v2/manage/?uuid={{ key.uuid }}" title="{% trans 'Edit' %}">
<i class="far fa-edit"></i>
</a>
</td>
</tr>
{% endfor %}
</tbody>
</table>
<div class="row">
<div class="col-md-12">
<a href="/manage_api/v2/manage/" class="btn btn-primary">
<i class="fas fa-plus"></i> {% trans 'Add API Key' %}
</a>
</div>
</div>
<script>
function toggleListToken(btn) {
var input = btn.closest('.input-group').querySelector('input');
var icon = btn.querySelector('i');
if (input.type === 'password') {
input.type = 'text';
icon.classList.remove('fa-eye');
icon.classList.add('fa-eye-slash');
} else {
input.type = 'password';
icon.classList.remove('fa-eye-slash');
icon.classList.add('fa-eye');
}
}
</script>
{% endblock %}

View File

@@ -100,6 +100,16 @@
</a>
</li>
<li class="nav-item">
<a href="/manage_api/v2/list/"
class="nav-link {% if '/manage_api/' in request.path %}active{% endif %}">
<i class="fas fa-key nav-icon"></i>
<p>
{% trans 'API Keys' %}
</p>
</a>
</li>
<li class="nav-item">
<a href="/cluster/" class="nav-link {% if '/cluster/' in request.path %}active{% endif %}">
<i class="fas fa-server nav-icon"></i>

View File

@@ -21,6 +21,7 @@ from accounts.views import view_create_first_user, view_login, view_logout
from api.views import api_instance_info, api_peer_invite, api_peer_list, cron_check_updates, \
cron_update_peer_latest_handshake, peer_info, routerfleet_authenticate_session, routerfleet_get_user_token, \
wireguard_status, cron_refresh_wireguard_status_cache, cron_calculate_peer_schedules, cron_peer_scheduler
from api_v2.views import view_api_key_list, view_manage_api_key, view_delete_api_key
from cluster.cluster_api import api_cluster_status, api_get_worker_config_files, api_get_worker_dnsmasq_config, \
api_worker_ping, api_submit_worker_wireguard_stats
from cluster.views import cluster_main, cluster_settings, worker_manage
@@ -47,6 +48,9 @@ from wireguard_tools.views import download_config_or_qrcode, view_export_wiregua
urlpatterns = [
path('admin/', admin.site.urls),
path('manage_api/v2/list/', view_api_key_list, name='api_v2_list'),
path('manage_api/v2/manage/', view_manage_api_key, name='api_v2_manage'),
path('manage_api/v2/delete/<uuid:uuid>/', view_delete_api_key, name='api_v2_delete'),
path('', view_apply_db_patches, name='apply_db_patches'),
path('status/', view_wireguard_status, name='wireguard_status'),
path('dns/', view_static_host_list, name='static_host_list'),