Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-54361

Plugin name doesn't match UI, docs stale

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      The Jenkins UI and docs refer to the "Safe HTML" markup formatter. But there is really no such thing.

      It is implemented by the "OWASP Markup Formatter Plugin" (which links to "plugins.jenkins.io/antisamy-markup-formatter").

      The "jenkinsci/antisamy-markup-formatter project has a 1.5 tag", and appears to be what Jenkins bundles.

      The plugin site mentions that policies are configurable, but there's no UI to configure policies. The "file with the extension in it, confusingly named RawHtmlMarkupFormatter" appears to have had any pluggability cut out, but the comment still reflects the old support:

      {{ // Use the policy defined above to sanitize the HTML.}}
      {{ HtmlSanitizer.sanitize(markup, MyspacePolicy.POLICY_DEFINITION.apply(renderer));}}

      so in practice it looks like you can only use the copy of the MyspacePolicy embedded in the plugin code.

      Hopefully this helps the next person who is utterly confused by this, when trying to figure out how to configure the "Safe HTML" formatter policy, allow additional tags in the "Safe HTML" markup formatter in Jenkins, etc.

        Attachments

          Activity

          Hide
          ringerc Craig Ringer added a comment -

          I updated the wiki page.

          I don't have the access to update the plugins page, or the github repository's descriptive text. Both should really be changed to mention the three names it gets referred to, and the fact it's not configurable (anymore?).

          Show
          ringerc Craig Ringer added a comment - I updated the wiki page. I don't have the access to update the plugins page, or the github repository's descriptive text. Both should really be changed to mention the three names it gets referred to, and the fact it's not configurable (anymore?).
          Hide
          ringerc Craig Ringer added a comment -
          Show
          ringerc Craig Ringer added a comment - Created pull for the github repo :  https://github.com/jenkinsci/antisamy-markup-formatter-plugin/pull/8
          Hide
          danielbeck Daniel Beck added a comment -

          Seems obsolete now, and https://github.com/jenkinsci/antisamy-markup-formatter-plugin/pull/19 should address it even further.

          Show
          danielbeck Daniel Beck added a comment - Seems obsolete now, and https://github.com/jenkinsci/antisamy-markup-formatter-plugin/pull/19 should address it even further.

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            ringerc Craig Ringer
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: