xref: /freebsd/sys/netinet/libalias/libalias.3 (revision 619d1a30a1970057e270eb05f9289a41f8608ce7)
13efa11bbSBrian Somers.Dd July, 1997
23efa11bbSBrian Somers.Dt "libalias" 3
33efa11bbSBrian Somers.Os
43efa11bbSBrian Somers.Sh NAME
53efa11bbSBrian Somers.Nm "libalias"
63efa11bbSBrian SomersPacket Aliasing Library.  A collection of
73efa11bbSBrian Somersfunctions for aliasing and de-aliasing
83efa11bbSBrian Somersof IP packets, intended for masquerading and
93efa11bbSBrian Somersnetwork address translation (NAT).
103efa11bbSBrian Somers
113efa11bbSBrian Somers.Sh SYNOPSIS
12442a25bdSBruce Evans.Fd #include <sys/types.h>
133efa11bbSBrian Somers.Fd #include <netinet/in.h>
143efa11bbSBrian Somers.Fd #include <alias.h>
153efa11bbSBrian Somers
163efa11bbSBrian SomersFunction prototypes are given in the main body
173efa11bbSBrian Somersof the text.
183efa11bbSBrian Somers
193efa11bbSBrian Somers.Sh CONTENTS
203efa11bbSBrian Somers.Bd -literal -offset left
213efa11bbSBrian Somers1. Introduction
223efa11bbSBrian Somers2. Initialization and Control
233efa11bbSBrian Somers    2.1 PacketAliasInit()
248ddc51bcSEivind Eklund    2.2 PacketAliasUninit()
258ddc51bcSEivind Eklund    2.3 PacketAliasSetAddress()
268ddc51bcSEivind Eklund    2.4 PacketAliasSetMode()
278ddc51bcSEivind Eklund    2.5 PacketAliasSetFWBase()
283efa11bbSBrian Somers3. Packet Handling
29b2052ac8SJohn Polstra    3.1 PacketAliasIn()
30b2052ac8SJohn Polstra    3.2 PacketAliasOut()
313efa11bbSBrian Somers4. Port and Address Redirection
323efa11bbSBrian Somers    4.1 PacketAliasRedirectPort()
333efa11bbSBrian Somers    4.2 PacketAliasRedirectAddr()
343efa11bbSBrian Somers    4.3 PacketAliasRedirectDelete()
35619d1a30SBrian Somers    4.4 PacketAliasProxyRule()
363efa11bbSBrian Somers5. Fragment Handling
373efa11bbSBrian Somers    5.1 PacketAliasSaveFragment()
383efa11bbSBrian Somers    5.2 PacketAliasGetFragment()
393efa11bbSBrian Somers    5.3 PacketAliasFragmentIn()
403efa11bbSBrian Somers6. Miscellaneous Functions
413efa11bbSBrian Somers    6.1 PacketAliasSetTarget()
423efa11bbSBrian Somers    6.2 PacketAliasCheckNewLink()
433efa11bbSBrian Somers    6.3 PacketAliasInternetChecksum()
443efa11bbSBrian Somers7. Authors
453efa11bbSBrian Somers8. Acknowledgments
463efa11bbSBrian Somers
473efa11bbSBrian SomersAppendix A: Conceptual Background
483efa11bbSBrian Somers    A.1 Aliasing Links
493efa11bbSBrian Somers    A.2 Static and Dynamic Links
503efa11bbSBrian Somers    A.3 Partially Specified Links
513efa11bbSBrian Somers    A.4 Dynamic Link Creation
523efa11bbSBrian Somers.Ed
533efa11bbSBrian Somers
543efa11bbSBrian Somers.Sh 1. Introduction
553efa11bbSBrian SomersThis library is a moderately portable
563efa11bbSBrian Somersset of functions designed to assist
573efa11bbSBrian Somersin the process of IP masquerading and
583efa11bbSBrian Somersnetwork address translation.  Outgoing
593efa11bbSBrian Somerspackets from a local network with
603efa11bbSBrian Somersunregistered IP addresses can be aliased
613efa11bbSBrian Somersto appear as if they came from an
623efa11bbSBrian Somersaccessible IP address.  Incoming packets
633efa11bbSBrian Somersare then de-aliased so that they are sent
643efa11bbSBrian Somersto the correct machine on the local network.
653efa11bbSBrian Somers
663efa11bbSBrian SomersA certain amount of flexibility is built
673efa11bbSBrian Somersinto the packet aliasing engine.  In
683efa11bbSBrian Somersthe simplest mode of operation, a
693efa11bbSBrian Somersmany-to-one address mapping takes place
703efa11bbSBrian Somersbetween local network and the packet
713efa11bbSBrian Somersaliasing host.  This is known as IP
723efa11bbSBrian Somersmasquerading.  In addition, one-to-one
733efa11bbSBrian Somersmappings between local and public addresses
743efa11bbSBrian Somerscan also be implemented, which is known as
753efa11bbSBrian Somersstatic NAT.  In between these extremes,
763efa11bbSBrian Somersdifferent groups of private addresses
773efa11bbSBrian Somerscan be linked to different public addresses,
783efa11bbSBrian Somerscomprising several distinct many-to-one
793efa11bbSBrian Somersmappings.  Also, a given public address
809c727d2cSJoseph Koshyand port can be statically redirected to
813efa11bbSBrian Somersa private address/port.
823efa11bbSBrian Somers
833efa11bbSBrian SomersThe packet aliasing engine was designed
843efa11bbSBrian Somersto operate in user space outside of the
853efa11bbSBrian Somerskernel, without any access to private
863efa11bbSBrian Somerskernel data structure, but the source code
873efa11bbSBrian Somerscan also be ported to a kernel environment.
883efa11bbSBrian Somers
893efa11bbSBrian Somers.Sh 2. Initialization and Control
903efa11bbSBrian SomersTwo specific functions, PacketAliasInit()
913efa11bbSBrian Somersand PacketAliasSetAddress(), must always be
923efa11bbSBrian Somerscalled before any packet handling may be
933efa11bbSBrian Somersperformed.  In addition, the operating mode
943efa11bbSBrian Somersof the packet aliasing engine can be customized
953efa11bbSBrian Somersby calling PacketAliasSetMode().
963efa11bbSBrian Somers.Ss 2.1 PacketAliasInit()
973efa11bbSBrian Somers
983efa11bbSBrian Somers.Ft void
993efa11bbSBrian Somers.Fn PacketAliasInit "void"
1003efa11bbSBrian Somers
1013efa11bbSBrian SomersThis function has no argument or return
1023efa11bbSBrian Somersvalue and is used to initialize internal
1033efa11bbSBrian Somersdata structures. The following mode bits
1043efa11bbSBrian Somersare always set after calling
1053efa11bbSBrian SomersPacketAliasInit().  See section 2.3 for
1063efa11bbSBrian Somersthe meaning of these mode bits.
1073efa11bbSBrian Somers.Bd -literal -offset indent
1083efa11bbSBrian Somers    PKT_ALIAS_USE_SAME_PORTS
1093efa11bbSBrian Somers    PKT_ALIAS_USE_SOCKETS
1103efa11bbSBrian Somers    PKT_ALIAS_RESET_ON_ADDR_CHANGE
1113efa11bbSBrian Somers
1123efa11bbSBrian Somers.Ed
1133efa11bbSBrian SomersThis function will always return the packet
1143efa11bbSBrian Somersaliasing engine to the same initial state.
1153efa11bbSBrian SomersPacketAliasSetAddress() must be called afterwards,
1163efa11bbSBrian Somersand any desired changes from the default mode
1173efa11bbSBrian Somersbits listed above require a call to
1183efa11bbSBrian SomersPacketAliasSetMode().
1193efa11bbSBrian Somers
1203efa11bbSBrian SomersIt is mandatory that this function be called
1213efa11bbSBrian Somersat the beginning of a program prior to any
1223efa11bbSBrian Somerspacket handling.
123bf9a92b7SBruce Evans.Ss 2.2 PacketAliasUninit()
1248ddc51bcSEivind Eklund
1258ddc51bcSEivind Eklund.Ft void
126bf9a92b7SBruce Evans.Fn PacketAliasUninit "void"
1278ddc51bcSEivind Eklund
1288ddc51bcSEivind EklundThis function has no argument or return
1298ddc51bcSEivind Eklundvalue and is used to clear any resources
1308ddc51bcSEivind Eklundattached to internal data structures.
1318ddc51bcSEivind Eklund
1328ddc51bcSEivind EklundThis functions should be called when a
1338ddc51bcSEivind Eklundprogram stop using the aliasing engine;
1348ddc51bcSEivind Eklundit do, among other things, clear out any
1358ddc51bcSEivind Eklundfirewall holes.  To provide backwards
1368ddc51bcSEivind Eklundcompatibility and extra security, it is
1378ddc51bcSEivind Eklundadded to the atexit() chain by
1388ddc51bcSEivind EklundPacketAliasInit().  Calling it multiple
1398ddc51bcSEivind Eklundtimes is harmless.
1408ddc51bcSEivind Eklund.Ss 2.3 PacketAliasSetAddress()
1413efa11bbSBrian Somers
1423efa11bbSBrian Somers.Ft void
1433efa11bbSBrian Somers.Fn PacketAliasSetAddress "struct in_addr addr"
1443efa11bbSBrian Somers
1453efa11bbSBrian SomersThis function sets the source address to which
1463efa11bbSBrian Somersoutgoing packets from the local area network
1473efa11bbSBrian Somersare aliased.  All outgoing packets are remapped
1483efa11bbSBrian Somersto this address unless overridden by a static
1493efa11bbSBrian Somersaddress mapping established by
1503efa11bbSBrian SomersPacketAliasRedirectAddr().
1513efa11bbSBrian Somers
1523efa11bbSBrian SomersIf the PKT_ALIAS_RESET_ON_ADDR_CHANGE mode bit
1533efa11bbSBrian Somersis set (the default mode of operation), then
1543efa11bbSBrian Somersthe internal aliasing link tables will be reset
1553efa11bbSBrian Somersany time the aliasing address changes, as if
1563efa11bbSBrian SomersPacketAliasReset() were called.  This is useful
1573efa11bbSBrian Somersfor interfaces such as ppp where the IP
1583efa11bbSBrian Somersaddress may or may not change on successive
1593efa11bbSBrian Somersdial-up attempts.
1603efa11bbSBrian Somers
1613efa11bbSBrian SomersIf the PKT_ALIAS_RESET_ON_ADDR_CHANGE mode bit
1623efa11bbSBrian Somersis set to zero, this function can also be used to
1633efa11bbSBrian Somersdynamically change the aliasing address on a
1643efa11bbSBrian Somerspacket to packet basis (it is a low overhead
1653efa11bbSBrian Somerscall).
1663efa11bbSBrian Somers
1673efa11bbSBrian SomersIt is mandatory that this function be called
1683efa11bbSBrian Somersprior to any packet handling.
1698ddc51bcSEivind Eklund.Ss 2.4 PacketAliasSetMode()
1703efa11bbSBrian Somers
171442a25bdSBruce Evans.Ft unsigned int
172442a25bdSBruce Evans.Fn PacketAliasSetMode "unsigned int mode" "unsigned int mask"
1733efa11bbSBrian Somers
1743efa11bbSBrian SomersThis function sets or clears mode bits
1753efa11bbSBrian Somersaccording to the value of
1763efa11bbSBrian Somers.Em mode .
1773efa11bbSBrian SomersOnly bits marked in
1783efa11bbSBrian Somers.Em mask
1793efa11bbSBrian Somersare affected.  The following mode bits are
1803efa11bbSBrian Somersdefined in alias.h:
1813efa11bbSBrian Somers.Bl -hang -offset left
1823efa11bbSBrian Somers.It PKT_ALIAS_LOG.
1833efa11bbSBrian SomersEnables logging /var/log/alias.log.  The log file
1843efa11bbSBrian Somersshows total numbers of links (icmp, tcp, udp) each
1853efa11bbSBrian Somerstime an aliasing link is created or deleted.  Mainly
1863efa11bbSBrian Somersuseful for debugging when the log file is viewed
1873efa11bbSBrian Somerscontinuously with "tail -f".
1883efa11bbSBrian Somers.It PKT_ALIAS_DENY_INCOMING.
1893efa11bbSBrian SomersIf this mode bit is set, all incoming packets
1903efa11bbSBrian Somersassociated with new TCP connections or new
1913efa11bbSBrian SomersUDP transactions will be marked for being
1923efa11bbSBrian Somersignored (PacketAliasIn() return code
1933efa11bbSBrian SomersPKT_ALIAS_IGNORED) by the calling program.
1943efa11bbSBrian SomersResponse packets to connections or transactions
1953efa11bbSBrian Somersinitiated from the packet aliasing host or
1963efa11bbSBrian Somerslocal network will be unaffected.  This mode
1973efa11bbSBrian Somersbit is useful for implementing a one-way firewall.
1983efa11bbSBrian Somers.It PKT_ALIAS_SAME_PORTS.
1993efa11bbSBrian SomersIf this mode bit is set, the packet aliasing
2003efa11bbSBrian Somersengine will attempt to leave the alias port
2013efa11bbSBrian Somersnumbers unchanged from the actual local port
2023efa11bbSBrian Somersnumber.  This can be done as long as the
2033efa11bbSBrian Somersquintuple (proto, alias addr, alias port,
2043efa11bbSBrian Somersremote addr, remote port) is unique.  If a
2053efa11bbSBrian Somersconflict exists, an new aliasing port number is
2063efa11bbSBrian Somerschosen even if this mode bit is set.
2073efa11bbSBrian Somers.It PKT_ALIAS_USE_SOCKETS.
2083efa11bbSBrian SomersThis bit should be set when the the packet
2093efa11bbSBrian Somersaliasing host originates network traffic as
2103efa11bbSBrian Somerswell as forwards it.  When the packet aliasing
2113efa11bbSBrian Somershost is waiting for a connection from an
2123efa11bbSBrian Somersunknown host address or unknown port number
2133efa11bbSBrian Somers(e.g. an FTP data connection), this mode bit
2143efa11bbSBrian Somersspecifies that a socket be allocated as a place
2153efa11bbSBrian Somersholder to prevent port conflicts.  Once a
2169c727d2cSJoseph Koshyconnection is established, usually within a
2173efa11bbSBrian Somersminute or so, the socket is closed.
2183efa11bbSBrian Somers.It PKT_ALIAS_UNREGISTERED_ONLY.
2193efa11bbSBrian SomersIf this mode bit is set, traffic on the
2203efa11bbSBrian Somerslocal network which does not originate from
2213efa11bbSBrian Somersunregistered address spaces will be ignored.
2223efa11bbSBrian SomersStandard Class A, B and C unregistered addresses
2233efa11bbSBrian Somersare:
2243efa11bbSBrian Somers.Bd -literal -offset indent
2253efa11bbSBrian Somers    10.0.0.0     ->   10.255.255.255   (Class A subnet)
2263efa11bbSBrian Somers    172.16.0.0   ->   172.31.255.255   (Class B subnets)
2273efa11bbSBrian Somers    192.168.0.0  ->   192.168.255.255  (Class C subnets)
2283efa11bbSBrian Somers
2293efa11bbSBrian Somers.Ed
2303efa11bbSBrian SomersThis option is useful in the case that
2313efa11bbSBrian Somerspacket aliasing host has both registered and
2323efa11bbSBrian Somersunregistered subnets on different interfaces.
2333efa11bbSBrian SomersThe registered subnet is fully accessible to
2343efa11bbSBrian Somersthe outside world, so traffic from it doesn't
2353efa11bbSBrian Somersneed to be passed through the packet aliasing
2363efa11bbSBrian Somersengine.
2373efa11bbSBrian Somers.It PKT_ALIAS_RESET_ON_ADDR_CHANGE.
2383efa11bbSBrian SomersWhen this mode bit is set and
2393efa11bbSBrian SomersPacketAliasSetAddress() is called to change
2403efa11bbSBrian Somersthe aliasing address, the internal link table
2413efa11bbSBrian Somersof the packet aliasing engine will be cleared.
2423efa11bbSBrian SomersThis operating mode is useful for ppp links
2433efa11bbSBrian Somerswhere the interface address can sometimes
2443efa11bbSBrian Somerschange or remain the same between dial-ups.
2453efa11bbSBrian SomersIf this mode bit is not set, it the link table
2463efa11bbSBrian Somerswill never be reset in the event of an
2473efa11bbSBrian Somersaddress change.
2488ddc51bcSEivind Eklund.It PKT_ALIAS_PUNCH_FW.
2498ddc51bcSEivind EklundThis option make libalias `punch holes' in an
2508ddc51bcSEivind Eklundipfw based firewall for FTP/IRC DCC connections.
2518ddc51bcSEivind EklundThe holes punched are bound by from/to IP address
2528ddc51bcSEivind Eklundand port; it will not be possible to use a hole
2538ddc51bcSEivind Eklundfor another connection.  A hole is removed when
2548ddc51bcSEivind Eklundthe connection that use it die.  To cater for
2558ddc51bcSEivind Eklundunexpected death of a program using libalias (e.g
2568ddc51bcSEivind Eklundkill -9), changing the state of the flag will
2578ddc51bcSEivind Eklundclear the entire ipfw range allocated for holes.
2588ddc51bcSEivind EklundThis will also happen on the initial call to
2598ddc51bcSEivind EklundPacketAliasSetFWBase().  This call must happen
2608ddc51bcSEivind Eklundprior to setting this flag.
2618ddc51bcSEivind Eklund
2623efa11bbSBrian Somers.El
2638ddc51bcSEivind Eklund
2648ddc51bcSEivind Eklund.Ss 2.5 PacketAliasSetFWBase()
2658ddc51bcSEivind Eklund
2668ddc51bcSEivind Eklund.Ft void
2678ddc51bcSEivind Eklund.Fn PacketAliasSetFWBase "unsigned int base" "unsigned int num"
2688ddc51bcSEivind Eklund
2698ddc51bcSEivind EklundSet IPFW range allocated for punching firewall holes (with the
2708ddc51bcSEivind EklundPKT_ALIAS_PUNCH_FW flag).  The range will be cleared for all rules on
2718ddc51bcSEivind Eklundinitialization.
2728ddc51bcSEivind Eklund
2733efa11bbSBrian Somers.Sh 3. Packet Handling
2743efa11bbSBrian SomersThe packet handling functions are used to
2753efa11bbSBrian Somersmodify incoming (remote->local) and outgoing
2763efa11bbSBrian Somers(local->remote) packets.  The calling program
2773efa11bbSBrian Somersis responsible for receiving and sending
2783efa11bbSBrian Somerspackets via network interfaces.
2793efa11bbSBrian Somers
2803efa11bbSBrian SomersAlong with PacketAliasInit() and PacketAliasSetAddress(),
2813efa11bbSBrian Somersthe two packet handling functions, PacketAliasIn()
2823efa11bbSBrian Somersand PacketAliasOut(), comprise minimal set of functions
2833efa11bbSBrian Somersneeded for a basic IP masquerading implementation.
2843efa11bbSBrian Somers.Ss 3.1 PacketAliasIn()
2853efa11bbSBrian Somers
2863efa11bbSBrian Somers.Ft int
2873efa11bbSBrian Somers.Fn PacketAliasIn "char *buffer" "int maxpacketsize"
2883efa11bbSBrian Somers
2893efa11bbSBrian SomersAn incoming packet coming from a remote machine to
2903efa11bbSBrian Somersthe local network is de-aliased by this function.
2913efa11bbSBrian SomersThe IP packet is pointed to by
2923efa11bbSBrian Somers.Em buffer ,
2933efa11bbSBrian Somersand
2943efa11bbSBrian Somers.Em maxpacketsize
2953efa11bbSBrian Somersindicates the size of the data structure containing
2963efa11bbSBrian Somersthe packet and should be at least as large as the
2973efa11bbSBrian Somersactual packet size.
2983efa11bbSBrian Somers
2993efa11bbSBrian SomersReturn codes:
3003efa11bbSBrian Somers.Bl -hang -offset left
3013efa11bbSBrian Somers.It PKT_ALIAS_ERROR.
3023efa11bbSBrian SomersAn internal error within the packet aliasing
3039c727d2cSJoseph Koshyengine occurred.
3043efa11bbSBrian Somers.It PKT_ALIAS_OK.
3053efa11bbSBrian SomersThe packet aliasing process was successful.
3063efa11bbSBrian Somers.It PKT_ALIAS_IGNORED.
3073efa11bbSBrian SomersThe packet was ignored and not de-aliased.
3083efa11bbSBrian SomersThis can happen if the protocal is unrecognized,
3093efa11bbSBrian Somerspossibly an ICMP message type is not handled or
3103efa11bbSBrian Somersif incoming packets for new connections are being
3113efa11bbSBrian Somersignored (see PKT_ALIAS_DENY_INCOMING in section
3123efa11bbSBrian Somers2.2).
3133efa11bbSBrian Somers.It PKT_ALIAS_UNRESOLVED_FRAGMENT.
3143efa11bbSBrian SomersThis is returned when a fragment cannot be
3153efa11bbSBrian Somersresolved because the header fragment has not
3163efa11bbSBrian Somersbeen sent yet.  In this situation, fragments
3173efa11bbSBrian Somersmust be saved with PacketAliasSaveFragment()
3183efa11bbSBrian Somersuntil a header fragment is found.
3193efa11bbSBrian Somers.It PKT_ALIAS_FOUND_HEADER_FRAGMENT.
3203efa11bbSBrian SomersThe packet aliasing process was successful,
3213efa11bbSBrian Somersand a header fragment was found.  This is a
3223efa11bbSBrian Somerssignal to retrieve any unresolved fragments
3233efa11bbSBrian Somerswith PacketAliasGetFragment() and de-alias
3243efa11bbSBrian Somersthem with PacketAliasFragmentIn().
3253efa11bbSBrian Somers.El
3263efa11bbSBrian Somers.Ss 3.2 PacketAliasOut()
3273efa11bbSBrian Somers
3283efa11bbSBrian Somers.Ft int
329b2052ac8SJohn Polstra.Fn PacketAliasOut "char *buffer" "int maxpacketsize"
3303efa11bbSBrian Somers
3313efa11bbSBrian SomersAn outgoing packet coming from the local network
3323efa11bbSBrian Somersto a remote machine is aliased by this function.
3333efa11bbSBrian SomersThe IP packet is pointed to by
3343efa11bbSBrian Somers.Em buffer r,
3353efa11bbSBrian Somersand
3363efa11bbSBrian Somers.Em maxpacketsize
3379c727d2cSJoseph Koshyindicates the maximum packet size permissible
3383efa11bbSBrian Somersshould the packet length be changed.  IP encoding
3399c727d2cSJoseph Koshyprotocols place address and port information in
3403efa11bbSBrian Somersthe encapsulated data stream which have to be
3413efa11bbSBrian Somersmodified and can account for changes in packet
3423efa11bbSBrian Somerslength.  Well known examples of such protocols
3438ddc51bcSEivind Eklundare FTP and IRC DCC.
3443efa11bbSBrian Somers
3453efa11bbSBrian SomersReturn codes:
3463efa11bbSBrian Somers.Bl -hang -offset left
3473efa11bbSBrian Somers.It PKT_ALIAS_ERROR.
3483efa11bbSBrian SomersAn internal error within the packet aliasing
3499c727d2cSJoseph Koshyengine occurred.
3503efa11bbSBrian Somers.It PKT_ALIAS_OK.
3513efa11bbSBrian SomersThe packet aliasing process was successful.
3523efa11bbSBrian Somers.It PKT_ALIAS_IGNORED.
3533efa11bbSBrian SomersThe packet was ignored and not de-aliased.
3543efa11bbSBrian SomersThis can happen if the protocal is unrecognized,
3553efa11bbSBrian Somersor possibly an ICMP message type is not handled.
3563efa11bbSBrian Somers.El
3573efa11bbSBrian Somers
3583efa11bbSBrian Somers.Sh 4. Port and Address Redirection
3593efa11bbSBrian SomersThe functions described in this section allow machines
3603efa11bbSBrian Somerson the local network to be accessible in some degree
3613efa11bbSBrian Somersto new incoming connections from the external network.
3623efa11bbSBrian SomersIndividual ports can be re-mapped or static network
3633efa11bbSBrian Somersaddress translations can be designated.
3643efa11bbSBrian Somers.Ss 4.1 PacketAliasRedirectPort()
3653efa11bbSBrian Somers
3663efa11bbSBrian Somers.Ft struct alias_link *
3673efa11bbSBrian Somers.Fo PacketAliasRedirectPort
3683efa11bbSBrian Somers.Fa "struct in_addr local_addr"
3693efa11bbSBrian Somers.Fa "u_short local_port"
3703efa11bbSBrian Somers.Fa "struct in_addr remote_addr"
3713efa11bbSBrian Somers.Fa "u_short remote_port"
3723efa11bbSBrian Somers.Fa "struct in_addr alias_addr"
3733efa11bbSBrian Somers.Fa "u_short alias_port"
3743efa11bbSBrian Somers.Fa "u_char proto"
3753efa11bbSBrian Somers.Fc
3763efa11bbSBrian Somers
3773efa11bbSBrian SomersThis function specifies that traffic from a
3783efa11bbSBrian Somersgiven remote address/port to an alias address/port
3793efa11bbSBrian Somersbe redirected to a specified local address/port.
3809c727d2cSJoseph KoshyThe parameter
3813efa11bbSBrian Somers.Em proto
3823efa11bbSBrian Somerscan be either IPPROTO_TCP or IPPROTO_UDP, as
3833efa11bbSBrian Somersdefined in <netinet/in.h>.
3843efa11bbSBrian Somers
3853efa11bbSBrian SomersIf
3863efa11bbSBrian Somers.Em local_addr
3873efa11bbSBrian Somersor
3883efa11bbSBrian Somers.Em alias_addr
3893efa11bbSBrian Somersis zero, this indicates that the packet aliasing
3903efa11bbSBrian Somersaddress as established by PacketAliasSetAddress()
3913efa11bbSBrian Somersis to be used.  Even if PacketAliasAddress() is
3923efa11bbSBrian Somerscalled to change the address after PacketAliasRedirectPort()
3933efa11bbSBrian Somersis called, a zero reference will track this change.
3943efa11bbSBrian Somers
3953efa11bbSBrian SomersIf
3963efa11bbSBrian Somers.Em remote_addr
3973efa11bbSBrian Somersis zero, this indicates to redirect packets from
3983efa11bbSBrian Somersany remote address.  Likewise, if
3993efa11bbSBrian Somers.Em remote_port
4003efa11bbSBrian Somersis zero, this indicates to redirect packets originating
4013efa11bbSBrian Somersfrom any remote port number.  Almost always, the remote
4023efa11bbSBrian Somersport specification will be zero, but non-zero remote
4033efa11bbSBrian Somersaddresses can be sometimes be useful for firewalling.
4043efa11bbSBrian SomersIf two calls to PacketAliasRedirectPort() overlap in
4053efa11bbSBrian Somerstheir address/port specifications, then the most recent
4063efa11bbSBrian Somerscall will have precedence.
4073efa11bbSBrian Somers
4083efa11bbSBrian SomersThis function returns a pointer which can subsequently
4093efa11bbSBrian Somersbe used by PacketAliasRedirectDelete().  If NULL is
4103efa11bbSBrian Somersreturned, then the function call did not complete
4113efa11bbSBrian Somerssuccessfully.
4123efa11bbSBrian Somers
4133efa11bbSBrian SomersAll port numbers are in network address byte order,
4143efa11bbSBrian Somersso it is necessary to use htons() to convert these
4153efa11bbSBrian Somersparameters from internally readable numbers to
4163efa11bbSBrian Somersnetwork byte order.  Addresses are also in network
4173efa11bbSBrian Somersbyte order, which is implicit in the use of the
4183efa11bbSBrian Somers.Em struct in_addr
4193efa11bbSBrian Somersdata type.
4203efa11bbSBrian Somers.Ss 4.2 PacketAliasRedirectAddr()
4213efa11bbSBrian Somers
4223efa11bbSBrian Somers.Ft struct alias_link *
423442a25bdSBruce Evans.Fo PacketAliasRedirectAddr
4243efa11bbSBrian Somers.Fa "struct in_addr local_addr"
4253efa11bbSBrian Somers.Fa "struct in_addr alias_addr"
4263efa11bbSBrian Somers.Fc
4273efa11bbSBrian Somers
4283efa11bbSBrian SomersThis function desgnates that all incoming
4293efa11bbSBrian Somerstraffic to
4303efa11bbSBrian Somers.Em alias_addr
4313efa11bbSBrian Somersbe redirected to
4323efa11bbSBrian Somers.Em local_addr.
4333efa11bbSBrian SomersSimilarly, all outgoing traffic from
4343efa11bbSBrian Somers.Em local_addr
4353efa11bbSBrian Somersis aliased to
4363efa11bbSBrian Somers.Em alias_addr .
4373efa11bbSBrian Somers
4383efa11bbSBrian SomersIf
4393efa11bbSBrian Somers.Em local_addr
4403efa11bbSBrian Somersor
4413efa11bbSBrian Somers.Em alias_addr
4423efa11bbSBrian Somersis zero, this indicates that the packet aliasing
4433efa11bbSBrian Somersaddress as established by PacketAliasSetAddress()
4443efa11bbSBrian Somersis to be used.  Even if PacketAliasAddress() is
4453efa11bbSBrian Somerscalled to change the address after PacketAliasRedirectAddr()
4463efa11bbSBrian Somersis called, a zero reference will track this change.
4473efa11bbSBrian Somers
4483efa11bbSBrian SomersIf subsequent calls to PacketAliasRedirectAddr()
4493efa11bbSBrian Somersuse the same aliasing address, all new incoming
4503efa11bbSBrian Somerstraffic to this aliasing address will be redirected
4513efa11bbSBrian Somersto the local address made in the last function call,
4523efa11bbSBrian Somersbut new traffic all of the local machines designated
4533efa11bbSBrian Somersin the several function calls will be aliased to
4543efa11bbSBrian Somersthe same address.  Consider the following example:
4553efa11bbSBrian Somers.Bd -literal -offset left
4563efa11bbSBrian Somers    PacketAliasRedirectAddr(inet_aton("192.168.0.2"),
4573efa11bbSBrian Somers                            inet_aton("141.221.254.101"));
4583efa11bbSBrian Somers    PacketAliasRedirectAddr(inet_aton("192.168.0.3"),
4593efa11bbSBrian Somers                            inet_aton("141.221.254.101"));
4603efa11bbSBrian Somers    PacketAliasRedirectAddr(inet_aton("192.168.0.4"),
4613efa11bbSBrian Somers                            inet_aton("141.221.254.101"));
4623efa11bbSBrian Somers.Ed
4633efa11bbSBrian Somers
4643efa11bbSBrian SomersAny outgoing connections such as telnet or ftp
4653efa11bbSBrian Somersfrom 192.168.0.2, 102.168.0.3, 192.168.0.4 will
4663efa11bbSBrian Somersappear to come from 141.221.254.101.  Any incoming
4673efa11bbSBrian Somersconnections to 141.221.254.101 will be directed
4683efa11bbSBrian Somersto 192.168.0.4.
4693efa11bbSBrian Somers
4703efa11bbSBrian SomersAny calls to PacketAliasRedirectPort() will
4713efa11bbSBrian Somershave precedence over address mappings designated
4723efa11bbSBrian Somersby PacketAliasRedirectAddr().
4733efa11bbSBrian Somers
4743efa11bbSBrian SomersThis function returns a pointer which can subsequently
4753efa11bbSBrian Somersbe used by PacketAliasRedirectDelete().  If NULL is
4763efa11bbSBrian Somersreturned, then the function call did not complete
4773efa11bbSBrian Somerssuccessfully.
4783efa11bbSBrian Somers.Ss 4.3 PacketAliasRedirectDelete()
4793efa11bbSBrian Somers
4803efa11bbSBrian Somers.Ft void
4813efa11bbSBrian Somers.Fn PacketAliasRedirectDelete "struct alias_link *ptr"
4823efa11bbSBrian Somers
4833efa11bbSBrian SomersThis function will delete a specific static redirect
4843efa11bbSBrian Somersrule entered by PacketAliasRedirectPort() or
4853efa11bbSBrian SomersPacketAliasRedirectAddr().  The parameter
4863efa11bbSBrian Somers.Em ptr
4873efa11bbSBrian Somersis the pointer returned by either of the redirection
4883efa11bbSBrian Somersfunctions.  If an invalid pointer is passed to
4893efa11bbSBrian SomersPacketAliasRedirectDelete(), then a program crash
4903efa11bbSBrian Somersor unpredictable operation could result, so it is
4913efa11bbSBrian Somersnecessary to be careful using this function.
4923efa11bbSBrian Somers
4933efa11bbSBrian Somers.Sh 5. Fragment Handling
4943efa11bbSBrian SomersThe functions in this section are used to deal with
4953efa11bbSBrian Somersincoming fragments.
4963efa11bbSBrian Somers
4973efa11bbSBrian SomersOutgoing fragments are handled within PacketAliasOut()
4983efa11bbSBrian Somersby changing the address according to any
4993efa11bbSBrian Somersapplicable mapping set by PacketAliasRedirectAddress(),
5003efa11bbSBrian Somersor the default aliasing address set by
5013efa11bbSBrian SomersPacketAliasSetAddress().
5023efa11bbSBrian Somers
5033efa11bbSBrian SomersIncoming fragments are handled in one of two ways.
5043efa11bbSBrian SomersIf the header of a fragmented IP packet has already
5053efa11bbSBrian Somersbeen seen, then all subsequent fragments will be
5063efa11bbSBrian Somersre-mapped in the same manner the header fragment
5073efa11bbSBrian Somerswas.  Fragments which arrive before the header
5083efa11bbSBrian Somersare saved and then retrieved once the header fragment
5093efa11bbSBrian Somershas been resolved.
510619d1a30SBrian Somers.Ss 4.4 PacketAliasProxyRule()
511619d1a30SBrian Somers
512619d1a30SBrian Somers.Ft int
513619d1a30SBrian Somers.Fn PacketAliasProxyRule "char *cmd"
514619d1a30SBrian Somers
515619d1a30SBrian SomersThe passed
516619d1a30SBrian Somers.Ar cmd
517619d1a30SBrian Somersstring consists of one or more pairs of words.  The first word in each
518619d1a30SBrian Somerspair is a token and the second is the value that should be applied for
519619d1a30SBrian Somersthat token.  Tokens and their argument types are as follows:
520619d1a30SBrian Somers
521619d1a30SBrian Somers.Bl -tag -offset XXX -width XXX
522619d1a30SBrian Somers.It type encode_ip_hdr|encode_tcp_stream|no_encode
523619d1a30SBrian SomersIn order to support transparent proxying, it is necessary to somehow
524619d1a30SBrian Somerspass the original address and port information into the new destination
525619d1a30SBrian Somersserver.  If
526619d1a30SBrian Somers.Dq encode_ip_hdr
527619d1a30SBrian Somersis specified, the original address and port is passed as an extra IP
528619d1a30SBrian Somersoption.  If
529619d1a30SBrian Somers.Dq encode_tcp_stream
530619d1a30SBrian Somersis specified, the original address and port is passed as the first
531619d1a30SBrian Somerspiece of data in the tcp stream in the format
532619d1a30SBrian Somers.Dq DEST Ar IP port .
533619d1a30SBrian Somers.It port Ar portnum
534619d1a30SBrian SomersOnly packets with the destination port
535619d1a30SBrian Somers.Ar portnum
536619d1a30SBrian Somersare proxied.
537619d1a30SBrian Somers.It server Ar host[:portnum]
538619d1a30SBrian SomersThis specifies the
539619d1a30SBrian Somers.Ar host
540619d1a30SBrian Somersand
541619d1a30SBrian Somers.Ar portnum
542619d1a30SBrian Somersthat the data is to be redirected to.  If
543619d1a30SBrian Somers.Ar portnum
544619d1a30SBrian Somersis not specified, the destination port number is not changed.
545619d1a30SBrian Somers.Pp
546619d1a30SBrian SomersThe
547619d1a30SBrian Somers.Ar server
548619d1a30SBrian Somersspecification is mandatory unless the
549619d1a30SBrian Somers.Dq delete
550619d1a30SBrian Somerscommand is being used.
551619d1a30SBrian Somers.It rule Ar index
552619d1a30SBrian SomersNormally, each call to
553619d1a30SBrian Somers.Fn PacketAliasProxyRule
554619d1a30SBrian Somersinserts the next rule at the start of a linear list of rules.  If an
555619d1a30SBrian Somers.Ar index
556619d1a30SBrian Somersis specified, the new rule will be checked after all rules with lower
557619d1a30SBrian Somersindices.  Calls to
558619d1a30SBrian Somers.Fn PacketAliasProxyRule
559619d1a30SBrian Somersthat do not specify a rule are assigned rule 0.
560619d1a30SBrian Somers.It delete Ar index
561619d1a30SBrian SomersThis token and its argument must not be used with any other tokens.  When
562619d1a30SBrian Somersused, all existing rules with the given
563619d1a30SBrian Somers.Ar index
564619d1a30SBrian Somersare deleted.
565619d1a30SBrian Somers.It proto tcp|udp
566619d1a30SBrian SomersIf specified, only packets of the given protocol type are matched.
567619d1a30SBrian Somers.It src Ar IP[/bits]
568619d1a30SBrian SomersIf specified, only packets with a source address matching the given
569619d1a30SBrian Somers.Ar IP
570619d1a30SBrian Somersare matched.  If
571619d1a30SBrian Somers.Ar bits
572619d1a30SBrian Somersis also specified, then the first
573619d1a30SBrian Somers.Ar bits
574619d1a30SBrian Somersbits of
575619d1a30SBrian Somers.Ar IP
576619d1a30SBrian Somersare taken as a network specification, and all IP addresses from that
577619d1a30SBrian Somersnetwork will be matched.
578619d1a30SBrian Somers.It dest Ar IP[/bits]
579619d1a30SBrian SomersIf specified, only packets with a destination address matching the given
580619d1a30SBrian Somers.Ar IP
581619d1a30SBrian Somersare matched.  If
582619d1a30SBrian Somers.Ar bits
583619d1a30SBrian Somersis also specified, then the first
584619d1a30SBrian Somers.Ar bits
585619d1a30SBrian Somersbits of
586619d1a30SBrian Somers.Ar IP
587619d1a30SBrian Somersare taken as a network specification, and all IP addresses from that
588619d1a30SBrian Somersnetwork will be matched.
589619d1a30SBrian Somers.El
590619d1a30SBrian Somers
591619d1a30SBrian SomersThis function is usually used to redirect outgoing connections for
592619d1a30SBrian Somersinternal machines that are not permitted certain types of internet
593619d1a30SBrian Somersaccess, or to restrict access to certain external machines.
594619d1a30SBrian Somers
5953efa11bbSBrian Somers.Ss 5.1 PacketAliasSaveFragment()
5963efa11bbSBrian Somers
5973efa11bbSBrian Somers.Ft int
5983efa11bbSBrian Somers.Fn PacketAliasSaveFragment "char *ptr"
5993efa11bbSBrian Somers
6003efa11bbSBrian SomersWhen PacketAliasIn() returns
6013efa11bbSBrian SomersPKT_ALIAS_UNRESOLVED_FRAGMENT, this
6023efa11bbSBrian Somersfunction can be used to save the pointer to
6033efa11bbSBrian Somersthe unresolved fragment.
6043efa11bbSBrian Somers
6053efa11bbSBrian SomersIt is implicitly assumed that
6063efa11bbSBrian Somers.Em ptr
6073efa11bbSBrian Somerspoints to a block of memory allocated by
6083efa11bbSBrian Somersmalloc().  If the fragment is never
6093efa11bbSBrian Somersresolved, the packet aliasing engine will
6103efa11bbSBrian Somersautomatically free the memory after a
6113efa11bbSBrian Somerstimeout period. [Eventually this function
6123efa11bbSBrian Somersshould be modified so that a callback
6133efa11bbSBrian Somersfunction for freeing memory is passed as
6143efa11bbSBrian Somersan argument.]
6153efa11bbSBrian Somers
6163efa11bbSBrian SomersThis function returns PKT_ALIAS_OK if it
6173efa11bbSBrian Somerswas successful and PKT_ALIAS_ERROR if there
6183efa11bbSBrian Somerswas an error.
619619d1a30SBrian Somers
620619d1a30SBrian Somers.Ss 5.2 PacketAliasGetFragment()
6213efa11bbSBrian Somers
6223efa11bbSBrian Somers.Ft char *
6233efa11bbSBrian Somers.Fn PacketAliasGetFragment "char *buffer"
6243efa11bbSBrian Somers
6253efa11bbSBrian SomersThis function can be used to retrieve fragment
6263efa11bbSBrian Somerspointers saved by PacketAliasSaveFragment().
6273efa11bbSBrian SomersThe IP header fragment pointed to by
6283efa11bbSBrian SomersEm buffer
6293efa11bbSBrian Somersis the header fragment indicated when
6303efa11bbSBrian SomersPacketAliasIn() returns PKT_ALIAS_FOUND_HEADER_FRAGMENT.
6313efa11bbSBrian SomersOnce a a fragment pointer is retrieved, it
6323efa11bbSBrian Somersbecomes the calling program's responsibility
6333efa11bbSBrian Somersto free the dynamically allocated memory for
6343efa11bbSBrian Somersthe fragment.
6353efa11bbSBrian Somers
6363efa11bbSBrian SomersPacketAliasGetFragment() can be called
6373efa11bbSBrian Somerssequentially until there are no more fragments
6383efa11bbSBrian Somersavailable, at which time it returns NULL.
6393efa11bbSBrian Somers.Ss 5.3 PacketAliasFragmentIn()
6403efa11bbSBrian Somers
6413efa11bbSBrian Somers.Ft void
6423efa11bbSBrian Somers.Fn PacketAliasFragmentIn "char *header" "char *fragment"
6433efa11bbSBrian Somers
6443efa11bbSBrian SomersWhen a fragment is retrieved with
6453efa11bbSBrian SomersPacketAliasGetFragment(), it can then be
6463efa11bbSBrian Somersde-aliased with a call to PacketAliasFragmentIn().
6473efa11bbSBrian Somers.Em header
6483efa11bbSBrian Somersis the pointer to a header fragment used as a
6493efa11bbSBrian Somerstemplate, and
6503efa11bbSBrian Somers.Em fragment
6513efa11bbSBrian Somersis the pointer to the packet to be de-aliased.
6523efa11bbSBrian Somers
6533efa11bbSBrian Somers.Sh 6. Miscellaneous Functions
6543efa11bbSBrian Somers
6553efa11bbSBrian Somers.Ss 6.1 PacketAliasSetTarget()
6563efa11bbSBrian Somers
6573efa11bbSBrian Somers.Ft void
6583efa11bbSBrian Somers.Fn PacketAliasSetTarget "struct in_addr addr"
6593efa11bbSBrian Somers
6603efa11bbSBrian SomersWhen an incoming packet not associated with
6613efa11bbSBrian Somersany pre-existing aliasing link arrives at the
6623efa11bbSBrian Somershost machine, it will be sent to the address
6633efa11bbSBrian Somersindicated by a call to PacketAliasSetTarget().
6643efa11bbSBrian Somers
6653efa11bbSBrian SomersIf this function is not called, or is called
6663efa11bbSBrian Somerswith a zero address argument, then all new
6673efa11bbSBrian Somersincoming packets go to the address set by
6683efa11bbSBrian SomersPacketAliasSetAddress.
6693efa11bbSBrian Somers.Ss 6.2 PacketAliasCheckNewLink()
6703efa11bbSBrian Somers
6713efa11bbSBrian Somers.Ft int
6723efa11bbSBrian Somers.Fn PacketAliasCheckNewLink "void"
6733efa11bbSBrian Somers
6743efa11bbSBrian SomersThis function returns a non-zero value when
6753efa11bbSBrian Somersa new aliasing link is created.  In circumstances
6763efa11bbSBrian Somerswhere incoming traffic is being sequentially
6773efa11bbSBrian Somerssent to different local servers, this function
6783efa11bbSBrian Somerscan be used to trigger when PacketAliasSetTarget()
6793efa11bbSBrian Somersis called to change the default target address.
6803efa11bbSBrian Somers.Ss 6.3 PacketAliasInternetChecksum()
6813efa11bbSBrian Somers
6823efa11bbSBrian Somers.Ft u_short
683442a25bdSBruce Evans.Fn PacketAliasInternetChecksum "u_short *buffer" "int nbytes"
6843efa11bbSBrian Somers
6853efa11bbSBrian SomersThis is a utility function that does not seem
6863efa11bbSBrian Somersto be available elswhere and is included as a
6873efa11bbSBrian Somersconvenience.  It computes the internet checksum,
6883efa11bbSBrian Somerswhich is used in both IP and protocol-specific
6893efa11bbSBrian Somersheaders (TCP, UDP, ICMP).
6903efa11bbSBrian Somers
6913efa11bbSBrian Somers.Em buffer
6923efa11bbSBrian Somerspoints to the data block to be checksummed, and
6933efa11bbSBrian Somers.Em nbytes
6943efa11bbSBrian Somersis the number of bytes.  The 16-bit checksum
6953efa11bbSBrian Somersfield should be zeroed before computing the checksum.
6963efa11bbSBrian Somers
6973efa11bbSBrian SomersChecksums can also be verified by operating on a block
6983efa11bbSBrian Somersof data including its checksum.  If the checksum is
6993efa11bbSBrian Somersvalid, PacketAliasInternetChecksum() will return zero.
7003efa11bbSBrian Somers
7013efa11bbSBrian Somers.Sh 7. Authors
70259354a4eSBrian SomersCharles Mott (cmott@srv.net), versions 1.0 - 1.8, 2.0 - 2.4.
7033efa11bbSBrian Somers
7048ddc51bcSEivind EklundEivind Eklund (eivind@freebsd.org), versions 1.8b, 1.9 and
7058ddc51bcSEivind Eklund2.5.  Added IRC DCC support as well as contributing a number of
7068ddc51bcSEivind Eklundarchitectural improvements; added the firewall bypass
7078ddc51bcSEivind Eklundfor FTP/IRC DCC.
7083efa11bbSBrian Somers
7093efa11bbSBrian Somers.Sh 8. Acknowledgments
7103efa11bbSBrian Somers
7113efa11bbSBrian SomersListed below, in approximate chronological
7123efa11bbSBrian Somersorder, are individuals who have provided
7133efa11bbSBrian Somersvaluable comments and/or debugging assistance.
7143efa11bbSBrian Somers
7153efa11bbSBrian Somers.Bl -inset -compact -offset left
7163efa11bbSBrian Somers.It Gary Roberts
7173efa11bbSBrian Somers.It Tom Torrance
7183efa11bbSBrian Somers.It Reto Burkhalter
7193efa11bbSBrian Somers.It Martin Renters
7203efa11bbSBrian Somers.It Brian Somers
7213efa11bbSBrian Somers.It Paul Traina
7223efa11bbSBrian Somers.It Ari Suutari
7233efa11bbSBrian Somers.It Dave Remien
7243efa11bbSBrian Somers.It J. Fortes
7253efa11bbSBrian Somers.It Andrzej Bialeki
7264fe071a9SBrian Somers.It Gordon Burditt
7273efa11bbSBrian Somers.El
7283efa11bbSBrian Somers
7293efa11bbSBrian Somers.Sh Appendix: Conceptual Background
7303efa11bbSBrian SomersThis appendix is intended for those who
7313efa11bbSBrian Somersare planning to modify the source code or want
7323efa11bbSBrian Somersto create somewhat esoteric applications using
7333efa11bbSBrian Somersthe packet aliasing functions.
7343efa11bbSBrian Somers
7353efa11bbSBrian SomersThe conceptual framework under which the
7363efa11bbSBrian Somerspacket aliasing engine operates is described here.
7373efa11bbSBrian SomersCentral to the discussion is the idea of an
7383efa11bbSBrian Somers"aliasing link" which  describes the relationship
7393efa11bbSBrian Somersfor a given packet transaction between the local
7403efa11bbSBrian Somersmachine, aliased identity and remote machine.  It
7413efa11bbSBrian Somersis discussed how such links come into existence
7423efa11bbSBrian Somersand are destroyed.
7433efa11bbSBrian Somers.Ss A.1 Aliasing Links
7443efa11bbSBrian SomersThere is a notion of an "aliasing link",
7453efa11bbSBrian Somerswhich is 7-tuple describing a specific
7463efa11bbSBrian Somerstranslation:
7473efa11bbSBrian Somers.Bd -literal -offset indent
7483efa11bbSBrian Somers(local addr, local port, alias addr, alias port,
7493efa11bbSBrian Somers remote addr, remote port, protocol)
7503efa11bbSBrian Somers.Ed
7513efa11bbSBrian Somers
7523efa11bbSBrian SomersOutgoing packets have the local address and
7533efa11bbSBrian Somersport number replaced with the alias address
7543efa11bbSBrian Somersand port number.  Incoming packets undergo the
7553efa11bbSBrian Somersreverse process.  The packet aliasing engine
7563efa11bbSBrian Somersattempts to match packets against an internal
7573efa11bbSBrian Somerstable of aliasing links to determine how to
7583efa11bbSBrian Somersmodify a given IP packet.  Both the IP
7593efa11bbSBrian Somersheader and protocol dependent headers are
7603efa11bbSBrian Somersmodified as necessary.  Aliasing links are
7613efa11bbSBrian Somerscreated and deleted as necessary according
7623efa11bbSBrian Somersto network traffic.
7633efa11bbSBrian Somers
7643efa11bbSBrian SomersProtocols can be TCP, UDP or even ICMP in
7653efa11bbSBrian Somerscertain circumstances.  (Some types of ICMP
7663efa11bbSBrian Somerspackets can be aliased according to sequence
7673efa11bbSBrian Somersor id number which acts as an equivalent port
7683efa11bbSBrian Somersnumber for identifying how individual packets
7693efa11bbSBrian Somersshould be handled.)
7703efa11bbSBrian Somers
7713efa11bbSBrian SomersEach aliasing link must have a unique
7729c727d2cSJoseph Koshycombination of the following five quantities:
7733efa11bbSBrian Somersalias address/port, remote address/port
7743efa11bbSBrian Somersand protocol.  This ensures that several
7753efa11bbSBrian Somersmachines on a local network can share the
7763efa11bbSBrian Somerssame aliased IP address.  In cases where
7773efa11bbSBrian Somersconflicts might arise, the aliasing port
7783efa11bbSBrian Somersis chosen so that uniqueness is maintained.
7793efa11bbSBrian Somers.Ss A.2 Static and Dynamic Links
7803efa11bbSBrian SomersAliasing links can either be static or dynamic.
7813efa11bbSBrian SomersStatic links persist indefinitely and represent
7823efa11bbSBrian Somersfixed rules for translating IP packets.  Dynamic
7833efa11bbSBrian Somerslinks come into existence for a specific TCP
7843efa11bbSBrian Somersconnection or UDP transaction or ICMP echo
7853efa11bbSBrian Somerssequence.  For the case of TCP, the connection
7863efa11bbSBrian Somerscan be monitored to see when the associated
7873efa11bbSBrian Somersaliasing link should be deleted.  Aliasing links
7883efa11bbSBrian Somersfor UDP transactions (and ICMP echo and timestamp
7899c727d2cSJoseph Koshyrequests) work on a simple timeout rule.  When
7903efa11bbSBrian Somersno activity is observed on a dynamic link for
7913efa11bbSBrian Somersa certain amount of time it is automatically
7923efa11bbSBrian Somersdeleted.  Timeout rules also apply to TCP
7933efa11bbSBrian Somersconnections which do not open or close
7943efa11bbSBrian Somersproperly.
7953efa11bbSBrian Somers.Ss A.3 Partially Specified Aliasing Links
7963efa11bbSBrian SomersAliasing links can be partially specified,
7973efa11bbSBrian Somersmeaning that the remote address and/or remote
7989c727d2cSJoseph Koshyports are unknown.  In this case, when a packet
7993efa11bbSBrian Somersmatching the incomplete specification is found,
8003efa11bbSBrian Somersa fully specified dynamic link is created.  If
8013efa11bbSBrian Somersthe original partially specified link is dynamic,
8023efa11bbSBrian Somersit will be deleted after the fully specified link
8033efa11bbSBrian Somersis created, otherwise it will persist.
8043efa11bbSBrian Somers
8053efa11bbSBrian SomersFor instance, a partially specified link might
8063efa11bbSBrian Somersbe
8073efa11bbSBrian Somers.Bd -literal -offset indent
8083efa11bbSBrian Somers(192.168.0.4, 23, 204.228.203.215, 8066, 0, 0, tcp)
8093efa11bbSBrian Somers.Ed
8103efa11bbSBrian Somers
8113efa11bbSBrian SomersThe zeros denote unspecified components for
8123efa11bbSBrian Somersthe remote address and port.  If this link were
8133efa11bbSBrian Somersstatic it would have the effect of redirecting
8143efa11bbSBrian Somersall incoming traffic from port 8066 of
8153efa11bbSBrian Somers204.228.203.215 to port 23 (telnet) of machine
8163efa11bbSBrian Somers192.168.0.4 on the local network.  Each
8173efa11bbSBrian Somersindividual telnet connection would initiate
8183efa11bbSBrian Somersthe creation of a distinct dynamic link.
8193efa11bbSBrian Somers.Ss A.4 Dynamic Link Creation
8203efa11bbSBrian SomersIn addition to aliasing links, there are
8213efa11bbSBrian Somersalso address mappings that can be stored
8223efa11bbSBrian Somerswithin the internal data table of the packet
8233efa11bbSBrian Somersaliasing mechanism.
8243efa11bbSBrian Somers.Bd -literal -offset indent
8253efa11bbSBrian Somers(local addr, alias addr)
8263efa11bbSBrian Somers.Ed
8273efa11bbSBrian Somers
8283efa11bbSBrian SomersAddress mappings are searched when creating
8293efa11bbSBrian Somersnew dynamic links.
8303efa11bbSBrian Somers
8313efa11bbSBrian SomersAll outgoing packets from the local network
8323efa11bbSBrian Somersautomatically create a dynamic link if
8333efa11bbSBrian Somersthey do not match an already existing fully
8343efa11bbSBrian Somersspecified link.  If an address mapping exists
8353efa11bbSBrian Somersfor the the outgoing packet, this determines
8363efa11bbSBrian Somersthe alias address to be used.  If no mapping
8373efa11bbSBrian Somersexists, then a default address, usually the
8383efa11bbSBrian Somersaddress of the packet aliasing host, is used.
8393efa11bbSBrian SomersIf necessary, this default address can be
8409c727d2cSJoseph Koshychanged as often as each individual packet
8413efa11bbSBrian Somersarrives.
8423efa11bbSBrian Somers
8433efa11bbSBrian SomersThe aliasing port number is determined
8443efa11bbSBrian Somerssuch that the new dynamic link does not
8453efa11bbSBrian Somersconflict with any existing links.  In the
8463efa11bbSBrian Somersdefault operating mode, the packet aliasing
8473efa11bbSBrian Somersengine attempts to set the aliasing port
8483efa11bbSBrian Somersequal to the local port number.  If this
8493efa11bbSBrian Somersresults in a conflict, then port numbers
8503efa11bbSBrian Somersare randomly chosen until a unique aliasing
8513efa11bbSBrian Somerslink can be established.  In an alternate
8523efa11bbSBrian Somersoperating mode, the first choice of an
8533efa11bbSBrian Somersaliasing port is also random and unrelated
8543efa11bbSBrian Somersto the local port number.
8553efa11bbSBrian Somers
856