Skip to content

[#2713] [3.0] bugfix: Improve thread-safety of Shiro-native sessions by using Atomic* classes#2712

Open
lprimak wants to merge 6 commits into
apache:3.xfrom
lprimak:sync-native-sessions
Open

[#2713] [3.0] bugfix: Improve thread-safety of Shiro-native sessions by using Atomic* classes#2712
lprimak wants to merge 6 commits into
apache:3.xfrom
lprimak:sync-native-sessions

Conversation

@lprimak
Copy link
Copy Markdown
Contributor

@lprimak lprimak commented May 21, 2026

While auditing Shiro-native sessions for correctness, I noticed that there is indeed a possibility of race conditions there.
This PR fixes this by using Atomic* for shared mutable values, and ConcurrentHashMap for session attributes.

There is some code cleanup, such as adding @Override annotations as I went along this path

fixes #2713

Following this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a GitHub issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a GitHub issue. Your pull request should address just this issue, without pulling in other changes.
  • Format the pull request title like [#XXX] - Fixes bug in SessionManager,
    where you replace #XXX with the appropriate GitHub issue. Best practice
    is to use the GitHub issue title in the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • add fixes #XXX if merging the PR should close a related issue.
  • Run mvn verify to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
  • Committers: Make sure a milestone is set on the PR
  • Committers: Use "Squash and Merge" to combine all commits into one when merging a PR when appropriate.

Trivial changes like typos do not require a GitHub issue (javadoc, comments...).
In this case, just format the pull request title like [DOC] - Add javadoc in SessionManager.

If this is your first contribution, you have to read the Contribution Guidelines

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement
if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@github-actions github-actions Bot added the java Pull requests that update Java code label May 21, 2026
@lprimak lprimak changed the title bugfix: using atomics for session updates [#2713] bugfix: using atomics for session updates May 21, 2026
@lprimak lprimak self-assigned this May 21, 2026
@lprimak lprimak added this to the 3.0.0 milestone May 21, 2026
@lprimak lprimak changed the title [#2713] bugfix: using atomics for session updates [#2713] [3.0] bugfix: using atomics for session updates May 21, 2026
@lprimak lprimak requested a review from Copilot May 24, 2026 03:08
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR aims to address issue #2713 by making SimpleSession state updates (timestamps, timeout, expired flag, and attributes) more concurrency-safe, improving cross-thread visibility of session mutations that can affect timeout/expiration behavior.

Changes:

  • Replace stopTimestamp, lastAccessTime, timeout, and expired with AtomicReference/AtomicLong/AtomicBoolean wrappers.
  • Use ConcurrentHashMap for session attributes and update lazy initialization accordingly.
  • Update custom Java serialization logic (writeObject/readObject) to read/write the underlying values.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java
Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java
Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java Outdated
Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java:525

  • In readObject, attributes are deserialized directly into the session. Older serialized sessions may contain a non-concurrent Map (e.g., HashMap), which defeats the new thread-safety expectations for attributes and can reintroduce concurrency issues. Consider wrapping the deserialized map in a ConcurrentHashMap (or reusing setAttributes) after reading it from the stream.
        if (isFieldPresent(bitMask, HOST_BIT_MASK)) {
            this.host = in.readUTF();
        }
        if (isFieldPresent(bitMask, ATTRIBUTES_BIT_MASK)) {
            this.attributes = (Map<Object, Object>) in.readObject();
        }

Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java Outdated
Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java
Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java
Copy link
Copy Markdown
Contributor

@steinarb steinarb left a comment

Choose a reason for hiding this comment

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

It would be nice if this class had a test

@lprimak
Copy link
Copy Markdown
Contributor Author

lprimak commented May 24, 2026

Thanks Steinar! I am actually looking if there is a better way to do this (there probably is) so stay tuned. I may even close PR, or start over :)

@lprimak
Copy link
Copy Markdown
Contributor Author

lprimak commented May 25, 2026

I've decided to continue with current approach, Steinar,
Which test do you think is missing? Will be glad to add.
We have org/apache/shiro/session/mgt/SimpleSessionTest.java,
also we have org/apache/shiro/session/mgt/AbstractValidatingSessionManagerTest.java

It would be nice if this class had a test

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java Outdated
Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java
Comment thread core/src/main/java/org/apache/shiro/session/mgt/SimpleSession.java
@steinarb
Copy link
Copy Markdown
Contributor

steinarb commented May 25, 2026 via email

@lprimak
Copy link
Copy Markdown
Contributor Author

lprimak commented May 25, 2026

I doubt everything is covered, but yes thank you :)

@lprimak lprimak marked this pull request as ready for review May 27, 2026 00:40
@lprimak lprimak changed the title [#2713] [3.0] bugfix: using atomics for session updates [#2713] [3.0] bugfix: Improve thread-safety of Shiro-native sessions by using Atomic* classes May 27, 2026
@lprimak
Copy link
Copy Markdown
Contributor Author

lprimak commented May 27, 2026

Guys, I would love to get this into 3.0.0 so please review.

@lprimak lprimak requested a review from steinarb May 27, 2026 01:10
Copy link
Copy Markdown
Contributor

@steinarb steinarb left a comment

Choose a reason for hiding this comment

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

I've never used AtomicReference (had to google it), but changes LGTM! 👍

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

Labels

java Pull requests that update Java code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants