facebook noscript

Building a Fine-grained Permission System in a Distributed Environment: Architecture

February 13, 2019
engineering-default

At Very Good Security (VGS), our seasoned engineering team works hard to successfully solve complex technical challenges - while keeping security our top priority. One of such security challenges is access control to resources we store in our microservice architectures.

Essentially, what we are about here is the level of authorization. This isn’t to be confused with setting up an authentication process, although these two concepts do tend to appear hand in hand.

Authentication and authorization both provide different levels of security. Authorization basically controls who has access to what. Meanwhile, authentication handles validating a user’s identity or role.

When would we use authorization processes?

Consider this real-world scenario: a document management system. On each document, you can find multiple collaborators with different permissions levels. Your user account has access to multiple documents, and on each of them you have different permissions levels: read, write, or admin (managing other users’ access to the document). This structure is similar to how sharing permissions works on Google Docs.

Let’s take a look at a simple, specific example: Does Alice have access to “read” document #123?

fine-grained-permission-system

We need to evaluate access quickly and implementation shouldn't be too complicated for other engineers to use it.

For building a usable microservices authentication and fine-grained authorization API, it needs to also fulfill the following conditions :

  • Restrict access to multiple documents
  • Access needs to be restricted on a per-user basis
  • Evaluate documents' permissions by multiple instances of a service
  • Deploy and use the architecture effortlessly
  • Authorization and authentication mechanisms should be fast in performance

Existing solutions in authentication and authorization

Typical authentication and authorization mechanisms are based on OAuth 2.0 / OpenID Connect, but these protocols are not designed to solve these types of issues. OAuth 2.0 is a delegation protocol, which instead, solves a client-to-client access delegation problem. OpenID Connect just adds an identity layer on top of OAuth 2.0. To achieve our goal, we need to look beyond these solutions.

Access control lists, RBAC and ABAC concepts were designed to solve these exact problems. If you’re designing a monolithic application, the described problem of authentication and authorization can be resolved by simply storing all the lists in a single database and evaluating permissions any time the system needs it. But that’s assuming you aren’t working in a centralized environment. Things begin to get more complicated in a distributed environment.

It is very difficult to manage decision criteria and policies when access control technology is embedded in each service. Each service needs to be updated with any changes in authentication and authorization policies, and evaluation logic needs to be shared among different applications.

Considering the fact that you can have services written in different languages, you’d need to support libraries for each language. Service decoupling for authentication and authorization allows policies to be updated just once while affecting all clients simultaneously. This makes the mechanism language independent.

Looking at the standards built on top of OAuth 2.0 and OpenID Connect that solve such problems, User-Managed Access (UMA) and XACML are the first that come to mind. The purpose of UMA, in its specification, is defined as:

To enable a resource owner to control the authorization of data sharing and other protected-resource access made between online services on the owner's behalf or with the owner's authorization by an autonomous requesting party.

UMA doesn’t define the policy format but instead defines the communication mechanism. The benefit of having UMA in place is that it’s compatible with OAuth 2.0. However, a combination of regular OAuth Authorization Grant Flow with UMA is complicated. Neither “OAuth dance” nor “UMA dance” are easy. Try to look at the diagrams of Full UMA Flow. If you’re not familiar with it, it might be a pain for you to implement or even use.

Implementing XACML and storing it is also a complicated task. Regular XACML policy looks similar to this one:


<xacml-ctx:Request ReturnPolicyIdList="true" CombinedDecision="false" xmlns:xacml-ctx="urn:oasis:names:tc:xacml:3.0:core:schema:wd-17">
   <xacml-ctx:Attributes Category="urn:oasis:names:tc:xacml:3.0:attribute-category:action" >
      <xacml-ctx:Attribute AttributeId="actionId" IncludeInResult="true">
         <xacml-ctx:AttributeValue DataType="http://www.w3.org/2001/XMLSchema#string">view</xacml-ctx:AttributeValue>
      </xacml-ctx:Attribute>
   </xacml-ctx:Attributes>
   <xacml-ctx:Attributes Category="urn:oasis:names:tc:xacml:3.0:attribute-category:resource" >
      <xacml-ctx:Attribute AttributeId="resource-id" IncludeInResult="true">
         <xacml-ctx:AttributeValue DataType="http://www.w3.org/2001/XMLSchema#string">doc#123</xacml-ctx:AttributeValue>
      </xacml-ctx:Attribute>
   </xacml-ctx:Attributes>
   <xacml-ctx:Attributes Category="urn:oasis:names:tc:xacml:1.0:subject-category:access-subject" >
      <xacml-ctx:Attribute AttributeId="user.identifier" IncludeInResult="true">
         <xacml-ctx:AttributeValue DataType="http://www.w3.org/2001/XMLSchema#string">Alice</xacml-ctx:AttributeValue>
      </xacml-ctx:Attribute>
   </xacml-ctx:Attributes>
</xacml-ctx:Request>

As you can see, XACML is verbose and even JSON profile doesn’t help much.

With all the issues described above, the main problem is that UMA and XACML need to be supported by many implementations of authorization servers, or the implementation isn't complete. Unfortunately, these solutions are rarely supported by the number of authorization servers required, and building these types of solutions on your own is complicated.

Another problem is the barrier to entry for engineers who aren’t familiar with authentication and authorization. What if you just wanted to build simple microservice architectures and need to evaluate permissions like “Does Alice have access to read document #123?” There would be a significant amount of knowledge you’d need to write even a simple policy like the one above.

Luckily, there are other solutions to this problem.

Don't miss the next Developer Office Hours with our CTO

Join Us

How can we do it better?

In recent years, Service Mesh architecture became popular and is often used alongside Kubernetes. Service Mesh defines the concept of a sidecar, which is a proxy or a small service sitting in front of your service. What if, as a developer, I could simply put a sidecar in front of my service for user authorization?

Access-control-sidecar-2

This looks like a much more scalable solution, which could be applied across multiple services. It would also be fast, without any long network calls, because of the type of deployment. Another benefit of this method of authentication and authorization is that the access control sidecar encapsulates all complex evaluation logic. Development of access control technology can be separated from the service and is very useful in engineering team structure: a team that manages identities and access (IAM) can work on developing a sidecar while another team can work on the business logic of the service.

Building such a sidecar on your own would take quite some time, as you’d need to define the right architecture, code it, and make it production-ready. However, there’s a ready-to-use product on the market already,
, called Open Policy Agent (OPA). It’s open source, small, and fast in performance because of in-memory storage.

With OPA you can declare your policy file in a Rego language, which would look like this:


package httpapi.authz

default allow = false

# is Alice allowed to read document with id 123
allow {
 input.method = "GET"
 input.path = ["document", "123"]
 input.user = "Alice"
}

Writing a policy for each user in the system would be too cumbersome. That’s why the concept of data exists in OPA. Data is a simple JSON file that can be read by the policy. Here is example of documents.json:

[
  {
    "id": "123",
    "users": [
    	{
    		"id" : "Alice",
    		"permission" : "read"
    	}
    ]
  },
  ...
]

A more generic case policy would look similar to this one:


package httpapi.authz

import input as http_api
import documents

default allow = false

allow {
  http_api.method = "GET"
  http_api.path = ["document", document_id]
  document = documents[_]
  document_user = document.users[_]

  # is user allowed to read document with document_id
  document.id = document_id
  document_user.id = http_api.user
  document_user.permission = "read"
}

As you can see, this API gateway and JSON web token combination already looks more readable than XACML. The only learning curve here would be to understand how to write policies in Rego. Reading the documentation for 10-20 minutes should give you enough understanding to write simple policy files.

Service side implementation for this is also efficient. Policy evaluation on service results in a simple HTTP call with allow/deny response:


curl -X POST -d '{"input":{"user": "Alice", "path": ["document", "123"], "method": "GET"}}' localhost:8181/data/httpapi/authz

{
  "result": {
    "allow": true
  }
}

This can be coded as HTTP filter, which would evaluate each request to the service.

Microservices authentication and authorization for strong security patterns

Solving a resource permissions problem is not easy in regards to microservices security. Existing standardized protocols built on top of OAuth 2.0 (such as User-Managed Access) are complicated, can be verbose (such as XACML), and there are not many production-ready solutions for them.

Having access control sidecars scale well in the distributed environment and simplify usage by separating access control logic on a deployment level.

This approach can be used with Open Policy Agent (OPA), which provides everything needed. Policies are less verbose compared to XACML, and the application developer shouldn’t focus on sophisticated access control logic.

Still, there are more open questions to be asked about microservice architectures and security design patterns, such as:

  • Where should you store and manage data files?
  • How would this scenario work and eventually be consistent if there are multiple services with the same data source?
  • Where should you store and manage policy files?
  • What needs to be changed in the code or the deployment of service itself?

Stay tuned for updates on the Very Good Security Blog.

Yuriy Yunikov Yuriy Yunikov

Engineering Manager at VGS

Share

You Might also be interested in...

data-security-default

Prevent a Million Dollar Data Breach with VGS in 10 Minutes

Fang Pen April 2, 2019

engineering-default

How to securely capture your users’ sensitive data with VGS Collect

Irina Ziakhor February 4, 2019

data-security-default

Preserve Privacy, Promote Progress: The New Data Paradigm

Marshall Jones December 16, 2018