dane.1.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='dane'>
<refentryinfo><date>April 12, 2011</date></refentryinfo>
<refmeta>
<refentrytitle>dane</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>April 12, 2011</refmiscinfo>
<refmiscinfo class='source'>Paul Wouters</refmiscinfo>
<refmiscinfo class='manual'>Internet / DNS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>dane</refname>
<refpurpose>Generate TLSA/HASTLS DNS records by scanning SSL/TLS sites</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>
<para>dane [<option>-v</option>] [<option>-q</option>] [<option>-h</option>] [<option>-v</option>] 
           [<option>--draft</option>|<option>--rfc</option>] [<option>--sha256</option>] [<option>--sha512</option>]
           [<option>--full</option>] [<option>--insecure</option>] [<option>--pubkey</option>] [<option>--txt</option>]
           [<option>--eecert</option>] [<option>--cacert</option>] [<option>-4</option>] [<option>-6</option>]
           [<option>--axfr</option>] [<option>-n</option> &lt;<emphasis remap='I'>nameserver</emphasis>&gt;]
           <emphasis remap='I'>host1</emphasis> [<emphasis remap='I'>host2 ...]</emphasis>] 
           [<emphasis remap='I'>@nameserver]</emphasis>]

<!-- .br -->
</para>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>dane generates TLSA/HASTLS records based on the IETF DANE working group proposal.
These are currently in draft, so private RRTYPE assignments are used. Records are generated
by connecting to the website using SSL and grabbing its (EE) certificate. 
If the nameserver of the domain allows zone tranfers (AXFR), an entire domain can be processed for all its A/AAAA records.</para>
</refsect1>

<refsect1 id='options'><title>OPTIONS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><option>-n / --nameserver</option> &lt;<emphasis remap='I'>hostname1</emphasis>&gt;</term>
  <listitem>
<para>Use specified nameserver for AXFR query</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-q / --quiet</option></term>
  <listitem>
<para>Supress all warnings - useful when scanning lots of host where some do not run SSL</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--axfr</option></term>
  <listitem>
<para>Use AXFR. Implies -n nameserver (or @nameserver). Hosts are treated as zones to AXFR.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--tlsa</option></term>
  <listitem>
<para>Output TLSA record from SSL server scan results (default)</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--eecert</option></term>
  <listitem>
<para>Output TLSA record format EE certificates (type 1)  (default)</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--pubkey</option></term>
  <listitem>
<para>Output TLSA record for just the public key (type unassined) (not implemented yet)</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--txt</option></term>
  <listitem>
<para>Output Kaminsky style TXT record for (not implemented yet)</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--cacert</option></term>
  <listitem>
<para>Output TLSA record for the entire CA chain and EE-cert (not yet implemented)</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--sha256</option></term>
  <listitem>
<para>Output TLSA record reference type 1 (SHA256) records (default)</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--sha512</option></term>
  <listitem>
<para>Output TLSA record reference type 2 (SHA512) records</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--full</option></term>
  <listitem>
<para>Output TLSA record reference type 0 (full cert) records</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--draft</option></term>
  <listitem>
<para>Output Unknown Resource Record format with private RRTYPE assignment. This is used while the standard is
      still in draft form, and for when your nameserver does not (yet) support the new RRTYPE names. This option
      is the default (if --rfc is not specified) as long as dane is has not be released as RFC.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--rfc</option></term>
  <listitem>
<para>Specify records using the RRTYPE's TLSA (and HASTLA) </para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>--insecure</option></term>
  <listitem>
<para>Continue scanning even if the A/AAAA records could not be validated using DNSSEC</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-4</option></term>
  <listitem>
<para>Only use ipv4 networking - do not attempt to connect to AAAA SSL sites</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-6</option></term>
  <listitem>
<para>Only use ipv6 networking - do not attempt to connect to A SSL sites</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-h / --help</option></term>
  <listitem>
<para>Output help information and exit.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-v / --version</option></term>
  <listitem>
<para>Output version information and exit.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='files'><title>FILES</title>
<para><filename>~/.ssh/known_hosts</filename></para> 
</refsect1>

<refsect1 id='requirements'><title>REQUIREMENTS</title>
<para>dane requires python-dns and python-argparse(<ulink url='http://www.pythondns.org'>http://www.pythondns.org</ulink>)</para>

<para>Fedora: yum install python-dns python-argparse</para>

<para>Debian: apt-get install python-dnspython python-argparse</para>
</refsect1>

<refsect1 id='bugs'><title>BUGS</title>
<para>I'm sure there are</para>

</refsect1>

<refsect1 id='examples'><title>EXAMPLES</title>
<para>typical usage:</para>

<para>dane www.xelerance.com</para>

<para>dane --rfc --sha512 www.xelerance.com </para>

<para>dane --insecure --draft xelerance.com @ns0.xelerance.net</para>

</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para><citerefentry><refentrytitle>sshfp</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry> and RFC-XXXX</para>

<para><ulink url='http://www.xelerance.com/software/sshfp/'>http://www.xelerance.com/software/sshfp/</ulink></para>

<para><ulink url='http://lists.xelerance.com/mailman/listinfo/sshfp/'>http://lists.xelerance.com/mailman/listinfo/sshfp/</ulink></para>
</refsect1>

<refsect1 id='authors'><title>AUTHORS</title>
<para>Paul Wouters &lt;paul@xelerance.com&gt;</para>
</refsect1>

<refsect1 id='copyright'><title>COPYRIGHT</title>
<para>Copyright 2011 Xelerance Corporation</para>

<para>This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.  See &lt;<ulink url='http://www.fsf.org/copyleft/gpl.txt'>http://www.fsf.org/copyleft/gpl.txt</ulink>&gt;.</para>

<para>This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
Public License (file COPYING in the distribution) for more details.</para>
</refsect1>
</refentry>