Skip to content

Latest commit

 

History

History
257 lines (179 loc) · 12 KB

file-downloads.md

File metadata and controls

257 lines (179 loc) · 12 KB
Raw
title author description monikerRange ms.author ms.custom ms.date uid
ASP.NET Core Blazor file downloads
guardrex
Learn how to download files in Blazor apps.
>= aspnetcore-6.0
riande
mvc
11/14/2023
blazor/file-downloads

ASP.NET Core Blazor file downloads

[!INCLUDE]

This article explains how to download files in Blazor apps.

[!INCLUDE]

File downloads

Files can be downloaded from the app's own static assets or from any other location:

  • ASP.NET Core apps use Static File Middleware to serve files to clients of server-side apps.
  • The guidance in this article also applies to other types of file servers that don't use .NET, such as Content Delivery Networks (CDNs).

This article covers approaches for the following scenarios:

When downloading files from a different origin than the app, Cross-Origin Resource Sharing (CORS) considerations apply. For more information, see the Cross-Origin Resource Sharing (CORS) section.

Security considerations

Use caution when providing users with the ability to download files from a server. Attackers may execute Denial of Service (DoS) attacks, API exploitation attacks, or attempt to compromise networks and servers in other ways.

Security steps that reduce the likelihood of a successful attack are:

  • Download files from a dedicated file download area on the server, preferably from a non-system drive. Using a dedicated location makes it easier to impose security restrictions on downloadable files. Disable execute permissions on the file download area.
  • Client-side security checks are easy to circumvent by malicious users. Always perform client-side security checks on the server, too.
  • Don't receive files from users or other untrusted sources and then make the files available for immediate download without performing security checks on the files. For more information, see xref:mvc/models/file-uploads#security-considerations.

Download from a stream

This section applies to files that are typically up to 250 MB in size.

The recommended approach for downloading relatively small files (< 250 MB) is to stream file content to a raw binary data buffer on the client with JavaScript (JS) interop.

Warning

The approach in this section reads the file's content into a JS ArrayBuffer. This approach loads the entire file into the client's memory, which can impair performance. To download relatively large files (>= 250 MB), we recommend following the guidance in the Download from a URL section.

The following downloadFileFromStream JS function:

  • Reads the provided stream into an ArrayBuffer.
  • Creates a Blob to wrap the ArrayBuffer.
  • Creates an object URL to serve as the file's download address.
  • Creates an HTMLAnchorElement (<a> element).
  • Assigns the file's name (fileName) and URL (url) for the download.
  • Triggers the download by firing a click event on the anchor element.
  • Removes the anchor element.
  • Revokes the object URL (url) by calling URL.revokeObjectURL. This is an important step to ensure memory isn't leaked on the client.
<script>
  window.downloadFileFromStream = async (fileName, contentStreamReference) => {
    const arrayBuffer = await contentStreamReference.arrayBuffer();
    const blob = new Blob([arrayBuffer]);
    const url = URL.createObjectURL(blob);
    const anchorElement = document.createElement('a');
    anchorElement.href = url;
    anchorElement.download = fileName ?? '';
    anchorElement.click();
    anchorElement.remove();
    URL.revokeObjectURL(url);
  }
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

The following component:

  • Uses native byte-streaming interop to ensure efficient transfer of the file to the client.
  • Has a method named GetFileStream to retrieve a xref:System.IO.Stream for the file that's downloaded to clients. Alternative approaches include retrieving a file from storage or generating a file dynamically in C# code. For this demonstration, the app creates a 50 KB file of random data from a new byte array (new byte[]). The bytes are wrapped with a xref:System.IO.MemoryStream to serve as the example's dynamically-generated binary file.
  • The DownloadFileFromStream method:
    • Retrieves the xref:System.IO.Stream from GetFileStream.
    • Specifies a file name when file is saved on the user's machine. The following example names the file quote.txt.
    • Wraps the xref:System.IO.Stream in a xref:Microsoft.JSInterop.DotNetStreamReference, which allows streaming the file data to the client.
    • Invokes the downloadFileFromStream JS function to accept the data on the client.

FileDownload1.razor:

:::moniker range=">= aspnetcore-8.0"

@page "/file-download-1"
@using System.IO
@inject IJSRuntime JS

<h1>File Download Example 1</h1>

<button @onclick="DownloadFileFromStream">
    Download File From Stream
</button>

@code {
    private Stream GetFileStream()
    {
        var binaryData = new byte[50 * 1024];
        var fileStream = new MemoryStream(binaryData);
        return fileStream;
    }

    private async Task DownloadFileFromStream()
    {
        var fileStream = GetFileStream();
        var fileName = "log.bin";
        using var streamRef = new DotNetStreamReference(stream: fileStream);

        await JS.InvokeVoidAsync("downloadFileFromStream", fileName, streamRef);
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/file-downloads/FileDownload1.razor":::

:::moniker-end

:::moniker range="< aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/file-downloads/FileDownload1.razor":::

:::moniker-end

For a component in a server-side app that must return a xref:System.IO.Stream for a physical file, the component can call xref:System.IO.File.OpenRead%2A?displayProperty=nameWithType, as the following example demonstrates:

private Stream GetFileStream()
{
    return File.OpenRead(@"{PATH}");
}

In the preceding example, the {PATH} placeholder is the path to the file. The @ prefix indicates that the string is a verbatim string literal, which permits the use of backslashes (\) in a Windows OS path and embedded double-quotes ("") for a single quote in the path. Alternatively, avoid the string literal (@) and use either of the following approaches:

  • Use escaped backslashes (\\) and quotes (\").
  • Use forward slashes (/) in the path, which are supported across platforms in ASP.NET Core apps, and escaped quotes (\").

Download from a URL

This section applies to files that are relatively large, typically 250 MB or larger.

The example in this section uses a download file named quote.txt, which is placed in a folder named files in the app's web root (wwwroot folder). The use of the files folder is only for demonstration purposes. You can organize downloadable files in any folder layout within the web root (wwwroot folder) that you prefer, including serving the files directly from the wwwroot folder.

wwwroot/files/quote.txt:

:::moniker range=">= aspnetcore-7.0"

:::code language="text" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/wwwroot/files/quote.txt":::

:::moniker-end

:::moniker range="< aspnetcore-7.0"

:::code language="text" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/wwwroot/files/quote.txt":::

:::moniker-end

The following triggerFileDownload JS function:

  • Creates an HTMLAnchorElement (<a> element).
  • Assigns the file's name (fileName) and URL (url) for the download.
  • Triggers the download by firing a click event on the anchor element.
  • Removes the anchor element.
<script>
  window.triggerFileDownload = (fileName, url) => {
    const anchorElement = document.createElement('a');
    anchorElement.href = url;
    anchorElement.download = fileName ?? '';
    anchorElement.click();
    anchorElement.remove();
  }
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

The following example component downloads the file from the same origin that the app uses. If the file download is attempted from a different origin, configure Cross-Origin Resource Sharing (CORS). For more information, see the Cross-Origin Resource Sharing (CORS) section.

Change the port in the following example to match the localhost development port of your environment.

FileDownload2.razor:

:::moniker range=">= aspnetcore-8.0"

@page "/file-download-2"
@inject IJSRuntime JS

<h1>File Download Example 2</h1>

<button @onclick="DownloadFileFromURL">
    Download File From URL
</button>

@code {
    private async Task DownloadFileFromURL()
    {
        var fileName = "quote.txt";
        var fileURL = Path.Combine("https://localhost:7029", "files", fileName);

        await JS.InvokeVoidAsync("triggerFileDownload", fileName, fileURL);
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/file-downloads/FileDownload2.razor":::

:::moniker-end

:::moniker range="< aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/file-downloads/FileDownload2.razor":::

:::moniker-end

Cross-Origin Resource Sharing (CORS)

Without taking further steps to enable Cross-Origin Resource Sharing (CORS) for files that don't have the same origin as the app, downloading files won't pass CORS checks made by the browser.

For more information on CORS with ASP.NET Core apps and other Microsoft products and services that host files for download, see the following resources:

Additional resources