[Nym3-commit] r344 - trunk/nymbaron/doc
laurent at conuropsis.org
laurent at conuropsis.org
Wed Oct 12 23:15:21 CEST 2005
Author: laurent
Date: 2005-10-12 23:15:20 +0200 (Wed, 12 Oct 2005)
New Revision: 344
Added:
trunk/nymbaron/doc/nymbarond.xml
Log:
Add reference page for the server.
Added: trunk/nymbaron/doc/nymbarond.xml
===================================================================
--- trunk/nymbaron/doc/nymbarond.xml 2005-10-12 21:13:43 UTC (rev 343)
+++ trunk/nymbaron/doc/nymbarond.xml 2005-10-12 21:15:20 UTC (rev 344)
@@ -0,0 +1,161 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<refentry>
+<refmeta>
+<refentrytitle>NYMBAROND</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='source'>October 12, 2005</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>nymbarond</refname>
+<refpurpose>type III nymserver</refpurpose>
+</refnamediv>
+<!-- body begins here -->
+<refsynopsisdiv id='synopsis'>
+<cmdsynopsis>
+ <command>nymbarond</command>
+ <group>
+ <arg choice='plain'>-m</arg>
+ <arg choice='plain'>-d</arg>
+ </group>
+ <sbr/>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+<para>A nymserver is a mail server which stores emails on behalf of anonymous
+users. It provides long-term pseudonymous identities which can receive and send
+emails through the server, without revealing the user controling those
+identities.</para>
+
+<para>nymbarond is an implementation of a type III nymserver, which
+is built upon the mixminion remailer network.</para>
+
+<para>WARNING: this is still considered alpha quality software. Do NOT use
+ it if you require strong anonymity.</para>
+
+<para><command>nymbarond</command> is not in intended to be called
+directly from the command line. Instead you have to arrange for it to
+be called automatically upon a mail delivery, or when receiving a
+control message.
+</para>
+</refsect1>
+
+<refsect1 id='bounds'><title>COMMANDS</title>
+<variablelist>
+<varlistentry>
+ <term><option>-d</option><arg>localpart</arg></term>
+ <listitem>
+ <para>
+ Accept an incoming email for delivery to the specified localpart.
+ Return non-zero on failure, possibly indicating an inexistant
+ localpart or exceeded quota.
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><option>-m</option></term>
+ <listitem>
+ <para>
+ Accept a control message from <emphasis>stdin</emphasis>.
+ </para>
+ </listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1><title>INSTALLATION GUIDE</title>
+<para>
+ To be able to install a nymbaron server you will need to tweak
+ your MTA configuration. Although this is currently not strictly
+ needed, a mixminion server accepting at least mbox delivery is
+ recommanded. Without it, some assumptions in the type III
+ nymserver protocol are false and your hosted accounts are open to
+ replay attacks.</para>
+ <important>
+ <para>
+ LET ME MAKE THIS ABSOLUTELY CLEAR: SETTING UP A
+ NYMSERVER WITHOUT AN ASSOCIATED MIXMINION SERVER IS A FLAWED
+ CONFIGURATION THAT IS SOLELY ACCEPTABLE FOR TESTING
+ PURPOSES.
+ </para>
+ </important>
+<para>A mixminion server will become a requirement
+ in the future.
+</para>
+
+<orderedlist>
+<listitem>
+<para>
+ First create an unpriviledged system account, for example
+ nymbaron, that will hold all nymuser emails and data and run the
+ scripts. Chose a suitable homedir (I recommand something in
+ /var/lib or /var/spool) and make sure other users don't have
+ access to the homedir.
+</para>
+</listitem>
+<listitem>
+<para>
+ Chose an email domain that will host the nymuser email addresses.
+ It's better to have a different domain that the regular domain
+ used for the host. Configure your MTA to deliver emails for this
+ domain to:
+</para>
+ <synopsis>nymbarond -d localpart
+ </synopsis>
+<para>
+ as user nymbaron. If you're not familiar with your MTA, you will
+ want to look for something named "pipe delivery" or similar.
+ Please see the example configurations in the contrib directory.
+</para>
+</listitem>
+<listitem>
+<para>
+ Arrange for control message delivery.
+ TODO : write more.
+</para>
+</listitem>
+</orderedlist>
+
+</refsect1>
+<refsect1><title>AUTHORS</title>
+<para>
+ Laurent Fousse <email>laurent at komite.net</email> and Jean-René
+ Reinhard
+ <email>jr at komite.net</email>.
+ <ulink
+ url="http://www.komite.net/laurent/soft/nymbaron/">Homepage</ulink>
+</para>
+</refsect1>
+<refsect1><title>COPYRIGHT</title>
+<para>
+Copyright © 2004,2005 Jean-René Reinhard
+<email>jr at komite.net</email>
+and Laurent Fousse <email>laurent at komite.net</email>.
+</para>
+<para>
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to
+do so, provided that the above copyright notice(s) and this permission
+notice appear in all copies of the Software and that both the above
+copyright notice(s) and this permission notice appear in supporting
+documentation.
+</para>
+<para>
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE
+LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR
+ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+</para>
+</refsect1>
+</refentry>
More information about the Nym3-commit
mailing list