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