azure-ad-auth-in-kentico

KO | EN

gitlite — search

#javascript #game #python #golang #library #animation #epub #css #cli #java #php #hacktoberfest

azure-ad-auth-in-kentico

★ 16 Open GitHub ↗

Azure AD authentication in Kentico

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/kate-orlova/azure-ad-auth-in-kentico)
[![GitHub release](https://img.shields.io/github/release-date/kate-orlova/azure-ad-auth-in-kentico.svg?style=flat)](https://github.com/kate-orlova/azure-ad-auth-in-kentico/releases/tag/MVPRelease)
[![GitHub license](https://img.shields.io/github/license/kate-orlova/azure-ad-auth-in-kentico.svg)](https://github.com/kate-orlova/azure-ad-auth-in-kentico/blob/master/LICENSE)
![GitHub language count](https://img.shields.io/github/languages/count/kate-orlova/azure-ad-auth-in-kentico.svg?style=flat)
![GitHub top language](https://img.shields.io/github/languages/top/kate-orlova/azure-ad-auth-in-kentico.svg?style=flat)
![GitHub repo size](https://img.shields.io/github/repo-size/kate-orlova/azure-ad-auth-in-kentico.svg?style=flat)
![GitHub contributors](https://img.shields.io/github/contributors/kate-orlova/azure-ad-auth-in-kentico)

# Azure AD authentication in Kentico
Azure Active Directory (AD) authentication in Kentico project implements an Azure AD identity provider for Kentico 10, 11 and 12 to verify user accounts existing in a business directory and issue security tokens upon successful authentication of those users.

The following diagram demonstrates the login process flow
![Sign in process flow](https://raw.githubusercontent.com/kate-orlova/azure-ad-auth-in-kentico/master/assets/sign_in_flow.png)

Prior to start integrating make sure that a Kentico application planning to outsource an authentication to Azure AD is registered in Azure AD first. Azure AD registers and uniquely identifies an application in its directory. This solution supports the definition of registration parameters in Kentico Settings at a website / global level, the key configuration fields are
 * Client Id
 * Application Key
 * Tenant Id
 * Azure Groups to sync
 
The below screnshots will guide you where to find the required Azure AD settings:
![Azure application overview](https://raw.githubusercontent.com/kate-orlova/azure-ad-auth-in-kentico/master/assets/azure_app.png)

![Azure application keys](https://raw.githubusercontent.com/kate-orlova/azure-ad-auth-in-kentico/master/assets/azure_app_key.png)

It is also important to enable access for your application as follows:  
![Azure application permissions](https://raw.githubusercontent.com/kate-orlova/azure-ad-auth-in-kentico/master/assets/azure_app_permissions.png)

The module comes with two user controls for Login and Logout functionality, and a proxy script (_/pages/AzureAuthRedirect.aspx_) implementing the integration routine. So, that you can adapt the user interface for your needs easily.

Another thing to check in Settings is that you have specified a login page for users in front-end, go to _"Settings -> Security & Membership -> Content"_ and set a _"Website logon page URL"_ field to your login page with the placed Login control on it.
![Login page URL](https://raw.githubusercontent.com/kate-orlova/azure-ad-auth-in-kentico/master/assets/login_page.png)

How to secure a page on your Kentico website?
1. Select a page you wish to put behind the login
1. Go to _Page Properties -> Security_ tab
1. Select the required user roles to restrict access to the page in _"Users and Roles"_ field under _Permissions_ section
1. Specify access rights in _"Access rights"_ table
1. Set a _"Requires authentication"_ to "Yes" under _Access_ section

# Installation steps
1. Import a relevant Kentico module package for your CMS version:
   1. Kentico 10: _Kentico10\AzureADAuthenticationModule_K10.zip_
   1. Kentico 11: _Kentico11\AzureADAuthenticationModule_K11.zip_
   1. Kentico 12: _Kentico12\AzureADAuthenticationModule_K12.zip_

Go to _Sites > Import site or objects > Upload_ and select a package. Tick off an _"Import code files"_ checkbox during import.

2. Include the imported code files into your project in Visual Studio:
   1. _CMSGlobalFiles\AzureADAuthentication\AzureADAuthenticationHandler.cs_
   1. _CMSModules\AzureADAuthentication\AzureADAuthenticationModule.cs_
   1. _CMSModules\AzureADAuthentication\AzureADAuthenticationSettings.cs_
   1. _CMSWebParts\AzureADAuthentication\Login.ascx_
   1. _CMSWebParts\AzureADAuthentication\Login.ascx.cs_
   1. _CMSWebParts\AzureADAuthentication\Login.ascx.designer.cs_
   1. _CMSWebParts\AzureADAuthentication\Logout.ascx_
   1. _CMSWebParts\AzureADAuthentication\Logout.ascx.cs_
   1. _CMSWebParts\AzureADAuthentication\Logout.ascx.designer.cs_

3. Install the following Nuget packages into your solution:
   1. `Install-Package Microsoft.Azure.ActiveDirectory.GraphClient`
   1. `Install-Package Microsoft.IdentityModel.Clients.ActiveDirectory`

4. Register the following handler in `web.config`:

`<add name ="AzureADAuthenticationHandler" verb="*" path="AzureADAuthentication.axd" type="AzureADAuthentication.Handlers.AzureADAuthenticationHandler" />`

5. Rebuild your solution and open Kentico CMS Admin area

6. Fill in the following settings in _Settings > Security & Membership > Authentication > Azure AD_:
   1. _Client ID_
   1. _Tenant ID_
   1. _Application Key_
   1. _Authentication Redirect Page_
   
7. Make sure that your Kentico application is registered in Azure AD; note that the redirect URL has to be the full URL including the protocol and port, for example, _http://localhost/AzureADAuthentication.axd_ or _http://localhost/Kentico11/AzureADAuthentication.axd_

The below is an Azure admin interface where you can register your redirect URLs
   ![Azure Admin interface for redirects](https://raw.githubusercontent.com/kate-orlova/azure-ad-auth-in-kentico/master/assets/azure_admin_interface_for_redirect_URLs.png)
   
8. Add an _"Azure AD Login"_ webpart to a page you want to secure and then try to browse it in front-end and login!

# Test Data
## General application settings
For testing purpose you can use the following test details:
1. Client ID: _f25b409a-888a-47bc-94cf-c1d27ac9ad57_
1. Tenant ID: _20235006-a5ce-40f9-a061-cd97b588de50_
1. Application Key: _q7mX1-q[+LetIB42cAY.nsp8e4q[K452_

## Registered redirect URLs
The following Redirect URLs are registered:
1. http://localhost/AzureADAuthentication.axd
1. http://localhost/Kentico12_2/AzureADAuthentication.axd
1. http://localhost/Kentico10/AzureADAuthentication.axd
1. http://localhost/Kentico11/AzureADAuthentication.axd

## Test user
Username: _test@testdancinggoat.onmicrosoft.com_
Group: _Test Group_
Password: _Sxqp5t*9GD7E_

# Configuration Guide
1. Make sure that your Kentico application is registered in Azure AD;
1. Include AzureADAuthInKentico project into your Kentico solution;
1. Restore Nuget packages for AzureADAuthInKentico project;
1. Check Kentico references in AzureADAuthInKentico project (the ones pointing to /lib/ folder) and make sure that you use your Kentico assemblies;
1. Define Azure AD registration parameters in Kentico Settings at a website / global level: _Client Id, Application Key, Tenant Id, Azure Groups to sync_ (see above about where to find them);
1. Build and run;
1. Now you are ready to secure your Kentico pages and use Azure AD accounts to access them:
   - Specify a login page for users in front-end, go to _"Settings -> Security & Membership -> Content"_ and set a _"Website logon page URL"_ field to your login page with the placed Login control on it;
   - Secure a page you want to be behind login (_see the "How to secure a page on your Kentico website?" section above_).
   
That is all, enjoy!

# Contribution
Hope you found the above solution helpful, your contributions and suggestions will be very much appreciated. Please submit a pull request with your code enhancements.

# License
The Azure AD authentication in Kentico module is released under the MIT license what means that you can modify and use it how you want even for commercial use. Please give it a star if you like it and your experience was positive.

azure-ad-auth-in-kentico

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README