doc/website/static/security/advisory-template.txt

=============================================================================
FreeBSD-SA-ADVISORY_TEMPLATE                                Security Advisory
                                                          The FreeBSD Project

Topic:

Category:       < core | contrib >
Module:         <module name>
Announced:      2021-XX-XX
Credits:
Affects:        <affected versions>
                <e.g., "All supported versions of FreeBSD.", "FreeBSD
                12.2 and later.", "FreeBSD 12.x", or "FreeBSD 11.4">
Corrected:      2021-XX-XX XX:XX:XX UTC (stable/12, 12.2-STABLE)
                2021-XX-XX XX:XX:XX UTC (releng/12.2, 12.2-RELEASE-pXX)
                2021-XX-XX XX:XX:XX UTC (stable/11, 11.4-STABLE)
                2021-XX-XX XX:XX:XX UTC (releng/11.4, 11.4-RELEASE-pXX)
CVE Name:       CVE-XXXX-XXXX

For general information regarding FreeBSD Security Advisories,
including descriptions of the fields above, security branches, and the
following sections, please visit <URL:https://security.FreeBSD.org/>.

I.   Background

<brief description of what the affected bits are supposed to do>

II.  Problem Description

<detailed description of the problem>

III. Impact

<description as to why the above problem is bad>

IV.  Workaround

<If no workaround exists:>
No workaround is available.

<... but some systems are unaffected:>
No workaround is available.  <insert simple description of some
systems that are not vulnerable>

<If a workaround exists:>
<insert workaround here>

V.   Solution

<insert solution here>

Upgrade your vulnerable system to a supported FreeBSD stable or
release / security branch (releng) dated after the correction date.
[XX Needs reboot? Mention please]

Perform one of the following:

1) To update your vulnerable system via a binary patch:

Systems running a RELEASE version of FreeBSD on the i386 or amd64
platforms can be updated via the freebsd-update(8) utility:

# freebsd-update fetch
# freebsd-update install
# shutdown -r +10min "Rebooting for a security update" <XX if required>

2) To update your vulnerable system via a source code patch:

The following patches have been verified to apply to the applicable
FreeBSD release branches.

a) Download the relevant patch from the location below, and verify the
detached PGP signature using your PGP utility.

[FreeBSD 11.4]
# fetch https://security.FreeBSD.org/patches/SA-XX:XX/XXXX.patch
# fetch https://security.FreeBSD.org/patches/SA-XX:XX/XXXX.patch.asc
# gpg --verify XXXX.patch.asc

b) Apply the patch.  Execute the following commands as root:

# cd /usr/src
# patch < /path/to/patch

<for a userland utility:>

c) Recompile the operating system using buildworld and installworld as
described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.

<for a daemons>

c) Recompile the operating system using buildworld and installworld as
described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.

Restart the applicable daemons, or reboot the system.

<for a common library>

c) Recompile the operating system using buildworld and installworld as
described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.

Restart all daemons that use the library, or reboot the system.

<for a kernel vulnerability:>

c) Recompile your kernel as described in
<URL:https://www.FreeBSD.org/handbook/kernelconfig.html> and reboot the
system.

VI.  Correction details

The following list contains the correction revision numbers for each
affected branch.

Branch/path                                                      Revision
-------------------------------------------------------------------------
stable/12/                                                        rXXXXXX
releng/12.2/                                                      rXXXXXX
stable/11/                                                        rXXXXXX
releng/11.4/                                                      rXXXXXX
-------------------------------------------------------------------------

To see which files were modified by a particular revision, run the
following command, replacing NNNNNN with the revision number, on a
machine with Subversion installed:

# svn diff -cNNNNNN --summarize svn://svn.freebsd.org/base

Or visit the following URL, replacing NNNNNN with the revision number:

<URL:https://svnweb.freebsd.org/base?view=revision&revision=NNNNNN>

VII. References

<other info on vulnerability>

<URL:https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-XXXX-XXXX>

The latest revision of this advisory is available at
<URL:https://security.FreeBSD.org/advisories/FreeBSD-SA-XX:XX.XXXXX.asc>