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">
<refentry>
  <refentryinfo>
    <title>certwatch</title>
    <productname>certwatch</productname>
    <author><contrib>Author</contrib><surname>Orton</surname><firstname>Joe</firstname><email>jorton@redhat.com</email></author>
    <date>February 2019</date>
  </refentryinfo>

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

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

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

    <para>The program has two modes of operation: normal mode and
    quiet mode.  In normal mode, the certificate given by the
    <replaceable>filename</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>

  </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>--help</option>, <option>-h</option></term>

        <listitem><simpara>Display usage information.</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>

      <varlistentry>
        <term><emphasis>2</emphasis></term>

        <listitem><simpara>An invalid argument was
        passed.</simpara></listitem>
      </varlistentry>

    </variablelist>
  </refsect1>
  
  <refsect1>
    <title>See also</title>

    <para>
      <citerefentry><refentrytitle>httpd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>certwatch.cron</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
    <ulink url="https://github.com/notroj/certwatch/"/></para>
  </refsect1>

</refentry>