Skip to content

JCU/Fix dspace-customers 1083 finding 6: keep the backend application files owned by root - #1710

Open
milanmajchrak wants to merge 2 commits into
customer/jcufrom
jcu/be-app-files-owned-by-root
Open

milanmajchrak wants to merge 2 commits into
customer/jcufrom
jcu/be-app-files-owned-by-root

Conversation

@milanmajchrak

Copy link
Copy Markdown
Collaborator

References

dspace-customers issue 1083, finding 6. Same idea as #1706 on dtq-dev, written for the Spring Boot image of this branch. This PR also creates /dspace/sitemaps, which is all that the open PR 1506 does.

Description

The backend image now keeps the DSpace files owned by root. DSpace still runs as dspace, which owns only the data folders and solr/search/conf.

Instructions for Reviewers

List of changes in this PR:

  • Dockerfile: COPY --from=ant_build /dspace $dspace__P__dir drops --chown, so /dspace stays owned by root. dspace owns only these:
    • the data folders assetstore, ctqueues, exports, handle-server, imports, log, reports, sitemaps, temp, triplestore, upload and var (missing ones are created);
    • solr/search/conf, where database migrate writes reindex.flag so DSpace reindexes Discovery at start.
  • /dspace/bin gets a+rX, so dspace can still run the installed scripts (the installer makes them 744).

Named volumes that already exist keep their owner, so deployments need no migration. Two things change:

  • A CLI command that writes a file to a relative path (for example dspace metadata-export -f out.csv) now fails, because the working folder /dspace is root-owned. So do the solr-*-statistics commands without -d (the export one only prints an error and exits with 0), because they cannot create /dspace/solr-export. Give them a path in a writable folder such as /dspace/exports.
  • dspace stats-util -u can no longer download spider lists into config/spiders, and dspace submission-forms-migrate cannot write its .migrated files into config.

How to test:

docker build -t dspace-test .
docker run --rm --entrypoint bash dspace-test -c "touch /dspace/config/dspace.cfg; touch /dspace/lib/x.jar; touch /dspace/webapps/server-boot.jar"

All three touch commands fail with Permission denied.

Also tested on a stack with PostgreSQL, Solr and named volumes, running database migrate force before the jar: once with the current customer-jcu image, once with this PR's final stage on top of the install from that image. Both start and answer on /server/api. With the PR image the Discovery reindex after the first migration still runs, and writes to config, lib and webapps are refused.

Codex review (gpt-6.2-sol, high): it flagged only the changes listed above. The solr-export fix from the dtq-dev review is in this PR too.

AI Disclosure (REQUIRED)

Were AI tools used in the creation of this PR?

  • No (This PR does NOT include AI-generated or AI-assisted content that requires disclosure.)
  • Yes (This PR includes AI-generated or AI-assisted content that requires disclosure.)

Claude Code wrote the change and tested it in Docker as described above.

Checklist

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & integration tests). Exceptions may be made if previously agreed upon.
  • My PR follows all coding best practices based on the Code Conventions Guide.
  • My PR passes Checkstyle validation based on the Code Style Guide.
  • My PR includes Javadoc for all new (or modified) public methods and classes. It also includes Javadoc for large or complex private methods.
  • My PR passes all tests and includes new/updated Unit or Integration Tests based on the Code Testing Guide.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in any pom.xml), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR modifies REST API endpoints, I've opened a separate REST Contract PR related to this change.
  • If my PR includes new configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

🤖 Generated with Claude Code

milanmajchrak and others added 2 commits November 18, 2026 18:50
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
solr-reindex-statistics removes its export folder only when it created it, so the image
no longer creates /dspace/solr-export. The solr-*-statistics commands take -d instead.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The Dockerfile permission change causes stats-util -s and stats-util -b to fail during cleanup because deleting /dspace/temp requires write access to the protected /dspace parent.

1 open issue
What changed in this PR

Applies the root-ownership hardening from PR #1706 to this branch’s Spring Boot backend image, while retaining writable runtime data directories.

Changes:

  • Keeps installed application files root-owned while DSpace runs as dspace.
  • Creates and assigns ownership of data directories, including sitemaps, and permits Discovery reindex flag creation.
  • Preserves read and execute access to installed scripts.
File Description
Dockerfile Restricts writable paths to runtime directories and preserves script execution permissions.

Review effort: Balanced

Comment thread Dockerfile
# Missing folders are created so named volumes (not bind mounts) inherit the owner.
RUN for dir in assetstore ctqueues exports handle-server imports log reports sitemaps temp \
triplestore upload var; do \
mkdir -p /dspace/$dir && chown -R dspace:dspace /dspace/$dir; \

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants