-
Notifications
You must be signed in to change notification settings - Fork 9
fix(cloud-agent): rate limit stream tickets by IP #5141
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.
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
apps/web/src/app/api/cloud-agent-next/sessions/stream-ticket/route.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import { checkRateLimit } from '@vercel/firewall'; | ||
| import { getUserFromAuth } from '@/lib/user/server'; | ||
|
|
||
| jest.mock('@vercel/firewall'); | ||
| jest.mock('@/lib/user/server'); | ||
| jest.mock('@/lib/drizzle'); | ||
| jest.mock('@/lib/cloud-agent/session-ownership'); | ||
| jest.mock('@/lib/cloud-agent/stream-ticket'); | ||
| jest.mock('@sentry/nextjs'); | ||
|
|
||
| import { POST } from './route'; | ||
|
|
||
| const mockCheckRateLimit = jest.mocked(checkRateLimit); | ||
| const mockGetUserFromAuth = jest.mocked(getUserFromAuth); | ||
|
|
||
| function createRequest(): Request { | ||
| return new Request('http://localhost:3000/api/cloud-agent-next/sessions/stream-ticket', { | ||
| method: 'POST', | ||
| headers: { 'Content-Type': 'application/json' }, | ||
| body: JSON.stringify({ cloudAgentSessionId: 'session-1' }), | ||
| }); | ||
| } | ||
|
|
||
| describe('POST /api/cloud-agent-next/sessions/stream-ticket', () => { | ||
| beforeEach(() => { | ||
| jest.clearAllMocks(); | ||
| mockCheckRateLimit.mockResolvedValue({ rateLimited: false }); | ||
| }); | ||
|
|
||
| test('returns 429 before authentication when the client IP is rate limited', async () => { | ||
| mockCheckRateLimit.mockResolvedValue({ rateLimited: true }); | ||
| const request = createRequest(); | ||
|
|
||
| const response = await POST(request); | ||
|
|
||
| expect(response.status).toBe(429); | ||
| expect(response.headers.get('Retry-After')).toBe('60'); | ||
| await expect(response.json()).resolves.toEqual({ | ||
| error: 'Rate limit exceeded. Please try again later.', | ||
| }); | ||
| expect(mockCheckRateLimit).toHaveBeenCalledWith('stream-ticket-ip', { request }); | ||
| expect(mockGetUserFromAuth).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| test('continues to authentication when the client IP is allowed', async () => { | ||
| const authFailedResponse = Response.json({ error: 'Unauthorized' }, { status: 401 }); | ||
| mockGetUserFromAuth.mockResolvedValue({ user: null, authFailedResponse } as never); | ||
| const request = createRequest(); | ||
|
|
||
| const response = await POST(request); | ||
|
|
||
| expect(mockCheckRateLimit).toHaveBeenCalledWith('stream-ticket-ip', { request }); | ||
| expect(mockGetUserFromAuth).toHaveBeenCalledWith({ adminOnly: false }); | ||
| expect(response).toBe(authFailedResponse); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Low, Security:
checkRateLimitreturns{ rateLimited: false, error: 'not-found' }when the rate limit ID is not configured in the firewall (the SDK only does aconsole.warn). Since onlyrateLimitedis destructured here, a missing or later deletedstream-ticket-iprule silently disables the protection and the endpoint is back to the pre-incident state with no signal. Failing open is the right call for availability, but consider checkingerror === 'not-found'and reporting it to Sentry so a missing rule gets noticed. The throw path is already covered by the surrounding try/catch, so this is the only unobserved failure mode. Same pattern exists in the device-auth and native-admission call sites, so a shared helper or a follow-up there could make sense.