Skip to content
This repository was archived by the owner on Jan 23, 2020. It is now read-only.

Commit c68f0b7

Browse files
acomsmpbotacomsmpbot
committed
Updating repository initial files.
1 parent bae98d1 commit c68f0b7

File tree

1 file changed

+10
-181
lines changed

1 file changed

+10
-181
lines changed

‎README.md

Lines changed: 10 additions & 181 deletions
Original file line numberDiff line numberDiff line change
@@ -1,181 +1,10 @@
1-
---
2-
services: active-directory
3-
platforms: dotnet
4-
author: dstrockis
5-
---
6-
7-
# Calling a web API in an ASP.NET 5 web application using Azure AD
8-
This sample shows how to build an MVC web application that uses Azure AD for sign-in using the OpenID Connect protocol, and then calls a web API under the signed-in user's identity using tokens obtained via OAuth 2.0. This sample uses the OpenID Connect ASP.Net OWIN middleware and ADAL .Net running on ASP.NET 5.
9-
10-
For more information about how the protocols work in this scenario and other scenarios, see [Authentication Scenarios for Azure AD](http://go.microsoft.com/fwlink/?LinkId=394414).
11-
12-
## How To Run This Sample
13-
14-
To run this sample you will need:
15-
- [Visual Studio 2015](https://www.visualstudio.com/downloads/download-visual-studio-vs)
16-
- An Internet connection
17-
- An Azure subscription (a free trial is sufficient)
18-
19-
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 [https://azure.microsoft.com](https://azure.microsoft.com). All of the Azure AD features used by this sample are available free of charge.
20-
21-
### Step 1: Clone or download this repository
22-
23-
From your shell or command line:
24-
25-
`git clone https://github.com/Azure-Samples/active-directory-dotnet-webapp-webapi-openidconnect-aspnet5.git`
26-
27-
### Step 2: Create a user account in your Azure Active Directory tenant
28-
29-
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.
30-
31-
### Step 3: Register the sample with your Azure Active Directory tenant
32-
33-
There are two projects in this sample. Each needs to be separately registered in your Azure AD tenant.
34-
35-
#### Register the TodoListService web API
36-
37-
1. Sign in to the [Azure management portal](https://manage.windowsazure.com).
38-
2. Click on Active Directory in the left hand nav.
39-
3. Click the directory tenant where you wish to register the sample application.
40-
4. Click the Applications tab.
41-
5. In the drawer, click Add.
42-
6. Click "Add an application my organization is developing".
43-
7. Enter a friendly name for the application, for example "TodoListService", select "Web Application and/or Web API", and click next.
44-
8. For the sign-on URL, enter the base URL for the sample, which is by default `https://localhost:44321`.
45-
9. 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.
46-
10. While still in the Azure portal, click the Configure tab of your application.
47-
11. Find the Client ID value and copy it aside, you will need this later when configuring your application.
48-
49-
#### Register the TodoListWebApp web application
50-
51-
1. Sign in to the [Azure management portal](https://manage.windowsazure.com).
52-
2. Click on Active Directory in the left hand nav.
53-
3. Click the directory tenant where you wish to register the sample application.
54-
4. Click the Applications tab.
55-
5. In the drawer, click Add.
56-
6. Click "Add an application my organization is developing".
57-
7. Enter a friendly name for the application, for example "TodoListWebApp", select "Web Application and/or Web API", and click next.
58-
8. For the sign-on URL, enter the base URL for the sample, which is by default `https://localhost:44322/`. NOTE: It is important, due to the way Azure AD matches URLs, to ensure there is a trailing slash on the end of this URL. If you don't include the trailing slash, you will receive an error when the application attempts to redeem an authorization code.
59-
9. For the App ID URI, enter `https://<your_tenant_name>/TodoListWebApp`, replacing `<your_tenant_name>` with the name of your Azure AD tenant. Click OK to complete the registration.
60-
10. While still in the Azure portal, click the Configure tab of your application.
61-
11. Find the Client ID value and copy it aside, you will need this later when configuring your application.
62-
12. Create a new key for the application. Save the configuration so you can view the key value. Save this aside for when you configure the project in Visual Studio.
63-
13. In "Permissions to Other Applications", click "Add Application." Select "Other" in the "Show" dropdown, and click the upper check mark. Locate & click on the TodoListService, and click the bottom check mark to add the application. Select "Access TodoListService" from the "Delegated Permissions" dropdown, and save the configuration.
64-
65-
### Step 4: Configure the sample to use your Azure AD tenant
66-
67-
#### Configure the TodoListService project
68-
69-
1. Open the solution in Visual Studio 2015.
70-
2. Open the `config.json` file.
71-
3. Find the `Tenant` property and replace the value with your AAD tenant name, e.g. contoso.onmicrosoft.com.
72-
4. Find the app key `Audience` and replace the value with the App ID URI you registered earlier, for example `https://<your_tenant_name>/TodoListService`.
73-
74-
#### Configure the TodoListWebApp project
75-
76-
1. Open the solution in Visual Studio 2015.
77-
2. Open the `config.json` file.
78-
3. Find the `Tenant` property and replace the value with your AAD tenant name, e.g. contoso.onmicrosoft.com.
79-
4. Find the `ClientId` property and replace the value with the Client ID for the TodoListWebApp from the Azure portal.
80-
5. Find the `AppKey` and replace the value with the key for the TodoListWebApp from the Azure portal.
81-
6. If you changed the base URL of the TodoListWebApp sample, find the `PostLogoutRedirectUri` property and replace the value with the new base URL of the sample.
82-
7. Find the property `TodoListBaseAddress` and make sure it has the correct value for the address of the TodoListService project.
83-
8. Find the `TodoListResourceId` property and replace the value with the App ID URI registered for the TodoListService, for example `https://<your_tenant_name>/TodoListService`.
84-
85-
### Step 5: Trust the IIS Express SSL certificate
86-
87-
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:
88-
89-
"The underlying connection was closed: Could not establish trust relationship for the SSL/TLS secure channel."
90-
91-
To configure your computer to trust the IIS Express SSL certificate, begin by opening a Windows Powershell command window as Administrator.
92-
93-
Query your personal certificate store to find the thumbprint of the certificate for `CN=localhost`:
94-
95-
```
96-
PS C:\windows\system32> dir Cert:\LocalMachine\My
97-
98-
99-
Directory: Microsoft.PowerShell.Security\Certificate::LocalMachine\My
100-
101-
102-
Thumbprint Subject
103-
---------- -------
104-
C24798908DA71693C1053F42A462327543B38042 CN=localhost
105-
```
106-
107-
Next, add the certificate to the Trusted Root store:
108-
109-
```
110-
PS C:\windows\system32> $cert = (get-item cert:\LocalMachine\My\C24798908DA71693C1053F42A462327543B38042)
111-
PS C:\windows\system32> $store = (get-item cert:\Localmachine\Root)
112-
PS C:\windows\system32> $store.Open("ReadWrite")
113-
PS C:\windows\system32> $store.Add($cert)
114-
PS C:\windows\system32> $store.Close()
115-
```
116-
117-
You can verify the certificate is in the Trusted Root store by running this command:
118-
119-
`PS C:\windows\system32> dir Cert:\LocalMachine\Root`
120-
121-
### Step 6: Run the sample
122-
123-
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.
124-
125-
Explore the sample by signing in, To Do List link, adding items to the To Do list, signing out, and starting again.
126-
127-
## How To Deploy This Sample to Azure
128-
129-
Coming soon.
130-
131-
## About The Code
132-
133-
Coming soon.
134-
135-
## How To Recreate This Sample
136-
137-
First, in Visual Studio 2015 create an empty solution to host the projects. Then, follow these steps to create each project.
138-
139-
### Creating the TodoListService Project
140-
141-
1. In the solution, create a new "ASP.NET 5 MVC Web API" project called TodoListService.
142-
2. Enable SSL on the project by following the steps outlined in the below section.
143-
2. Add the `Microsoft.AspNet.Security.OAuthBearer` and `Microsoft.Framework.ConfigurationModel.Json` NuGets to the project.
144-
2. Create a new `Models` folder, and add a new class to it called `TodoItem.cs`. Copy the implementation of TodoItem from this sample into the class.
145-
3. Delete the existing `ValuesController.cs`, and add a new Web API controller class called `TodoListController`.
146-
4. Copy the implementation of the TodoListController from this sample into the controller. Don't forget to add the `[Authorize]` attribute to the class.
147-
5. In `TodoListController` resolving missing references by adding `using` statements for `System.Collections.Concurrent`, `TodoListService.Models`, `System.Security.Claims`.
148-
6. Add a new ASP.NET Configuration File called `config.json` to the project. Replace its contents with those of the sample.
149-
7. Replace the implementation of `Startup.cs` with that of the sample, resolving any missing references such as `Microsoft.Framework.ConfigurationModel`.
150-
151-
### Creating the TodoListWebApp Project
152-
153-
1. In Visual Studio 2015 CTP6, create a new "ASP.NET 5 Preview Starter Web" application.
154-
2. Enable SSL for the application by following the steps in section at the bottom of this page.
155-
5. Add the `Microsoft.AspNet.Security.OpenIdConnect` ASP.Net OWIN middleware NuGet to the project. Remember to enable prerelease versions in the NuGet package manager. Also add the prerelease version of `Microsoft.AspNet.Session` to the project.
156-
5. Remove a few excess files that come with the template - they are not needed for this sample. Delete the `Migrations` folder, the `Views/Account` folder, the `Models` folder, and the `Compiler` folder.
157-
6. Replace the implementation of the `Controllers\AccountController.cs` class with the one from the project, resolving any excess or missing using statements.
158-
6. In `Views\Shared`, replace the implementation of `_LoginPartial.cshtml` and `_Layout.cshtml` with the ones from the sample.
159-
7. Replace the contents of `config.json` with the one from the sample.
160-
6. Replace the contents of `Startup.cs` with the one from the sample, resolving any excess or missing using statements. Note that you need to change the class to a `partial` class so you can implement the `ConfigureAuth` method.
161-
7. Create a new folder in the project called `App_Start`, and within it create the `Startup.Auth.cs` class. Again, make sure it's a partial class and copy in the code from the sample. This is where the identity related configuration code occurs.
162-
8. Add a `Models` folder to the project, and create the `TodoItem.cs` class in it. Copy its simple implementation from the sample.
163-
9. Add a `Utils` folder to the project, and create a new class inside it called `NaiveSessionCache.cs`. The `NaiveSessionCache` extends the ADAL token cache, and is used here to store tokens in session storage.
164-
7. Add a new controller to the project, the `TodoListController.cs`. Also create a corresponding `TodoList` view. Copy the implementations in from the sample. Note the use of the `[Authorize]` tag on the `TodoListController` class, to enforce authentication on the methods in this class.
165-
13. Almost done! Follow the steps in "How To Run This Sample" above to register the application in your AAD tenant.
166-
167-
### Enable SSL in Visual Studio 2015 CTP6
168-
These steps are temporarily necessary to enable SSL only for Visual Studio 2015 CTP6: First, hit F5 to run the application. Once you see the homepage, you may close the browser and stop IIS Express. In a text editor, open the file `%userprofile%\documents\IISExpress\config\applicatoinhost.confg`. Find the entry for your app in the `<sites>` node. Add an https protocol binding to this entry for a port between 44300 and 44399, similar to the following:
169-
170-
```
171-
<site name="WebApplication1" id="2">
172-
<application path="/" applicationPool="Clr4IntegratedAppPool">
173-
<virtualDirectory path="/" physicalPath="c:\users\billhie\documents\visual studio 2015\Projects\WebApplication1\WebApplication1" />
174-
</application>
175-
<bindings>
176-
<binding protocol="http" bindingInformation="*:53756:localhost" />
177-
<binding protocol="https" bindingInformation="*:44300:localhost" />
178-
</bindings>
179-
</site>
180-
```
181-
Save and close the file. In Visual Studio, open the properties page of your web app. In the Debug menu, enable the Launch Browser checkbox and enter the same URL as the protocol binding you added, e.g. `https://localhost:44300/`. Your app will now run at this address.
1+
# active-directory-dotnet-webapp-webapi-openidconnect-aspnet5
2+
An ASP.NET 5 web application that authenticates Azure AD users and calls a web API using OAuth 2.0 access tokens.
3+
## Running this sample
4+
Coming soon...
5+
## Deploy this sample to Azure
6+
Coming soon...
7+
## About the code
8+
Coming soon...
9+
## More information
10+
Coming soon...

0 commit comments

Comments
 (0)