Skip to content

Reregister AuthCheckFilter exclusion when certificates change #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fishbowler wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Reregister AuthCheckFilter exclusion when certificates change #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/java/org/jivesoftware/openfire/plugin/rest/RESTServicePlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2005-2008 Jive Software, 2022 Ignite Realtime Foundation. All rights reserved.
* Copyright (C) 2005-2008 Jive Software, 2022-2026 Ignite Realtime Foundation. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -19,8 +19,11 @@
import org.jivesoftware.admin.AuthCheckFilter;
import org.jivesoftware.openfire.container.Plugin;
import org.jivesoftware.openfire.container.PluginManager;
import org.jivesoftware.openfire.keystore.CertificateStore;
import org.jivesoftware.openfire.plugin.rest.service.JerseyWrapper;
import org.jivesoftware.openfire.stats.StatisticsManager;
import org.jivesoftware.util.CertificateEventListener;
import org.jivesoftware.util.CertificateManager;
import org.jivesoftware.util.JiveGlobals;
import org.jivesoftware.util.PropertyEventDispatcher;
import org.jivesoftware.util.PropertyEventListener;
Expand All @@ -32,7 +35,7 @@
/**
* The Class RESTServicePlugin.
*/
public class RESTServicePlugin implements Plugin, PropertyEventListener {
public class RESTServicePlugin implements Plugin, PropertyEventListener, CertificateEventListener {

private static final String CUSTOM_AUTH_FILTER_PROPERTY_NAME = "plugin.restapi.customAuthFilter";
public static final String SERVICE_LOGGING_ENABLED = "plugin.restapi.serviceLoggingEnabled";
Expand Down Expand Up @@ -99,6 +102,9 @@ public void initializePlugin(PluginManager manager, File pluginDirectory) {
// Listen to system property events
PropertyEventDispatcher.addListener(this);

// Re-register the URL exclusion if the admin console restarts (e.g. on certificate change)
CertificateManager.addListener(this);

// Exclude this servlet from requering the user to login
AuthCheckFilter.addExclude(JerseyWrapper.SERVLET_URL);
}
Expand All @@ -118,6 +124,17 @@ public void destroyPlugin() {
AuthCheckFilter.removeExclude(JerseyWrapper.SERVLET_URL);
// Stop listening to system property events
PropertyEventDispatcher.removeListener(this);
CertificateManager.removeListener(this);
}

/**
* Re-registers the URL exclusion with the admin console's AuthCheckFilter after a certificate
* store change, which triggers an admin console restart that would otherwise clear plugin-
* registered excludes.
*/
@Override
public void storeContentChanged(CertificateStore store) {
AuthCheckFilter.addExclude(JerseyWrapper.SERVLET_URL);
}

/**
Expand Down
Loading