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.

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

[Files] correct for anomalies in content disposition value for file downloads #176822

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 6 additions & 14 deletions src/plugins/files/server/routes/common.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,48 +10,40 @@ import type { File } from '../file';
import { getDownloadHeadersForFile } from './common';

describe('getDownloadHeadersForFile', () => {
function expectHeaders({
contentDisposition,
contentType,
}: {
contentDisposition: string;
contentType: string;
}) {
function expectHeaders({ contentType }: { contentType: string }) {
return {
'content-type': contentType,
'content-disposition': `attachment; filename="${contentDisposition}"`,
'cache-control': 'max-age=31536000, immutable',
'x-content-type-options': 'nosniff',
};
}

const file = { data: { name: 'test', mimeType: undefined } } as unknown as File;
test('no mime type and name from file object', () => {
expect(getDownloadHeadersForFile({ file, fileName: undefined })).toEqual(
expectHeaders({ contentType: 'application/octet-stream', contentDisposition: 'test' })
expectHeaders({ contentType: 'application/octet-stream' })
);
});

test('no mime type and name (without ext)', () => {
expect(getDownloadHeadersForFile({ file, fileName: 'myfile' })).toEqual(
expectHeaders({ contentType: 'application/octet-stream', contentDisposition: 'myfile' })
expectHeaders({ contentType: 'application/octet-stream' })
);
});
test('no mime type and name (with ext)', () => {
expect(getDownloadHeadersForFile({ file, fileName: 'myfile.png' })).toEqual(
expectHeaders({ contentType: 'image/png', contentDisposition: 'myfile.png' })
expectHeaders({ contentType: 'image/png' })
);
});
test('mime type and no name', () => {
const fileWithMime = { data: { ...file.data, mimeType: 'application/pdf' } } as File;
expect(getDownloadHeadersForFile({ file: fileWithMime, fileName: undefined })).toEqual(
expectHeaders({ contentType: 'application/pdf', contentDisposition: 'test' })
expectHeaders({ contentType: 'application/pdf' })
);
});
test('mime type and name', () => {
const fileWithMime = { data: { ...file.data, mimeType: 'application/pdf' } } as File;
expect(getDownloadHeadersForFile({ file: fileWithMime, fileName: 'a cool file.pdf' })).toEqual(
expectHeaders({ contentType: 'application/pdf', contentDisposition: 'a cool file.pdf' })
expectHeaders({ contentType: 'application/pdf' })
);
});
});
4 changes: 0 additions & 4 deletions src/plugins/files/server/routes/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ export function getDownloadHeadersForFile({ file, fileName }: Args): ResponseHea
return {
'content-type':
(fileName && mime.getType(fileName)) ?? file.data.mimeType ?? 'application/octet-stream',
// Note, this name can be overridden by the client if set via a "download" attribute on the HTML tag.
'content-disposition': `attachment; filename="${fileName || getDownloadedFileName(file)}"`,
'cache-control': 'max-age=31536000, immutable',
// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
'x-content-type-options': 'nosniff',
Comment on lines -22 to -26
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The header fields content-disposition and x-content-type-options are removed because the handler res.file already takes care of providing these values.

};
}

Expand Down
5 changes: 3 additions & 2 deletions src/plugins/files/server/routes/file_kind/download.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import type { FilesClient } from '../../../common/files_client';
import type { FileKind } from '../../../common/types';
import { fileNameWithExt } from '../common_schemas';
import { fileErrors } from '../../file';
import { getDownloadHeadersForFile } from '../common';
import { getDownloadHeadersForFile, getDownloadedFileName } from '../common';
import { getById } from './helpers';
import type { CreateHandler, FileKindRouter } from './types';
import { CreateRouteDefinition, FILES_API_ROUTES } from '../api_routes';
Expand All @@ -39,8 +39,9 @@ export const handler: CreateHandler<Endpoint> = async ({ files, fileKind }, req,
if (error) return error;
try {
const body: Response = await file.downloadContent();
return res.ok({
return res.file({
body,
filename: fileName ?? getDownloadedFileName(file),
headers: getDownloadHeadersForFile({ file, fileName }),
});
} catch (e) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ describe('File kind HTTP API', () => {
.expect(200);

expect(header['content-type']).toEqual('image/png');
expect(header['content-disposition']).toEqual('attachment; filename="test.png"');
expect(header['content-disposition']).toEqual('attachment; filename=test.png');
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The res.file implementation provides the filename for content-disposition header without quotes, and is still a valid value, see the spec

expect(buffer.toString('utf8')).toEqual('what have you');
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ describe('File HTTP API', () => {
.expect(200);

expect(header['content-type']).toEqual('application/pdf');
expect(header['content-disposition']).toEqual('attachment; filename="myfilename.pdf"');
expect(header['content-disposition']).toEqual('attachment; filename=myfilename.pdf');
expect(buffer.toString('utf8')).toEqual('test');
});
});
Expand Down
5 changes: 3 additions & 2 deletions src/plugins/files/server/routes/public_facing/download.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
} from '../../file_share_service/errors';
import type { FilesRouter } from '../types';
import { CreateRouteDefinition, FILES_API_ROUTES } from '../api_routes';
import { getDownloadHeadersForFile } from '../common';
import { getDownloadHeadersForFile, getDownloadedFileName } from '../common';
import { fileNameWithExt } from '../common_schemas';
import { CreateHandler } from '../types';

Expand All @@ -44,8 +44,9 @@ const handler: CreateHandler<Endpoint> = async ({ files }, req, res) => {
try {
const file = await fileService.asInternalUser().getByToken(token);
const body: Readable = await file.downloadContent();
return res.ok({
return res.file({
body,
filename: fileName ?? getDownloadedFileName(file),
headers: getDownloadHeadersForFile({ file, fileName }),
});
} catch (e) {
Expand Down
2 changes: 1 addition & 1 deletion x-pack/test/api_integration/apis/cases/files.ts
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ export default ({ getService }: FtrProviderContext): void => {
});

expect(header['content-type']).to.eql('image/png');
expect(header['content-disposition']).to.eql('attachment; filename="test.png"');
expect(header['content-disposition']).to.eql('attachment; filename=test.png');
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See

expect(buffer.toString('utf8')).to.eql('abc');
});

Expand Down
Loading