Merge pull request #37 from myndocs/release/0.3.0

Release/0.3.0
myndocs · Nov 15, 2018 · 84c29b6 · 84c29b6
2 parents 6681d96 + 6bae166
commit 84c29b6
Show file tree

Hide file tree

Showing 32 changed files with 220 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ It encourages to adapt to existing implementations instead the other way around.
 First define the version to be used and set it as a property
 ```xml
 <properties>
-    <myndocs.oauth.version>0.2.2</myndocs.oauth.version>
+    <myndocs.oauth.version>0.3.0</myndocs.oauth.version>
 </properties>
 ```
 

diff --git a/oauth2-server-client-inmemory/pom.xml b/oauth2-server-client-inmemory/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>kotlin-oauth2-server</artifactId>
         <groupId>nl.myndocs</groupId>
-        <version>0.2.2</version>
+        <version>0.3.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oauth2-server-core/pom.xml b/oauth2-server-core/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>kotlin-oauth2-server</artifactId>
         <groupId>nl.myndocs</groupId>
-        <version>0.2.2</version>
+        <version>0.3.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -21,7 +21,7 @@
         <dependency>
             <groupId>io.mockk</groupId>
             <artifactId>mockk</artifactId>
-            <version>1.8.6</version>
+            <version>1.8.12.kotlin13</version>
             <scope>test</scope>
         </dependency>
         <dependency>

diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/CallRouter.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/CallRouter.kt
@@ -1,17 +1,21 @@
 package nl.myndocs.oauth2
 
 import nl.myndocs.oauth2.authenticator.Authorizer
+import nl.myndocs.oauth2.client.AuthorizedGrantType.AUTHORIZATION_CODE
+import nl.myndocs.oauth2.client.AuthorizedGrantType.CLIENT_CREDENTIALS
+import nl.myndocs.oauth2.client.AuthorizedGrantType.PASSWORD
+import nl.myndocs.oauth2.client.AuthorizedGrantType.REFRESH_TOKEN
 import nl.myndocs.oauth2.exception.*
-import nl.myndocs.oauth2.identity.UserInfo
+import nl.myndocs.oauth2.identity.TokenInfo
 import nl.myndocs.oauth2.request.*
 import nl.myndocs.oauth2.token.toMap
 
 class CallRouter(
         private val tokenService: TokenService,
         val tokenEndpoint: String,
         val authorizeEndpoint: String,
-        val userInfoEndpoint: String,
-        private val userInfoCallback: (UserInfo) -> Map<String, Any?>
+        val tokenInfoEndpoint: String,
+        private val tokenInfoCallback: (TokenInfo) -> Map<String, Any?>
 ) {
     companion object {
         const val METHOD_POST = "post"
@@ -28,7 +32,7 @@ class CallRouter(
         when (callContext.path) {
             tokenEndpoint -> routeTokenEndpoint(callContext)
             authorizeEndpoint -> routeAuthorizeEndpoint(callContext, authorizer)
-            userInfoEndpoint -> routeUserInfoEndpoint(callContext)
+            tokenInfoEndpoint -> routeTokenInfoEndpoint(callContext)
         }
     }
 
@@ -38,7 +42,7 @@ class CallRouter(
         }
 
         try {
-            val allowedGrantTypes = setOf("password", "authorization_code", "refresh_token")
+            val allowedGrantTypes = setOf(PASSWORD, AUTHORIZATION_CODE, REFRESH_TOKEN, CLIENT_CREDENTIALS)
             val grantType = callContext.formParameters["grant_type"]
                     ?: throw InvalidRequestException("'grant_type' not given")
 
@@ -50,6 +54,7 @@ class CallRouter(
                 "password" -> routePasswordGrant(callContext, tokenService)
                 "authorization_code" -> routeAuthorizationCodeGrant(callContext, tokenService)
                 "refresh_token" -> routeRefreshTokenGrant(callContext, tokenService)
+                "client_credentials" -> routeClientCredentialsGrant(callContext, tokenService)
             }
         } catch (oauthException: OauthException) {
             callContext.respondStatus(STATUS_BAD_REQUEST)
@@ -71,6 +76,16 @@ class CallRouter(
         callContext.respondJson(tokenResponse.toMap())
     }
 
+    fun routeClientCredentialsGrant(callContext: CallContext, tokenService: TokenService) {
+        val tokenResponse = tokenService.authorize(ClientCredentialsRequest(
+            callContext.formParameters["client_id"],
+            callContext.formParameters["client_secret"],
+            callContext.formParameters["scope"]
+        ))
+
+        callContext.respondJson(tokenResponse.toMap())
+    }
+
     fun routeRefreshTokenGrant(callContext: CallContext, tokenService: TokenService) {
         val accessToken = tokenService.refresh(
                 RefreshTokenRequest(
@@ -193,7 +208,7 @@ class CallRouter(
         }
     }
 
-    private fun routeUserInfoEndpoint(callContext: CallContext) {
+    private fun routeTokenInfoEndpoint(callContext: CallContext) {
         if (callContext.method.toLowerCase() != METHOD_GET) {
             return
         }
@@ -207,8 +222,8 @@ class CallRouter(
 
         val token = authorization.substring(7)
 
-        val userInfoCallback = userInfoCallback(tokenService.userInfo(token))
+        val tokenInfoCallback = tokenInfoCallback(tokenService.tokenInfo(token))
 
-        callContext.respondJson(userInfoCallback)
+        callContext.respondJson(tokenInfoCallback)
     }
 }
diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/Oauth2TokenService.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/Oauth2TokenService.kt
@@ -8,7 +8,7 @@ import nl.myndocs.oauth2.client.ClientService
 import nl.myndocs.oauth2.exception.*
 import nl.myndocs.oauth2.identity.Identity
 import nl.myndocs.oauth2.identity.IdentityService
-import nl.myndocs.oauth2.identity.UserInfo
+import nl.myndocs.oauth2.identity.TokenInfo
 import nl.myndocs.oauth2.request.*
 import nl.myndocs.oauth2.response.TokenResponse
 import nl.myndocs.oauth2.scope.ScopeParser
@@ -119,6 +119,31 @@ class Oauth2TokenService(
         return accessToken.toTokenResponse()
     }
 
+    override fun authorize(clientCredentialsRequest: ClientCredentialsRequest): TokenResponse {
+        throwExceptionIfUnverifiedClient(clientCredentialsRequest)
+
+        val requestedClient = clientService.clientOf(clientCredentialsRequest.clientId!!) ?: throw InvalidClientException()
+
+        val scopes = clientCredentialsRequest.scope
+            ?.let { ScopeParser.parseScopes(it).toSet() }
+            ?: requestedClient.clientScopes
+
+        val accessToken = accessTokenConverter.convertToToken(
+            username = null,
+            clientId = clientCredentialsRequest.clientId,
+            requestedScopes = scopes,
+            refreshToken = refreshTokenConverter.convertToToken(
+                username = null,
+                clientId = clientCredentialsRequest.clientId,
+                requestedScopes = scopes
+            )
+        )
+
+        tokenStore.storeAccessToken(accessToken)
+
+        return accessToken.toTokenResponse()
+    }
+
     override fun refresh(refreshTokenRequest: RefreshTokenRequest): TokenResponse {
         throwExceptionIfUnverifiedClient(refreshTokenRequest)
 
@@ -143,7 +168,7 @@ class Oauth2TokenService(
                 refreshToken.username,
                 refreshToken.clientId,
                 refreshToken.scopes,
-                refreshToken
+                refreshTokenConverter.convertToToken(refreshToken)
         )
 
         tokenStore.storeAccessToken(accessToken)
@@ -290,13 +315,12 @@ class Oauth2TokenService(
         }
     }
 
-    override fun userInfo(accessToken: String): UserInfo {
+    override fun tokenInfo(accessToken: String): TokenInfo {
         val storedAccessToken = tokenStore.accessToken(accessToken) ?: throw InvalidGrantException()
         val client = clientService.clientOf(storedAccessToken.clientId) ?: throw InvalidClientException()
-        val identity = identityService.identityOf(client, storedAccessToken.username)
-                ?: throw InvalidIdentityException()
+        val identity = storedAccessToken.username?.let { identityService.identityOf(client, it) }
 
-        return UserInfo(
+        return TokenInfo(
                 identity,
                 client,
                 storedAccessToken.scopes

diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/TokenService.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/TokenService.kt
@@ -2,7 +2,7 @@ package nl.myndocs.oauth2
 
 import nl.myndocs.oauth2.authenticator.Authenticator
 import nl.myndocs.oauth2.authenticator.IdentityScopeVerifier
-import nl.myndocs.oauth2.identity.UserInfo
+import nl.myndocs.oauth2.identity.TokenInfo
 import nl.myndocs.oauth2.request.*
 import nl.myndocs.oauth2.response.TokenResponse
 import nl.myndocs.oauth2.token.AccessToken
@@ -13,6 +13,8 @@ interface TokenService {
 
     fun authorize(authorizationCodeRequest: AuthorizationCodeRequest): TokenResponse
 
+    fun authorize(clientCredentialsRequest: ClientCredentialsRequest): TokenResponse
+
     fun refresh(refreshTokenRequest: RefreshTokenRequest): TokenResponse
 
     fun redirect(
@@ -27,5 +29,5 @@ interface TokenService {
             identityScopeVerifier: IdentityScopeVerifier?
     ): AccessToken
 
-    fun userInfo(accessToken: String): UserInfo
+    fun tokenInfo(accessToken: String): TokenInfo
 }
diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/client/AuthorizedGrantType.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/client/AuthorizedGrantType.kt
@@ -5,4 +5,5 @@ object AuthorizedGrantType {
     const val REFRESH_TOKEN = "refresh_token"
     const val PASSWORD = "password"
     const val AUTHORIZATION_CODE = "authorization_code"
+    const val CLIENT_CREDENTIALS = "client_credentials"
 }
diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/config/CallRouterBuilder.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/config/CallRouterBuilder.kt
@@ -2,18 +2,18 @@ package nl.myndocs.oauth2.config
 
 import nl.myndocs.oauth2.CallRouter
 import nl.myndocs.oauth2.TokenService
-import nl.myndocs.oauth2.identity.UserInfo
+import nl.myndocs.oauth2.identity.TokenInfo
 
 internal object CallRouterBuilder {
     class Configuration {
         var tokenEndpoint: String = "/oauth/token"
         var authorizeEndpoint: String = "/oauth/authorize"
-        var userInfoEndpoint: String = "/oauth/userinfo"
-        var userInfoCallback: (UserInfo) -> Map<String, Any?> = { userInfo ->
+        var tokenInfoEndpoint: String = "/oauth/tokeninfo"
+        var tokenInfoCallback: (TokenInfo) -> Map<String, Any?> = { tokenInfo ->
             mapOf(
-                    "username" to userInfo.identity.username,
-                    "scopes" to userInfo.scopes
-            )
+                    "username" to tokenInfo.identity?.username,
+                    "scopes" to tokenInfo.scopes
+            ).filterValues { it != null }
         }
         var tokenService: TokenService? = null
     }
@@ -29,7 +29,7 @@ internal object CallRouterBuilder {
             configuration.tokenService!!,
             configuration.tokenEndpoint,
             configuration.authorizeEndpoint,
-            configuration.userInfoEndpoint,
-            configuration.userInfoCallback
+            configuration.tokenInfoEndpoint,
+            configuration.tokenInfoCallback
     )
 }
diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/config/ConfigurationBuilder.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/config/ConfigurationBuilder.kt
@@ -2,7 +2,7 @@ package nl.myndocs.oauth2.config
 
 import nl.myndocs.oauth2.TokenService
 import nl.myndocs.oauth2.authenticator.Authorizer
-import nl.myndocs.oauth2.identity.UserInfo
+import nl.myndocs.oauth2.identity.TokenInfo
 import nl.myndocs.oauth2.request.CallContext
 import nl.myndocs.oauth2.request.auth.BasicAuthorizer
 
@@ -28,16 +28,16 @@ object ConfigurationBuilder {
                 callRouterConfiguration.tokenEndpoint = value
             }
 
-        var userInfoEndpoint: String
-            get() = callRouterConfiguration.userInfoEndpoint
+        var tokenInfoEndpoint: String
+            get() = callRouterConfiguration.tokenInfoEndpoint
             set(value) {
-                callRouterConfiguration.userInfoEndpoint = value
+                callRouterConfiguration.tokenInfoEndpoint = value
             }
 
-        var userInfoCallback: (UserInfo) -> Map<String, Any?>
-            get() = callRouterConfiguration.userInfoCallback
+        var tokenInfoCallback: (TokenInfo) -> Map<String, Any?>
+            get() = callRouterConfiguration.tokenInfoCallback
             set(value) {
-                callRouterConfiguration.userInfoCallback = value
+                callRouterConfiguration.tokenInfoCallback = value
             }
 
         var authorizerFactory: (CallContext) -> Authorizer = ::BasicAuthorizer

diff --git a/...va/nl/myndocs/oauth2/identity/UserInfo.kt → ...a/nl/myndocs/oauth2/identity/TokenInfo.kt b/...va/nl/myndocs/oauth2/identity/UserInfo.kt → ...a/nl/myndocs/oauth2/identity/TokenInfo.kt
@@ -2,8 +2,8 @@ package nl.myndocs.oauth2.identity
 
 import nl.myndocs.oauth2.client.Client
 
-data class UserInfo(
-        val identity: Identity,
+data class TokenInfo(
+        val identity: Identity?,
         val client: Client,
         val scopes: Set<String>
 )
diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/request/ClientCredentialsRequest.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/request/ClientCredentialsRequest.kt
@@ -0,0 +1,9 @@
+package nl.myndocs.oauth2.request
+
+data class ClientCredentialsRequest(
+    override val clientId: String?,
+    override val clientSecret: String?,
+    val scope: String?
+) : ClientRequest{
+    val grant_type = "client_credentials"
+}
diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/token/AccessToken.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/token/AccessToken.kt
@@ -6,7 +6,7 @@ data class AccessToken(
         val accessToken: String,
         val tokenType: String,
         override val expireTime: Instant,
-        val username: String,
+        val username: String?,
         val clientId: String,
         val scopes: Set<String>,
         val refreshToken: RefreshToken?

diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/token/RefreshToken.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/token/RefreshToken.kt
@@ -5,7 +5,7 @@ import java.time.Instant
 data class RefreshToken(
         val refreshToken: String,
         override val expireTime: Instant,
-        val username: String,
+        val username: String?,
         val clientId: String,
         val scopes: Set<String>
 ) : ExpirableToken
diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/token/converter/AccessTokenConverter.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/token/converter/AccessTokenConverter.kt
@@ -4,5 +4,5 @@ import nl.myndocs.oauth2.token.AccessToken
 import nl.myndocs.oauth2.token.RefreshToken
 
 interface AccessTokenConverter {
-    fun convertToToken(username: String, clientId: String, requestedScopes: Set<String>, refreshToken: RefreshToken?): AccessToken
+    fun convertToToken(username: String?, clientId: String, requestedScopes: Set<String>, refreshToken: RefreshToken?): AccessToken
 }
diff --git a/oauth2-server-core/src/main/java/nl/myndocs/oauth2/token/converter/RefreshTokenConverter.kt b/oauth2-server-core/src/main/java/nl/myndocs/oauth2/token/converter/RefreshTokenConverter.kt
@@ -3,5 +3,7 @@ package nl.myndocs.oauth2.token.converter
 import nl.myndocs.oauth2.token.RefreshToken
 
 interface RefreshTokenConverter {
-    fun convertToToken(username: String, clientId: String, requestedScopes: Set<String>): RefreshToken
+    fun convertToToken(refreshToken: RefreshToken): RefreshToken = convertToToken(refreshToken.username, refreshToken.clientId, refreshToken.scopes)
+
+    fun convertToToken(username: String?, clientId: String, requestedScopes: Set<String>): RefreshToken
 }
diff --git a/...2-server-core/src/main/java/nl/myndocs/oauth2/token/converter/UUIDAccessTokenConverter.kt b/...2-server-core/src/main/java/nl/myndocs/oauth2/token/converter/UUIDAccessTokenConverter.kt
@@ -9,7 +9,7 @@ class UUIDAccessTokenConverter(
         private val accessTokenExpireInSeconds: Int = 3600
 ) : AccessTokenConverter {
 
-    override fun convertToToken(username: String, clientId: String, requestedScopes: Set<String>, refreshToken: RefreshToken?): AccessToken {
+    override fun convertToToken(username: String?, clientId: String, requestedScopes: Set<String>, refreshToken: RefreshToken?): AccessToken {
         return AccessToken(
                 UUID.randomUUID().toString(),
                 "bearer",

diff --git a/...-server-core/src/main/java/nl/myndocs/oauth2/token/converter/UUIDRefreshTokenConverter.kt b/...-server-core/src/main/java/nl/myndocs/oauth2/token/converter/UUIDRefreshTokenConverter.kt
@@ -7,7 +7,7 @@ import java.util.*
 class UUIDRefreshTokenConverter(
         private val refreshTokenExpireInSeconds: Int = 86400
 ) : RefreshTokenConverter {
-    override fun convertToToken(username: String, clientId: String, requestedScopes: Set<String>): RefreshToken {
+    override fun convertToToken(username: String?, clientId: String, requestedScopes: Set<String>): RefreshToken {
         return RefreshToken(
                 UUID.randomUUID().toString(),
                 Instant.now().plusSeconds(refreshTokenExpireInSeconds.toLong()),