Skip to content

Commit

Permalink
Merge pull request #9367 from nextcloud/techdebt/noid/controller-anno…
Browse files Browse the repository at this point in the history 
…tations

techdebt(controllers): Migrate controllers to Attributes
  • Loading branch information
@nickvergessen
nickvergessen authored Apr 25, 2023
2 parents 3a2a536 + 2bef329 commit 2d8a0e4
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 60 deletions.
10 changes: 6 additions & 4 deletions lib/Controller/FilesIntegrationController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
use OCA\Talk\Service\RoomService;
use OCA\Talk\TalkSession;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\BruteForceProtection;
use OCP\AppFramework\Http\Attribute\UseSession;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSException;
use OCP\AppFramework\OCS\OCSNotFoundException;
Expand Down Expand Up @@ -148,8 +150,6 @@ public function getRoomByFileId(string $fileId): DataResponse {

/**
* @PublicPage
* @UseSession
* @BruteForceProtection(action=shareinfo)
*
* Returns the token of the room associated to the file id of the given
* share token.
Expand All @@ -173,12 +173,14 @@ public function getRoomByFileId(string $fileId): DataResponse {
* Besides the token of the room this also returns the current user ID and
* display name, if any; this is needed by the Talk sidebar to know the
* actual current user, as the public share page uses the incognito mode and
* thus logged in users as seen as guests.
* thus logged-in users as seen as guests.
*
* @param string $shareToken
* @return DataResponse the status code is "200 OK" if a room is returned,
* or "404 Not found" if the given share token was invalid.
*/
#[UseSession]
#[BruteForceProtection(action: 'shareinfo')]
public function getRoomByShareToken(string $shareToken): DataResponse {
if ($this->config->getAppValue('spreed', 'conversations_files', '1') !== '1' ||
$this->config->getAppValue('spreed', 'conversations_files_public_shares', '1') !== '1') {
Expand All @@ -195,7 +197,7 @@ public function getRoomByShareToken(string $shareToken): DataResponse {
}
} catch (ShareNotFound $e) {
$response = new DataResponse([], Http::STATUS_NOT_FOUND);
$response->throttle(['token' => $shareToken]);
$response->throttle(['token' => $shareToken, 'action' => 'shareinfo']);
return $response;
}

Expand Down
26 changes: 14 additions & 12 deletions lib/Controller/PageController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@
use OCP\App\IAppManager;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\BruteForceProtection;
use OCP\AppFramework\Http\Attribute\UseSession;
use OCP\AppFramework\Http\ContentSecurityPolicy;
use OCP\AppFramework\Http\NotFoundResponse;
use OCP\AppFramework\Http\RedirectResponse;
Expand Down Expand Up @@ -126,13 +128,13 @@ public function __construct(
/**
* @PublicPage
* @NoCSRFRequired
* @UseSession
* @BruteForceProtection(action=talkRoomToken)
*
* @param string $token
* @return Response
* @throws HintException
*/
#[UseSession]
#[BruteForceProtection(action: 'talkRoomToken')]
public function showCall(string $token): Response {
// This is the entry point from the `/call/{token}` URL which is hardcoded in the server.
return $this->index($token);
Expand All @@ -141,14 +143,14 @@ public function showCall(string $token): Response {
/**
* @PublicPage
* @NoCSRFRequired
* @UseSession
* @BruteForceProtection(action=talkRoomPassword)
*
* @param string $token
* @param string $password
* @return Response
* @throws HintException
*/
#[UseSession]
#[BruteForceProtection(action: 'talkRoomPassword')]
public function authenticatePassword(string $token, string $password = ''): Response {
// This is the entry point from the `/call/{token}` URL which is hardcoded in the server.
return $this->index($token, '', $password);
Expand Down Expand Up @@ -177,15 +179,15 @@ public function duplicateSession(): Response {
/**
* @PublicPage
* @NoCSRFRequired
* @UseSession
* @BruteForceProtection(action=talkRoomToken)
*
* @param string $token
* @param string $callUser
* @param string $password
* @return TemplateResponse|RedirectResponse
* @throws HintException
*/
#[BruteForceProtection(action: 'talkRoomToken')]
#[UseSession]
public function index(string $token = '', string $callUser = '', string $password = ''): Response {
$bruteForceToken = $token;
$user = $this->userSession->getUser();
Expand Down Expand Up @@ -256,7 +258,7 @@ public function index(string $token = '', string $callUser = '', string $passwor
$response = new RedirectResponse($passwordVerification['url']);
}

$response->throttle(['token' => $token]);
$response->throttle(['token' => $token, 'action' => 'talkRoomPassword']);
return $response;
}
}
Expand Down Expand Up @@ -300,25 +302,25 @@ public function index(string $token = '', string $callUser = '', string $passwor
$response->setContentSecurityPolicy($csp);
if ($throttle) {
// Logged-in user tried to access a chat they can not access
$response->throttle(['token' => $bruteForceToken]);
$response->throttle(['token' => $bruteForceToken, 'action' => 'talkRoomToken']);
}
return $response;
}

/**
* @PublicPage
* @NoCSRFRequired
* @BruteForceProtection(action=talkRoomToken)
*
* @param string $token
* @return TemplateResponse|NotFoundResponse
*/
#[BruteForceProtection(action: 'talkRoomToken')]
public function recording(string $token): Response {
try {
$room = $this->manager->getRoomByToken($token);
} catch (RoomNotFoundException $e) {
$response = new NotFoundResponse();
$response->throttle(['token' => $token]);
$response->throttle(['token' => $token, 'action' => 'talkRoomToken']);

return $response;
}
Expand Down Expand Up @@ -375,7 +377,7 @@ protected function guestEnterRoom(string $token, string $password): Response {
$response = new RedirectResponse($this->url->linkToRoute('core.login.showLoginForm', [
'redirect_url' => $redirectUrl,
]));
$response->throttle(['token' => $token]);
$response->throttle(['token' => $token, 'action' => 'talkRoomToken']);
return $response;
}

Expand All @@ -399,7 +401,7 @@ protected function guestEnterRoom(string $token, string $password): Response {
} else {
$response = new RedirectResponse($passwordVerification['url']);
}
$response->throttle(['token' => $token]);
$response->throttle(['token' => $token, 'action' => 'talkRoomPassword']);
return $response;
}
}
Expand Down
11 changes: 5 additions & 6 deletions lib/Controller/RecordingController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
use OCA\Talk\Service\RecordingService;
use OCA\Talk\Service\RoomService;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\BruteForceProtection;
use OCP\AppFramework\Http\DataResponse;
use OCP\Http\Client\IClientService;
use OCP\IRequest;
Expand Down Expand Up @@ -132,10 +133,10 @@ protected function getInputStream(): string {
* Backend API to update recording status by backends.
*
* @PublicPage
* @BruteForceProtection(action=talkRecordingSecret)
*
* @return DataResponse
*/
#[BruteForceProtection(action: 'talkRecordingSecret')]
public function backend(): DataResponse {
$json = $this->getInputStream();
if (!$this->validateBackendRequest($json)) {
Expand All @@ -146,7 +147,7 @@ public function backend(): DataResponse {
'message' => 'The request could not be authenticated.',
],
], Http::STATUS_FORBIDDEN);
$response->throttle();
$response->throttle(['action' => 'talkRecordingSecret']);
return $response;
}

Expand Down Expand Up @@ -292,10 +293,8 @@ public function stop(): DataResponse {
/**
* @PublicPage
* @RequireRoom
* @BruteForceProtection(action=talkRecordingSecret)
*
* @return DataResponse
*/
#[BruteForceProtection(action: 'talkRecordingSecret')]
public function store(string $owner): DataResponse {
$data = $this->room->getToken();
if (!$this->validateBackendRequest($data)) {
Expand All @@ -306,7 +305,7 @@ public function store(string $owner): DataResponse {
'message' => 'The request could not be authenticated.',
],
], Http::STATUS_UNAUTHORIZED);
$response->throttle();
$response->throttle(['action' => 'talkRecordingSecret']);
return $response;
}

Expand Down
35 changes: 18 additions & 17 deletions lib/Controller/RoomController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
use OCA\Talk\Webinary;
use OCP\App\IAppManager;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\BruteForceProtection;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\EventDispatcher\IEventDispatcher;
Expand Down Expand Up @@ -284,10 +285,10 @@ public function getListedRooms(string $searchTerm = ''): DataResponse {
*
* @NoAdminRequired
* @RequireLoggedInParticipant
* @BruteForceProtection(action=talkRoomToken)
*
* @return DataResponse
*/
#[BruteForceProtection(action: 'talkRoomToken')]
public function getBreakoutRooms(): DataResponse {
try {
$rooms = $this->breakoutRoomService->getBreakoutRooms($this->room, $this->participant);
Expand All @@ -312,20 +313,19 @@ public function getBreakoutRooms(): DataResponse {

/**
* @PublicPage
* @BruteForceProtection(action=talkRoomToken)
*
* @param string $token
* @return DataResponse
*/
#[BruteForceProtection(action: 'talkRoomToken')]
#[BruteForceProtection(action: 'talkSipBridgeSecret')]
public function getSingleRoom(string $token): DataResponse {
try {
$isSIPBridgeRequest = $this->validateSIPBridgeRequest($token);
} catch (UnauthorizedException $e) {
$ip = $this->request->getRemoteAddress();
$action = 'talkSipBridgeSecret';
$this->throttler->sleepDelay($ip, $action);
$this->throttler->registerAttempt($action, $ip);
return new DataResponse([], Http::STATUS_UNAUTHORIZED);
$response = new DataResponse([], Http::STATUS_UNAUTHORIZED);
$response->throttle(['action' => 'talkSipBridgeSecret']);
return $response;
}

// The SIP bridge only needs room details (public, sip enabled, lobby state, etc)
Expand Down Expand Up @@ -365,7 +365,7 @@ public function getSingleRoom(string $token): DataResponse {
return new DataResponse($this->formatRoom($room, $participant, $statuses, $isSIPBridgeRequest), Http::STATUS_OK, $this->getTalkHashHeader());
} catch (RoomNotFoundException $e) {
$response = new DataResponse([], Http::STATUS_NOT_FOUND);
$response->throttle(['token' => $token]);
$response->throttle(['token' => $token, 'action' => 'talkRoomToken']);
return $response;
}
}
Expand Down Expand Up @@ -1222,13 +1222,14 @@ public function setPassword(string $password): DataResponse {

/**
* @PublicPage
* @BruteForceProtection(action=talkRoomPassword)
*
* @param string $token
* @param string $password
* @param bool $force
* @return DataResponse
*/
#[BruteForceProtection(action: 'talkRoomPassword')]
#[BruteForceProtection(action: 'talkRoomToken')]
public function joinRoom(string $token, string $password = '', bool $force = true): DataResponse {
$sessionId = $this->session->getSessionForRoom($token);
try {
Expand Down Expand Up @@ -1284,11 +1285,11 @@ public function joinRoom(string $token, string $password = '', bool $force = tru
$this->throttler->resetDelay($this->request->getRemoteAddress(), 'talkRoomToken', ['token' => $token]);
} catch (InvalidPasswordException $e) {
$response = new DataResponse([], Http::STATUS_FORBIDDEN);
$response->throttle(['token' => $token]);
$response->throttle(['token' => $token, 'action' => 'talkRoomPassword']);
return $response;
} catch (UnauthorizedException $e) {
$response = new DataResponse([], Http::STATUS_NOT_FOUND);
$response->throttle(['token' => $token]);
$response->throttle(['token' => $token, 'action' => 'talkRoomToken']);
return $response;
}

Expand All @@ -1305,21 +1306,21 @@ public function joinRoom(string $token, string $password = '', bool $force = tru
/**
* @PublicPage
* @RequireRoom
* @BruteForceProtection(action=talkSipBridgeSecret)
*
* @param string $pin
* @return DataResponse
*/
#[BruteForceProtection(action: 'talkSipBridgeSecret')]
public function getParticipantByDialInPin(string $pin): DataResponse {
try {
if (!$this->validateSIPBridgeRequest($this->room->getToken())) {
$response = new DataResponse([], Http::STATUS_UNAUTHORIZED);
$response->throttle();
$response->throttle(['action' => 'talkSipBridgeSecret']);
return $response;
}
} catch (UnauthorizedException $e) {
$response = new DataResponse([], Http::STATUS_UNAUTHORIZED);
$response->throttle();
$response->throttle(['action' => 'talkSipBridgeSecret']);
return $response;
}

Expand All @@ -1335,20 +1336,20 @@ public function getParticipantByDialInPin(string $pin): DataResponse {
/**
* @PublicPage
* @RequireRoom
* @BruteForceProtection(action=talkSipBridgeSecret)
*
* @return DataResponse
*/
#[BruteForceProtection(action: 'talkSipBridgeSecret')]
public function createGuestByDialIn(): DataResponse {
try {
if (!$this->validateSIPBridgeRequest($this->room->getToken())) {
$response = new DataResponse([], Http::STATUS_UNAUTHORIZED);
$response->throttle();
$response->throttle(['action' => 'talkSipBridgeSecret']);
return $response;
}
} catch (UnauthorizedException $e) {
$response = new DataResponse([], Http::STATUS_UNAUTHORIZED);
$response->throttle();
$response->throttle(['action' => 'talkSipBridgeSecret']);
return $response;
}

Expand Down
Loading

0 comments on commit 2d8a0e4

Please sign in to comment.