DSC/grapher/text.pm

# Copyright (c) 2016-2017, OARC, Inc.
# Copyright (c) 2007, The Measurement Factory, Inc.
# Copyright (c) 2007, Internet Systems Consortium, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in
#    the documentation and/or other materials provided with the
#    distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
#    contributors may be used to endorse or promote products derived
#    from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

package DSC::grapher::text;

BEGIN {
        use Exporter   ();
        use vars       qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
        $VERSION     = '2.04';
        @ISA         = qw(Exporter);
        @EXPORT      = qw(
                %TEXTS
        );
        %EXPORT_TAGS = ( );
        @EXPORT_OK   = qw();
}
use vars      @EXPORT;
use vars      @EXPORT_OK;

END { }

use strict;
use warnings;

%TEXTS = (

  bynode => {
    description => '<p>The <strong>Queries by Node</strong> plot shows the
		amount of queries coming from each node in the server
		cluster.  If you would like to see the traffic for
		a single node, select the node name in the Servers/Nodes
		menu on the left.</p>
		<p>Note that the <em>By Node</em> option disappears from the
		Plots list when you are viewing the data for a single node.
		It reappears if you click on the Server name in the
		Servers/Nodes menu.</p>',
  },

  qtype => {
    description => '<p>The <strong>Queries by Qtype</strong> plot shows
	the breakdown of queries by DNS query type:</p>
	<ul>
	<li>A - Queries for the IPv4 address of a name.  Usually
	the most popular query type.
	<li>NS - Queries for the authoritative nameservers for
	a particular zone.  These are usually rare because end
	users (and their software agents) do not normally send
	NS queries.  NS records are normally included in the
	authority section of every DNS message.
	</ul>
        <p>Click on the legend to view the queries for a specific type.</p>',
  },

  dnssec_qtype => {
    description => '<p>The <strong>DNSSEC Query Types</strong> plot shows
	queries recieved for certain DNSSEC-related query types (shown
	in the legend).  The first-generation DNSSEC types
	(SIG, KEY, NXT) have been obsoleted by newer, second-generation
	types (DS, RRSIG, NSEC, DNSKEY).
        <p>Click on the legend to view the queries for a specific type.</p>',
  },

  rcode => {
    description => '<p>The <strong>Replies by Rcode</strong> plot shows
	the breakdown of RCODE values in DNS responses:</p>
	<ul>
	<li>NOERROR - No error condition.
	<li>SERVFAIL - The name server was unable to process the
	query due to a problem with the name server.
	<li>NXDOMAIN - The domain name referenced in the query does
	not exist.
	<li>REFUSED - The server refuses to perform the specified
	operation for policy reasons.
	<li>NXRRSET - Some RRset that ought to exist, does not exist (used
	in dynamic updates).
	<li>Other - All other response codes, including: FORMERR, NOTIMP, YXDOMAIN, YXRRSET, NOTAUTH, NOTZONE.
	</ul>
        <p>Click on the legend to view the queries for a specific RCODE.</p>',
  },

  opcode => {
    description => '<p>The <strong>Messages by Opcode</strong> plot shows
	the breakdown of OPCODE values, other than QUERY, in DNS queries.
	Since QUERY is the most common opcode, its inclusion here would
	dominate the plot.  Some of the less common opcodes are:</p>
	<ul>
	<li>IQUERY - An "inverse query" which has been deprecated
	in favor of the PTR query type.
	<li>STATUS - A server status request.
	<li>NOTIFY - Allows master servers to inform slave servers when a zone has changed.
	<li>UPDATE - Add or delete RRs or RRsets from a zone.
	<li>Other - All other opcode values, legitimate or not.
	</ul>
        <p>Click on the legend to view the queries for a specific opcode.</p>',
  },

  certain_qnames_vs_qtype => {
    description => '<p>This plot shows
	queries of type A, AAAA, or A6 for the name <strong>localhost</strong>
	and anything under <strong>root-servers.net</strong>.  We chose these
	names because, historically, the DNS root servers see a significant
	number of queries for them.  These plots may be uninteresting on
	normal nameservers.</p>
	<p>Click on the legend to view the queries for a specific type/name
	pair</p>',

  },

  client_subnet_accum => {
    description => '<p>The <strong>Busiest Client Subnet</strong> plot shows
	the number of queries sent from each /24 network.  The horizontal
	bars are colored based on the RIR where the address space is
	registered, followed by a two-letter country code.</p>',
  },

  client_subnet2_accum => {
    description => '<p>The <strong>Query Classifications by Subnets</strong> plot shows
	a kind of "quality report" for each /24 subnet.   Queries are classified
	according to a number of known misbehaviors, shown in the legend:
	<ul>
	<li>Malformed - The DNS message was malformed and could not be entirely parsed
	<li>Src port 0 - The UDP query came from source port 0
	<li>Funny Qtype - Query type was not one of the documented types
	<li>Funny Qclass - Query class was not IN
	<li>RFC1918PTR - The query type was PTR and the name was in an in-addr.arpa zone covered by RFC1918 private address space
	<li>A-for-. - The query name was empty (equal to the root zone)
	<li>A-for-A - The query name was already an IPv4 address
	<li>localhost - The query was for localhost
	<li>root-servers.net - The query was for a root-servers.net name
	<li>Non-Authoritative TLD - The query was for a known-invalid TLD
	<li>Unclassified - the query did not fall into one of the other categories.
	</ul>
        <p>Click on the legend to view the queries for a specific type.</p>',
  },

  client_subnet2_trace => {
    description => '<p>This plot shows the same classification data, but
	as a time series instead of per-subnet.</p>
        <p>Click on the legend to view the queries for a specific type.</p>',
  },

  client_subnet2_count => {
    description => '<p>This plot shows the same classification data, but
	here we see the number of subnets sending each class of misbehavior
	over time.</p>
        <p>Click on the legend to view the queries for a specific type.</p>',
  },

  qtype_vs_all_tld => {
    description => '<p>The <strong>Most Popular TLDs Queried</strong> plot shows
	the types of queries for each TLD.</p>
	<p>Click on one of the plot subtypes in the left-side menu to see
	a subset of TLDs.</p>
        <p>Click on the legend to view the queries for a specific type.</p>',

  },

  qtype_vs_invalid_tld => {
    description => '<p>The <strong>Most Popular TLDs Queried</strong> plot shows
	the types of queries for each TLD.  Here we show only
	<em>invalid</em> TLDs.  If you see TLDs listed here that
	should be considered valid, then you need to set the
	<em>domain_list</em> and </em>valid_domains</em> directives
	in the dsc-grapher.cfg file.</p>',
  },

  qtype_vs_valid_tld => {
    description => '<p>The <strong>Most Popular TLDs Queried</strong> plot shows
	the types of queries for each TLD.  Here we show only
	<em>valid</em> TLDs.  If this plot is empty, then you need to set the
	<em>domain_list</em> and </em>valid_domains</em> directives
	in the dsc-grapher.cfg file.</p>',
  },

  qtype_vs_numeric_tld => {
    description => '<p>The <strong>Most Popular TLDs Queried</strong> plot shows
	the types of queries for each TLD.  Here we show only
	"TLDs" that are numeric.  Queries to TLDs are closely related to
	A-for-A queries in the Classification plots.</p>',
  },

  direction_vs_ipproto => {
    description => '',
  },

  direction_vs_ipproto_sent => {
    description => '',
  },

  query_attrs => {
    description => '',
  },

  reply_attrs => {
    description => '',
  },

  idn_qname => {
    description => '',
  },

  rd_bit => {
    description => '',
  },

  tc_bit => {
    description => '',
  },

  do_bit => {
    description => '',
  },

  edns_version => {
    description => '',
  },

  qtype_vs_qnamelen => {
    description => '',
  },

 rcode_vs_replylen => {
    description => '',
  },

  client_addr_vs_rcode_accum => {
    description => '',
  },

  ipv6_rsn_abusers_accum => {
    description => '',
  },

  chaos_types_and_names => {
    description => '',
  },

);

1;