From 3131dd1d5cb601b84cf898fff589596c2bcabdbc Mon Sep 17 00:00:00 2001 From: Harshitha Onkar Date: Thu, 10 Apr 2025 19:55:29 +0000 Subject: [PATCH] 8346465: Add a check in setData() to restrict the update of Built-In ICC_Profiles Reviewed-by: aivanov, jdv, prr, serb --- .../classes/java/awt/color/ICC_Profile.java | 37 +++- .../BuiltInProfileCheck.java | 168 ++++++++++++++++++ .../BuiltInProfileCheck/builtIn.icc | Bin 0 -> 141 bytes .../BuiltInProfileCheck/custom.icc | Bin 0 -> 7030 bytes .../awt/color/ICC_Profile/SetHeaderInfo.java | 6 +- .../awt/color/ICC_ProfileSetNullDataTest.java | 34 ++-- .../sun/java2d/cmm/ProfileOp/SetDataTest.java | 6 +- 7 files changed, 228 insertions(+), 23 deletions(-) create mode 100644 test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/BuiltInProfileCheck.java create mode 100644 test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/builtIn.icc create mode 100644 test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/custom.icc diff --git a/src/java.desktop/share/classes/java/awt/color/ICC_Profile.java b/src/java.desktop/share/classes/java/awt/color/ICC_Profile.java index a11e0bd293b..5574b3c01f8 100644 --- a/src/java.desktop/share/classes/java/awt/color/ICC_Profile.java +++ b/src/java.desktop/share/classes/java/awt/color/ICC_Profile.java @@ -107,6 +107,14 @@ public sealed class ICC_Profile implements Serializable */ private transient volatile ProfileDeferralInfo deferralInfo; + + /** + * Set to {@code true} for {@code BuiltInProfile}, {@code false} otherwise. + * This flag is used in {@link #setData(int, byte[])} to prevent modifying + * built-in profiles. + */ + private final transient boolean builtIn; + /** * The lazy registry of singleton profile objects for specific built-in * color spaces defined in the ColorSpace class (e.g. CS_sRGB), @@ -114,8 +122,8 @@ public sealed class ICC_Profile implements Serializable */ private interface BuiltInProfile { /* - * Deferral is only used for standard profiles. Enabling the appropriate - * access privileges is handled at a lower level. + * ProfileDeferralInfo is used for built-in profile creation only, + * and all built-in profiles should be constructed using it. */ ICC_Profile SRGB = new ICC_ProfileRGB(new ProfileDeferralInfo( "sRGB.pf", ColorSpace.TYPE_RGB, 3, CLASS_DISPLAY)); @@ -763,14 +771,20 @@ public sealed class ICC_Profile implements Serializable */ ICC_Profile(Profile p) { cmmProfile = p; + builtIn = false; } /** * Constructs an {@code ICC_Profile} object whose loading will be deferred. * The ID will be 0 until the profile is loaded. + * + *

+ * Note: {@code ProfileDeferralInfo} is used for built-in profile + * creation only, and all built-in profiles should be constructed using it. */ ICC_Profile(ProfileDeferralInfo pdi) { deferralInfo = pdi; + builtIn = true; } /** @@ -1131,17 +1145,34 @@ public sealed class ICC_Profile implements Serializable * This method is useful for advanced applications which need to access * profile data directly. * + *

+ * Note: JDK built-in ICC Profiles cannot be updated using this method + * as it will result in {@code IllegalArgumentException}. JDK built-in + * profiles are those obtained by {@code ICC_Profile.getInstance(int colorSpaceID)} + * where {@code colorSpaceID} is one of the following: + * {@link ColorSpace#CS_sRGB}, {@link ColorSpace#CS_LINEAR_RGB}, + * {@link ColorSpace#CS_PYCC}, {@link ColorSpace#CS_GRAY} or + * {@link ColorSpace#CS_CIEXYZ}. + * * @param tagSignature the ICC tag signature for the data element you want * to set * @param tagData the data to set for the specified tag signature * @throws IllegalArgumentException if {@code tagSignature} is not a * signature as defined in the ICC specification. - * @throws IllegalArgumentException if a content of the {@code tagData} + * @throws IllegalArgumentException if the content of the {@code tagData} * array can not be interpreted as valid tag data, corresponding to * the {@code tagSignature} + * @throws IllegalArgumentException if this is a built-in profile for one + * of the pre-defined color spaces, that is those which can be obtained + * by calling {@code ICC_Profile.getInstance(int colorSpaceID)} * @see #getData + * @see ColorSpace */ public void setData(int tagSignature, byte[] tagData) { + if (builtIn) { + throw new IllegalArgumentException("Built-in profile cannot be modified"); + } + if (tagSignature == ICC_Profile.icSigHead) { verifyHeader(tagData); } diff --git a/test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/BuiltInProfileCheck.java b/test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/BuiltInProfileCheck.java new file mode 100644 index 00000000000..8f00ab10747 --- /dev/null +++ b/test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/BuiltInProfileCheck.java @@ -0,0 +1,168 @@ +/* + * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @bug 8346465 + * @summary Tests if setData() throws IAE for BuiltIn profiles + */ + +import java.awt.color.ColorSpace; +import java.awt.color.ICC_Profile; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.FileInputStream; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import java.util.Map; + +public class BuiltInProfileCheck { + private static final int HEADER_TAG = ICC_Profile.icSigHead; + private static final int INDEX = ICC_Profile.icHdrDeviceClass; + private static final String EXCEPTION_MSG = "Built-in profile cannot be modified"; + /** + * {@link #prepareTestProfile(String, boolean, int)} + * stores the profile to test in testProfile. + */ + private static ICC_Profile testProfile; + + private static final Map colorSpace = Map.of( + ColorSpace.CS_sRGB, "CS_sRGB", + ColorSpace.CS_PYCC, "CS_PYCC", + ColorSpace.CS_GRAY, "CS_GRAY", + ColorSpace.CS_CIEXYZ, "CS_CIEXYZ", + ColorSpace.CS_LINEAR_RGB, "CS_LINEAR_RGB" + ); + + public static void main(String[] args) throws Exception { + System.out.println("CASE 1: Testing BuiltIn Profile"); + for (int cs : colorSpace.keySet()) { + prepareTestProfile("Default", true, cs); + testProfile(true, cs); + } + System.out.println("Passed\n"); + + System.out.println("CASE 2: Testing Custom Profile"); + prepareTestProfile("Default", false, ColorSpace.CS_sRGB); + testProfile(false, ColorSpace.CS_sRGB); + System.out.println("Passed\n"); + + System.out.println("CASE 3: Testing Built-In Profile" + + " Serialization & Deserialization"); + for (int cs : colorSpace.keySet()) { + prepareTestProfile("Serialize", true, cs); + testProfile(true, cs); + } + System.out.println("Passed\n"); + + System.out.println("CASE 4: Testing Custom Profile" + + " Serialization & Deserialization"); + prepareTestProfile("Serialize", false, ColorSpace.CS_sRGB); + testProfile(false, ColorSpace.CS_sRGB); + System.out.println("Passed\n"); + + System.out.println("CASE 5: Test reading Built-In profile from .icc file"); + prepareTestProfile("ReadFromFile", true, ColorSpace.CS_sRGB); + testProfile(true, ColorSpace.CS_sRGB); + System.out.println("Passed\n"); + + System.out.println("CASE 6: Test reading Custom profile from .icc file"); + prepareTestProfile("ReadFromFile", false, ColorSpace.CS_sRGB); + testProfile(false, ColorSpace.CS_sRGB); + System.out.println("Passed\n"); + } + + private static void prepareTestProfile(String testCase, + boolean isBuiltIn, int cs) { + ICC_Profile builtInProfile = ICC_Profile.getInstance(cs); + // if isBuiltIn=true use builtInProfile else create a copy + testProfile = isBuiltIn + ? builtInProfile + : ICC_Profile.getInstance(builtInProfile.getData()); + + switch (testCase) { + case "Default" -> { + // empty case block + // no further processing of testProfile required for default case + } + case "Serialize" -> { + try (ByteArrayOutputStream baos = new ByteArrayOutputStream(); + ObjectOutputStream oos = new ObjectOutputStream(baos)) { + oos.writeObject(testProfile); + + byte[] array = baos.toByteArray(); + try (ObjectInputStream ois = + new ObjectInputStream(new ByteArrayInputStream(array))) { + testProfile = (ICC_Profile) ois.readObject(); + } + } catch (Exception e) { + throw new RuntimeException("Test Failed ! Serial-Deserialization" + + " case failed", e); + } + } + case "ReadFromFile" -> { + // .icc files serialized on older JDK version + String filename = isBuiltIn ? "builtIn.icc" : "custom.icc"; + String testDir = System.getProperty("test.src") + + System.getProperty("file.separator"); + filename = testDir + filename; + + try (FileInputStream fileIn = new FileInputStream(filename); + ObjectInputStream ois = new ObjectInputStream(fileIn)) { + testProfile = (ICC_Profile) ois.readObject(); + } catch (Exception e) { + throw new RuntimeException("Test Failed ! Unable to fetch" + + " .icc files", e); + } + } + } + } + + private static void testProfile(boolean isBuiltIn, int cs) { + byte[] headerData = testProfile.getData(HEADER_TAG); + // Set profile class to valid icSigInputClass = 0x73636E72 + headerData[INDEX] = 0x73; + headerData[INDEX + 1] = 0x63; + headerData[INDEX + 2] = 0x6E; + headerData[INDEX + 3] = 0x72; + + if (isBuiltIn) { + System.out.println("Testing: " + colorSpace.get(cs)); + try { + // Try updating a built-in profile, IAE is expected + testProfile.setData(HEADER_TAG, headerData); + throw new RuntimeException("Test Failed! IAE NOT thrown for profile " + + colorSpace.get(cs)); + } catch (IllegalArgumentException iae) { + if (!iae.getMessage().equals(EXCEPTION_MSG)) { + throw new RuntimeException("Test Failed! IAE with exception msg \"" + + EXCEPTION_MSG + "\" NOT thrown for profile " + + colorSpace.get(cs)); + } + } + } else { + // Modifying custom profile should NOT throw IAE + testProfile.setData(HEADER_TAG, headerData); + } + } +} diff --git a/test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/builtIn.icc b/test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/builtIn.icc new file mode 100644 index 0000000000000000000000000000000000000000..dbe11f2c6d651974009b5c4d96db2f45923a47dc GIT binary patch literal 141 zcmZ4UmVvdnh(R_hu`E$9vAjetIX@@ANYB&RIX<8$KP@vSHOSqmj6-netmDhsm>3u; ziWsDDt34S$WyATC@12+#7(E%}Gn12{W(21eWhUliR;8x6B$gzGr4|)u=I2!uFfcGM QmN2k82ger!Z7HY#0O%4im;e9( literal 0 HcmV?d00001 diff --git a/test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/custom.icc b/test/jdk/java/awt/color/ICC_Profile/BuiltInProfileCheck/custom.icc new file mode 100644 index 0000000000000000000000000000000000000000..b32c838c80ad94b311dcd5af73d74c1ad0ec9dd6 GIT binary patch literal 7030 zcmeHMXHXQ`8ok{;IS^)G2$FLU1SAX~IVZ_cRE8PC5C$BgU_=&IUxKzEQuMOnpFL`CJz=&RbduipE&_5Qr+s_uLG^jF{a-R@h}r_OEt9iUUV zKt7I<&d_IMr0O%15|X(3ZVnEceYi={?1U&k7yERacu(bEBL)T_lM7`3d+bnf>8YDT zuj~;3xdBBslljja{!v^uBY~Y2#d2h%GJ>MGDeNRpW-1Yfc!PcG8>#mgTmVl{ zg3rrN3C;v&VhU^kKq4oV%Wp#|Bs5G3I{`>Q4p0CV&=|~=WG{c`0Dc}Ih!u=~J>E?K zNWk3I`_Iq+8vSo~L{=h)#cvVE=i^vWDNH_2<>OdZB1^#Ydjzo=smXi}cI0CTF26xO z4iVtUZ#Y4KW4_^CUtM*xUv z2_~V$=A=e(IgAADujJo(`IlNEDS{UsnZ`~?)njx1&LaF=|EoHJ_42LtH&$QQ0YoeR zlS|@%1Nut;`$D02G5mpc2%8de8*gz-iD0&Vq~J z3b+n#fpPEv@W3p10T#eJuna*E79vAbNCr}b)FEBS2%9P$DlLNdFV291G)o!89k1kMZd#fFf@!N#th?%3B|-=vN462Bbau~1SgMz1V%zr!c8Jh zqCnzDi4lnfNs6SgWRPU0WR>JONgfTMY0%tg3A7^GY1#zsqm;aqom7<6KB+dTF{vf# zRnoT7QPTO+?b74YA7zweoMhr<4#;%LJd{Pr>d5-aX2>3uy(~MwN@A7eD(0&ERi{_o zmxJYWlAl+gDcCB+DU>SoDaC@m<aul@=#H*NuQp%JSzWh!Qjer(ryfl^BqT=C{BS+l}?YGRh(m-TbvhMOkA>E zF1VsyJzNjCPP)mvG2NQn7TnF;x4RE`kUac7Dm@;1>UeTJd%a*Ucdvt9Q|r~&bJllx z18+C)gWeB)G<~-C{Nju8_3^Fped1^6x6N@9ZDPw}=h+VIO7`nG*SMOvrFif7#`u+l;Dq)>Tw+9G4~N2u=L{q%BxNRz zChI2WCG)meY&o=Lf$PC-NP$u|rgW!D@PEw1Xr&p!F&j`vmlPR9b$sFFQ zvvuFrr&-QfC$dr5%y>^ixduseSDjU0oV zlAO1Dg7@_1%IEINo%zn?yOunWJZ|3PUdz2T-=n@~e?PKs?Y@eAU-DV`*9r^@$_hRe zG7GQ$VE9A%4=ekl_m32r79B0d6myCv4%i$xSt4GNRWftX>tJW8QfYqa+e4cV4V4*} z)f^@qPCLvi_bl(OP^&1e_*5BNIbLO7)m|-Ey{~%d2~7O*t8J&X7n}m8(oQ}9DdMMz(;lb$&(P1b{jC0TbqBR0zZ2@*+PTmb+r{e+ z?H=uM@9FQg?CtnP|Ch$I%4e(2NuDd}BlP9=t(?y~zjz_}!u-XUi!=S3`yX5ixpZg1 zcVOhQ$K|V6oUdFOv>QBs)#~cmA&a4&YxHYf*G;c?4x0>j+%UP(F=9H>dDHA>_bu~V zy`$?!`^Id>F5Y&$edUhZo$KT4$44guC+<#$Px9`v?moMhaPRf~^!v*Xc1@wD@*j#l zEPEvPsP0$oU)y=6ymQlz)5DMbA3vC3&b;_7<+o3>xlhPX%AP7dZF*+(?ChNL+^y#u zp3lBWez82C_q+J-)i1SP{`|`J)$l^d!t87A>yslKG5F)t<&00*PvxJrKlgs|_%gMUxUwSD0zxey)B-{+Ak+dvEg;kaLM colorSpace = Map.of( + ColorSpace.CS_sRGB, "CS_sRGB", + ColorSpace.CS_PYCC, "CS_PYCC", + ColorSpace.CS_GRAY, "CS_GRAY", + ColorSpace.CS_CIEXYZ, "CS_CIEXYZ", + ColorSpace.CS_LINEAR_RGB, "CS_LINEAR_RGB" + ); public static void main(String[] args) { - test(ICC_Profile.getInstance(ColorSpace.CS_sRGB)); - test(ICC_Profile.getInstance(ColorSpace.CS_LINEAR_RGB)); - test(ICC_Profile.getInstance(ColorSpace.CS_CIEXYZ)); - test(ICC_Profile.getInstance(ColorSpace.CS_PYCC)); - test(ICC_Profile.getInstance(ColorSpace.CS_GRAY)); - } - - private static void test(ICC_Profile profile) { - byte[] tagData = null; - try { - profile.setData(ICC_Profile.icSigCmykData, tagData); - } catch (IllegalArgumentException e) { - return; + for (int cs : colorSpace.keySet()) { + ICC_Profile builtInProfile = ICC_Profile.getInstance(cs); + ICC_Profile profile = ICC_Profile.getInstance(builtInProfile.getData()); + try { + profile.setData(ICC_Profile.icSigCmykData, null); + throw new RuntimeException("IAE expected, but not thrown for " + + "ColorSpace: " + colorSpace.get(cs)); + } catch (IllegalArgumentException e) { + // IAE expected + } } - throw new RuntimeException("IllegalArgumentException expected"); } } diff --git a/test/jdk/sun/java2d/cmm/ProfileOp/SetDataTest.java b/test/jdk/sun/java2d/cmm/ProfileOp/SetDataTest.java index dc86de98bfa..6850061b225 100644 --- a/test/jdk/sun/java2d/cmm/ProfileOp/SetDataTest.java +++ b/test/jdk/sun/java2d/cmm/ProfileOp/SetDataTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2011, 2025, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -29,7 +29,6 @@ * @run main SetDataTest */ - import java.util.ArrayList; import java.util.List; import java.awt.color.ICC_Profile; @@ -47,7 +46,8 @@ public class SetDataTest { static byte[] invalidTRCData; static { - profile = ICC_Profile.getInstance(CS_GRAY); + ICC_Profile builtInProfile = ICC_Profile.getInstance(CS_GRAY); + profile = ICC_Profile.getInstance(builtInProfile.getData()); validTRCdata = profile.getData(icSigGrayTRCTag); invalidTRCData = new byte[]{0x42, 0x42, 0x42, 0x42, 1, 3, 4, 6,}; }