- Document modern way to work with vulnerability database

- Do some rewording, remove "you" and "your" where possible (special thanks to wblock)

Reviewed by:	mat, wblock
Approved by:	mat, wblock

Differential Revision:	https://reviews.freebsd.org/D941
This commit is contained in:
Alex Kozlov 2014-10-16 12:30:42 +00:00
parent 55926f60e6
commit ca0e6e196d
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=45838

View file

@ -114,16 +114,14 @@
also monitor it for issues requiring their also monitor it for issues requiring their
intervention.</para> intervention.</para>
<!-- XXX: Too much "you" in there --> <para>Committers can update the <acronym>VuXML</acronym>
<para>If you have committer rights you can update the VuXML database themselves, assisting the Security Officer Team
database by yourself. So you will both help the Security and delivering crucial information to the community more
Officer Team and deliver the crucial information to the quickly. Those who are not committers or have discovered
community earlier. However, if you are not a committer, or an exceptionally severe vulnerability should not hesitate
you believe you have found an exceptionally severe to contact the Security Officer Team directly, as described
vulnerability please do not hesitate to contact the Security on the <link xlink:href="http://www.freebsd.org/security/#how">
Officer Team directly as described on the &os; Security Information</link> page.</para>
<link xlink:href="http://www.freebsd.org/security/#how">&os;
Security Information</link> page.</para>
<para>The VuXML database is an <acronym>XML</acronym> document. <para>The VuXML database is an <acronym>XML</acronym> document.
Its source file <filename>vuln.xml</filename> is kept right Its source file <filename>vuln.xml</filename> is kept right
@ -412,38 +410,19 @@
<title>Testing Changes to the VuXML Database</title> <title>Testing Changes to the VuXML Database</title>
<para>This example describes a new entry for a <para>This example describes a new entry for a
vulnerability in the package <literal>clamav</literal> that vulnerability in the package <literal>dropbear</literal> that
has been fixed in version <literal>0.65_7</literal>.</para> has been fixed in version <literal>dropbear-2013.59</literal>.</para>
<para>As a prerequisite, <para>As a prerequisite,
<emphasis>install</emphasis> fresh versions of the ports install a fresh version of
<package role="port">ports-mgmt/portaudit</package>, <package role="port">security/vuxml</package> port.</para>
<package role="port">ports-mgmt/portaudit-db</package>, and
<package role="port">security/vuxml</package>.</para>
<note>
<para>The user running <command>packaudit</command> must have
permission to write to its <filename>DATABASEDIR</filename>,
typically <filename>/var/db/portaudit</filename>.</para>
<para>To use a different directory, set the
<varname>DATABASEDIR</varname> environment variable to a
different location.</para>
<para>If working in a directory other than
<filename>${PORTSDIR}/security/vuxml</filename>, set the
<varname>VUXMLDIR</varname> environment variable to the
directory where <filename>vuln.xml</filename> is
located.</para>
</note>
<para>First, check whether there already is an entry for this <para>First, check whether there already is an entry for this
vulnerability. If there were such an entry, it would match vulnerability. If there were such an entry, it would match
the previous version of the package, the previous version of the package,
<literal>0.65_6</literal>:</para> <literal>2013.58</literal>:</para>
<screen>&prompt.user; <userinput>packaudit</userinput> <screen>&prompt.user; <userinput>pkg audit dropbear-2013.58</userinput></screen>
&prompt.user; <userinput>portaudit clamav-0.65_6</userinput></screen>
<para>If there is none found, add a <para>If there is none found, add a
new entry for this vulnerability.</para> new entry for this vulnerability.</para>
@ -461,21 +440,10 @@
<package role="port">textproc/jade</package>.</para> <package role="port">textproc/jade</package>.</para>
</note> </note>
<para>Now rebuild the <command>portaudit</command> database from <para>Verify that the <literal>&lt;affected&gt;</literal>
the VuXML file:</para> section of the entry will match the correct packages:</para>
<screen>&prompt.user; <userinput>packaudit</userinput></screen> <screen>&prompt.user; <userinput>pkg audit -f ${PORTSDIR}/security/vuxml/vuln.xml dropbear-2013.58</userinput></screen>
<para>To verify that the <literal>&lt;affected&gt;</literal>
section of the entry will match the correct package(s), issue this
command:</para>
<screen>&prompt.user; <userinput>portaudit -f /usr/ports/INDEX -r <replaceable>uuid</replaceable></userinput></screen>
<note>
<para>Please refer to &man.portaudit.1; for better
understanding of the command syntax.</para>
</note>
<para>Make sure that the entry produces no spurious matches in <para>Make sure that the entry produces no spurious matches in
the output.</para> the output.</para>
@ -483,22 +451,18 @@
<para>Now check whether the right package versions are matched <para>Now check whether the right package versions are matched
by the entry:</para> by the entry:</para>
<screen>&prompt.user; <userinput>portaudit clamav-0.65_6 clamav-0.65_7</userinput> <screen>&prompt.user; <userinput>pkg audit -f ${PORTSDIR}/security/vuxml/vuln.xml dropbear-201
Affected package: clamav-0.65_6 (matched by clamav&lt;0.65_7) 3.58 dropbear-2013.59</userinput>
Type of problem: clamav remote denial-of-service. dropbear-2012.58 is vulnerable:
Reference: &lt;http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-0020ed76ef5a.html&gt; dropbear -- exposure of sensitive information, DoS
CVE: CVE-2013-4434
CVE: CVE-2013-4421
WWW: http://portaudit.FreeBSD.org/8c9b48d1-3715-11e3-a624-00262d8b701d.html
1 problem(s) found.</screen> 1 problem(s) in the installed packages found.</screen>
<para>The former version matches while the latter one <para>The former version matches while the latter one
does not.</para> does not.</para>
<para>Finally, verify whether the web page generated from the
VuXML database looks like expected:</para>
<screen>&prompt.user; <userinput>mkdir -p ~/public_html/portaudit</userinput>
&prompt.user; <userinput>packaudit</userinput>
&prompt.user; <userinput>lynx ~/public_html/portaudit/74a9541d-5d6c-11d8-80e3-0020ed76ef5a.html</userinput></screen>
</sect2> </sect2>
</sect1> </sect1>
</chapter> </chapter>