classlib/modules/archive/src/test/java/org/apache/harmony/archive/tests/java/util/jar/JarFileTest.java

/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.harmony.archive.tests.java.util.jar;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.security.cert.Certificate;
import java.util.Enumeration;
import java.util.Vector;
import java.util.jar.Attributes;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
import java.util.zip.ZipEntry;

import junit.framework.TestCase;
import tests.support.Support_PlatformFile;
import tests.support.resource.Support_Resources;

public class JarFileTest extends TestCase {

    /**
     * The file contains the following entries:
     * 
     * <pre>
     * META-INF/ META-INF/MANIFEST.MF
     * foo/ foo/bar/ foo/bar/A.class
     * Blah.txt
     * </pre>
     */
    private final String JAR1 = "hyts_patch.jar";

    private final String JAR2 = "hyts_patch2.jar";

    private final String JAR3 = "hyts_manifest1.jar";

    private final String JAR4 = "hyts_signed.jar";

    private final String JAR5 = "Integrate.jar";

    private final String JAR1_ENTRY1 = "foo/bar/A.class";

    private final String JAR5_SIGNED_ENTRY = "Test.class";

    private final String JAR4_SIGNED_ENTRY = "coucou/FileAccess.class";

    private File resources;

    private final String jarName = "hyts_patch.jar"; // a 'normal' jar file

    private final String entryName = "foo/bar/A.class";

    private final String emptyEntryJar = "EmptyEntries_signed.jar";

    private final String emptyEntry1 = "subfolder/internalSubset01.js";

    private final String emptyEntry2 = "svgtest.js";

    private final String emptyEntry3 = "svgunit.js";

    @Override
    protected void setUp() {
        resources = Support_Resources.createTempFolder();
    }

    /**
     * Constructs JarFile object.
     * 
     * @tests java.util.jar.JarFile#JarFile(java.io.File)
     * @tests java.util.jar.JarFile#JarFile(java.lang.String)
     */
    public void testConstructor() throws IOException {
        File f = new File(resources, JAR1);
        Support_Resources.copyFile(resources, null, JAR1);
        assertTrue(new JarFile(f).getEntry(JAR1_ENTRY1).getName().equals(
                JAR1_ENTRY1));
        assertTrue(new JarFile(f.getPath()).getEntry(JAR1_ENTRY1).getName()
                .equals(JAR1_ENTRY1));
    }

    /**
     * @tests java.util.jar.JarFile#entries()
     */
    public void testEntries() throws Exception {
        Support_Resources.copyFile(resources, null, JAR1);
        JarFile jarFile = new JarFile(new File(resources, JAR1));
        Enumeration<JarEntry> e = jarFile.entries();
        int i;
        for (i = 0; e.hasMoreElements(); i++) {
            e.nextElement();
        }
        assertEquals(jarFile.size(), i);
        jarFile.close();
        assertEquals(6, i);
    }

    public void testEntriesIterator() throws Exception {
        Support_Resources.copyFile(resources, null, JAR1);
        JarFile jarFile = new JarFile(new File(resources, JAR1));
        Enumeration<JarEntry> enumeration = jarFile.entries();
        jarFile.close();
        try {
            enumeration.hasMoreElements();
            fail("hasMoreElements() did not detect a closed jar file");
        } catch (IllegalStateException e) {
        }
        Support_Resources.copyFile(resources, null, JAR1);
        jarFile = new JarFile(new File(resources, JAR1));
        enumeration = jarFile.entries();
        jarFile.close();
        try {
            enumeration.nextElement();
            fail("nextElement() did not detect closed jar file");
        } catch (IllegalStateException e) {
        }
    }

    public void test_getEntryLjava_lang_String() throws IOException {
        try {
            Support_Resources.copyFile(resources, null, jarName);
            JarFile jarFile = new JarFile(new File(resources, jarName));
            assertEquals("Error in returned entry", 311, jarFile.getEntry(
                    entryName).getSize());
            jarFile.close();
        } catch (Exception e) {
            fail("Exception during test: " + e.toString());
        }

        Support_Resources.copyFile(resources, null, jarName);
        JarFile jarFile = new JarFile(new File(resources, jarName));
        Enumeration<JarEntry> enumeration = jarFile.entries();
        assertTrue(enumeration.hasMoreElements());
        while (enumeration.hasMoreElements()) {
            JarEntry je = enumeration.nextElement();
            jarFile.getEntry(je.getName());
        }

        enumeration = jarFile.entries();
        assertTrue(enumeration.hasMoreElements());
        JarEntry je = enumeration.nextElement();
        try {
            jarFile.close();
            jarFile.getEntry(je.getName());
            // fail("IllegalStateException expected.");
        } catch (IllegalStateException ee) { // Per documentation exception
            // may be thrown.
            // expected
        }
    }

    public void test_getJarEntryLjava_lang_String() throws IOException {
        try {
            Support_Resources.copyFile(resources, null, jarName);
            JarFile jarFile = new JarFile(new File(resources, jarName));
            assertEquals("Error in returned entry", 311, jarFile.getJarEntry(
                    entryName).getSize());
            jarFile.close();
        } catch (Exception e) {
            fail("Exception during test: " + e.toString());
        }

        Support_Resources.copyFile(resources, null, jarName);
        JarFile jarFile = new JarFile(new File(resources, jarName));
        Enumeration<JarEntry> enumeration = jarFile.entries();
        assertTrue(enumeration.hasMoreElements());
        while (enumeration.hasMoreElements()) {
            JarEntry je = enumeration.nextElement();
            jarFile.getJarEntry(je.getName());
        }

        enumeration = jarFile.entries();
        assertTrue(enumeration.hasMoreElements());
        JarEntry je = enumeration.nextElement();
        try {
            jarFile.close();
            jarFile.getJarEntry(je.getName());
            // fail("IllegalStateException expected.");
        } catch (IllegalStateException ee) { // Per documentation exception
            // may be thrown.
            // expected
        }
    }

    /**
     * @tests java.util.jar.JarFile#getJarEntry(java.lang.String)
     */
    public void testGetJarEntry() throws Exception {
        Support_Resources.copyFile(resources, null, JAR1);
        JarFile jarFile = new JarFile(new File(resources, JAR1));
        assertEquals("Error in returned entry", 311, jarFile.getEntry(
                JAR1_ENTRY1).getSize());
        jarFile.close();

        // tests for signed jars
        // test all signed jars in the /Testres/Internal/SignedJars directory
        String jarDirUrl = Support_Resources
                .getResourceURL("/../internalres/signedjars");
        Vector<String> signedJars = new Vector<String>();
        try {
            InputStream is = new URL(jarDirUrl + "/jarlist.txt").openStream();
            while (is.available() > 0) {
                StringBuilder linebuff = new StringBuilder(80); // Typical line
                // length
                done: while (true) {
                    int nextByte = is.read();
                    switch (nextByte) {
                    case -1:
                        break done;
                    case (byte) '\r':
                        if (linebuff.length() == 0) {
                            // ignore
                        }
                        break done;
                    case (byte) '\n':
                        if (linebuff.length() == 0) {
                            // ignore
                        }
                        break done;
                    default:
                        linebuff.append((char) nextByte);
                    }
                }
                if (linebuff.length() == 0) {
                    break;
                }
                String line = linebuff.toString();
                signedJars.add(line);
            }
            is.close();
        } catch (IOException e) {
            // no list of jars found
        }

        for (int i = 0; i < signedJars.size(); i++) {
            String jarName = signedJars.get(i);
            try {
                File file = Support_Resources.getExternalLocalFile(jarDirUrl
                        + "/" + jarName);
                jarFile = new JarFile(file, true);
                boolean foundCerts = false;
                Enumeration<JarEntry> e = jarFile.entries();
                while (e.hasMoreElements()) {
                    JarEntry entry = e.nextElement();
                    InputStream is = jarFile.getInputStream(entry);
                    is.skip(100000);
                    is.close();
                    Certificate[] certs = entry.getCertificates();
                    if (certs != null && certs.length > 0) {
                        foundCerts = true;
                        break;
                    }
                }
                assertTrue(
                        "No certificates found during signed jar test for jar \""
                                + jarName + "\"", foundCerts);
            } catch (IOException e) {
                fail("Exception during signed jar test for jar \"" + jarName
                        + "\": " + e.toString());
            }
        }
    }

    /**
     * @tests java.util.jar.JarFile#getManifest()
     */
    public void testGetManifest() throws Exception {
        // Test for method java.util.jar.Manifest
        // java.util.jar.JarFile.getManifest()
        Support_Resources.copyFile(resources, null, JAR1);
        JarFile jarFile = new JarFile(new File(resources, JAR1));
        InputStream is = jarFile.getInputStream(jarFile.getEntry(JAR1_ENTRY1));
        assertTrue(is.available() > 0);
        assertNotNull("Error--Manifest not returned", jarFile.getManifest());
        jarFile.close();

        Support_Resources.copyFile(resources, null, JAR2);
        jarFile = new JarFile(new File(resources, JAR2));
        assertNull("Error--should have returned null", jarFile.getManifest());
        jarFile.close();

        // jarName3 was created using the following test
        Support_Resources.copyFile(resources, null, JAR3);
        jarFile = new JarFile(new File(resources, JAR3));
        assertNotNull("Should find manifest without verifying", jarFile
                .getManifest());
        jarFile.close();

        // this is used to create jarName3 used in the previous test
        Manifest manifest = new Manifest();
        Attributes attributes = manifest.getMainAttributes();
        attributes.put(new Attributes.Name("Manifest-Version"), "1.0");
        ByteArrayOutputStream manOut = new ByteArrayOutputStream();
        manifest.write(manOut);
        byte[] manBytes = manOut.toByteArray();
        File file = new File(Support_PlatformFile.getNewPlatformFile(
                "hyts_manifest1", ".jar"));
        JarOutputStream jarOut = new JarOutputStream(new FileOutputStream(file
                .getAbsolutePath()));
        ZipEntry entry = new ZipEntry("META-INF/");
        entry.setSize(0);
        jarOut.putNextEntry(entry);
        entry = new ZipEntry(JarFile.MANIFEST_NAME);
        entry.setSize(manBytes.length);
        jarOut.putNextEntry(entry);
        jarOut.write(manBytes);
        entry = new ZipEntry("myfile");
        entry.setSize(1);
        jarOut.putNextEntry(entry);
        jarOut.write(65);
        jarOut.close();
        JarFile jar = new JarFile(file.getAbsolutePath(), false);
        assertNotNull("Should find manifest without verifying", jar
                .getManifest());
        jar.close();
        file.delete();

        try {
            Support_Resources.copyFile(resources, null, JAR2);
            JarFile jF = new JarFile(new File(resources, JAR2));
            jF.close();
            jF.getManifest();
            fail("IllegalStateException expected");
        } catch (IllegalStateException ise) {
            // expected;
        }
    }

    /**
     * @tests java.util.jar.JarFile#getInputStream(java.util.zip.ZipEntry)
     */
    public void testGetInputStream() throws Exception {
        File localFile;
        byte[] b = new byte[1024];
        JarFile jf;
        InputStream is;

        Support_Resources.copyFile(resources, null, JAR1);
        localFile = new File(resources, JAR1);

        jf = new JarFile(localFile);

        is = jf.getInputStream(new JarEntry("invalid"));
        assertNull("Got stream for non-existent entry", is);

        is = jf.getInputStream(jf.getEntry(JAR1_ENTRY1));
        assertTrue("Returned invalid stream", is.available() > 0);

        // try to read class file header
        is.read(b, 0, 1024);
        jf.close();
        assertEquals("Invalid bytes were read", (byte) 0xCA, b[0]);
        assertEquals("Invalid bytes were read", (byte) 0xFE, b[1]);
        assertEquals("Invalid bytes were read", (byte) 0xBA, b[2]);
        assertEquals("Invalid bytes were read", (byte) 0xBE, b[3]);
    }

    /**
     * Signed file is verified by default.
     * 
     * @tests java.util.jar.JarFile#getInputStream(java.util.zip.ZipEntry)
     */
    public void testInputStreamOperations() throws Exception {
        Support_Resources.copyFile(resources, null, JAR4);
        File signedFile = new File(resources, JAR4);

        JarFile jar = new JarFile(signedFile);
        JarEntry entry = new JarEntry(JAR4_SIGNED_ENTRY);
        InputStream in = jar.getInputStream(entry);
        in.read();

        // RI verifies only entries which appear via getJarEntry method
        jar = new JarFile(signedFile);
        entry = jar.getJarEntry(JAR4_SIGNED_ENTRY);
        in = jar.getInputStream(entry);
        readExactly(in, (int) entry.getSize() - 1);
        assertNull(entry.getCertificates());
        in.read();
        assertNotNull(entry.getCertificates());
        assertEquals(-1, in.read());

        jar = new JarFile(signedFile);
        entry = jar.getJarEntry(JAR4_SIGNED_ENTRY);
        entry.setSize(entry.getSize() - 1);
        in = jar.getInputStream(entry);
        readExactly(in, (int) entry.getSize() - 1);
        assertNull(entry.getCertificates());
        try {
            in.read();
            fail("SecurityException expected");
        } catch (SecurityException e) {
            // desired
        }
        assertEquals(-1, in.read());
    }

    /**
     * Performs as many read() calls as necessary to read {@code numBytes} from
     * the stream. Should the stream exhaust early, this method will fail.
     */
    private void readExactly(InputStream in, int numBytes) throws IOException {
        byte[] buffer = new byte[1024];
        while (numBytes > 0) {
            int read = in.read(buffer, 0, Math.min(numBytes, 1024));
            assertTrue(read != -1);
            numBytes -= read;
        }
    }

    /*
     * The jar created by 1.4 which does not provide a
     * algorithm-Digest-Manifest-Main-Attributes entry in .SF file.
     */
    public void testJar14() throws IOException {
        String modifiedJarName = "Created_by_1_4.jar";
        Support_Resources.copyFile(resources, null, modifiedJarName);
        JarFile jarFile = new JarFile(new File(resources, modifiedJarName),
                true);
        Enumeration<JarEntry> entries = jarFile.entries();
        while (entries.hasMoreElements()) {
            ZipEntry zipEntry = entries.nextElement();
            jarFile.getInputStream(zipEntry);
        }
    }

    /**
     * The jar is intact, then everything is all right.
     */
    public void testJarVerification() throws IOException {
        Support_Resources.copyFile(resources, null, JAR5);
        JarFile jarFile = new JarFile(new File(resources, JAR5), true);
        Enumeration<JarEntry> entries = jarFile.entries();
        while (entries.hasMoreElements()) {
            ZipEntry zipEntry = entries.nextElement();
            jarFile.getInputStream(zipEntry).skip(Long.MAX_VALUE);
        }
    }

    /**
     * The jar is intact, but the entry object is modified.
     */
    public void testJarVerificationModifiedEntry() throws IOException {
        Support_Resources.copyFile(resources, null, JAR5);
        File f = new File(resources, JAR5);

        JarFile jarFile = new JarFile(f);
        ZipEntry zipEntry = jarFile.getJarEntry(JAR5_SIGNED_ENTRY);
        zipEntry.setSize(zipEntry.getSize() + 1);
        jarFile.getInputStream(zipEntry).skip(Long.MAX_VALUE);

        jarFile = new JarFile(f);
        zipEntry = jarFile.getJarEntry(JAR5_SIGNED_ENTRY);
        zipEntry.setSize(zipEntry.getSize() - 1);
        try {
            //jarFile.getInputStream(zipEntry).skip(Long.MAX_VALUE);
            jarFile.getInputStream(zipEntry).read(new byte[5000], 0, 5000);
            fail("SecurityException expected");
        } catch (SecurityException e) {
            // desired
        }
    }

    /*
     * If another entry is inserted into Manifest, no security exception will be
     * thrown out.
     */
    public void testJarFileInsertEntryInManifestJar() throws IOException {
        String modifiedJarName = "Inserted_Entry_Manifest.jar";
        Support_Resources.copyFile(resources, null, modifiedJarName);
        JarFile jarFile = new JarFile(new File(resources, modifiedJarName),
                true);
        Enumeration<JarEntry> entries = jarFile.entries();
        int count = 0;
        while (entries.hasMoreElements()) {

            ZipEntry zipEntry = entries.nextElement();
            jarFile.getInputStream(zipEntry);
            count++;
        }
        assertEquals(5, count);
    }

    /*
     * If another entry is inserted into Manifest, no security exception will be
     * thrown out.
     */
    public void testInsertedEntryManifestWithDigestCode() throws IOException {
        String modifiedJarName = "Inserted_Entry_Manifest_with_DigestCode.jar";
        Support_Resources.copyFile(resources, null, modifiedJarName);
        JarFile jarFile = new JarFile(new File(resources, modifiedJarName),
                true);
        Enumeration<JarEntry> entries = jarFile.entries();
        int count = 0;
        while (entries.hasMoreElements()) {
            ZipEntry zipEntry = entries.nextElement();
            jarFile.getInputStream(zipEntry);
            count++;
        }
        assertEquals(5, count);
    }

    /*
     * The content of Test.class is modified, jarFile.getInputStream will not
     * throw security Exception, but it will anytime before the inputStream got
     * from getInputStream method has been read to end.
     */
    public void testJarFileModifiedClass() throws IOException {
        String modifiedJarName = "Modified_Class.jar";
        Support_Resources.copyFile(resources, null, modifiedJarName);
        JarFile jarFile = new JarFile(new File(resources, modifiedJarName),
                true);
        Enumeration<JarEntry> entries = jarFile.entries();
        while (entries.hasMoreElements()) {
            ZipEntry zipEntry = entries.nextElement();
            jarFile.getInputStream(zipEntry);
        }
        /* The content of Test.class has been tampered. */
        ZipEntry zipEntry = jarFile.getEntry("Test.class");
        InputStream in = jarFile.getInputStream(zipEntry);
        byte[] buffer = new byte[1024];
        try {
            while (in.available() > 0) {
                in.read(buffer);
            }
            fail("SecurityException expected");
        } catch (SecurityException e) {
            // desired
        }
    }

    /*
     * In the Modified.jar, the main attributes of META-INF/MANIFEST.MF is
     * tampered manually. Hence the RI 5.0 JarFile.getInputStream of any
     * JarEntry will throw security exception.
     */
    public void testJarFileModifiedManifestMainAttributes() throws IOException {
        String modifiedJarName = "Modified_Manifest_MainAttributes.jar";
        Support_Resources.copyFile(resources, null, modifiedJarName);
        JarFile jarFile = new JarFile(new File(resources, modifiedJarName),
                true);
        Enumeration<JarEntry> entries = jarFile.entries();
        while (entries.hasMoreElements()) {
            ZipEntry zipEntry = entries.nextElement();
            try {
                jarFile.getInputStream(zipEntry);
                fail("SecurityException expected");
            } catch (SecurityException e) {
                // desired
            }
        }
    }

    /*
     * It is all right in our original JarFile. If the Entry Attributes, for
     * example Test.class in our jar, the jarFile.getInputStream will throw
     * Security Exception.
     */
    public void testJarFileModifiedManifestEntryAttributes() throws IOException {
        String modifiedJarName = "Modified_Manifest_EntryAttributes.jar";
        Support_Resources.copyFile(resources, null, modifiedJarName);
        JarFile jarFile = new JarFile(new File(resources, modifiedJarName),
                true);
        Enumeration<JarEntry> entries = jarFile.entries();
        while (entries.hasMoreElements()) {
            ZipEntry zipEntry = entries.nextElement();
            try {
                jarFile.getInputStream(zipEntry);
                fail("should throw Security Exception");
            } catch (SecurityException e) {
                // desired
            }
        }
    }

    /*
     * If the content of the .SA file is modified, no matter what it resides,
     * JarFile.getInputStream of any JarEntry will throw Security Exception.
     */
    public void testJarFileModifiedSfEntryAttributes() throws IOException {
        String modifiedJarName = "Modified_SF_EntryAttributes.jar";
        Support_Resources.copyFile(resources, null, modifiedJarName);
        JarFile jarFile = new JarFile(new File(resources, modifiedJarName),
                true);
        Enumeration<JarEntry> entries = jarFile.entries();
        while (entries.hasMoreElements()) {
            ZipEntry zipEntry = entries.nextElement();
            try {
                jarFile.getInputStream(zipEntry);
                fail("should throw Security Exception");
            } catch (SecurityException e) {
                // desired
            }
        }
    }
    
    /*
     * @test JarFile.getInputStream()
     */
    public void testGetInputStreamLjava_util_jar_JarEntry() throws IOException {
        Support_Resources.copyFile(resources, null, JAR1);
        JarFile jf = new JarFile(new File(resources, JAR1));
        InputStream is = jf.getInputStream(jf.getEntry(JAR1_ENTRY1));
        assertTrue(is.available() > 0);

        byte[] buffer = new byte[1024];
        int r = is.read(buffer, 0, 1024);
        jf.close();
        is.close();

        StringBuilder sb = new StringBuilder(r);
        for (int i = 0; i < r; i++) {
            sb.append((char) (buffer[i] & 0xff));
        }
        String contents = sb.toString();
        assertTrue(contents.indexOf("foo") > 0);
        assertTrue(contents.indexOf("bar") > 0);

        try {
            jf.getInputStream(jf.getEntry(JAR1_ENTRY1));
            fail("should throw IllegalStateException");
        } catch (IllegalStateException e) {
            // Expected
        }

        jf = new JarFile(new File(resources, JAR1));
        is = jf.getInputStream(new JarEntry("invalid"));
        assertNull(is);
        jf.close(); 
    }

    public void testJarVerificationEmptyEntry() throws IOException {
        Support_Resources.copyFile(resources, null, emptyEntryJar);
        File f = new File(resources, emptyEntryJar);

        JarFile jarFile = new JarFile(f);

        ZipEntry zipEntry = jarFile.getJarEntry(emptyEntry1);
        int res = jarFile.getInputStream(zipEntry).read(new byte[100], 0, 100);
        assertEquals("Wrong length of empty jar entry", -1, res);

        zipEntry = jarFile.getJarEntry(emptyEntry2);
        res = jarFile.getInputStream(zipEntry).read(new byte[100], 0, 100);
        assertEquals("Wrong length of empty jar entry", -1, res);

        zipEntry = jarFile.getJarEntry(emptyEntry3);
        res = jarFile.getInputStream(zipEntry).read();
        assertEquals("Wrong length of empty jar entry", -1, res);
    }

    // Regression test for HARMONY-6384
    public void testJarWrittenWithFlush() throws IOException {
        File f = new File(resources, "hyts_flushed.jar");
        Support_Resources.copyFile(resources, null, "hyts_flushed.jar");

        // Used to crash with ZipException: Central Directory Entry not found
        new JarFile(f);
    }
}