xmlgraphics-batik-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vha...@apache.org
Subject cvs commit: xml-batik/test-sources/org/apache/batik/test/svg SVGOnLoadExceptionTest.java
Date Fri, 14 Jun 2002 13:21:26 GMT
vhardy      2002/06/14 06:21:26

  Added:       test-sources/org/apache/batik/test/svg
                        SVGOnLoadExceptionTest.java
  Log:
  Additional security features:
  
  - Strict control over ECMAScript. It is now possible to completely
    disable ECMAScript. Previously, it was only possible to disable
    linked ECMAScripts
  
  - Additional strategy for controlling script and external resource
    origin. It is now possible to constrain scripts or external 
    resources to be 'embeded' in the document. For scripts, that 
    means scripts in attribute, <script> element content or a 
    data url on the <script> element href attribute. For external
    resources, this means that only the data protocol is allowed.
  
  - Improved security settings in the PreferenceDialog.
  
  - Additional tests checking that security exceptions are thrown
    for embeded scripts or image href when this is disallowed by
    security settings.
  
  Test Infrastructure:
  
  - New generic test: SVGOnLoadExceptionTest. This is used by the 
    new tests, but these is a generic test which could be used for
    testing error processing.
  
  
  
  Revision  Changes    Path
  1.1                  xml-batik/test-sources/org/apache/batik/test/svg/SVGOnLoadExceptionTest.java
  
  Index: SVGOnLoadExceptionTest.java
  ===================================================================
  /*****************************************************************************
   * Copyright (C) The Apache Software Foundation. All rights reserved.        *
   * ------------------------------------------------------------------------- *
   * This software is published under the terms of the Apache Software License *
   * version 1.1, a copy of which has been included with this distribution in  *
   * the LICENSE file.                                                         *
   *****************************************************************************/
  
  package org.apache.batik.test.svg;
  
  import java.io.File;
  import java.io.IOException;
  
  import java.net.URL;
  import java.net.MalformedURLException;
  
  import org.apache.batik.bridge.BaseScriptingEnvironment;
  import org.apache.batik.bridge.BridgeContext;
  import org.apache.batik.bridge.BridgeException;
  
  import org.apache.batik.bridge.GVTBuilder;
  import org.apache.batik.bridge.UserAgent;
  import org.apache.batik.bridge.UserAgentAdapter;
  import org.apache.batik.bridge.ExternalResourceSecurity;
  import org.apache.batik.bridge.ScriptSecurity;
  import org.apache.batik.bridge.NoLoadExternalResourceSecurity;
  import org.apache.batik.bridge.EmbededExternalResourceSecurity;
  import org.apache.batik.bridge.DefaultExternalResourceSecurity;
  import org.apache.batik.bridge.RelaxedExternalResourceSecurity;
  import org.apache.batik.bridge.NoLoadScriptSecurity;
  import org.apache.batik.bridge.EmbededScriptSecurity;
  import org.apache.batik.bridge.DefaultScriptSecurity;
  import org.apache.batik.bridge.RelaxedScriptSecurity;
  import org.apache.batik.test.AbstractTest;
  import org.apache.batik.test.DefaultTestReport;
  import org.apache.batik.test.TestReport;
  
  import org.apache.batik.util.XMLResourceDescriptor;
  import org.apache.batik.util.ParsedURL;
  
  import org.apache.batik.dom.svg.SAXSVGDocumentFactory;
  
  import org.w3c.dom.Attr;
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  import org.w3c.dom.Node;
  import org.w3c.dom.NodeList;
  import org.w3c.dom.NamedNodeMap;
  
  /**
   * This test takes an SVG file as an input. It processes the input SVG
   * (meaning it turns it into a GVT tree) and then dispatches the 'onload'
   * event.
   * 
   * In that process, the test checks for the occurence of a specific
   * exception type and, for BridgeExceptions, for a given error code.
   *
   * If an exception of the given type (and, optionally, code) happens,
   * then the test passes. If an exception of an unexpected type 
   * (or code, for BridgeExceptions) happens, or if no exception happens,
   * the test fails.
   *
   * The following properties control the test's operation:
   * - Scripts: list of allowed script types (e.g., "application/java-archive")
   * - ScriptOrigin: "ANY", "DOCUMENT", "EMBEDED", "NONE"
   * - ResourceOrigin: "ANY", "DOCUMENT", "EMBEDED", "NONE"
   * - ExpectedExceptionClass (e.g., "java.lang.SecurityException")
   * - ExpectedErrorCode (e.g., "err.uri.unsecure")
   *
   * @author <a href="mailto:vhardy@apache.org">Vincent Hardy</a>
   * @version $Id: SVGOnLoadExceptionTest.java,v 1.1 2002/06/14 13:21:25 vhardy Exp $
   */
  public class SVGOnLoadExceptionTest extends AbstractTest {
      /**
       * Error when the expected exception did not occur
       */
      public static final String ERROR_EXCEPTION_DID_NOT_OCCUR
          = "SVGOnLoadExceptionTest.error.exception.did.not.occur";
  
      /**
       * Error when an exception occured, but not of the expected
       * class
       */
      public static final String ERROR_UNEXPECTED_EXCEPTION
          = "SVGOnLoadExceptionTest.error.unexpected.exception";
  
      /**
       * Error when a BridgeException occured, as expected, but
       * with an unexpected error code
       */
      public static final String ERROR_UNEXPECTED_ERROR_CODE
          = "SVGOnLoadExceptionTest.error.unexpected.error.code";
  
      /**
       * Entry describing the unexpected exception
       */
      public static final String ENTRY_KEY_UNEXPECTED_EXCEPTION
          = "SVGOnLoadExceptionTest.entry.key.unexpected.exception";
  
      /**
       * Entry describing the unexpected error code
       */
      public static final String ENTRY_KEY_UNEXPECTED_ERROR_CODE
          = "SVGOnLoadExceptionTest.entry.key.unexpected.error.code";
  
      /**
       * Entry describign the expected error code
       */
      public static final String ENTRY_KEY_EXPECTED_ERROR_CODE
          = "SVGOnLoadExceptionTest.entry.key.expected.error.code";
  
      /**
       * Entry describing the expected exception
       */
      public static final String ENTRY_KEY_EXPECTED_EXCEPTION
          = "SVGOnLoadExceptionTest.entry.key.expected.exception";
  
      /**
       * Value used to disable error code check on BridgeExceptions
       */
      public static final String ERROR_CODE_NO_CHECK
          = "noCheck";
  
      /**
       * Test Namespace
       */
      public static final String testNS = "http://xml.apache.org/batik/test";
  
      /**
       * The URL for the input SVG document to be tested
       */
      protected String svgURL;
  
      /**
       * The allowed script types
       */
      protected String scripts = "text/ecmascript, application/java-archive";
      
      /**
       * Name of the expected exception class
       */
      protected String expectedExceptionClass = "org.apache.batik.bridge.Exception";
  
      /**
       * Expected error code (for BridgeExceptions)
       */
      protected String expectedErrorCode = "none";
  
      /**
       * The allowed script origin
       */
      protected String scriptOrigin = "ANY";
  
      /**
       * The allowed external resource origin
       */
      protected String resourceOrigin = "ANY";
  
      public void setScripts(String scripts){
          this.scripts = scripts;
      }
  
      public String getScripts(){
          return scripts;
      }
  
      public void setScriptOrigin(String scriptOrigin){
          this.scriptOrigin = scriptOrigin;
      }
  
      public String getScriptOrigin(){
          return this.scriptOrigin;
      }
  
      public void setResourceOrigin(String resourceOrigin){
          this.resourceOrigin = resourceOrigin;
      }
  
      public String getResourceOrigin(){
          return this.resourceOrigin;
      }
  
      public void setExpectedExceptionClass(String expectedExceptionClass){
          this.expectedExceptionClass = expectedExceptionClass;
      }
  
      public String getExpectedExceptionClass(){
          return this.expectedExceptionClass;
      }
  
      public void setExpectedErrorCode(String expectedErrorCode){
          this.expectedErrorCode = expectedErrorCode;
      }
  
      public String getExpectedErrorCode(){
          return this.expectedErrorCode;
      }
      
      /**
       * Default constructor
       */
      public SVGOnLoadExceptionTest(){
      }
  
      public void setId(String id){
          super.setId(id);
          svgURL = resolveURL("test-resources/org/apache/batik/" + id + ".svg");
      }
  
      /**
       * Resolves the input string as follows.
       * + First, the string is interpreted as a file description.
       *   If the file exists, then the file name is turned into
       *   a URL.
       * + Otherwise, the string is supposed to be a URL. If it
       *   is an invalid URL, an IllegalArgumentException is thrown.
       */
      protected String resolveURL(String url){
          // Is url a file?
          File f = (new File(url)).getAbsoluteFile();
          if(f.getParentFile().exists()){
              try{
                  return f.toURL().toString();
              }catch(MalformedURLException e){
                  throw new IllegalArgumentException();
              }
          }
          
          // url is not a file. It must be a regular URL...
          try{
              return (new URL(url)).toString();
          }catch(MalformedURLException e){
              throw new IllegalArgumentException(url);
          }
      }
  
  
      /**
       * Run this test and produce a report.
       * The test goes through the following steps: <ul>
       * <li>load the input SVG into a Document</li>
       * <li>build the GVT tree corresponding to the 
       *     Document and dispatch the 'onload' event</li>
       * </ul>
       *
       */
      public TestReport runImpl() throws Exception{
          //
          // First step: 
          //
          // Load the input SVG into a Document object
          //
          String parserClassName = XMLResourceDescriptor.getXMLParserClassName();
          SAXSVGDocumentFactory f = new SAXSVGDocumentFactory(parserClassName);
          Document doc = null;
  
          try {
              doc = f.createDocument(svgURL);
          } catch(Exception e){
              return handleException(e);
          } 
  
          //
          // Second step:
          // 
          // Now that the SVG file has been loaded, build
          // a GVT Tree from it
          //
          UserAgent userAgent = buildUserAgent();
          GVTBuilder builder = new GVTBuilder();
          BridgeContext ctx = new BridgeContext(userAgent);
          ctx.setDynamic(true);
  
          try {
              builder.build(ctx, doc);
              BaseScriptingEnvironment scriptEnvironment 
                  = new BaseScriptingEnvironment(ctx);
              scriptEnvironment.loadScripts();
              scriptEnvironment.dispatchSVGLoadEvent();
          } catch (Exception e){
              return handleException(e);
          } 
  
          //
          // If we got here, it means that the expected exception did not
          // happen. Report an error
          //
          TestReport report = reportError(ERROR_EXCEPTION_DID_NOT_OCCUR);
          report.addDescriptionEntry(ENTRY_KEY_EXPECTED_EXCEPTION,
                                     expectedExceptionClass);
          return report;
      }
  
      /** 
       * Compares the input exception with the expected exception
       * If they match, then the test passes. Otherwise, the test fails
       */
      protected TestReport handleException(Exception e) {
          if (!e.getClass().getName().equals(expectedExceptionClass)) {
              TestReport report = reportError(ERROR_UNEXPECTED_EXCEPTION);
              report.addDescriptionEntry(ENTRY_KEY_UNEXPECTED_EXCEPTION,
                                         e.getClass().getName());
              report.addDescriptionEntry(ENTRY_KEY_EXPECTED_EXCEPTION,
                                         expectedExceptionClass);
              return report;
          } else {
              if (!ERROR_CODE_NO_CHECK.equals(expectedErrorCode)
                  && e instanceof BridgeException) {
                  if ( !expectedErrorCode.equals(((BridgeException)e).getCode()) ) {
                      TestReport report = reportError(ERROR_UNEXPECTED_ERROR_CODE);
                      report.addDescriptionEntry(ENTRY_KEY_UNEXPECTED_ERROR_CODE,
                                                 ((BridgeException)e).getCode());
                      report.addDescriptionEntry(ENTRY_KEY_EXPECTED_ERROR_CODE,
                                                 expectedErrorCode);
                      return report;
                  }
              }
              return reportSuccess();
          }
      }
  
      /**
       * Give subclasses a chance to build their own UserAgent
       */
      protected UserAgent buildUserAgent(){
          return new TestUserAgent();
      }
  
      class TestUserAgent extends UserAgentAdapter {
          public ExternalResourceSecurity 
              getExternalResourceSecurity(ParsedURL resourceURL,
                                          ParsedURL docURL) {
              if ("ANY".equals(resourceOrigin)) {
                  return new RelaxedExternalResourceSecurity(resourceURL,
                                                             docURL);
              } else if ("DOCUMENT".equals(resourceOrigin)) {
                  return new DefaultExternalResourceSecurity(resourceURL,
                                                             docURL);
              } else if ("EMBEDED".equals(resourceOrigin)) {
                  return new EmbededExternalResourceSecurity(resourceURL);
              } else {
                  return new NoLoadExternalResourceSecurity();
              }
          }
  
          public ScriptSecurity
              getScriptSecurity(String scriptType,
                                ParsedURL scriptURL,
                                ParsedURL docURL) {
              if (scripts.indexOf(scriptType) == -1) {
                  return new NoLoadScriptSecurity(scriptType);
              } else {
                  if ("ANY".equals(scriptOrigin)) {
                      return new RelaxedScriptSecurity(scriptType,
                                                       scriptURL,
                                                       docURL);
                  } else if ("DOCUMENT".equals(resourceOrigin)) {
                      return new DefaultScriptSecurity(scriptType,
                                                       scriptURL,
                                                       docURL);
                  } else if ("EMBEDED".equals(resourceOrigin)) {
                      return new EmbededScriptSecurity(scriptType,
                                                       scriptURL,
                                                       docURL);
                  } else {
                      return new NoLoadScriptSecurity(scriptType);
                  }
              }
          }
      }
  
  }
  
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: batik-dev-help@xml.apache.org


Mime
View raw message