Repository navigation
Fix authenticated CHIRP HEAD responses in UHRP hosts #650
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
Merged
ty-everett
merged 2 commits into
main
from
codex/chirp-authenticated-head-response-20260927
Sep 27, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
88 changes: 88 additions & 0 deletions
88
infra/uhrp-server-basic/test/chirpHeadAuthentication.test.js
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,88 @@ | ||
| process.env.BSV_NETWORK = 'testnet' | ||
| process.env.HOSTING_DOMAIN = 'storage.example.com' | ||
| process.env.NODE_ENV = 'test' | ||
| process.env.WALLET_STORAGE_URL = 'http://localhost:3000' | ||
|
|
||
| const mockHasStagedObject = jest.fn() | ||
| jest.mock('../out/src/chirp/store', () => ({ | ||
| getChirpStore: () => ({ hasStagedObject: mockHasStagedObject }) | ||
| })) | ||
| jest.mock('../out/src/utils/createUHRPAdvertisement', () => ({ | ||
| createUHRPAdvertisementWithResult: jest.fn() | ||
| })) | ||
| jest.mock('../out/src/logger', () => ({ log: { error: jest.fn() } })) | ||
|
|
||
| const express = require('express') | ||
| const { createAuthMiddleware } = require('@bsv/auth-express-middleware') | ||
| const { rateLimit } = require('express-rate-limit') | ||
| const { | ||
| rateLimitOptions, | ||
| authenticatedIdentityKey | ||
| } = require('../out/src/security/rateLimitPolicy') | ||
| const { AuthFetch, PrivateKey, ProtoWallet } = require('@bsv/sdk') | ||
| const { chirpPostAuthRoutes } = require('../out/src/chirp/routes') | ||
| const { objectIdentifierForBytes } = require('../out/src/chirp/core/hash') | ||
|
|
||
| const present = objectIdentifierForBytes(Uint8Array.of(1)) | ||
| const absent = objectIdentifierForBytes(Uint8Array.of(2)) | ||
| let server | ||
| let origin | ||
| let clientWallet | ||
|
|
||
| beforeAll(async () => { | ||
| const app = express() | ||
| const serverWallet = new ProtoWallet(PrivateKey.fromRandom()) | ||
| clientWallet = new ProtoWallet(PrivateKey.fromRandom()) | ||
| app.use(express.json()) | ||
| app.use(rateLimit(rateLimitOptions('UHRP_PRE_AUTH_RATE_LIMIT', { windowMs: 60_000, limit: 300 }))) | ||
| app.use(createAuthMiddleware({ wallet: serverWallet, allowUnauthenticated: false })) | ||
| app.use( | ||
| rateLimit( | ||
| rateLimitOptions( | ||
| 'UHRP_AUTHENTICATED_RATE_LIMIT', | ||
| { windowMs: 60_000, limit: 1000 }, | ||
| { keyGenerator: authenticatedIdentityKey } | ||
| ) | ||
| ) | ||
| ) | ||
| const route = chirpPostAuthRoutes.find( | ||
| value => value.type === 'head' && value.path.includes('/uploads/') | ||
| ) | ||
| app.head(route.path, route.func) | ||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
|
||
| server = await new Promise(resolve => { | ||
| const listener = app.listen(0, '127.0.0.1', () => resolve(listener)) | ||
| }) | ||
| origin = `http://127.0.0.1:${server.address().port}` | ||
| }) | ||
|
|
||
| beforeEach(() => { | ||
| mockHasStagedObject.mockImplementation(async (_uploadId, identityKey, identifier) => { | ||
| expect(identityKey).toBe((await clientWallet.getPublicKey({ identityKey: true })).publicKey) | ||
| return identifier === present | ||
| }) | ||
| }) | ||
|
|
||
| afterAll(async () => { | ||
| server.closeAllConnections() | ||
| await new Promise(resolve => server.close(resolve)) | ||
| }) | ||
|
|
||
| test.each([ | ||
| ['present staged object', present, 200], | ||
| ['absent staged object', absent, 404], | ||
| ['invalid object identifier', 'invalid-object', 400] | ||
| ])( | ||
| 'authenticates a bodyless HEAD for %s', | ||
| async (_name, identifier, status) => { | ||
| const auth = new AuthFetch(clientWallet, undefined, undefined, undefined, {}, fetch) | ||
| const response = await auth.fetch( | ||
| `${origin}/chirp/v1/uploads/test-session/objects/${identifier}`, | ||
| { | ||
| method: 'HEAD' | ||
| } | ||
| ) | ||
| expect(response.status).toBe(status) | ||
| expect((await response.arrayBuffer()).byteLength).toBe(0) | ||
| }, | ||
| 15_000 | ||
| ) | ||
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
85 changes: 85 additions & 0 deletions
85
infra/uhrp-server-cloud-bucket/src/routes/__tests/chirpHeadAuthentication.test.js
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,85 @@ | ||
| process.env.BSV_NETWORK = 'testnet' | ||
| process.env.HOSTING_DOMAIN = 'storage.example.com' | ||
| process.env.NODE_ENV = 'test' | ||
| process.env.WALLET_STORAGE_URL = 'http://localhost:3000' | ||
|
|
||
| const mockHasStagedObject = jest.fn() | ||
| jest.mock('../../chirp/store', () => ({ | ||
| getChirpStore: () => ({ hasStagedObject: mockHasStagedObject }) | ||
| })) | ||
| jest.mock('../../utils/createUHRPAdvertisement', () => ({ | ||
| createUHRPAdvertisementWithResult: jest.fn() | ||
| })) | ||
| jest.mock('../../logger', () => ({ log: { error: jest.fn() } })) | ||
|
|
||
| const express = require('express') | ||
| const { createAuthMiddleware } = require('@bsv/auth-express-middleware') | ||
| const { rateLimit } = require('express-rate-limit') | ||
| const { rateLimitOptions, authenticatedIdentityKey } = require('../../security/rateLimitPolicy') | ||
| const { AuthFetch, PrivateKey, ProtoWallet } = require('@bsv/sdk') | ||
| const { chirpPostAuthRoutes } = require('../../chirp/routes') | ||
| const { objectIdentifierForBytes } = require('../../chirp/core/hash') | ||
|
|
||
| const present = objectIdentifierForBytes(Uint8Array.of(1)) | ||
| const absent = objectIdentifierForBytes(Uint8Array.of(2)) | ||
| let server | ||
| let origin | ||
| let clientWallet | ||
|
|
||
| beforeAll(async () => { | ||
| const app = express() | ||
| const serverWallet = new ProtoWallet(PrivateKey.fromRandom()) | ||
| clientWallet = new ProtoWallet(PrivateKey.fromRandom()) | ||
| app.use(express.json()) | ||
| app.use(rateLimit(rateLimitOptions('UHRP_PRE_AUTH_RATE_LIMIT', { windowMs: 60_000, limit: 300 }))) | ||
| app.use(createAuthMiddleware({ wallet: serverWallet, allowUnauthenticated: false })) | ||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
|
||
| app.use( | ||
| rateLimit( | ||
| rateLimitOptions( | ||
| 'UHRP_AUTHENTICATED_RATE_LIMIT', | ||
| { windowMs: 60_000, limit: 1000 }, | ||
| { keyGenerator: authenticatedIdentityKey } | ||
| ) | ||
| ) | ||
| ) | ||
| const route = chirpPostAuthRoutes.find( | ||
| value => value.type === 'head' && value.path.includes('/uploads/') | ||
| ) | ||
| app.head(route.path, route.func) | ||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
|
||
| server = await new Promise(resolve => { | ||
| const listener = app.listen(0, '127.0.0.1', () => resolve(listener)) | ||
| }) | ||
| origin = `http://127.0.0.1:${server.address().port}` | ||
| }) | ||
|
|
||
| beforeEach(() => { | ||
| mockHasStagedObject.mockImplementation(async (_uploadId, identityKey, identifier) => { | ||
| expect(identityKey).toBe((await clientWallet.getPublicKey({ identityKey: true })).publicKey) | ||
| return identifier === present | ||
| }) | ||
| }) | ||
|
|
||
| afterAll(async () => { | ||
| server.closeAllConnections() | ||
| await new Promise(resolve => server.close(resolve)) | ||
| }) | ||
|
|
||
| test.each([ | ||
| ['present staged object', present, 200], | ||
| ['absent staged object', absent, 404], | ||
| ['invalid object identifier', 'invalid-object', 400] | ||
| ])( | ||
| 'authenticates a bodyless HEAD for %s', | ||
| async (_name, identifier, status) => { | ||
| const auth = new AuthFetch(clientWallet, undefined, undefined, undefined, {}, fetch) | ||
| const response = await auth.fetch( | ||
| `${origin}/chirp/v1/uploads/test-session/objects/${identifier}`, | ||
| { | ||
| method: 'HEAD' | ||
| } | ||
| ) | ||
| expect(response.status).toBe(status) | ||
| expect((await response.arrayBuffer()).byteLength).toBe(0) | ||
| }, | ||
| 15_000 | ||
| ) | ||
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.
Uh oh!
There was an error while loading. Please reload this page.