{"id":2283,"date":"2007-12-10T22:25:54","date_gmt":"2007-12-10T22:25:54","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/odatateam\/2007\/12\/10\/ado-net-data-services-dec2007-ctp-validation-and-access-control\/"},"modified":"2007-12-10T22:25:54","modified_gmt":"2007-12-10T22:25:54","slug":"ado-net-data-services-dec2007-ctp-validation-and-access-control","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/odata\/ado-net-data-services-dec2007-ctp-validation-and-access-control\/","title":{"rendered":"ADO.NET Data Services Dec2007 CTP – Validation and Access Control"},"content":{"rendered":"

Note: This post refers to the CTP available here<\/a>. <\/i> <\/p>\n

When building frameworks to expose and consume data on the web, access policy and data validation are always one of the first topics discussed during the design process, at conferences, etc.  Given this, we thought the topic would be a good one to kick off a series of blog posts about the feature set of the recently announced Dec 07 CTP of the product.  If you haven\u2019t seen ADO.NET Data Services \/ \u201cProject Astoria\u201d before, I suggest checking out http:\/\/astoria.mslivelabs.com<\/a> for an overview and \u201cgetting started\u201d style walkthroughs of the product.  <\/p>\n

<\/b> <\/p>\n

Authentication<\/b> <\/p>\n

Before getting into access control and validation, I need to put in a quick note about authentication to set the stage.  Data services do not directly implement an authentication scheme. Instead, they rely on the authentication infrastructure of the technology (ex. WCF+ASP.NET, WCF, etc) hosting the data service. If you have an ASP.NET site that uses authentication (either one of the built-in authentication schemes or a custom one that sets the HTTP context principal appropriately), Astoria will simply leverage that mechanism to establish the current identity (principal) for a given request.  Ok, now that we know how data services determines who<\/i> is making a request, its\u2019 time to look at how to implement access control and perform validation based on this information. <\/p>\n

<\/b> <\/p>\n

Service-wide Access Control<\/b> <\/p>\n

By default all entities, Service Operations and metadata describing any resources in a data service cannot be retrieved.  Said another way, by default a data service is completely locked down with no read or write access.  This is one of the significant differences from previous (prototype) releases of Astoria.  In prior releases, a data service was fully open by default to enable easily creating and evaluating our ideas for what data services on the web might look like.  Now that the project has moved out from incubation and into an official product release, we changed such that services are locked down out of the box to align with typical security requirements of production web infrastructures. <\/p>\n

One of the first steps a data service developer needs to take is to open up access to the appropriate resources in the data service.  One way to do this is to set service wide, access control policy by adding a data service initialization method.  The code below shows what a typical data service created over the northwind sample database would look like if only the Customers, Orders and Products sets were exposed.  <\/p>\n

public class MyDataService : WebDataService<Northwind><\/font> <\/p>\n

{<\/font> <\/p>\n

\n

public static void InitializeService   <\/font> <\/p>\n

   (<\/font>IWebDataServiceConfiguration configuration)<\/font> <\/p>\n

{<\/font> <\/p>\n<\/blockquote>\n

\n

   \/\/ URI \u2018\/Customers\u2019 entities is enabled for all    <\/font><\/p>\n<\/blockquote>\n

\n

   \/\/read and write <\/font>operations<\/font> <\/p>\n<\/blockquote>\n

    configuration.SetResourceContainerAccessRule<\/font> <\/p>\n

\n

       (“Customers”, <\/font>ResourceContainerRights.All);<\/font> <\/p>\n<\/blockquote>\n

    <\/font> <\/p>\n

     \/\/  URI \u2018\/Orders\u2019 is disabled, but \u2018\/Orders(1)\u2019 <\/font> <\/p>\n

     \/\/ is enabled for read <\/font>only <\/font> <\/p>\n

     configuration.SetResourceContainerAccessRule<\/font> <\/p>\n

\n

      (“Orders”, R<\/font>esourceContainerRights.ReadSingle);<\/font> <\/p>\n<\/blockquote>\n

<\/font>  <\/p>\n

\n

    \/\/  Can insert and update, but not delete <\/font> <\/p>\n

    \/\/ Products<\/font> <\/p>\n<\/blockquote>\n

      configuration.SetResourceContainerAccessRule<\/font> <\/p>\n

       (“Products”, <\/font>              <\/font> <\/p>\n

\n

              ResourceContainerRights.WriteInsert |<\/font> <\/p>\n<\/blockquote>\n

               ResourceContainerRights.WriteUpdate);<\/font> <\/p>\n

   }<\/font> <\/p>\n

}<\/font> <\/p>\n

The access policies in the snippet above are applied to all requests to the data service and are related to entity sets, not particular URIs.  For example, the policy described by the call: \u2018SetResourceContainerAccessRule(“Customers”,ResourceContainerRights.All)\u2019 would apply to a request sent to  \u2018\/Customers(\u2018ALFKI\u2019)\u2019 as well as  \u2019\/Orders(1)\/Customers\u2019.  Basically, the rule is no matter how you address an entity or entity set, the rules in the init method apply equally.  All other entities not explicitly enabled in the initialize service method will not be exposed by the data service.  For example, the northwind db also includes Employee entities.  Since the initialization method does not say anything about Employees, any request to retrieve an employee entity will result in an HTTP 404 (Not Found) response.  In addition accessing the endpoint to retrieve the service\u2019s metadata (ex. http:\/\/host\/service.svc\/$metadata<\/a>) will return a document which only describes those resources where were explicitly made visible. <\/p>\n

Per Request Access Control & Validation<\/b> <\/p>\n

Many data services will need to need to run validation logic when entities enter the data service (for inserts, updates or deletes) and\/or restrict access to entities on a per request basis.  For these scenarios Interceptors<\/i> are used which enable a data service developer to plug in custom validation or access policy logic into the request\/response processing pipeline of a data service.  We decided to take the approach of providing infrastructure to build out custom per request access policy instead of defining an access policy model specific to ADO.NET Data Services because we recognize that each application, business, etc have different requirements in this space and that we could add value by providing comprehensive infrastructure elements for one to build custom access policy.  <\/p>\n

For example, assume you want to implement a policy which enabled customers to only retrieve their orders and not orders placed by other customers.   The example below shows a query interceptor<\/i> that implements this access policy.  The important aspect to note about query interceptors is that they accept as a parameter an instance of IQueryable<T> which represents the query the system will push down to the underlying data store to retrieve the requested entity.  As shown in the example, this approach enables access policy to be defined using query composition eliminating any added round trips to the data store to retrieve access control information.  The example assumes the data service is hosted within a WCF+ASP.NET web application with authentication enabled as the ASP.Net HTTPContext object is used to retrieve the principle of the current request.  <\/p>\n

using System; <\/p>\n

using System.Web; <\/p>\n

using System.Collections.Generic; <\/p>\n

using System.ServiceModel.Web; <\/p>\n

using System.Linq; <\/p>\n

using Microsoft.Data.Web; <\/p>\n

using NorthwindModel; <\/p>\n

namespace TestApplication <\/p>\n

{ <\/p>\n

public class nw :   WebDataService<NorthwindModel.NorthwindEntities> <\/p>\n

{ <\/p>\n

\n

public static void InitializeService( <\/p>\n<\/blockquote>\n

                            IWebDataServiceConfiguration configuration) <\/p>\n

   { <\/p>\n

        configuration.SetResourceContainerAccessRule(“Customers”, <\/p>\n

                    ResourceContainerRights.All); <\/p>\n

        configuration.SetResourceContainerAccessRule(“Orders”, <\/p>\n

                    ResourceContainerRights.ReadSingle); <\/p>\n

        configuration.SetResourceContainerAccessRule(“Products”, <\/p>\n

                    ResourceContainerRights.WriteInsert | <\/p>\n

                    ResourceContainerRights.WriteUpdate); <\/p>\n

    } <\/p>\n

    <\/p>\n

\n

[QueryInterceptor(“Orders”)] <\/p>\n<\/blockquote>\n

    public IQueryable<Orders> OnQueryOrders(IQueryable<Orders> <\/p>\n

\n

                                                                        orderQuery) <\/p>\n<\/blockquote>\n

    { <\/p>\n

          return from o in orderQuery <\/p>\n

             where o.Customers.ContactName == <\/p>\n

\n

          HttpContext.Current.User.Identity.Name <\/p>\n<\/blockquote>\n

             select o; <\/p>\n

    } <\/p>\n

  <\/p>\n

} <\/p>\n

} <\/p>\n

To hook into update operations (insert, update & delete), change interceptors<\/i> are used.  The example below validates all the Product entities that are created are not discontinued.   This would also be the place to implement per request access policy to restrict inserts, updates and\/or deletes per request.       <\/p>\n

[ChangeInterceptor(“Products”)] <\/p>\n

public void OnChangeCategories(Products p, ResourceActions action){ <\/p>\n

\n

if(action == ReceiveEntityOperation.Insert) { <\/p>\n<\/blockquote>\n

\n

  if(p.Discontinued) { <\/p>\n<\/blockquote>\n

\n

    throw new WebDataServiceException(400, <\/p>\n<\/blockquote>\n

\n

                       “Cannot add discontinued products”); <\/p>\n<\/blockquote>\n

     } <\/p>\n

} <\/p>\n

} <\/p>\n

To summarize, services created using the ADO.NET Data Services framework are locked down by default and resources must be explicitly exposed.  Once exposed, the service developer has a number of hooks at their disposal to implement per request access control and business rule validation.   <\/p>\n

What do you think of this approach?  Is there something we should change\/alter\/add\/etc to better meet your requirements?   We look forward to hearing your feedback and continuing our open design process<\/a> on this blog. <\/p>\n

  <\/p>\n

Mike Flasko <\/p>\n

Program Manager <\/p>\n

 <\/p>\n

This post is part of the transparent design exercise in the Astoria Team. To understand how it works and how your feedback will be used please look at this post<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"

Note: This post refers to the CTP available here. When building frameworks to expose and consume data on the web, access policy and data validation are always one of the first topics discussed during the design process, at conferences, etc.  Given this, we thought the topic would be a good one to kick off a […]<\/p>\n","protected":false},"author":512,"featured_media":3253,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[27],"class_list":["post-2283","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-odata","tag-design-notes"],"acf":[],"blog_post_summary":"

Note: This post refers to the CTP available here. When building frameworks to expose and consume data on the web, access policy and data validation are always one of the first topics discussed during the design process, at conferences, etc.  Given this, we thought the topic would be a good one to kick off a […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/posts\/2283","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/users\/512"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/comments?post=2283"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/posts\/2283\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/media\/3253"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/media?parent=2283"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/categories?post=2283"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/tags?post=2283"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}