Store scope and allow revoking of tokens

authorizer-app-backend/authorizer.yml

@@ -23,6 +23,7 @@ restSourceClients:
   - sourceType: FitBit
     authorizationEndpoint: https://www.fitbit.com/oauth2/authorize
     tokenEndpoint: https://api.fitbit.com/oauth2/token
+    deregistrationEndpoint: https://api.fitbit.com/oauth2/revoke
     clientId: <CLIENT_ID>
     clientSecret: <CLIENT_SECRET>
     scope: activity heartrate sleep profile

authorizer-app-backend/src/main/java/org/radarbase/authorizer/api/ApiDeclarations.kt

@@ -32,6 +32,8 @@ data class RestOauth2AccessToken(
     val tokenType: String? = null,
     @SerialName("user_id")
     val externalUserId: String? = null,
+    @SerialName("scope")
+    val scope: String? = null,
 )
 
 @Serializable
@@ -101,6 +103,7 @@ data class RequestTokenPayload(
     val oauth_token: String? = null,
     val oauth_verifier: String? = null,
     val oauth_token_secret: String? = null,
+    val scope: String? = null,
 )
 
 data class ShareableClientDetail(

authorizer-app-backend/src/main/java/org/radarbase/authorizer/doa/RestSourceUserRepositoryImpl.kt

@@ -78,6 +78,7 @@ class RestSourceUserRepositoryImpl(
             this.refreshToken = token.refreshToken
             this.expiresIn = token.expiresIn
             this.expiresAt = Instant.now().plusSeconds(token.expiresIn.toLong()) - expiryTimeMargin
+            this.scope = token.scope
         } else {
             this.externalUserId = null
             this.authorized = false

authorizer-app-backend/src/main/java/org/radarbase/authorizer/doa/entity/RestSourceUser.kt

@@ -108,6 +108,9 @@ class RestSourceUser(
     @Column(name = "times_reset")
     var timesReset: Long = 0,
 
+    @Column(name = "scope")
+    var scope: String? = null,
+
     @OneToMany(
         fetch = FetchType.EAGER,
         targetEntity = RegistrationState::class,

authorizer-app-backend/src/main/java/org/radarbase/authorizer/service/OAuth2RestSourceAuthorizationService.kt

@@ -81,16 +81,47 @@ open class OAuth2RestSourceAuthorizationService(
         }
     }
 
-    override suspend fun revokeToken(user: RestSourceUser): Boolean = withContext(Dispatchers.IO) {
+    override suspend fun revokeToken(user: RestSourceUser): Boolean {
         val accessToken = user.accessToken ?: run {
             logger.error("Cannot revoke token of user {} without an access token", user.userId)
-            return@withContext false
+            return false
         }
-        logger.info("Requesting to revoke access token")
-        val response = submitForm(user.sourceType) {
-            append("token", accessToken)
+        // revoke token using the deregistrationEndpoint token endpoint
+        val authConfig = clients.forSourceType(user.sourceType)
+        val deregistrationEndpoint = checkNotNull(authConfig.deregistrationEndpoint) { "Missing deregistration endpoint configuration" }
+
+        val isSuccess = try {
+            withContext(Dispatchers.IO) {
+                val response = httpClient.submitForm {
+                    url {
+                        takeFrom(deregistrationEndpoint)
+                        parameters.append("token", accessToken)
+                        parameters.append("client_id", authConfig.clientId!!)
+                    }
+                }
+                if (response.status.isSuccess()) {
+                    true
+                } else {
+                    logger.error(
+                        "Failed to revoke token for user {}: {}",
+                        user.userId,
+                        response.bodyAsText().take(512),
+                    )
+                    false
+                }
+            }
+        } catch (ex: Exception) {
+            logger.warn("Revoke endpoint error: {}", ex.toString())
+            false
+        }
+
+        return if (isSuccess) {
+            logger.info("Successfully revoked token for user {}", user.userId)
+            true
+        } else {
+            logger.error("Failed to revoke token for user {}", user.userId)
+            false
         }
-        response.status.isSuccess()
     }
 
     override suspend fun revokeToken(externalId: String, sourceType: String, token: String): Boolean =

authorizer-app-backend/src/main/resources/db/changelog/changes/00000000000004_add_scope_column.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<databaseChangeLog
+    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+                        https://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.10.xsd">
+
+    <changeSet author="pauline" id="addScope">
+        <addColumn tableName="rest_source_user">
+            <column name="scope" type="varchar(200)" defaultValue="null" value="null">
+                <constraints nullable="true" />
+            </column>
+        </addColumn>
+    </changeSet>
+</databaseChangeLog>

docker/etc/rest-source-authorizer/authorizer.yml

@@ -26,6 +26,7 @@ restSourceClients:
   - sourceType: FitBit
     authorizationEndpoint: https://www.fitbit.com/oauth2/authorize
     tokenEndpoint: https://api.fitbit.com/oauth2/token
+    deregistrationEndpoint: https://api.fitbit.com/oauth2/revoke
     clientId: Fitbit-clientid
     clientSecret: Fitbit-clientsecret
     scope: activity heartrate sleep profile

docker/etc/rest-source-authorizer/authorizer.yml.template

@@ -30,6 +30,7 @@ restSourceClients:
   - sourceType: FitBit
     authorizationEndpoint: https://www.fitbit.com/oauth2/authorize
     tokenEndpoint: https://api.fitbit.com/oauth2/token
+    deregistrationEndpoint: https://api.fitbit.com/oauth2/revoke
     clientId: Fitbit-clientid
     clientSecret: Fitbit-clientsecret
     scope: activity heartrate sleep profile