Skip to content

Check weblog permission in XML-RPC Blogger/MetaWeblog handlers #164

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
snoopdave wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Check weblog permission in XML-RPC Blogger/MetaWeblog handlers #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1dfd10b
Refine XML-RPC weblog access handling
snoopdave Aug 16, 2026
bca0ba0
Expand XML-RPC access handling coverage
snoopdave Aug 29, 2026
2761648
Bound the draft scan behind the XML-RPC recent-posts handlers
snoopdave Aug 29, 2026
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
150 changes: 84 additions & 66 deletions app/src/main/java/org/apache/roller/weblogger/webservices/xmlrpc/BaseAPIHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,12 @@
import org.apache.roller.weblogger.config.WebloggerRuntimeConfig;
import org.apache.roller.weblogger.business.WebloggerFactory;
import org.apache.roller.weblogger.business.UserManager;
import org.apache.roller.weblogger.business.WeblogEntryManager;
import org.apache.roller.weblogger.business.WeblogManager;
import org.apache.roller.weblogger.pojos.User;
import org.apache.roller.weblogger.pojos.Weblog;
import org.apache.roller.weblogger.pojos.WeblogEntry;
import org.apache.roller.weblogger.pojos.WeblogPermission;
import org.apache.roller.weblogger.ui.core.RollerContext;
import org.apache.roller.weblogger.util.cache.CacheManager;
import org.apache.xmlrpc.common.XmlRpcNotAuthorizedException;
Expand Down Expand Up @@ -102,97 +105,112 @@ public BaseAPIHandler() {

//------------------------------------------------------------------------
/**
* Returns website, but only if user authenticates and is authorized to edit.
* @param blogid Blogid sent in request (used as website's handle)
* @param username Username sent in request
* @param password Password sent in request
* Returns a weblog only when the authenticated user has the requested
* permission and XML-RPC access is enabled for that weblog.
*/
protected Weblog validate(String blogid, String username, String password)
throws Exception {
boolean authenticated = false;
boolean userEnabled = false;
boolean weblogEnabled = false;
boolean apiEnabled = false;
boolean weblogFound = false;
Weblog website = null;
try {
UserManager userMgr = WebloggerFactory.getWeblogger().getUserManager();
WeblogManager weblogMgr = WebloggerFactory.getWeblogger().getWeblogManager();
User user = userMgr.getUserByUserName(username);

website = weblogMgr.getWeblogByHandle(blogid);
if (website != null) {
weblogFound = true;
weblogEnabled = website.getVisible();
apiEnabled = website.getEnableBloggerApi()
&& WebloggerRuntimeConfig.getBooleanProperty("webservices.enableXmlRpc");
}

if (user != null) {
userEnabled = user.getEnabled();
authenticated = RollerContext.getPasswordEncoder().matches(password, user.getPassword());
}
} catch (Exception e) {
mLogger.error("ERROR internal error validating user", e);
}

if ( !authenticated ) {
throw new XmlRpcNotAuthorizedException(AUTHORIZATION_EXCEPTION_MSG);
}
if ( !userEnabled ) {
throw new XmlRpcNotAuthorizedException(USER_DISABLED_MSG);
}
if ( !weblogEnabled ) {
protected Weblog validate(String blogid, String username, String password,
String requiredAction) throws Exception {
User user = validateUser(username, password);
return validateWeblog(blogid, user, requiredAction);
}

/**
* Validate a weblog for an already authenticated user.
*/
protected Weblog validateWeblog(String blogid, User user,
String requiredAction) throws Exception {
WeblogManager weblogMgr = WebloggerFactory.getWeblogger().getWeblogManager();
Weblog website = weblogMgr.getWeblogByHandle(blogid);

@mraible mraible Aug 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The deleted validate() wrapped the user and weblog lookups in a try/catch that logged and converted backend failures into an authorization fault. Here getWeblogByHandle runs outside any try, so a WebloggerException (transient DB trouble, say) escapes as a raw exception and the XML-RPC servlet returns a generic server fault carrying the internal message. Easy to trigger in tests with a hyphenated blogid. Worth restoring the wrap.


// Use one response for missing, unavailable, and inaccessible weblogs.
if (!isWeblogAvailable(website)
|| !website.hasUserPermission(user, requiredAction)) {
throw new XmlRpcNotAuthorizedException(WEBLOG_DISABLED_MSG);
}
if ( !weblogFound ) {
throw new XmlRpcException(WEBLOG_NOT_FOUND, WEBLOG_NOT_FOUND_MSG);
}
if ( !apiEnabled ) {
if (!Boolean.TRUE.equals(website.getEnableBloggerApi())) {

@mraible mraible Aug 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small one: the enableBloggerApi check lives here and again in getEntryForWrite (line 197), and the two paths report it differently (BLOGGERAPI_DISABLED here, collapsed into INVALID_POSTID there). Doing it once in isWeblogAvailable would keep the faults consistent.

throw new XmlRpcNotAuthorizedException(BLOGGERAPI_DISABLED_MSG);
}
return website;
}

//------------------------------------------------------------------------
/**
* Returns true if username/password are valid and user is not disabled.
* Returns the authenticated user if username/password are valid and the
* user is not disabled.
* @param username Username sent in request
* @param password Password sent in request
*/
protected boolean validateUser(String username, String password)
throws Exception {
protected User validateUser(String username, String password)
throws Exception {
User user = null;
boolean authenticated = false;
boolean enabled = false;
boolean apiEnabled = false;
try {

UserManager userMgr = WebloggerFactory.getWeblogger().getUserManager();
User user = userMgr.getUserByUserName(username);

if (user != null) {
enabled = user.getEnabled();
authenticated = RollerContext.getPasswordEncoder().matches(password, user.getPassword());

apiEnabled = WebloggerRuntimeConfig.getBooleanProperty("webservices.enableXmlRpc");
user = userMgr.getUserByUserName(username);
if (user != null && RollerContext.getPasswordEncoder() != null) {
authenticated = RollerContext.getPasswordEncoder().matches(
password, user.getPassword());
}
} catch (Exception e) {
mLogger.error("ERROR internal error validating user", e);
}
if ( !authenticated ) {

if (!authenticated) {
throw new XmlRpcNotAuthorizedException(AUTHORIZATION_EXCEPTION_MSG);
}
if ( !enabled ) {

if (!Boolean.TRUE.equals(user.getEnabled())) {
throw new XmlRpcNotAuthorizedException(USER_DISABLED_MSG);
}
if ( !apiEnabled ) {

if (!WebloggerRuntimeConfig.getBooleanProperty("webservices.enableXmlRpc")) {
throw new XmlRpcNotAuthorizedException(BLOGGERAPI_DISABLED_MSG);
}

return authenticated;
}

return user;
}

/**
* Returns an entry only when it belongs to an available XML-RPC weblog and
* the user may edit it. An optional additional weblog action can be
* required for transitions such as publishing.
*/
protected WeblogEntry validateEntry(String postid, User user,
String additionalAction) throws Exception {
WeblogEntry entry = getEntryForWrite(postid, user, additionalAction);
if (entry == null) {
throw new XmlRpcException(INVALID_POSTID, INVALID_POSTID_MSG);

@mraible mraible Aug 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read the description's "foreign and unknown identifiers produce the same fault" as deliberate anti-enumeration, which makes sense for entries the caller can't see. This also covers the case where the caller can see and edit the entry and only lacks POST: a limited member who just saved a draft with publish=false retries with publish=true and gets INVALID_POSTID for the id that worked seconds ago. Clients that treat that fault as "deleted on the server" will drop or re-create the post. For an entry the caller already has access to, a not-authorized fault leaks nothing and is far kinder.

}
return entry;
}

/**
* Nullable form used by Blogger.deletePost(), whose public contract
* returns false when the entry is unavailable.
*/
protected WeblogEntry getEntryForWrite(String postid, User user,
String additionalAction) throws Exception {
WeblogEntryManager entryMgr = WebloggerFactory.getWeblogger()
.getWeblogEntryManager();
WeblogEntry entry = entryMgr.getWeblogEntry(postid);
if (entry == null || !isWeblogAvailable(entry.getWebsite())
|| !Boolean.TRUE.equals(entry.getWebsite().getEnableBloggerApi())
|| !entry.getWebsite().hasUserPermission(
user, WeblogPermission.EDIT_DRAFT)
|| !entry.hasWritePermissions(user)) {
return null;
}
if (additionalAction != null
&& !entry.getWebsite().hasUserPermission(user, additionalAction)) {
return null;
}
return entry;
}

private boolean isWeblogAvailable(Weblog website) {
return website != null
&& Boolean.TRUE.equals(website.getVisible())
&& Boolean.TRUE.equals(website.getActive());

@mraible mraible Aug 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weblog.active isn't a disabled flag: per its javadoc (and ROL-485) it's the user-settable "include in front page / planet listings" toggle, and the web UI never blocks editing an inactive weblog. Gating here means an owner who unticks Active in Weblog Settings to hide the blog from the front page loses every XML-RPC call for it (newPost, editPost, getRecentPosts, and via getEntryForWrite even deletePost by id) with "not found or disabled". The pre-PR check was visible only, which is the flag that means what this code wants.

}

//------------------------------------------------------------------------
Expand Down
Loading
Loading