openswan/programs/mailkey/mailkey.8

   1 '\" t
   2 .\"     Title: IPSEC_MAILKEY
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 10/06/2010
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "IPSEC_MAILKEY" "8" "10/06/2010" "[FIXME: source]" "[FIXME: manual]"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 ipsec_mailkey \- mail DNS records for Opportunistic Encryption
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBipsec\fR\ 'u
  25 \fBipsec\fR \-\-me\ \fImy@address\&.tld\fR [\-\-reverse\ \fI1\&.2\&.3\&.4\ aaa\fR] [\-\-forward\ \fIhostname\&.domain\&.tld\fR]
  26 .SH "DESCRIPTION"
  27 .PP
  28 \fIMailkey\fR
  29 is a meta\-program\&. It generates a script which will attempt to mail the TXT records required to enable Opportunistic Encryption (OE)\&.
  30 .PP
  31 An e\-mail address for the domain\(^a\80\99s DNS administrator is derived from SOA records\&. The mail body and destination address are freely editable in the script\&.
  32 .PP
  33 If no administrator can be located, the output file will not be executable\&.
  34 .PP
  35 The
  36 \fB\-\-me\fR
  37 option sets the Reply\-to: address of the mail to be sent\&.
  38 .PP
  39 The
  40 \fB\-\-forward\fR
  41 hostname sets the domain name to be used for initiator\-only OE\&.
  42 .PP
  43 The
  44 \fB\-\-reverse\fR
  45 ip\-address sets the ip address to be used for full Opportunistic Encryption\&.
  46 .SH "EXAMPLES"
  47 .PP
  48 \fBipsec mailkey \-\-me paul@xelerance\&.com \-\-forward bofh\&.xelerance\&.com\fR
  49 .RS 4
  50 creates the i\-OE record for use on bofh\&.xelerance\&.com\&.
  51 .RE
  52 .PP
  53 \fBipsec mailkey \-\-me paul@xelerance\&.com \-\-reverse 193\&.110\&.157\&.17\fR
  54 .RS 4
  55 creates full\-OE record for use on bofh\&.xelerance\&.com\'s static IP address\&.
  56 .RE
  57 .SH "FILES"
  58 .PP
  59 /etc/ipsec\&.secrets
  60 .SH "SEE ALSO"
  61 .PP
  62 ipsecshowhostkey(8),host(8)
  63 .SH "HISTORY"
  64 .PP
  65 Written for the Linux FreeS/WAN project <\m[blue]\fBhttp://www\&.freeswan\&.org/\fR\m[]> by Sam Sgro\&.