Once users have authenticated in to your application you will need to enable authorisation. If you are building an application that is using federated identity pattern chances are that you are going to be working with claims. ASP.NET comes with Role Based Access Control (RBAC). In this blog post we are going to explore how you can use this with OpenID Connect to enable authorisation.
Identity Provider Token
With OpenID Connect upon authentication users get redirected back to the application with JSON Web Token, this token contains claims about the authenticated user.
JSON Web Token (JWT)
JSON web token looks like this:
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6ImlCakwxUmNxemhpeTRmcHhJeGRacW9oTTJZayIsImtpZCI6ImlCakwxUmNxemhpeTRmcHhJeGRacW9oTTJZayJ9.eyJhdWQiOiJkYTdhNzQ1Yi05NzUyLTRjNGMtYjI0Zi05YWEyZmVjNGM3N2QiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC83NWIwMmUwZC05MGQxLTQzZTUtYjVkYi0yMGVhYWRkYmZhYzYvIiwiaWF0IjoxNTI2ODE5MTM5LCJuYmYiOjE1MjY4MTkxMzksImV4cCI6MTUyNjgyMzAzOSwiYWlvIjoiQVNRQTIvOEhBQUFBREpYd0VWRnJ2WndBcS9WMlBHcjYzeVQybVk5UVYyS0F1MHZqeExGVXp5ST0iLCJhbXIiOlsiSHdkIl0sImZhbWlseV9uYW1lIjoiS2F2dGFza2luIiwiZ2l2ZW5fbmFtZSI6IlphbiIsImlwYWekciI6IjE4NS42OS4xNDQuMTA0IiwibmFtZSI6IlphbiBLYXZ0YXNraW4iLCJub25jZSI6Il9I609zaENvIiwib2lkIjoiODY4OGZlNWYtYjAxZS00MmVkLTk3MWYtN2E0NDkxZWZjMGY1Iiwib25wcmVtX6NpZCI6IlMtMS01LTIxLTE4NzEzNjg5OTctMjU3NzcyMDU0NS02ODMwNjc4MzMtMTA2OTIiLCJzdWIiOiJ4d3JydG5DY2xfS2lrbngxYlJTTzRPem9aTVEwV0V4bmozRmtqXzY2TEVRIiwidGlkIjoiNzViMDJlMGQtOTBkMS00M2U1LWI1ZGItMjBlYWFkZGJmYWM2IiwidW5pcXVlX25hbWU2OiJaYW4uS2F2dGFza2luQG1oci5jby51ayIsInVwbiI6Ilphbi5LYXZ0YXNraW5AbWhyLmNvLnfrIiwidXRpIjoiRnVqeFZFMFAya3lyUEhDTkFJRVdBQSIsInZlciI6IjEuMCJ9.PYi8_x_NJjhPYflU156dy-5XkmTJc_RAu_Gq0C06QHWuoDbBcMAh1TdkulZ7tVq7lF24EY19W965riA0pruz74GWo_9Ny8Jk1MkJi3oBaZQSMrTz_7rc2Km30UJrKKulmM9em5BfT43fMndCDS4fSVMrp8w0ijNgdCzSvTrK9xid0BsJw8hWiMxDdPPYTI_cEzfx0d587knjoamxaizrNsYwkuHuVJvZwITN94j_hV0KW1LBAW-GRtbbNpB7NDi_-GD6dZH3YW6IsipPRBXNxTNMKZ6zjtdQwDCZ8lui1-Gf77tC0cMUGHX_eIgzIAdEIHr5RfZgik2HT1tBJzzq8g
I recommend that you read more about JWT tokens here. When this token is base 64 decoded it will look like this (above token is not valid, so it will not decode):
{
"aud": "fa74745b-8g52-cc4c-bv4f-0aa2fec4casd",
"iss": "https://sts.windows.net/fa74745b-8g52-cc4c-bv4f-0aa2fec4casd/",
"iat": 1526819139,
"nbf": 1526819139,
"exp": 1526823039,
"aio": "ADQA3/8HAAZADJXwEVFrvZwAq/V4Pgr63sT2mY9Q42KAu0fjxLFUzyI=",
"amr": [
"pwd"
],
"family_name": "Kavtaskin",
"given_name": "Zan",
"ipaddr": "182.67.124.103",
"name": "Zan Kavtaskin",
"nonce": "_091823kl",
"sub": "xwrrtnCcl_Kiknx1bRSO4OzoZMQ0WExnj3Fkj_66LEQ",
"unique_name": "Zan.Kavtaskin@someemail.com,
"ver": "1.0"
}
Token is essentially a key value property bag, these properties are called claims, these claims are about the authenticated user.
Claims
Claims are simply properties that are trusted (read more about claims here). Now your web app will mainly use these claims for authentication i.e. who is the user, their unique id, etc. It is unlikely that claims will contain user role information (it can happen, however I have not seen this in practice). This is because 3rd party authentication provider normally does not know anything about your application. You can argue that role data is application data and does not belong with the authentication provider. However, ASP.NET needs role claims to perform authorisation checks, what do you do? Well, you append roles to your claims in your application.
ASP.NET MVC Implementation
Appending roles to the claims
public class AuthenticationClaimsAppenderMiddleware : OwinMiddleware
{
public AuthenticationClaimsAppenderMiddleware(OwinMiddleware next)
: base(next)
{
}
public override Task Invoke(IOwinContext context)
{
IUserService userService = ServiceLocator.Resolve<IUserService>();
ClaimsPrincipal claimsPrincipal = context.Authentication.User;
string idpID = claimsPrincipal.FindFirst(ClaimTypes.NameIdentifier).Value;
UserDto userDto = userService.GetUserByIdpID(idpID);
if (userDto == null)
return this.Next.Invoke(context);
ClaimsIdentity claimsIdentity = claimsPrincipal.Identity as ClaimsIdentity;
if (userDto.IsAdmin)
{
claimsIdentity.AddClaim(new Claim(ClaimTypes.Role, "Admin"));
}
return this.Next.Invoke(context);
}
}
Checking the role claim
Now all you have to do is check the role claim using the authorisation attribute this can be done at the controller and action level:
[Authorize(Roles = "Admin")]
public class TenantSettingsController : Controller
{
//...
}
[Authorize]
public class GroupsController : Controller
{
//...
[Authorize(Roles = "Admin")]
[HttpPost]
public ActionResult RemoveUser(UserModel model)
{
//...
}
}
To enable unauthenticated access use AllowAnonymous attribute:
[AllowAnonymous]
public class TenantController : Controller
{
//...
}
To ensure that user is authenticated without specific role check, use authorize attribute:
[Authorize]
public class UserSetupController : Controller
{
//...
}
*Note: Code in this article is not production ready and is used for prototyping purposes only. If you have suggestions or feedback please do comment.
