Skip to main content

.Net Core Protection Using Antiforgery Token



AntiForgeryToken is a security token generated by the .Net Core web application, which is used to validate a post request to guard against Cross-Site Request.

Automatic AntiforgeryToken Generation:

AntiforgeryToken used for validating the post request. So if we access an MVC or RazorPages view which contains the form element with an attribute 'method="post"' then the view gets rendered with an automatic generated AntiforgertyToken value, which gets injected into the form as hidden input field.

Let's test automatic AntiforgeryToken generation as follow:
Controllers/TestController.cs:
using Microsoft.AspNetCore.Mvc;
namespace AntiforgeryTokeSample.Mvc.Controllers
{
    public class TestController : Controller
    {
        public IActionResult Index()
        {
            return View();
        }
    }
}
Let's create a view for the above index action method as follows:
Views/Test/Index.cshtml:
<form  method="POST">
	<button type="submit" class="btn btn-primary">submit</button>
</form>
Here Index.cshtml view contains a form element with method="post" attribute. If you don't specify the method="post" attribute AntiforgertyToken never gets created automatically.
Note:-
So method attribute with post value is mandatory for autogeneration of AntiforgeryToken.
Now run the application and access the view we create above and go to browser inspect element window and we can observe the Antiforgery token injected into the form as below.
In general, the form element will be decorated with the 'action' attribute which has the post action method Url. The tricky part here if we use the 'action' attribute on a form element, the AntiforgeryToken will not be generated automatically.

To test 'action' attribute on form element update the Index.cshtml as follows
Views/Test/Index.html:
<form action="save" method="POST">
	<button type="submit" class="btn btn-primary">submit</button>
</form>
Updated form with 'action' attribute(action method value to post action URL, since we haven't created any post action method for testing our scenario pass any text value 'action' attribute as value).

@Html.AntiForgeryToken Tag Helper To Generate Explicitly:

In razor page, views Antiforgery token generated explicitly by using @Html.AntiForgeryToken(), tag helper.

Let's test using HTML tag helper as below:
Views/Test/Index.cshtml:
<form>
	@Html.AntiForgeryToken()
	<button type="submit" class="btn btn-primary">submit</button>
</form>
Now run the application and check the hidden field inside form with Antiforgery token as value as below
Let's create a post action method that will be decorated with the 'ValidateAntiForgeryToken' attribute to secure the page from cross-site attacks.
Controllers/TestController.cs:
[HttpPost]
[ValidateAntiForgeryToken]
public IActionResult Save()
{
	return Content("Executed Post Save action method");
}
Here we created a sample MVC POST action method which decorated with the 'HttpPost' attribute(makes post method) and 'ValidateAntiForgeryToken' attribute(to secure action method).

Now update the view to navigate to this newly created post method on clicking the submit button on the page as follows.
Views/Test/Index.cshtml:
<form method="POST" action="save">
	@Html.AntiForgeryToken();
	<button type="submit" class="btn btn-primary">Submit</button>
</form>
Form element 'action' attribute specifies the post URL, on hitting submit button form data get posted.

On posting data, the 'ValidateAntiForgeryToken' attribute reads the hidden input element value(AntiforgeryToken) and then validates token. If the token signature qualifies, the server allows the post request to execute, if the token is not qualified(tampered or modified) then the server halts the post request and return a response as Bad Request of status 400(Http Status Code for Bad Request).

Let's run the application and click on the submit button and observe the response below.
By looking at this response from the post action method we can confirm that our Antiforgery Token gets successfully validated.

Let's test a failure case now, so remove the Antiforgery token from the Form element.
Views/Test/Index.html:
<form method="POST" action="save">
	<button type="submit" class="btn btn-primary">Submit</button>
</form>
Now run the application and click on the submit and observe the response below.

IAntiforgery Interface To Generate Explicitly:

By using 'Microsoft.AspNetCore.Antiforgery.IAntiforgery' interface, we able to generate Antiforgery token explicitly.

Views/Test/Index.cshtml:
@inject Microsoft.AspNetCore.Antiforgery.IAntiforgery _antiforgery
@{
   string tokenValue = _antiforgery.GetAndStoreTokens(Context).RequestToken;
}

<div>
    <form method="POST" action="save">
        <input type="hidden" name="__RequestVerificationToken"
        value="@tokenValue" />
        <button type="submit" class="btn btn-primary">Submit</button>
    </form>
</div>
  • Using '@inject' directive injecting the 'Microsoft.AspNetCore.Antiforgery.IAntiforgery'.
  •  'GetAndStoreTokens(Context)' method generate the token. The reason to pass request context as an input parameter to 'GetAndStoreTokens', to fetch value already exists Antiforgery token in Antiforgery cookie, if no cookie value then it will generate new token and store to a cookie, as well as returns it if needed.

  • Token was assigned to a manually added hidden input element in the form. Here hidden input element name should be like "__RequestVerificationToken" if you assign any other name to hidden field the .Net Core application can't read the Antiforgery token value. So "__RequestVerificationToken" is the default name for input hidden element which stores Antiforgery token value.
  • In two scenarios we can give a custom name to a hidden field like:-
  • Case 1 - Override Antiforgery service configuration in Startup.cs file(discuss in detail later steps)
  • Case 2 - Instead of posting form data as MVC page, post the form data to API call by fetching form data using javascript, but in this case, Antiforgery token need to send as the custom header in the API call (discuss in detail in later steps)
Let's a test failure case by assigning a custom name, for example, like 'myTokenField' to the hidden input element as below.
<input type="hidden" name="myTokenField"
        value="@tokenValue" />
Now run the application and click on submit button and you can see the response as below

ValidateAntiForgeryToken Vs AutoValidateAntiForgeryToken:

  • Now we know using ValidateAntiForgeryToken attribute on the POST action method to avoid cross-site attacks. 
  • But adding ValidateAntiForgeryToken filter attribute on every POST action method in action method will be tedious and there are high chances may forget to add on few POST action methods unknowingly which may lead application vulnerability. 
  • At this point in time, we think like adding the ValidateAntiForgery Token filter attribute at the controller level makes our application secured. But adding on controller level leads to fatal error for 'GET', 'OPTION' action method inside the controller, because these methods don't need of the AntiforgeryToken. 
  • So we need to resolve this issue by adding in the filter like 'IgnoreAntiForgeryToken' on 'GET', 'OPTION' action methods.
Let's check the above point practically by updating the controller code as below.
Controllers/TestController.cs:
[ValidateAntiForgeryToken]
public class TestController : Controller
{
	[HttpGet]
	public IActionResult Index()
	{
		return View();
	}

	[HttpPost]
	public IActionResult Save()
	{
		return Content("Executed Post Save action method");
	}
}
Added ValidateAntiForgeryToken filter attribute at the controller. Now try to access the 'Index' action method which is 'GET' and the response will be Bad Request of HTTP Status code 400.
So to avoid this issue need to use 'IgnoreAntiForgeryToken' filter attribute on Http Get Method as below
Controllers/TestController.cs:(Update Index Action method):
[IgnoreAntiforgeryToken]
[HttpGet]
public IActionResult Index()
{
	return View();
}
Now if we access the index action method we won't face any issue like previously. But this approach looks more tedious by configuring two different filter attributes on the action method.

'AutoValidateAntiForgeryToken' filter attribute will solve all the above problems we discussed. 'AutoValidateAntiForgeryToken' by adding on the controller level only validate the action method of type 'POST', it will automatically skip validation for methods like 'GET', 'OPTIONS', 'TRACE', etc.

Let's update the controller with the 'AutoValidateAntiForgeryToken' attribute as below.
Controllers/TestController.cs:
[AutoValidateAntiforgeryToken]
public class TestController : Controller
{
	[HttpGet]
	public IActionResult Index()
	{
		return View();
	}

	[HttpPost]
	public IActionResult Save()
	{
		return Content("Executed Post Save action method");
	}
}

Override Antiforgery Options: 

By registering Antiforgery service in Startup.cs file we can provide our own custom option to the service like Header Name, Form Field Name, Cookie Settings(Cookie Name, Expiration, etc).
Startup.cs:
services.AddAntiforgery(opiton => {
	opiton.FormFieldName = "MyAntiForgeryField";
	opiton.HeaderName = "ANTI-TOKEN-HEADERNAME";
});
Let's observe the difference of hidden field generated by @Html.AntiForgeryToken tag helper.
Views/Test/Index.cshml:
<form method="POST" action="save">
	@Html.AntiForgeryToken()
	<button type="submit" class="btn btn-primary">Submit</button>
</form>
Hidden field name render as per the configuration made at Antiforgery Service registration in the startup.cs

Validate By AJAX Call:

  • Form post data using AJAX call can be validated against the ValidateAntiforgeryToken, by supplying the token in AJAX headers(The same concept will apply for Web API validation). 
  • This header name should be matched with the name configured in 'AddAntiforgery()' service in Startup.cs file.
  • In this AJAX call approach, we need to read the AntiForgeryToken. 
  • Reading can be done either from the Cookie or Hidden Input field. Here we going to access it from the Hidden Input Field.
  • As we know we can inject AntiForgeryToken into the page by using '@Html.AntiForgeryToken()' or 'IAntiforgery' interface. 
  • For Ajax call suitable approach is using 'IAntiforgery' interface, because here we create hidden field manually where we can add additional Html attributes to hidden field like 'Id','class', etc easily, which is not possible with '@Html.AntiForgeryToke()' tag helper which generates hidden field automatically.
  • Using client libraries like Javascript, Jquery, Angular, etc we will read the anti-forgery token from the hidden field by using 'id' attribute.
Let' add the form with the token hidden field as below.
Views/Test/Index.cshtml:
@inject Microsoft.AspNetCore.Antiforgery.IAntiforgery _antiforgery
@{
   string tokenValue = _antiforgery.GetAndStoreTokens(Context).RequestToken;
}

<div>
    <form method="POST" action="save">
        <input type="hidden" id="myToken" name="MyAntiForgeryField"
        value="@tokenValue">
        <button type="button" class="btn btn-primary" onclick="Submit()">Submit</button>
    </form>
</div>
  • 'onclick=Submit()' button click triggers javascript 'submit' function.
  • 'id=myToken' using hidden field 'id' attribute fetches token value in javascript.
Add the following AJAX call code snippet at the bottom of the razor page as follows
Views/Test/Index.cshtml:(Add at bottom of page)
<script>
function Submit(){
   var token = $("#myToken").val();
   $.ajax({
	   beforeSend:function(request){
		   request.setRequestHeader("ANTI-TOKEN-HEADERNAME",token)
	   },
	   url:"https://localhost:5001/test/save",
	   type:"POST"
   })
}
</script>
  • Using the hidden field 'id' attribute fetches the token value.
  • 'ANTI-TOKEN-HEADERNAME' is custom header name this value must match with options set int 'AddAntiforgery()' service method in the Startup.cs file.
Now run the application and click on the button and check the AJAX call as follows

Wrapping Up:

Hopefully, this article will help to understand AntiforgeryToken In .Net Core Application. I love to have your feedback, suggestions, and better techniques in the comment sections.

Follow Me:

Comments

  1. Well explained ,keep it up.

    ReplyDelete
  2. Thank you very much for this detailed explanation. It seems the RequestVerificationToken can also be sent in form-data. I've tested with Insomnia and it works:

    ```
    Content-Disposition: form-data; name="__RequestVerificationToken"
    | CfDJ8AcKBMNi4DdLguow6v7WiDVltkwODWRKcrqi85_2_ommsENbr5rr79EgDIyBLr5P6mtluGEWnuFfZUrxvTjCNXR8U_wyjQLPXupnE1MsgrwS5DpDT4zc9e-AwHTbVLV3kwkuT-qlIbaU-k2pfSDfrcw
    ```

    Is there a prefered way or can I just use whatever method ?

    ReplyDelete

Post a Comment

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. CLI command For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl