Uploaded image for project: 'Log4j 2'
  1. Log4j 2
  2. LOG4J2-2001

StyleConverter.newInstance argument validation is incorrect

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • 2.8.2
    • 2.9.0
    • Configurators
    • None

    Description

      There are three bugs in the argument handling of StyleConverter.newInstance.
      Firstly the javadoc says options may be null. It must not be.
      Secondly the method doesn't validate that it is not null.
      Thirdly it validates that options.length <1 when the subsequent code requires options.length >=2

          /**
           * Gets an instance of the class.
           *
           * @param config
           *            The current Configuration.
           * @param options
           *            pattern options, may be null. If first element is "short", only the first line of the throwable will
           *            be formatted.
           * @return instance of class.
           */
          public static StyleConverter newInstance(final Configuration config, final String[] options) {
              if (options.length < 1) {
                  LOGGER.error("Incorrect number of options on style. Expected at least 1, received " + options.length);
                  return null;
              }
              if (options[0] == null) {
                  LOGGER.error("No pattern supplied on style");
                  return null;
              }
              if (options[1] == null) {
                  LOGGER.error("No style attributes provided");
                  return null;
              }
      

      Attachments

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            ggregory Gary D. Gregory
            pburrowesOC Paul Burrowes
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment