Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for viewing and deleting of any Application API Keys #5176

Open
wants to merge 2 commits into
base: 1.0-develop
Choose a base branch
from
Open

Added support for viewing and deleting of any Application API Keys #5176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f939b9
Added support for viewing and deleting of other Application API Keys
MackenzieMolloy Jul 31, 2024
0e01ae7
Updated NodeAutoDeployController getApplicationKeys reference
MackenzieMolloy Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions app/Contracts/Repository/ApiKeyRepositoryInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ interface ApiKeyRepositoryInterface extends RepositoryInterface
public function getAccountKeys(User $user): Collection;

/**
* Get all the application API keys that exist for a specific user.
* Get all the application API keys that exist.
*/
public function getApplicationKeys(User $user): Collection;
public function getApplicationKeys(): Collection;

/**
* Delete an account API key from the panel for a specific user.
*/
public function deleteAccountKey(User $user, string $identifier): int;

/**
* Delete an application API key from the panel for a specific user.
* Delete an application API key from the panel.
*/
public function deleteApplicationKey(User $user, string $identifier): int;
public function deleteApplicationKey(string $identifier): int;
}
4 changes: 2 additions & 2 deletions app/Http/Controllers/Admin/ApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function __construct(
public function index(Request $request): View
{
return $this->view->make('admin.api.index', [
'keys' => $this->repository->getApplicationKeys($request->user()),
'keys' => $this->repository->getApplicationKeys(),
]);
}

Expand Down Expand Up @@ -80,7 +80,7 @@ public function store(StoreApplicationApiKeyRequest $request): RedirectResponse
*/
public function delete(Request $request, string $identifier): Response
{
$this->repository->deleteApplicationKey($request->user(), $identifier);
$this->repository->deleteApplicationKey($identifier);

return response('', 204);
}
Expand Down
3 changes: 2 additions & 1 deletion app/Http/Controllers/Admin/NodeAutoDeployController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ public function __construct(
public function __invoke(Request $request, Node $node): JsonResponse
{
/** @var \Pterodactyl\Models\ApiKey|null $key */
$key = $this->repository->getApplicationKeys($request->user())
$key = $this->repository->getApplicationKeys()
->filter(function (ApiKey $key) {
if ($key->user->id != $request->user()->id) return false;
foreach ($key->getAttributes() as $permission => $value) {
if ($permission === 'r_nodes' && $value === 1) {
return true;
Expand Down
13 changes: 7 additions & 6 deletions app/Repositories/Eloquent/ApiKeyRepository.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ public function getAccountKeys(User $user): Collection
}

/**
* Get all the application API keys that exist for a specific user.
* Get all the application API keys that exist.
*/
public function getApplicationKeys(User $user): Collection
public function getApplicationKeys(): Collection
{
return $this->getBuilder()->where('user_id', $user->id)
return $this->getBuilder()
->where('key_type', ApiKey::TYPE_APPLICATION)
->with('user')
->get($this->getColumns());
}

Expand All @@ -49,11 +50,11 @@ public function deleteAccountKey(User $user, string $identifier): int
}

/**
* Delete an application API key from the panel for a specific user.
* Delete an application API key from the panel.
*/
public function deleteApplicationKey(User $user, string $identifier): int
public function deleteApplicationKey(string $identifier): int
{
return $this->getBuilder()->where('user_id', $user->id)
return $this->getBuilder()
->where('key_type', ApiKey::TYPE_APPLICATION)
->where('identifier', $identifier)
->delete();
Expand Down
176 changes: 93 additions & 83 deletions resources/views/admin/api/index.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,103 +1,113 @@
@extends('layouts.admin')

@section('title')
Application API
Application API
@endsection

@section('content-header')
<h1>Application API<small>Control access credentials for managing this Panel via the API.</small></h1>
<ol class="breadcrumb">
<li><a href="{{ route('admin.index') }}">Admin</a></li>
<li class="active">Application API</li>
</ol>
<h1>Application API<small>Control access credentials for managing this Panel via the API.</small></h1>
<ol class="breadcrumb">
<li><a href="{{ route('admin.index') }}">Admin</a></li>
<li class="active">Application API</li>
</ol>
@endsection

@section('content')
<div class="row">
<div class="col-xs-12">
<div class="box box-primary">
<div class="box-header with-border">
<h3 class="box-title">Credentials List</h3>
<div class="box-tools">
<a href="{{ route('admin.api.new') }}" class="btn btn-sm btn-primary">Create New</a>
</div>
</div>
<div class="box-body table-responsive no-padding">
<table class="table table-hover">
<tr>
<th>Key</th>
<th>Memo</th>
<th>Last Used</th>
<th>Created</th>
<th></th>
</tr>
@foreach($keys as $key)
<tr>
<td><code>{{ $key->identifier }}{{ decrypt($key->token) }}</code></td>
<td>{{ $key->memo }}</td>
<td>
@if(!is_null($key->last_used_at))
@datetimeHuman($key->last_used_at)
@else
&mdash;
@endif
</td>
<td>@datetimeHuman($key->created_at)</td>
<td>
<a href="#" data-action="revoke-key" data-attr="{{ $key->identifier }}">
<i class="fa fa-trash-o text-danger"></i>
</a>
</td>
</tr>
@endforeach
</table>
<div class="row">
<div class="col-xs-12">
<div class="box box-primary">
<div class="box-header with-border">
<h3 class="box-title">Credentials List</h3>
<div class="box-tools">
<a href="{{ route('admin.api.new') }}" class="btn btn-sm btn-primary">Create New</a>
</div>
</div>
<div class="box-body table-responsive no-padding">
<table class="table table-hover">
<tr>
<th>Key</th>
<th>Memo</th>
<th>Last Used</th>
<th>Created</th>
<th>Created by</th>
<th></th>
</tr>
@foreach($keys as $key)
<tr>
<td><code>
@if(Auth::user()->id != $key->user->id)
{{ $key->identifier . str_repeat('*', strlen(decrypt($key->token)))}}
@else
{{$key->identifier . decrypt($key->token)}}
@endif
</code></td>
<td>{{ $key->memo }}</td>
<td>
@if(!is_null($key->last_used_at))
@datetimeHuman($key->last_used_at)
@else
&mdash;
@endif
</td>
<td>@datetimeHuman($key->created_at)</td>
<td>
<a href="{{ route('admin.users.view', $key->user->id) }}">{{ $key->user->username }}</a>
</td>
<td>
<a href="#" data-action="revoke-key" data-attr="{{ $key->identifier }}">
<i class="fa fa-trash-o text-danger"></i>
</a>
</td>
</tr>
@endforeach
</table>
</div>
</div>
</div>
</div>
@endsection

@section('footer-scripts')
@parent
<script>
$(document).ready(function() {
$('[data-action="revoke-key"]').click(function (event) {
var self = $(this);
event.preventDefault();
swal({
type: 'error',
title: 'Revoke API Key',
text: 'Once this API key is revoked any applications currently using it will stop working.',
showCancelButton: true,
allowOutsideClick: true,
closeOnConfirm: false,
confirmButtonText: 'Revoke',
confirmButtonColor: '#d9534f',
showLoaderOnConfirm: true
}, function () {
$.ajax({
method: 'DELETE',
url: '/admin/api/revoke/' + self.data('attr'),
headers: {
'X-CSRF-TOKEN': '{{ csrf_token() }}'
}
}).done(function () {
swal({
type: 'success',
title: '',
text: 'API Key has been revoked.'
});
self.parent().parent().slideUp();
}).fail(function (jqXHR) {
console.error(jqXHR);
swal({
type: 'error',
title: 'Whoops!',
text: 'An error occurred while attempting to revoke this key.'
});
@parent
<script>
$(document).ready(function() {
$('[data-action="revoke-key"]').click(function(event) {
var self = $(this);
event.preventDefault();
swal({
type: 'error',
title: 'Revoke API Key',
text: 'Once this API key is revoked any applications currently using it will stop working.',
showCancelButton: true,
allowOutsideClick: true,
closeOnConfirm: false,
confirmButtonText: 'Revoke',
confirmButtonColor: '#d9534f',
showLoaderOnConfirm: true
}, function() {
$.ajax({
method: 'DELETE',
url: '/admin/api/revoke/' + self.data('attr'),
headers: {
'X-CSRF-TOKEN': '{{ csrf_token() }}'
}
}).done(function() {
swal({
type: 'success',
title: '',
text: 'API Key has been revoked.'
});
self.parent().parent().slideUp();
}).fail(function(jqXHR) {
console.error(jqXHR);
swal({
type: 'error',
title: 'Whoops!',
text: 'An error occurred while attempting to revoke this key.'
});
});
});
});
</script>
@endsection
});
</script>
@endsection