From df6ad009b1652f23434c121cc35b3fe45d39005b Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 19:01:44 +0100 Subject: [PATCH 01/83] Fix logging placeholder mismatch --- .../src/main/java/org/jabref/http/manager/HttpServerThread.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java b/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java index bafae3697c13..1903fdbecf0e 100644 --- a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java +++ b/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java @@ -35,7 +35,7 @@ public void run() { try { httpServer = this.server.run(srvStateManager, uri); } catch (ProcessingException e) { - LOGGER.error("Failed to start HTTP server thread: {}", e); + LOGGER.error("Failed to start HTTP server thread", e); } } From 5cd62cae378169e57778d746fdb9d395b85e30c9 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 19:01:59 +0100 Subject: [PATCH 02/83] Remove wrong empty line --- versions/build.gradle.kts | 1 - 1 file changed, 1 deletion(-) diff --git a/versions/build.gradle.kts b/versions/build.gradle.kts index 2392852619ba..57224be8ad37 100644 --- a/versions/build.gradle.kts +++ b/versions/build.gradle.kts @@ -32,7 +32,6 @@ dependencies { api("org.junit.jupiter:junit-jupiter") api("org.junit.platform:junit-platform-launcher") - api(platform("org.glassfish.grizzly:grizzly-bom:4.0.2")) api("org.glassfish.grizzly:grizzly-framework") api("org.glassfish.grizzly:grizzly-http-server") From 801d18e90f32b4b5e31521dc47a850f31eae75a1 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 19:03:32 +0100 Subject: [PATCH 03/83] Fix wrong space --- jabsrv/src/main/java/org/jabref/http/server/Server.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jabsrv/src/main/java/org/jabref/http/server/Server.java b/jabsrv/src/main/java/org/jabref/http/server/Server.java index 724a03e0ced4..33332ad3c17a 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/Server.java +++ b/jabsrv/src/main/java/org/jabref/http/server/Server.java @@ -76,7 +76,7 @@ public HttpServer run(List files, URI uri) { return httpServer; } - /// Entry point for the GUI + /// Entry point for the GUI public HttpServer run(SrvStateManager srvStateManager, URI uri) { FilesToServe filesToServe = new FilesToServe(); From c03e26945ebebb78f632c97c153f57ae8daac714 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 19:08:59 +0100 Subject: [PATCH 04/83] Route prefernces through --- jabgui/src/main/java/org/jabref/gui/JabRefGUI.java | 2 +- .../gui/preferences/general/GeneralTabViewModel.java | 2 +- .../main/java/org/jabref/http/server/cli/ServerCli.java | 2 +- .../java/org/jabref/http/manager/HttpServerManager.java | 5 +++-- .../java/org/jabref/http/manager/HttpServerThread.java | 5 +++-- .../java/org/jabref/http/server/PreferencesFactory.java | 9 ++++++++- jabsrv/src/main/java/org/jabref/http/server/Server.java | 8 +++++++- 7 files changed, 24 insertions(+), 9 deletions(-) diff --git a/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java b/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java index 1cf0ea126956..16d8c8d81c78 100644 --- a/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java +++ b/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java @@ -438,7 +438,7 @@ public void startBackgroundTasks() { } if (remotePreferences.enableHttpServer()) { - httpServerManager.start(stateManager, remotePreferences.getHttpServerUri()); + httpServerManager.start(preferences, stateManager, remotePreferences.getHttpServerUri()); } if (remotePreferences.enableLanguageServer()) { languageServerController.start(cliMessageHandler, remotePreferences.getLanguageServerPort()); diff --git a/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java b/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java index 967e54aa9e70..d5369563abd4 100644 --- a/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java +++ b/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java @@ -316,7 +316,7 @@ public void storeSettings() { if (enableHttpServerProperty.getValue()) { remotePreferences.setEnableHttpServer(true); URI uri = remotePreferences.getHttpServerUri(); - httpServerManager.start(stateManager, uri); + httpServerManager.start(preferences, stateManager, uri); } else { remotePreferences.setEnableHttpServer(false); httpServerManager.stop(); diff --git a/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java b/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java index 9d0cc50087dd..c43fb4fa8ff6 100644 --- a/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java +++ b/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java @@ -76,7 +76,7 @@ public Void call() throws InterruptedException { return null; } - Server server = new Server(); + Server server = new Server(JabRefCliPreferences.getInstance()); HttpServer httpServer = server.run(filesToServe, uri); // Keep the http server running until user kills the process (e.g., presses Ctrl+C) diff --git a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerManager.java b/jabsrv/src/main/java/org/jabref/http/manager/HttpServerManager.java index ba6ba127c42d..d9514c4533bc 100644 --- a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerManager.java +++ b/jabsrv/src/main/java/org/jabref/http/manager/HttpServerManager.java @@ -3,6 +3,7 @@ import java.net.URI; import org.jabref.http.SrvStateManager; +import org.jabref.logic.preferences.CliPreferences; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -19,13 +20,13 @@ public class HttpServerManager implements AutoCloseable { private HttpServerThread httpServerThread; - public synchronized void start(SrvStateManager srvStateManager, URI uri) { + public synchronized void start(CliPreferences preferences, SrvStateManager srvStateManager, URI uri) { if (httpServerThread != null) { LOGGER.warn("HTTP server manager already started, cannot start again."); return; } - httpServerThread = new HttpServerThread(srvStateManager, uri); + httpServerThread = new HttpServerThread(preferences, srvStateManager, uri); // This enqueues the thread to run in the background // The JVM will take care of running it at some point in time in the future // Thus, we cannot check directly if it really runs diff --git a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java b/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java index 1903fdbecf0e..b59a012d8786 100644 --- a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java +++ b/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java @@ -4,6 +4,7 @@ import org.jabref.http.SrvStateManager; import org.jabref.http.server.Server; +import org.jabref.logic.preferences.CliPreferences; import jakarta.ws.rs.ProcessingException; import org.glassfish.grizzly.http.server.HttpServer; @@ -23,10 +24,10 @@ public class HttpServerThread extends Thread { private HttpServer httpServer; - public HttpServerThread(SrvStateManager srvStateManager, URI uri) { + public HttpServerThread(CliPreferences cliPreferences, SrvStateManager srvStateManager, URI uri) { this.srvStateManager = srvStateManager; this.uri = uri; - this.server = new Server(); + this.server = new Server(cliPreferences); this.setName("JabSrv - JabRef HTTP Server on " + uri.getHost() + ":" + uri.getPort()); } diff --git a/jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java b/jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java index aadac431462f..19f3c7903614 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java +++ b/jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java @@ -6,9 +6,16 @@ import org.glassfish.hk2.api.Factory; public class PreferencesFactory implements Factory { + + private final CliPreferences preferences; + + public PreferencesFactory(CliPreferences preferences) { + this.preferences = preferences; + } + @Override public CliPreferences provide() { - return JabRefCliPreferences.getInstance(); + return preferences; } @Override diff --git a/jabsrv/src/main/java/org/jabref/http/server/Server.java b/jabsrv/src/main/java/org/jabref/http/server/Server.java index 33332ad3c17a..d6584065afbc 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/Server.java +++ b/jabsrv/src/main/java/org/jabref/http/server/Server.java @@ -20,6 +20,7 @@ import org.jabref.http.server.resources.RootResource; import org.jabref.http.server.services.FilesToServe; import org.jabref.logic.os.OS; +import org.jabref.logic.preferences.CliPreferences; import net.harawata.appdirs.AppDirsFactory; import org.glassfish.grizzly.http.server.HttpServer; @@ -34,6 +35,11 @@ public class Server { private static final Logger LOGGER = LoggerFactory.getLogger(Server.class); + private final CliPreferences preferences; + + public Server(CliPreferences preferences) { + this.preferences = preferences; + } /// Entry point for the CLI public HttpServer run(List files, URI uri) { @@ -90,7 +96,7 @@ public HttpServer run(SrvStateManager srvStateManager, URI uri) { private HttpServer startServer(ServiceLocator serviceLocator, URI uri) { ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new GsonFactory()); ServiceLocatorUtilities.addOneConstant(serviceLocator, new FormatterService()); - ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new PreferencesFactory()); + ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new PreferencesFactory(preferences)); // see https://stackoverflow.com/a/33794265/873282 final ResourceConfig resourceConfig = new ResourceConfig(); From cd79986d374bfe8ebd5fe94d1de0b15350801b45 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 19:19:19 +0100 Subject: [PATCH 05/83] Use OneConstant instead of Factor for preferences --- .../http/server/PreferencesFactory.java | 24 ------------------- .../java/org/jabref/http/server/Server.java | 4 ++-- 2 files changed, 2 insertions(+), 26 deletions(-) delete mode 100644 jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java diff --git a/jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java b/jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java deleted file mode 100644 index 19f3c7903614..000000000000 --- a/jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java +++ /dev/null @@ -1,24 +0,0 @@ -package org.jabref.http.server; - -import org.jabref.logic.preferences.CliPreferences; -import org.jabref.logic.preferences.JabRefCliPreferences; - -import org.glassfish.hk2.api.Factory; - -public class PreferencesFactory implements Factory { - - private final CliPreferences preferences; - - public PreferencesFactory(CliPreferences preferences) { - this.preferences = preferences; - } - - @Override - public CliPreferences provide() { - return preferences; - } - - @Override - public void dispose(CliPreferences instance) { - } -} diff --git a/jabsrv/src/main/java/org/jabref/http/server/Server.java b/jabsrv/src/main/java/org/jabref/http/server/Server.java index d6584065afbc..f75c5e4bb030 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/Server.java +++ b/jabsrv/src/main/java/org/jabref/http/server/Server.java @@ -94,9 +94,9 @@ public HttpServer run(SrvStateManager srvStateManager, URI uri) { } private HttpServer startServer(ServiceLocator serviceLocator, URI uri) { - ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new GsonFactory()); ServiceLocatorUtilities.addOneConstant(serviceLocator, new FormatterService()); - ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new PreferencesFactory(preferences)); + ServiceLocatorUtilities.addOneConstant(serviceLocator, preferences); + ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new GsonFactory()); // see https://stackoverflow.com/a/33794265/873282 final ResourceConfig resourceConfig = new ResourceConfig(); From fdf7e015e8c47acc89c874121d16d70588ffc14f Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 19:28:13 +0100 Subject: [PATCH 06/83] Remove obsolete file --- .jbang/JabSrvLauncher.java | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.jbang/JabSrvLauncher.java b/.jbang/JabSrvLauncher.java index 0e816bb93074..a35c96fa8b23 100755 --- a/.jbang/JabSrvLauncher.java +++ b/.jbang/JabSrvLauncher.java @@ -39,7 +39,7 @@ //DEPS org.jabref:afterburner.fx:2.0.0 //DEPS net.harawata:appdirs:1.5.0 //DEPS de.undercouch:citeproc-java:3.4.0 -//DEPS com.github.ben-manes.caffeine:caffeine:3.2.3 +//DEPS com.github.ben-manes.caffeine:caffeine:3.2.3 //DEPS tools.jackson.core:jackson-core:3.0.3 //DEPS tools.jackson.core:jackson-databind:3.0.3 //DEPS tools.jackson.dataformat:jackson-dataformat-yaml:3.0.3 @@ -78,7 +78,6 @@ //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/services/FilesToServe.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/services/ServerUtils.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/CORSFilter.java -//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/PreferencesFactory.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/Server.java //FILES tinylog.properties=../jabsrv-cli/src/main/resources/tinylog.properties From 809371a35ab76b3e49aade0dd96e479ccfc49ca9 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 22:05:55 +0100 Subject: [PATCH 07/83] First OAuth2 flow --- ...ef.gradle.base.dependency-rules.gradle.kts | 26 ++++ jabgui/build.gradle.kts | 4 + jabgui/src/main/java/module-info.java | 5 + .../gui/citedrive/CiteDriveOAuthService.java | 121 ++++++++++++++++++ .../java/org/jabref/gui/citedrive/Tokens.java | 10 ++ .../citedrive/CiteDriveOAuthServiceTest.java | 28 ++++ jablib/src/main/java/module-info.java | 1 + .../logic/citedrive/OAuthSessionRegistry.java | 39 ++++++ .../org/jabref/http/server/cli/ServerCli.java | 4 +- .../jabref/http/manager/HttpServerThread.java | 4 +- .../java/org/jabref/http/server/Server.java | 9 +- .../org/jabref/http/server/oauth/OAuth.java | 46 +++++++ versions/build.gradle.kts | 2 + 13 files changed, 295 insertions(+), 4 deletions(-) create mode 100644 jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java create mode 100644 jabgui/src/main/java/org/jabref/gui/citedrive/Tokens.java create mode 100644 jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java create mode 100644 jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java create mode 100644 jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java diff --git a/build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts b/build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts index 8bbd7790b810..adf7a7d973dd 100644 --- a/build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts +++ b/build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts @@ -146,6 +146,32 @@ extraJavaModuleInfo { uses("kong.unirest.core.json.JsonEngine") } module("com.konghq:unirest-modules-gson", "unirest.modules.gson") + + // region nimbusdl + // required by nimbusdl + module("com.github.stephenc.jcip:jcip-annotations", "jcip.annotations") { + exportAllPackages() + } + module("net.minidev:json-smart", "json.smart") { + exportAllPackages() + } + module("com.nimbusds:content-type", "nimbusds.contenttype") { + overrideModuleName() + exportAllPackages() + } + module("com.nimbusds:lang-tag", "nimbusds.langtag") { + overrideModuleName() + exportAllPackages() + } + module("com.nimbusds:oauth2-oidc-sdk", "nimbusds.oauth2.oidc.sdk") { + overrideModuleName() + exportAllPackages() + requires("nimbusds.contenttype") + requires("nimbusds.langtag") + requires("json.smart") + } + // endregion + module("com.squareup.okhttp3:okhttp", "okhttp3") module("com.squareup.okhttp3:okhttp-jvm", "okhttp3") module("com.squareup.okhttp3:okhttp-jvm-sse", "okhttp3.sse") diff --git a/jabgui/build.gradle.kts b/jabgui/build.gradle.kts index a10967291ccf..3fd50bfc14a1 100644 --- a/jabgui/build.gradle.kts +++ b/jabgui/build.gradle.kts @@ -104,6 +104,10 @@ dependencies { implementation("de.undercouch:citeproc-java") + // OAuth2 for CiteDrive + implementation("com.nimbusds:oauth2-oidc-sdk") + implementation("net.minidev:json-smart") + testImplementation(project(":test-support")) testImplementation("io.github.classgraph:classgraph") diff --git a/jabgui/src/main/java/module-info.java b/jabgui/src/main/java/module-info.java index 6d93abd9fef8..256b9b26cd9b 100644 --- a/jabgui/src/main/java/module-info.java +++ b/jabgui/src/main/java/module-info.java @@ -179,6 +179,11 @@ requires transitive org.jspecify; requires io.github.adr; + // region nimbusds / OAuth2 + requires nimbusds.oauth2.oidc.sdk; + requires json.smart; + // endregion + // region: other libraries (alphabetically) // requires cuid; requires com.dlsc.pdfviewfx; diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java new file mode 100644 index 000000000000..6c551eb6f18d --- /dev/null +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -0,0 +1,121 @@ +package org.jabref.gui.citedrive; + +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.CompletableFuture; + +import org.jabref.gui.frame.ExternalApplicationsPreferences; +import org.jabref.logic.citedrive.OAuthSessionRegistry; +import org.jabref.logic.remote.RemotePreferences; + +import com.nimbusds.oauth2.sdk.AccessTokenResponse; +import com.nimbusds.oauth2.sdk.AuthorizationCode; +import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; +import com.nimbusds.oauth2.sdk.AuthorizationGrant; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.TokenErrorResponse; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.id.ClientID; +import com.nimbusds.oauth2.sdk.id.State; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.oauth2.sdk.token.RefreshToken; +import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import org.jspecify.annotations.NonNull; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class CiteDriveOAuthService { + + private static final Logger LOGGER = LoggerFactory.getLogger(CiteDriveOAuthService.class); + + private static final ClientID CLIENT_ID = new ClientID("jabref-desktop"); + private static final Scope SCOPE_WRITE = new Scope("write"); + + private static final URI AUTH_ENDPOINT; + private static final URI TOKEN_ENDPOINT; + + private final ExternalApplicationsPreferences externalApplicationsPreferences; + private final RemotePreferences remotePreferences; + private final OAuthSessionRegistry sessionRegistry; + + static { + try { + AUTH_ENDPOINT = new URI("https://api-dev.citedrive.com/jabref/login/"); + TOKEN_ENDPOINT = new URI("https://api-dev.citedrive.com/o/token/"); + } catch (URISyntaxException e) { + throw new RuntimeException(e); + } + } + + public CiteDriveOAuthService( + ExternalApplicationsPreferences externalApplicationsPreferences, + RemotePreferences remotePreferences, + OAuthSessionRegistry sessionRegistry) { + this.externalApplicationsPreferences = externalApplicationsPreferences; + this.remotePreferences = remotePreferences; + this.sessionRegistry = sessionRegistry; + } + + public CompletableFuture> authorizeInteractive() { + String state = UUID.randomUUID().toString(); + CompletableFuture codeFuture = sessionRegistry.register(state); + + URI authUrl = buildAuthUrl(state); + try { + org.jabref.gui.desktop.os.NativeDesktop.openBrowser(authUrl, externalApplicationsPreferences); + } catch (IOException e) { + LOGGER.error("Could not open browser", e); + return CompletableFuture.failedFuture(e); + } + + return codeFuture.thenApply(code -> exchangeCodeForToken(code)); + } + + private URI buildAuthUrl(String state) { + return new AuthenticationRequest.Builder( + new ResponseType(ResponseType.Value.CODE), + SCOPE_WRITE, + CLIENT_ID, + getCallBackUri()) + .endpointURI(AUTH_ENDPOINT) + .state(new State(state)) + .build() + .toURI(); + } + + private @NonNull URI getCallBackUri() { + // The endpoint is at [org.jabref.http.server.oauth.OAuth.citeDriveCallback] + return remotePreferences.getHttpServerUri().resolve("/oauth/citedrive"); + } + + private Optional exchangeCodeForToken(String code) { + AuthorizationCode authCode = new AuthorizationCode(code); + AuthorizationGrant codeGrant = new AuthorizationCodeGrant(authCode, getCallBackUri()); + TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, codeGrant, SCOPE_WRITE); + TokenResponse response; + try { + response = TokenResponse.parse(request.toHTTPRequest().send()); + } catch (ParseException e) { + LOGGER.error("Could not parse response", e); + return Optional.empty(); + } catch (IOException e) { + LOGGER.error("I/O error", e); + return Optional.empty(); + } + if (!response.indicatesSuccess()) { + TokenErrorResponse errorResponse = response.toErrorResponse(); + LOGGER.error("Could not receive token {}", errorResponse); + return Optional.empty(); + } + AccessTokenResponse successResponse = response.toSuccessResponse(); + AccessToken accessToken = successResponse.getTokens().getAccessToken(); + RefreshToken refreshToken = successResponse.getTokens().getRefreshToken(); + return Optional.of(new Tokens(accessToken, refreshToken)); + } +} diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/Tokens.java b/jabgui/src/main/java/org/jabref/gui/citedrive/Tokens.java new file mode 100644 index 000000000000..45a51024ce3b --- /dev/null +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/Tokens.java @@ -0,0 +1,10 @@ +package org.jabref.gui.citedrive; + +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.oauth2.sdk.token.RefreshToken; + +public record Tokens( + AccessToken accessToken, + RefreshToken refreshToken +) { +} diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java new file mode 100644 index 000000000000..38ae10a1032a --- /dev/null +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java @@ -0,0 +1,28 @@ +package org.jabref.gui.citedrive; + +import java.net.URI; + +import org.jabref.gui.frame.ExternalApplicationsPreferences; +import org.jabref.logic.citedrive.OAuthSessionRegistry; +import org.jabref.logic.remote.RemotePreferences; + +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +class CiteDriveOAuthServiceTest { + + @Test + // @Disabled + void getToken() { + ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); + RemotePreferences remotePreferences = mock(RemotePreferences.class); + when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); + OAuthSessionRegistry oAuthSessionRegistry = new OAuthSessionRegistry(); + CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, oAuthSessionRegistry); + citeDriveOAuthService.authorizeInteractive(); + } +} diff --git a/jablib/src/main/java/module-info.java b/jablib/src/main/java/module-info.java index 0815aa33750b..a6bf37c27ee9 100644 --- a/jablib/src/main/java/module-info.java +++ b/jablib/src/main/java/module-info.java @@ -121,6 +121,7 @@ exports org.jabref.logic.git.merge.execution; exports org.jabref.model.sciteTallies; exports org.jabref.logic.bibtex.comparator.plausibility; + exports org.jabref.logic.citedrive; requires java.base; diff --git a/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java b/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java new file mode 100644 index 000000000000..ccd03f1e5d98 --- /dev/null +++ b/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java @@ -0,0 +1,39 @@ +package org.jabref.logic.citedrive; + +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class OAuthSessionRegistry { + + private static final Logger LOGGER = LoggerFactory.getLogger(OAuthSessionRegistry.class); + + private final Map> pending = new ConcurrentHashMap<>(); + + public CompletableFuture register(String state) { + var future = new CompletableFuture(); + pending.put(state, future); + return future; + } + + public void complete(String state, String code) { + var future = pending.remove(state); + if (future != null) { + future.complete(code); + } else { + LOGGER.warn("No pending OAuth session for state {}", state); + } + } + + public void fail(String state, Throwable t) { + var future = pending.remove(state); + if (future != null) { + future.completeExceptionally(t); + } else { + LOGGER.warn("No pending OAuth session for state {} (fail)", state); + } + } +} diff --git a/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java b/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java index c43fb4fa8ff6..d358b1d1b298 100644 --- a/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java +++ b/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java @@ -10,6 +10,7 @@ import org.jabref.architecture.AllowedToUseStandardStreams; import org.jabref.http.server.Server; +import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.preferences.JabRefCliPreferences; import org.glassfish.grizzly.http.server.HttpServer; @@ -76,7 +77,8 @@ public Void call() throws InterruptedException { return null; } - Server server = new Server(JabRefCliPreferences.getInstance()); + // TODO: Fix parameter + Server server = new Server(JabRefCliPreferences.getInstance(), new OAuthSessionRegistry()); HttpServer httpServer = server.run(filesToServe, uri); // Keep the http server running until user kills the process (e.g., presses Ctrl+C) diff --git a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java b/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java index b59a012d8786..c97860ca4c18 100644 --- a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java +++ b/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java @@ -4,6 +4,7 @@ import org.jabref.http.SrvStateManager; import org.jabref.http.server.Server; +import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.preferences.CliPreferences; import jakarta.ws.rs.ProcessingException; @@ -27,7 +28,8 @@ public class HttpServerThread extends Thread { public HttpServerThread(CliPreferences cliPreferences, SrvStateManager srvStateManager, URI uri) { this.srvStateManager = srvStateManager; this.uri = uri; - this.server = new Server(cliPreferences); + // TODO: Fix params + this.server = new Server(cliPreferences, new OAuthSessionRegistry()); this.setName("JabSrv - JabRef HTTP Server on " + uri.getHost() + ":" + uri.getPort()); } diff --git a/jabsrv/src/main/java/org/jabref/http/server/Server.java b/jabsrv/src/main/java/org/jabref/http/server/Server.java index f75c5e4bb030..3ca4af0e6f44 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/Server.java +++ b/jabsrv/src/main/java/org/jabref/http/server/Server.java @@ -14,11 +14,13 @@ import org.jabref.http.server.cayw.CAYWResource; import org.jabref.http.server.cayw.format.FormatterService; import org.jabref.http.server.command.CommandResource; +import org.jabref.http.server.oauth.OAuth; import org.jabref.http.server.resources.LibrariesResource; import org.jabref.http.server.resources.LibraryResource; import org.jabref.http.server.resources.MapResource; import org.jabref.http.server.resources.RootResource; import org.jabref.http.server.services.FilesToServe; +import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.os.OS; import org.jabref.logic.preferences.CliPreferences; @@ -36,9 +38,11 @@ public class Server { private static final Logger LOGGER = LoggerFactory.getLogger(Server.class); private final CliPreferences preferences; + private final OAuthSessionRegistry oAuthSessionRegistry; - public Server(CliPreferences preferences) { + public Server(CliPreferences preferences, OAuthSessionRegistry oAuthSessionRegistry) { this.preferences = preferences; + this.oAuthSessionRegistry = oAuthSessionRegistry; } /// Entry point for the CLI @@ -110,8 +114,9 @@ private HttpServer startServer(ServiceLocator serviceLocator, URI uri) { resourceConfig.register(MapResource.class); // Other resources - resourceConfig.register(CommandResource.class); resourceConfig.register(CAYWResource.class); + resourceConfig.register(OAuth.class); + resourceConfig.register(CommandResource.class); // Supporting classes resourceConfig.register(CORSFilter.class); diff --git a/jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java b/jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java new file mode 100644 index 000000000000..14c0fb4934b2 --- /dev/null +++ b/jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java @@ -0,0 +1,46 @@ +package org.jabref.http.server.oauth; + +import org.jabref.logic.citedrive.OAuthSessionRegistry; + +import jakarta.inject.Inject; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; +import jakarta.ws.rs.QueryParam; +import jakarta.ws.rs.core.MediaType; +import jakarta.ws.rs.core.Response; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Path("/oauth") +public class OAuth { + + private static final Logger LOGGER = LoggerFactory.getLogger(OAuth.class); + + @Inject + OAuthSessionRegistry sessionRegistry; + + @GET + @Path("/citedrive") + @Produces(MediaType.TEXT_HTML) + public Response citeDriveCallback(@QueryParam("code") String code, + @QueryParam("state") String state, + @QueryParam("error") String error) { + if (error != null && !error.isBlank()) { + LOGGER.warn("CiteDrive OAuth error: {} (state={})", error, state); + sessionRegistry.fail(state, new IllegalStateException("OAuth error: " + error)); + return Response.serverError().entity("Authorization failed. You can close this window.").build(); + } + + if (code == null || state == null) { + LOGGER.warn("Missing code or state in CiteDrive callback: code={}, state={}", code, state); + sessionRegistry.fail(state, new IllegalStateException("Missing code or state")); + return Response.serverError().entity("Missing information. You can close this window.").build(); + } + + LOGGER.debug("Received CiteDrive callback: state={}, code={}", state, code); + sessionRegistry.complete(state, code); + + return Response.ok("Authorization successful. You can close this window.").build(); + } +} diff --git a/versions/build.gradle.kts b/versions/build.gradle.kts index 57224be8ad37..895ebd51ea0e 100644 --- a/versions/build.gradle.kts +++ b/versions/build.gradle.kts @@ -79,6 +79,7 @@ dependencies.constraints { api("com.h2database:h2-mvstore:2.3.232") api("com.konghq:unirest-java-core:4.5.1") api("com.konghq:unirest-modules-gson:4.5.1") + api("com.nimbusds:oauth2-oidc-sdk:11.30.1") api("com.pixelduke:fxthemes:1.6.0") api("com.squareup.okhttp3:okhttp:5.1.0") api("com.squareup.okio:okio-jvm:3.16.0") @@ -116,6 +117,7 @@ dependencies.constraints { api("net.java.dev.jna:jna-platform:5.18.1") api("net.ltgt.errorprone:net.ltgt.errorprone.gradle.plugin:4.3.0") api("net.ltgt.nullaway:nullaway:2.3.0") + api("net.minidev:json-smart:2.6.0") api("org.antlr:antlr4-runtime:4.13.2") api("org.antlr:antlr4:4.13.2") api("org.apache.commons:commons-csv:1.14.0") From 1cd243b74a86ecf3991a62592eebb5dcf7020fca Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 23:10:17 +0100 Subject: [PATCH 08/83] Change scope to make lib happy --- .../org/jabref/gui/citedrive/CiteDriveOAuthService.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index 6c551eb6f18d..f3f51dea21db 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -26,6 +26,7 @@ import com.nimbusds.oauth2.sdk.token.AccessToken; import com.nimbusds.oauth2.sdk.token.RefreshToken; import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import com.nimbusds.openid.connect.sdk.OIDCScopeValue; import org.jspecify.annotations.NonNull; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -35,7 +36,7 @@ public class CiteDriveOAuthService { private static final Logger LOGGER = LoggerFactory.getLogger(CiteDriveOAuthService.class); private static final ClientID CLIENT_ID = new ClientID("jabref-desktop"); - private static final Scope SCOPE_WRITE = new Scope("write"); + private static final Scope SCOPE = new Scope(OIDCScopeValue.OPENID); private static final URI AUTH_ENDPOINT; private static final URI TOKEN_ENDPOINT; @@ -80,7 +81,7 @@ public CompletableFuture> authorizeInteractive() { private URI buildAuthUrl(String state) { return new AuthenticationRequest.Builder( new ResponseType(ResponseType.Value.CODE), - SCOPE_WRITE, + SCOPE, CLIENT_ID, getCallBackUri()) .endpointURI(AUTH_ENDPOINT) @@ -97,7 +98,7 @@ private URI buildAuthUrl(String state) { private Optional exchangeCodeForToken(String code) { AuthorizationCode authCode = new AuthorizationCode(code); AuthorizationGrant codeGrant = new AuthorizationCodeGrant(authCode, getCallBackUri()); - TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, codeGrant, SCOPE_WRITE); + TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, codeGrant, SCOPE); TokenResponse response; try { response = TokenResponse.parse(request.toHTTPRequest().send()); From 05df76e54454e71f2de92ac744eb05c0e0ac51ca Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 23:10:36 +0100 Subject: [PATCH 09/83] Add initial check for token --- .../citedrive/CiteDriveOAuthServiceTest.java | 42 +++++++++++++++++-- 1 file changed, 38 insertions(+), 4 deletions(-) diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java index 38ae10a1032a..09ba1eda2ffe 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java @@ -1,28 +1,62 @@ package org.jabref.gui.citedrive; import java.net.URI; +import java.util.Optional; +import java.util.TreeSet; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; +import javafx.collections.FXCollections; + +import org.jabref.gui.externalfiletype.ExternalFileTypes; import org.jabref.gui.frame.ExternalApplicationsPreferences; +import org.jabref.http.SrvStateManager; +import org.jabref.http.manager.HttpServerManager; import org.jabref.logic.citedrive.OAuthSessionRegistry; +import org.jabref.logic.preferences.CliPreferences; import org.jabref.logic.remote.RemotePreferences; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; -import static org.junit.jupiter.api.Assertions.*; +import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; class CiteDriveOAuthServiceTest { + private static HttpServerManager HTTP_SERVER_MANAGER = new HttpServerManager(); + + @BeforeAll + static void startServer() { + CliPreferences cliPreferences = mock(CliPreferences.class); + SrvStateManager srvStateManager = mock(SrvStateManager.class); + URI uri = URI.create("http://localhost:23119"); + HTTP_SERVER_MANAGER.start(cliPreferences, srvStateManager, uri); + } + + @AfterAll + static void stopServer() { + HTTP_SERVER_MANAGER.stop(); + } + @Test - // @Disabled - void getToken() { + @Disabled + // @Timeout(value = 2, unit = TimeUnit.SECONDS) + void getToken() throws ExecutionException, InterruptedException { ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); + when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); + RemotePreferences remotePreferences = mock(RemotePreferences.class); when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); + OAuthSessionRegistry oAuthSessionRegistry = new OAuthSessionRegistry(); CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, oAuthSessionRegistry); - citeDriveOAuthService.authorizeInteractive(); + + Optional actual = citeDriveOAuthService.authorizeInteractive().get(); + assertTrue(actual.isPresent()); } } From 94a614c197c8bbc95ccbeb276bcef21c5e07e623 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 23:17:14 +0100 Subject: [PATCH 10/83] Fix checkstyle --- .../org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java index 09ba1eda2ffe..64132ac9fb05 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java @@ -4,7 +4,6 @@ import java.util.Optional; import java.util.TreeSet; import java.util.concurrent.ExecutionException; -import java.util.concurrent.TimeUnit; import javafx.collections.FXCollections; @@ -20,7 +19,6 @@ import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.Timeout; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.Mockito.mock; From 08b15cef6907a685d28fa7140b8eaf4a042ab6a6 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 23:24:39 +0100 Subject: [PATCH 11/83] Fix formatting --- .../java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java | 1 - 1 file changed, 1 deletion(-) diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java index 64132ac9fb05..1df5b56f621e 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java @@ -43,7 +43,6 @@ static void stopServer() { @Test @Disabled - // @Timeout(value = 2, unit = TimeUnit.SECONDS) void getToken() throws ExecutionException, InterruptedException { ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); From 1de39fbf8fa05d5b08487e4e7be223a2046896eb Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 1 Dec 2025 23:27:27 +0100 Subject: [PATCH 12/83] Try to fix JBang --- .jbang/JabSrvLauncher.java | 1 + 1 file changed, 1 insertion(+) diff --git a/.jbang/JabSrvLauncher.java b/.jbang/JabSrvLauncher.java index a35c96fa8b23..0a1371645ddb 100755 --- a/.jbang/JabSrvLauncher.java +++ b/.jbang/JabSrvLauncher.java @@ -71,6 +71,7 @@ //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/command/Command.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/command/CommandResource.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/command/SelectEntriesCommand.java +//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/LibrariesResource.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/LibraryResource.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/MapResource.java From d5bb3966379caea070238932f2a41949d4e22a01 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 10 Dec 2025 14:57:55 +0100 Subject: [PATCH 13/83] Add final --- .../org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java index 1df5b56f621e..4216bf2c0966 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java @@ -26,7 +26,7 @@ class CiteDriveOAuthServiceTest { - private static HttpServerManager HTTP_SERVER_MANAGER = new HttpServerManager(); + private static final HttpServerManager HTTP_SERVER_MANAGER = new HttpServerManager(); @BeforeAll static void startServer() { From 8f702677cc3bdfbe84dc732ef588e03cd9ed87fb Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:08:25 +0100 Subject: [PATCH 14/83] Fix scope --- .../java/org/jabref/gui/citedrive/CiteDriveOAuthService.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index f3f51dea21db..fee02207807d 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -36,7 +36,7 @@ public class CiteDriveOAuthService { private static final Logger LOGGER = LoggerFactory.getLogger(CiteDriveOAuthService.class); private static final ClientID CLIENT_ID = new ClientID("jabref-desktop"); - private static final Scope SCOPE = new Scope(OIDCScopeValue.OPENID); + private static final Scope SCOPE = Scope.parse("openid read write"); private static final URI AUTH_ENDPOINT; private static final URI TOKEN_ENDPOINT; From fa45b4d42589bc64187fa0dcd05ca58991a9c54f Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:14:01 +0100 Subject: [PATCH 15/83] Fix typo --- .../main/java/org/jabref/logic/importer/util/MediaTypes.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jablib/src/main/java/org/jabref/logic/importer/util/MediaTypes.java b/jablib/src/main/java/org/jabref/logic/importer/util/MediaTypes.java index 01b803dcad8a..3bc2f8280e9a 100644 --- a/jablib/src/main/java/org/jabref/logic/importer/util/MediaTypes.java +++ b/jablib/src/main/java/org/jabref/logic/importer/util/MediaTypes.java @@ -1,7 +1,7 @@ package org.jabref.logic.importer.util; /** - * Stores MediaTypes required by JabRef (which are not availble in used libraries) + * Stores MediaTypes required by JabRef (which are not available in used libraries) */ public class MediaTypes { public static final String APPLICATION_BIBTEX = "application/x-bibtex"; From f12cd44eb2b973ef52d1a246758e486d3558d342 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:16:58 +0100 Subject: [PATCH 16/83] Fix checkstyle --- .../java/org/jabref/gui/citedrive/CiteDriveOAuthService.java | 1 - 1 file changed, 1 deletion(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index fee02207807d..860859be07cb 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -26,7 +26,6 @@ import com.nimbusds.oauth2.sdk.token.AccessToken; import com.nimbusds.oauth2.sdk.token.RefreshToken; import com.nimbusds.openid.connect.sdk.AuthenticationRequest; -import com.nimbusds.openid.connect.sdk.OIDCScopeValue; import org.jspecify.annotations.NonNull; import org.slf4j.Logger; import org.slf4j.LoggerFactory; From 77bc336ca1e1691833e3bec17ad5036ed6b6c5a7 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:19:14 +0100 Subject: [PATCH 17/83] Try to group resources classes under "resources" --- .jbang/JabSrvLauncher.java | 6 +++--- jabsrv/src/main/java/module-info.java | 4 ++-- jabsrv/src/main/java/org/jabref/http/server/Server.java | 2 +- .../jabref/http/server/{ => resources}/command/Command.java | 2 +- .../server/{ => resources}/command/CommandResource.java | 2 +- .../{ => resources}/command/SelectEntriesCommand.java | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) rename jabsrv/src/main/java/org/jabref/http/server/{ => resources}/command/Command.java (94%) rename jabsrv/src/main/java/org/jabref/http/server/{ => resources}/command/CommandResource.java (95%) rename jabsrv/src/main/java/org/jabref/http/server/{ => resources}/command/SelectEntriesCommand.java (98%) diff --git a/.jbang/JabSrvLauncher.java b/.jbang/JabSrvLauncher.java index 44152dc3c6f7..4f0bf72cc196 100755 --- a/.jbang/JabSrvLauncher.java +++ b/.jbang/JabSrvLauncher.java @@ -68,10 +68,10 @@ //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SearchField.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SearchResultContainer.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SelectedItemsContainer.java -//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/command/Command.java -//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/command/CommandResource.java -//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/command/SelectEntriesCommand.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java +//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/command/Command.java +//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/command/CommandResource.java +//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/command/SelectEntriesCommand.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/LibrariesResource.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/LibraryResource.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/MapResource.java diff --git a/jabsrv/src/main/java/module-info.java b/jabsrv/src/main/java/module-info.java index 7fd8ad3366fb..353c066f6ad7 100644 --- a/jabsrv/src/main/java/module-info.java +++ b/jabsrv/src/main/java/module-info.java @@ -7,10 +7,10 @@ opens org.jabref.http.server to org.glassfish.hk2.utilities, org.glassfish.hk2.locator; exports org.jabref.http.server.cayw to org.glassfish.jersey.core.server; - exports org.jabref.http.server.command to org.glassfish.jersey.core.server; + exports org.jabref.http.server.resources.command to org.glassfish.jersey.core.server; opens org.jabref.http.server.cayw to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities; opens org.jabref.http.dto to com.google.gson; - opens org.jabref.http.server.command to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities, tools.jackson.databind; + opens org.jabref.http.server.resources.command to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities, tools.jackson.databind; exports org.jabref.http.server.services; exports org.jabref.http; opens org.jabref.http.server.resources to org.glassfish.hk2.locator, org.glassfish.hk2.utilities; diff --git a/jabsrv/src/main/java/org/jabref/http/server/Server.java b/jabsrv/src/main/java/org/jabref/http/server/Server.java index 3ca4af0e6f44..2d0603181b0c 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/Server.java +++ b/jabsrv/src/main/java/org/jabref/http/server/Server.java @@ -13,12 +13,12 @@ import org.jabref.http.dto.GsonFactory; import org.jabref.http.server.cayw.CAYWResource; import org.jabref.http.server.cayw.format.FormatterService; -import org.jabref.http.server.command.CommandResource; import org.jabref.http.server.oauth.OAuth; import org.jabref.http.server.resources.LibrariesResource; import org.jabref.http.server.resources.LibraryResource; import org.jabref.http.server.resources.MapResource; import org.jabref.http.server.resources.RootResource; +import org.jabref.http.server.resources.command.CommandResource; import org.jabref.http.server.services.FilesToServe; import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.os.OS; diff --git a/jabsrv/src/main/java/org/jabref/http/server/command/Command.java b/jabsrv/src/main/java/org/jabref/http/server/resources/command/Command.java similarity index 94% rename from jabsrv/src/main/java/org/jabref/http/server/command/Command.java rename to jabsrv/src/main/java/org/jabref/http/server/resources/command/Command.java index 703936cb40d2..2392f7e82edd 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/command/Command.java +++ b/jabsrv/src/main/java/org/jabref/http/server/resources/command/Command.java @@ -1,4 +1,4 @@ -package org.jabref.http.server.command; +package org.jabref.http.server.resources.command; import org.jabref.http.SrvStateManager; diff --git a/jabsrv/src/main/java/org/jabref/http/server/command/CommandResource.java b/jabsrv/src/main/java/org/jabref/http/server/resources/command/CommandResource.java similarity index 95% rename from jabsrv/src/main/java/org/jabref/http/server/command/CommandResource.java rename to jabsrv/src/main/java/org/jabref/http/server/resources/command/CommandResource.java index 7dfb074e2241..340b638dbd3c 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/command/CommandResource.java +++ b/jabsrv/src/main/java/org/jabref/http/server/resources/command/CommandResource.java @@ -1,4 +1,4 @@ -package org.jabref.http.server.command; +package org.jabref.http.server.resources.command; import jakarta.inject.Inject; import jakarta.ws.rs.Consumes; diff --git a/jabsrv/src/main/java/org/jabref/http/server/command/SelectEntriesCommand.java b/jabsrv/src/main/java/org/jabref/http/server/resources/command/SelectEntriesCommand.java similarity index 98% rename from jabsrv/src/main/java/org/jabref/http/server/command/SelectEntriesCommand.java rename to jabsrv/src/main/java/org/jabref/http/server/resources/command/SelectEntriesCommand.java index e4e764e66de0..44af545c7607 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/command/SelectEntriesCommand.java +++ b/jabsrv/src/main/java/org/jabref/http/server/resources/command/SelectEntriesCommand.java @@ -1,4 +1,4 @@ -package org.jabref.http.server.command; +package org.jabref.http.server.resources.command; import java.util.ArrayList; import java.util.List; From 0ee36b6d3532d6931697d32d3f58edee3265b829 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:20:58 +0100 Subject: [PATCH 18/83] "manager" belongs to http.server, not general http --- jabgui/src/main/java/org/jabref/gui/JabRefGUI.java | 2 +- .../java/org/jabref/gui/preferences/general/GeneralTab.java | 2 +- .../org/jabref/gui/preferences/general/GeneralTabViewModel.java | 2 +- .../org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java | 2 +- jabsrv/src/main/java/module-info.java | 2 +- .../org/jabref/http/{ => server}/manager/HttpServerManager.java | 2 +- .../org/jabref/http/{ => server}/manager/HttpServerThread.java | 2 +- .../java/org/jabref/http/{ => server}/manager/package-info.java | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) rename jabsrv/src/main/java/org/jabref/http/{ => server}/manager/HttpServerManager.java (97%) rename jabsrv/src/main/java/org/jabref/http/{ => server}/manager/HttpServerThread.java (97%) rename jabsrv/src/main/java/org/jabref/http/{ => server}/manager/package-info.java (62%) diff --git a/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java b/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java index 57c53ebf678c..ca051b1134dd 100644 --- a/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java +++ b/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java @@ -33,7 +33,7 @@ import org.jabref.gui.util.DirectoryMonitor; import org.jabref.gui.util.UiTaskExecutor; import org.jabref.gui.util.WebViewStore; -import org.jabref.http.manager.HttpServerManager; +import org.jabref.http.server.manager.HttpServerManager; import org.jabref.languageserver.controller.LanguageServerController; import org.jabref.logic.UiCommand; import org.jabref.logic.ai.AiService; diff --git a/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTab.java b/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTab.java index bb820980b8ef..2c021763a615 100644 --- a/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTab.java +++ b/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTab.java @@ -23,7 +23,7 @@ import org.jabref.gui.theme.ThemeTypes; import org.jabref.gui.util.IconValidationDecorator; import org.jabref.gui.util.ViewModelListCellFactory; -import org.jabref.http.manager.HttpServerManager; +import org.jabref.http.server.manager.HttpServerManager; import org.jabref.languageserver.controller.LanguageServerController; import org.jabref.logic.help.HelpFile; import org.jabref.logic.l10n.Language; diff --git a/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java b/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java index d5369563abd4..8b0a5a8694fc 100644 --- a/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java +++ b/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java @@ -32,7 +32,7 @@ import org.jabref.gui.theme.ThemeTypes; import org.jabref.gui.util.DirectoryDialogConfiguration; import org.jabref.gui.util.FileDialogConfiguration; -import org.jabref.http.manager.HttpServerManager; +import org.jabref.http.server.manager.HttpServerManager; import org.jabref.languageserver.controller.LanguageServerController; import org.jabref.logic.FilePreferences; import org.jabref.logic.LibraryPreferences; diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java index 4216bf2c0966..412abecead1f 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java @@ -10,7 +10,7 @@ import org.jabref.gui.externalfiletype.ExternalFileTypes; import org.jabref.gui.frame.ExternalApplicationsPreferences; import org.jabref.http.SrvStateManager; -import org.jabref.http.manager.HttpServerManager; +import org.jabref.http.server.manager.HttpServerManager; import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.preferences.CliPreferences; import org.jabref.logic.remote.RemotePreferences; diff --git a/jabsrv/src/main/java/module-info.java b/jabsrv/src/main/java/module-info.java index 353c066f6ad7..6afb1c9e72e5 100644 --- a/jabsrv/src/main/java/module-info.java +++ b/jabsrv/src/main/java/module-info.java @@ -1,6 +1,6 @@ module org.jabref.jabsrv { exports org.jabref.http.server; - exports org.jabref.http.manager; + exports org.jabref.http.server.manager; exports org.jabref.http.dto to com.google.gson, org.glassfish.hk2.locator; exports org.jabref.http.dto.cayw to com.google.gson; diff --git a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerManager.java b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerManager.java similarity index 97% rename from jabsrv/src/main/java/org/jabref/http/manager/HttpServerManager.java rename to jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerManager.java index d9514c4533bc..b27725c3f6a3 100644 --- a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerManager.java +++ b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerManager.java @@ -1,4 +1,4 @@ -package org.jabref.http.manager; +package org.jabref.http.server.manager; import java.net.URI; diff --git a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java similarity index 97% rename from jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java rename to jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java index c97860ca4c18..976c11d76d46 100644 --- a/jabsrv/src/main/java/org/jabref/http/manager/HttpServerThread.java +++ b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java @@ -1,4 +1,4 @@ -package org.jabref.http.manager; +package org.jabref.http.server.manager; import java.net.URI; diff --git a/jabsrv/src/main/java/org/jabref/http/manager/package-info.java b/jabsrv/src/main/java/org/jabref/http/server/manager/package-info.java similarity index 62% rename from jabsrv/src/main/java/org/jabref/http/manager/package-info.java rename to jabsrv/src/main/java/org/jabref/http/server/manager/package-info.java index 6258bb4c371f..3ea9192a127d 100644 --- a/jabsrv/src/main/java/org/jabref/http/manager/package-info.java +++ b/jabsrv/src/main/java/org/jabref/http/server/manager/package-info.java @@ -1,2 +1,2 @@ /// Implemented similar to package org.jabref.logic.remote.server; -package org.jabref.http.manager; +package org.jabref.http.server.manager; From 595e8a32b92badb3213ba912e632eaf0e3115e9d Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:21:58 +0100 Subject: [PATCH 19/83] Ignore gcl.mv --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 585891046cfc..d9ca0cdae571 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,9 @@ jablib/src/main/resources/csl-locales javafx/ +# Generated by https://github.com/koppor/github-contributors-list +gcl.mv + # generated by gg.cmd m2 gg.cmd From 317d84c94303ea5d68dee59bec5aaa2e28578be7 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:43:51 +0100 Subject: [PATCH 20/83] Rename "callback" resource - and start to work on OAuthSessionRegistry --- .../main/java/org/jabref/gui/JabRefGUI.java | 4 +++- .../gui/citedrive/CiteDriveOAuthService.java | 5 +++-- .../general/GeneralTabViewModel.java | 4 +++- ...rviceTest.java => CiteDriveOAuthTest.java} | 12 ++++++------ jabsrv/src/main/java/module-info.java | 19 ++++++++++--------- .../java/org/jabref/http/server/Server.java | 4 ++-- .../server/manager/HttpServerManager.java | 5 +++-- .../http/server/manager/HttpServerThread.java | 4 ++-- .../callback/CallbackResource.java} | 14 +++++++------- 9 files changed, 39 insertions(+), 32 deletions(-) rename jabgui/src/test/java/org/jabref/gui/citedrive/{CiteDriveOAuthServiceTest.java => CiteDriveOAuthTest.java} (89%) rename jabsrv/src/main/java/org/jabref/http/server/{oauth/OAuth.java => resources/callback/CallbackResource.java} (82%) diff --git a/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java b/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java index ca051b1134dd..ed90f3bbfce5 100644 --- a/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java +++ b/jabgui/src/main/java/org/jabref/gui/JabRefGUI.java @@ -38,6 +38,7 @@ import org.jabref.logic.UiCommand; import org.jabref.logic.ai.AiService; import org.jabref.logic.citation.SearchCitationsRelationsService; +import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.git.util.GitHandlerRegistry; import org.jabref.logic.journals.JournalAbbreviationLoader; import org.jabref.logic.journals.JournalAbbreviationRepository; @@ -438,7 +439,8 @@ public void startBackgroundTasks() { } if (remotePreferences.enableHttpServer()) { - httpServerManager.start(preferences, stateManager, remotePreferences.getHttpServerUri()); + // TODO: Fix OAuthSessionRegistry - should be more global + httpServerManager.start(preferences, stateManager, new OAuthSessionRegistry(), remotePreferences.getHttpServerUri()); } if (remotePreferences.enableLanguageServer()) { languageServerController.start(cliMessageHandler, remotePreferences.getLanguageServerPort()); diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index 860859be07cb..c30c3c40ba0a 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -89,9 +89,10 @@ private URI buildAuthUrl(String state) { .toURI(); } + /// Redirects to [org.jabref.http.server.resources.callback.CallbackResource#citeDriveCallback] private @NonNull URI getCallBackUri() { - // The endpoint is at [org.jabref.http.server.oauth.OAuth.citeDriveCallback] - return remotePreferences.getHttpServerUri().resolve("/oauth/citedrive"); + // "/callback" is standard for OAuth2 redirect URIs + return remotePreferences.getHttpServerUri().resolve("/callback"); } private Optional exchangeCodeForToken(String code) { diff --git a/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java b/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java index 8b0a5a8694fc..08277c0ad2ba 100644 --- a/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java +++ b/jabgui/src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java @@ -36,6 +36,7 @@ import org.jabref.languageserver.controller.LanguageServerController; import org.jabref.logic.FilePreferences; import org.jabref.logic.LibraryPreferences; +import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.l10n.Language; import org.jabref.logic.l10n.Localization; import org.jabref.logic.net.ssl.TrustStoreManager; @@ -316,7 +317,8 @@ public void storeSettings() { if (enableHttpServerProperty.getValue()) { remotePreferences.setEnableHttpServer(true); URI uri = remotePreferences.getHttpServerUri(); - httpServerManager.start(preferences, stateManager, uri); + // TODO: Fix OAuthSessionRegistry parameter + httpServerManager.start(preferences, stateManager, new OAuthSessionRegistry(), uri); } else { remotePreferences.setEnableHttpServer(false); httpServerManager.stop(); diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java similarity index 89% rename from jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java rename to jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index 412abecead1f..608141e8615b 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthServiceTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -17,23 +17,24 @@ import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; -import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -class CiteDriveOAuthServiceTest { +class CiteDriveOAuthTest { private static final HttpServerManager HTTP_SERVER_MANAGER = new HttpServerManager(); + private static final OAuthSessionRegistry OAUTH_SESSION_REGISTRY = new OAuthSessionRegistry(); @BeforeAll static void startServer() { CliPreferences cliPreferences = mock(CliPreferences.class); SrvStateManager srvStateManager = mock(SrvStateManager.class); URI uri = URI.create("http://localhost:23119"); - HTTP_SERVER_MANAGER.start(cliPreferences, srvStateManager, uri); + HTTP_SERVER_MANAGER.start(cliPreferences, srvStateManager, OAUTH_SESSION_REGISTRY, uri); } @AfterAll @@ -42,7 +43,7 @@ static void stopServer() { } @Test - @Disabled + @Timeout(15) void getToken() throws ExecutionException, InterruptedException { ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); @@ -50,8 +51,7 @@ void getToken() throws ExecutionException, InterruptedException { RemotePreferences remotePreferences = mock(RemotePreferences.class); when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); - OAuthSessionRegistry oAuthSessionRegistry = new OAuthSessionRegistry(); - CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, oAuthSessionRegistry); + CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, OAUTH_SESSION_REGISTRY); Optional actual = citeDriveOAuthService.authorizeInteractive().get(); assertTrue(actual.isPresent()); diff --git a/jabsrv/src/main/java/module-info.java b/jabsrv/src/main/java/module-info.java index 6afb1c9e72e5..58cdaef06fe3 100644 --- a/jabsrv/src/main/java/module-info.java +++ b/jabsrv/src/main/java/module-info.java @@ -1,20 +1,21 @@ module org.jabref.jabsrv { - exports org.jabref.http.server; - exports org.jabref.http.server.manager; + exports org.jabref.http; exports org.jabref.http.dto to com.google.gson, org.glassfish.hk2.locator; exports org.jabref.http.dto.cayw to com.google.gson; - - opens org.jabref.http.server to org.glassfish.hk2.utilities, org.glassfish.hk2.locator; + exports org.jabref.http.server; exports org.jabref.http.server.cayw to org.glassfish.jersey.core.server; + exports org.jabref.http.server.manager; + exports org.jabref.http.server.resources; + exports org.jabref.http.server.resources.callback to org.glassfish.hk2.locator; exports org.jabref.http.server.resources.command to org.glassfish.jersey.core.server; - opens org.jabref.http.server.cayw to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities; - opens org.jabref.http.dto to com.google.gson; - opens org.jabref.http.server.resources.command to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities, tools.jackson.databind; exports org.jabref.http.server.services; - exports org.jabref.http; + + opens org.jabref.http.dto to com.google.gson; + opens org.jabref.http.server to org.glassfish.hk2.utilities, org.glassfish.hk2.locator; + opens org.jabref.http.server.cayw to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities; opens org.jabref.http.server.resources to org.glassfish.hk2.locator, org.glassfish.hk2.utilities; - exports org.jabref.http.server.resources; + opens org.jabref.http.server.resources.command to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities, tools.jackson.databind; requires javafx.base; diff --git a/jabsrv/src/main/java/org/jabref/http/server/Server.java b/jabsrv/src/main/java/org/jabref/http/server/Server.java index 2d0603181b0c..e3a07808a00a 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/Server.java +++ b/jabsrv/src/main/java/org/jabref/http/server/Server.java @@ -13,11 +13,11 @@ import org.jabref.http.dto.GsonFactory; import org.jabref.http.server.cayw.CAYWResource; import org.jabref.http.server.cayw.format.FormatterService; -import org.jabref.http.server.oauth.OAuth; import org.jabref.http.server.resources.LibrariesResource; import org.jabref.http.server.resources.LibraryResource; import org.jabref.http.server.resources.MapResource; import org.jabref.http.server.resources.RootResource; +import org.jabref.http.server.resources.callback.CallbackResource; import org.jabref.http.server.resources.command.CommandResource; import org.jabref.http.server.services.FilesToServe; import org.jabref.logic.citedrive.OAuthSessionRegistry; @@ -115,7 +115,7 @@ private HttpServer startServer(ServiceLocator serviceLocator, URI uri) { // Other resources resourceConfig.register(CAYWResource.class); - resourceConfig.register(OAuth.class); + resourceConfig.register(CallbackResource.class); resourceConfig.register(CommandResource.class); // Supporting classes diff --git a/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerManager.java b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerManager.java index b27725c3f6a3..e7ca6534c338 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerManager.java +++ b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerManager.java @@ -3,6 +3,7 @@ import java.net.URI; import org.jabref.http.SrvStateManager; +import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.preferences.CliPreferences; import org.slf4j.Logger; @@ -20,13 +21,13 @@ public class HttpServerManager implements AutoCloseable { private HttpServerThread httpServerThread; - public synchronized void start(CliPreferences preferences, SrvStateManager srvStateManager, URI uri) { + public synchronized void start(CliPreferences preferences, SrvStateManager srvStateManager, OAuthSessionRegistry oAuthSessionRegistry, URI uri) { if (httpServerThread != null) { LOGGER.warn("HTTP server manager already started, cannot start again."); return; } - httpServerThread = new HttpServerThread(preferences, srvStateManager, uri); + httpServerThread = new HttpServerThread(preferences, srvStateManager, oAuthSessionRegistry, uri); // This enqueues the thread to run in the background // The JVM will take care of running it at some point in time in the future // Thus, we cannot check directly if it really runs diff --git a/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java index 976c11d76d46..8ac19792c3a0 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java +++ b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java @@ -25,11 +25,11 @@ public class HttpServerThread extends Thread { private HttpServer httpServer; - public HttpServerThread(CliPreferences cliPreferences, SrvStateManager srvStateManager, URI uri) { + public HttpServerThread(CliPreferences cliPreferences, SrvStateManager srvStateManager, OAuthSessionRegistry oAuthSessionRegistry, URI uri) { this.srvStateManager = srvStateManager; this.uri = uri; // TODO: Fix params - this.server = new Server(cliPreferences, new OAuthSessionRegistry()); + this.server = new Server(cliPreferences, oAuthSessionRegistry); this.setName("JabSrv - JabRef HTTP Server on " + uri.getHost() + ":" + uri.getPort()); } diff --git a/jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java b/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java similarity index 82% rename from jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java rename to jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java index 14c0fb4934b2..b0e00da2792f 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java +++ b/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java @@ -1,4 +1,4 @@ -package org.jabref.http.server.oauth; +package org.jabref.http.server.resources.callback; import org.jabref.logic.citedrive.OAuthSessionRegistry; @@ -12,23 +12,23 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -@Path("/oauth") -public class OAuth { +/// This resource is triggered by [org.jabref.gui.citedrive.CiteDriveOAuthService] +@Path("/callback") +public class CallbackResource { - private static final Logger LOGGER = LoggerFactory.getLogger(OAuth.class); + private static final Logger LOGGER = LoggerFactory.getLogger(CallbackResource.class); @Inject OAuthSessionRegistry sessionRegistry; @GET - @Path("/citedrive") @Produces(MediaType.TEXT_HTML) public Response citeDriveCallback(@QueryParam("code") String code, @QueryParam("state") String state, @QueryParam("error") String error) { if (error != null && !error.isBlank()) { - LOGGER.warn("CiteDrive OAuth error: {} (state={})", error, state); - sessionRegistry.fail(state, new IllegalStateException("OAuth error: " + error)); + LOGGER.warn("CiteDrive CallbackResource error: {} (state={})", error, state); + sessionRegistry.fail(state, new IllegalStateException("CallbackResource error: " + error)); return Response.serverError().entity("Authorization failed. You can close this window.").build(); } From b7e699f6b566c354f88b4d9d28ed6132b7870e7c Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:54:28 +0100 Subject: [PATCH 21/83] Outputting error_description --- jabsrv/src/main/java/module-info.java | 3 ++- .../src/main/java/org/jabref/http/server/Server.java | 2 ++ .../jabref/http/server/manager/HttpServerThread.java | 1 - .../server/resources/callback/CallbackResource.java | 11 ++++++----- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/jabsrv/src/main/java/module-info.java b/jabsrv/src/main/java/module-info.java index 58cdaef06fe3..19bcaecc8ea1 100644 --- a/jabsrv/src/main/java/module-info.java +++ b/jabsrv/src/main/java/module-info.java @@ -7,13 +7,14 @@ exports org.jabref.http.server.cayw to org.glassfish.jersey.core.server; exports org.jabref.http.server.manager; exports org.jabref.http.server.resources; - exports org.jabref.http.server.resources.callback to org.glassfish.hk2.locator; + exports org.jabref.http.server.resources.callback to org.glassfish.hk2.locator, org.glassfish.jersey.core.server; exports org.jabref.http.server.resources.command to org.glassfish.jersey.core.server; exports org.jabref.http.server.services; opens org.jabref.http.dto to com.google.gson; opens org.jabref.http.server to org.glassfish.hk2.utilities, org.glassfish.hk2.locator; opens org.jabref.http.server.cayw to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities; + opens org.jabref.http.server.resources.callback to org.glassfish.hk2.utilities; opens org.jabref.http.server.resources to org.glassfish.hk2.locator, org.glassfish.hk2.utilities; opens org.jabref.http.server.resources.command to com.google.gson, org.glassfish.hk2.locator, org.glassfish.hk2.utilities, tools.jackson.databind; diff --git a/jabsrv/src/main/java/org/jabref/http/server/Server.java b/jabsrv/src/main/java/org/jabref/http/server/Server.java index e3a07808a00a..784725ec6220 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/Server.java +++ b/jabsrv/src/main/java/org/jabref/http/server/Server.java @@ -98,7 +98,9 @@ public HttpServer run(SrvStateManager srvStateManager, URI uri) { } private HttpServer startServer(ServiceLocator serviceLocator, URI uri) { + // Add remaining services - the difference between CLI and GUI is the SrvStateManager added before ServiceLocatorUtilities.addOneConstant(serviceLocator, new FormatterService()); + ServiceLocatorUtilities.addOneConstant(serviceLocator, oAuthSessionRegistry); ServiceLocatorUtilities.addOneConstant(serviceLocator, preferences); ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new GsonFactory()); diff --git a/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java index 8ac19792c3a0..53d52f6c8716 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java +++ b/jabsrv/src/main/java/org/jabref/http/server/manager/HttpServerThread.java @@ -28,7 +28,6 @@ public class HttpServerThread extends Thread { public HttpServerThread(CliPreferences cliPreferences, SrvStateManager srvStateManager, OAuthSessionRegistry oAuthSessionRegistry, URI uri) { this.srvStateManager = srvStateManager; this.uri = uri; - // TODO: Fix params this.server = new Server(cliPreferences, oAuthSessionRegistry); this.setName("JabSrv - JabRef HTTP Server on " + uri.getHost() + ":" + uri.getPort()); } diff --git a/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java b/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java index b0e00da2792f..7cce03f7545e 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java +++ b/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java @@ -25,22 +25,23 @@ public class CallbackResource { @Produces(MediaType.TEXT_HTML) public Response citeDriveCallback(@QueryParam("code") String code, @QueryParam("state") String state, - @QueryParam("error") String error) { + @QueryParam("error") String error, + @QueryParam("error_description") String errorDescription) { if (error != null && !error.isBlank()) { - LOGGER.warn("CiteDrive CallbackResource error: {} (state={})", error, state); + LOGGER.warn("CiteDrive CallbackResource error: {} ({}) (state={})", error, errorDescription, state); sessionRegistry.fail(state, new IllegalStateException("CallbackResource error: " + error)); - return Response.serverError().entity("Authorization failed. You can close this window.").build(); + return Response.serverError().build(); } if (code == null || state == null) { LOGGER.warn("Missing code or state in CiteDrive callback: code={}, state={}", code, state); sessionRegistry.fail(state, new IllegalStateException("Missing code or state")); - return Response.serverError().entity("Missing information. You can close this window.").build(); + return Response.serverError().build(); } LOGGER.debug("Received CiteDrive callback: state={}, code={}", state, code); sessionRegistry.complete(state, code); - return Response.ok("Authorization successful. You can close this window.").build(); + return Response.noContent().build(); } } From e9ba682d219c0c89442a143d2288a668b15b5511 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 12:58:04 +0100 Subject: [PATCH 22/83] Browser should show error --- .../http/server/resources/callback/CallbackResource.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java b/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java index 7cce03f7545e..a8f8561ddb4b 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java +++ b/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java @@ -30,18 +30,18 @@ public Response citeDriveCallback(@QueryParam("code") String code, if (error != null && !error.isBlank()) { LOGGER.warn("CiteDrive CallbackResource error: {} ({}) (state={})", error, errorDescription, state); sessionRegistry.fail(state, new IllegalStateException("CallbackResource error: " + error)); - return Response.serverError().build(); + return Response.serverError().entity("Authorization failed. You can close this window.").build(); } if (code == null || state == null) { LOGGER.warn("Missing code or state in CiteDrive callback: code={}, state={}", code, state); sessionRegistry.fail(state, new IllegalStateException("Missing code or state")); - return Response.serverError().build(); + return Response.serverError().entity("Missing information. You can close this window.").build(); } LOGGER.debug("Received CiteDrive callback: state={}, code={}", state, code); sessionRegistry.complete(state, code); - return Response.noContent().build(); + return Response.ok("Authorization successful. You can close this window.").build(); } } From 2a5b39cfc481e544bea579fcbd4a01f70b798712 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 13:31:36 +0100 Subject: [PATCH 23/83] Add challenge --- ...g.jabref.gradle.base.dependency-rules.gradle.kts | 5 ++--- jabgui/build.gradle.kts | 1 + .../jabref/gui/citedrive/CiteDriveOAuthService.java | 13 ++++++++++++- versions/build.gradle.kts | 1 + 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts b/build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts index adf7a7d973dd..dbab08c9431a 100644 --- a/build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts +++ b/build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts @@ -159,6 +159,7 @@ extraJavaModuleInfo { overrideModuleName() exportAllPackages() } + knownModule("com.nimbusds:nimbus-jose-jwt", "com.nimbusds.jose.jwt") module("com.nimbusds:lang-tag", "nimbusds.langtag") { overrideModuleName() exportAllPackages() @@ -166,9 +167,7 @@ extraJavaModuleInfo { module("com.nimbusds:oauth2-oidc-sdk", "nimbusds.oauth2.oidc.sdk") { overrideModuleName() exportAllPackages() - requires("nimbusds.contenttype") - requires("nimbusds.langtag") - requires("json.smart") + requireAllDefinedDependencies() } // endregion diff --git a/jabgui/build.gradle.kts b/jabgui/build.gradle.kts index 3fd50bfc14a1..6eadbbef5ec2 100644 --- a/jabgui/build.gradle.kts +++ b/jabgui/build.gradle.kts @@ -107,6 +107,7 @@ dependencies { // OAuth2 for CiteDrive implementation("com.nimbusds:oauth2-oidc-sdk") implementation("net.minidev:json-smart") + implementation("com.nimbusds:nimbus-jose-jwt") testImplementation(project(":test-support")) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index c30c3c40ba0a..5f35490cc1d8 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -23,6 +23,9 @@ import com.nimbusds.oauth2.sdk.TokenResponse; import com.nimbusds.oauth2.sdk.id.ClientID; import com.nimbusds.oauth2.sdk.id.State; +import com.nimbusds.oauth2.sdk.pkce.CodeChallenge; +import com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod; +import com.nimbusds.oauth2.sdk.pkce.CodeVerifier; import com.nimbusds.oauth2.sdk.token.AccessToken; import com.nimbusds.oauth2.sdk.token.RefreshToken; import com.nimbusds.openid.connect.sdk.AuthenticationRequest; @@ -53,6 +56,8 @@ public class CiteDriveOAuthService { } } + private CodeVerifier lastPkceVerifier; // store per-login attempt (TODO: better: map by state - in OAuthSessionRegistry?) + public CiteDriveOAuthService( ExternalApplicationsPreferences externalApplicationsPreferences, RemotePreferences remotePreferences, @@ -78,6 +83,11 @@ public CompletableFuture> authorizeInteractive() { } private URI buildAuthUrl(String state) { + CodeVerifier codeVerifier = new CodeVerifier(); + lastPkceVerifier = codeVerifier; + + CodeChallenge codeChallenge = CodeChallenge.compute(CodeChallengeMethod.S256, codeVerifier); + return new AuthenticationRequest.Builder( new ResponseType(ResponseType.Value.CODE), SCOPE, @@ -85,6 +95,7 @@ private URI buildAuthUrl(String state) { getCallBackUri()) .endpointURI(AUTH_ENDPOINT) .state(new State(state)) + .codeChallenge(codeChallenge, CodeChallengeMethod.S256) .build() .toURI(); } @@ -97,7 +108,7 @@ private URI buildAuthUrl(String state) { private Optional exchangeCodeForToken(String code) { AuthorizationCode authCode = new AuthorizationCode(code); - AuthorizationGrant codeGrant = new AuthorizationCodeGrant(authCode, getCallBackUri()); + AuthorizationGrant codeGrant = new AuthorizationCodeGrant(authCode, getCallBackUri(), lastPkceVerifier); TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, codeGrant, SCOPE); TokenResponse response; try { diff --git a/versions/build.gradle.kts b/versions/build.gradle.kts index fd34b3a6087d..8643923c9176 100644 --- a/versions/build.gradle.kts +++ b/versions/build.gradle.kts @@ -80,6 +80,7 @@ dependencies.constraints { api("com.konghq:unirest-java-core:4.5.1") api("com.konghq:unirest-modules-gson:4.5.1") api("com.nimbusds:oauth2-oidc-sdk:11.30.1") + api("com.nimbusds:nimbus-jose-jwt:10.6") api("com.pixelduke:fxthemes:1.6.0") api("com.squareup.okhttp3:okhttp:5.1.0") api("com.squareup.okio:okio-jvm:3.16.0") From c5c487a0bfc4f99c2ed7e8a25c92a5cd3fa121ff Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 13:41:27 +0100 Subject: [PATCH 24/83] Remove OpenId requirement --- .../gui/citedrive/CiteDriveOAuthService.java | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index 5f35490cc1d8..f8ea59dcb2b4 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -15,6 +15,7 @@ import com.nimbusds.oauth2.sdk.AuthorizationCode; import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; import com.nimbusds.oauth2.sdk.AuthorizationGrant; +import com.nimbusds.oauth2.sdk.AuthorizationRequest; import com.nimbusds.oauth2.sdk.ParseException; import com.nimbusds.oauth2.sdk.ResponseType; import com.nimbusds.oauth2.sdk.Scope; @@ -28,7 +29,6 @@ import com.nimbusds.oauth2.sdk.pkce.CodeVerifier; import com.nimbusds.oauth2.sdk.token.AccessToken; import com.nimbusds.oauth2.sdk.token.RefreshToken; -import com.nimbusds.openid.connect.sdk.AuthenticationRequest; import org.jspecify.annotations.NonNull; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -38,7 +38,7 @@ public class CiteDriveOAuthService { private static final Logger LOGGER = LoggerFactory.getLogger(CiteDriveOAuthService.class); private static final ClientID CLIENT_ID = new ClientID("jabref-desktop"); - private static final Scope SCOPE = Scope.parse("openid read write"); + private static final Scope SCOPE = Scope.parse("read write"); private static final URI AUTH_ENDPOINT; private static final URI TOKEN_ENDPOINT; @@ -88,13 +88,12 @@ private URI buildAuthUrl(String state) { CodeChallenge codeChallenge = CodeChallenge.compute(CodeChallengeMethod.S256, codeVerifier); - return new AuthenticationRequest.Builder( - new ResponseType(ResponseType.Value.CODE), - SCOPE, - CLIENT_ID, - getCallBackUri()) - .endpointURI(AUTH_ENDPOINT) + return new AuthorizationRequest.Builder( + new ResponseType(ResponseType.Value.CODE), CLIENT_ID) + .scope(SCOPE) .state(new State(state)) + .redirectionURI(getCallBackUri()) + .endpointURI(AUTH_ENDPOINT) .codeChallenge(codeChallenge, CodeChallengeMethod.S256) .build() .toURI(); From 1662407c844fcc1aabf81cb012e5ad8efcaca306 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 14:47:00 +0100 Subject: [PATCH 25/83] Remove scope and introduce variables for debuggin --- .../jabref/gui/citedrive/CiteDriveOAuthService.java | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index f8ea59dcb2b4..f8aa448567f8 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -22,6 +22,8 @@ import com.nimbusds.oauth2.sdk.TokenErrorResponse; import com.nimbusds.oauth2.sdk.TokenRequest; import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.http.HTTPRequest; +import com.nimbusds.oauth2.sdk.http.HTTPResponse; import com.nimbusds.oauth2.sdk.id.ClientID; import com.nimbusds.oauth2.sdk.id.State; import com.nimbusds.oauth2.sdk.pkce.CodeChallenge; @@ -108,10 +110,12 @@ private URI buildAuthUrl(String state) { private Optional exchangeCodeForToken(String code) { AuthorizationCode authCode = new AuthorizationCode(code); AuthorizationGrant codeGrant = new AuthorizationCodeGrant(authCode, getCallBackUri(), lastPkceVerifier); - TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, codeGrant, SCOPE); + TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, codeGrant); TokenResponse response; try { - response = TokenResponse.parse(request.toHTTPRequest().send()); + HTTPRequest httpRequest = request.toHTTPRequest(); + HTTPResponse httpResponse = httpRequest.send(); + response = TokenResponse.parse(httpResponse); } catch (ParseException e) { LOGGER.error("Could not parse response", e); return Optional.empty(); @@ -121,7 +125,7 @@ private Optional exchangeCodeForToken(String code) { } if (!response.indicatesSuccess()) { TokenErrorResponse errorResponse = response.toErrorResponse(); - LOGGER.error("Could not receive token {}", errorResponse); + LOGGER.error("Could not receive token {}", errorResponse.getErrorObject().toJSONObject()); return Optional.empty(); } AccessTokenResponse successResponse = response.toSuccessResponse(); From 06a707a15d01449d0098b3b1aea1c713e04fe3f0 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 15:19:04 +0100 Subject: [PATCH 26/83] Add trace statement --- .../java/org/jabref/gui/citedrive/CiteDriveOAuthService.java | 1 + 1 file changed, 1 insertion(+) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index f8aa448567f8..49b4314fb158 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -108,6 +108,7 @@ private URI buildAuthUrl(String state) { } private Optional exchangeCodeForToken(String code) { + LOGGER.trace("Received code {}", code); AuthorizationCode authCode = new AuthorizationCode(code); AuthorizationGrant codeGrant = new AuthorizationCodeGrant(authCode, getCallBackUri(), lastPkceVerifier); TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, codeGrant); From 32383575c1769a5eadeac583dcf878f5896704eb Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 17:13:33 +0100 Subject: [PATCH 27/83] Remove Scope --- .../java/org/jabref/gui/citedrive/CiteDriveOAuthService.java | 3 --- 1 file changed, 3 deletions(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index 49b4314fb158..7bfe0450bfd2 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -18,7 +18,6 @@ import com.nimbusds.oauth2.sdk.AuthorizationRequest; import com.nimbusds.oauth2.sdk.ParseException; import com.nimbusds.oauth2.sdk.ResponseType; -import com.nimbusds.oauth2.sdk.Scope; import com.nimbusds.oauth2.sdk.TokenErrorResponse; import com.nimbusds.oauth2.sdk.TokenRequest; import com.nimbusds.oauth2.sdk.TokenResponse; @@ -40,7 +39,6 @@ public class CiteDriveOAuthService { private static final Logger LOGGER = LoggerFactory.getLogger(CiteDriveOAuthService.class); private static final ClientID CLIENT_ID = new ClientID("jabref-desktop"); - private static final Scope SCOPE = Scope.parse("read write"); private static final URI AUTH_ENDPOINT; private static final URI TOKEN_ENDPOINT; @@ -92,7 +90,6 @@ private URI buildAuthUrl(String state) { return new AuthorizationRequest.Builder( new ResponseType(ResponseType.Value.CODE), CLIENT_ID) - .scope(SCOPE) .state(new State(state)) .redirectionURI(getCallBackUri()) .endpointURI(AUTH_ENDPOINT) From 133d5e2d5fd44fdd49a1eb267019f7fcd8255298 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 17:18:37 +0100 Subject: [PATCH 28/83] Increase timeout --- .../test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index 608141e8615b..3646f4e0508f 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -43,7 +43,7 @@ static void stopServer() { } @Test - @Timeout(15) + @Timeout(60) void getToken() throws ExecutionException, InterruptedException { ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); From 23af6c935772a4e9f98bb62118cde169901e7ac7 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 23:12:37 +0100 Subject: [PATCH 29/83] Successful interaction --- .../gui/citedrive/CiteDriveOAuthService.java | 71 +++++++++++-------- .../jabref/gui/desktop/os/NativeDesktop.java | 7 +- .../org/jabref/gui/desktop/os/Windows.java | 5 +- .../gui/citedrive/CiteDriveOAuthTest.java | 5 +- 4 files changed, 57 insertions(+), 31 deletions(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index 7bfe0450bfd2..be6f37968ea7 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -7,10 +7,12 @@ import java.util.UUID; import java.util.concurrent.CompletableFuture; +import org.jabref.gui.DialogService; import org.jabref.gui.frame.ExternalApplicationsPreferences; import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.remote.RemotePreferences; +import com.google.common.annotations.VisibleForTesting; import com.nimbusds.oauth2.sdk.AccessTokenResponse; import com.nimbusds.oauth2.sdk.AuthorizationCode; import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; @@ -25,7 +27,6 @@ import com.nimbusds.oauth2.sdk.http.HTTPResponse; import com.nimbusds.oauth2.sdk.id.ClientID; import com.nimbusds.oauth2.sdk.id.State; -import com.nimbusds.oauth2.sdk.pkce.CodeChallenge; import com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod; import com.nimbusds.oauth2.sdk.pkce.CodeVerifier; import com.nimbusds.oauth2.sdk.token.AccessToken; @@ -40,31 +41,50 @@ public class CiteDriveOAuthService { private static final ClientID CLIENT_ID = new ClientID("jabref-desktop"); - private static final URI AUTH_ENDPOINT; - private static final URI TOKEN_ENDPOINT; - - private final ExternalApplicationsPreferences externalApplicationsPreferences; - private final RemotePreferences remotePreferences; - private final OAuthSessionRegistry sessionRegistry; + private static final URI DEFAULT_AUTH_ENDPOINT; + private static final URI DEFAULT_TOKEN_ENDPOINT; static { try { - AUTH_ENDPOINT = new URI("https://api-dev.citedrive.com/jabref/login/"); - TOKEN_ENDPOINT = new URI("https://api-dev.citedrive.com/o/token/"); + DEFAULT_AUTH_ENDPOINT = new URI("https://api-dev.citedrive.com/jabref/login/"); + DEFAULT_TOKEN_ENDPOINT = new URI("https://api-dev.citedrive.com/o/token/"); } catch (URISyntaxException e) { throw new RuntimeException(e); } } - private CodeVerifier lastPkceVerifier; // store per-login attempt (TODO: better: map by state - in OAuthSessionRegistry?) + private final DialogService dialogService; + private final URI AUTH_ENDPOINT; + private final URI TOKEN_ENDPOINT; + + private final ExternalApplicationsPreferences externalApplicationsPreferences; + private final RemotePreferences remotePreferences; + private final OAuthSessionRegistry sessionRegistry; + + private CodeVerifier codeVerifier; // store per-login attempt (TODO: better: map by state - in OAuthSessionRegistry?) public CiteDriveOAuthService( ExternalApplicationsPreferences externalApplicationsPreferences, RemotePreferences remotePreferences, - OAuthSessionRegistry sessionRegistry) { + OAuthSessionRegistry sessionRegistry, + DialogService dialogService) { + this(externalApplicationsPreferences, remotePreferences, sessionRegistry, dialogService, DEFAULT_AUTH_ENDPOINT, DEFAULT_TOKEN_ENDPOINT); + } + + @VisibleForTesting + public CiteDriveOAuthService( + ExternalApplicationsPreferences externalApplicationsPreferences, + RemotePreferences remotePreferences, + OAuthSessionRegistry sessionRegistry, + DialogService dialogService, + URI authEndpoint, + URI tokenEndpoint) { this.externalApplicationsPreferences = externalApplicationsPreferences; this.remotePreferences = remotePreferences; this.sessionRegistry = sessionRegistry; + this.dialogService = dialogService; + this.AUTH_ENDPOINT = authEndpoint; + this.TOKEN_ENDPOINT = tokenEndpoint; } public CompletableFuture> authorizeInteractive() { @@ -72,30 +92,24 @@ public CompletableFuture> authorizeInteractive() { CompletableFuture codeFuture = sessionRegistry.register(state); URI authUrl = buildAuthUrl(state); - try { - org.jabref.gui.desktop.os.NativeDesktop.openBrowser(authUrl, externalApplicationsPreferences); - } catch (IOException e) { - LOGGER.error("Could not open browser", e); - return CompletableFuture.failedFuture(e); - } + org.jabref.gui.desktop.os.NativeDesktop.openBrowserShowPopup(authUrl.toASCIIString(), dialogService, externalApplicationsPreferences); return codeFuture.thenApply(code -> exchangeCodeForToken(code)); } private URI buildAuthUrl(String state) { - CodeVerifier codeVerifier = new CodeVerifier(); - lastPkceVerifier = codeVerifier; - - CodeChallenge codeChallenge = CodeChallenge.compute(CodeChallengeMethod.S256, codeVerifier); - - return new AuthorizationRequest.Builder( - new ResponseType(ResponseType.Value.CODE), CLIENT_ID) - .state(new State(state)) - .redirectionURI(getCallBackUri()) + this.codeVerifier = new CodeVerifier(); + URI uri = new AuthorizationRequest.Builder(ResponseType.CODE, CLIENT_ID) .endpointURI(AUTH_ENDPOINT) - .codeChallenge(codeChallenge, CodeChallengeMethod.S256) + .redirectionURI(getCallBackUri()) + .state(new State(state)) + // .scope(new Scope("openid", "read", "write")) // only required for https://github.com/navikt/mock-oauth2-server + .codeChallenge(codeVerifier, CodeChallengeMethod.S256) .build() .toURI(); + LOGGER.trace("PKCE verifier: {}", codeVerifier.getValue()); + LOGGER.trace("Auth URL: {}", uri); + return uri; } /// Redirects to [org.jabref.http.server.resources.callback.CallbackResource#citeDriveCallback] @@ -107,7 +121,8 @@ private URI buildAuthUrl(String state) { private Optional exchangeCodeForToken(String code) { LOGGER.trace("Received code {}", code); AuthorizationCode authCode = new AuthorizationCode(code); - AuthorizationGrant codeGrant = new AuthorizationCodeGrant(authCode, getCallBackUri(), lastPkceVerifier); + LOGGER.trace("Using PKCE code verifier: {}", codeVerifier.getValue()); + AuthorizationGrant codeGrant = new AuthorizationCodeGrant(authCode, getCallBackUri(), codeVerifier); TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, codeGrant); TokenResponse response; try { diff --git a/jabgui/src/main/java/org/jabref/gui/desktop/os/NativeDesktop.java b/jabgui/src/main/java/org/jabref/gui/desktop/os/NativeDesktop.java index 6614a568bc6f..6eb435d60d08 100644 --- a/jabgui/src/main/java/org/jabref/gui/desktop/os/NativeDesktop.java +++ b/jabgui/src/main/java/org/jabref/gui/desktop/os/NativeDesktop.java @@ -294,7 +294,12 @@ private static void executeCommand(String command, String absolutePath, DialogSe */ public static void openBrowser(String url, ExternalApplicationsPreferences externalApplicationsPreferences) throws IOException { Optional fileType = ExternalFileTypes.getExternalFileTypeByExt("html", externalApplicationsPreferences); - openExternalFilePlatformIndependent(fileType, url, externalApplicationsPreferences); + if (!OS.WINDOWS || (fileType.isPresent() && !fileType.get().getOpenWithApplication().isEmpty())) { + openExternalFilePlatformIndependent(fileType, url, externalApplicationsPreferences); + return; + } + // Works also if url is longer than 260 characters (Windows command line limit) + Desktop.getDesktop().browse(URI.create(url)); } public static void openBrowser(URI url, ExternalApplicationsPreferences externalApplicationsPreferences) throws IOException { diff --git a/jabgui/src/main/java/org/jabref/gui/desktop/os/Windows.java b/jabgui/src/main/java/org/jabref/gui/desktop/os/Windows.java index 3d2d1213d5b4..55f62fe27ded 100644 --- a/jabgui/src/main/java/org/jabref/gui/desktop/os/Windows.java +++ b/jabgui/src/main/java/org/jabref/gui/desktop/os/Windows.java @@ -28,10 +28,13 @@ public class Windows extends NativeDesktop { @Override public void openFile(String filePath, String fileType, ExternalApplicationsPreferences externalApplicationsPreferences) throws IOException { Optional type = ExternalFileTypes.getExternalFileTypeByExt(fileType, externalApplicationsPreferences); - if (type.isPresent() && !type.get().getOpenWithApplication().isEmpty()) { openFileWithApplication(filePath, type.get().getOpenWithApplication()); } else { + if (filePath.length() > 260) { + LoggerFactory.getLogger(Windows.class).warn("filePath exceeds Windows maximum length of 260 characters: {}", filePath); + // It could be that PowerShell could be used as workaround with `Start-Process "URL"` + } // quote String so explorer handles URL query strings correctly String quotePath = "\"" + filePath + "\""; new ProcessBuilder("explorer.exe", quotePath).start(); diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index 3646f4e0508f..b4f8b5add972 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -7,6 +7,7 @@ import javafx.collections.FXCollections; +import org.jabref.gui.DialogService; import org.jabref.gui.externalfiletype.ExternalFileTypes; import org.jabref.gui.frame.ExternalApplicationsPreferences; import org.jabref.http.SrvStateManager; @@ -51,7 +52,9 @@ void getToken() throws ExecutionException, InterruptedException { RemotePreferences remotePreferences = mock(RemotePreferences.class); when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); - CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, OAUTH_SESSION_REGISTRY); + CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class)); + // When testing with https://github.com/navikt/mock-oauth2-server + // CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class), URI.create("http://localhost:8080/default/authorize"), URI.create("http://localhost:8080/default/token")); Optional actual = citeDriveOAuthService.authorizeInteractive().get(); assertTrue(actual.isPresent()); From 416d6face3a82594fc4d168c4fa18fda91d1e4f9 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 23:39:30 +0100 Subject: [PATCH 30/83] Add MWE for PUT to CiteDrive --- jabgui/build.gradle.kts | 6 +-- .../gui/citedrive/CiteDriveOAuthTest.java | 45 +++++++++++++++++++ .../logic/importer/util/MediaTypes.java | 4 +- .../java/org/jabref/http/JabrefMediaType.java | 2 +- .../server/resources/LibraryResource.java | 3 +- .../http/server/LibraryResourceTest.java | 3 +- 6 files changed, 54 insertions(+), 9 deletions(-) diff --git a/jabgui/build.gradle.kts b/jabgui/build.gradle.kts index 6eadbbef5ec2..058bf572e507 100644 --- a/jabgui/build.gradle.kts +++ b/jabgui/build.gradle.kts @@ -219,15 +219,15 @@ javaModuleTesting.whitebox(testing.suites["test"]) { // requires.add("javafx.graphics") requires.add("com.github.javaparser.core") + requires.add("com.tngtech.archunit") + requires.add("com.tngtech.archunit.junit5.api") + requires.add("org.junit.jupiter.api") requires.add("org.junit.jupiter.params") requires.add("org.mockito") requires.add("org.testfx") requires.add("org.testfx.junit5") - - requires.add("com.tngtech.archunit") - requires.add("com.tngtech.archunit.junit5.api") } tasks.test { diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index b4f8b5add972..5aa507be5686 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -1,5 +1,6 @@ package org.jabref.gui.citedrive; +import java.io.IOException; import java.net.URI; import java.util.Optional; import java.util.TreeSet; @@ -13,14 +14,19 @@ import org.jabref.http.SrvStateManager; import org.jabref.http.server.manager.HttpServerManager; import org.jabref.logic.citedrive.OAuthSessionRegistry; +import org.jabref.logic.importer.util.MediaTypes; import org.jabref.logic.preferences.CliPreferences; import org.jabref.logic.remote.RemotePreferences; +import kong.unirest.core.HttpResponse; +import kong.unirest.core.Unirest; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Timeout; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; @@ -59,4 +65,43 @@ void getToken() throws ExecutionException, InterruptedException { Optional actual = citeDriveOAuthService.authorizeInteractive().get(); assertTrue(actual.isPresent()); } + + /// Fetches a token and sends some BibTeX to CiteDrive + @Test + @Timeout(60) + void putLibrary() throws ExecutionException, InterruptedException, IOException { + ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); + when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); + + RemotePreferences remotePreferences = mock(RemotePreferences.class); + when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); + + CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class)); + + Optional actual = citeDriveOAuthService.authorizeInteractive().get(); + assertTrue(actual.isPresent()); + + String bibtex = """ + @article{xyz, + author = {Doe, John and Smith, Jane}, + title = {An Example Article}, + journal = {Journal of Examples}, + year = {2024}, + volume = {42}, + number = {1}, + pages = {1-10}, + publisher = {Example Publisher} + } + """; + + HttpResponse response = Unirest.post("https://api-dev.citedrive.com/jabref/push/") + .header("Authorization", "Bearer " + actual.get().accessToken()) + .header("Content-Type", MediaTypes.APPLICATION_BIBTEX) + .body(bibtex) + .asString(); + + assertEquals(200, response.getStatus()); + // Example response: {"file_size":225,"file_size_kb":0.22,"entry_count":1,"status":"success"} + assertNotEquals("", response.getBody()); + } } diff --git a/jablib/src/main/java/org/jabref/logic/importer/util/MediaTypes.java b/jablib/src/main/java/org/jabref/logic/importer/util/MediaTypes.java index 3bc2f8280e9a..8bf51585bf9c 100644 --- a/jablib/src/main/java/org/jabref/logic/importer/util/MediaTypes.java +++ b/jablib/src/main/java/org/jabref/logic/importer/util/MediaTypes.java @@ -1,8 +1,6 @@ package org.jabref.logic.importer.util; -/** - * Stores MediaTypes required by JabRef (which are not available in used libraries) - */ +/// Stores MediaTypes required by JabRef (which are not available in used libraries) public class MediaTypes { public static final String APPLICATION_BIBTEX = "application/x-bibtex"; public static final String APPLICATION_JABREF_DATA = "application/x-jabref"; diff --git a/jabsrv/src/main/java/org/jabref/http/JabrefMediaType.java b/jabsrv/src/main/java/org/jabref/http/JabrefMediaType.java index b1d3598867e0..c10b1a6c5140 100644 --- a/jabsrv/src/main/java/org/jabref/http/JabrefMediaType.java +++ b/jabsrv/src/main/java/org/jabref/http/JabrefMediaType.java @@ -1,6 +1,6 @@ package org.jabref.http; +/// Other mediatypes in [org.jabref.logic.importer.util.MediaTypes] public class JabrefMediaType { - public static final String BIBTEX = "application/x-bibtex"; public static final String JSON_CSL_ITEM = "application/x-bibtex-library-csl+json"; } diff --git a/jabsrv/src/main/java/org/jabref/http/server/resources/LibraryResource.java b/jabsrv/src/main/java/org/jabref/http/server/resources/LibraryResource.java index 9a91c3628acf..9e4e575215dd 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/resources/LibraryResource.java +++ b/jabsrv/src/main/java/org/jabref/http/server/resources/LibraryResource.java @@ -14,6 +14,7 @@ import org.jabref.http.server.services.FilesToServe; import org.jabref.http.server.services.ServerUtils; import org.jabref.logic.citationstyle.JabRefItemDataProvider; +import org.jabref.logic.importer.util.MediaTypes; import org.jabref.logic.preferences.CliPreferences; import org.jabref.model.database.BibDatabase; import org.jabref.model.database.BibDatabaseContext; @@ -82,7 +83,7 @@ public String getClsItemJson(@PathParam("id") String id) throws IOException { } @GET - @Produces(JabrefMediaType.BIBTEX) + @Produces(MediaTypes.APPLICATION_BIBTEX) public Response getBibtex(@PathParam("id") String id) { if ("demo".equals(id)) { StreamingOutput stream = output -> { diff --git a/jabsrv/src/test/java/org/jabref/http/server/LibraryResourceTest.java b/jabsrv/src/test/java/org/jabref/http/server/LibraryResourceTest.java index 612402863880..4f9d98e2c794 100644 --- a/jabsrv/src/test/java/org/jabref/http/server/LibraryResourceTest.java +++ b/jabsrv/src/test/java/org/jabref/http/server/LibraryResourceTest.java @@ -3,6 +3,7 @@ import org.jabref.http.JabrefMediaType; import org.jabref.http.server.resources.LibrariesResource; import org.jabref.http.server.resources.LibraryResource; +import org.jabref.logic.importer.util.MediaTypes; import jakarta.ws.rs.core.Application; import org.glassfish.jersey.server.ResourceConfig; @@ -32,7 +33,7 @@ void getJson() { } @Comment{jabref-meta: databaseType:bibtex;} - """, target("/libraries/" + TestBibFile.GENERAL_SERVER_TEST.id).request(JabrefMediaType.BIBTEX).get(String.class)); + """, target("/libraries/" + TestBibFile.GENERAL_SERVER_TEST.id).request(MediaTypes.APPLICATION_BIBTEX).get(String.class)); } @Test From 3d7ea80310df0ced7271ce26e2a051538b1aeb48 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 23:43:55 +0100 Subject: [PATCH 31/83] Fix path --- .jbang/JabSrvLauncher.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.jbang/JabSrvLauncher.java b/.jbang/JabSrvLauncher.java index 4f0bf72cc196..424decf92733 100755 --- a/.jbang/JabSrvLauncher.java +++ b/.jbang/JabSrvLauncher.java @@ -68,7 +68,7 @@ //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SearchField.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SearchResultContainer.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SelectedItemsContainer.java -//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/oauth/OAuth.java +//SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/command/Command.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/command/CommandResource.java //SOURCES ../jabsrv/src/main/java/org/jabref/http/server/resources/command/SelectEntriesCommand.java From d440eb4b98b37859c04a0ca0799b5c7a3085eca6 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 12 Dec 2025 23:44:03 +0100 Subject: [PATCH 32/83] Add `@Disabled` --- .../test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index 5aa507be5686..f7b0e896297c 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -22,6 +22,7 @@ import kong.unirest.core.Unirest; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Timeout; @@ -51,6 +52,7 @@ static void stopServer() { @Test @Timeout(60) + @Disabled void getToken() throws ExecutionException, InterruptedException { ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); @@ -69,6 +71,7 @@ void getToken() throws ExecutionException, InterruptedException { /// Fetches a token and sends some BibTeX to CiteDrive @Test @Timeout(60) + @Disabled void putLibrary() throws ExecutionException, InterruptedException, IOException { ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); From 2f057ab24eaddb84692dab984b91eaaf57aaedad Mon Sep 17 00:00:00 2001 From: Siedlerchr Date: Mon, 15 Dec 2025 21:41:19 +0100 Subject: [PATCH 33/83] add refresh token handling --- .../gui/citedrive/CiteDriveOAuthService.java | 77 ++++++++++++++++--- 1 file changed, 68 insertions(+), 9 deletions(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index be6f37968ea7..38405bdaf45d 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -20,14 +20,15 @@ import com.nimbusds.oauth2.sdk.AuthorizationRequest; import com.nimbusds.oauth2.sdk.ParseException; import com.nimbusds.oauth2.sdk.ResponseType; -import com.nimbusds.oauth2.sdk.TokenErrorResponse; -import com.nimbusds.oauth2.sdk.TokenRequest; -import com.nimbusds.oauth2.sdk.TokenResponse; -import com.nimbusds.oauth2.sdk.http.HTTPRequest; -import com.nimbusds.oauth2.sdk.http.HTTPResponse; -import com.nimbusds.oauth2.sdk.id.ClientID; -import com.nimbusds.oauth2.sdk.id.State; -import com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod; + import com.nimbusds.oauth2.sdk.TokenErrorResponse; + import com.nimbusds.oauth2.sdk.TokenRequest; + import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.RefreshTokenGrant; + import com.nimbusds.oauth2.sdk.http.HTTPRequest; + import com.nimbusds.oauth2.sdk.http.HTTPResponse; + import com.nimbusds.oauth2.sdk.id.ClientID; + import com.nimbusds.oauth2.sdk.id.State; + import com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod; import com.nimbusds.oauth2.sdk.pkce.CodeVerifier; import com.nimbusds.oauth2.sdk.token.AccessToken; import com.nimbusds.oauth2.sdk.token.RefreshToken; @@ -63,6 +64,8 @@ public class CiteDriveOAuthService { private CodeVerifier codeVerifier; // store per-login attempt (TODO: better: map by state - in OAuthSessionRegistry?) + private volatile Tokens currentTokens; + public CiteDriveOAuthService( ExternalApplicationsPreferences externalApplicationsPreferences, RemotePreferences remotePreferences, @@ -94,7 +97,11 @@ public CompletableFuture> authorizeInteractive() { URI authUrl = buildAuthUrl(state); org.jabref.gui.desktop.os.NativeDesktop.openBrowserShowPopup(authUrl.toASCIIString(), dialogService, externalApplicationsPreferences); - return codeFuture.thenApply(code -> exchangeCodeForToken(code)); + return codeFuture.thenApply(this::exchangeCodeForToken) + .thenApply(tokensOpt -> { + tokensOpt.ifPresent(tokens -> this.currentTokens = tokens); + return tokensOpt; + }); } private URI buildAuthUrl(String state) { @@ -146,4 +153,56 @@ private Optional exchangeCodeForToken(String code) { RefreshToken refreshToken = successResponse.getTokens().getRefreshToken(); return Optional.of(new Tokens(accessToken, refreshToken)); } + + /** + * Returns the current tokens if available; otherwise tries to obtain fresh tokens interactively. + * If current tokens are present and include a refresh token, attempts to refresh them first. + */ + public CompletableFuture> currentOrFreshTokens() { + Tokens cached = this.currentTokens; + if (cached == null) { + // No tokens yet: go interactive + return authorizeInteractive(); + } + + // Try to refresh when we have a refresh token; fall back to cached tokens on failure + if (cached.refreshToken() != null) { + return CompletableFuture.supplyAsync(() -> refreshTokens(cached)) + .thenApply(refreshedOpt -> { + if (refreshedOpt.isPresent()) { + this.currentTokens = refreshedOpt.get(); + return refreshedOpt; + } + return Optional.of(cached); + }); + } + + return CompletableFuture.completedFuture(Optional.of(cached)); + } + + private Optional refreshTokens(Tokens tokens) { + try { + AuthorizationGrant refreshGrant = new RefreshTokenGrant(tokens.refreshToken()); + TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, refreshGrant); + HTTPRequest httpRequest = request.toHTTPRequest(); + HTTPResponse httpResponse = httpRequest.send(); + TokenResponse response = TokenResponse.parse(httpResponse); + + if (!response.indicatesSuccess()) { + TokenErrorResponse errorResponse = response.toErrorResponse(); + LOGGER.warn("Refresh token failed: {}", errorResponse.getErrorObject().toJSONObject()); + return Optional.empty(); + } + + AccessTokenResponse successResponse = response.toSuccessResponse(); + AccessToken newAccessToken = successResponse.getTokens().getAccessToken(); + RefreshToken newRefreshToken = successResponse.getTokens().getRefreshToken(); + // Some providers may omit refresh_token on refresh; keep the old one in that case + RefreshToken effectiveRefresh = (newRefreshToken != null) ? newRefreshToken : tokens.refreshToken(); + return Optional.of(new Tokens(newAccessToken, effectiveRefresh)); + } catch (IOException | ParseException e) { + LOGGER.error("Error refreshing token", e); + return Optional.empty(); + } + } } From 8be40706efa15b2ab45a9da93488b40bcec76ef7 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 15 Dec 2025 23:08:42 +0100 Subject: [PATCH 34/83] WIP: Store in preferences Co-authored-by: Carl Christian Snethlage <50491877+calixtus@users.noreply.github.com> Co-authored-by: Philip <37398281+palukku@users.noreply.github.com> Co-authored-by: Siedlerchr --- .../gui/citedrive/CiteDriveOAuthService.java | 81 ++++++++--------- .../java/org/jabref/gui/citedrive/Tokens.java | 10 --- .../gui/citedrive/CiteDriveOAuthTest.java | 57 ++++++++++-- jablib/build.gradle.kts | 3 + jablib/src/main/java/module-info.java | 5 ++ .../logic/net/CiteDrivePreferences.java | 70 +++++++++++++++ .../logic/preferences/CliPreferences.java | 3 + .../preferences/JabRefCliPreferences.java | 90 +++++++++++++++++-- 8 files changed, 254 insertions(+), 65 deletions(-) delete mode 100644 jabgui/src/main/java/org/jabref/gui/citedrive/Tokens.java create mode 100644 jablib/src/main/java/org/jabref/logic/net/CiteDrivePreferences.java diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index 38405bdaf45d..f0253106c033 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -10,6 +10,7 @@ import org.jabref.gui.DialogService; import org.jabref.gui.frame.ExternalApplicationsPreferences; import org.jabref.logic.citedrive.OAuthSessionRegistry; +import org.jabref.logic.net.CiteDrivePreferences; import org.jabref.logic.remote.RemotePreferences; import com.google.common.annotations.VisibleForTesting; @@ -19,16 +20,16 @@ import com.nimbusds.oauth2.sdk.AuthorizationGrant; import com.nimbusds.oauth2.sdk.AuthorizationRequest; import com.nimbusds.oauth2.sdk.ParseException; -import com.nimbusds.oauth2.sdk.ResponseType; - import com.nimbusds.oauth2.sdk.TokenErrorResponse; - import com.nimbusds.oauth2.sdk.TokenRequest; - import com.nimbusds.oauth2.sdk.TokenResponse; import com.nimbusds.oauth2.sdk.RefreshTokenGrant; - import com.nimbusds.oauth2.sdk.http.HTTPRequest; - import com.nimbusds.oauth2.sdk.http.HTTPResponse; - import com.nimbusds.oauth2.sdk.id.ClientID; - import com.nimbusds.oauth2.sdk.id.State; - import com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.TokenErrorResponse; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.http.HTTPRequest; +import com.nimbusds.oauth2.sdk.http.HTTPResponse; +import com.nimbusds.oauth2.sdk.id.ClientID; +import com.nimbusds.oauth2.sdk.id.State; +import com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod; import com.nimbusds.oauth2.sdk.pkce.CodeVerifier; import com.nimbusds.oauth2.sdk.token.AccessToken; import com.nimbusds.oauth2.sdk.token.RefreshToken; @@ -60,48 +61,47 @@ public class CiteDriveOAuthService { private final ExternalApplicationsPreferences externalApplicationsPreferences; private final RemotePreferences remotePreferences; + private final CiteDrivePreferences citeDrivePreferences; private final OAuthSessionRegistry sessionRegistry; private CodeVerifier codeVerifier; // store per-login attempt (TODO: better: map by state - in OAuthSessionRegistry?) - private volatile Tokens currentTokens; - public CiteDriveOAuthService( ExternalApplicationsPreferences externalApplicationsPreferences, RemotePreferences remotePreferences, + CiteDrivePreferences citeDrivePreferences, OAuthSessionRegistry sessionRegistry, DialogService dialogService) { - this(externalApplicationsPreferences, remotePreferences, sessionRegistry, dialogService, DEFAULT_AUTH_ENDPOINT, DEFAULT_TOKEN_ENDPOINT); + this(externalApplicationsPreferences, remotePreferences, citeDrivePreferences, sessionRegistry, dialogService, DEFAULT_AUTH_ENDPOINT, DEFAULT_TOKEN_ENDPOINT); } @VisibleForTesting public CiteDriveOAuthService( ExternalApplicationsPreferences externalApplicationsPreferences, RemotePreferences remotePreferences, + CiteDrivePreferences citeDrivePreferences, OAuthSessionRegistry sessionRegistry, DialogService dialogService, URI authEndpoint, URI tokenEndpoint) { this.externalApplicationsPreferences = externalApplicationsPreferences; this.remotePreferences = remotePreferences; + this.citeDrivePreferences = citeDrivePreferences; this.sessionRegistry = sessionRegistry; this.dialogService = dialogService; this.AUTH_ENDPOINT = authEndpoint; this.TOKEN_ENDPOINT = tokenEndpoint; } - public CompletableFuture> authorizeInteractive() { + @VisibleForTesting + public CompletableFuture> authorizeInteractive() { String state = UUID.randomUUID().toString(); CompletableFuture codeFuture = sessionRegistry.register(state); URI authUrl = buildAuthUrl(state); org.jabref.gui.desktop.os.NativeDesktop.openBrowserShowPopup(authUrl.toASCIIString(), dialogService, externalApplicationsPreferences); - return codeFuture.thenApply(this::exchangeCodeForToken) - .thenApply(tokensOpt -> { - tokensOpt.ifPresent(tokens -> this.currentTokens = tokens); - return tokensOpt; - }); + return codeFuture.thenApply(this::exchangeCodeForToken); } private URI buildAuthUrl(String state) { @@ -125,7 +125,8 @@ private URI buildAuthUrl(String state) { return remotePreferences.getHttpServerUri().resolve("/callback"); } - private Optional exchangeCodeForToken(String code) { + /// Also stores the refresh token + private Optional exchangeCodeForToken(String code) { LOGGER.trace("Received code {}", code); AuthorizationCode authCode = new AuthorizationCode(code); LOGGER.trace("Using PKCE code verifier: {}", codeVerifier.getValue()); @@ -151,38 +152,28 @@ private Optional exchangeCodeForToken(String code) { AccessTokenResponse successResponse = response.toSuccessResponse(); AccessToken accessToken = successResponse.getTokens().getAccessToken(); RefreshToken refreshToken = successResponse.getTokens().getRefreshToken(); - return Optional.of(new Tokens(accessToken, refreshToken)); + citeDrivePreferences.setRefreshToken(refreshToken); + + return Optional.of(accessToken); } - /** - * Returns the current tokens if available; otherwise tries to obtain fresh tokens interactively. - * If current tokens are present and include a refresh token, attempts to refresh them first. - */ - public CompletableFuture> currentOrFreshTokens() { - Tokens cached = this.currentTokens; - if (cached == null) { + /// Returns the current tokens if available; otherwise tries to obtain fresh tokens interactively. + /// If current tokens are present and include a refresh token, attempts to refresh them first. + /// + /// Also stores the refresh token + public CompletableFuture> currentOrFreshTokens() { + RefreshToken cachedRefreshToken = citeDrivePreferences.getRefreshToken(); + if (cachedRefreshToken == null) { // No tokens yet: go interactive return authorizeInteractive(); } - // Try to refresh when we have a refresh token; fall back to cached tokens on failure - if (cached.refreshToken() != null) { - return CompletableFuture.supplyAsync(() -> refreshTokens(cached)) - .thenApply(refreshedOpt -> { - if (refreshedOpt.isPresent()) { - this.currentTokens = refreshedOpt.get(); - return refreshedOpt; - } - return Optional.of(cached); - }); - } - - return CompletableFuture.completedFuture(Optional.of(cached)); + return CompletableFuture.supplyAsync(() -> refreshToken(cachedRefreshToken)); } - private Optional refreshTokens(Tokens tokens) { + private Optional refreshToken(RefreshToken refreshToken) { try { - AuthorizationGrant refreshGrant = new RefreshTokenGrant(tokens.refreshToken()); + AuthorizationGrant refreshGrant = new RefreshTokenGrant(refreshToken); TokenRequest request = new TokenRequest(TOKEN_ENDPOINT, CLIENT_ID, refreshGrant); HTTPRequest httpRequest = request.toHTTPRequest(); HTTPResponse httpResponse = httpRequest.send(); @@ -198,8 +189,10 @@ private Optional refreshTokens(Tokens tokens) { AccessToken newAccessToken = successResponse.getTokens().getAccessToken(); RefreshToken newRefreshToken = successResponse.getTokens().getRefreshToken(); // Some providers may omit refresh_token on refresh; keep the old one in that case - RefreshToken effectiveRefresh = (newRefreshToken != null) ? newRefreshToken : tokens.refreshToken(); - return Optional.of(new Tokens(newAccessToken, effectiveRefresh)); + if (newRefreshToken != null) { + citeDrivePreferences.setRefreshToken(newRefreshToken); + } + return Optional.of(newAccessToken); } catch (IOException | ParseException e) { LOGGER.error("Error refreshing token", e); return Optional.empty(); diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/Tokens.java b/jabgui/src/main/java/org/jabref/gui/citedrive/Tokens.java deleted file mode 100644 index 45a51024ce3b..000000000000 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/Tokens.java +++ /dev/null @@ -1,10 +0,0 @@ -package org.jabref.gui.citedrive; - -import com.nimbusds.oauth2.sdk.token.AccessToken; -import com.nimbusds.oauth2.sdk.token.RefreshToken; - -public record Tokens( - AccessToken accessToken, - RefreshToken refreshToken -) { -} diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index f7b0e896297c..e2566ae83032 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -15,9 +15,11 @@ import org.jabref.http.server.manager.HttpServerManager; import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.importer.util.MediaTypes; +import org.jabref.logic.net.CiteDrivePreferences; import org.jabref.logic.preferences.CliPreferences; import org.jabref.logic.remote.RemotePreferences; +import com.nimbusds.oauth2.sdk.token.AccessToken; import kong.unirest.core.HttpResponse; import kong.unirest.core.Unirest; import org.junit.jupiter.api.AfterAll; @@ -60,11 +62,13 @@ void getToken() throws ExecutionException, InterruptedException { RemotePreferences remotePreferences = mock(RemotePreferences.class); when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); - CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class)); + CiteDrivePreferences citeDrivePreferences = mock(CiteDrivePreferences.class); + + CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, citeDrivePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class)); // When testing with https://github.com/navikt/mock-oauth2-server // CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class), URI.create("http://localhost:8080/default/authorize"), URI.create("http://localhost:8080/default/token")); - Optional actual = citeDriveOAuthService.authorizeInteractive().get(); + Optional actual = citeDriveOAuthService.authorizeInteractive().get(); assertTrue(actual.isPresent()); } @@ -72,6 +76,47 @@ void getToken() throws ExecutionException, InterruptedException { @Test @Timeout(60) @Disabled + void putLibraryOAuthFromScratch() throws ExecutionException, InterruptedException, IOException { + ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); + when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); + + RemotePreferences remotePreferences = mock(RemotePreferences.class); + when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); + + CiteDrivePreferences citeDrivePreferences = mock(CiteDrivePreferences.class); + + CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, citeDrivePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class)); + + Optional actual = citeDriveOAuthService.authorizeInteractive().get(); + assertTrue(actual.isPresent()); + + String bibtex = """ + @article{xyz, + author = {Doe, John and Smith, Jane}, + title = {An Example Article}, + journal = {Journal of Examples}, + year = {2024}, + volume = {42}, + number = {1}, + pages = {1-10}, + publisher = {Example Publisher} + } + """; + + HttpResponse response = Unirest.post("https://api-dev.citedrive.com/jabref/push/") + .header("Authorization", "Bearer " + actual.get()) + .header("Content-Type", MediaTypes.APPLICATION_BIBTEX) + .body(bibtex) + .asString(); + + assertEquals(200, response.getStatus()); + // Example response: {"file_size":225,"file_size_kb":0.22,"entry_count":1,"status":"success"} + assertNotEquals("", response.getBody()); + } + + /// Uses the "intended" use of CiteDriveOAuthService w/ token refresh + @Test + @Timeout(60) void putLibrary() throws ExecutionException, InterruptedException, IOException { ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); @@ -79,9 +124,11 @@ void putLibrary() throws ExecutionException, InterruptedException, IOException { RemotePreferences remotePreferences = mock(RemotePreferences.class); when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); - CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class)); + CiteDrivePreferences citeDrivePreferences = mock(CiteDrivePreferences.class); + + CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, citeDrivePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class)); - Optional actual = citeDriveOAuthService.authorizeInteractive().get(); + Optional actual = citeDriveOAuthService.currentOrFreshTokens().get(); assertTrue(actual.isPresent()); String bibtex = """ @@ -98,7 +145,7 @@ void putLibrary() throws ExecutionException, InterruptedException, IOException { """; HttpResponse response = Unirest.post("https://api-dev.citedrive.com/jabref/push/") - .header("Authorization", "Bearer " + actual.get().accessToken()) + .header("Authorization", "Bearer " + actual.get()) .header("Content-Type", MediaTypes.APPLICATION_BIBTEX) .body(bibtex) .asString(); diff --git a/jablib/build.gradle.kts b/jablib/build.gradle.kts index 389ba1d597e8..e4300dc78ca9 100644 --- a/jablib/build.gradle.kts +++ b/jablib/build.gradle.kts @@ -128,6 +128,9 @@ dependencies { implementation("jakarta.ws.rs:jakarta.ws.rs-api") // endregion + // OAuth2 for CiteDrive + implementation("com.nimbusds:oauth2-oidc-sdk") + implementation("org.slf4j:slf4j-api") // route all requests to java.util.logging to SLF4J (which in turn routes to tinylog in the CLI and GUI) implementation("org.slf4j:jul-to-slf4j") diff --git a/jablib/src/main/java/module-info.java b/jablib/src/main/java/module-info.java index a6bf37c27ee9..d51e588a07f0 100644 --- a/jablib/src/main/java/module-info.java +++ b/jablib/src/main/java/module-info.java @@ -172,6 +172,11 @@ requires unirest.modules.gson; // endregion + // region nimbusds / OAuth2 + requires nimbusds.oauth2.oidc.sdk; + // requires json.smart; + // endregion + // region: SQL databases requires embedded.postgres; requires org.tukaani.xz; diff --git a/jablib/src/main/java/org/jabref/logic/net/CiteDrivePreferences.java b/jablib/src/main/java/org/jabref/logic/net/CiteDrivePreferences.java new file mode 100644 index 000000000000..e06bbbcfbd3d --- /dev/null +++ b/jablib/src/main/java/org/jabref/logic/net/CiteDrivePreferences.java @@ -0,0 +1,70 @@ +package org.jabref.logic.net; + +import javafx.beans.property.BooleanProperty; +import javafx.beans.property.ObjectProperty; +import javafx.beans.property.SimpleBooleanProperty; +import javafx.beans.property.SimpleObjectProperty; +import javafx.beans.value.ObservableValue; + +import com.nimbusds.oauth2.sdk.token.RefreshToken; +import org.jspecify.annotations.NullMarked; +import org.jspecify.annotations.Nullable; + +@NullMarked +public class CiteDrivePreferences { + + /// OAuth tokens + /// + /// - Refresh token (long-lived, confidential). -- could be unavailable; therefore "Optional" + /// - Access token (short-lived) - not stored here + private final ObjectProperty refreshToken; + private final BooleanProperty persistRefreshToken; + + public CiteDrivePreferences(@Nullable RefreshToken refreshToken, + boolean persistRefreshToken) { + this.refreshToken = new SimpleObjectProperty<>(refreshToken); + this.persistRefreshToken = new SimpleBooleanProperty(persistRefreshToken); + } + + // Creates object with default preference values + private CiteDrivePreferences() { + this( + null, // no refresh token + true // store in keychain + ); + } + + public static CiteDrivePreferences getDefault() { + return new CiteDrivePreferences(); + } + + public void setAll(CiteDrivePreferences preferences) { + this.refreshToken.set(preferences.getRefreshToken()); + this.persistRefreshToken.set(preferences.shouldPersistRefreshToken()); + } + + public final @Nullable RefreshToken getRefreshToken() { + return refreshToken.get(); + } + + /// NOT called from the GUI preferences page, but from the OAuth flow handling components + public void setRefreshToken(@Nullable RefreshToken refreshToken) { + this.refreshToken.set(refreshToken); + } + + public final boolean shouldPersistRefreshToken() { + return persistRefreshToken.get(); + } + + public BooleanProperty persistRefreshTokenProperty() { + return persistRefreshToken; + } + + public void setPersistRefreshToken(boolean persistRefreshToken) { + this.persistRefreshToken.set(persistRefreshToken); + } + + public ObservableValue getRefreshTokenProperty() { + return refreshToken; + } +} diff --git a/jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java b/jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java index f1a404195221..e0711ede3fc2 100644 --- a/jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java +++ b/jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java @@ -23,6 +23,7 @@ import org.jabref.logic.journals.JournalAbbreviationRepository; import org.jabref.logic.layout.LayoutFormatterPreferences; import org.jabref.logic.layout.format.NameFormatterPreferences; +import org.jabref.logic.net.CiteDrivePreferences; import org.jabref.logic.net.ProxyPreferences; import org.jabref.logic.net.ssl.SSLPreferences; import org.jabref.logic.openoffice.OpenOfficePreferences; @@ -89,6 +90,8 @@ public interface CliPreferences { ProxyPreferences getProxyPreferences(); + CiteDrivePreferences getCiteDrivePreferences(); + SSLPreferences getSSLPreferences(); CitationKeyPatternPreferences getCitationKeyPatternPreferences(); diff --git a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java index 0dba6996aa62..05076a3aa32e 100644 --- a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java +++ b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java @@ -72,6 +72,7 @@ import org.jabref.logic.l10n.Localization; import org.jabref.logic.layout.LayoutFormatterPreferences; import org.jabref.logic.layout.format.NameFormatterPreferences; +import org.jabref.logic.net.CiteDrivePreferences; import org.jabref.logic.net.ProxyPreferences; import org.jabref.logic.net.ssl.SSLPreferences; import org.jabref.logic.net.ssl.TrustStoreManager; @@ -118,8 +119,13 @@ import com.github.javakeyring.PasswordAccessException; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Splitter; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.token.RefreshToken; import com.tobiasdiez.easybind.EasyBind; import jakarta.inject.Singleton; +import net.minidev.json.JSONObject; +import net.minidev.json.parser.JSONParser; +import org.jspecify.annotations.Nullable; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -341,6 +347,11 @@ public class JabRefCliPreferences implements CliPreferences { private static final String PROXY_PASSWORD = "proxyPassword"; private static final String PROXY_PERSIST_PASSWORD = "persistPassword"; + // CiteDrive + // RefreshToken + private static final String CITE_DRIVE_TOKEN = "citeDriveToken"; + private static final String CITE_DRIVE_PERSIST_TOKEN = "citeDrivePersistToken"; + // Web search private static final String FETCHER_CUSTOM_KEY_NAMES = "fetcherCustomKeyNames"; private static final String FETCHER_CUSTOM_KEY_USES = "fetcherCustomKeyUses"; @@ -473,6 +484,7 @@ public class JabRefCliPreferences implements CliPreferences { private FilePreferences filePreferences; private RemotePreferences remotePreferences; private ProxyPreferences proxyPreferences; + private CiteDrivePreferences citeDrivePreferences; private SSLPreferences sslPreferences; private SearchPreferences searchPreferences; private AutoLinkPreferences autoLinkPreferences; @@ -1048,6 +1060,7 @@ public void clear() throws BackingStoreException { new SharedDatabasePreferences().clear(); getProxyPreferences().setAll(ProxyPreferences.getDefault()); + getCiteDrivePreferences().setAll(CiteDrivePreferences.getDefault()); } private void clearTruststoreFromCustomCertificates() { @@ -1201,7 +1214,8 @@ public void importPreferences(Path path) throws JabRefException { // See org.jabref.gui.preferences.JabRefGuiPreferences.importPreferences for the GUI // in case of incomplete or corrupt xml fall back to current preferences - getProxyPreferences().setAll(ProxyPreferences.getDefault()); + getProxyPreferences().setAll(getProxyPreferencesFromBackingStore(getProxyPreferences())); + getCiteDrivePreferences().setAll(getCiteDrivePreferencesFromBackingStore(getCiteDrivePreferences())); } //************************************************************************************************************* // ToDo: Cleanup @@ -1454,14 +1468,13 @@ private ProxyPreferences getProxyPreferencesFromBackingStore(ProxyPreferences de get(PROXY_PORT, defaults.getPort()), getBoolean(PROXY_USE_AUTHENTICATION, defaults.shouldUseAuthentication()), get(PROXY_USERNAME, defaults.getUsername()), - get(PROXY_PASSWORD, defaults.getPassword()), + getProxyPassword(defaults), getBoolean(PROXY_PERSIST_PASSWORD, defaults.shouldPersistPassword()) ); } - // endRegion: Proxy Preferences - private String getProxyPassword() { - if (getBoolean(PROXY_PERSIST_PASSWORD)) { + private String getProxyPassword(ProxyPreferences defaults) { + if (getBoolean(PROXY_PERSIST_PASSWORD, defaults.shouldPersistPassword())) { try (final Keyring keyring = Keyring.create()) { return new Password( keyring.getPassword("org.jabref", "proxy"), @@ -1473,7 +1486,7 @@ private String getProxyPassword() { LOGGER.warn("JabRef could not open the key store", ex); } } - return (String) defaults.get(PROXY_PASSWORD); + return get(PROXY_PASSWORD, defaults.getPassword()); } private void setProxyPassword(String password) { @@ -1492,6 +1505,7 @@ private void setProxyPassword(String password) { } } } + // endRegion: Proxy Preferences @Override public SSLPreferences getSSLPreferences() { @@ -1506,6 +1520,70 @@ public SSLPreferences getSSLPreferences() { return sslPreferences; } + // region: CiteDrive Preferences + @Override + public CiteDrivePreferences getCiteDrivePreferences() { + if (citeDrivePreferences != null) { + return citeDrivePreferences; + } + + citeDrivePreferences = getCiteDrivePreferencesFromBackingStore(CiteDrivePreferences.getDefault()); + + EasyBind.listen(citeDrivePreferences.persistRefreshTokenProperty(), (_, _, newValue) -> { + putBoolean(CITE_DRIVE_PERSIST_TOKEN, newValue); + if (!newValue) { + try (final Keyring keyring = Keyring.create()) { + keyring.deletePassword("org.jabref", "citedrive"); + } catch (Exception ex) { + LOGGER.warn("Unable to remove citedrive token"); + } + } + }); + + EasyBind.listen(citeDrivePreferences.getRefreshTokenProperty(), (_, _, newValue) -> { + if (citeDrivePreferences.shouldPersistRefreshToken()) { + put(CITE_DRIVE_TOKEN, serializeCiteDriveToken(newValue)); + } + }); + + return citeDrivePreferences; + } + + private String serializeCiteDriveToken(RefreshToken newValue) { + + } + + private CiteDrivePreferences getCiteDrivePreferencesFromBackingStore(CiteDrivePreferences defaults) { + return new CiteDrivePreferences( + getCiteDriveToken(), + getBoolean(CITE_DRIVE_PERSIST_TOKEN, defaults.shouldPersistRefreshToken()) + ); + } + + private RefreshToken getCiteDriveToken() { + try (final Keyring keyring = Keyring.create()) { + return parseCiteDriveToken(keyring.getPassword("org.jabref", "citedrive")); + } catch (Exception ex) { + LOGGER.warn("Unable to read citedrive token"); + return new RefreshToken(); + } + } + + private RefreshToken parseCiteDriveToken(@Nullable String json) { + if (json == null || json.isBlank()) { + return null; + } + + try { + JSONObject jsonObject = (JSONObject) new JSONParser(JSONParser.MODE_PERMISSIVE).parse(json); + return RefreshToken.parse(jsonObject); + } catch (ParseException | net.minidev.json.parser.ParseException e) { + LOGGER.warn("Invalid CiteDrive refresh token JSON", e); + return null; + } + } + // endRegion: CiteDrive Preferences + //************************************************************************************************************* // CitationKeyPatternPreferences //************************************************************************************************************* From af7e6035a2fab256e99ec631c89640ced50232f0 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 19 Dec 2025 21:46:48 +0100 Subject: [PATCH 35/83] Remove commented code --- .../java/org/jabref/logic/preferences/JabRefCliPreferences.java | 1 - 1 file changed, 1 deletion(-) diff --git a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java index 2a14ec043e6e..c58a8b23694c 100644 --- a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java +++ b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java @@ -2400,7 +2400,6 @@ private Set getFetcherKeys() { for (int i = 0; i < names.size(); i++) { fetcherApiKeys.add(new FetcherApiKey( names.get(i), - // i < uses.size() ? Boolean.parseBoolean(uses.get(i)) : false (i < uses.size()) && Boolean.parseBoolean(uses.get(i)), i < keys.size() ? keys.get(i) : "")); } From e54be7d7c0d3e59f6eabd5dfef9813e578a3ed4b Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 19 Dec 2025 22:05:52 +0100 Subject: [PATCH 36/83] Finish reading/writing token --- .../jabref/logic/preferences/JabRefCliPreferences.java | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java index c58a8b23694c..2d47b3862268 100644 --- a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java +++ b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java @@ -1540,17 +1540,13 @@ public CiteDrivePreferences getCiteDrivePreferences() { EasyBind.listen(citeDrivePreferences.getRefreshTokenProperty(), (_, _, newValue) -> { if (citeDrivePreferences.shouldPersistRefreshToken()) { - put(CITE_DRIVE_TOKEN, serializeCiteDriveToken(newValue)); + put(CITE_DRIVE_TOKEN, newValue.toJSONObject().toJSONString()); } }); return citeDrivePreferences; } - private String serializeCiteDriveToken(RefreshToken newValue) { - - } - private CiteDrivePreferences getCiteDrivePreferencesFromBackingStore(CiteDrivePreferences defaults) { return new CiteDrivePreferences( getCiteDriveToken(), @@ -1558,7 +1554,7 @@ private CiteDrivePreferences getCiteDrivePreferencesFromBackingStore(CiteDrivePr ); } - private RefreshToken getCiteDriveToken() { + private @Nullable RefreshToken getCiteDriveToken() { try (final Keyring keyring = Keyring.create()) { return parseCiteDriveToken(keyring.getPassword("org.jabref", "citedrive")); } catch (Exception ex) { @@ -1567,7 +1563,7 @@ private RefreshToken getCiteDriveToken() { } } - private RefreshToken parseCiteDriveToken(@Nullable String json) { + private @Nullable RefreshToken parseCiteDriveToken(@Nullable String json) { if (json == null || json.isBlank()) { return null; } From 98f4ff7adddef2b81e8e7113eda555e3b6fb0c8d Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 19 Dec 2025 22:07:32 +0100 Subject: [PATCH 37/83] Disable test --- .../test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java | 1 + 1 file changed, 1 insertion(+) diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index e2566ae83032..39949bc0deeb 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -117,6 +117,7 @@ void putLibraryOAuthFromScratch() throws ExecutionException, InterruptedExceptio /// Uses the "intended" use of CiteDriveOAuthService w/ token refresh @Test @Timeout(60) + @Disabled void putLibrary() throws ExecutionException, InterruptedException, IOException { ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class); when(externalApplicationsPreferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(new TreeSet<>(ExternalFileTypes.getDefaultExternalFileTypes()))); From b74c6a18a2f823ca3a27a62b6a2bfc738d43d145 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 19 Dec 2025 22:13:15 +0100 Subject: [PATCH 38/83] Add localization --- jablib/src/main/resources/l10n/JabRef_en.properties | 5 +++++ .../http/server/resources/callback/CallbackResource.java | 7 ++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/jablib/src/main/resources/l10n/JabRef_en.properties b/jablib/src/main/resources/l10n/JabRef_en.properties index 84c165908618..4667642061a6 100644 --- a/jablib/src/main/resources/l10n/JabRef_en.properties +++ b/jablib/src/main/resources/l10n/JabRef_en.properties @@ -3514,3 +3514,8 @@ Export\ chat\ history=Export chat history No\ summary\ available\ to\ export=No summary available to export No\ chat\ history\ to\ export=No chat history to export Problem\ occurred\ while\ writing\ the\ export\ file=Problem occurred while writing the export file + +# CiteDrive +Authorization\ failed.\ You\ can\ close\ this\ window.=Authorization failed. You can close this window. +Authorization\ successful.\ You\ can\ close\ this\ window.=Authorization successful. You can close this window. +Missing\ information.\ You\ can\ close\ this\ window.=Missing information. You can close this window. diff --git a/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java b/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java index a8f8561ddb4b..5ce492e09d1e 100644 --- a/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java +++ b/jabsrv/src/main/java/org/jabref/http/server/resources/callback/CallbackResource.java @@ -1,6 +1,7 @@ package org.jabref.http.server.resources.callback; import org.jabref.logic.citedrive.OAuthSessionRegistry; +import org.jabref.logic.l10n.Localization; import jakarta.inject.Inject; import jakarta.ws.rs.GET; @@ -30,18 +31,18 @@ public Response citeDriveCallback(@QueryParam("code") String code, if (error != null && !error.isBlank()) { LOGGER.warn("CiteDrive CallbackResource error: {} ({}) (state={})", error, errorDescription, state); sessionRegistry.fail(state, new IllegalStateException("CallbackResource error: " + error)); - return Response.serverError().entity("Authorization failed. You can close this window.").build(); + return Response.serverError().entity("" + Localization.lang("Authorization failed. You can close this window.") + "").build(); } if (code == null || state == null) { LOGGER.warn("Missing code or state in CiteDrive callback: code={}, state={}", code, state); sessionRegistry.fail(state, new IllegalStateException("Missing code or state")); - return Response.serverError().entity("Missing information. You can close this window.").build(); + return Response.serverError().entity("" + Localization.lang("Missing information. You can close this window.") + "").build(); } LOGGER.debug("Received CiteDrive callback: state={}, code={}", state, code); sessionRegistry.complete(state, code); - return Response.ok("Authorization successful. You can close this window.").build(); + return Response.ok("" + Localization.lang("Authorization successful. You can close this window.") + "").build(); } } From f923aac29a7b0a3ab82ab894f11daac905c23db8 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 19 Dec 2025 23:19:37 +0100 Subject: [PATCH 39/83] Initial code for push --- .../jabref/gui/actions/StandardActions.java | 22 +++++--- .../gui/citedrive/CiteDriveOAuthService.java | 4 +- .../gui/citedrive/CiteDrivePushAction.java | 23 +++++++++ .../java/org/jabref/gui/frame/MainMenu.java | 2 + .../gui/citedrive/CiteDriveOAuthTest.java | 2 +- .../jabref/logic/citedrive/CiteDrivePush.java | 51 +++++++++++++++++++ .../importer/fileformat/BibtexParser.java | 2 +- .../model/database/BibDatabaseContext.java | 17 +++---- .../main/resources/l10n/JabRef_en.properties | 4 ++ 9 files changed, 106 insertions(+), 21 deletions(-) create mode 100644 jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java create mode 100644 jablib/src/main/java/org/jabref/logic/citedrive/CiteDrivePush.java diff --git a/jabgui/src/main/java/org/jabref/gui/actions/StandardActions.java b/jabgui/src/main/java/org/jabref/gui/actions/StandardActions.java index f777bb1182fe..2e6905787037 100644 --- a/jabgui/src/main/java/org/jabref/gui/actions/StandardActions.java +++ b/jabgui/src/main/java/org/jabref/gui/actions/StandardActions.java @@ -82,17 +82,29 @@ public enum StandardActions implements Action { SAVE_LIBRARY_AS(Localization.lang("Save library as..."), KeyBinding.SAVE_DATABASE_AS), SAVE_SELECTED_AS_PLAIN_BIBTEX(Localization.lang("Save selected as plain BibTeX...")), SAVE_ALL(Localization.lang("Save all"), Localization.lang("Save all open libraries"), IconTheme.JabRefIcons.SAVE_ALL, KeyBinding.SAVE_ALL), + IMPORT_INTO_NEW_LIBRARY(Localization.lang("Import into new library"), KeyBinding.IMPORT_INTO_NEW_DATABASE), IMPORT_INTO_CURRENT_LIBRARY(Localization.lang("Import into current library"), KeyBinding.IMPORT_INTO_CURRENT_DATABASE), EXPORT_ALL(Localization.lang("Export all entries")), - REMOTE_DB(Localization.lang("Shared database"), IconTheme.JabRefIcons.REMOTE_DATABASE), EXPORT_SELECTED(Localization.lang("Export selected entries"), KeyBinding.EXPORT_SELECTED), + + GIT(Localization.lang("Git"), IconTheme.JabRefIcons.GIT_SYNC), + GIT_PULL(Localization.lang("Pull")), + GIT_PUSH(Localization.lang("Push")), + GIT_COMMIT(Localization.lang("Commit")), + GIT_SHARE(Localization.lang("Share this library to GitHub")), + + CITE_DRIVE_PUSH(Localization.lang("Push to CiteDrive")), + + REMOTE_DB(Localization.lang("Shared database"), IconTheme.JabRefIcons.REMOTE_DATABASE), CONNECT_TO_SHARED_DB(Localization.lang("Connect to shared database"), IconTheme.JabRefIcons.CONNECT_DB), PULL_CHANGES_FROM_SHARED_DB(Localization.lang("Pull changes from shared database"), KeyBinding.PULL_CHANGES_FROM_SHARED_DATABASE), + CLOSE_LIBRARY(Localization.lang("Close library"), Localization.lang("Close the current library"), IconTheme.JabRefIcons.CLOSE), CLOSE_OTHER_LIBRARIES(Localization.lang("Close others"), Localization.lang("Close other libraries"), IconTheme.JabRefIcons.CLOSE), CLOSE_ALL_LIBRARIES(Localization.lang("Close all"), Localization.lang("Close all libraries"), IconTheme.JabRefIcons.CLOSE), QUIT(Localization.lang("Quit"), Localization.lang("Quit JabRef"), IconTheme.JabRefIcons.CLOSE_JABREF, KeyBinding.QUIT_JABREF), + UNDO(Localization.lang("Undo"), IconTheme.JabRefIcons.UNDO, KeyBinding.UNDO), REDO(Localization.lang("Redo"), IconTheme.JabRefIcons.REDO, KeyBinding.REDO), REPLACE_ALL(Localization.lang("Find and replace"), KeyBinding.REPLACE_STRING), @@ -230,13 +242,7 @@ public enum StandardActions implements Action { GROUP_SUBGROUP_RENAME(Localization.lang("Rename subgroup"), KeyBinding.GROUP_SUBGROUP_RENAME), GROUP_ENTRIES_REMOVE(Localization.lang("Remove selected entries from this group")), - CLEAR_EMBEDDINGS_CACHE(Localization.lang("Clear embeddings cache")), - - GIT(Localization.lang("Git"), IconTheme.JabRefIcons.GIT_SYNC), - GIT_PULL(Localization.lang("Pull")), - GIT_PUSH(Localization.lang("Push")), - GIT_COMMIT(Localization.lang("Commit")), - GIT_SHARE(Localization.lang("Share this library to GitHub")); + CLEAR_EMBEDDINGS_CACHE(Localization.lang("Clear embeddings cache")); private String text; private final String description; diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java index f0253106c033..c303afcd3396 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveOAuthService.java @@ -93,6 +93,8 @@ public CiteDriveOAuthService( this.TOKEN_ENDPOINT = tokenEndpoint; } + /// Do not use if not in testing! + /// Continue at [CiteDriveOAuthService#getAccessToken()] @VisibleForTesting public CompletableFuture> authorizeInteractive() { String state = UUID.randomUUID().toString(); @@ -161,7 +163,7 @@ private Optional exchangeCodeForToken(String code) { /// If current tokens are present and include a refresh token, attempts to refresh them first. /// /// Also stores the refresh token - public CompletableFuture> currentOrFreshTokens() { + public CompletableFuture> getAccessToken() { RefreshToken cachedRefreshToken = citeDrivePreferences.getRefreshToken(); if (cachedRefreshToken == null) { // No tokens yet: go interactive diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java new file mode 100644 index 000000000000..023515b8ed7e --- /dev/null +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java @@ -0,0 +1,23 @@ +package org.jabref.gui.citedrive; + +import org.jabref.gui.DialogService; +import org.jabref.gui.StateManager; +import org.jabref.gui.actions.ActionHelper; +import org.jabref.gui.actions.SimpleCommand; +import org.jabref.gui.preferences.GuiPreferences; +import org.jabref.logic.citedrive.OAuthSessionRegistry; + +public class CiteDrivePushAction extends SimpleCommand { + private final CiteDriveOAuthService citeDriveOAuthService; + + public CiteDrivePushAction(DialogService dialogService, StateManager stateManager, GuiPreferences preferences) { + citeDriveOAuthService = new CiteDriveOAuthService(preferences.getExternalApplicationsPreferences(), preferences.getRemotePreferences(), preferences.getCiteDrivePreferences(), new OAuthSessionRegistry(), dialogService); + + this.executableProperty(ActionHelper.needsSavedLocalDatabase(stateManager)); + } + + @Override + public void execute() { + citeDriveOAuthService.getAccessToken() + } +} diff --git a/jabgui/src/main/java/org/jabref/gui/frame/MainMenu.java b/jabgui/src/main/java/org/jabref/gui/frame/MainMenu.java index 490210dbde74..9186d0c84823 100644 --- a/jabgui/src/main/java/org/jabref/gui/frame/MainMenu.java +++ b/jabgui/src/main/java/org/jabref/gui/frame/MainMenu.java @@ -17,6 +17,7 @@ import org.jabref.gui.ai.ClearEmbeddingsAction; import org.jabref.gui.auximport.NewSubLibraryAction; import org.jabref.gui.citationkeypattern.GenerateCitationKeyAction; +import org.jabref.gui.citedrive.CiteDrivePushAction; import org.jabref.gui.cleanup.CleanupAction; import org.jabref.gui.clipboard.ClipBoardManager; import org.jabref.gui.consistency.ConsistencyCheckAction; @@ -194,6 +195,7 @@ private void createMenu() { new SeparatorMenuItem(), factory.createMenuItem(StandardActions.GIT_SHARE, new GitShareToGitHubAction(dialogService, stateManager)) ), + factory.createMenuItem(StandardActions.CITE_DRIVE_PUSH, new CiteDrivePushAction(dialogService, stateManager, preferences)), factory.createSubMenu(StandardActions.REMOTE_DB, factory.createMenuItem(StandardActions.CONNECT_TO_SHARED_DB, new ConnectToSharedDatabaseCommand(frame, dialogService)), factory.createMenuItem(StandardActions.PULL_CHANGES_FROM_SHARED_DB, new PullChangesFromSharedAction(stateManager))), diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index 39949bc0deeb..1969b2132c54 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -129,7 +129,7 @@ void putLibrary() throws ExecutionException, InterruptedException, IOException { CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(externalApplicationsPreferences, remotePreferences, citeDrivePreferences, OAUTH_SESSION_REGISTRY, mock(DialogService.class)); - Optional actual = citeDriveOAuthService.currentOrFreshTokens().get(); + Optional actual = citeDriveOAuthService.getAccessToken().get(); assertTrue(actual.isPresent()); String bibtex = """ diff --git a/jablib/src/main/java/org/jabref/logic/citedrive/CiteDrivePush.java b/jablib/src/main/java/org/jabref/logic/citedrive/CiteDrivePush.java new file mode 100644 index 000000000000..c6857ffb38f5 --- /dev/null +++ b/jablib/src/main/java/org/jabref/logic/citedrive/CiteDrivePush.java @@ -0,0 +1,51 @@ +package org.jabref.logic.citedrive; + +import java.io.IOException; +import java.io.OutputStreamWriter; +import java.io.PipedInputStream; +import java.io.PipedOutputStream; +import java.io.Writer; +import java.nio.charset.StandardCharsets; + +import org.jabref.logic.exporter.BibDatabaseWriter; +import org.jabref.logic.importer.util.MediaTypes; +import org.jabref.logic.l10n.Localization; +import org.jabref.logic.preferences.CliPreferences; +import org.jabref.logic.util.NotificationService; +import org.jabref.model.database.BibDatabaseContext; + +import com.nimbusds.oauth2.sdk.token.AccessToken; +import kong.unirest.core.HttpResponse; +import kong.unirest.core.Unirest; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class CiteDrivePush { + private static final Logger LOGGER = LoggerFactory.getLogger(CiteDrivePush.class); + + public static void push(BibDatabaseContext context, AccessToken accessToken, CliPreferences cliPreferences, NotificationService notificationService) throws IOException { + PipedOutputStream pos = new PipedOutputStream(); + // bigger buffer helps avoid producer/consumer stalls + PipedInputStream pis = new PipedInputStream(pos, 256 * 1024); + + Thread.startVirtualThread(() -> { + try (pos; Writer writer = new OutputStreamWriter(pos, StandardCharsets.UTF_8)) { + BibDatabaseWriter bibDatabaseWriter = new BibDatabaseWriter(writer, context, cliPreferences); + bibDatabaseWriter.writeDatabase(context); + writer.flush(); + } catch (Exception e) { + LOGGER.error("Error writing BibTeX data for CiteDrive push", e); + } + }); + HttpResponse httpResponse = Unirest.post("https://api-dev.citedrive.com/jabref/push/") + .header("Authorization", accessToken.toAuthorizationHeader()) + .header("Content-Type", MediaTypes.APPLICATION_BIBTEX) + .body(pis) + .asString(); + httpResponse.ifFailure(response -> { + LOGGER.error("CiteDrive push failed: {}", response); + notificationService.notify(Localization.lang("CiteDrive push failed: %0", response.getStatusText())); + }); + httpResponse.ifSuccess(_ -> notificationService.notify(Localization.lang("CiteDrive push succeeded."))); + } +} diff --git a/jablib/src/main/java/org/jabref/logic/importer/fileformat/BibtexParser.java b/jablib/src/main/java/org/jabref/logic/importer/fileformat/BibtexParser.java index d9f8c9c01254..40383dff639f 100644 --- a/jablib/src/main/java/org/jabref/logic/importer/fileformat/BibtexParser.java +++ b/jablib/src/main/java/org/jabref/logic/importer/fileformat/BibtexParser.java @@ -87,7 +87,7 @@ /// [`OpenDatabase.loadDatabase`](org.jabref.logic.importer.OpenDatabase#loadDatabase(java.nio.file.Path, org.jabref.logic.importer.ImportFormatPreferences, org.jabref.model.util.FileUpdateMonitor)) /// /// **Opposite class:** -/// [`BibDatabaseWriter`](org.jabref.logic.exporter.BibDatabaseWriter) +/// [org.jabref.logic.exporter.BibDatabaseWriter] /// /// FIXME: This class relies on `char`, but should use [java.lang.Character] to be fully Unicode compliant. public class BibtexParser implements Parser { diff --git a/jablib/src/main/java/org/jabref/model/database/BibDatabaseContext.java b/jablib/src/main/java/org/jabref/model/database/BibDatabaseContext.java index b407aab2d7f0..da90f4bbad96 100644 --- a/jablib/src/main/java/org/jabref/model/database/BibDatabaseContext.java +++ b/jablib/src/main/java/org/jabref/model/database/BibDatabaseContext.java @@ -37,16 +37,13 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** - * Represents everything related to a BIB file. - * - *

The entries are stored in BibDatabase, the other data in MetaData - * and the options relevant for this file in Defaults. - *

- *

- * To get an instance for a .bib file, use {@link org.jabref.logic.importer.fileformat.BibtexParser}. - *

- */ +/// Represents everything related to a BIB file. +/// +/// The entries are stored in BibDatabase, the other data in MetaData +/// and the options relevant for this file in Defaults. +/// +/// - To get an instance for a .bib file, use {@link org.jabref.logic.importer.fileformat.BibtexParser}. +/// - To save an instance to a .bib file, use {@link org.jabref.logic.exporter.BibDatabaseWriter}. @AllowedToUseLogic("because it needs access to shared database features") @NullMarked public class BibDatabaseContext { diff --git a/jablib/src/main/resources/l10n/JabRef_en.properties b/jablib/src/main/resources/l10n/JabRef_en.properties index 4667642061a6..ee147b160dad 100644 --- a/jablib/src/main/resources/l10n/JabRef_en.properties +++ b/jablib/src/main/resources/l10n/JabRef_en.properties @@ -3519,3 +3519,7 @@ Problem\ occurred\ while\ writing\ the\ export\ file=Problem occurred while writ Authorization\ failed.\ You\ can\ close\ this\ window.=Authorization failed. You can close this window. Authorization\ successful.\ You\ can\ close\ this\ window.=Authorization successful. You can close this window. Missing\ information.\ You\ can\ close\ this\ window.=Missing information. You can close this window. +Push\ to\ CiteDrive=Push to CiteDrive +CiteDrive\ push\ failed\:\ could\ not\ obtain\ access\ token.=CiteDrive push failed: could not obtain access token. +CiteDrive\ push\ failed\:\ %0=CiteDrive push failed: %0 +CiteDrive\ push\ succeeded.=CiteDrive push succeeded. From 3752bd12287edf4aa62ef8324cee8b984466beb0 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 19 Dec 2025 23:19:49 +0100 Subject: [PATCH 40/83] Some more changes --- .../gui/citedrive/CiteDrivePushAction.java | 42 ++++++++++++++++++- jabgui/src/main/resources/tinylog.properties | 4 +- 2 files changed, 43 insertions(+), 3 deletions(-) diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java index 023515b8ed7e..a69ce9f8f754 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java @@ -1,23 +1,61 @@ package org.jabref.gui.citedrive; +import java.io.IOException; + import org.jabref.gui.DialogService; import org.jabref.gui.StateManager; import org.jabref.gui.actions.ActionHelper; import org.jabref.gui.actions.SimpleCommand; import org.jabref.gui.preferences.GuiPreferences; +import org.jabref.logic.citedrive.CiteDrivePush; import org.jabref.logic.citedrive.OAuthSessionRegistry; +import org.jabref.logic.l10n.Localization; +import org.jabref.model.database.BibDatabaseContext; + +import com.nimbusds.oauth2.sdk.token.AccessToken; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public class CiteDrivePushAction extends SimpleCommand { + private static final Logger LOGGER = LoggerFactory.getLogger(CiteDrivePushAction.class); + private final CiteDriveOAuthService citeDriveOAuthService; + private final DialogService dialogService; + private final StateManager stateManager; + private final GuiPreferences preferences; public CiteDrivePushAction(DialogService dialogService, StateManager stateManager, GuiPreferences preferences) { + this.dialogService = dialogService; + this.stateManager = stateManager; + this.preferences = preferences; citeDriveOAuthService = new CiteDriveOAuthService(preferences.getExternalApplicationsPreferences(), preferences.getRemotePreferences(), preferences.getCiteDrivePreferences(), new OAuthSessionRegistry(), dialogService); - this.executableProperty(ActionHelper.needsSavedLocalDatabase(stateManager)); + this.executable.bind(ActionHelper.needsSavedLocalDatabase(stateManager)); } @Override public void execute() { - citeDriveOAuthService.getAccessToken() + if (this.stateManager.getActiveDatabase().isEmpty()) { + dialogService.notify(Localization.lang("CiteDrive push failed: no active database.")); + return; + } + + BibDatabaseContext database = this.stateManager.getActiveDatabase().get(); + + citeDriveOAuthService.getAccessToken().thenAccept( + accessTokenOpt -> { + if (accessTokenOpt.isEmpty()) { + dialogService.notify(Localization.lang("CiteDrive push failed: could not obtain access token.")); + return; + } + + AccessToken accessToken = accessTokenOpt.get(); + try { + CiteDrivePush.push(database, accessToken, preferences, dialogService); + } catch (IOException e) { + LOGGER.error("CiteDrive push failed", e); + dialogService.notify(Localization.lang("CiteDrive push failed: %0", e.getMessage())); + } + }); } } diff --git a/jabgui/src/main/resources/tinylog.properties b/jabgui/src/main/resources/tinylog.properties index fc870e66bfba..580643a5361f 100644 --- a/jabgui/src/main/resources/tinylog.properties +++ b/jabgui/src/main/resources/tinylog.properties @@ -2,7 +2,7 @@ level = info writer = gui writerConsole = console -writerConsole.format = {date} [{thread}] {class}.{method}()\n{level}: {message}\n +writerConsole.format = {date} [{thread}] {class}.{method}({line})\n{level}: {message}\m # More shrunk exception logs. See https://tinylog.org/v2/configuration/#strip-stack-trace-elements for details exception = strip: jdk.internal @@ -30,3 +30,5 @@ level@org.jabref.logic.externalfiles.LinkedFileTransferHelper = debug #level@org.jabref.logic.ai.FileEmbeddingsManager = trace #level@org.jabref.logic.ai.impl.embeddings.LowLevelIngestor = trace #level@org.jabref.logic.ai.chat.AiChatLogic = trace + +level@org.jabref.logic.citedrive.CiteDrivePush = debug From d7eaeb1736d937cad8051b519341bd4f33fea4f9 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 19 Dec 2025 23:54:26 +0100 Subject: [PATCH 41/83] WIP --- .idea/checkstyle-idea.xml | 2 +- .../jabref/gui/actions/StandardActions.java | 2 + .../gui/citedrive/CiteDriveLoginAction.java | 42 +++++++++++++++++++ .../gui/citedrive/CiteDrivePushAction.java | 9 ++-- .../java/org/jabref/gui/frame/MainMenu.java | 5 ++- jabgui/src/main/resources/tinylog.properties | 2 +- .../main/resources/l10n/JabRef_en.properties | 2 + 7 files changed, 55 insertions(+), 9 deletions(-) create mode 100644 jabgui/src/main/java/org/jabref/gui/citedrive/CiteDriveLoginAction.java diff --git a/.idea/checkstyle-idea.xml b/.idea/checkstyle-idea.xml index 98ed7f21e9de..cc424b698be0 100644 --- a/.idea/checkstyle-idea.xml +++ b/.idea/checkstyle-idea.xml @@ -12,7 +12,7 @@ (bundled) (bundled) - $PROJECT_DIR$/../JabRef/config/checkstyle/checkstyle.xml + $PROJECT_DIR$/config/checkstyle/checkstyle.xml - + \ No newline at end of file diff --git a/jabgui/src/test/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModelTest.java b/jabgui/src/test/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModelTest.java deleted file mode 100644 index 084e2a2e6775..000000000000 --- a/jabgui/src/test/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModelTest.java +++ /dev/null @@ -1,39 +0,0 @@ -package org.jabref.gui.preferences.externalstorages; - -import org.jabref.logic.net.CiteDrivePreferences; - -import org.junit.jupiter.api.Test; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertTrue; - -class ExternalStoragesTabViewModelTest { - - private final CiteDrivePreferences citeDrivePreferences = CiteDrivePreferences.getDefault(); - private final ExternalStoragesTabViewModel viewModel = new ExternalStoragesTabViewModel(citeDrivePreferences); - - @Test - void editedValuesReachThePreferences() { - viewModel.setValues(); - - viewModel.rememberCiteDriveLoginProperty().set(false); - viewModel.citeDriveApiBaseUrlProperty().set(" https://api.example.com/ "); - viewModel.citeDriveAppBaseUrlProperty().set("https://app.example.com/"); - viewModel.storeSettings(); - - assertFalse(citeDrivePreferences.shouldPersistRefreshToken()); - assertEquals("https://api.example.com/", citeDrivePreferences.getApiBaseUrl()); - assertEquals("https://app.example.com/", citeDrivePreferences.getAppBaseUrl()); - } - - @Test - void addressThatIsNoUrlIsRejected() { - viewModel.setValues(); - assertTrue(viewModel.validateSettings()); - - viewModel.citeDriveApiBaseUrlProperty().set("not a url"); - - assertFalse(viewModel.validateSettings()); - } -} diff --git a/jablib-examples/jbang/doi_to_bibtex.java b/jablib-examples/jbang/doi_to_bibtex.java index e782e5c57594..fab39cf3a3a8 100644 --- a/jablib-examples/jbang/doi_to_bibtex.java +++ b/jablib-examples/jbang/doi_to_bibtex.java @@ -16,11 +16,11 @@ //FILES tinylog.properties=tinylog.properties //REPOS mavencentral,mavencentralsnapshots=https://central.sonatype.com/repository/maven-snapshots/ -//DEPS org.jabref:jablib:6.0-SNAPSHOT // JabRef relies on PR https://github.com/unicode-org/icu/pull/2127; for experiments the release version is OK. //DEPS com.ibm.icu:icu4j:78.1 //DEPS com.nimbusds:oauth2-oidc-sdk:11.30.1 //DEPS net.minidev:json-smart:2.6.0 +//DEPS org.jabref:jablib:6.0-SNAPSHOT void main() throws Exception { var preferences = JabRefCliPreferences.getInstance(); diff --git a/jablib-examples/jbang/ieee_pdf_references_to_bibtex.java b/jablib-examples/jbang/ieee_pdf_references_to_bibtex.java index 972556d47ed2..45e79ffdffa2 100644 --- a/jablib-examples/jbang/ieee_pdf_references_to_bibtex.java +++ b/jablib-examples/jbang/ieee_pdf_references_to_bibtex.java @@ -15,15 +15,15 @@ //FILES tinylog.properties=tinylog.properties //REPOS mavencentral,mavencentralsnapshots=https://central.sonatype.com/repository/maven-snapshots/ -//DEPS org.jabref:jablib:6.0-SNAPSHOT +//DEPS com.fasterxml.jackson.core:jackson-annotations:2.20 // JabRef relies on PR https://github.com/unicode-org/icu/pull/2127; for experiments the release version is OK. //DEPS com.ibm.icu:icu4j:78.1 -//DEPS com.fasterxml.jackson.core:jackson-annotations:2.20 +//DEPS com.nimbusds:oauth2-oidc-sdk:11.30.1 +//DEPS net.minidev:json-smart:2.6.0 +//DEPS org.jabref:jablib:6.0-SNAPSHOT //DEPS tools.jackson.core:jackson-core:3.0.2 //DEPS tools.jackson.core:jackson-databind:3.0.2 //DEPS tools.jackson.dataformat:jackson-dataformat-yaml:3.0.2 -//DEPS com.nimbusds:oauth2-oidc-sdk:11.30.1 -//DEPS net.minidev:json-smart:2.6.0 void main() throws Exception { var preferences = JabRefCliPreferences.getInstance(); diff --git a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java index 6f4b96758f92..de0d69224816 100644 --- a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java +++ b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java @@ -1720,7 +1720,7 @@ private void setCiteDriveToken(@Nullable RefreshToken refreshToken) { } private @Nullable RefreshToken parseCiteDriveToken(@Nullable String json) { - if (json == null || json.isBlank()) { + if (StringUtil.isBlank(json)) { return null; } diff --git a/jablib/src/main/resources/l10n/JabRef_en.properties b/jablib/src/main/resources/l10n/JabRef_en.properties index 1326da910ab5..e8a1c5164d61 100644 --- a/jablib/src/main/resources/l10n/JabRef_en.properties +++ b/jablib/src/main/resources/l10n/JabRef_en.properties @@ -1917,6 +1917,7 @@ Cannot\ use\ port\ %0\ for\ remote\ operation;\ another\ application\ may\ be\ u Enable\ HTTP\ Server\ (e.g.,\ for\ JabMap)\ on\ port=Enable HTTP Server (e.g., for JabMap) on port Skip\ import\ dialog\ for\ entries\ received\ from\ browser\ extensions=Skip import dialog for entries received from browser extensions HTTP\ Server=HTTP Server +Enable\ HTTP\ server=Enable HTTP server Enable\ LSP\ Server\ on\ port=Enable LSP Server on port LSP\ Server=LSP Server @@ -3705,11 +3706,11 @@ CiteDrive\ push\ succeeded.=CiteDrive push succeeded. Logging\ in\ to\ CiteDrive\ needs\ the\ HTTP\ server.\ Please\ enable\ it\ in\ the\ preferences.=Logging in to CiteDrive needs the HTTP server. Please enable it in the preferences. Log\ in\ to\ CiteDrive=Log in to CiteDrive Logging\ in\ to\ CiteDrive\ needs\ JabRef's\ HTTP\ server,\ which\ is\ currently\ disabled.=Logging in to CiteDrive needs JabRef's HTTP server, which is currently disabled. -Enable\ HTTP\ server=Enable HTTP server Opening\ the\ CiteDrive\ login\ page\ in\ the\ browser=Opening the CiteDrive login page in the browser Login\ was\ not\ completed\ in\ time.=Login was not completed in time. CiteDrive\ push\ succeeded\:\ %0\ KB=CiteDrive push succeeded: %0 KB CiteDrive\ push\ succeeded\:\ %0\ entries\ (%1\ KB)=CiteDrive push succeeded: %0 entries (%1 KB) + Select\ citation\ fetcher=Select citation fetcher Parsing\ failed\ because\ more\ than\ one\ entry\ was\ found.\ Please\ check\ your\ BibTeX\ syntax.=Parsing failed because more than one entry was found. Please check your BibTeX syntax. Problem\ with\ parsing\ entry=Problem with parsing entry diff --git a/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java b/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java index fe48e2947a73..abaebc2824a8 100644 --- a/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java +++ b/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java @@ -38,6 +38,10 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; +/// Guards what leaves the machine: the request body is plain BibTeX regardless of the user's export settings. +/// JabRef's metadata (here: the library-specific file directory) must not be uploaded, and the token has to arrive as a bearer header. +/// +/// [utest->req~citedrive.push~1] class CiteDrivePushTest { @Test diff --git a/jablib/src/test/java/org/jabref/logic/citedrive/OAuthSessionRegistryTest.java b/jablib/src/test/java/org/jabref/logic/citedrive/OAuthSessionRegistryTest.java index 28ab87aab9d0..374443ffb636 100644 --- a/jablib/src/test/java/org/jabref/logic/citedrive/OAuthSessionRegistryTest.java +++ b/jablib/src/test/java/org/jabref/logic/citedrive/OAuthSessionRegistryTest.java @@ -12,7 +12,13 @@ import static org.junit.jupiter.api.Assertions.assertInstanceOf; import static org.junit.jupiter.api.Assertions.assertThrows; -// [utest->req~citedrive.login~1] +/// The registry is what ties a browser callback to the login that started it. +/// Two things must hold or logins silently break: +/// +/// - a callback completes only the login with the matching `state` (a stale or foreign callback must not finish someone else's login) +/// - an abandoned login times out *and* is dropped from the registry, otherwise forgotten logins pile up for the lifetime of the JVM +/// +/// [utest->req~citedrive.login~1] class OAuthSessionRegistryTest { private final OAuthSessionRegistry registry = new OAuthSessionRegistry(); diff --git a/jablib/src/test/java/org/jabref/logic/net/CiteDrivePreferencesTest.java b/jablib/src/test/java/org/jabref/logic/net/CiteDrivePreferencesTest.java deleted file mode 100644 index fb3050fd1536..000000000000 --- a/jablib/src/test/java/org/jabref/logic/net/CiteDrivePreferencesTest.java +++ /dev/null @@ -1,20 +0,0 @@ -package org.jabref.logic.net; - -import java.net.URI; - -import org.junit.jupiter.api.Test; - -import static org.junit.jupiter.api.Assertions.assertEquals; - -class CiteDrivePreferencesTest { - - @Test - void endpointsFollowBaseUrls() { - CiteDrivePreferences preferences = new CiteDrivePreferences(true, null, true, "https://api.example.com/", "https://app.example.com/"); - - assertEquals(URI.create("https://api.example.com/jabref/login/"), preferences.getAuthorizationEndpoint()); - assertEquals(URI.create("https://api.example.com/o/token/"), preferences.getTokenEndpoint()); - assertEquals(URI.create("https://api.example.com/jabref/push/"), preferences.getPushEndpoint()); - assertEquals(URI.create("https://app.example.com/jabref/push/"), preferences.getImportPage()); - } -} diff --git a/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java b/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java index a6a825d23942..9a48618721c5 100644 --- a/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java +++ b/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java @@ -48,8 +48,10 @@ public static void main(final String[] args) throws InterruptedException { @Override public Void call() throws InterruptedException, IOException { + JabRefCliPreferences preferences = JabRefCliPreferences.getInstance(); + // The server serves the last opened files (see org.jabref.http.server.resources.LibraryResource.getLibraryPath) - final List filesToServe = new ArrayList<>(JabRefCliPreferences.getInstance().getLastFilesOpenedPreferences().getLastFilesOpened()); + final List filesToServe = new ArrayList<>(preferences.getLastFilesOpenedPreferences().getLastFilesOpened()); // Additionally, files can be provided as args if (files != null) { @@ -72,8 +74,9 @@ public Void call() throws InterruptedException, IOException { return null; } - // TODO: Fix parameter - Server server = new Server(JabRefCliPreferences.getInstance(), new OAuthSessionRegistry()); + // A standalone jabsrv never starts a CiteDrive login (that needs the GUI), so no login can be pending: + // the callback endpoint answers every callback with "login could not be completed" + Server server = new Server(preferences, new OAuthSessionRegistry()); HttpServer httpServer = server.run(filesToServe, uri); // Keep the http server running until user kills the process (e.g., presses Ctrl+C) diff --git a/test-support/src/main/java/org/jabref/support/CommonArchitectureTest.java b/test-support/src/main/java/org/jabref/support/CommonArchitectureTest.java index d7194e54679c..3320767a4299 100644 --- a/test-support/src/main/java/org/jabref/support/CommonArchitectureTest.java +++ b/test-support/src/main/java/org/jabref/support/CommonArchitectureTest.java @@ -202,7 +202,7 @@ public void shouldNotCallUriCreateMethod(JavaClasses classes) { ArchRuleDefinition.noClasses() .that() .resideInAPackage("org.jabref..") - .should().callMethod(URI.class, "create", String.class) // Method: "URI.create(String)" + .should().callMethod(URI.class, "create", String.class) .check(classes); } From d8f7818cdb68b4ed2db844712310c30b828afac4 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 12 Oct 2026 05:54:30 +0200 Subject: [PATCH 79/83] Add jabsrv --citedrive-login The OAuth flow lives in jablib and only needs a way to show the login address and a running callback server, so jabsrv can log in without the GUI: it prints the address, waits for the browser to return to /callback, stores the refresh token in the keyring, and exits. The option refuses to start if the preferences' HTTP server port (where CiteDrive redirects the browser) differs from the port jabsrv listens on, or if the login would not be remembered between sessions. Co-Authored-By: Claude Fable 5.1 --- docs/code-howtos/http-server.md | 9 +++ docs/requirements/citedrive.md | 1 + .../org/jabref/http/server/cli/ServerCli.java | 79 +++++++++++++++++-- 3 files changed, 81 insertions(+), 8 deletions(-) diff --git a/docs/code-howtos/http-server.md b/docs/code-howtos/http-server.md index aebae17070e9..320a5f0fec11 100644 --- a/docs/code-howtos/http-server.md +++ b/docs/code-howtos/http-server.md @@ -74,6 +74,15 @@ The library name `current` denotes the currently focussed library in JabRef. ./gradlew :jabsrv-cli:run --args="../jablib/src/test/resources/testbib/complex.bib" ``` +## Logging in to CiteDrive without the GUI + +`jabsrv --citedrive-login` prints the CiteDrive login address, waits for the browser to come back to `/callback`, stores the refresh token in the system keyring, and exits. +JabRef's HTTP server port from the preferences has to be the port `jabsrv` listens on, since CiteDrive redirects the browser there. + +```shell +./gradlew :jabsrv-cli:run --args="--citedrive-login" +``` + ## Developing with IntelliJ IntelliJ Ultimate offers a Markdown-based http-client. You need to open the file `jabsrv/src/test/rest-api.http`. diff --git a/docs/requirements/citedrive.md b/docs/requirements/citedrive.md index b789d97a3862..0d4cec251596 100644 --- a/docs/requirements/citedrive.md +++ b/docs/requirements/citedrive.md @@ -8,6 +8,7 @@ parent: Requirements JabRef logs the user in to CiteDrive in the browser (OAuth 2.0 authorization code flow with PKCE). The browser returns to JabRef's HTTP server; if it is disabled, JabRef asks the user to enable it and only then opens the browser. +`jabsrv --citedrive-login` offers the same login without the GUI: it prints the login address instead of opening the browser. A login not completed within ten minutes fails. The refresh token is stored in the system keyring only, never in the preferences. diff --git a/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java b/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java index 9a48618721c5..6217383e8585 100644 --- a/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java +++ b/jabsrv-cli/src/main/java/org/jabref/http/server/cli/ServerCli.java @@ -8,11 +8,15 @@ import java.util.ArrayList; import java.util.List; import java.util.concurrent.Callable; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeoutException; import org.jabref.architecture.AllowedToUseStandardStreams; import org.jabref.http.server.Server; +import org.jabref.logic.citedrive.CiteDriveOAuthService; import org.jabref.logic.citedrive.OAuthSessionRegistry; import org.jabref.logic.preferences.JabRefCliPreferences; +import org.jabref.logic.remote.RemotePreferences; import org.glassfish.grizzly.http.server.HttpServer; import org.slf4j.Logger; @@ -22,7 +26,7 @@ @AllowedToUseStandardStreams("This is a CLI application. It resides in the package http.server to be close to the other http server related classes.") @CommandLine.Command(name = "jabsrv", mixinStandardHelpOptions = true, description = "JabSrv - JabRef HTTP server") -public class ServerCli implements Callable { +public class ServerCli implements Callable { private static final Logger LOGGER = LoggerFactory.getLogger(ServerCli.class); @CommandLine.Parameters(arity = "0..*", paramLabel = "FILE", description = "the library files (*.bib) to serve") @@ -34,6 +38,9 @@ public class ServerCli implements Callable { @CommandLine.Option(names = {"-p", "--port"}, description = "the port") private Integer port = 23119; + @CommandLine.Option(names = "--citedrive-login", description = "log in to CiteDrive in the browser, remember the login, and exit") + private boolean citeDriveLogin; + /// Starts an http server serving the last files opened in JabRef /// /// More files can be provided as args. @@ -43,11 +50,13 @@ public static void main(final String[] args) throws InterruptedException { SLF4JBridgeHandler.removeHandlersForRootLogger(); SLF4JBridgeHandler.install(); - new CommandLine(new ServerCli()).execute(args); + int exitCode = new CommandLine(new ServerCli()).execute(args); + // Only reached after --citedrive-login: serving blocks until the process is killed + System.exit(exitCode); } @Override - public Void call() throws InterruptedException, IOException { + public Integer call() throws InterruptedException, IOException { JabRefCliPreferences preferences = JabRefCliPreferences.getInstance(); // The server serves the last opened files (see org.jabref.http.server.resources.LibraryResource.getLibraryPath) @@ -71,17 +80,71 @@ public Void call() throws InterruptedException, IOException { uri = new URI(url); } catch (URISyntaxException _) { LOGGER.error("Invalid URL: {}", url); - return null; + return 1; } - // A standalone jabsrv never starts a CiteDrive login (that needs the GUI), so no login can be pending: - // the callback endpoint answers every callback with "login could not be completed" - Server server = new Server(preferences, new OAuthSessionRegistry()); + // Only --citedrive-login registers a pending login here; without it, the callback endpoint + // answers every callback with "login could not be completed" + OAuthSessionRegistry oAuthSessionRegistry = new OAuthSessionRegistry(); + Server server = new Server(preferences, oAuthSessionRegistry); HttpServer httpServer = server.run(filesToServe, uri); + if (citeDriveLogin) { + try { + return logInToCiteDrive(preferences, oAuthSessionRegistry, uri); + } finally { + httpServer.shutdownNow(); + } + } + // Keep the http server running until user kills the process (e.g., presses Ctrl+C) Thread.currentThread().join(); - return null; + return 0; + } + + /// The same flow as in the GUI, with the browser URL printed instead of opened. The refresh token ends up in the keyring, so JabRef itself is logged in afterwards. + /// + /// [impl->req~citedrive.login~1] + /// + /// @return the process exit code + private static int logInToCiteDrive(JabRefCliPreferences preferences, OAuthSessionRegistry oAuthSessionRegistry, URI serverUri) throws InterruptedException { + RemotePreferences remotePreferences = preferences.getRemotePreferences(); + + // CiteDrive redirects the browser to the HTTP server address from the preferences: that has to be this server + int callbackPort = remotePreferences.getHttpServerUri().getPort(); + if (callbackPort != serverUri.getPort()) { + System.err.printf("CiteDrive redirects the browser to port %d (JabRef's HTTP server port), but jabsrv listens on port %d. Use --port %d.%n", callbackPort, serverUri.getPort(), callbackPort); + return 1; + } + + if (!preferences.getCiteDrivePreferences().shouldPersistRefreshToken()) { + System.err.println("JabRef is set to forget the CiteDrive login between sessions, so a login from jabsrv would be lost on exit. Enable \"Remember the login between sessions\" in JabRef's preferences."); + return 1; + } + + CiteDriveOAuthService oAuthService = new CiteDriveOAuthService( + remotePreferences, + preferences.getCiteDrivePreferences(), + oAuthSessionRegistry, + authUrl -> System.out.println("Open this address in your browser to log in to CiteDrive:\n" + authUrl), + // This server already receives the callback, whatever the preferences say + () -> true); + + try { + if (oAuthService.authorizeInteractive().get().isPresent()) { + System.out.println("Logged in to CiteDrive."); + return 0; + } + System.err.println("CiteDrive login failed: could not obtain access token."); + } catch (ExecutionException e) { + if (e.getCause() instanceof TimeoutException) { + System.err.println("CiteDrive login failed: login was not completed in time."); + } else { + LOGGER.error("CiteDrive login failed", e.getCause()); + System.err.println("CiteDrive login failed: " + e.getCause().getLocalizedMessage()); + } + } + return 1; } } From f679eb538e8d23993873c368e26a77e7f237e25c Mon Sep 17 00:00:00 2001 From: Siedlerchr Date: Mon, 19 Oct 2026 22:50:19 +0200 Subject: [PATCH 80/83] fix(citedrive): secure OAuth token handling Bind stored credentials and uploads to the issuing server. Reject insecure endpoints and discard stale authentication responses. Share refresh requests to avoid rotating-token reuse. Bound token network operations and preserve credentials after transient failures. --- docs/code-howtos/http-server.md | 18 ++ docs/requirements/citedrive.md | 40 +++ .../gui/citedrive/CiteDrivePushAction.java | 11 +- .../ExternalStoragesTabViewModel.java | 5 +- .../gui/citedrive/CiteDriveOAuthTest.java | 8 +- .../ExternalStoragesTabViewModelTest.java | 26 ++ jablib/src/main/java/module-info.java | 3 + .../citedrive/CiteDriveOAuthService.java | 179 ++++++++--- .../jabref/logic/citedrive/CiteDrivePush.java | 6 +- .../logic/citedrive/OAuthSessionRegistry.java | 28 ++ .../logic/net/CiteDrivePreferences.java | 55 +++- .../preferences/JabRefCliPreferences.java | 23 +- .../main/resources/l10n/JabRef_en.properties | 2 +- .../citedrive/CiteDriveOAuthServiceTest.java | 293 ++++++++++++++++-- .../logic/citedrive/CiteDrivePushTest.java | 94 ++++++ .../logic/net/CiteDrivePreferencesTest.java | 58 ++++ .../CiteDriveTokenStorageTest.java | 30 ++ 17 files changed, 789 insertions(+), 90 deletions(-) create mode 100644 jabgui/src/test/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModelTest.java create mode 100644 jablib/src/test/java/org/jabref/logic/net/CiteDrivePreferencesTest.java create mode 100644 jablib/src/test/java/org/jabref/logic/preferences/CiteDriveTokenStorageTest.java diff --git a/docs/code-howtos/http-server.md b/docs/code-howtos/http-server.md index 320a5f0fec11..2753fd8310be 100644 --- a/docs/code-howtos/http-server.md +++ b/docs/code-howtos/http-server.md @@ -83,6 +83,24 @@ JabRef's HTTP server port from the preferences has to be the port `jabsrv` liste ./gradlew :jabsrv-cli:run --args="--citedrive-login" ``` +### CiteDrive authentication security + +CiteDrive's API and web application addresses must use HTTPS; only the local browser callback uses HTTP. +Each authentication operation captures its server settings, and uploads use the address associated with their access token. +Changing the API address clears the login and prevents pending responses from restoring credentials for the previous configuration. +The keyring stores the API address alongside the refresh token; existing tokens without that binding require another login. + +Concurrent token requests share one authentication operation to support refresh token rotation. +Both token exchange and refresh use a ten-second connection timeout and a thirty-second read timeout, with redirects disabled. +The code exchange runs asynchronously so that a slow token endpoint does not block the callback response. +Temporary errors preserve the stored login; an HTTP 400 `invalid_grant` response starts another browser login. + +The current upload sends all entries from the active library in a single BibTeX request to `/jabref/push/`. +Each upload therefore uses one request from the endpoint's current allowance of 100 requests per hour per user; the server's payload size limit is a separate constraint. +`CiteDrivePushTest` verifies batches of two and one thousand entries by parsing the prepared request back into entries. +Setting the test JVM system property `citedrive.batch.fixture` to a generated 100,000-entry library adds that fixture to the same check. +The test records the payload size and preparation timings without contacting CiteDrive. + ## Developing with IntelliJ IntelliJ Ultimate offers a Markdown-based http-client. You need to open the file `jabsrv/src/test/rest-api.http`. diff --git a/docs/requirements/citedrive.md b/docs/requirements/citedrive.md index 0d4cec251596..f5e4df8e8c06 100644 --- a/docs/requirements/citedrive.md +++ b/docs/requirements/citedrive.md @@ -30,4 +30,44 @@ After a successful push, JabRef opens the CiteDrive page where the user chooses Needs: impl +## CiteDrive credentials must remain bound to their server +`req~citedrive.credentials.server~1` + +Changing the API address invalidates the saved login, including pending authentication responses. +Stored refresh tokens are loaded only for the address that issued them. +An upload uses the API address captured when its access token was requested. + +Needs: impl, utest + +## CiteDrive server addresses must use HTTPS +`req~citedrive.https~1` + +The authorization, token, upload, and web application addresses must use HTTPS. +The browser callback remains on the local HTTP loopback listener. + +Needs: impl, utest + +## Concurrent CiteDrive token requests must share one authentication operation +`req~citedrive.refresh.single-request~1` + +Requests for the same server configuration share an outstanding token request so that rotating refresh tokens are not reused concurrently. + +Needs: impl, utest + +## CiteDrive token requests must have finite network timeouts +`req~citedrive.token.timeout~1` + +Authorization code exchange and refresh use a ten-second connection timeout and a thirty-second read timeout. +Token exchange runs outside the browser callback request thread. + +Needs: impl, utest + +## CiteDrive must preserve the login after retryable refresh failures +`req~citedrive.refresh.failure~1` + +Network, parsing, rate limit, server, and client configuration failures retain the refresh token without starting browser authentication. +Only an `invalid_grant` response with HTTP status 400 clears the token and starts another login. + +Needs: impl, utest + diff --git a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java index 3d5a75933137..945010883afb 100644 --- a/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java +++ b/jabgui/src/main/java/org/jabref/gui/citedrive/CiteDrivePushAction.java @@ -51,17 +51,18 @@ public void execute() { .toList(); citeDriveOAuthService - .getAccessToken() + .getAuthorizedSession() // Async: the token may arrive on the HTTP server thread; the push itself is network I/O - .thenAcceptAsync(accessTokenOpt -> { - if (accessTokenOpt.isEmpty()) { + .thenAcceptAsync(sessionOpt -> { + if (sessionOpt.isEmpty()) { dialogService.notify(Localization.lang("CiteDrive push failed: could not obtain access token.")); return; } + CiteDriveOAuthService.AuthorizedSession session = sessionOpt.orElseThrow(); try { - if (CiteDrivePush.push(database, entries, accessTokenOpt.get(), preferences, dialogService)) { + if (CiteDrivePush.push(database, entries, session.accessToken(), preferences, dialogService, session.pushEndpoint())) { // [impl->req~citedrive.push.import-page~1] - UiTaskExecutor.runInJavaFXThread(() -> NativeDesktop.openBrowserShowPopup(preferences.getCiteDrivePreferences().getImportPage().toASCIIString(), dialogService, preferences.getExternalApplicationsPreferences())); + UiTaskExecutor.runInJavaFXThread(() -> NativeDesktop.openBrowserShowPopup(session.importPage().toASCIIString(), dialogService, preferences.getExternalApplicationsPreferences())); } } catch (IOException e) { LOGGER.error("CiteDrive push failed", e); diff --git a/jabgui/src/main/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModel.java b/jabgui/src/main/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModel.java index d1d1d6b2e1d7..2a72ef93d2c9 100644 --- a/jabgui/src/main/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModel.java +++ b/jabgui/src/main/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModel.java @@ -8,7 +8,6 @@ import org.jabref.gui.preferences.PreferenceTabViewModel; import org.jabref.logic.l10n.Localization; import org.jabref.logic.net.CiteDrivePreferences; -import org.jabref.logic.util.URLUtil; import de.saxsys.mvvmfx.utils.validation.FunctionBasedValidator; import de.saxsys.mvvmfx.utils.validation.ValidationMessage; @@ -39,11 +38,11 @@ public ExternalStoragesTabViewModel(CiteDrivePreferences citeDrivePreferences) { private static Validator urlValidator(StringProperty url, String fieldName) { return new FunctionBasedValidator<>( url, - URLUtil::isValidHttpUrl, + CiteDrivePreferences::isSecureUrl, ValidationMessage.error("%s > %s %n %n %s".formatted( Localization.lang("External storages"), fieldName, - Localization.lang("Please enter a valid URL")))); + Localization.lang("Please enter a valid HTTPS URL")))); } @Override diff --git a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java index 9edf6c7aeffd..cce52c020759 100644 --- a/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java +++ b/jabgui/src/test/java/org/jabref/gui/citedrive/CiteDriveOAuthTest.java @@ -66,11 +66,9 @@ void getToken() throws ExecutionException, InterruptedException { when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); when(remotePreferences.shouldEnableHttpServer()).thenReturn(true); - CiteDrivePreferences citeDrivePreferences = mock(CiteDrivePreferences.class); + CiteDrivePreferences citeDrivePreferences = CiteDrivePreferences.getDefault(); CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(remotePreferences, citeDrivePreferences, OAUTH_SESSION_REGISTRY, uri -> NativeDesktop.openBrowserShowPopup(uri.toASCIIString(), mock(DialogService.class), externalApplicationsPreferences), () -> true, URI.create("https://api-dev.citedrive.com/jabref/login/"), URI.create("https://api-dev.citedrive.com/o/token/")); - // When testing with https://github.com/navikt/mock-oauth2-server - docker run -p 8080:8080 -h localhost -it --rm ghcr.io/navikt/mock-oauth2-server - // Use URI.create("http://localhost:8080/default/authorize") and URI.create("http://localhost:8080/default/token") as endpoints Optional actual = citeDriveOAuthService.authorizeInteractive().get(); assertTrue(actual.isPresent()); @@ -88,7 +86,7 @@ void putLibraryOAuthFromScratch() throws ExecutionException, InterruptedExceptio when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); when(remotePreferences.shouldEnableHttpServer()).thenReturn(true); - CiteDrivePreferences citeDrivePreferences = mock(CiteDrivePreferences.class); + CiteDrivePreferences citeDrivePreferences = CiteDrivePreferences.getDefault(); CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(remotePreferences, citeDrivePreferences, OAUTH_SESSION_REGISTRY, uri -> NativeDesktop.openBrowserShowPopup(uri.toASCIIString(), mock(DialogService.class), externalApplicationsPreferences), () -> true, URI.create("https://api-dev.citedrive.com/jabref/login/"), URI.create("https://api-dev.citedrive.com/o/token/")); @@ -131,7 +129,7 @@ void putLibrary() throws ExecutionException, InterruptedException, IOException { when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://localhost:23119")); when(remotePreferences.shouldEnableHttpServer()).thenReturn(true); - CiteDrivePreferences citeDrivePreferences = mock(CiteDrivePreferences.class); + CiteDrivePreferences citeDrivePreferences = CiteDrivePreferences.getDefault(); CiteDriveOAuthService citeDriveOAuthService = new CiteDriveOAuthService(remotePreferences, citeDrivePreferences, OAUTH_SESSION_REGISTRY, uri -> NativeDesktop.openBrowserShowPopup(uri.toASCIIString(), mock(DialogService.class), externalApplicationsPreferences), () -> true, URI.create("https://api-dev.citedrive.com/jabref/login/"), URI.create("https://api-dev.citedrive.com/o/token/")); diff --git a/jabgui/src/test/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModelTest.java b/jabgui/src/test/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModelTest.java new file mode 100644 index 000000000000..d16c17f9e039 --- /dev/null +++ b/jabgui/src/test/java/org/jabref/gui/preferences/externalstorages/ExternalStoragesTabViewModelTest.java @@ -0,0 +1,26 @@ +package org.jabref.gui.preferences.externalstorages; + +import org.jabref.logic.net.CiteDrivePreferences; + +import org.jspecify.annotations.NullMarked; +import org.junit.jupiter.api.parallel.ResourceLock; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +import static org.junit.jupiter.api.Assertions.assertFalse; + +@NullMarked +@ResourceLock("Localization.lang") +class ExternalStoragesTabViewModelTest { + + @ParameterizedTest + @ValueSource(strings = {"http://api.example/", "http://127.0.0.1:8080/"}) + void rejectsUnencryptedApiAddress(String address) { + ExternalStoragesTabViewModel viewModel = new ExternalStoragesTabViewModel(CiteDrivePreferences.getDefault()); + viewModel.setValues(); + + viewModel.citeDriveApiBaseUrlProperty().set(address); + + assertFalse(viewModel.validateSettings()); + } +} diff --git a/jablib/src/main/java/module-info.java b/jablib/src/main/java/module-info.java index a5f546823e0f..7dfd9f1192a8 100644 --- a/jablib/src/main/java/module-info.java +++ b/jablib/src/main/java/module-info.java @@ -5,8 +5,11 @@ /// Entry points: [org.jabref.model.database.BibDatabaseContext] (an open library), /// [org.jabref.model.entry.BibEntry], [org.jabref.logic.importer.ImportFormatReader], /// [org.jabref.logic.exporter.ExporterFactory]. +/// CiteDrive authentication and uploads are coordinated by [org.jabref.logic.citedrive.CiteDriveOAuthService]; +/// its authorized sessions keep credentials bound to their upload address. /// /// @see Architecture and components +/// @see CiteDrive authentication security open module org.jabref.jablib { exports org.jabref.model; exports org.jabref.model.undo; diff --git a/jablib/src/main/java/org/jabref/logic/citedrive/CiteDriveOAuthService.java b/jablib/src/main/java/org/jabref/logic/citedrive/CiteDriveOAuthService.java index b0c89cb77d18..916415ac6249 100644 --- a/jablib/src/main/java/org/jabref/logic/citedrive/CiteDriveOAuthService.java +++ b/jablib/src/main/java/org/jabref/logic/citedrive/CiteDriveOAuthService.java @@ -8,6 +8,7 @@ import java.util.concurrent.CompletionException; import java.util.function.BooleanSupplier; import java.util.function.Consumer; +import java.util.function.Supplier; import org.jabref.logic.JabRefException; import org.jabref.logic.l10n.Localization; @@ -20,6 +21,7 @@ import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; import com.nimbusds.oauth2.sdk.AuthorizationGrant; import com.nimbusds.oauth2.sdk.AuthorizationRequest; +import com.nimbusds.oauth2.sdk.OAuth2Error; import com.nimbusds.oauth2.sdk.ParseException; import com.nimbusds.oauth2.sdk.RefreshTokenGrant; import com.nimbusds.oauth2.sdk.ResponseType; @@ -27,6 +29,8 @@ import com.nimbusds.oauth2.sdk.TokenErrorResponse; import com.nimbusds.oauth2.sdk.TokenRequest; import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.http.HTTPRequest; +import com.nimbusds.oauth2.sdk.http.HTTPResponse; import com.nimbusds.oauth2.sdk.id.ClientID; import com.nimbusds.oauth2.sdk.id.State; import com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod; @@ -46,9 +50,12 @@ public class CiteDriveOAuthService { private static final Logger LOGGER = LoggerFactory.getLogger(CiteDriveOAuthService.class); private static final ClientID CLIENT_ID = new ClientID("jabref-desktop"); + private static final int CONNECT_TIMEOUT_MILLIS = 10_000; + private static final int READ_TIMEOUT_MILLIS = 30_000; - private final URI authEndpoint; - private final URI tokenEndpoint; + private final Supplier authEndpoint; + private final Supplier tokenEndpoint; + private final TokenRequestSender tokenRequestSender; private final RemotePreferences remotePreferences; private final CiteDrivePreferences citeDrivePreferences; @@ -63,7 +70,8 @@ public CiteDriveOAuthService(RemotePreferences remotePreferences, OAuthSessionRegistry sessionRegistry, Consumer authorizationPageOpener, BooleanSupplier callbackServerEnabler) { - this(remotePreferences, citeDrivePreferences, sessionRegistry, authorizationPageOpener, callbackServerEnabler, citeDrivePreferences.getAuthorizationEndpoint(), citeDrivePreferences.getTokenEndpoint()); + this(remotePreferences, citeDrivePreferences, sessionRegistry, authorizationPageOpener, callbackServerEnabler, + citeDrivePreferences::getAuthorizationEndpoint, citeDrivePreferences::getTokenEndpoint, HTTPRequest::send); } @VisibleForTesting @@ -74,6 +82,29 @@ public CiteDriveOAuthService(RemotePreferences remotePreferences, BooleanSupplier callbackServerEnabler, URI authEndpoint, URI tokenEndpoint) { + this(remotePreferences, citeDrivePreferences, sessionRegistry, authorizationPageOpener, callbackServerEnabler, + () -> authEndpoint, () -> tokenEndpoint, HTTPRequest::send); + } + + @VisibleForTesting + CiteDriveOAuthService(RemotePreferences remotePreferences, + CiteDrivePreferences citeDrivePreferences, + OAuthSessionRegistry sessionRegistry, + Consumer authorizationPageOpener, + BooleanSupplier callbackServerEnabler, + TokenRequestSender tokenRequestSender) { + this(remotePreferences, citeDrivePreferences, sessionRegistry, authorizationPageOpener, callbackServerEnabler, + citeDrivePreferences::getAuthorizationEndpoint, citeDrivePreferences::getTokenEndpoint, tokenRequestSender); + } + + private CiteDriveOAuthService(RemotePreferences remotePreferences, + CiteDrivePreferences citeDrivePreferences, + OAuthSessionRegistry sessionRegistry, + Consumer authorizationPageOpener, + BooleanSupplier callbackServerEnabler, + Supplier authEndpoint, + Supplier tokenEndpoint, + TokenRequestSender tokenRequestSender) { this.remotePreferences = remotePreferences; this.citeDrivePreferences = citeDrivePreferences; this.sessionRegistry = sessionRegistry; @@ -81,6 +112,7 @@ public CiteDriveOAuthService(RemotePreferences remotePreferences, this.callbackServerEnabler = callbackServerEnabler; this.authEndpoint = authEndpoint; this.tokenEndpoint = tokenEndpoint; + this.tokenRequestSender = tokenRequestSender; } /// Lets the user log in in the browser. Also stores the refresh token. @@ -89,6 +121,13 @@ public CiteDriveOAuthService(RemotePreferences remotePreferences, /// /// Fails if the HTTP server receiving the browser redirect is disabled, or if the user does not finish logging in in time. public CompletableFuture> authorizeInteractive() { + return authorizeInteractive(snapshotConfiguration()).thenApply(session -> session.map(AuthorizedSession::accessToken)); + } + + private CompletableFuture> authorizeInteractive(ServerConfiguration configuration) { + if (!configuration.isSecure() || configuration.revision() != citeDrivePreferences.getServerRevision()) { + return CompletableFuture.failedFuture(loginFailure("Invalid or changed CiteDrive server configuration")); + } if (!remotePreferences.shouldEnableHttpServer() && !callbackServerEnabler.getAsBoolean()) { return CompletableFuture.failedFuture(new JabRefException( "HTTP server disabled", @@ -101,8 +140,8 @@ public CompletableFuture> authorizeInteractive() { CompletableFuture codeFuture = sessionRegistry.register(state); URI authUrl = new AuthorizationRequest.Builder(ResponseType.CODE, CLIENT_ID) - .endpointURI(authEndpoint) - .redirectionURI(getCallBackUri()) + .endpointURI(configuration.authEndpoint()) + .redirectionURI(configuration.callbackUri()) .state(new State(state)) .scope(new Scope("read", "write")) // required for CiteDrive API .codeChallenge(codeVerifier, CodeChallengeMethod.S256) @@ -110,21 +149,22 @@ public CompletableFuture> authorizeInteractive() { .toURI(); authorizationPageOpener.accept(authUrl); - return codeFuture.thenApply(code -> exchangeCodeForToken(code, codeVerifier)); + return codeFuture.thenApplyAsync(code -> exchangeCodeForToken(code, codeVerifier, configuration)); } - /// Redirects to [org.jabref.http.server.resources.callback.CallbackResource#citeDriveCallback] private URI getCallBackUri() { - // "/callback" is standard for OAuth2 redirect URIs return remotePreferences.getHttpServerUri().resolve("/callback"); } /// Also stores the refresh token - private Optional exchangeCodeForToken(String code, CodeVerifier codeVerifier) { - AuthorizationGrant codeGrant = new AuthorizationCodeGrant(new AuthorizationCode(code), getCallBackUri(), codeVerifier); + private Optional exchangeCodeForToken(String code, CodeVerifier codeVerifier, ServerConfiguration configuration) { + if (configuration.revision() != citeDrivePreferences.getServerRevision()) { + return Optional.empty(); + } + AuthorizationGrant codeGrant = new AuthorizationCodeGrant(new AuthorizationCode(code), configuration.callbackUri(), codeVerifier); TokenResponse response; try { - response = TokenResponse.parse(new TokenRequest(tokenEndpoint, CLIENT_ID, codeGrant).toHTTPRequest().send()); + response = sendTokenRequest(configuration.tokenEndpoint(), codeGrant); } catch (ParseException | IOException e) { LOGGER.error("Could not obtain CiteDrive token", e); return Optional.empty(); @@ -135,12 +175,10 @@ private Optional exchangeCodeForToken(String code, CodeVerifier cod return Optional.empty(); } AccessTokenResponse successResponse = response.toSuccessResponse(); - RefreshToken newRefreshToken = successResponse.getTokens().getRefreshToken(); - // Some providers may omit refresh_token; keep the stored one in that case - if (newRefreshToken != null) { - citeDrivePreferences.setRefreshToken(newRefreshToken); + if (!citeDrivePreferences.updateRefreshToken(configuration.revision(), Optional.ofNullable(successResponse.getTokens().getRefreshToken()))) { + return Optional.empty(); } - return Optional.of(successResponse.getTokens().getAccessToken()); + return Optional.of(configuration.authorizedSession(successResponse.getTokens().getAccessToken())); } /// Refreshes the access token using the stored refresh token. @@ -148,44 +186,109 @@ private Optional exchangeCodeForToken(String code, CodeVerifier cod /// /// Also stores the refresh token public CompletableFuture> getAccessToken() { - RefreshToken cachedRefreshToken = citeDrivePreferences.getRefreshToken(); - if (cachedRefreshToken == null) { - return authorizeInteractive(); + return getAuthorizedSession().thenApply(session -> session.map(AuthorizedSession::accessToken)); + } + + /// Pins the upload and import addresses to the server that issued the access token. + /// + /// [impl->req~citedrive.credentials.server~1] + public CompletableFuture> getAuthorizedSession() { + ServerConfiguration configuration = snapshotConfiguration(); + if (!configuration.isSecure()) { + return CompletableFuture.failedFuture(loginFailure("CiteDrive requires HTTPS server addresses")); } - return CompletableFuture.supplyAsync(() -> refreshToken(cachedRefreshToken)) - .thenCompose(token -> { - if (token.isPresent()) { - return CompletableFuture.completedFuture(token); - } - LOGGER.info("Refresh token rejected, falling back to interactive authentication"); - return authorizeInteractive(); - }); + return sessionRegistry.requestToken(citeDrivePreferences, configuration.revision(), () -> { + Optional cachedRefreshToken; + synchronized (citeDrivePreferences) { + if (configuration.revision() != citeDrivePreferences.getServerRevision()) { + return CompletableFuture.failedFuture(loginFailure("CiteDrive server configuration changed")); + } + cachedRefreshToken = Optional.ofNullable(citeDrivePreferences.getRefreshToken()); + } + return cachedRefreshToken.map(refreshToken -> CompletableFuture.supplyAsync(() -> refreshToken(refreshToken, configuration)) + .thenCompose(session -> session.map(value -> CompletableFuture.completedFuture(Optional.of(value))) + .orElseGet(() -> authorizeInteractive(configuration)))) + .orElseGet(() -> authorizeInteractive(configuration)); + }); } /// @return empty if CiteDrive rejected the refresh token (it is then removed) /// @throws CompletionException on network or parse errors; the refresh token is kept to retry later - private Optional refreshToken(RefreshToken refreshToken) { + /// + /// [impl->req~citedrive.refresh.failure~1] + private Optional refreshToken(RefreshToken refreshToken, ServerConfiguration configuration) { + if (configuration.revision() != citeDrivePreferences.getServerRevision()) { + throw new CompletionException(loginFailure("CiteDrive server configuration changed")); + } TokenResponse response; try { - TokenRequest request = new TokenRequest(tokenEndpoint, CLIENT_ID, new RefreshTokenGrant(refreshToken)); - response = TokenResponse.parse(request.toHTTPRequest().send()); + response = sendTokenRequest(configuration.tokenEndpoint(), new RefreshTokenGrant(refreshToken)); } catch (IOException | ParseException e) { + LOGGER.warn("Could not refresh CiteDrive token", e); throw new CompletionException(e); } if (!response.indicatesSuccess()) { - LOGGER.warn("Refresh token failed: {}", response.toErrorResponse().getErrorObject().toJSONObject()); - citeDrivePreferences.setRefreshToken(null); - return Optional.empty(); + var error = response.toErrorResponse().getErrorObject(); + LOGGER.warn("Refresh token failed: {}", error.toJSONObject()); + if (OAuth2Error.INVALID_GRANT.getCode().equals(error.getCode()) && error.getHTTPStatusCode() == HTTPResponse.SC_BAD_REQUEST) { + citeDrivePreferences.updateRefreshToken(configuration.revision(), Optional.empty()); + return Optional.empty(); + } + throw new CompletionException(loginFailure("CiteDrive token endpoint failed: " + error.getCode())); } AccessTokenResponse successResponse = response.toSuccessResponse(); - RefreshToken newRefreshToken = successResponse.getTokens().getRefreshToken(); - // Some providers may omit refresh_token on refresh; keep the old one in that case - if (newRefreshToken != null) { - citeDrivePreferences.setRefreshToken(newRefreshToken); + Optional newRefreshToken = Optional.ofNullable(successResponse.getTokens().getRefreshToken()).or(() -> Optional.of(refreshToken)); + if (!citeDrivePreferences.updateRefreshToken(configuration.revision(), newRefreshToken)) { + throw new CompletionException(loginFailure("CiteDrive server configuration changed")); + } + return Optional.of(configuration.authorizedSession(successResponse.getTokens().getAccessToken())); + } + + // [impl->req~citedrive.token.timeout~1] + private TokenResponse sendTokenRequest(URI endpoint, AuthorizationGrant grant) throws IOException, ParseException { + HTTPRequest request = new TokenRequest.Builder(endpoint, CLIENT_ID, grant).build().toHTTPRequest(); + request.setConnectTimeout(CONNECT_TIMEOUT_MILLIS); + request.setReadTimeout(READ_TIMEOUT_MILLIS); + request.setFollowRedirects(false); + return TokenResponse.parse(tokenRequestSender.send(request)); + } + + private ServerConfiguration snapshotConfiguration() { + synchronized (citeDrivePreferences) { + return new ServerConfiguration(citeDrivePreferences.getServerRevision(), authEndpoint.get(), tokenEndpoint.get(), + getCallBackUri(), citeDrivePreferences.getPushEndpoint(), citeDrivePreferences.getImportPage()); + } + } + + private static JabRefException loginFailure(String message) { + return new JabRefException(message, Localization.lang("Login could not be completed")); + } + + /// An access token can only be uploaded to the address captured with its authentication operation. + @NullMarked + public record AuthorizedSession(AccessToken accessToken, URI pushEndpoint, URI importPage) { + } + + @FunctionalInterface + @NullMarked + interface TokenRequestSender { + HTTPResponse send(HTTPRequest request) throws IOException; + } + + @NullMarked + private record ServerConfiguration(long revision, URI authEndpoint, URI tokenEndpoint, URI callbackUri, URI pushEndpoint, URI importPage) { + boolean isSecure() { + return CiteDrivePreferences.isSecureUrl(authEndpoint.toString()) + && CiteDrivePreferences.isSecureUrl(tokenEndpoint.toString()) + && CiteDrivePreferences.isSecureUrl(pushEndpoint.toString()) + && CiteDrivePreferences.isSecureUrl(importPage.toString()); + } + + AuthorizedSession authorizedSession(AccessToken accessToken) { + return new AuthorizedSession(accessToken, pushEndpoint, importPage); } - return Optional.of(successResponse.getTokens().getAccessToken()); } } diff --git a/jablib/src/main/java/org/jabref/logic/citedrive/CiteDrivePush.java b/jablib/src/main/java/org/jabref/logic/citedrive/CiteDrivePush.java index f135d7293389..199d4848bbc9 100644 --- a/jablib/src/main/java/org/jabref/logic/citedrive/CiteDrivePush.java +++ b/jablib/src/main/java/org/jabref/logic/citedrive/CiteDrivePush.java @@ -10,6 +10,7 @@ import org.jabref.logic.exporter.SelfContainedSaveConfiguration; import org.jabref.logic.importer.util.MediaTypes; import org.jabref.logic.l10n.Localization; +import org.jabref.logic.net.CiteDrivePreferences; import org.jabref.logic.preferences.CliPreferences; import org.jabref.logic.util.NotificationService; import org.jabref.model.database.BibDatabaseContext; @@ -39,7 +40,10 @@ public static boolean push(BibDatabaseContext context, List entries, A return push(context, entries, accessToken, cliPreferences, notificationService, cliPreferences.getCiteDrivePreferences().getPushEndpoint()); } - static boolean push(BibDatabaseContext context, List entries, AccessToken accessToken, CliPreferences cliPreferences, NotificationService notificationService, URI pushEndpoint) throws IOException { + public static boolean push(BibDatabaseContext context, List entries, AccessToken accessToken, CliPreferences cliPreferences, NotificationService notificationService, URI pushEndpoint) throws IOException { + if (!CiteDrivePreferences.isSecureUrl(pushEndpoint.toString())) { + throw new IOException(Localization.lang("Please enter a valid HTTPS URL")); + } StringWriter writer = new StringWriter(); SelfContainedSaveConfiguration exportConfiguration = cliPreferences.getSelfContainedExportConfiguration(); SelfContainedSaveConfiguration plainBibtex = new SelfContainedSaveConfiguration( diff --git a/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java b/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java index 27758685c61b..a80c04c9687e 100644 --- a/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java +++ b/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java @@ -1,9 +1,13 @@ package org.jabref.logic.citedrive; import java.util.Map; +import java.util.Optional; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; + +import org.jabref.logic.net.CiteDrivePreferences; import org.jspecify.annotations.NullMarked; import org.slf4j.Logger; @@ -19,6 +23,30 @@ public class OAuthSessionRegistry { private static final Logger LOGGER = LoggerFactory.getLogger(OAuthSessionRegistry.class); private final Map> pending = new ConcurrentHashMap<>(); + private final Map>> tokenRequests = new ConcurrentHashMap<>(); + + // [impl->req~citedrive.refresh.single-request~1] + CompletableFuture> requestToken( + CiteDrivePreferences preferences, long revision, + Supplier>> request) { + TokenRequestKey key = new TokenRequestKey(preferences, revision); + CompletableFuture> candidate = new CompletableFuture<>(); + CompletableFuture> shared = Optional.ofNullable(tokenRequests.putIfAbsent(key, candidate)) + .orElseGet(() -> { + CompletableFuture.completedFuture(true) + .thenCompose(_ -> request.get()) + .whenComplete((session, failure) -> { + tokenRequests.remove(key, candidate); + Optional.ofNullable(failure).ifPresentOrElse(candidate::completeExceptionally, () -> candidate.complete(session)); + }); + return candidate; + }); + return shared.copy(); + } + + @NullMarked + private record TokenRequestKey(CiteDrivePreferences preferences, long revision) { + } /// @return the authorization code; fails with a `TimeoutException` if no callback arrives in time public CompletableFuture register(String state) { diff --git a/jablib/src/main/java/org/jabref/logic/net/CiteDrivePreferences.java b/jablib/src/main/java/org/jabref/logic/net/CiteDrivePreferences.java index 041e901a7c27..abbf5443793e 100644 --- a/jablib/src/main/java/org/jabref/logic/net/CiteDrivePreferences.java +++ b/jablib/src/main/java/org/jabref/logic/net/CiteDrivePreferences.java @@ -1,6 +1,8 @@ package org.jabref.logic.net; import java.net.URI; +import java.net.URISyntaxException; +import java.util.Optional; import javafx.beans.property.BooleanProperty; import javafx.beans.property.ObjectProperty; @@ -15,22 +17,27 @@ import com.nimbusds.oauth2.sdk.token.RefreshToken; import org.jspecify.annotations.NullMarked; import org.jspecify.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; @NullMarked public class CiteDrivePreferences { + private static final Logger LOGGER = LoggerFactory.getLogger(CiteDrivePreferences.class); + /// OAuth tokens /// /// - Refresh token (long-lived, confidential). -- could be unavailable; therefore "Optional" /// - Access token (short-lived) - not stored here private final BooleanProperty enabled; - private final ObjectProperty refreshToken; + private final ObjectProperty<@Nullable RefreshToken> refreshToken; private final BooleanProperty persistRefreshToken; /// CiteDrive REST API (OAuth and push endpoints); the dev server until CiteDrive goes live private final StringProperty apiBaseUrl; /// CiteDrive web app, where the user completes an import private final StringProperty appBaseUrl; + private long serverRevision; public CiteDrivePreferences(boolean enabled, @Nullable RefreshToken refreshToken, @@ -42,6 +49,7 @@ public CiteDrivePreferences(boolean enabled, this.persistRefreshToken = new SimpleBooleanProperty(persistRefreshToken); this.apiBaseUrl = new SimpleStringProperty(apiBaseUrl); this.appBaseUrl = new SimpleStringProperty(appBaseUrl); + this.apiBaseUrl.addListener((_, _, _) -> invalidateLogin()); } // Creates object with default preference values @@ -55,16 +63,47 @@ private CiteDrivePreferences() { ); } + private synchronized void invalidateLogin() { + serverRevision++; + refreshToken.setValue(null); + } + + public synchronized long getServerRevision() { + return serverRevision; + } + + /// A response from an earlier server configuration must not overwrite the current login. + public synchronized boolean updateRefreshToken(long revision, Optional token) { + if (revision != serverRevision) { + return false; + } + token.ifPresentOrElse(this::setRefreshToken, () -> refreshToken.setValue(null)); + return true; + } + + // [impl->req~citedrive.https~1] + public static boolean isSecureUrl(String url) { + try { + URI uri = new URI(url); + return "https".equalsIgnoreCase(uri.getScheme()) + && Optional.ofNullable(uri.getHost()).filter(host -> !host.isBlank()).isPresent() + && Optional.ofNullable(uri.getRawUserInfo()).isEmpty(); + } catch (URISyntaxException e) { + LOGGER.debug("Invalid CiteDrive address", e); + return false; + } + } + public static CiteDrivePreferences getDefault() { return new CiteDrivePreferences(); } - public void setAll(CiteDrivePreferences preferences) { + public synchronized void setAll(CiteDrivePreferences preferences) { this.enabled.set(preferences.isEnabled()); - this.refreshToken.set(preferences.getRefreshToken()); this.persistRefreshToken.set(preferences.shouldPersistRefreshToken()); this.apiBaseUrl.set(preferences.getApiBaseUrl()); this.appBaseUrl.set(preferences.getAppBaseUrl()); + this.refreshToken.set(preferences.getRefreshToken()); } public boolean isEnabled() { @@ -79,7 +118,7 @@ public BooleanProperty enabledProperty() { return enabled; } - public String getApiBaseUrl() { + public synchronized String getApiBaseUrl() { return apiBaseUrl.get(); } @@ -87,7 +126,7 @@ public StringProperty apiBaseUrlProperty() { return apiBaseUrl; } - public void setApiBaseUrl(String apiBaseUrl) { + public synchronized void setApiBaseUrl(String apiBaseUrl) { this.apiBaseUrl.set(apiBaseUrl); } @@ -120,12 +159,12 @@ public URI getImportPage() { return URLUtil.createUri(getAppBaseUrl()).resolve("jabref/import/"); } - public final @Nullable RefreshToken getRefreshToken() { + public final synchronized @Nullable RefreshToken getRefreshToken() { return refreshToken.get(); } /// NOT called from the GUI preferences page, but from the OAuth flow handling components - public void setRefreshToken(@Nullable RefreshToken refreshToken) { + public synchronized void setRefreshToken(@Nullable RefreshToken refreshToken) { this.refreshToken.set(refreshToken); } @@ -141,7 +180,7 @@ public void setPersistRefreshToken(boolean persistRefreshToken) { this.persistRefreshToken.set(persistRefreshToken); } - public ObservableValue getRefreshTokenProperty() { + public ObservableValue<@Nullable RefreshToken> getRefreshTokenProperty() { return refreshToken; } } diff --git a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java index de0d69224816..99aa7fe4bfa3 100644 --- a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java +++ b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java @@ -1683,19 +1683,20 @@ public CiteDrivePreferences getCiteDrivePreferences() { private CiteDrivePreferences getCiteDrivePreferencesFromBackingStore(CiteDrivePreferences defaults) { boolean persistToken = getBoolean(CITE_DRIVE_PERSIST_TOKEN, defaults.shouldPersistRefreshToken()); + String apiBaseUrl = get(CITE_DRIVE_API_BASE_URL, defaults.getApiBaseUrl()); return new CiteDrivePreferences( getBoolean(CITE_DRIVE_ENABLED, defaults.isEnabled()), - persistToken ? getCiteDriveToken() : null, + persistToken ? getCiteDriveToken(apiBaseUrl) : null, persistToken, - get(CITE_DRIVE_API_BASE_URL, defaults.getApiBaseUrl()), + apiBaseUrl, get(CITE_DRIVE_APP_BASE_URL, defaults.getAppBaseUrl()) ); } /// The refresh token lives in the system keyring only: never in the preferences, which can be exported as plain text - private @Nullable RefreshToken getCiteDriveToken() { + private @Nullable RefreshToken getCiteDriveToken(String apiBaseUrl) { try (final Keyring keyring = Keyring.create()) { - return parseCiteDriveToken(keyring.getPassword(CITE_DRIVE_KEYRING_SERVICE, CITE_DRIVE_KEYRING_ACCOUNT)); + return parseCiteDriveToken(keyring.getPassword(CITE_DRIVE_KEYRING_SERVICE, CITE_DRIVE_KEYRING_ACCOUNT), apiBaseUrl); } catch (PasswordAccessException _) { LOGGER.debug("No CiteDrive token stored in keyring"); } catch (Exception ex) { @@ -1710,7 +1711,7 @@ private void setCiteDriveToken(@Nullable RefreshToken refreshToken) { if (refreshToken == null) { keyring.deletePassword(CITE_DRIVE_KEYRING_SERVICE, CITE_DRIVE_KEYRING_ACCOUNT); } else { - keyring.setPassword(CITE_DRIVE_KEYRING_SERVICE, CITE_DRIVE_KEYRING_ACCOUNT, refreshToken.toJSONObject().toJSONString()); + keyring.setPassword(CITE_DRIVE_KEYRING_SERVICE, CITE_DRIVE_KEYRING_ACCOUNT, serializeCiteDriveToken(refreshToken, citeDrivePreferences.getApiBaseUrl())); } } catch (PasswordAccessException _) { LOGGER.debug("No CiteDrive token stored in keyring, nothing to remove"); @@ -1719,13 +1720,23 @@ private void setCiteDriveToken(@Nullable RefreshToken refreshToken) { } } - private @Nullable RefreshToken parseCiteDriveToken(@Nullable String json) { + static String serializeCiteDriveToken(RefreshToken refreshToken, String apiBaseUrl) { + JSONObject json = refreshToken.toJSONObject(); + json.put("api_base_url", apiBaseUrl); + return json.toJSONString(); + } + + // [impl->req~citedrive.credentials.server~1] + static @Nullable RefreshToken parseCiteDriveToken(@Nullable String json, String apiBaseUrl) { if (StringUtil.isBlank(json)) { return null; } try { JSONObject jsonObject = (JSONObject) new JSONParser(JSONParser.MODE_PERMISSIVE).parse(json); + if (!apiBaseUrl.equals(jsonObject.get("api_base_url"))) { + return null; + } return RefreshToken.parse(jsonObject); } catch (ParseException | net.minidev.json.parser.ParseException e) { LOGGER.warn("Invalid CiteDrive refresh token JSON", e); diff --git a/jablib/src/main/resources/l10n/JabRef_en.properties b/jablib/src/main/resources/l10n/JabRef_en.properties index 27b8948b833e..dfc03f114dc8 100644 --- a/jablib/src/main/resources/l10n/JabRef_en.properties +++ b/jablib/src/main/resources/l10n/JabRef_en.properties @@ -3697,7 +3697,7 @@ Enable\ CiteDrive=Enable CiteDrive Remember\ the\ login\ between\ sessions=Remember the login between sessions Server\ address=Server address Web\ address=Web address -Please\ enter\ a\ valid\ URL=Please enter a valid URL +Please\ enter\ a\ valid\ HTTPS\ URL=Please enter a valid HTTPS URL Login\ could\ not\ be\ completed=Login could not be completed Continue\ in\ JabRef.\ You\ can\ close\ this\ window.=Continue in JabRef. You can close this window. Please\ try\ again\ in\ JabRef.\ You\ can\ close\ this\ window.=Please try again in JabRef. You can close this window. diff --git a/jablib/src/test/java/org/jabref/logic/citedrive/CiteDriveOAuthServiceTest.java b/jablib/src/test/java/org/jabref/logic/citedrive/CiteDriveOAuthServiceTest.java index fbf17d32ae1c..c247b5ff496d 100644 --- a/jablib/src/test/java/org/jabref/logic/citedrive/CiteDriveOAuthServiceTest.java +++ b/jablib/src/test/java/org/jabref/logic/citedrive/CiteDriveOAuthServiceTest.java @@ -1,56 +1,303 @@ package org.jabref.logic.citedrive; +import java.io.IOException; +import java.net.SocketTimeoutException; import java.net.URI; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; import org.jabref.logic.net.CiteDrivePreferences; import org.jabref.logic.remote.RemotePreferences; +import com.nimbusds.oauth2.sdk.AuthorizationRequest; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.http.HTTPRequest; +import com.nimbusds.oauth2.sdk.http.HTTPResponse; +import com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod; +import com.nimbusds.oauth2.sdk.token.BearerAccessToken; import com.nimbusds.oauth2.sdk.token.RefreshToken; +import org.jspecify.annotations.NullMarked; +import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.parallel.ResourceLock; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; +import org.mockito.ArgumentCaptor; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.verifyNoInteractions; import static org.mockito.Mockito.when; // [utest->req~citedrive.login~1] // [utest->req~citedrive.push~1] +@NullMarked +@ResourceLock("Localization.lang") class CiteDriveOAuthServiceTest { - // Nothing listens on port 1, so every token request fails with a connection error - private static final URI UNREACHABLE = URI.create("http://127.0.0.1:1/"); - private final RemotePreferences remotePreferences = mock(RemotePreferences.class); + private final CiteDrivePreferences preferences = CiteDrivePreferences.getDefault(); + private final OAuthSessionRegistry registry = new OAuthSessionRegistry(); + private final AtomicReference openedPage = new AtomicReference<>(); + private final CiteDriveOAuthService.TokenRequestSender sender = mock(CiteDriveOAuthService.TokenRequestSender.class); + + @BeforeEach + void setUp() { + when(remotePreferences.shouldEnableHttpServer()).thenReturn(true); + when(remotePreferences.getHttpServerUri()).thenReturn(URI.create("http://127.0.0.1:23119/")); + } @Test void disabledHttpServerFailsWithoutOpeningBrowser() { when(remotePreferences.shouldEnableHttpServer()).thenReturn(false); - CiteDrivePreferences citeDrivePreferences = CiteDrivePreferences.getDefault(); - CiteDriveOAuthService service = new CiteDriveOAuthService(remotePreferences, citeDrivePreferences, new OAuthSessionRegistry(), - _ -> { - throw new AssertionError("Browser must not be opened"); - }, - () -> false, - UNREACHABLE, UNREACHABLE); - assertThrows(ExecutionException.class, () -> service.authorizeInteractive().get(5, TimeUnit.SECONDS)); + assertThrows(ExecutionException.class, () -> service().authorizeInteractive().get(5, TimeUnit.SECONDS)); + assertEquals(Optional.empty(), Optional.ofNullable(openedPage.get())); + verifyNoInteractions(sender); } @Test - void networkErrorOnRefreshKeepsStoredLogin() { + void networkErrorOnRefreshKeepsStoredLogin() throws IOException { + RefreshToken refreshToken = new RefreshToken("stored"); + preferences.setRefreshToken(refreshToken); + when(sender.send(any())).thenThrow(new SocketTimeoutException("Token endpoint timed out")); + + assertThrows(ExecutionException.class, () -> service().getAccessToken().get(5, TimeUnit.SECONDS)); + assertEquals(refreshToken, preferences.getRefreshToken()); + assertEquals(Optional.empty(), Optional.ofNullable(openedPage.get())); + } + + @Test + void refreshWithoutRotationKeepsStoredRefreshToken() throws Exception { + RefreshToken refreshToken = new RefreshToken("stored"); + preferences.setRefreshToken(refreshToken); + when(sender.send(any())).thenReturn(response(200, """ + {"access_token":"access","token_type":"Bearer"} + """)); + + assertEquals(new BearerAccessToken("access"), service().getAccessToken().get(5, TimeUnit.SECONDS).orElseThrow()); + assertEquals(refreshToken, preferences.getRefreshToken()); + } + + @Test + void interactiveLoginWithoutRefreshTokenDiscardsPreviousAccountToken() throws Exception { + preferences.setRefreshToken(new RefreshToken("previous-account")); + when(sender.send(any())).thenReturn(response(200, """ + {"access_token":"access","token_type":"Bearer"} + """)); + + var login = service().authorizeInteractive(); + AuthorizationRequest request = AuthorizationRequest.parse(openedPage.get()); + registry.complete(request.getState().getValue(), "code"); + + assertEquals(new BearerAccessToken("access"), login.get(5, TimeUnit.SECONDS).orElseThrow()); + assertEquals(Optional.empty(), Optional.ofNullable(preferences.getRefreshToken())); + } + + @ParameterizedTest + @CsvSource({"400,invalid_client", "429,slow_down", "503,temporarily_unavailable", "503,invalid_grant"}) + void retryableOrConfigurationErrorKeepsStoredLogin(int status, String error) throws IOException, ParseException { + // [utest->req~citedrive.refresh.failure~1] RefreshToken refreshToken = new RefreshToken("stored"); - CiteDrivePreferences citeDrivePreferences = CiteDrivePreferences.getDefault(); - citeDrivePreferences.setRefreshToken(refreshToken); - CiteDriveOAuthService service = new CiteDriveOAuthService(remotePreferences, citeDrivePreferences, new OAuthSessionRegistry(), - _ -> { - throw new AssertionError("Browser must not be opened"); - }, - () -> false, - UNREACHABLE, UNREACHABLE); - - assertThrows(ExecutionException.class, () -> service.getAccessToken().get(30, TimeUnit.SECONDS)); - assertEquals(refreshToken, citeDrivePreferences.getRefreshToken()); + preferences.setRefreshToken(refreshToken); + when(sender.send(any())).thenReturn(response(status, "{\"error\":\"" + error + "\"}")); + + assertThrows(ExecutionException.class, () -> service().getAccessToken().get(5, TimeUnit.SECONDS)); + assertEquals(refreshToken, preferences.getRefreshToken()); + assertEquals(Optional.empty(), Optional.ofNullable(openedPage.get())); + } + + @Test + void temporaryFailureCanBeRetriedWithoutAnotherLogin() throws Exception { + // [utest->req~citedrive.refresh.failure~1] + preferences.setRefreshToken(new RefreshToken("stored")); + when(sender.send(any())).thenReturn(response(503, "{\"error\":\"temporarily_unavailable\"}"), successResponse()); + + assertThrows(ExecutionException.class, () -> service().getAccessToken().get(5, TimeUnit.SECONDS)); + assertEquals(new BearerAccessToken("access"), service().getAccessToken().get(5, TimeUnit.SECONDS).orElseThrow()); + assertEquals(Optional.empty(), Optional.ofNullable(openedPage.get())); + } + + @Test + void invalidGrantClearsStoredLoginAndStartsInteractiveLogin() throws Exception { + // [utest->req~citedrive.refresh.failure~1] + preferences.setRefreshToken(new RefreshToken("expired")); + when(sender.send(any())).thenReturn(response(400, "{\"error\":\"invalid_grant\"}")); + CompletableFuture browserOpened = new CompletableFuture<>(); + CiteDriveOAuthService service = new CiteDriveOAuthService(remotePreferences, preferences, registry, browserOpened::complete, () -> false, sender); + + CompletableFuture login = service.getAccessToken(); + AuthorizationRequest request = AuthorizationRequest.parse(browserOpened.get(5, TimeUnit.SECONDS)); + + assertEquals(Optional.empty(), Optional.ofNullable(preferences.getRefreshToken())); + registry.fail(request.getState().getValue(), new IOException("Login cancelled by test")); + assertThrows(ExecutionException.class, () -> login.get(5, TimeUnit.SECONDS)); + } + + @Test + void concurrentServicesShareOneRefreshAndStoreRotatedToken() throws Exception { + // [utest->req~citedrive.refresh.single-request~1] + preferences.setRefreshToken(new RefreshToken("stored")); + CompletableFuture received = new CompletableFuture<>(); + CompletableFuture reply = new CompletableFuture<>(); + AtomicInteger requests = new AtomicInteger(); + when(sender.send(any())).thenAnswer(invocation -> { + requests.incrementAndGet(); + received.complete(invocation.getArgument(0)); + return reply.join(); + }); + + try { + var first = service().getAuthorizedSession(); + received.get(5, TimeUnit.SECONDS); + var second = service().getAuthorizedSession(); + reply.complete(successResponse()); + + assertEquals(first.get(5, TimeUnit.SECONDS), second.get(5, TimeUnit.SECONDS)); + assertEquals(1, requests.get()); + assertEquals(new RefreshToken("rotated"), preferences.getRefreshToken()); + } finally { + reply.complete(successResponse()); + } + } + + @Test + void serverChangeUpdatesExistingServiceAndDiscardsOldCredential() throws Exception { + // [utest->req~citedrive.credentials.server~1] + preferences.setRefreshToken(new RefreshToken("old-server-token")); + CiteDriveOAuthService service = service(); + preferences.setApiBaseUrl("https://other.example/"); + when(sender.send(any())).thenReturn(successResponse()); + + var login = service.getAuthorizedSession(); + AuthorizationRequest request = AuthorizationRequest.parse(openedPage.get()); + assertEquals(URI.create("https://other.example/jabref/login/"), request.getEndpointURI()); + assertEquals(Optional.empty(), Optional.ofNullable(preferences.getRefreshToken())); + registry.complete(request.getState().getValue(), "code"); + + var session = login.get(5, TimeUnit.SECONDS).orElseThrow(); + assertEquals(URI.create("https://other.example/jabref/push/"), session.pushEndpoint()); + ArgumentCaptor tokenRequest = ArgumentCaptor.forClass(HTTPRequest.class); + verify(sender).send(tokenRequest.capture()); + assertEquals("https://other.example/o/token/", tokenRequest.getValue().getURL().toString()); + } + + @Test + void serverChangeDuringRefreshCannotRestoreOldCredential() throws Exception { + // [utest->req~citedrive.credentials.server~1] + preferences.setRefreshToken(new RefreshToken("stored")); + CompletableFuture received = new CompletableFuture<>(); + CompletableFuture reply = new CompletableFuture<>(); + when(sender.send(any())).thenAnswer(invocation -> { + received.complete(invocation.getArgument(0)); + return reply.join(); + }); + + try { + var login = service().getAuthorizedSession(); + received.get(5, TimeUnit.SECONDS); + preferences.setApiBaseUrl("https://other.example/"); + reply.complete(successResponse()); + + assertThrows(ExecutionException.class, () -> login.get(5, TimeUnit.SECONDS)); + assertEquals(Optional.empty(), Optional.ofNullable(preferences.getRefreshToken())); + } finally { + reply.complete(successResponse()); + } + } + + @Test + void authorizedSessionKeepsItsOriginalUploadAddress() throws Exception { + // [utest->req~citedrive.credentials.server~1] + preferences.setRefreshToken(new RefreshToken("stored")); + when(sender.send(any())).thenReturn(successResponse()); + var session = service().getAuthorizedSession().get(5, TimeUnit.SECONDS).orElseThrow(); + + preferences.setApiBaseUrl("https://other.example/"); + preferences.setAppBaseUrl("https://other-app.example/"); + + assertEquals(URI.create("https://api-dev.citedrive.com/jabref/push/"), session.pushEndpoint()); + assertEquals(URI.create("https://app-dev.citedrive.com/jabref/import/"), session.importPage()); + } + + @Test + void insecureApiAddressFailsBeforeOpeningBrowserOrSendingToken() { + // [utest->req~citedrive.https~1] + preferences.setApiBaseUrl("http://other.example/"); + preferences.setRefreshToken(new RefreshToken("stored")); + + assertThrows(ExecutionException.class, () -> service().getAccessToken().get(5, TimeUnit.SECONDS)); + assertThrows(ExecutionException.class, () -> service().authorizeInteractive().get(5, TimeUnit.SECONDS)); + verifyNoInteractions(sender); + assertEquals(Optional.empty(), Optional.ofNullable(openedPage.get())); + } + + @Test + void refreshUsesBoundedTimeoutsAndDisablesRedirects() throws Exception { + // [utest->req~citedrive.token.timeout~1] + preferences.setRefreshToken(new RefreshToken("stored")); + when(sender.send(any())).thenReturn(successResponse()); + + assertEquals(new BearerAccessToken("access"), service().getAccessToken().get(5, TimeUnit.SECONDS).orElseThrow()); + assertRequestTimeouts(); + } + + @Test + void codeExchangeRunsOutsideCallbackThreadWithBoundedTimeouts() throws Exception { + // [utest->req~citedrive.token.timeout~1] + CompletableFuture received = new CompletableFuture<>(); + CompletableFuture reply = new CompletableFuture<>(); + when(sender.send(any())).thenAnswer(invocation -> { + received.complete(invocation.getArgument(0)); + return reply.join(); + }); + try { + var login = service().authorizeInteractive(); + AuthorizationRequest request = AuthorizationRequest.parse(openedPage.get()); + assertEquals(CodeChallengeMethod.S256, request.getCodeChallengeMethod()); + assertTrue(registry.complete(request.getState().getValue(), "code")); + received.get(5, TimeUnit.SECONDS); + assertFalse(login.isDone()); + reply.complete(successResponse()); + + assertEquals(new BearerAccessToken("access"), login.get(5, TimeUnit.SECONDS).orElseThrow()); + assertRequestTimeouts(); + } finally { + reply.complete(successResponse()); + } + } + + private CiteDriveOAuthService service() { + return new CiteDriveOAuthService(remotePreferences, preferences, registry, openedPage::set, () -> false, sender); + } + + private void assertRequestTimeouts() throws IOException { + ArgumentCaptor request = ArgumentCaptor.forClass(HTTPRequest.class); + verify(sender).send(request.capture()); + assertEquals(10_000, request.getValue().getConnectTimeout()); + assertEquals(30_000, request.getValue().getReadTimeout()); + assertFalse(request.getValue().getFollowRedirects()); + } + + private HTTPResponse successResponse() throws ParseException { + return response(200, """ + {"access_token":"access","token_type":"Bearer","refresh_token":"rotated"} + """); + } + + private HTTPResponse response(int status, String body) throws ParseException { + HTTPResponse response = new HTTPResponse(status); + response.setContentType("application/json"); + response.setBody(body); + return response; } } diff --git a/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java b/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java index abaebc2824a8..4f0a2618f5d7 100644 --- a/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java +++ b/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java @@ -1,14 +1,25 @@ package org.jabref.logic.citedrive; import java.io.IOException; +import java.io.Reader; import java.net.URI; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Comparator; import java.util.List; +import java.util.Map; +import java.util.Optional; import java.util.concurrent.atomic.AtomicReference; +import java.util.stream.IntStream; +import java.util.stream.Stream; import org.jabref.logic.bibtex.FieldPreferences; import org.jabref.logic.citationkeypattern.CitationKeyPatternPreferences; import org.jabref.logic.exporter.BibDatabaseWriter; import org.jabref.logic.exporter.SelfContainedSaveConfiguration; +import org.jabref.logic.importer.ImportFormatPreferences; +import org.jabref.logic.importer.fileformat.BibtexParser; import org.jabref.logic.preferences.CliPreferences; import org.jabref.logic.util.NotificationService; import org.jabref.model.database.BibDatabase; @@ -25,12 +36,19 @@ import kong.unirest.core.RequestBodyEntity; import kong.unirest.core.Unirest; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestReporter; +import org.junit.jupiter.api.parallel.ResourceLock; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; import org.mockito.Answers; +import org.mockito.ArgumentCaptor; import org.mockito.MockedStatic; import org.mockito.Mockito; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.doAnswer; @@ -42,8 +60,84 @@ /// JabRef's metadata (here: the library-specific file directory) must not be uploaded, and the token has to arrive as a bearer header. /// /// [utest->req~citedrive.push~1] +@ResourceLock("Localization.lang") class CiteDrivePushTest { + private static Stream batches() { + Stream generated = Stream.of(2, 1_000).map(count -> Arguments.of(count, Optional.empty())); + Stream fixture = Optional.ofNullable(System.getProperty("citedrive.batch.fixture")) + .stream() + .map(path -> Arguments.of(100_000, Optional.of(Path.of(path)))); + return Stream.concat(generated, fixture); + } + + @ParameterizedTest + @MethodSource("batches") + @SuppressWarnings("unchecked") + void batchUploadSendsEveryEntryInOneRequest(int count, Optional fixture, TestReporter reporter) throws IOException { + ImportFormatPreferences importPreferences = mock(ImportFormatPreferences.class, Answers.RETURNS_DEEP_STUBS); + when(importPreferences.bibEntryPreferences().getKeywordSeparator()).thenReturn(','); + long started = System.nanoTime(); + BibDatabaseContext context; + if (fixture.isEmpty()) { + BibDatabase database = new BibDatabase(); + IntStream.range(0, count).mapToObj(index -> new BibEntry(StandardEntryType.Article) + .withCitationKey("batch-" + index) + .withField(StandardField.AUTHOR, "Müller, Jane") + .withField(StandardField.TITLE, "Batch entry " + index) + .withChanged(true)) + .forEach(database::insertEntry); + context = new BibDatabaseContext(database); + } else { + try (Reader reader = Files.newBufferedReader(fixture.orElseThrow(), StandardCharsets.UTF_8)) { + context = new BibtexParser(importPreferences).parse(reader).getDatabaseContext(); + } + } + long loaded = System.nanoTime(); + assertEquals(count, context.getEntries().size()); + List entries = context.getEntries().stream().map(BibEntry::new).toList(); + long copied = System.nanoTime(); + HttpRequestWithBody postRequest = mock(HttpRequestWithBody.class); + RequestBodyEntity bodyEntity = mock(RequestBodyEntity.class); + HttpResponse response = mock(HttpResponse.class); + when(postRequest.header(anyString(), anyString())).thenReturn(postRequest); + when(postRequest.body(anyString())).thenReturn(bodyEntity); + when(bodyEntity.asString()).thenReturn(response); + when(response.isSuccess()).thenReturn(true); + + try (MockedStatic unirestMock = Mockito.mockStatic(Unirest.class)) { + unirestMock.when(() -> Unirest.post("https://example.com/jabref/push/")).thenReturn(postRequest); + + assertTrue(CiteDrivePush.push(context, entries, new BearerAccessToken("access-token"), createPreferences(), + mock(NotificationService.class), URI.create("https://example.com/jabref/push/"))); + long serialized = System.nanoTime(); + + ArgumentCaptor requestBody = ArgumentCaptor.forClass(String.class); + verify(postRequest).body(requestBody.capture()); + unirestMock.verify(() -> Unirest.post("https://example.com/jabref/push/")); + List uploaded = new BibtexParser(importPreferences).parse(Reader.of(requestBody.getValue())).getDatabase().getEntries(); + Comparator byKey = Comparator.comparing(entry -> entry.getCitationKey().orElseThrow()); + assertEquals(entries.stream().sorted(byKey).toList(), uploaded.stream().sorted(byKey).toList()); + assertEquals(context.getEntries().stream().sorted(byKey).toList(), entries.stream().sorted(byKey).toList()); + reporter.publishEntry(Map.of( + "entries", String.valueOf(count), + "bytes", String.valueOf(requestBody.getValue().getBytes(StandardCharsets.UTF_8).length), + "loadMs", String.valueOf((loaded - started) / 1_000_000), + "snapshotMs", String.valueOf((copied - loaded) / 1_000_000), + "serializeAndPrepareMs", String.valueOf((serialized - copied) / 1_000_000))); + } + } + + @Test + void pushRejectsUnencryptedEndpointBeforeSendingCredentials() { + try (MockedStatic unirestMock = Mockito.mockStatic(Unirest.class)) { + BibDatabaseContext context = createDatabaseContext(); + assertThrows(IOException.class, () -> CiteDrivePush.push(context, context.getEntries(), new BearerAccessToken("access-token"), + createPreferences(), mock(NotificationService.class), URI.create("http://api.example/jabref/push/"))); + unirestMock.verifyNoInteractions(); + } + } + @Test @SuppressWarnings("unchecked") void pushSendsSerializedBibtexBody() throws IOException { diff --git a/jablib/src/test/java/org/jabref/logic/net/CiteDrivePreferencesTest.java b/jablib/src/test/java/org/jabref/logic/net/CiteDrivePreferencesTest.java new file mode 100644 index 000000000000..37fded62cf68 --- /dev/null +++ b/jablib/src/test/java/org/jabref/logic/net/CiteDrivePreferencesTest.java @@ -0,0 +1,58 @@ +package org.jabref.logic.net; + +import java.util.Optional; + +import com.nimbusds.oauth2.sdk.token.RefreshToken; +import org.jspecify.annotations.NullMarked; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; + +@NullMarked +class CiteDrivePreferencesTest { + + @ParameterizedTest + @CsvSource({ + "https://api.citedrive.com/,true", + "HTTPS://api.citedrive.com/,true", + "http://api.citedrive.com/,false", + "http://127.0.0.1:8080/,false", + "https:///missing-host,false", + "https://user:password@api.citedrive.com/,false", + "file:///tmp/token,false", + "'not a URL',false" + }) + void serverAddressRequiresHttps(String address, boolean valid) { + // [utest->req~citedrive.https~1] + assertEquals(valid, CiteDrivePreferences.isSecureUrl(address)); + } + + @Test + void changingServerInvalidatesLoginEvenWhenReturningToOriginalAddress() { + // [utest->req~citedrive.credentials.server~1] + CiteDrivePreferences preferences = CiteDrivePreferences.getDefault(); + long revision = preferences.getServerRevision(); + String originalAddress = preferences.getApiBaseUrl(); + preferences.setRefreshToken(new RefreshToken("original")); + + preferences.setApiBaseUrl("https://other.example/"); + preferences.setApiBaseUrl(originalAddress); + + assertFalse(preferences.updateRefreshToken(revision, Optional.of(new RefreshToken("stale")))); + assertEquals(Optional.empty(), Optional.ofNullable(preferences.getRefreshToken())); + } + + @Test + void importingPreferencesKeepsTheLoginForTheImportedServer() { + CiteDrivePreferences preferences = CiteDrivePreferences.getDefault(); + RefreshToken importedToken = new RefreshToken("imported"); + CiteDrivePreferences imported = new CiteDrivePreferences(true, importedToken, true, "https://other.example/", "https://app.example/"); + + preferences.setAll(imported); + + assertEquals(importedToken, preferences.getRefreshToken()); + } +} diff --git a/jablib/src/test/java/org/jabref/logic/preferences/CiteDriveTokenStorageTest.java b/jablib/src/test/java/org/jabref/logic/preferences/CiteDriveTokenStorageTest.java new file mode 100644 index 000000000000..41b70d16ff03 --- /dev/null +++ b/jablib/src/test/java/org/jabref/logic/preferences/CiteDriveTokenStorageTest.java @@ -0,0 +1,30 @@ +package org.jabref.logic.preferences; + +import java.util.Optional; + +import com.nimbusds.oauth2.sdk.token.RefreshToken; +import org.jspecify.annotations.NullMarked; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +@NullMarked +// [utest->req~citedrive.credentials.server~1] +class CiteDriveTokenStorageTest { + + @Test + void storedTokenCanOnlyBeLoadedForItsOriginalServer() { + RefreshToken token = new RefreshToken("stored"); + String json = JabRefCliPreferences.serializeCiteDriveToken(token, "https://original.example/"); + + assertEquals(token, JabRefCliPreferences.parseCiteDriveToken(json, "https://original.example/")); + assertEquals(Optional.empty(), Optional.ofNullable(JabRefCliPreferences.parseCiteDriveToken(json, "https://other.example/"))); + } + + @Test + void legacyTokenWithoutServerBindingRequiresAnotherLogin() { + String json = new RefreshToken("legacy").toJSONObject().toJSONString(); + + assertEquals(Optional.empty(), Optional.ofNullable(JabRefCliPreferences.parseCiteDriveToken(json, "https://original.example/"))); + } +} From 6f89c01cc129015f9e9f9717ea9ddb38a6a71127 Mon Sep 17 00:00:00 2001 From: Siedlerchr Date: Mon, 19 Oct 2026 22:50:24 +0200 Subject: [PATCH 81/83] test(gui): make custom browser test portable Launch the recording shell script directly rather than treating it as a macOS application bundle. Keep the complete URL assertion intact. --- .../test/java/org/jabref/gui/desktop/os/NativeDesktopTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jabgui/src/test/java/org/jabref/gui/desktop/os/NativeDesktopTest.java b/jabgui/src/test/java/org/jabref/gui/desktop/os/NativeDesktopTest.java index a8343bafbfef..a2c9e63f294f 100644 --- a/jabgui/src/test/java/org/jabref/gui/desktop/os/NativeDesktopTest.java +++ b/jabgui/src/test/java/org/jabref/gui/desktop/os/NativeDesktopTest.java @@ -69,7 +69,7 @@ void openBrowserPassesFullUrlToCustomBrowser() throws IOException, InterruptedEx ExternalApplicationsPreferences preferences = mock(ExternalApplicationsPreferences.class); when(preferences.getExternalFileTypes()).thenReturn(FXCollections.observableSet(htmlType)); - NativeDesktop.openBrowser(URL_WITH_QUERY, preferences); + NativeDesktop.openBrowser(URL_WITH_QUERY, preferences, FakeDesktop.NO_FAILURE_EXPECTED, new Windows()); assertEquals(URL_WITH_QUERY, recordedArgument()); } From 59e25ceb554a065112124f3ddfe75449cc486d04 Mon Sep 17 00:00:00 2001 From: Siedlerchr Date: Mon, 19 Oct 2026 22:57:21 +0200 Subject: [PATCH 82/83] style(citedrive): apply IntelliJ formatting --- .../citedrive/CiteDriveOAuthService.java | 28 +++++++++---------- .../logic/citedrive/OAuthSessionRegistry.java | 18 ++++++------ .../logic/citedrive/CiteDrivePushTest.java | 12 ++++---- .../CiteDriveTokenStorageTest.java | 2 +- 4 files changed, 30 insertions(+), 30 deletions(-) diff --git a/jablib/src/main/java/org/jabref/logic/citedrive/CiteDriveOAuthService.java b/jablib/src/main/java/org/jabref/logic/citedrive/CiteDriveOAuthService.java index 916415ac6249..ee1b8213a184 100644 --- a/jablib/src/main/java/org/jabref/logic/citedrive/CiteDriveOAuthService.java +++ b/jablib/src/main/java/org/jabref/logic/citedrive/CiteDriveOAuthService.java @@ -88,23 +88,23 @@ public CiteDriveOAuthService(RemotePreferences remotePreferences, @VisibleForTesting CiteDriveOAuthService(RemotePreferences remotePreferences, - CiteDrivePreferences citeDrivePreferences, - OAuthSessionRegistry sessionRegistry, - Consumer authorizationPageOpener, - BooleanSupplier callbackServerEnabler, - TokenRequestSender tokenRequestSender) { + CiteDrivePreferences citeDrivePreferences, + OAuthSessionRegistry sessionRegistry, + Consumer authorizationPageOpener, + BooleanSupplier callbackServerEnabler, + TokenRequestSender tokenRequestSender) { this(remotePreferences, citeDrivePreferences, sessionRegistry, authorizationPageOpener, callbackServerEnabler, citeDrivePreferences::getAuthorizationEndpoint, citeDrivePreferences::getTokenEndpoint, tokenRequestSender); } private CiteDriveOAuthService(RemotePreferences remotePreferences, - CiteDrivePreferences citeDrivePreferences, - OAuthSessionRegistry sessionRegistry, - Consumer authorizationPageOpener, - BooleanSupplier callbackServerEnabler, - Supplier authEndpoint, - Supplier tokenEndpoint, - TokenRequestSender tokenRequestSender) { + CiteDrivePreferences citeDrivePreferences, + OAuthSessionRegistry sessionRegistry, + Consumer authorizationPageOpener, + BooleanSupplier callbackServerEnabler, + Supplier authEndpoint, + Supplier tokenEndpoint, + TokenRequestSender tokenRequestSender) { this.remotePreferences = remotePreferences; this.citeDrivePreferences = citeDrivePreferences; this.sessionRegistry = sessionRegistry; @@ -207,8 +207,8 @@ public CompletableFuture> getAuthorizedSession() { cachedRefreshToken = Optional.ofNullable(citeDrivePreferences.getRefreshToken()); } return cachedRefreshToken.map(refreshToken -> CompletableFuture.supplyAsync(() -> refreshToken(refreshToken, configuration)) - .thenCompose(session -> session.map(value -> CompletableFuture.completedFuture(Optional.of(value))) - .orElseGet(() -> authorizeInteractive(configuration)))) + .thenCompose(session -> session.map(value -> CompletableFuture.completedFuture(Optional.of(value))) + .orElseGet(() -> authorizeInteractive(configuration)))) .orElseGet(() -> authorizeInteractive(configuration)); }); } diff --git a/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java b/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java index a80c04c9687e..fb3fccee6afb 100644 --- a/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java +++ b/jablib/src/main/java/org/jabref/logic/citedrive/OAuthSessionRegistry.java @@ -32,15 +32,15 @@ CompletableFuture> requestToke TokenRequestKey key = new TokenRequestKey(preferences, revision); CompletableFuture> candidate = new CompletableFuture<>(); CompletableFuture> shared = Optional.ofNullable(tokenRequests.putIfAbsent(key, candidate)) - .orElseGet(() -> { - CompletableFuture.completedFuture(true) - .thenCompose(_ -> request.get()) - .whenComplete((session, failure) -> { - tokenRequests.remove(key, candidate); - Optional.ofNullable(failure).ifPresentOrElse(candidate::completeExceptionally, () -> candidate.complete(session)); - }); - return candidate; - }); + .orElseGet(() -> { + CompletableFuture.completedFuture(true) + .thenCompose(_ -> request.get()) + .whenComplete((session, failure) -> { + tokenRequests.remove(key, candidate); + Optional.ofNullable(failure).ifPresentOrElse(candidate::completeExceptionally, () -> candidate.complete(session)); + }); + return candidate; + }); return shared.copy(); } diff --git a/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java b/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java index 4f0a2618f5d7..327dc29b083d 100644 --- a/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java +++ b/jablib/src/test/java/org/jabref/logic/citedrive/CiteDrivePushTest.java @@ -66,8 +66,8 @@ class CiteDrivePushTest { private static Stream batches() { Stream generated = Stream.of(2, 1_000).map(count -> Arguments.of(count, Optional.empty())); Stream fixture = Optional.ofNullable(System.getProperty("citedrive.batch.fixture")) - .stream() - .map(path -> Arguments.of(100_000, Optional.of(Path.of(path)))); + .stream() + .map(path -> Arguments.of(100_000, Optional.of(Path.of(path)))); return Stream.concat(generated, fixture); } @@ -82,10 +82,10 @@ void batchUploadSendsEveryEntryInOneRequest(int count, Optional fixture, T if (fixture.isEmpty()) { BibDatabase database = new BibDatabase(); IntStream.range(0, count).mapToObj(index -> new BibEntry(StandardEntryType.Article) - .withCitationKey("batch-" + index) - .withField(StandardField.AUTHOR, "Müller, Jane") - .withField(StandardField.TITLE, "Batch entry " + index) - .withChanged(true)) + .withCitationKey("batch-" + index) + .withField(StandardField.AUTHOR, "Müller, Jane") + .withField(StandardField.TITLE, "Batch entry " + index) + .withChanged(true)) .forEach(database::insertEntry); context = new BibDatabaseContext(database); } else { diff --git a/jablib/src/test/java/org/jabref/logic/preferences/CiteDriveTokenStorageTest.java b/jablib/src/test/java/org/jabref/logic/preferences/CiteDriveTokenStorageTest.java index 41b70d16ff03..291adb8305f5 100644 --- a/jablib/src/test/java/org/jabref/logic/preferences/CiteDriveTokenStorageTest.java +++ b/jablib/src/test/java/org/jabref/logic/preferences/CiteDriveTokenStorageTest.java @@ -9,7 +9,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; @NullMarked -// [utest->req~citedrive.credentials.server~1] + // [utest->req~citedrive.credentials.server~1] class CiteDriveTokenStorageTest { @Test From 011e240254520e26f2c58ff411c92d9a7aa09a8e Mon Sep 17 00:00:00 2001 From: Siedlerchr Date: Mon, 19 Oct 2026 23:10:19 +0200 Subject: [PATCH 83/83] docs: remove misplaced CiteDrive module details --- jablib/src/main/java/module-info.java | 3 --- 1 file changed, 3 deletions(-) diff --git a/jablib/src/main/java/module-info.java b/jablib/src/main/java/module-info.java index 7dfd9f1192a8..a5f546823e0f 100644 --- a/jablib/src/main/java/module-info.java +++ b/jablib/src/main/java/module-info.java @@ -5,11 +5,8 @@ /// Entry points: [org.jabref.model.database.BibDatabaseContext] (an open library), /// [org.jabref.model.entry.BibEntry], [org.jabref.logic.importer.ImportFormatReader], /// [org.jabref.logic.exporter.ExporterFactory]. -/// CiteDrive authentication and uploads are coordinated by [org.jabref.logic.citedrive.CiteDriveOAuthService]; -/// its authorized sessions keep credentials bound to their upload address. /// /// @see Architecture and components -/// @see CiteDrive authentication security open module org.jabref.jablib { exports org.jabref.model; exports org.jabref.model.undo;