Update documentation for configuring AuthSCH

Author: albi005

README.md

@@ -18,37 +18,34 @@ Instructions on how to quickly set up a development environment.
 - [bun](https://bun.sh/docs/installation)
   - make sure you can run `bun`
 
-### AuthSCH credentials
-
-https://auth.sch.bme.hu > *Bejelentkezés* > *Fejlesztői konzol* > *Új hozzáadása*, set *Átirányítási cím* to
-`http://localhost:5264/signin-oidc`,
-then use the created credentials in the following commands:
-
 ### Running from the terminal
 
 ```shell
 git clone https://github.com/kir-dev/StartSCH
 cd StartSCH/StartSch
-dotnet user-secrets set AuthSch:ClientId REPLACE_THIS_WITH_YOUR_AUTHSCH_CLIENTID
-dotnet user-secrets set AuthSch:ClientSecret REPLACE_THIS_WITH_YOUR_AUTHSCH_CLIENTSECRET
 dotnet run
 ```
 
-### Debugging
+### IDE
 
-I recommend using JetBrains' .NET IDE, Rider for working on StartSCH. Below you can find instructions on how run StartSCH in debug mode using it:
+I recommend using JetBrains' .NET IDE, Rider for working on StartSCH.
+Below you can find instructions on how to run StartSCH in debug mode using it:
 
 1. [Install Rider](https://www.jetbrains.com/rider/download/)
-2. Open `StartSCH.slnx`
-3. Ensure AuthSCH credentials are correctly set up: *Explorer* > *StartSch* > right-click > *Tools* > *.NET User Secrets*
+2. Open `StartSCH.slnx` with Rider
+3. [Set the Run Configuration](https://www.jetbrains.com/help/rider/Run_Debug_Configuration.html#launch-run-configuration)
+   to *StartSch: http*
 4. Click *Debug 'StartSch'* (the green bug icon in the top right) or press `F5`
 
 [//]: # (TODO: add details about WASM debugging. Perhaps create a separate doc for it?)
 
 ### Running with hot reloading
 
 Hot reloading allows updating the code of the app while it is running without restarting it.
-Rider's built-in hot reloading is not that great, so I highly recommend just running StartSCH from the terminal if you don't need a debugger:
+It is especially useful when working on UI code.
+
+Rider's built-in hot reloading is useless, so I highly recommend just running StartSCH
+from the terminal if you don't need a debugger.
 
 #### Terminal 1
 ```sh
@@ -58,6 +55,9 @@ cd StartSCH/StartSch
 dotnet watch
 ```
 
+.NET Hot Reload only works for smaller changes, and even at that it still sometimes fails,
+so you will have to restart the app quite often.
+
 #### Terminal 2
 ```shell
 cd StartSCH/StartSch
@@ -69,9 +69,11 @@ bun watch
 
 ## Development
 
+Everything you might need to know to work on StartSCH.
+
 ### Overview
 
-If you don't like reading, check out these files and directories for a quick overview of the project:
+If you don't like reading, skim these files and directories for a quick overview of the project:
 
 - [`StartSch/`](StartSch)
   - [`Program.cs`](StartSch/Program.cs): the entrypoint of the server
@@ -146,13 +148,34 @@ Examples:
 
 `SchPincerModule` is enabled by default in `appsettings.Development.json`.
 
-### Setting up push notifications
+#### Configuring AuthSCH
+
+### AuthSCH credentials
+
+https://auth.sch.bme.hu > *Bejelentkezés* > *Fejlesztői konzol* > *Új hozzáadása*, set *Átirányítási cím* to
+`http://localhost:5264/signin-oidc`,
+then set `AuthSch:ClientId` and `AuthSch:ClientSecret` configuration values, for example using user secrets:
+```shell
+cd StartSCH/StartSch
+dotnet user-secrets set AuthSch:ClientId REPLACE_THIS_WITH_YOUR_AUTHSCH_CLIENTID
+dotnet user-secrets set AuthSch:ClientSecret REPLACE_THIS_WITH_YOUR_AUTHSCH_CLIENTSECRET
+dotnet run
+```
+or environment variables:
+```shell
+AuthSch__ClientId=REPLACE_THIS_WITH_YOUR_AUTHSCH_CLIENTID
+AuthSch__ClientSecret=REPLACE_THIS_WITH_YOUR_AUTHSCH_CLIENTSECRET
+```
+
+Once the credentials are set, StartSCH will allow logging in with AuthSCH.
+
+#### Configuring Web Push notifications
 
 - [MDN: Web Push API](https://developer.mozilla.org/en-US/docs/Web/API/Push_API)
 - [web.dev: Push notifications overview](https://web.dev/articles/push-notifications-overview)
 
 To send push notifications, most push services, 
-[for example, Apple](https://developer.apple.com/documentation/usernotifications/sending-web-push-notifications-in-web-apps-and-browsers#Prepare-your-server-to-send-push-notifications),
+[for example, Apple's](https://developer.apple.com/documentation/usernotifications/sending-web-push-notifications-in-web-apps-and-browsers#Prepare-your-server-to-send-push-notifications),
 require a [VAPID](https://rfc-editor.org/rfc/rfc8292) key pair.
 
 If you want to try out push notifications, you can use a [VAPID key generator](https://steveseguin.github.io/vapid/)
@@ -163,7 +186,8 @@ cd StartSCH/StartSch
 
 dotnet user-secrets set Push:PublicKey "..."
 dotnet user-secrets set Push:PrivateKey "..."
-# Push service providers use this if there are issues with a sender, probably not important when developing
+# Push service providers use this if there are issues with a sender,
+# probably not important when developing but do ensure it is set to something.
 dotnet user-secrets set Push:Subject "mailto:example@example.com"
 ```
 

StartSch/Components/Pages/AuthenticationDevPage.razor

@@ -14,6 +14,24 @@
 @if (!HostEnvironment.IsDevelopment())
     return;
 
+@if (FromAuthSchLogin is { })
+{
+    <section style="margin: 16px 0; padding: 16px; border-radius: 16px; background-color: var(--md-sys-color-secondary-container); color: var(--md-sys-color-on-secondary-container); line-height: 1.6">
+        <md-icon>
+            lightbulb_2
+        </md-icon>
+        <h2>
+            Enabling AuthSCH sign-in
+        </h2>
+        <p>
+            Get a client ID and secret from auth.sch.bme.hu and add them to your StartSCH configuration:
+        </p>
+        <a href="https://github.com/kir-dev/StartSCH#configuring-authsch" style="font-weight: bold">
+            github.com/kir-dev/StartSCH#configuring-authsch
+        </a>
+    </section>
+}
+
 <Title>Fejlesztői bejelentkezés</Title>
 
 <AuthorizeView Context="_">
@@ -63,6 +81,9 @@
     [SupplyParameterFromQuery(Name = "ReturnUrl")]
     private string? ReturnUrl { get; set; }
 
+    [SupplyParameterFromQuery(Name = "from-authsch-login")]
+    private string? FromAuthSchLogin { get; set; }
+
     protected override void OnInitialized() => Model ??= new();
 
     private async Task SignIn()

StartSch/Controllers/AuthenticationController.cs

@@ -5,15 +5,22 @@ namespace StartSch.Controllers;
 
 // Based on https://learn.microsoft.com/en-us/aspnet/core/blazor/security/blazor-web-app-with-oidc?view=aspnetcore-8.0&pivots=without-bff-pattern
 [ApiController]
-public class AuthenticationController : ControllerBase
+public class AuthenticationController(
+    IHostEnvironment hostEnvironment,
+    IAuthenticationSchemeProvider authenticationSchemeProvider
+) : ControllerBase
 {
     [HttpGet("/authentication/login")]
-    public ChallengeResult Login([FromQuery] string? returnUrl)
+    public async Task<IActionResult> Login([FromQuery] string? returnUrl)
     {
-        return Challenge(new AuthenticationProperties()
+        if (hostEnvironment.IsDevelopment()
+            && await authenticationSchemeProvider.GetSchemeAsync(Constants.AuthSchAuthenticationScheme) is null)
+            return Redirect("/authentication/dev?from-authsch-login");
+
+        return Challenge(new AuthenticationProperties
         {
             RedirectUri = GetReturnUrl(returnUrl, Request.PathBase),
-            IsPersistent = true
+            IsPersistent = true,
         });
     }
 
@@ -26,7 +33,6 @@ public SignOutResult Logout([FromForm] string? returnUrl)
             {
                 RedirectUri = GetReturnUrl(returnUrl, Request.PathBase)
             },
-
             [
                 Constants.CookieAuthenticationScheme,
 
@@ -43,7 +49,7 @@ public SignOutResult Logout([FromForm] string? returnUrl)
         );
     }
 
-    private static string? GetReturnUrl(string? returnUrl, string pathBase)
+    private static string GetReturnUrl(string? returnUrl, string pathBase)
     {
         // Prevent open redirects
         if (string.IsNullOrEmpty(returnUrl))

StartSch/Services/FontCache.cs

@@ -69,6 +69,7 @@ public class FontCache
                 "history",
                 "home",
                 "lightbulb",
+                "lightbulb_2",
                 "link",
                 "link_2",
                 "location_on",