summaryrefslogtreecommitdiffstats
path: root/imap/mkimapdcert.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'imap/mkimapdcert.sgml')
-rw-r--r--imap/mkimapdcert.sgml83
1 files changed, 83 insertions, 0 deletions
diff --git a/imap/mkimapdcert.sgml b/imap/mkimapdcert.sgml
new file mode 100644
index 0000000..6b1c2f8
--- /dev/null
+++ b/imap/mkimapdcert.sgml
@@ -0,0 +1,83 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<!-- Copyright 2000 - 2007 Double Precision, Inc. See COPYING for -->
+<!-- distribution information. -->
+<refentry>
+ <info><author><firstname>Sam</firstname><surname>Varshavchik</surname><contrib>Author</contrib></author><productname>Courier Mail Server</productname></info>
+
+ <refmeta>
+ <refentrytitle>mkimapdcert</refentrytitle>
+ <manvolnum>8</manvolnum>
+ <refmiscinfo>Double Precision, Inc.</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>mkimapdcert</refname>
+ <refpurpose>create a test SSL certificate for IMAP over SSL</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis sepchar=" ">
+ <command moreinfo="none">@sbindir@/mkimapdcert</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>DESCRIPTION</title>
+
+ <para>
+IMAP over SSL requires a valid, signed, X.509 certificate. The default
+location for the certificate file is
+<filename moreinfo="none">@certsdir@/imapd.pem</filename>.
+<command moreinfo="none">mkimapdcert</command> generates a self-signed X.509 certificate,
+mainly for
+testing.
+For production use the X.509 certificate must be signed by a
+recognized certificate authority, in order for mail clients to accept the
+certificate.</para>
+
+ <para>
+<filename moreinfo="none">@certsdir@/imapd.pem</filename> must be owned by the
+@mailuser@ user and
+have no group or world permissions.
+The <command moreinfo="none">mkimapdcert</command> command will
+enforce this. To prevent an unfortunate accident,
+<command moreinfo="none">mkimapdcert</command>
+will not work if <command moreinfo="none">@certsdir@/imapd.pem</command> already exists.</para>
+
+ <para>
+<command moreinfo="none">mkimapdcert</command> requires
+<application moreinfo="none">OpenSSL</application> to be installed.</para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>FILES</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>@certsdir@/imapd.pem</term>
+ <listitem>
+ <simpara>
+X.509 certificate.
+</simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>@sysconfdir@/imapd.cnf</term>
+ <listitem>
+ <simpara>
+Parameters used by OpenSSL to
+create the X.509 certificate.
+</simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>
+<ulink url="courier.html"><citerefentry><refentrytitle>courier</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink></para>
+ </refsect1>
+</refentry>