crypto-utils/certwatch.xml

<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY date SYSTEM "date.xml">
<!ENTITY version SYSTEM "version.xml">

]>

<refentry>

  <refentryinfo>
    <date>&date;</date>
    <title>Cryptography Utilities</title>
    <productname>crypto-utils</productname>
    <productnumber>&version;</productnumber>
  </refentryinfo>

  <refmeta>
    <refentrytitle>certwatch</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  
  <refnamediv>
    <refname>certwatch</refname>
    <refpurpose>generate SSL certificate expiry warnings</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>certwatch</command>
      <arg choice="opt">OPTION...</arg>
      <arg choice="plain"><replaceable>certname</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  
  <refsect1>
    <title>Description</title>

    <para>The <command>certwatch</command> program is used to issue
    warning mail when an SSL certificate is about to expire.</para>

    <para>The program has two modes of operation: normal mode and
    quiet mode.  In normal mode, the certificate identified by the
    <replaceable>certname</replaceable> argument is examined, and a
    warning email is issued to standard output if the certificate is
    outside its validity period, or approaching expiry.  If the
    certificate cannot be found, or any errors occur whilst parsing
    the certificate, the certificate is ignored and no output is
    produced.  In quiet mode, no output is given, but the exit status
    can still be used.</para>
    
    <para>The certificate can be specified in one of two ways.  If the
    <option>--configdir</option> option is used, the
    <replaceable>certname</replaceable> parameter is used as a
    nickname to identify a certificate within an NSS database.
    Otherwise, the <replaceable>certname</replaceable> parameter is
    treated as a filename containing a certificate in OpenSSL "PEM"
    format.</para>

  </refsect1>


  <refsect1>
    <title>Options</title>

    <variablelist>

      <varlistentry>
        <term><option>--quiet</option>, <option>-q</option></term>

        <listitem><simpara>Enable quiet mode; no output is produced
        whether the certificate is expired or not</simpara></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--period <replaceable>days</replaceable></option>, 
        <option>-p <replaceable>days</replaceable></option></term>

        <listitem><simpara>Specify the number of days within which an
        expiry warning will be produced; default is 30.  Expiry
        warnings are always produced if, on the day of invocation, the
        certificate is not yet valid, has already expired, or is due
        to expire either that day or the following
        day.</simpara></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--address <replaceable>address</replaceable></option>,
        <option>-a <replaceable>address</replaceable></option></term>

        <listitem><simpara>Specify the address used in the To field of
        the warning e-mail issued if quiet mode is not enabled.  The
        default is <literal>root</literal>.</simpara></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--configdir <replaceable>cert-directory</replaceable></option>,
        <option>-d <replaceable>cert-directory</replaceable></option></term>

        <listitem><simpara>Specify the database directory containing the certificate 
        and key database files.</simpara></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--certdbprefix <replaceable>prefix</replaceable></option>,
        <option>-c <replaceable>prefix</replaceable></option></term>

        <listitem><simpara>If <option>--configdir</option> is used,
        specify the prefix used for the certificate database within
        the database directory.</simpara></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--keydbprefix <replaceable>prefix</replaceable></option>,
        <option>-c <replaceable>prefix</replaceable></option></term>

        <listitem><simpara>If <option>--configdir</option> is used,
        specify the prefix used for the key database within the
        database directory.</simpara></listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Diagnostics</title>
    
    <para>The exit code indicates the state of the certificate:</para>
    
    <variablelist>
      <varlistentry>
        <term><emphasis>0</emphasis></term>
        
        <listitem><simpara>The certificate is outside its validity
        period, or approaching expiry</simpara></listitem>
      </varlistentry>

      <varlistentry>
        <term><emphasis>1</emphasis></term>
        
        <listitem><simpara>The certificate is inside its validity
        period, or could not be parsed</simpara></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Notes</title>

    <para>The <command>certwatch</command> program is run daily by
    <command>crond</command> from the file
    <filename>/etc/cron.daily/certwatch</filename> to generate warning
    mail concerning the imminent expiry of SSL certificates configured
    for use in the Apache HTTP server.  These warnings can be disabled
    by adding the line: <literal>NOCERTWATCH=yes</literal> to the file
    <filename>/etc/sysconfig/httpd</filename>.  Additional options to
    pass to <command>certwatch</command> can be specified in that file
    in the <literal>CERTWATCH_OPTS</literal> environment
    variable.</para>

  </refsect1>

  <refsect1>
    <title>Files</title>

    <para><filename>/etc/cron.daily/certwatch</filename>,
    <filename>/etc/sysconfig/httpd</filename></para>
  </refsect1>
  
  <refsect1>
    <title>See also</title>

    <para>genkey(1)</para>
  </refsect1>

</refentry>