Skip to content

Commit 778a402

Browse files
laura-rodriguezlaura-rodriguez
authored
Merge pull request #25 from okta/lr-update-self-hosted-to-aspnetcore-2.2
Update self-hosted sample to ASP.NET Core 2.2
2 parents 17642bb + 0425e08 commit 778a402

File tree

78 files changed

+27582
-11165
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+27582
-11165
lines changed

‎self-hosted-login/OktaMvcSamples.ruleset

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<RuleSet Name="New Rule Set" Description=" " ToolsVersion="10.0">
3+
<Rules AnalyzerId="AsyncUsageAnalyzers" RuleNamespace="AsyncUsageAnalyzers">
4+
<Rule Id="AvoidAsyncSuffix" Action="Error" />
5+
<Rule Id="AvoidAsyncVoid" Action="Error" />
6+
<Rule Id="UseAsyncSuffix" Action="Error" />
7+
<Rule Id="UseConfigureAwait" Action="Error" />
8+
</Rules>
9+
10+
<Rules AnalyzerId="Microsoft.Analyzers.ManagedCodeAnalysis" RuleNamespace="Microsoft.Rules.Managed">
11+
<Rule Id="CA1001" Action="Warning" />
12+
<Rule Id="CA1009" Action="Warning" />
13+
<Rule Id="CA1016" Action="Warning" />
14+
<Rule Id="CA1033" Action="Warning" />
15+
<Rule Id="CA1049" Action="Warning" />
16+
<Rule Id="CA1060" Action="Warning" />
17+
<Rule Id="CA1061" Action="Warning" />
18+
<Rule Id="CA1063" Action="Warning" />
19+
<Rule Id="CA1065" Action="Warning" />
20+
<Rule Id="CA1301" Action="Warning" />
21+
<Rule Id="CA1400" Action="Warning" />
22+
<Rule Id="CA1401" Action="Warning" />
23+
<Rule Id="CA1403" Action="Warning" />
24+
<Rule Id="CA1404" Action="Warning" />
25+
<Rule Id="CA1405" Action="Warning" />
26+
<Rule Id="CA1410" Action="Warning" />
27+
<Rule Id="CA1415" Action="Warning" />
28+
<Rule Id="CA1821" Action="Warning" />
29+
<Rule Id="CA1900" Action="Warning" />
30+
<Rule Id="CA1901" Action="Warning" />
31+
<Rule Id="CA2002" Action="Warning" />
32+
<Rule Id="CA2100" Action="Warning" />
33+
<Rule Id="CA2101" Action="Warning" />
34+
<Rule Id="CA2108" Action="Warning" />
35+
<Rule Id="CA2111" Action="Warning" />
36+
<Rule Id="CA2112" Action="Warning" />
37+
<Rule Id="CA2114" Action="Warning" />
38+
<Rule Id="CA2116" Action="Warning" />
39+
<Rule Id="CA2117" Action="Warning" />
40+
<Rule Id="CA2122" Action="Warning" />
41+
<Rule Id="CA2123" Action="Warning" />
42+
<Rule Id="CA2124" Action="Warning" />
43+
<Rule Id="CA2126" Action="Warning" />
44+
<Rule Id="CA2131" Action="Warning" />
45+
<Rule Id="CA2132" Action="Warning" />
46+
<Rule Id="CA2133" Action="Warning" />
47+
<Rule Id="CA2134" Action="Warning" />
48+
<Rule Id="CA2137" Action="Warning" />
49+
<Rule Id="CA2138" Action="Warning" />
50+
<Rule Id="CA2140" Action="Warning" />
51+
<Rule Id="CA2141" Action="Warning" />
52+
<Rule Id="CA2146" Action="Warning" />
53+
<Rule Id="CA2147" Action="Warning" />
54+
<Rule Id="CA2149" Action="Warning" />
55+
<Rule Id="CA2200" Action="Warning" />
56+
<Rule Id="CA2202" Action="Warning" />
57+
<Rule Id="CA2207" Action="Warning" />
58+
<Rule Id="CA2212" Action="Warning" />
59+
<Rule Id="CA2213" Action="Warning" />
60+
<Rule Id="CA2214" Action="Warning" />
61+
<Rule Id="CA2216" Action="Warning" />
62+
<Rule Id="CA2220" Action="Warning" />
63+
<Rule Id="CA2229" Action="Warning" />
64+
<Rule Id="CA2231" Action="Warning" />
65+
<Rule Id="CA2232" Action="Warning" />
66+
<Rule Id="CA2235" Action="Warning" />
67+
<Rule Id="CA2236" Action="Warning" />
68+
<Rule Id="CA2237" Action="Warning" />
69+
<Rule Id="CA2238" Action="Warning" />
70+
<Rule Id="CA2240" Action="Warning" />
71+
<Rule Id="CA2241" Action="Warning" />
72+
<Rule Id="CA2242" Action="Warning" />
73+
</Rules>
74+
75+
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
76+
<Rule Id="SA1000" Action="Error" />
77+
<Rule Id="SA1001" Action="Error" />
78+
<Rule Id="SA0001" Action="None" />
79+
<!-- Restore after C# 7 support is added -->
80+
<Rule Id="SA1008" Action="None" />
81+
<Rule Id="SA1021" Action="Error" />
82+
<Rule Id="SA1022" Action="Error" />
83+
<Rule Id="SA1100" Action="Error" />
84+
<Rule Id="SA1101" Action="None"/>
85+
<Rule Id="SA1106" Action="Error" />
86+
<Rule Id="SA1111" Action="Error" />
87+
<Rule Id="SA1112" Action="Error" />
88+
<Rule Id="SA1119" Action="Error" />
89+
<Rule Id="SA1121" Action="Error" />
90+
<Rule Id="SA1122" Action="Error" />
91+
<Rule Id="SA1133" Action="Error" />
92+
<Rule Id="SA1201" Action="None"/>
93+
<Rule Id="SA1202" Action="None"/>
94+
<Rule Id="SA1204" Action="None"/>
95+
<Rule Id="SA1300" Action="Error" />
96+
<Rule Id="SA1302" Action="Error" />
97+
<Rule Id="SA1303" Action="Error" />
98+
<Rule Id="SA1304" Action="Error" />
99+
<Rule Id="SA1305" Action="Warning" />
100+
<Rule Id="SA1309" Action="None" />
101+
<Rule Id="SA1311" Action="Error" />
102+
<Rule Id="SA1400" Action="Error" />
103+
<Rule Id="SA1401" Action="Error" />
104+
<Rule Id="SA1402" Action="Error" />
105+
<Rule Id="SA1403" Action="Error" />
106+
<Rule Id="SA1404" Action="Error" />
107+
<Rule Id="SA1405" Action="Error" />
108+
<Rule Id="SA1406" Action="Error" />
109+
<Rule Id="SA1407" Action="Error" />
110+
<Rule Id="SA1408" Action="Error" />
111+
<Rule Id="SA1410" Action="Error" />
112+
<Rule Id="SA1411" Action="Error" />
113+
<Rule Id="SA1412" Action="Warning" />
114+
<Rule Id="SA1503" Action="Error" />
115+
<Rule Id="SA1512" Action="None" />
116+
<Rule Id="SA1515" Action="None" />
117+
<Rule Id="SA1603" Action="Error" />
118+
<Rule Id="SA1609" Action="Warning" />
119+
<Rule Id="SA1636" Action="Error" />
120+
<Rule Id="SA1642" Action="Error" />
121+
<Rule Id="SA1643" Action="Error" />
122+
123+
<!-- Not required for samples -->
124+
<Rule Id="SA1600" Action="None" />
125+
<Rule Id="SA1633" Action="None" /> <!-- Back to Error after MSBuild bug fix (.NET Core 2.0) -->
126+
</Rules>
127+
</RuleSet>

‎self-hosted-login/README.md

+53-13
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ASP.NET Core & Self-Hosted Login Page Example
22

3-
This example shows you how to use the `Okta.AspNetCore` library to log in a user. The user's browser is first redirected to the self-hosted login page on your ASP.NET Core application. Once the user is successfully authenticated via Okta, ASP.NET Core automatically populates `HttpContext.User` with the information Okta sends back about the user.
3+
This example shows you how to use the [Okta ASP.NET Core SDK] to sign in a user. The user's browser is first redirected to the self-hosted sign-in page on your ASP.NET Core application. Once the user is successfully authenticated via Okta, ASP.NET Core automatically populates `HttpContext.User` with the information Okta sends back about the user.
44

55
## Prerequisites
66

@@ -9,23 +9,63 @@ Before running this sample, you will need the following:
99
* An Okta Developer Account, you can sign up for one at https://developer.okta.com/signup/.
1010
* An Okta Application, configured for Web mode. This is done from the Okta Developer Console and you can find instructions [here][OIDC Web Application Setup Instructions]. When following the wizard, use the default properties. They are designed to work with our sample applications.
1111

12-
**Note:** Make sure to add `http://localhost:8080` as a [Trusted Origin].
13-
1412
## Running This Example
1513

16-
Clone this repo and replace the okta configuration placeholders in the `appsettings.json` with your configuration values from the Okta Developer Console.
17-
You can see all the available configuration options in the [okta-aspnet GitHub](https://github.com/okta/okta-aspnet/blob/master/README.md).
18-
For step-by-step instructions, visit the Okta [ASP.NET MVC quickstart]. The quickstart will guide you through adding Okta login to your ASP.NET application.
14+
### Clone this repository
15+
16+
```git clone https://github.com/okta/samples-aspnetcore.git```
17+
18+
### Run the web application
19+
20+
Run the example with your preferred tool and write down the port of your web application to configure Okta afterwards.
21+
22+
> **NOTE:** This sample is using ASP.NET Core 2.2 which enforces HTTPS. This is a recommended practice for web applications. Check out [Enforce HTTPS in ASP.NET Core] for more details.
23+
24+
#### Run the web application from Visual Studio
25+
26+
If you run this project in Visual Studio it will start the web application on ports 5000 for HTTP and 44314 for HTTPS. You can change this configuration in the `launchSettings.json`.
27+
28+
#### Run the web application from dotnet CLI
29+
30+
If you run this project via the dotnet CLI it will start the web application on ports 5000 for HTTP and 5001 for HTTPS. You can change this configuration in the `launchSettings.json`.
31+
32+
Navigate to the folder where the project file is located and type the following:
33+
34+
```dotnet run```
35+
36+
#### Trust the local dev certificate if necessary
37+
38+
If you’ve never run an ASP.NET Core 2.x application before, you may notice a strange error page come up warning you that the site is potentially unsafe.
39+
This is because ASP.NET Core creates an HTTPS development certificate for you as part of the first-run experience, but it still needs to be trusted. You can ignore the warning by clicking on Advanced and telling the browser that it’s okay to visit this site even though there is no certificate for it. Or you can trust the certificate to get rid of this warning, check out [Configuring HTTPS in ASP.NET Core across different platforms] for more details.
40+
41+
### Add the correct configuration to the Okta Developer Console (including the port you just found in [Run the web application](#run-the-web-application))
42+
43+
Go to your [Okta Developer Console] and update the following parameters in your Okta Web Application configuration:
44+
* **Login redirect URI** - for example, `https://localhost:5001/authorization-code/callback`
45+
* **Logout redirect URI** - for example, `https://localhost:5001/signout/callback`
46+
47+
Also, enable CORS to allow your self-hosted page to make an XHR to the Okta API with the Okta session cookie. To do so, click **API > Trusted Origin** in your [Okta Developer Console], and add your web application’s base URL (for example, `https://localhost:5001/`) as a **Trusted Origin**.
48+
49+
For step-by-step instructions, visit the Okta [Sign Users in to Your Web Application guide] which will show you how to sign users in using Okta and, [Sign Users Out guide] which will show you how to sign users out of your app and out of Okta.
50+
51+
### Add the same configuration to the sample's appsettings
52+
53+
Replace the okta configuration placeholders in the `appsettings.json` with your configuration values from the [Okta Developer Console].
54+
You can see all the available configuration options in the [okta-aspnet GitHub](https://github.com/okta/okta-aspnet/blob/master/docs/aspnetcore-mvc.md#configuration-reference).
55+
For step-by-step instructions, visit the Okta [Sign Users in to Your Web Application guide]. The guide will walk you through adding Okta sign-in to your ASP.NET application.
1956

20-
Now start your server and navigate to http://localhost:8080 in your browser.
57+
### Run again and try to sign in
2158

22-
If you see a home page that allows you to login, then things are working! Clicking the **Log in** link will redirect you to the self-hosted sign-in page.
59+
Click the **Sign In** link in the Home page and it will redirect you to the self-hosted sign-in page.
2360

24-
You can login with the same account that you created when signing up for your Developer Org, or you can use a known username and password from your Okta Directory.
61+
You can sign in with the same account that you created when signing up for your Developer Org, or you can use a known username and password from your Okta Directory.
2562

26-
**Note:** If you are currently using your Developer Console, you already have a Single Sign-On (SSO) session for your Org. You will be automatically logged into your application as the same user that is using the Developer Console. You may want to use an incognito tab to test the flow from a blank slate.
63+
**Note:** If you are currently using your Developer Console, you already have a Single Sign-On (SSO) session for your Org. You will be automatically signed into your application as the same user that is using the Developer Console. You may want to use an incognito tab to test the flow from a blank slate.
2764

28-
[OIDC Middleware Library]: https://github.com/okta/okta-aspnet
29-
[Authorization Code Flow]: https://developer.okta.com/authentication-guide/implementing-authentication/auth-code
65+
[Okta ASP.NET Core SDK]: https://github.com/okta/okta-aspnet
3066
[OIDC Web Application Setup Instructions]: https://developer.okta.com/authentication-guide/implementing-authentication/auth-code#1-setting-up-your-application
31-
[ASP.NET MVC quickstart]:https://developer.okta.com/quickstart/#/okta-sign-in-page/dotnet/aspnetcore
67+
[Enforce HTTPS in ASP.NET Core]: https://docs.microsoft.com/en-us/aspnet/core/security/enforcing-ssl?view=aspnetcore-2.2&tabs=visual-studio
68+
[Configuring HTTPS in ASP.NET Core across different platforms]:https://devblogs.microsoft.com/aspnet/configuring-https-in-asp-net-core-across-different-platforms/
69+
[Sign Users in to Your Web Application guide]: https://developer.okta.com/guides/sign-into-web-app/aspnet/before-you-begin/
70+
[Sign Users Out guide]: https://developer.okta.com/guides/sign-users-out/aspnetcore/before-you-begin/
71+
[Okta Developer Console]: https://login.okta.com

‎self-hosted-login/okta-aspnetcore-mvc-example.sln

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11

22
Microsoft Visual Studio Solution File, Format Version 12.00
3-
# Visual Studio 15
4-
VisualStudioVersion = 15.0.27130.2036
3+
# Visual Studio Version 16
4+
VisualStudioVersion = 16.0.28729.10
55
MinimumVisualStudioVersion = 10.0.40219.1
6-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "okta-aspnetcore-mvc-example", "okta-aspnetcore-mvc-example\okta-aspnetcore-mvc-example.csproj", "{A31C71CE-4B56-485B-A760-9D3E2241EDF1}"
6+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "okta-aspnetcore-mvc-example", "okta-aspnetcore-mvc-example\okta-aspnetcore-mvc-example.csproj", "{E358DC85-C34B-4B6F-BBE1-4814A43D7827}"
77
EndProject
88
Global
99
GlobalSection(SolutionConfigurationPlatforms) = preSolution
1010
Debug|Any CPU = Debug|Any CPU
1111
Release|Any CPU = Release|Any CPU
1212
EndGlobalSection
1313
GlobalSection(ProjectConfigurationPlatforms) = postSolution
14-
{A31C71CE-4B56-485B-A760-9D3E2241EDF1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
15-
{A31C71CE-4B56-485B-A760-9D3E2241EDF1}.Debug|Any CPU.Build.0 = Debug|Any CPU
16-
{A31C71CE-4B56-485B-A760-9D3E2241EDF1}.Release|Any CPU.ActiveCfg = Release|Any CPU
17-
{A31C71CE-4B56-485B-A760-9D3E2241EDF1}.Release|Any CPU.Build.0 = Release|Any CPU
14+
{E358DC85-C34B-4B6F-BBE1-4814A43D7827}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
15+
{E358DC85-C34B-4B6F-BBE1-4814A43D7827}.Debug|Any CPU.Build.0 = Debug|Any CPU
16+
{E358DC85-C34B-4B6F-BBE1-4814A43D7827}.Release|Any CPU.ActiveCfg = Release|Any CPU
17+
{E358DC85-C34B-4B6F-BBE1-4814A43D7827}.Release|Any CPU.Build.0 = Release|Any CPU
1818
EndGlobalSection
1919
GlobalSection(SolutionProperties) = preSolution
2020
HideSolutionNode = FALSE
2121
EndGlobalSection
2222
GlobalSection(ExtensibilityGlobals) = postSolution
23-
SolutionGuid = {B40705E7-BD7A-4BBF-B87A-9BC2C953BC89}
23+
SolutionGuid = {689AB55A-EB52-4057-B501-1AD0A57D683B}
2424
EndGlobalSection
2525
EndGlobal

‎self-hosted-login/okta-aspnetcore-mvc-example/Controllers/AccountController.cs

+14-15
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,28 @@
11
using Microsoft.AspNetCore.Authentication;
22
using Microsoft.AspNetCore.Authentication.Cookies;
33
using Microsoft.AspNetCore.Mvc;
4-
using Microsoft.Extensions.Options;
54
using Okta.AspNetCore;
6-
using okta_aspnetcore_mvc_example.Models;
75

6+
#pragma warning disable SA1300 // Element should begin with upper-case letter
87
namespace okta_aspnetcore_mvc_example.Controllers
8+
#pragma warning restore SA1300 // Element should begin with upper-case letter
99
{
1010
public class AccountController : Controller
1111
{
12-
private OktaSettings _oktaSettings;
13-
14-
public AccountController(IOptions<OktaSettings> oktaSettings)
15-
{
16-
_oktaSettings = oktaSettings.Value;
17-
}
18-
19-
public IActionResult Login()
12+
public IActionResult SignIn()
2013
{
2114
return View();
2215
}
2316

2417
[HttpPost]
2518
[ValidateAntiForgeryToken]
26-
public IActionResult Login([FromForm]string sessionToken)
19+
public IActionResult SignIn([FromForm]string sessionToken)
2720
{
2821
if (!HttpContext.User.Identity.IsAuthenticated)
2922
{
3023
var properties = new AuthenticationProperties();
3124
properties.Items.Add("sessionToken", sessionToken);
32-
properties.RedirectUri = "/Home/About";
25+
properties.RedirectUri = "/Home/";
3326

3427
return Challenge(properties, OktaDefaults.MvcAuthenticationScheme);
3528
}
@@ -38,9 +31,15 @@ public IActionResult Login([FromForm]string sessionToken)
3831
}
3932

4033
[HttpPost]
41-
public IActionResult Logout()
34+
public IActionResult SignOut()
4235
{
43-
return new SignOutResult(new[] { CookieAuthenticationDefaults.AuthenticationScheme, OktaDefaults.MvcAuthenticationScheme });
36+
return new SignOutResult(
37+
new[]
38+
{
39+
OktaDefaults.MvcAuthenticationScheme,
40+
CookieAuthenticationDefaults.AuthenticationScheme,
41+
},
42+
new AuthenticationProperties { RedirectUri = "/Home/" });
4443
}
4544
}
46-
}
45+
}

‎self-hosted-login/okta-aspnetcore-mvc-example/Controllers/HomeController.cs

+4-10
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
using Microsoft.AspNetCore.Mvc;
44
using okta_aspnetcore_mvc_example.Models;
55

6+
#pragma warning disable SA1300 // Element should begin with upper-case letter
67
namespace okta_aspnetcore_mvc_example.Controllers
8+
#pragma warning restore SA1300 // Element should begin with upper-case letter
79
{
810
public class HomeController : Controller
911
{
@@ -12,20 +14,12 @@ public IActionResult Index()
1214
return View();
1315
}
1416

15-
public IActionResult About()
17+
public IActionResult Privacy()
1618
{
17-
ViewData["Message"] = "Your application description page.";
18-
19-
return View();
20-
}
21-
22-
public IActionResult Contact()
23-
{
24-
ViewData["Message"] = "Your contact page.";
25-
2619
return View();
2720
}
2821

22+
[ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
2923
public IActionResult Error()
3024
{
3125
return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });

‎self-hosted-login/okta-aspnetcore-mvc-example/Models/ErrorViewModel.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
using System;
2-
1+
#pragma warning disable SA1300 // Element should begin with upper-case letter
32
namespace okta_aspnetcore_mvc_example.Models
3+
#pragma warning restore SA1300 // Element should begin with upper-case letter
44
{
55
public class ErrorViewModel
66
{
77
public string RequestId { get; set; }
88

99
public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
1010
}
11-
}
11+
}

‎self-hosted-login/okta-aspnetcore-mvc-example/Models/OktaSettings.cs

-7
This file was deleted.

‎self-hosted-login/okta-aspnetcore-mvc-example/Program.cs

+5-4
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,19 @@
88
using Microsoft.Extensions.Configuration;
99
using Microsoft.Extensions.Logging;
1010

11+
#pragma warning disable SA1300 // Element should begin with upper-case letter
1112
namespace okta_aspnetcore_mvc_example
13+
#pragma warning restore SA1300 // Element should begin with upper-case letter
1214
{
1315
public class Program
1416
{
1517
public static void Main(string[] args)
1618
{
17-
BuildWebHost(args).Run();
19+
CreateWebHostBuilder(args).Build().Run();
1820
}
1921

20-
public static IWebHost BuildWebHost(string[] args) =>
22+
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
2123
WebHost.CreateDefaultBuilder(args)
22-
.UseStartup<Startup>()
23-
.Build();
24+
.UseStartup<Startup>();
2425
}
2526
}

0 commit comments

Comments
 (0)