chore: fix spelling

Apparently go doesn't support those

README.md

@@ -8,3 +8,37 @@ OIDC_CLIENT_SECRET=<client secret>
 OIDC_ISSUE=<issuer url>
 ```
 If these env vars are not present, then depending on configuration, stubs will be used for the endpoints or the program will crash
+
+
+## Usage
+```go
+package main
+
+import (
+	"os"
+
+	"github.com/gin-contrib/sessions"
+	"github.com/gin-contrib/sessions/memstore"
+	"github.com/gin-gonic/gin"
+	"github.com/janishutz/oidclogin"
+)
+
+func main() {
+	r := gin.Default()
+
+	// TODO: Better secret
+	store := memstore.NewStore([]byte("secret"))
+	r.Use(sessions.Sessions("jhid", store))
+
+	oidclogin.Configure(r, os.Getenv("APP_BASE_URL"), "/account", false)
+	r.LoadHTMLGlob("public/*")
+
+	r.GET("/account", oidclogin.EnsureLogin(false), func(ctx *gin.Context) {
+		ctx.HTML(200, "main.tmpl", gin.H{})
+	})
+
+	r.Run()
+}
+```
+This example further needs the environment variable `APP_BASE_URL` set to something like `https://app.example.org`.
+Further, you should create a template file called `main.tmpl` and also copy over the template files in the `public` directory here and edit them.

go.mod

@@ -1,6 +1,6 @@
 module github.com/janishutz/oidclogin
 
-go 1.27.1
+go 1.26.0
 
 require (
 	github.com/coreos/go-oidc/v3 v3.21.0

handlers.go

@@ -35,7 +35,6 @@ func callbackHandler(c *gin.Context) {
 
 	if c.Query("state") != state || codeVerifier == nil {
 		log.Println("State invalid or verifier was not stored")
-		// TODO: Proper pages
 		c.HTML(500, "oidcerror.tmpl", gin.H{
 			"error": "ERR_INVALID_STATE",
 		})
@@ -92,7 +91,7 @@ func callbackHandler(c *gin.Context) {
 
 	// Verify NONCE
 	if nonce != claims.Nonce {
-		log.Println("Token verificcation failed", err)
+		log.Println("Token verification failed (nonce missing)")
 		c.HTML(500, "oidcerror.tmpl", gin.H{
 			"error": "ERR_AUTH",
 		})
@@ -112,6 +111,14 @@ func callbackHandler(c *gin.Context) {
 	session.Delete("redirect")
 
 	session.Set("jhid_auth", true)
+	session.Set("jhid_uid", claims.Uid)
+	session.Options(sessions.Options{
+		Path:     "/",
+		SameSite: sameSiteMode,
+		HttpOnly: true,
+		Secure:   prod,
+		MaxAge:   172800, // Expires in 2 days
+	})
 	session.Save()
 
 	if redir != nil {
@@ -121,10 +128,29 @@ func callbackHandler(c *gin.Context) {
 	}
 }
 
+func logoutHandler(c *gin.Context) {
+	session := sessions.Default(c)
+	session.Clear()
+	session.Save()
+	redir := ""
+	if c.Query("returnTo") != "" {
+		redir = c.Query("returnTo")
+	}
+	if redir != "" {
+		c.Redirect(307, redir)
+	} else {
+		c.Redirect(307, defaultRedirect)
+	}
+}
+
+// Ensure that a user is currently logged in.
+// If redirectFail is set, then if not, the user is redirected.
 func EnsureLogin(redirectFail bool) func(c *gin.Context) {
 	return (func(c *gin.Context) {
 		session := sessions.Default(c)
 		if session.Get("jhid_auth") == true {
+			// Set the UID on the context
+			c.Set("uid", session.Get("jhid_uid").(string))
 			c.Next()
 		} else {
 			if redirectFail {
@@ -132,9 +158,7 @@ func EnsureLogin(redirectFail bool) func(c *gin.Context) {
 				c.Abort()
 				return
 			} else {
-				c.HTML(401, "autherror.tmpl", gin.H{
-					"error": "ERR_AUTH",
-				})
+				c.HTML(401, "autherror.tmpl", gin.H{})
 				c.Abort()
 				return
 			}

main.go

@@ -5,6 +5,7 @@ import (
 	"crypto/rand"
 	"encoding/base64"
 	"log"
+	"net/http"
 	"os"
 
 	"github.com/coreos/go-oidc/v3/oidc"
@@ -20,37 +21,68 @@ func createRandomString(n int) (string, error) {
 	return base64.URLEncoding.EncodeToString(s), nil
 }
 
+type UserFunc func(userid string, name string, email string)
+
 var (
 	config          oauth2.Config
-	userFunc        func(userid string, name string, email string)
+	userFunc        UserFunc
 	verifier        oidc.IDTokenVerifier
 	defaultRedirect string
+	prod            bool
+	sameSiteMode    http.SameSite
 )
 
-// Configure and set up the login SDK.
-func Configure(r *gin.Engine, app_url string, default_redirect string, stubs_on_unconfigured bool) {
+// Wraps the normal configure function, but also gives you access to change the User Function, which is called upon login.
+// It is used to create or update a user.
+// The check middleware may be nil, in which case a default is used. Otherwise should be a valid gin middleware, calling c.Next() if okay to proceed.
+func ConfigureFull(
+	r *gin.Engine,
+	app_url string,
+	default_redirect string,
+	user_function UserFunc,
+	stubs_on_unconfigured bool,
+	check_middleware func(c *gin.Context),
+	production bool,
+) {
+	userFunc = user_function
+	Configure(r, app_url, default_redirect, stubs_on_unconfigured, check_middleware, production)
+}
+
+// Configure and set up the login SDK
+// The check middleware may be nil, in which case a default is used. Otherwise should be a valid gin middleware, calling c.Next() if okay to proceed.
+func Configure(r *gin.Engine, app_url string, default_redirect string, stubs_on_unconfigured bool, check_middleware func(c *gin.Context), production bool) {
 	issuer := os.Getenv("OIDC_ISSUER")
 	clientID := os.Getenv("OIDC_CLIENT_ID")
 	clientSecret := os.Getenv("OIDC_CLIENT_SECRET")
+	defaultRedirect = default_redirect
+	prod = production
+	if prod {
+		sameSiteMode = http.SameSiteNoneMode
+	} else {
+		sameSiteMode = http.SameSiteDefaultMode
+	}
 
 	if issuer == "" || clientID == "" || clientSecret == "" {
 		if stubs_on_unconfigured {
 			log.Println("[JHID] WARNING: OIDC not set up due to missing environment variables. Falling back to stubs")
-			startStubs(r)
+			startStubs(r, check_middleware)
 			return
 		} else {
 			log.Fatal("[JHID] One or more requried environment variables are missing. See docs for more information")
 		}
 	}
 
-	provider, err := oidc.NewProvider(context.Background(), issuer)
-	verifier = *provider.Verifier(&oidc.Config{ClientID: clientID})
-	defaultRedirect = default_redirect
+	if userFunc == nil {
+		log.Println("[JHID] WARNING: No user function defined")
+	}
 
+	provider, err := oidc.NewProvider(context.Background(), issuer)
 	if err != nil {
 		log.Fatal("[JHID] Provider resolution failed with error", err)
 	}
 
+	verifier = *provider.Verifier(&oidc.Config{ClientID: clientID})
+
 	config = oauth2.Config{
 		ClientID:     clientID,
 		ClientSecret: clientSecret,
@@ -61,10 +93,19 @@ func Configure(r *gin.Engine, app_url string, default_redirect string, stubs_on_
 
 	r.GET("/auth/v2/login", loginHandler)
 	r.GET("/auth/v2/verify", callbackHandler)
+	if check_middleware == nil {
+		r.GET("/auth/v2/check", EnsureLogin(false), check_finalizer)
+	} else {
+		log.Println("[JHID] Custom check middleware enabled")
+		r.GET("/auth/v2/check", EnsureLogin(false), check_middleware, check_finalizer)
+	}
+	r.GET("/auth/v2/logout", logoutHandler)
 
 	log.Println("[JHID] Configured successfully")
 }
 
+func check_finalizer(ctx *gin.Context) { ctx.JSON(200, gin.H{"success": "true"}) }
+
 func ErrorHandler() gin.HandlerFunc {
 	return func(c *gin.Context) {
 		c.Next()

public/autherror.tmpl

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <!-- NOTE: You should definitely host this yourself! (and you can adjust the style that way, too!) -->
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/janishutz/oidclogin/public/style.css">
+    </head>
+    <body>
+        <div class="message-wrapper">
+            <h1>401</h1>
+            <p>Unauthorized</p>
+        </div>
+        <p>You are not authorized to view this page. Please log in</p>
+        <a href="/">Back Home</a>
+    </body>
+</html>

public/oidcerror.tmpl

@@ -1,9 +1,16 @@
+<!DOCTYPE html>
 <html>
     <head>
-
+        <!-- NOTE: You should definitely host this yourself! (and you can adjust the style that way, too!) -->
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/janishutz/oidclogin/public/style.css">
     </head>
     <body>
-        <h1>Login Failed!</h1>
-        <p>{{ .error }}</p>
+        <div class="message-wrapper">
+            <h1>500</h1>
+            <p>Internal Server Error</p>
+        </div>
+        <p>There was an error logging you in. Please try again. We are sorry for the inconvenience</p>
+        <a href="/">Back Home</a>
+        <p class="error-msg">{{ .error }}</p>
     </body>
 </html>

public/style.css

@@ -0,0 +1,50 @@
+html,
+body {
+    background-color: #050505;
+    color: #FFFFFF;
+    width: 100vw;
+    height: 100vh;
+    margin: 0;
+    padding: 0;
+}
+
+body {
+    font-family: sans-serif;
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    flex-direction: column;
+}
+
+.message-wrapper {
+    display: flex;
+    justify-content: center;
+    align-items: center;
+}
+
+.message-wrapper h1 {
+    font-size: 10rem;
+}
+
+.message-wrapper p {
+    font-size: 1.5rem;
+}
+
+a {
+    color: white;
+    background-color: #101066;
+    padding: 10px;
+    border-radius: 10px;
+    cursor: pointer;
+    text-decoration: none;
+}
+
+.error-msg {
+    font-size: 0.8rem;
+    position: fixed;
+    bottom: 10px;
+    left: 0;
+    width: 100vw;
+    text-align: center;
+    color: #888888;
+}

stubs.go

@@ -1,22 +1,40 @@
 package oidclogin
 
-import "github.com/gin-gonic/gin"
+import (
+	"log"
 
-func startStubs(r *gin.Engine) {
-	r.GET("/auth/v2/login", func(ctx *gin.Context) {
-		redir := ctx.Query("returnTo")
-		if redir != "" {
-			ctx.Redirect(307, redir)
-		} else {
-			ctx.Redirect(307, defaultRedirect)
-		}
-	})
-	r.GET("/auth/v2/verify", func(ctx *gin.Context) {
-		redir := ctx.Query("returnTo")
-		if redir != "" {
-			ctx.Redirect(307, redir)
-		} else {
-			ctx.Redirect(307, defaultRedirect)
-		}
-	})
+	"github.com/gin-contrib/sessions"
+	"github.com/gin-gonic/gin"
+)
+
+func startStubs(r *gin.Engine, check_middleware func(c *gin.Context)) {
+	r.GET("/auth/v2/login", stubsHandler)
+	r.GET("/auth/v2/verify", stubsHandler)
+	if check_middleware == nil {
+		r.GET("/auth/v2/check", EnsureLogin(false), check_finalizer)
+	} else {
+		log.Println("[JHID] Custom check middleware enabled")
+		r.GET("/auth/v2/check", EnsureLogin(false), check_middleware, check_finalizer)
+	}
+	r.GET("/auth/v2/logout", logoutHandler)
+}
+
+func stubsHandler(c *gin.Context) {
+	redir := c.Query("returnTo")
+	session := sessions.Default(c)
+	if userFunc != nil {
+		userFunc("stubs", "Stubs User", "example@example.com")
+	} else {
+		log.Println("[JHID] WARNING: No user function defined")
+	}
+	session.Set("jhid_auth", true)
+	session.Set("jhid_uid", "stubs")
+	session.Save()
+	if redir != "" {
+		log.Println("[JHID] Redirecting to ", redir)
+		c.Redirect(307, redir)
+	} else {
+		log.Println("[JHID] Redirecting to ", defaultRedirect, " (default redirect)")
+		c.Redirect(307, defaultRedirect)
+	}
 }