Skip to content

Conversation

@honkar-jdk
Copy link
Contributor

@honkar-jdk honkar-jdk commented Feb 13, 2025

Built-in Profiles are singleton objects and if the user happens to modify this shared profile object via setData() then the modified version of the profile is returned each time the same built-in profile is requested via getInstance().

It is good to protect Built-in profiles from such direct modification by adding BuiltIn profile check in setData() such that only copies of Built-In profiles are allowed to be updated.

With the proposed fix, if Built-In profile is updated using .setData() it throws IAE - "BuiltIn profile cannot be modified"

There are no restrictions on creating copies of BuiltIn profile and then modifying it, but what is being restricted with this fix is - the direct modification of the shared BuiltIn profile instance.

Applications which need a modified version of the ICC Profile should instead do the following:

byte[] profileData = ICC_Profile.getData() // get the byte array representation of BuiltIn- profile
ICCProfile newProfile = ICC_Profile.getInstance(profileData) // create a new profile
newProfile.setData() // to modify and customize the profile

Following existing tests are modified to update a copy of Built-In profile.

  • java/awt/color/ICC_Profile/SetHeaderInfo.java
  • java/awt/color/ICC_ProfileSetNullDataTest.java
  • sun/java2d/cmm/ProfileOp/SetDataTest.java

Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change requires CSR request JDK-8350025 to be approved
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Warnings

 ⚠️ Patch contains a binary file (test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/builtIn.icc)
 ⚠️ Patch contains a binary file (test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/custom.icc)

Issues

  • JDK-8346465: Add a check in setData() to restrict the update of Built-In ICC_Profiles (Bug - P3)
  • JDK-8350025: Add a check in setData() to restrict the update of Built-In ICC_Profiles (CSR)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/23606/head:pull/23606
$ git checkout pull/23606

Update a local copy of the PR:
$ git checkout pull/23606
$ git pull https://git.openjdk.org/jdk.git pull/23606/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 23606

View PR using the GUI difftool:
$ git pr show -t 23606

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/23606.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Feb 13, 2025

👋 Welcome back honkar! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Feb 13, 2025

@honkar-jdk This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8346465: Add a check in setData() to restrict the update of Built-In ICC_Profiles

Reviewed-by: aivanov, jdv, prr, serb

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 20 new commits pushed to the master branch:

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the rfr Pull request is ready for review label Feb 13, 2025
@openjdk
Copy link

openjdk bot commented Feb 13, 2025

@honkar-jdk The following label will be automatically applied to this pull request:

  • client

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the client client-libs-dev@openjdk.org label Feb 13, 2025
@mlbridge
Copy link

mlbridge bot commented Feb 13, 2025

@honkar-jdk
Copy link
Contributor Author

/csr needed

@openjdk openjdk bot added the csr Pull request needs approved CSR before integration label Feb 13, 2025
@openjdk
Copy link

openjdk bot commented Feb 13, 2025

@honkar-jdk has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@honkar-jdk please create a CSR request for issue JDK-8346465 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Mar 28, 2025
@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Apr 2, 2025
@honkar-jdk
Copy link
Contributor Author

honkar-jdk commented Apr 2, 2025

@aivanov-jdk As per our discussion I have updated the test code. Please re-review.

  • Moved profile creation and testing into separate methods - prepareTestProfile(), testProfile()
  • Added 2 more cases which tests reading .icc files that were serialized on older version of JDK.

@mrserb Can you please re-review the updated test.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Apr 8, 2025
@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Apr 9, 2025
Copy link
Member

@aivanov-jdk aivanov-jdk left a comment

Choose a reason for hiding this comment

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

Looks good to me, yet there are a few small typos, fixes…

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Apr 10, 2025
@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Apr 10, 2025
@openjdk openjdk bot added the ready Pull request is ready to be integrated label Apr 10, 2025
@honkar-jdk
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Apr 10, 2025

Going to push as commit 3131dd1.
Since your change was applied there have been 20 commits pushed to the master branch:

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Apr 10, 2025
@openjdk openjdk bot closed this Apr 10, 2025
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Apr 10, 2025
@openjdk
Copy link

openjdk bot commented Apr 10, 2025

@honkar-jdk Pushed as commit 3131dd1.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

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

Labels

client client-libs-dev@openjdk.org integrated Pull request has been integrated

Development

Successfully merging this pull request may close these issues.

5 participants