Ticket #24932: oauth-remove-token.patch

src/org/openstreetmap/josm/io/auth/JosmPreferencesCredentialAgent.java

@@ -134 +134 @@
             keySet.addAll(Config.getPref().getSensitive()); // Just in case we decide to not return sensitive keys in getKeySet
             // Assume we want to remove all access tokens
             for (OAuthVersion oauthType : OAuthVersion.values()) {
-                final String hostKey = "oauth.access-token.parameters." + oauthType + "." + host;
+                final String hostKey = "oauth.access-token.object." + oauthType + "." + host;
                 final String parametersKey = "oauth.access-token.parameters." + oauthType + "." + host;
                 if (keySet.contains(hostKey)) {
                     Config.getPref().removeSensitive(hostKey);

test/unit/org/openstreetmap/josm/io/auth/JosmPreferencesCredentialAgentTest.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.io.auth;
 
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+import org.junit.jupiter.api.Test;
+import org.openstreetmap.josm.data.oauth.OAuth20Exception;
+import org.openstreetmap.josm.data.oauth.OAuth20Parameters;
+import org.openstreetmap.josm.data.oauth.OAuth20Token;
+import org.openstreetmap.josm.spi.preferences.Config;
+import org.openstreetmap.josm.testutils.annotations.BasicPreferences;
 import org.openstreetmap.josm.testutils.annotations.HTTP;
 
 /**
@@ -13 +23 @@
     public JosmPreferencesCredentialAgent createAgent() {
         return new JosmPreferencesCredentialAgent();
     }
+
+    /**
+     * Removing an OAuth token removes it from the preferences, not only the parameters stored with it.
+     * <p>
+     * Non-regression test: both keys were built with the {@code parameters} prefix, so the token itself stayed in the
+     * preferences in clear text. {@link CredentialsAgentTest#testLookupAndStoreOAuthTokens} did not notice, because a
+     * lookup needs both keys and so already fails once the parameters are gone.
+     * @throws CredentialsAgentException if the token cannot be stored or removed
+     * @throws OAuth20Exception if the token cannot be built
+     */
+    @Test
+    @BasicPreferences
+    void testRemoveOAuthTokenRemovesItFromThePreferences() throws CredentialsAgentException, OAuth20Exception {
+        final String host = "example.org";
+        final String tokenKey = "oauth.access-token.object.OAuth20." + host;
+        final String parametersKey = "oauth.access-token.parameters.OAuth20." + host;
+        final JosmPreferencesCredentialAgent agent = createAgent();
+        agent.storeOAuthAccessToken(host, new OAuth20Token(new OAuth20Parameters("clientId", null,
+                "https://example.org/api", "https://example.org/api", "http://127.0.0.1:8111/oauth_authorization"),
+                "{\"access_token\": \"a-secret-token\", \"token_type\": \"bearer\"}"));
+        assertNotNull(Config.getPref().get(tokenKey, null));
+        assertNotNull(Config.getPref().get(parametersKey, null));
+
+        agent.storeOAuthAccessToken(host, null);
+
+        assertNull(Config.getPref().get(tokenKey, null), "the token is still stored in the preferences");
+        assertNull(Config.getPref().get(parametersKey, null));
+        assertFalse(Config.getPref().getSensitive().contains(tokenKey));
+        assertFalse(Config.getPref().getSensitive().contains(parametersKey));
+    }
 }