Skip to content

Commit 8d52e2e

Browse files
DaneEverittDaneEveritt
committed
Finalize API key management for accounts
1 parent 3ef649d commit 8d52e2e

File tree

6 files changed

+154
-29
lines changed

6 files changed

+154
-29
lines changed

‎app/Http/Controllers/Api/Client/ApiKeyController.php‎

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,14 @@
33
namespace Pterodactyl\Http\Controllers\Api\Client;
44

55
use Pterodactyl\Models\ApiKey;
6+
use Illuminate\Http\JsonResponse;
67
use Pterodactyl\Exceptions\DisplayException;
78
use Illuminate\Contracts\Encryption\Encrypter;
89
use Pterodactyl\Services\Api\KeyCreationService;
10+
use Pterodactyl\Repositories\Eloquent\ApiKeyRepository;
911
use Pterodactyl\Http\Requests\Api\Client\ClientApiRequest;
1012
use Pterodactyl\Transformers\Api\Client\ApiKeyTransformer;
13+
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
1114
use Pterodactyl\Http\Requests\Api\Client\Account\StoreApiKeyRequest;
1215

1316
class ApiKeyController extends ClientApiController
@@ -22,18 +25,28 @@ class ApiKeyController extends ClientApiController
2225
*/
2326
private $encrypter;
2427

28+
/**
29+
* @var \Pterodactyl\Repositories\Eloquent\ApiKeyRepository
30+
*/
31+
private $repository;
32+
2533
/**
2634
* ApiKeyController constructor.
2735
*
2836
* @param \Illuminate\Contracts\Encryption\Encrypter $encrypter
2937
* @param \Pterodactyl\Services\Api\KeyCreationService $keyCreationService
38+
* @param \Pterodactyl\Repositories\Eloquent\ApiKeyRepository $repository
3039
*/
31-
public function __construct(Encrypter $encrypter, KeyCreationService $keyCreationService)
32-
{
40+
public function __construct(
41+
Encrypter $encrypter,
42+
KeyCreationService $keyCreationService,
43+
ApiKeyRepository $repository
44+
) {
3345
parent::__construct();
3446

3547
$this->encrypter = $encrypter;
3648
$this->keyCreationService = $keyCreationService;
49+
$this->repository = $repository;
3750
}
3851

3952
/**
@@ -80,7 +93,24 @@ public function store(StoreApiKeyRequest $request)
8093
->toArray();
8194
}
8295

83-
public function delete()
96+
/**
97+
* Deletes a given API key.
98+
*
99+
* @param \Pterodactyl\Http\Requests\Api\Client\ClientApiRequest $request
100+
* @param string $identifier
101+
* @return \Illuminate\Http\JsonResponse
102+
*/
103+
public function delete(ClientApiRequest $request, string $identifier)
84104
{
105+
$response = $this->repository->deleteWhere([
106+
'user_id' => $request->user()->id,
107+
'identifier' => $identifier,
108+
]);
109+
110+
if (! $response) {
111+
throw new NotFoundHttpException;
112+
}
113+
114+
return JsonResponse::create([], JsonResponse::HTTP_NO_CONTENT);
85115
}
86116
}

‎resources/scripts/api/account/deleteApiKey.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import http from '@/api/http';
2+
3+
export default (identifier: string): Promise<void> => {
4+
return new Promise((resolve, reject) => {
5+
http.delete(`/api/client/account/api-keys/${identifier}`)
6+
.then(() => resolve())
7+
.catch(reject);
8+
});
9+
};

‎resources/scripts/components/dashboard/AccountApiContainer.tsx‎

Lines changed: 74 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,51 +3,103 @@ import ContentBox from '@/components/elements/ContentBox';
33
import CreateApiKeyForm from '@/components/dashboard/forms/CreateApiKeyForm';
44
import getApiKeys, { ApiKey } from '@/api/account/getApiKeys';
55
import SpinnerOverlay from '@/components/elements/SpinnerOverlay';
6-
import { Simulate } from 'react-dom/test-utils';
76
import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
87
import { faKey } from '@fortawesome/free-solid-svg-icons/faKey';
98
import { faTrashAlt } from '@fortawesome/free-solid-svg-icons/faTrashAlt';
9+
import ConfirmationModal from '@/components/elements/ConfirmationModal';
10+
import deleteApiKey from '@/api/account/deleteApiKey';
11+
import { Actions, useStoreActions } from 'easy-peasy';
12+
import { ApplicationStore } from '@/state';
13+
import FlashMessageRender from '@/components/FlashMessageRender';
14+
import { httpErrorToHuman } from '@/api/http';
15+
import format from 'date-fns/format';
1016

1117
export default () => {
18+
const [ deleteIdentifier, setDeleteIdentifier ] = useState('');
1219
const [ keys, setKeys ] = useState<ApiKey[]>([]);
1320
const [ loading, setLoading ] = useState(true);
21+
const { addError, clearFlashes } = useStoreActions((actions: Actions<ApplicationStore>) => actions.flashes);
1422

1523
useEffect(() => {
24+
clearFlashes('account');
1625
getApiKeys()
1726
.then(keys => setKeys(keys))
1827
.then(() => setLoading(false))
1928
.catch(error => {
2029
console.error(error);
30+
addError({ key: 'account', message: httpErrorToHuman(error) });
2131
});
2232
}, []);
2333

34+
const doDeletion = (identifier: string) => {
35+
setLoading(true);
36+
clearFlashes('account');
37+
deleteApiKey(identifier)
38+
.then(() => setKeys(s => ([
39+
...(s || []).filter(key => key.identifier !== identifier),
40+
])))
41+
.catch(error => {
42+
console.error(error);
43+
addError({ key: 'account', message: httpErrorToHuman(error) });
44+
})
45+
.then(() => setLoading(false));
46+
};
47+
2448
return (
2549
<div className={'my-10 flex'}>
26-
<ContentBox title={'Create API Key'} className={'flex-1'} showFlashes={'account'}>
27-
<CreateApiKeyForm/>
50+
<FlashMessageRender byKey={'account'} className={'mb-4'}/>
51+
<ContentBox title={'Create API Key'} className={'flex-1'}>
52+
<CreateApiKeyForm onKeyCreated={key => setKeys(s => ([...s!, key]))}/>
2853
</ContentBox>
2954
<ContentBox title={'API Keys'} className={'ml-10 flex-1'}>
3055
<SpinnerOverlay visible={loading}/>
56+
{deleteIdentifier &&
57+
<ConfirmationModal
58+
title={'Confirm key deletion'}
59+
buttonText={'Yes, delete key'}
60+
visible={true}
61+
onConfirmed={() => {
62+
doDeletion(deleteIdentifier);
63+
setDeleteIdentifier('');
64+
}}
65+
onCanceled={() => setDeleteIdentifier('')}
66+
>
67+
Are you sure you wish to delete this API key? All requests using it will immediately be
68+
invalidated and will fail.
69+
</ConfirmationModal>
70+
}
3171
{
32-
keys.map(key => (
33-
<div key={key.identifier} className={'grey-row-box bg-neutral-600 mb-2 flex items-center'}>
34-
<FontAwesomeIcon icon={faKey} className={'text-neutral-300'}/>
35-
<p className={'text-sm ml-4 flex-1'}>
36-
{key.description}
37-
</p>
38-
<p className={'text-sm ml-4'}>
39-
<code className={'font-mono py-1 px-2 bg-neutral-900 rounded'}>
40-
{key.identifier}
41-
</code>
42-
</p>
43-
<button className={'ml-4 p-2 text-sm'}>
44-
<FontAwesomeIcon
45-
icon={faTrashAlt}
46-
className={'text-neutral-400 hover:text-red-400 transition-color duration-150'}
47-
/>
48-
</button>
49-
</div>
50-
))
72+
keys.length === 0 ?
73+
<p className={'text-center text-sm'}>
74+
{loading ? 'Loading...' : 'No API keys exist for this account.'}
75+
</p>
76+
:
77+
keys.map(key => (
78+
<div key={key.identifier} className={'grey-row-box bg-neutral-600 mb-2 flex items-center'}>
79+
<FontAwesomeIcon icon={faKey} className={'text-neutral-300'}/>
80+
<div className={'ml-4 flex-1'}>
81+
<p className={'text-sm'}>{key.description}</p>
82+
<p className={'text-2xs text-neutral-300 uppercase'}>
83+
Last
84+
used: {key.lastUsedAt ? format(key.lastUsedAt, 'MMM Do, YYYY HH:mm') : 'Never'}
85+
</p>
86+
</div>
87+
<p className={'text-sm ml-4'}>
88+
<code className={'font-mono py-1 px-2 bg-neutral-900 rounded'}>
89+
{key.identifier}
90+
</code>
91+
</p>
92+
<button
93+
className={'ml-4 p-2 text-sm'}
94+
onClick={() => setDeleteIdentifier(key.identifier)}
95+
>
96+
<FontAwesomeIcon
97+
icon={faTrashAlt}
98+
className={'text-neutral-400 hover:text-red-400 transition-color duration-150'}
99+
/>
100+
</button>
101+
</div>
102+
))
51103
}
52104
</ContentBox>
53105
</div>

‎resources/scripts/components/dashboard/forms/CreateApiKeyForm.tsx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,25 @@ import { Actions, useStoreActions } from 'easy-peasy';
88
import { ApplicationStore } from '@/state';
99
import { httpErrorToHuman } from '@/api/http';
1010
import SpinnerOverlay from '@/components/elements/SpinnerOverlay';
11+
import { ApiKey } from '@/api/account/getApiKeys';
1112

1213
interface Values {
1314
description: string;
1415
allowedIps: string;
1516
}
1617

17-
export default () => {
18+
export default ({ onKeyCreated }: { onKeyCreated: (key: ApiKey) => void }) => {
1819
const [ apiKey, setApiKey ] = useState('');
1920
const { addError, clearFlashes } = useStoreActions((actions: Actions<ApplicationStore>) => actions.flashes);
2021

2122
const submit = (values: Values, { setSubmitting, resetForm }: FormikHelpers<Values>) => {
2223
clearFlashes('account');
2324
createApiKey(values.description, values.allowedIps)
24-
.then(key => {
25+
.then(({ secretToken, ...key }) => {
2526
resetForm();
2627
setSubmitting(false);
27-
setApiKey(`${key.identifier}.${key.secretToken}`);
28+
setApiKey(`${key.identifier}${secretToken}`);
29+
onKeyCreated(key);
2830
})
2931
.catch(error => {
3032
console.error(error);

‎resources/scripts/components/elements/ConfirmationModal.tsx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
import React from 'react';
2+
import Modal from '@/components/elements/Modal';
3+
4+
interface Props {
5+
title: string;
6+
buttonText: string;
7+
children: string;
8+
visible: boolean;
9+
onConfirmed: () => void;
10+
onCanceled: () => void;
11+
}
12+
13+
const ConfirmationModal = ({ title, children, visible, buttonText, onConfirmed, onCanceled }: Props) => (
14+
<Modal
15+
appear={true}
16+
visible={visible}
17+
onDismissed={() => onCanceled()}
18+
>
19+
<h3 className={'mb-6'}>{title}</h3>
20+
<p className={'text-sm'}>{children}</p>
21+
<div className={'flex items-center justify-end mt-8'}>
22+
<button className={'btn btn-secondary btn-sm'} onClick={() => onCanceled()}>
23+
Cancel
24+
</button>
25+
<button className={'btn btn-red btn-sm ml-4'} onClick={() => onConfirmed()}>
26+
{buttonText}
27+
</button>
28+
</div>
29+
</Modal>
30+
);
31+
32+
export default ConfirmationModal;

‎routes/api-client.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
Route::get('/api-keys', 'ApiKeyController@index');
2727
Route::post('/api-keys', 'ApiKeyController@store');
28-
Route::delete('/api-keys/{key}', 'ApiKeyController@delete');
28+
Route::delete('/api-keys/{identifier}', 'ApiKeyController@delete');
2929
});
3030

3131
/*

0 commit comments

Comments
 (0)