Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Different REST resource content based on user viewing privileges

I want to provide different answers to the same question for different users, based on the access rights. I read this question:

Excluding private data in RESTful response

But I don't agree with the accepted answer, which states that you should provide both /people.xml and /unauthenticated/people.xml, since my understanding of REST is that a particular resource should live in a particular location, not several depending on how much of its information you're interested in.

The system I'm designing is even more complicated than that one. Let's say that a user has created a number of circles of friends, and assigned different access rights to them. For example, my "acquaintances" circle might have access to my birthday, and my "professional" circle might have access to my employment history, but not the other way around. In order to apply the answer from the question I mentioned, I need to have a way of getting all of the user's circles (which I might want to keep secret for security reasons), and then go through /circles/a/users/42, /circles/b/users/42, /circles/c/users/42 and so on, and then merge the results to display the maximum amount of information available. Obviously there's not necessarily a single circle that gets all the information that any of the other circles get. I believe this is tricky enough (note that I probably need to do this with several kinds of objects and that future versions might require a different procedure), but what if I want to impose security restrictions on a particular user despite the fact that he's also in some of my circles? Can that problem even be solved? Even if I refuse to respond to any of the above-mentioned queries and come up with a new one that could give me an answer, it'd still reveal the fact that this specific user is treated differently due to individual access restrictions.

What am I missing here? Is it even possible for me to develop a RESTful web service?

If the conclusion is that the behavior is not RESTful, would this still constitute as a situation where it'd be morally okay to break the REST contract? If so, what are the negative implications? Do I risk proxy caching issues for example?

like image 476
Anders Sjöqvist Avatar asked Jun 12 '12 12:06

Anders Sjöqvist


People also ask

What are the different types of REST resource?

REST architecture treats every content as a resource. These resources can be Text Files, Html Pages, Images, Videos or Dynamic Business Data. REST Server simply provides access to resources and REST client accesses and modifies the resources. Here each resource is identified by URIs/ Global IDs.

How do I restrict access to REST API?

If you wish to restrict access to the API altogether or restrict specific types of calls we have settings to help you do just this! To get to these settings click Account > Integrations > Manage API. You can restrict the specific methods for making API calls or restrict the use of OAUTH authentication.

What is a resource in rest?

A resource can be defined as a vital element to be referenced within a client-server system. REST architecture treats all of its content as a resource, which includes Html Pages, Images, Text Files, Videos, etc. Access to resources is provided by the REST server where REST client is used for accessing as well as modification of resources.

What is a RESTful API?

The initial concept of the RESTful API is its resource and its functionality. It acts as an object of OOP (Object Oriented Programming) language or a database entity. As the resources are recognized, they're determined using a standard format so that the server can transmit the resource in the specific developer's format.

What is the Uri in rest architecture?

REST architecture treats all of its content as a resource, which includes Html Pages, Images, Text Files, Videos, etc. Access to resources is provided by the REST server where REST client is used for accessing as well as modification of resources. All of its resources get identified via URI, which is abbreviated as Uniform Resource Identifier.

What can users see and do with a resource?

What users can see and do with a resource, such as a document, content item, or site, depends on the role (or permission) they’re assigned when the resource is shared with them. For example, they might be the manager of one site, a contributor to a folder, or a viewer for another site.


2 Answers

According to Fielding's dissertation (it really is a great writing):

A resource is a conceptual mapping to a set of entities, not the entity that corresponds to the mapping at any particular point in time.

In other words, if you have a resource that is defined as "the requesting user's assigned projects" and representations thereof accessible by a URI of /projects, you do not violate any constraints of REST by returning one list of projects (i.e., representation) for user A and another (representation) for user B when they GET that same URI. In this way, the interface is uniform/consistent.

In addition to this, REST only prescribes that an explicit caching instruction be included with the response, whether that is 'cache for this long' or 'do not cache at all':

Cache constraints require that the data within a response to a request be implicitly or explicitly labeled as cacheable or non-cacheable.

How you choose to manage that is up to you.

Keeping that in mind,

You should feel comfortable returning a representation of a resource that varies depending on the user requesting a representation of a particular resource, as long as you are not violating the constraints of a uniform interface -- don't use a single resource identifier to return representations of different resources.

If it helps, consider that the server responds with varying representations of a resource as well -- XML or JSON, French or English, etc. The credentials sent with the request are just another factor the server is able to use in determining which representation to to send in response. That's what the header section is there for.

like image 124
tuespetre Avatar answered Oct 10 '22 12:10

tuespetre


I agree that the other solution doesn't seem right. It makes the URL structure complicated and more difficult to find the resource. However, if you did REST properly, it shouldn't matter what the URL for the resource is as the server controls it (and is free to relocate it as it sees fit). If your client is really "REST", it would discover the resources it needed through prior negotiation with the server. So the path truly would not matter on the client. I don't like it because its confusing to use - not because of some violation of REST principles.

But that probably doesn't answer your question - What you didn't mention is your security setup - presumably you are a passing a session token with the request as part of the request header. So your back-end processing should have the ability to tie it to particular set of security constraints. From there, you form the list with whatever business logic you need and return a limited resource based on the user's security tied to the session.

For the algorithm itself, one usually implements a least or most restrictive type algorithm that merges the allowable data into a response (very similar to java realms or Microsoft's user security model).

If the data is structured differently for the restricted/non-restricted case, you could create two different representations of the data and return which ever one the user was authorized to see. The client should be asking for the accepted mime response types anyway, and it would just provide different answers based on the session security in the request header. Alternatively, you could provide optional elements with the representations and fill out the appropriate one base on authorization (although this is a little hack-ee in my opinion).

like image 32
jeremyh Avatar answered Oct 10 '22 11:10

jeremyh