head	1.5;
access;
symbols;
locks; strict;
comment	@# @;


1.5
date	2013.11.25.11.49.53;	author az;	state Exp;
branches;
next	1.4;

1.4
date	2010.09.16.05.14.25;	author az;	state Exp;
branches;
next	1.3;

1.3
date	2008.06.29.11.25.44;	author az;	state Exp;
branches;
next	1.2;

1.2
date	2002.09.19.14.36.35;	author az;	state Exp;
branches;
next	1.1;

1.1
date	2002.09.19.09.57.04;	author az;	state Exp;
branches;
next	;


desc
@@


1.5
log
@updated text a bit
@
text
@this is kuvert, a wrapper around sendmail or other MTAs that
does gpg signing/signing+encrypting transparently, based
on the content of your public keyring(s) and your preferences.

how it works:
-------------

you need to configure your MUA to submit mails to kuvert instead of 
directly. you configure kuvert either to present an SMTP server to
your MUA, or you make your MUA to use kuvert_submit instead of executing
/usr/sbin/sendmail. kuvert_submit will spool the mail
in kuvert's queue iff there is a suitable configuration file.

kuvert is the tool that takes care of mangling the email. it reads the 
queue periodically and handles emails in the queue: signing or encrypting
the mail, then handing it over to /usr/lib/sendmail or an external SMTP 
server for transport.

(why a queue? because i thought it might be useful to make sure that none of
your emails leaves your system without kuvert handing it. you might be 
very paranoid, and kill kuvert whenever you leave your box (and remove
the keyrings as well).)

installation:
-------------

on debian systems you simply install the kuvert package, construct
a suitable .kuvert configuration file and off you go. 
an example config file is provided 
at /usr/share/doc/kuvert/examples/dot-kuvert.

on other systems you need to do the following:

you need perl perl 5.004+, gpg and a raft of perl modules:
MIME::Parser, Mail::Address, Net::SMTPS, Sys::Hostname, Net::Server::Mail,
Authen::SASL, IO::Socket::INET, Filehandle, File::Slurp, File::Temp, Fcntl 
and Time::HiRes.
some of those are part of a standard perl intall, others you'll have to
get from your nearest CPAN archive and install.
optional: get linux-kernel keyutils package, the gpg-agent or some 
other passphrase cache of your choice.

run make, make install DESTDIR=/ as root
-> kuvert, kuvert_submit, the manpages and one helper module 
will be installed in /usr/bin, /usr/share/man/man1 and 
/usr/share/perl5/Net/Server/Mail/ESMTP/, respectively.

configuration:
--------------

read the manpages for kuvert(1) and kuvert_submit(1) and 
consult the example config file "dot-kuvert". you will need
to create your own config file as ~/.kuvert. sorry, no autoconfig here:
this step is too crucial for a mere robot to perform. 

then start kuvert and inject a testmail, look at the logs to check
if everything works correctly.

(historical note: kuvert came into existence in 1996 as pgpmail and
was used only privately until 99, when it was extended and renamed
to guard. some of my friends started using this software, and in 
2001 it was finally re-christened kuvert, extended even further
and debianized. in 2008 it received a major overhaul to also provide 
inbound smtp as submission mechanism, outbound smtp transport and better
controllability via email addresses. until 2008 kuvert supported pgp2.x.)

please report bugs to me, Alexander Zangerl, <az@@snafu.priv.at>.

The original source can always be found at:
	http://www.snafu.priv.at/kuvert/

Copyright (C) 1999-2013 Alexander Zangerl

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License version 2
  as published by the Free Software Foundation.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License with
  the Debian GNU/Linux distribution in file /usr/share/common-licenses/GPL;
  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  Suite 330, Boston, MA  02111-1307  USA




@


1.4
log
@updated with new dependency
@
text
@d35 1
a35 1
MIME::Parser, Mail::Address, Net::SMTP, Sys::Hostname, Net::Server::Mail,
d72 1
a72 1
Copyright (C) 1999-2008 Alexander Zangerl
@


1.3
log
@updated for version 2
@
text
@d36 2
a37 1
IO::Socket::INET, Filehandle, File::Slurp, File::Temp, Fcntl and Time::HiRes.
d40 2
a41 2
optional: get robert bihlmeyer's quintuple-agent, the linux-kernel keyutils 
package, the gpg-agent or some other passphrase cache of your choice.
@


1.2
log
@more info
@
text
@d2 1
a2 1
does pgp/gpg signing/signing+encrypting transparently, based
d8 5
a12 5
you have to get your MUA to use kuvert_mta_wrapper instead of executing
/usr/lib/sendmail (or similar). kuvert_mta_wrapper will spool the mail
in kuvert's queue, iff there is a suitable configuration file and the 
parameters passed to kuvert_mta_wrapper are consistent with sending mail
via sendmail.
d16 2
a17 1
the mail, then handing it over to /usr/lib/sendmail for transport.
a23 11
how to use kuvert in a nutshell: 
--------------------------------

you'll need a MTA which provides /usr/lib/sendmail with "common" options
(see the manpage for which are necessary). also you'll need a MUA which
can be instructed not to run /usr/lib/sendmail.

in a pinch you could rename /usr/lib/sendmail to something else, and install
kuvert_mta_wrapper as /usr/lib/sendmail. if you choose so, make double sure 
that your ~/.kuvert lists the name of the real sendmail binary as MTA.

d27 4
a30 1
on debian systems you may install just the kuvert package.
d34 7
a40 4
you need perl perl 5.004+, MIME-tools-4.124.tar.gz or later,
MIME-Base64-2.11.tar.gz or later, and MailTools-1.13.tar.gz or later
from your nearest CPAN archive and install them. get gpg and/or pgp2.x.
optional: get robert bihlmeyer's quintuple-agent, compile and install it.
d43 3
a45 2
-> kuvert, kuvert_mta_wrapper and the two manpages will be installed
in /usr/bin and /usr/share/man/man1.
d50 4
a53 3
read the manpages for kuvert(1) and kuvert_mta_wrapper(1), 
instruct your MUA to use kuvert_mta_wrapper, make the config file
~/.kuvert.
d55 1
a55 1
finally start kuvert and inject a testmail, look at the logs to check
d62 3
a64 1
and debianized.)
d71 1
a71 1
Copyright (C) 1999-2002  Alexander Zangerl
d74 2
a75 3
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
@


1.1
log
@Initial revision
@
text
@d5 18
d26 12
a37 2
on debian systems you may install just the kuvert package and
the rest of the  installation will be taken care of automatically.
d50 3
d54 5
a58 1
configure kuvert and go on from there.
d71 1
a71 1
Copyright (C) 1999-2001  Alexander Zangerl
@
