Refactor

- Use self type annotation instead of extending
- Aggregate OIDC context to a case class
- Use companion object instead of dedicated utility class

src/main/scala/gitbucket/core/controller/IndexController.scala

@@ -22,6 +22,7 @@ class IndexController extends IndexControllerBase
   with IssuesService
   with UsersAuthenticator
   with ReferrerAuthenticator
+  with AccountFederationService
   with OpenIDConnectService
 
 
@@ -50,6 +51,7 @@ trait IndexControllerBase extends ControllerBase {
 //
 //  case class SearchForm(query: String, owner: String, repository: String)
 
+  case class OidcContext(state: State, nonce: Nonce, redirectBackURI: String)
 
   get("/"){
     context.loginAccount.map { account =>
@@ -90,13 +92,11 @@ trait IndexControllerBase extends ControllerBase {
     context.settings.oidc.map { oidc =>
       val redirectURI = new URI(s"$baseUrl/signin/oidc")
       val authenticationRequest = createOIDCAuthenticationRequest(oidc.issuer, oidc.clientID, redirectURI)
-      session.setAttribute(Keys.Session.OidcState, authenticationRequest.getState)
+      val redirectBackURI = flash.get(Keys.Flash.Redirect) match {
-      session.setAttribute(Keys.Session.OidcNonce, authenticationRequest.getNonce)
+        case Some(redirectBackURI: String) => redirectBackURI + params.getOrElse("hash", "")
-      session.setAttribute(Keys.Session.OidcRedirectBackURI,
+        case _ => "/"
-        flash.get(Keys.Flash.Redirect) match {
+      }
-          case Some(redirectBackURI: String) => redirectBackURI + params.getOrElse("hash", "")
+      session.setAttribute(Keys.Session.OidcContext, OidcContext(authenticationRequest.getState, authenticationRequest.getNonce, redirectBackURI))
-          case _ => "/"
-        })
       redirect(authenticationRequest.toURI.toString)
     } getOrElse {
       NotFound()
@@ -109,10 +109,10 @@ trait IndexControllerBase extends ControllerBase {
   get("/signin/oidc") {
     context.settings.oidc.map { oidc =>
       val redirectURI = new URI(s"$baseUrl/signin/oidc")
-      Seq(Keys.Session.OidcState, Keys.Session.OidcNonce, Keys.Session.OidcRedirectBackURI).map(session.get(_)) match {
+      session.get(Keys.Session.OidcContext) match {
-        case Seq(Some(state: State), Some(nonce: Nonce), Some(redirectBackURI: String)) =>
+        case Some(context: OidcContext) =>
-          authenticate(params, redirectURI, state, nonce, oidc) map { account =>
+          authenticate(params, redirectURI, context.state, context.nonce, oidc) map { account =>
-            signin(account, redirectBackURI)
+            signin(account, context.redirectBackURI)
           } orElse {
             flash += "error" -> "Sorry, authentication failed. Please try again."
             session.invalidate()

src/main/scala/gitbucket/core/service/AccountFederationService.scala

@@ -6,7 +6,8 @@ import gitbucket.core.model.{Account, AccountFederation}
 import gitbucket.core.util.SyntaxSugars.~
 import org.slf4j.LoggerFactory
 
-trait AccountFederationService extends AccountService {
+trait AccountFederationService {
+  self: AccountService =>
 
   private val logger = LoggerFactory.getLogger(classOf[AccountFederationService])
 

src/main/scala/gitbucket/core/service/OpenIDConnectService.scala

@@ -2,9 +2,10 @@ package gitbucket.core.service
 
 import java.net.URI
 
-import com.nimbusds.jose.JOSEException
+import com.nimbusds.jose.JWSAlgorithm.Family
 import com.nimbusds.jose.proc.BadJOSEException
 import com.nimbusds.jose.util.DefaultResourceRetriever
+import com.nimbusds.jose.{JOSEException, JWSAlgorithm}
 import com.nimbusds.oauth2.sdk._
 import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic
 import com.nimbusds.oauth2.sdk.id.{ClientID, Issuer, State}
@@ -16,12 +17,13 @@ import gitbucket.core.model.Account
 import gitbucket.core.model.Profile.profile.blockingApi._
 import org.slf4j.LoggerFactory
 
-import scala.collection.JavaConverters.mapAsJavaMap
+import scala.collection.JavaConverters.{asScalaSet, mapAsJavaMap}
 
 /**
   * Service class for the OpenID Connect authentication.
   */
-trait OpenIDConnectService extends AccountFederationService {
+trait OpenIDConnectService {
+  self: AccountFederationService =>
 
   private val logger = LoggerFactory.getLogger(classOf[OpenIDConnectService])
 
@@ -175,3 +177,15 @@ trait OpenIDConnectService extends AccountFederationService {
         None
     }
 }
+
+object OpenIDConnectService {
+  /**
+    * All signature algorithms.
+    */
+  val JWS_ALGORITHMS: Map[String, Set[JWSAlgorithm]] = Seq(
+    "HMAC" -> Family.HMAC_SHA,
+    "RSA" -> Family.RSA,
+    "ECDSA" -> Family.EC,
+    "EdDSA" -> Family.ED
+  ).toMap.map { case (name, family) => (name, asScalaSet(family).toSet) }
+}

src/main/scala/gitbucket/core/util/Keys.scala

@@ -28,17 +28,7 @@ object Keys {
     /**
       * Session key for the OpenID Connect authentication.
       */
-    val OidcState = "oidc/state"
+    val OidcContext = "oidcContext"
-
-    /**
-      * Session key for the OpenID Connect authentication.
-      */
-    val OidcNonce = "oidc/nonce"
-
-    /**
-      * Session key for the redirect back to after SSO.
-      */
-    val OidcRedirectBackURI = "oidc/redirectBackURI"
 
     /**
      * Generate session key for the issue search condition.

src/main/scala/gitbucket/core/util/OpenIDConnectUtil.scala

@@ -1,15 +0,0 @@
-package gitbucket.core.util
-
-import com.nimbusds.jose.JWSAlgorithm
-import com.nimbusds.jose.JWSAlgorithm.Family
-
-import scala.collection.JavaConverters.asScalaSet
-
-object OpenIDConnectUtil {
-  val JWS_ALGORITHMS: Map[String, Set[JWSAlgorithm]] = Seq(
-    "HMAC" -> Family.HMAC_SHA,
-    "RSA" -> Family.RSA,
-    "ECDSA" -> Family.EC,
-    "EdDSA" -> Family.ED
-  ).toMap.map { case (name, family) => (name, asScalaSet(family).toSet) }
-}

src/main/twirl/gitbucket/core/admin/system.scala.html

@@ -1,5 +1,6 @@
 @(info: Option[Any])(implicit context: gitbucket.core.controller.Context)
-@import gitbucket.core.util.{DatabaseConfig, OpenIDConnectUtil}
+@import gitbucket.core.service.OpenIDConnectService
+@import gitbucket.core.util.DatabaseConfig
 @gitbucket.core.html.main("System settings"){
   @gitbucket.core.admin.html.menu("system"){
     @gitbucket.core.helper.html.information(info)
@@ -321,7 +322,7 @@
                   <option value="" @if(context.settings.oidc.flatMap(_.jwsAlgorithm) == None){selected}>
                     No signature
                   </option>
-                  @OpenIDConnectUtil.JWS_ALGORITHMS.map { case (family, algorithms) =>
+                  @OpenIDConnectService.JWS_ALGORITHMS.map { case (family, algorithms) =>
                     <optgroup label="@family">
                       @algorithms.map { algorithm =>
                         <option value="@algorithm.getName" @if(context.settings.oidc.flatMap(_.jwsAlgorithm) == Some(algorithm)){selected}>