Enabling Cross-Origin Requests in ASP.NET Web API 2
by Mike Wasson
Browser security prevents a web page from making AJAX requests to another domain. This restriction is called the same-origin policy, and prevents a malicious site from reading sensitive data from another site. However, sometimes you might want to let other sites call your web API.
Cross Origin Resource Sharing (CORS) is a W3C standard that allows a server to relax the same-origin policy. Using CORS, a server can explicitly allow some cross-origin requests while rejecting others. CORS is safer and more flexible than earlier techniques such as JSONP. This tutorial shows how to enable CORS in your Web API application.
Software versions used in the tutorial
- Visual Studio 2013 Update 2
- Web API 2.2
This tutorial demonstrates CORS support in ASP.NET Web API. We’ll start by creating two ASP.NET projects – one called “WebService”, which hosts a Web API controller, and the other called “WebClient”, which calls WebService. Because the two applications are hosted at different domains, an AJAX request from WebClient to WebService is a cross-origin request.
What is “Same Origin”?
Two URLs have the same origin if they have identical schemes, hosts, and ports. (RFC 6454)
These two URLs have the same origin:
http://example.com/foo.htmlhttp://example.com/bar.html
These URLs have different origins than the previous two:
http://example.net- Different domainhttp://example.com:9000/foo.html- Different porthttps://example.com/foo.html- Different schemehttp://www.example.com/foo.html- Different subdomain
[!NOTE] Internet Explorer does not consider the port when comparing origins.
## Create the WebService Project
[!NOTE] This section assumes you already know how to create Web API projects. If not, see Getting Started with ASP.NET Web API.
Start Visual Studio and create a new ASP.NET Web Application project. Select the Empty project template. Under “Add folders and core references for”, select the Web API checkbox. Optionally, select the “Host in Cloud” option to deploy the app to Mircosoft Azure. Microsoft offers free web hosting for up to 10 websites in a free Azure trial account.
Add a Web API controller named TestController with the following code:
[!code-csharpMain]
1: using System.Net.Http;
2: using System.Web.Http;
3:
4: namespace WebService.Controllers
5: {
6: public class TestController : ApiController
7: {
8: public HttpResponseMessage Get()
9: {
10: return new HttpResponseMessage()
11: {
12: Content = new StringContent("GET: Test message")
13: };
14: }
15:
16: public HttpResponseMessage Post()
17: {
18: return new HttpResponseMessage()
19: {
20: Content = new StringContent("POST: Test message")
21: };
22: }
23:
24: public HttpResponseMessage Put()
25: {
26: return new HttpResponseMessage()
27: {
28: Content = new StringContent("PUT: Test message")
29: };
30: }
31: }
32: }
You can run the application locally or deploy to Azure. (For the screenshots in this tutorial, I deployed to Azure App Service Web Apps.) To verify that the web API is working, navigate to http://hostname/api/test/, where hostname is the domain where you deployed the application. You should see the response text, “GET: Test Message”.
## Create the WebClient Project
Create another ASP.NET Web Application project and select the MVC project template. Optionally, select Change Authentication > No Authentication. You don’t need authentication for this tutorial.
In Solution Explorer, open the file Views/Home/Index.cshtml. Replace the code in this file with the following:
[!code-cshtmlMain]
1: <div>
2: <select id="method">
3: <option value="get">GET</option>
4: <option value="post">POST</option>
5: <option value="put">PUT</option>
6: </select>
7: <input type="button" value="Try it" onclick="sendRequest()" />
8: <span id='value1'>(Result)</span>
9: </div>
10:
11: @section scripts {
12: <script>
13: // TODO: Replace with the URL of your WebService app
14: var serviceUrl = 'http://mywebservice/api/test';
15:
16: function sendRequest() {
17: var method = $('#method').val();
18:
19: $.ajax({
20: type: method,
21: url: serviceUrl
22: }).done(function (data) {
23: $('#value1').text(data);
24: }).error(function (jqXHR, textStatus, errorThrown) {
25: $('#value1').text(jqXHR.responseText || textStatus);
26: });
27: }
28: </script>
29: }
For the serviceUrl variable, use the URI of the WebService app. Now run the WebClient app locally or publish it to another website.
Clicking the “Try It” button submits an AJAX request to the WebService app, using the HTTP method listed in the dropdown box (GET, POST, or PUT). This lets us examine different cross-origin requests. Right now, the WebService app does not support CORS, so if you click the button, you will get an error.
[!NOTE] If you watch the HTTP traffic in a tool like Fiddler, you will see that the browser does send the GET request, and the request succeeds, but the AJAX call returns an error. It’s important to understand that same-origin policy does not prevent the browser from sending the request. Instead, it prevents the application from seeing the response.
Now let’s enable CORS in the WebService app. First, add the CORS NuGet package. In Visual Studio, from the Tools menu, select Library Package Manager, then select Package Manager Console. In the Package Manager Console window, type the following command:
[!code-powershellMain]
1: Install-Package Microsoft.AspNet.WebApi.Cors
This command installs the latest package and updates all dependencies, including the core Web API libraries. User the -Version flag to target a specific version. The CORS package requires Web API 2.0 or later.
Open the file App_Start/WebApiConfig.cs. Add the following code to the WebApiConfig.Register method.
[!code-csharpMain]
1: using System.Web.Http;
2: namespace WebService
3: {
4: public static class WebApiConfig
5: {
6: public static void Register(HttpConfiguration config)
7: {
8: // New code
9: config.EnableCors();
10:
11: config.Routes.MapHttpRoute(
12: name: "DefaultApi",
13: routeTemplate: "api/{controller}/{id}",
14: defaults: new { id = RouteParameter.Optional }
15: );
16: }
17: }
18: }
Next, add the [EnableCors] attribute to the TestController class:
[!code-csharpMain]
1: using System.Net.Http;
2: using System.Web.Http;
3: using System.Web.Http.Cors;
4:
5: namespace WebService.Controllers
6: {
7: [EnableCors(origins: "http://mywebclient.azurewebsites.net", headers: "*", methods: "*")]
8: public class TestController : ApiController
9: {
10: // Controller methods not shown...
11: }
12: }
For the origins parameter, use the URI where you deployed the WebClient application. This allows cross-origin requests from WebClient, while still disallowing all other cross-domain requests. Later, I’ll describe the parameters for [EnableCors] in more detail.
Do not include a forward slash at the end of the origins URL.
Redeploy the updated WebService application. You don’t need to update WebClient. Now the AJAX request from WebClient should succeed. The GET, PUT, and POST methods are all allowed.
This section describes what happens in a CORS request, at the level of the HTTP messages. It’s important to understand how CORS works, so that you can configure the [EnableCors] attribute correctly, and troubleshoot if things don’t work as you expect.
The CORS specification introduces several new HTTP headers that enable cross-origin requests. If a browser supports CORS, it sets these headers automatically for cross-origin requests; you don’t need to do anything special in your JavaScript code.
Here is an example of a cross-origin request. The “Origin” header gives the domain of the site that is making the request.
[!code-consoleMain]
1: GET http://myservice.azurewebsites.net/api/test HTTP/1.1
2: Referer: http://myclient.azurewebsites.net/
3: Accept: */*
4: Accept-Language: en-US
5: Origin: http://myclient.azurewebsites.net
6: Accept-Encoding: gzip, deflate
7: User-Agent: Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)
8: Host: myservice.azurewebsites.net
If the server allows the request, it sets the Access-Control-Allow-Origin header. The value of this header either matches the Origin header, or is the wildcard value “*”, meaning that any origin is allowed.
[!code-consoleMain]
1: HTTP/1.1 200 OK
2: Cache-Control: no-cache
3: Pragma: no-cache
4: Content-Type: text/plain; charset=utf-8
5: Access-Control-Allow-Origin: http://myclient.azurewebsites.net
6: Date: Wed, 05 Jun 2013 06:27:30 GMT
7: Content-Length: 17
8:
9: GET: Test message
If the response does not include the Access-Control-Allow-Origin header, the AJAX request fails. Specifically, the browser disallows the request. Even if the server returns a successful response, the browser does not make the response available to the client application.
Preflight Requests
For some CORS requests, the browser sends an additional request, called a “preflight request”, before it sends the actual request for the resource.
The browser can skip the preflight request if the following conditions are true:
- The request method is GET, HEAD, or POST, and
- The application does not set any request headers other than Accept, Accept-Language, Content-Language, Content-Type, or Last-Event-ID, and
The Content-Type header (if set) is one of the following:
- application/x-www-form-urlencoded
- multipart/form-data
- text/plain
The rule about request headers applies to headers that the application sets by calling setRequestHeader on the XMLHttpRequest object. (The CORS specification calls these “author request headers”.) The rule does not apply to headers the browser can set, such as User-Agent, Host, or Content-Length.
Here is an example of a preflight request:
[!code-consoleMain]
1: OPTIONS http://myservice.azurewebsites.net/api/test HTTP/1.1
2: Accept: */*
3: Origin: http://myclient.azurewebsites.net
4: Access-Control-Request-Method: PUT
5: Access-Control-Request-Headers: accept, x-my-custom-header
6: Accept-Encoding: gzip, deflate
7: User-Agent: Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)
8: Host: myservice.azurewebsites.net
9: Content-Length: 0
The pre-flight request uses the HTTP OPTIONS method. It includes two special headers:
- Access-Control-Request-Method: The HTTP method that will be used for the actual request.
- Access-Control-Request-Headers: A list of request headers that the application set on the actual request. (Again, this does not include headers that the browser sets.)
Here is an example response, assuming that the server allows the request:
[!code-consoleMain]
1: HTTP/1.1 200 OK
2: Cache-Control: no-cache
3: Pragma: no-cache
4: Content-Length: 0
5: Access-Control-Allow-Origin: http://myclient.azurewebsites.net
6: Access-Control-Allow-Headers: x-my-custom-header
7: Access-Control-Allow-Methods: PUT
8: Date: Wed, 05 Jun 2013 06:33:22 GMT
The response includes an Access-Control-Allow-Methods header that lists the allowed methods, and optionally an Access-Control-Allow-Headers header, which lists the allowed headers. If the preflight request succeeds, the browser sends the actual request, as described earlier.
## Scope Rules for [EnableCors]
You can enable CORS per action, per controller, or globally for all Web API controllers in your application.
Per Action
To enable CORS for a single action, set the [EnableCors] attribute on the action method. The following example enables CORS for the GetItem method only.
[!code-csharpMain]
1: public class ItemsController : ApiController
2: {
3: public HttpResponseMessage GetAll() { ... }
4:
5: [EnableCors(origins: "http://www.example.com", headers: "*", methods: "*")]
6: public HttpResponseMessage GetItem(int id) { ... }
7:
8: public HttpResponseMessage Post() { ... }
9: public HttpResponseMessage PutItem(int id) { ... }
10: }
Per Controller
If you set [EnableCors] on the controller class, it applies to all the actions on the controller. To disable CORS for an action, add the [DisableCors] attribute to the action. The following example enables CORS for every method except PutItem.
[!code-csharpMain]
1: [EnableCors(origins: "http://www.example.com", headers: "*", methods: "*")]
2: public class ItemsController : ApiController
3: {
4: public HttpResponseMessage GetAll() { ... }
5: public HttpResponseMessage GetItem(int id) { ... }
6: public HttpResponseMessage Post() { ... }
7:
8: [DisableCors]
9: public HttpResponseMessage PutItem(int id) { ... }
10: }
Globally
To enable CORS for all Web API controllers in your application, pass an EnableCorsAttribute instance to the EnableCors method:
[!code-csharpMain]
1: public static class WebApiConfig
2: {
3: public static void Register(HttpConfiguration config)
4: {
5: var cors = new EnableCorsAttribute("www.example.com", "*", "*");
6: config.EnableCors(cors);
7: // ...
8: }
9: }
If you set the attribute at more than one scope, the order of precedence is:
- Action
- Controller
- Global
The origins parameter of the [EnableCors] attribute specifies which origins are allowed to access the resource. The value is a comma-separated list of the allowed origins.
[!code-csharpMain]
1: [EnableCors(origins: "http://www.contoso.com,http://www.example.com",
2: headers: "*", methods: "*")]
You can also use the wildcard value “*” to allow requests from any origins.
Consider carefully before allowing requests from any origin. It means that literally any website can make AJAX calls to your web API.
[!code-csharpMain]
1: // Allow CORS for all origins. (Caution!)
2: [EnableCors(origins: "*", headers: "*", methods: "*")]
## Set the Allowed HTTP Methods
The methods parameter of the [EnableCors] attribute specifies which HTTP methods are allowed to access the resource. To allow all methods, use the wildcard value “*”. The following example allows only GET and POST requests.
[!code-csharpMain]
1: [EnableCors(origins: "http://www.example.com", headers: "*", methods: "get,post")]
2: public class TestController : ApiController
3: {
4: public HttpResponseMessage Get() { ... }
5: public HttpResponseMessage Post() { ... }
6: public HttpResponseMessage Put() { ... }
7: }
## Set the Allowed Request Headers
Earlier I described how a preflight request might include an Access-Control-Request-Headers header, listing the HTTP headers set by the application (the so-called “author request headers”). The headers parameter of the [EnableCors] attribute specifies which author request headers are allowed. To allow any headers, set headers to “*”. To whitelist specific headers, set headers to a comma-separated list of the allowed headers:
[!code-csharpMain]
1: [EnableCors(origins: "http://example.com",
2: headers: "accept,content-type,origin,x-my-header", methods: "*")]
However, browsers are not entirely consistent in how they set Access-Control-Request-Headers. For example, Chrome currently includes “origin”; while FireFox does not include standard headers such as “Accept”, even when the application sets them in script.
If you set headers to anything other than “*”, you should include at least “accept”, “content-type”, and “origin”, plus any custom headers that you want to support.
## Set the Allowed Response Headers
By default, the browser does not expose all of the response headers to the application. The response headers that are available by default are:
- Cache-Control
- Content-Language
- Content-Type
- Expires
- Last-Modified
- Pragma
The CORS spec calls these simple response headers. To make other headers available to the application, set the exposedHeaders parameter of [EnableCors].
In the following example, the controller’s Get method sets a custom header named ‘X-Custom-Header’. By default, the browser will not expose this header in a cross-origin request. To make the header available, include ‘X-Custom-Header’ in exposedHeaders.
[!code-csharpMain]
1: [EnableCors(origins: "*", headers: "*", methods: "*", exposedHeaders: "X-Custom-Header")]
2: public class TestController : ApiController
3: {
4: public HttpResponseMessage Get()
5: {
6: var resp = new HttpResponseMessage()
7: {
8: Content = new StringContent("GET: Test message")
9: };
10: resp.Headers.Add("X-Custom-Header", "hello");
11: return resp;
12: }
13: }
## Passing Credentials in Cross-Origin Requests
Credentials require special handling in a CORS request. By default, the browser does not send any credentials with a cross-origin request. Credentials include cookies as well as HTTP authentication schemes. To send credentials with a cross-origin request, the client must set XMLHttpRequest.withCredentials to true.
Using XMLHttpRequest directly:
[!code-csharpMain]
1: var xhr = new XMLHttpRequest();
2: xhr.open('get', 'http://www.example.com/api/test');
3: xhr.withCredentials = true;
In jQuery:
[!code-javascriptMain]
1: $.ajax({
2: type: 'get',
3: url: 'http://www.example.com/api/test',
4: xhrFields: {
5: withCredentials: true
6: }
In addition, the server must allow the credentials. To allow cross-origin credentials in Web API, set the SupportsCredentials property to true on the [EnableCors] attribute:
[!code-csharpMain]
1: [EnableCors(origins: "http://myclient.azurewebsites.net", headers: "*",
2: methods: "*", SupportsCredentials = true)]
If this property is true, the HTTP response will include an Access-Control-Allow-Credentials header. This header tells the browser that the server allows credentials for a cross-origin request.
If the browser sends credentials, but the response does not include a valid Access-Control-Allow-Credentials header, the browser will not expose the response to the application, and the AJAX request fails.
Be very careful about setting SupportsCredentials to true, because it means a website at another domain can send a logged-in user’s credentials to your Web API on the user’s behalf, without the user being aware. The CORS spec also states that setting origins to “*” is invalid if SupportsCredentials is true.
## Custom CORS Policy Providers
The [EnableCors] attribute implements the ICorsPolicyProvider interface. You can provide your own implementation by creating a class that derives from Attribute and implements ICorsProlicyProvider.
[!code-csharpMain]
1: [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false)]
2: public class MyCorsPolicyAttribute : Attribute, ICorsPolicyProvider
3: {
4: private CorsPolicy _policy;
5:
6: public MyCorsPolicyAttribute()
7: {
8: // Create a CORS policy.
9: _policy = new CorsPolicy
10: {
11: AllowAnyMethod = true,
12: AllowAnyHeader = true
13: };
14:
15: // Add allowed origins.
16: _policy.Origins.Add("http://myclient.azurewebsites.net");
17: _policy.Origins.Add("http://www.contoso.com");
18: }
19:
20: public Task<CorsPolicy> GetCorsPolicyAsync(HttpRequestMessage request)
21: {
22: return Task.FromResult(_policy);
23: }
24: }
Now you can apply the attribute any place that you would put [EnableCors].
[!code-csharpMain]
1: [MyCorsPolicy]
2: public class TestController : ApiController
3: {
4: .. //
For example, a custom CORS policy provider could read the settings from a configuration file.
As an alternative to using attributes, you can register an ICorsPolicyProviderFactory object that creates ICorsPolicyProvider objects.
[!code-csharpMain]
1: public class CorsPolicyFactory : ICorsPolicyProviderFactory
2: {
3: ICorsPolicyProvider _provider = new MyCorsPolicyProvider();
4:
5: public ICorsPolicyProvider GetCorsPolicyProvider(HttpRequestMessage request)
6: {
7: return _provider;
8: }
9: }
To set the ICorsPolicyProviderFactory, call the SetCorsPolicyProviderFactory extension method at startup, as follows:
[!code-csharpMain]
1: public static class WebApiConfig
2: {
3: public static void Register(HttpConfiguration config)
4: {
5: config.SetCorsPolicyProviderFactory(new CorsPolicyFactory());
6: config.EnableCors();
7:
8: // ...
9: }
10: }
The Web API CORS package is a server-side technology. The user’s browser also needs to support CORS. Fortunately, the current versions of all major browsers include support for CORS.
Internet Explorer 8 and Internet Explorer 9 have partial support for CORS, using the legacy XDomainRequest object instead of XMLHttpRequest. For more information, see XDomainRequest - Restrictions, Limitations and Workarounds.
)
|
|