1 /* lint -save -library Flexelint comment for external headers */ 2 3 /*- 4 * SPDX-License-Identifier: BSD-2-Clause 5 * 6 * Copyright (c) 2001 Charles Mott <cm@linktel.net> 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 31 /* 32 * Alias.h defines the outside world interfaces for the packet aliasing 33 * software. 34 * 35 * This software is placed into the public domain with no restrictions on its 36 * distribution. 37 */ 38 39 #ifndef _ALIAS_H_ 40 #define _ALIAS_H_ 41 42 #include <netinet/in_systm.h> 43 #include <netinet/in.h> 44 #include <netinet/ip.h> 45 46 #define LIBALIAS_BUF_SIZE 128 47 #ifdef _KERNEL 48 /* 49 * The kernel version of libalias does not support these features. 50 */ 51 #define NO_FW_PUNCH 52 #define NO_USE_SOCKETS 53 #endif 54 55 /* 56 * The external interface to libalias, the packet aliasing engine. 57 * 58 * There are two sets of functions: 59 * 60 * PacketAlias*() the old API which doesn't take an instance pointer 61 * and therefore can only have one packet engine at a time. 62 * 63 * LibAlias*() the new API which takes as first argument a pointer to 64 * the instance of the packet aliasing engine. 65 * 66 * The functions otherwise correspond to each other one for one, except 67 * for the LibAliasUnaliasOut()/PacketUnaliasOut() function which were 68 * were misnamed in the old API. 69 */ 70 71 /* 72 * The instance structure 73 */ 74 struct libalias; 75 76 /* 77 * An anonymous structure, a pointer to which is returned from 78 * PacketAliasRedirectAddr(), PacketAliasRedirectPort() or 79 * PacketAliasRedirectProto(), passed to PacketAliasAddServer(), 80 * and freed by PacketAliasRedirectDelete(). 81 */ 82 struct alias_link; 83 84 /* Initialization and control functions. */ 85 struct libalias *LibAliasInit(struct libalias *); 86 void LibAliasSetAddress(struct libalias *, struct in_addr _addr); 87 void LibAliasSetAliasPortRange(struct libalias *la, u_short port_low, u_short port_hi); 88 void LibAliasSetFWBase(struct libalias *, unsigned int _base, unsigned int _num); 89 void LibAliasSetSkinnyPort(struct libalias *, unsigned int _port); 90 unsigned int LibAliasSetMode(struct libalias *, unsigned int _flags, unsigned int _mask); 91 void LibAliasUninit(struct libalias *); 92 93 /* Packet Handling functions. */ 94 int LibAliasIn (struct libalias *, void *_ptr, int _maxpacketsize); 95 int LibAliasOut(struct libalias *, void *_ptr, int _maxpacketsize); 96 int LibAliasOutTry(struct libalias *, void *_ptr, int _maxpacketsize, int _create); 97 int LibAliasUnaliasOut(struct libalias *, void *_ptr, int _maxpacketsize); 98 99 /* Port and address redirection functions. */ 100 101 int LibAliasAddServer(struct libalias *, struct alias_link *_lnk, 102 struct in_addr _addr, unsigned short _port); 103 struct alias_link * LibAliasRedirectAddr(struct libalias *, struct in_addr _src_addr, 104 struct in_addr _alias_addr); 105 int LibAliasRedirectDynamic(struct libalias *, struct alias_link *_lnk); 106 void LibAliasRedirectDelete(struct libalias *, struct alias_link *_lnk); 107 struct alias_link * LibAliasRedirectPort(struct libalias *, struct in_addr _src_addr, 108 unsigned short _src_port, struct in_addr _dst_addr, 109 unsigned short _dst_port, struct in_addr _alias_addr, 110 unsigned short _alias_port, unsigned char _proto); 111 struct alias_link * LibAliasRedirectProto(struct libalias *, struct in_addr _src_addr, 112 struct in_addr _dst_addr, struct in_addr _alias_addr, 113 unsigned char _proto); 114 115 /* Fragment Handling functions. */ 116 void LibAliasFragmentIn(struct libalias *, void *_ptr, void *_ptr_fragment); 117 void *LibAliasGetFragment(struct libalias *, void *_ptr); 118 int LibAliasSaveFragment(struct libalias *, void *_ptr); 119 120 /* Miscellaneous functions. */ 121 unsigned short LibAliasInternetChecksum(struct libalias *, unsigned short *_ptr, int _nbytes); 122 void LibAliasSetTarget(struct libalias *, struct in_addr _target_addr); 123 124 /* never used and never worked, to be removed in FreeBSD 14 */ 125 int LibAliasCheckNewLink(struct libalias *); 126 127 /* Transparent proxying routines. */ 128 int LibAliasProxyRule(struct libalias *, const char *_cmd); 129 130 /* Module handling API */ 131 int LibAliasLoadModule(char *); 132 int LibAliasUnLoadAllModule(void); 133 int LibAliasRefreshModules(void); 134 135 /* Mbuf helper function. */ 136 struct mbuf *m_megapullup(struct mbuf *, int); 137 138 /* 139 * Mode flags and other constants. 140 */ 141 142 /* Mode flags, set using PacketAliasSetMode() */ 143 144 /* 145 * If PKT_ALIAS_LOG is set, a message will be printed to /var/log/alias.log 146 * every time a link is created or deleted. This is useful for debugging. 147 */ 148 #define PKT_ALIAS_LOG 0x01 149 150 /* 151 * If PKT_ALIAS_DENY_INCOMING is set, then incoming connections (e.g. to ftp, 152 * telnet or web servers will be prevented by the aliasing mechanism. 153 */ 154 #define PKT_ALIAS_DENY_INCOMING 0x02 155 156 /* 157 * If PKT_ALIAS_SAME_PORTS is set, packets will be attempted sent from the 158 * same port as they originated on. This allows e.g. rsh to work *99% of the 159 * time*, but _not_ 100% (it will be slightly flakey instead of not working 160 * at all). This mode bit is set by PacketAliasInit(), so it is a default 161 * mode of operation. 162 */ 163 #define PKT_ALIAS_SAME_PORTS 0x04 164 165 /* 166 * If PKT_ALIAS_USE_SOCKETS is set, then when partially specified links (e.g. 167 * destination port and/or address is zero), the packet aliasing engine will 168 * attempt to allocate a socket for the aliasing port it chooses. This will 169 * avoid interference with the host machine. Fully specified links do not 170 * require this. This bit is set after a call to PacketAliasInit(), so it is 171 * a default mode of operation. 172 */ 173 #ifndef NO_USE_SOCKETS 174 #define PKT_ALIAS_USE_SOCKETS 0x08 175 #endif 176 /*- 177 * If PKT_ALIAS_UNREGISTERED_ONLY is set, then only packets with 178 * unregistered source addresses will be aliased. Private 179 * addresses are those in the following ranges: 180 * 181 * 10.0.0.0 -> 10.255.255.255 182 * 172.16.0.0 -> 172.31.255.255 183 * 192.168.0.0 -> 192.168.255.255 184 */ 185 #define PKT_ALIAS_UNREGISTERED_ONLY 0x10 186 187 /* 188 * If PKT_ALIAS_RESET_ON_ADDR_CHANGE is set, then the table of dynamic 189 * aliasing links will be reset whenever PacketAliasSetAddress() changes the 190 * default aliasing address. If the default aliasing address is left 191 * unchanged by this function call, then the table of dynamic aliasing links 192 * will be left intact. This bit is set after a call to PacketAliasInit(). 193 */ 194 #define PKT_ALIAS_RESET_ON_ADDR_CHANGE 0x20 195 196 /* 197 * If PKT_ALIAS_PROXY_ONLY is set, then NAT will be disabled and only 198 * transparent proxying is performed. 199 */ 200 #define PKT_ALIAS_PROXY_ONLY 0x40 201 202 /* 203 * If PKT_ALIAS_REVERSE is set, the actions of PacketAliasIn() and 204 * PacketAliasOut() are reversed. 205 */ 206 #define PKT_ALIAS_REVERSE 0x80 207 208 #ifndef NO_FW_PUNCH 209 /* 210 * If PKT_ALIAS_PUNCH_FW is set, active FTP and IRC DCC connections will 211 * create a 'hole' in the firewall to allow the transfers to work. The 212 * ipfw rule number that the hole is created with is controlled by 213 * PacketAliasSetFWBase(). The hole will be attached to that 214 * particular alias_link, so when the link goes away the hole is deleted. 215 */ 216 #define PKT_ALIAS_PUNCH_FW 0x100 217 #endif 218 219 /* 220 * If PKT_ALIAS_SKIP_GLOBAL is set, nat instance is not checked for matching 221 * states in 'ipfw nat global' rule. 222 */ 223 #define PKT_ALIAS_SKIP_GLOBAL 0x200 224 225 /* 226 * Like PKT_ALIAS_UNREGISTERED_ONLY, but includes the RFC 6598 227 * (Carrier Grade NAT) address range as follows: 228 * 229 * 100.64.0.0 -> 100.127.255.255 230 */ 231 #define PKT_ALIAS_UNREGISTERED_CGN 0x400 232 233 /* Function return codes. */ 234 #define PKT_ALIAS_ERROR -1 235 #define PKT_ALIAS_OK 1 236 #define PKT_ALIAS_IGNORED 2 237 #define PKT_ALIAS_UNRESOLVED_FRAGMENT 3 238 #define PKT_ALIAS_FOUND_HEADER_FRAGMENT 4 239 240 #endif /* !_ALIAS_H_ */ 241 242 /* lint -restore */ 243