adds the contents of the file to the argument list..TP\fB\-\-label\fP\ \fIstring\fPadds the string to all error messages generated by \fBwhack\fP..LPThe help form of \fBwhack\fP is self-explanatory..TP\fB\-\-help\fPdisplay the usage message..TP\fB\-\-version\fPdisplay the version of \fBwhack\fP..LPThe connection form describes a potential connection to \fBpluto\fP.\fBpluto\fP needs to know what connections can and should be negotiated.When \fBpluto\fP is the initiator, it needs to know what to propose.When \fBpluto\fP is the responder, it needs to know enough to decide whetheris is willing to set up the proposed connection..LPThe description of a potential connection can specify a large numberof details.  Each connection has a unique name.  This name will appearin a updown shell command, so it should not contain punctuationthat would make the command ill-formed..TP\fB\-\-name\fP\ \fIconnection-name\fP.LPThe topology ofcircuit is symmetric, so to save space here is half a picture:\ \ \ client_subnet<\-\->host:ikeport<\-\->nexthop<\-\-\-A similar trick is used in the flags.  The same flag names are used forboth ends.  Those before the \fB\-\-to\fP flag describe the left sideand those afterwards describe the right side.  When \fBpluto\fP attemptsto use the connection, it decides whether it is the left side or the rightside of the connection, based on the IP numbers of its interfaces..TP\fB\-\-id\fP\ \fIid\fPthe identity of the end.  Currently, this can be an IP address (specifiedas dotted quad or as a Fully Qualified Domain Name, which will be resolvedimmediately) or as a Fully Qualified Domain Name itself (prefixed by ``@''to signify that it should not be resolved), or as user@FQDN.\fBpluto\fP only authenticates the identity, and does not use it foraddressing, so, for example, an IP address need not be the one to whichpackets are to be sent.  If the option is absent, theidentity defaults to the IP address specified by \fB\-\-host\fP..\" The identity is transmitted in the IKE protocol, and is what is authenticated..TP\fB\-\-host\fP\ \fIip\(hyaddress\fP.TP\fB\-\-host\fP\ \fB%any\fP.TP\fB\-\-host\fP\ \fB%opportunistic\fPthe IP address of the end (generally the public interface).If \fBpluto\fP is to act as a responderfor IKE negotiations initiated from unknown IP addresses (the``Road Warrior'' case), theIP address should be specified as \fB%any\fP (currently,the obsolete notation \fB0.0.0.0\fP is also accepted for this).If \fBpluto\fP is to opportunistically initiate the connection,use \fB%opportunistic\fP.TP\fB\-\-ikeport\fP\ \fIport\(hynumber\fPthe UDP port that IKE listens to on that host.  The default is 500.(\fBpluto\fP on this machine uses the port specified by its own commandline argument, so this only affects where \fBpluto\fP sends messages.).TP\fB\-\-nexthop\fP\ \fIip\(hyaddress\fPwhere to route packets for the peer's client (presumably for the peer too,but it will not be used for this).When \fBpluto\fP installs an IPsec SA, it issues a route command.It uses the nexthop as the gateway.The default is the peer's IP address (this can be explicitly written as\fB%direct\fP; the obsolete notation \fB0.0.0.0\fP is accepted).This option is necessary if \fBpluto\fP's host's interface used for sendingpackets to the peer is neither point-to-point nor directly connected to thepeer..TP\fB\-\-client\fP\ \fIsubnet\fPthe subnet for which the IPsec traffic will be destined.  If not specified,the host will be the client.The subnet can be specified in any of the forms supported by \fIipsec_atosubnet\fP(3).The general form is \fIaddress\fP/\fImask\fP.  The \fIaddress\fP can be eithera domain name or four decimal numbers (specifying octets) separated by dots.The most convenient form of the \fImask\fP is a decimal integer, specifyingthe number of leading one bits in the mask.  So, for example, 10.0.0.0/8would specify the class A network ``Net 10''..TP\fB\-\-updown\fP\ \fIupdown\fPspecifies an external shell command to be run whenever \fBpluto\fPbrings up or down a connection.The script is used to build a shell command, so it may contain positionalparameters, but ought not to have punctuation that would cause theresulting command to be ill-formed.The default is \fIipsec _updown\fP..TP\fB\-\-to\fPseparates the specification of the left and right ends of the connection..LPThe potential connection description also specifies characteristics ofrekeying and security..TP\fB\-\-psk\fPPropose and allow preshared secret authentication for IKE peers.  This authenticationrequires that each side use the same secret.  May be combined with \fB\-\-rsasig\fP;at least one must be specified..TP\fB\-\-rsasig\fPPropose and allow RSA signatures for authentication of IKE peers.  This authenticationrequires that each side have have a private key of its own and know thepublic key of its peer.  May be combined with \fB\-\-psk\fP;at least one must be specified..TP\fB\-\-encrypt\fPAll proposed or accepted IPsec SAs will include non-null ESP.The actual choices of transforms are wired into \fBpluto\fP..TP\fB\-\-authenticate\fPAll proposed IPsec SAs will include AH.All accepted IPsec SAs will include AH or ESP with authentication.The actual choices of transforms are wired into \fBpluto\fP.Note that this has nothing to do with IKE authentication..TP\fB\-\-compress\fPAll proposed IPsec SAs will include IPCOMP (compression).This will be ignored if KLIPS is not configured with IPCOMP support..TP\fB\-\-tunnel\fPthe IPsec SA should use tunneling.  Implicit if the SA is for clients.Must only be used with \fB\-\-authenticate\fP or \fB\-\-encrypt\fP..TP\fB\-\-ipv4\fPThe host addresses will be interpreted as IPv4 addresses.  This is thedefault.  Note that for a connection, all host addresses must be ofthe same Address Family (IPv4 and IPv6 use different Address Families)..TP\fB\-\-ipv6\fPThe host addresses (including nexthop) will be interpreted as IPv6 addresses.Note that for a connection, all host addresses must be ofthe same Address Family (IPv4 and IPv6 use different Address Families)..TP\fB\-\-tunnelipv4\fPThe client addresses will be interpreted as IPv4 addresses.  The default isto match what the host will be.  This does not imply \fB\-\-tunnel\fP so theflag can be safely used when no tunnel is actually specified.Note that for a connection, all tunnel addresses must be of the sameAddress Family..TP\fB\-\-tunnelipv6\fPThe client addresses will be interpreted as IPv6 addresses.  The default isto match what the host will be.  This does not imply \fB\-\-tunnel\fP so theflag can be safely used when no tunnel is actually specified.Note that for a connection, all tunnel addresses must be of the sameAddress Family..TP\fB\-\-pfs\fPThere should be Perfect Forward Secrecy \- new keying material willbe generated for each IPsec SA rather than being derived from the ISAKMPSA keying material.Since the group to be used cannot be negotiated (a dubious feature of thestandard), \fBpluto\fP will propose the same group that was used during Phase 1.We don't implement a stronger form of PFS which would require that theISAKMP SA be deleted after the IPSEC SA is negotiated..TP\fB\-\-disablearrivalcheck\fPIf the connection is a tunnel, allow packets arriving through the tunnelto have any source and destination addresses..LPIf none of the \fB\-\-encrypt\fP, \fB\-\-authenticate\fP, \fB\-\-compress\fP,or \fB\-\-pfs\fP flags is given, the initiating the connection willonly build an ISAKMP SA.  For such a connection, client subnets haveno meaning and must not be specified..LPMore work is needed to allow for flexible policies.  Currentlypolicy is hardwired in the source file spdb.c.  The ISAKMP SAs may useOakley groups MODP1024 and MODP1536; 3DES encryption; SHA1-96and MD5-96 authentication.  The IPsec SAs may use 3DES andMD5-96 or SHA1-96 for ESP, or just MD5-96 or SHA1-96 for AH.IPCOMP Compression is always Deflate..TP\fB\-\-ikelifetime\fP\ \fIseconds\fPhow long \fBpluto\fP will propose that an ISAKMP SA be allowed to live.The default is 3600 (one hour) and the maximum is 28800 (8 hours).This option will not affect what is accepted.\fBpluto\fP will reject proposals that exceed the maximum..TP\fB\-\-ipseclifetime\fP\ \fIseconds\fPhow long \fBpluto\fP will propose that an IPsec SA be allowed to live.The default is 28800 (eight hours) and the maximum is 86400 (one day).This option will not affect what is accepted.\fBpluto\fP will reject proposals that exceed the maximum..TP\fB\-\-rekeymargin\fP\ \fIseconds\fPhow long before an SA's expiration should \fBpluto\fP try to negotiatea replacement SA.  This will only happen if \fBpluto\fP was the initiator.The default is 540 (nine minutes)..TP\fB\-\-rekeyfuzz\fP\ \fIpercentage\fPmaximum size of random component to add to rekeymargin, expressed asa percentage of rekeymargin.  \fBpluto\fP will select a delay uniformlydistributed within this range.  By default, the percentage will be 100.If greater determinism is desired, specify 0.  It may be appropriatefor the percentage to be much larger than 100..TP\fB\-\-keyingtries\fP\ \fIcount\fPhow many times \fBpluto\fP should try to negotiate an SA,either for the first time or for rekeying.A value of 0 is interpreted as a very large number: never give up.The default is three..TP\fB\-\-dontrekey\fPDo not initiate rekeying.  This applies to Phase 1 and Phase 2.This is currently the only automatic way for a connection to terminate.It may be useful with Road Warrior or Opportunistic connections..TP\fB\-\-delete\fPwhen used in the connection form, it causes any previous connectionwith this name to be deleted before this one is added.  Unlike anormal delete, no diagnostic is produced if there was no previousconnection to delete.  Any routing in place for the connection is undone..LPThe delete form deletes a named connection description and anySAs established or negotiations initiated using this connection.Any routing in place for the connection is undone..TP\fB\-\-delete\fP.TP\fB\-\-name\fP\ \fIconnection-name\fP.LPThe deletestate form deletes the state object with the specified serial number.This is useful for selectively deleting instances of connections..TP\fB\-\-deletestate\fP\ \fIstate-number\fP.LPThe route form of the \fBwhack\fP command tells \fBpluto\fP to set uprouting for a connection.Although like a traditional route, it uses an ipsec device as avirtual interface.Once routing is set up, no packets will besent ``in the clear'' to the peer's client specified in the connection.A TRAP shunt eroute will be installed; if outbound traffic is caught,Pluto will initiate the connection.An explicit \fBwhack\fP route is not always needed: if it hasn't beendone when an IPsec SA is being installed, one will be automatically attempted..LPWhen a routing is attempted for a connection, there must not alreadybe a routing for a different connection with the same subnet but differentinterface or destination, or ifthere is, it must not be being used by an IPsec SA.  Otherwise theattempt will fail..TP\fB\-\-route\fP.TP\fB\-\-name\fP\ \fIconnection-name\fP.LPThe unroute form of the \fBwhack\fP command tells \fBpluto\fP to undoa routing.  \fBpluto\fP will refuse if an IPsec SA is using the connection.If another connection is sharing the same routing, it will be left in place.Without a routing, packets will be sent without encryption or authentication..TP\fB\-\-unroute\fP.TP\fB\-\-name\fP\ \fIconnection-name\fP.LPThe initiate form tells \fBpluto\fP to initiate a negotiation with another\fBpluto\fP (or other IKE daemon) according to the named connection.Initiation requires a route that \fB\-\-route\fP would provide;if none is in place at the time an IPsec SA is being installed,\fBpluto\fP attempts to set one up..TP\fB\-\-initiate\fP.TP\fB\-\-name\fP\ \fIconnection-name\fP.TP\fB\-\-asynchronous.LPThe initiate form of the \fBwhack\fP command will relay back from\fBpluto\fP status information via the UNIX domain socket (unless\-\-asynchronous is specified).  The status information is meant tolook a bit like that from \fBFTP\fP.  Currently \fBwhack\fP simplycopies this to stderr.  When the request is finished (eg. the SAs areestablished or \fBpluto\fP gives up), \fBpluto\fP closes the channel,causing \fBwhack\fP to terminate..LPThe terminate form tells \fBpluto\fP to delete any SAs that use the specifiedconnection and to stop any negotiations in process.It does not prevent new negotiations from starting (the delete formhas this effect)..TP\fB\-\-terminate\fP.TP\fB\-\-name\fP\ \fIconnection-name\fP.LPThe public key for informs \fBpluto\fP of the RSA public key for a potential peer.Private keys must be kept secret, so they are kept in.IR ipsec.secrets (5)..TP\fB\-\-keyid\ \fP\fIid\fPspecififies the identity of the peer for which a public key should be used.Its form is identical to the identity in the connection.If no public key is specified, \fBpluto\fP attempts to find KEY recordsfrom DNS for the id (if a FQDN) or through reverse lookup (if an IP address).Note that there several interesting ways in which this is not secure..TP\fB\-\-addkey\fPspecifies that the new key is added to the collection; otherwise thenew key replaces any old ones..TP\fB\-\-pubkeyrsa\ \fP\fIkey\fPspecifies the value of the RSA public key.  It is a sequence of bytesas described in RFC 2537 ``RSA/MD5 KEYs and SIGs in the Domain Name System (DNS)''.It is denoted in a way suitable for \fIipsec_ttodata\fP(3).For example, a base 64 numeral starts with 0s..LPThe listen form tells \fBpluto\fP to start listening for IKE requestson its public interfaces.  To avoid race conditions, it is normal toload the appropriate connections into \fBpluto\fP before allowing itto listen.  If \fBpluto\fP isn't listening, it is pointless toinitiate negotiations, so it will refuse requests to do so.  Wheneverthe listen form is used, \fBpluto\fP looks for public interfaces andwill notice when new ones have been added and when old ones have beenremoved.  This is also the trigger for \fBpluto\fP to read the\fIipsec.secrets\fP file.  So listen may useful more than once..TP\fB\-\-listen\fPstart listening for IKE traffic on public interfaces..TP\fB\-\-unlisten\fPstop listening for IKE traffic on public interfaces..LPThe status form will display information about the internal state of\fBpluto\fP: information about each potential connection, abouteach state object, and about each shunt that \fBpluto\fP is managingwithout an associated connection..TP\fB\-\-status\fP.LPThe shutdown form is the proper way to shut down \fBpluto\fP.It will tear down the SAs on this machine that \fBpluto\fP has negotiated.It does not inform its peers, so the SAs on their machines remain..TP\fB\-\-shutdown\fP.SS Examples.LP