NativeClient-WindowsStore
This sample demonstrates a Windows Store application calling a web API that is secured using Azure AD. The Windows Store application uses the Active Directory Authentication Library (ADAL) to obtain a JWT access token through the OAuth 2.0 protocol. The access token is sent to the web API to authenticate the user.
For more information about how the protocols work in this scenario and other scenarios, see Authentication Scenarios for Azure AD.
How To Run This Sample
To run this sample you will need:
- Visual Studio 2013
- Windows 8.1 or higher
- An Internet connection
- An Azure subscription (a free trial is sufficient)
- A Microsoft account
Every Azure subscription has an associated Azure Active Directory tenant. If you don't already have an Azure subscription, you can get a free subscription by signing up at http://wwww.windowsazure.com. All of the Azure AD features used by this sample are available free of charge.
Step 1: Clone or download this repository
From your shell or command line:
git clone git@github.com:AzureADSamples/NativeClient-WindowsStore.git
Step 2: Create a user account in your Azure Active Directory tenant
If you already have a user account in your Azure Active Directory tenant, you can skip to the next step. This sample will not work with a Microsoft account, so if you signed in to the Azure portal with a Microsoft account and have never created a user account in your directory before, you need to do that now. If you create an account and want to use it to sign-in to the Azure portal, don't forget to add the user account as a co-administrator of your Azure subscription.
Step 3: Register the sample with your Azure Active Directory tenant
There are two projects in this sample. Each needs to be separately registered in your Azure AD tenant.
Register the TodoListService web API
- Sign in to the Azure management portal.
- Click on Active Directory in the left hand nav.
- Click the directory tenant where you wish to register the sample application.
- Click the Applications tab.
- In the drawer, click Add.
- Click "Add an application my organization is developing".
- Enter a friendly name for the application, for example "TodoListService", select "Web Application and/or Web API", and click next.
- For the sign-on URL, enter the base URL for the sample, which is by default
https://localhost:44321. - For the App ID URI, enter
https://<your_tenant_name>/TodoListService, replacing<your_tenant_name>with the name of your Azure AD tenant. Click OK to complete the registration. - While still in the Azure portal, click the Configure tab of your application.
- Find the Client ID value and copy it aside, you will need this later when configuring your application.
- Using the Manage Manifest button in the drawer, download the manifest file for the application.
- Add a permission to the application by replacing the appPermissions section with the block of JSON below. You will need to create a new GUID and replace the example permissionId GUID.
- Using the Manage Manfiest button, upload the updated manifest file. Save the configuration of the app.
"appPermissions": [
{
"claimValue": "user_impersonation",
"description": "Allow full access to the To Do List service on behalf of the signed-in user",
"directAccessGrantTypes": [],
"displayName": "Have full access to the To Do List service",
"impersonationAccessGrantTypes": [
{
"impersonated": "User",
"impersonator": "Application"
}
],
"isDisabled": false,
"origin": "Application",
"permissionId": "b69ee3c9-c40d-4f2a-ac80-961cd1534e40",
"resourceScopeType": "Personal",
"userConsentDescription": "Allow full access to the To Do service on your behalf",
"userConsentDisplayName": "Have full access to the To Do service"
}
],Find the TodoListClient app's redirect URI
Before you can register the TodoListClient application in the Azure portal, you need to find out the application's redirect URI. Windows 8 provides each application with a unique URI and ensures that messages sent to that URI are only sent to that application. To determine the redirect URI for your project:
- Open the solution in Visual Studio 2013.
- In the TodoListClient project, open the
MainPage.xaml.csfile. - Find this line of code and set a breakpoint on it.
Uri redirectURI = Windows.Security.Authentication.Web.WebAuthenticationBroker.GetCurrentApplicationCallbackUri();- Right-click on the TodoListClient project and Debug --> Start New Instance.
- When the breakpoint is hit, use the debugger to determine the value of redirectURI, and copy it aside for the next step.
- Stop debugging, and clear the breakpoint.
The redirectURI value will look something like this:
ms-app://s-1-15-2-2123189467-1366327299-2057240504-936110431-2588729968-1454536261-950042884/
Register the TodoListClient app
- Sign in to the Azure management portal.
- Click on Active Directory in the left hand nav.
- Click the directory tenant where you wish to register the sample application.
- Click the Applications tab.
- In the drawer, click Add.
- Click "Add an application my organization is developing".
- Enter a friendly name for the application, for example "TodoListClient-WindowsStore", select "Native Client Application", and click next.
- Enter the Redirect URI value that you obtained during the previous step. Click finish.
- Click the Configure tab of the application.
- Find the Client ID value and copy it aside, you will need this later when configuring your application.
- In "Permissions to Other Applications", select the TodoListService, and request the delegated permission "Have full access to the To Do List service". Save the configuration.
Step 4: Configure the sample to use your Azure AD tenant
Configure the TodoListService project
- Open the solution in Visual Studio 2013.
- Open the
web.configfile. - Find the app key
ida:Tenantand replace the value with your AAD tenant name. - Find the app key
ida:Audienceand replace the value with the App ID URI you registered earlier, for examplehttps://<your_tenant_name>/TodoListService.
Configure the TodoListClient project
- Open `MainPage.xaml.cs'.
- Find the declaration of
tenantand replace the value with the name of your Azure AD tenant. - Find the declaration of
clientIdand replace the value with the Client ID from the Azure portal. - Find the declaration of
todoListResourceIdandtodoListBaseAddressand ensure their values are set properly for your TodoListService project.
Step 5: Trust the IIS Express SSL certificate
Since the web API is SSL protected, the client of the API (the web app) will refuse the SSL connection to the web API unless it trusts the API's SSL certificate. Use the following steps in Windows Powershell to trust the IIS Express SSL certificate. You only need to do this once. If you fail to do this step, calls to the TodoListService will always throw an unhandled exception where the inner exception message is:
"The underlying connection was closed: Could not establish trust relationship for the SSL/TLS secure channel."
To configure your computer to trust the IIS Express SSL certificate, begin by opening a Windows Powershell command window as Administrator.
Query your personal certificate store to find the thumbprint of the certificate for CN=localhost:
PS C:\windows\system32> dir Cert:\LocalMachine\My
Directory: Microsoft.PowerShell.Security\Certificate::LocalMachine\My
Thumbprint Subject
---------- -------
C24798908DA71693C1053F42A462327543B38042 CN=localhost
Next, add the certificate to the Trusted Root store:
PS C:\windows\system32> $cert = (get-item cert:\LocalMachine\My\C24798908DA71693C1053F42A462327543B38042)
PS C:\windows\system32> $store = (get-item cert:\Localmachine\Root)
PS C:\windows\system32> $store.Open("ReadWrite")
PS C:\windows\system32> $store.Add($cert)
PS C:\windows\system32> $store.Close()
You can verify the certificate is in the Trusted Root store by running this command:
PS C:\windows\system32> dir Cert:\LocalMachine\Root
Step 6 (Optional): Enable Windows Integrated Authentication when using a federated Azure AD tenant
Out of the box, this sample is not configured to work with Windows Integrated Authentication (WIA) when used with a federated Azure Active Directory domain. To work with WIA the application manifest must enable additional capabilities. These are not configured by default for this sample because applications requesting the Enterprise Authentication or Shared User Certificates capabilities require a higher level of verification to be accepted into the Windows Store, and not all developers may wish to perform the higher level of verification.
To enable Windows Integrated Authentication, in Package.appxmanifest, in the Capabilities tab, enable:
- Enterprise Authentication
- Private Networks (Client & Server)
- Shared User Certificates
Plus uncomment the following line of code:
authContext.UseCorporateNetwork = true;
Step 7: Run the sample
Clean the solution, rebuild the solution, and run it. You might want to go into the solution properties and set both projects as startup projects, with the service project starting first.
Explore the sample by signing in, adding items to the To Do list, removing the user account, and starting again. Notice that if you stop the application without removing the user account, the next time you run the application you won't be prompted to sign-in again - that is because ADAL has a persistent cache, and remembers the tokens from the previous run.
How To Deploy This Sample to Azure
To deploy the TodoListService to Azure Web Sites, you will create a web site, publish the TodoListService to the web site, and update the TodoListClient to call the web site instead of IIS Express.
Create and Publish the TodoListService to an Azure Web Site
- Sign in to the Azure management portal.
- Click on Web Sites in the left hand nav.
- Click New in the bottom left hand corner, select Compute --> Web Site --> Quick Create, select the hosting plan and region, and give your web site a name, e.g. todolistservice-contoso.azurewebsites.net. Click Create Web Site.
- Once the web site is created, click on it to manage it. For this set of steps, download the publish profile and save it. Other deployment mechanisms, such as from source control, can also be used.
- Switch to Visual Studio and go to the TodoListService project. Right click on the project in the Solution Explorer and select Publish. Click Import, and import the publish profile that you just downloaded.
- On the Connection tab, update the Destination URL so that it is https, for example https://todolistservice-skwantoso.azurewebsites.net. Click Next.
- On the Settings tab, make sure Enable Organizational Authentication is NOT selected. Click Publish.
- Visual Studio will publish the project and automatically open a browser to the URL of the project. If you see the default web page of the project, the publication was successful.
Update the Active Directory Tenant Application Registration
- Navigate to the Azure management portal.
- In your Active Directory tenant, click on the TodoListService application in the Applications tab.
- In the Configure tab, update the Sign-On URL and Reply URL fields to the address of your service, for example https://todolistservice-skwantoso.azurewebsites.net.
Update the TodoListClient to call the TodoListService Running in Azure Web Sites
- In Visual Studio, go to the TodoListClient project.
- Open
MainPage.xaml.cs. Only one change is needed - update thetodo:TodoListBaseAddresskey value to be the address of the website you published, e.g. https://todolistservice-skwantoso.azurewebsites.net. - Run the client! If you are trying multiple different client types (e.g. .Net, Windows Store, Android, iOS) you can have them all call this one published web API.
NOTE: Remember, the To Do list is stored in memory in this TodoListService sample. Azure Web Sites will spin down your web site if it is inactive, and your To Do list will get emptied. Also, if you increase the instance count of the web site, requests will be distributed among the instances and the To Do will not be the same on each instance.
About The Code
Coming soon.
How To Recreate This Sample
First, in Visual Studio 2013 create an empty solution to host the projects. Then, follow these steps to create each project.
Creating the TodoListService Project
- In the solution, create a new ASP.Net MVC web API project called TodoListService and while creating the project, click the Change Authentication button, select Organizational Accounts, Cloud - Single Organization, enter the name of your Azure AD tenant, and set the Access Level to Single Sign On. You will be prompted to sign-in to your Azure AD tenant. NOTE: You must sign-in with a user that is in the tenant; you cannot, during this step, sign-in with a Microsoft account.
- In the
Modelsfolder add a new class calledTodoItem.cs. Copy the implementation of TodoItem from this sample into the class. - Add a new, empty, Web API 2 controller called
TodoListController. - Copy the implementation of the TodoListController from this sample into the controller. Don't forget to add the
[Authorize]attribute to the class. - In
TodoListControllerresolving missing references by addingusingstatements forSystem.Collections.Concurrent,TodoListService.Models,System.Security.Claims.
Creating the TodoListClient Project
- In the solution, create a new project for a Windows Store --> Blank App (XAML) called TodoListClient.
- Add the pre-release Active Directory Authentication Library (ADAL) NuGet, Microsoft.IdentityModel.Clients.ActiveDirectory, version 2.6.0-alpha (or higher), to the project.
- Open
Package.appxmanifest, click the Capabilities tab, and enable the following capability: Internet (Client). - Copy the markup from
MainPage.xamlin the sample project toMainPage.xamlin the new project. - Copy the code from
MainPage.xaml.csin the sample project toMainPage.xaml.csin the new project.
Finally, in the properties of the solution itself, set both projects as startup projects.