Set Up the Security Advisory Application

Last modified by Simon Urli on 2026/11/13 10:24

Steps

Set up the Security Advisory Application so that advisories stay private until they are disclosed, the security team is notified, and the GitHub advisories are imported. You need admin right on the wiki.

  1. Open "Security Advisory Application" from the "Applications" panel. As long as the security entries space is viewable by everyone, its home page shows a warning.

    The Security Advisory Application home page, with the warning saying that the security entry space is open to any users

  2. Click "security entry space" in the warning and set the rights of that space so that only the security team has the view and edit rights on it.
  3. Set the rights of the disclosed entries space, SecurityAdvisoryApplication.DisclosedEntries by default, so that the security team has the edit right on it and every user keeps the view right. Disclosing an advisory requires the edit right on both the advisory and this space, and the application does not grant the view right on it.
  4. Open "Administer Wiki" > "Other" > "Security Advisory" and, in the "Configuration" section:
    • select the security team group in "The group of targeted users for advisories notifications";
    • set the embargo delay in "Duration value to use for the embargo computation" and "Unit of the duration to use for the embargo computation";
    • list the repositories to import in "Github Repositories", as organization/repository (xwiki/xwiki-platform) or as a whole organization (xwiki).

    Security Advisory Configuration describes every field and its default.

    The Configuration section of the Security Advisory administration, with its fields and the Save button

  5. Click "Save".
  6. In the "GitHub Tokens" section, fill in the "Organization" and a GitHub "Token" that can read its repository security advisories, then click "Add GitHub Token". Repeat for each organization listed in "Github Repositories": the import skips the repositories of an organization without a token.

    The GitHub Tokens section of the Security Advisory administration, with the Organization and Token fields and the Add GitHub Token button

  7. The warning is gone from the application home page, and the advisories of the listed repositories appear in its list after the next daily import.

    The Security Advisory Application home page without the warning about the security entry space, above the list of advisories

FAQ

What do I do after upgrading the application?

In "Administer Wiki" > "Other" > "Security Advisory", click "Migrate advisories" in the "Data migration" section if it lists advisories still using the legacy data model, then "Publish disclosed advisories" in the section of that name if it lists disclosed advisories not published yet. Security Advisory Configuration describes both sections.

Related

Get Connected