Blame nss/doc/vfychain.xml

Packit 40b132
Packit 40b132
Packit 40b132
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
Packit 40b132
Packit 40b132
Packit 40b132
]>
Packit 40b132
Packit 40b132
<refentry id="vfychain">
Packit 40b132
Packit 40b132
  <refentryinfo>
Packit 40b132
    <date>&dat;;</date>
Packit 40b132
    <title>NSS Security Tools</title>
Packit 40b132
    <productname>nss-tools</productname>
Packit 40b132
    <productnumber>&version;</productnumber>
Packit 40b132
  </refentryinfo>
Packit 40b132
Packit 40b132
  <refmeta>
Packit 40b132
    <refentrytitle>VFYCHAIN</refentrytitle>
Packit 40b132
    <manvolnum>1</manvolnum>
Packit 40b132
  </refmeta>
Packit 40b132
Packit 40b132
  <refnamediv>
Packit 40b132
    <refname>vfychain </refname>
Packit 40b132
    <refpurpose>vfychain [options] [revocation options] certfile [[options] certfile] ...</refpurpose>
Packit 40b132
  </refnamediv>
Packit 40b132
Packit 40b132
 <refsynopsisdiv>
Packit 40b132
    <cmdsynopsis>
Packit 40b132
      <command>vfychain</command>
Packit 40b132
    </cmdsynopsis>
Packit 40b132
  </refsynopsisdiv>
Packit 40b132
Packit 40b132
  <refsection>
Packit 40b132
    <title>STATUS</title>
Packit 40b132
    <para>This documentation is still work in progress. Please contribute to the initial review in <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=836477">Mozilla NSS bug 836477</ulink>
Packit 40b132
    </para>
Packit 40b132
  </refsection>
Packit 40b132
Packit 40b132
  <refsection id="description">
Packit 40b132
    <title>Description</title>
Packit 40b132
    <para>The verification Tool, <command>vfychain</command>, verifies certificate chains. <command>modutil</command> can add and delete PKCS #11 modules, change passwords on security databases, set defaults, list module contents, enable or disable slots, enable or disable FIPS 140-2 compliance, and assign default providers for cryptographic operations. This tool can also create certificate, key, and module security database files.</para>
Packit 40b132
Packit 40b132
	<para>The tasks associated with security module database management are part of a process that typically also involves managing key databases and certificate databases.</para>
Packit 40b132
  </refsection>
Packit 40b132
Packit 40b132
  <refsection id="options">
Packit 40b132
    <title>Options</title>
Packit 40b132
    
Packit 40b132
    <variablelist>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-a</option></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>the following certfile is base64 encoded</simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
          <term><option>-b </option> <replaceable>YYMMDDHHMMZ</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Validate date (default: now)</simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
          <term><option>-d </option> <replaceable>directory</replaceable></term>        <listitem>
Packit 40b132
          <simpara>database directory</simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-f </option> </term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Enable cert fetching from AIA URL</simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-o </option> <replaceable>oid</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Set policy OID for cert validation(Format OID.1.2.3)</simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-p </option></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Use PKIX Library to validate certificate by calling:</simpara>
Packit 40b132
		  <simpara>	   * CERT_VerifyCertificate if specified once,</simpara>
Packit 40b132
		  <simpara>	   * CERT_PKIXVerifyCert if specified twice and more.</simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
          <term><option>-r </option></term>
Packit 40b132
          <listitem>
Packit 40b132
            <simpara>Following certfile is raw binary DER (default)</simpara>
Packit 40b132
         </listitem>
Packit 40b132
       </varlistentry>
Packit 40b132
Packit 40b132
       <varlistentry>
Packit 40b132
         <term><option>-t</option></term>
Packit 40b132
         <listitem>
Packit 40b132
	       <simpara>Following cert is explicitly trusted (overrides db trust)</simpara>
Packit 40b132
         </listitem>
Packit 40b132
       </varlistentry>
Packit 40b132
Packit 40b132
       <varlistentry>
Packit 40b132
         <term><option>-u </option> <replaceable>usage</replaceable></term>
Packit 40b132
         <listitem>
Packit 40b132
            <para>
Packit 40b132
	 	 0=SSL client, 1=SSL server, 2=SSL StepUp, 3=SSL CA,
Packit 40b132
	     4=Email signer, 5=Email recipient, 6=Object signer,
Packit 40b132
		 9=ProtectedObjectSigner, 10=OCSP responder, 11=Any CA
Packit 40b132
            </para>
Packit 40b132
         </listitem>
Packit 40b132
        </varlistentry>
Packit 40b132
Packit 40b132
        <varlistentry>
Packit 40b132
          <term><option>-T </option></term>
Packit 40b132
          <listitem>
Packit 40b132
	        <simpara>Trust both explicit trust anchors (-t) and the database. (Without this option, the default is to only trust certificates marked -t, if there are any, or to trust the database if there are certificates marked -t.)
Packit 40b132
            </simpara>
Packit 40b132
          </listitem>
Packit 40b132
        </varlistentry>
Packit 40b132
Packit 40b132
        <varlistentry>
Packit 40b132
          <term><option>-v </option></term>
Packit 40b132
          <listitem>
Packit 40b132
	        <simpara>Verbose mode. Prints root cert subject(double the
Packit 40b132
			 argument for whole root cert info)
Packit 40b132
            </simpara>
Packit 40b132
          </listitem>
Packit 40b132
        </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-w </option> <replaceable>password</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Database password</simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-W </option> <replaceable>pwfile</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Password file</simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option></option></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Revocation options for PKIX API (invoked with -pp options) is a
Packit 40b132
	collection of the following flags:
Packit 40b132
		[-g type [-h flags] [-m type [-s flags]] ...] ...</simpara>
Packit 40b132
          <simpara>Where: </simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-g </option> <replaceable>test-type</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Sets status checking test type. Possible values
Packit 40b132
			are "leaf" or "chain"
Packit 40b132
          </simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-g </option> <replaceable>test type</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Sets status checking test type. Possible values
Packit 40b132
			are "leaf" or "chain".
Packit 40b132
          </simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-h </option> <replaceable>test flags</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Sets revocation flags for the test type it
Packit 40b132
			follows. Possible flags: "testLocalInfoFirst" and
Packit 40b132
			"requireFreshInfo".
Packit 40b132
          </simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-m </option> <replaceable>method type</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Sets method type for the test type it follows.
Packit 40b132
			Possible types are "crl" and "ocsp".
Packit 40b132
          </simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
      <varlistentry>
Packit 40b132
        <term><option>-s </option> <replaceable>method flags</replaceable></term>
Packit 40b132
        <listitem>
Packit 40b132
          <simpara>Sets revocation flags for the method it follows.
Packit 40b132
			Possible types are "doNotUse", "forbidFetching",
Packit 40b132
			"ignoreDefaultSrc", "requireInfo" and "failIfNoInfo".
Packit 40b132
          </simpara>
Packit 40b132
        </listitem>
Packit 40b132
      </varlistentry>
Packit 40b132
    </variablelist>
Packit 40b132
  </refsection>
Packit 40b132
Packit 40b132
Packit 40b132
  <refsection id="resources">
Packit 40b132
    <title>Additional Resources</title>
Packit 40b132
	<para>For information about NSS and other tools related to NSS (like JSS), check out the NSS project wiki at <ulink url="http://www.mozilla.org/projects/security/pki/nss/">http://www.mozilla.org/projects/security/pki/nss/</ulink>. The NSS site relates directly to NSS code changes and releases.</para>
Packit 40b132
	<para>Mailing lists: https://lists.mozilla.org/listinfo/dev-tech-crypto</para>
Packit 40b132
	<para>IRC: Freenode at #dogtag-pki</para>
Packit 40b132
  </refsection>
Packit 40b132
Packit 40b132
Packit 40b132
  <refsection id="authors">
Packit 40b132
    <title>Authors</title>
Packit 40b132
    <para>The NSS tools were written and maintained by developers with Netscape, Red Hat,  Sun, Oracle, Mozilla, and Google.</para>
Packit 40b132
    <para>
Packit 40b132
	Authors: Elio Maldonado <emaldona@redhat.com>, Deon Lackey <dlackey@redhat.com>.
Packit 40b132
    </para>
Packit 40b132
  </refsection>
Packit 40b132
Packit 40b132
Packit 40b132
  <refsection id="license">
Packit 40b132
    <title>LICENSE</title>
Packit 40b132
    <para>Licensed under the Mozilla Public License, v. 2.0.  If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Packit 40b132
    </para>
Packit 40b132
  </refsection>
Packit 40b132
Packit 40b132
</refentry>