alias.h revision 145925
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: head/sys/netinet/libalias/alias.h 145925 2005-05-05 20:22:09Z glebius $ 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 */ 61struct 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 */ 69struct alias_link; 70 71 72/* OLD API */ 73 74/* Initialization and control functions. */ 75void PacketAliasInit(void); 76void PacketAliasSetAddress(struct in_addr _addr); 77void PacketAliasSetFWBase(unsigned int _base, unsigned int _num); 78void PacketAliasSetSkinnyPort(unsigned int _port); 79unsigned int 80 PacketAliasSetMode(unsigned int _flags, unsigned int _mask); 81void PacketAliasUninit(void); 82 83/* Packet Handling functions. */ 84int PacketAliasIn(char *_ptr, int _maxpacketsize); 85int PacketAliasOut(char *_ptr, int _maxpacketsize); 86int PacketUnaliasOut(char *_ptr, int _maxpacketsize); 87 88/* Port and address redirection functions. */ 89 90 91int 92PacketAliasAddServer(struct alias_link *_lnk, 93 struct in_addr _addr, unsigned short _port); 94struct alias_link * 95PacketAliasRedirectAddr(struct in_addr _src_addr, 96 struct in_addr _alias_addr); 97int PacketAliasRedirectDynamic(struct alias_link *_lnk); 98void PacketAliasRedirectDelete(struct alias_link *_lnk); 99struct alias_link * 100PacketAliasRedirectPort(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); 104struct alias_link * 105PacketAliasRedirectProto(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. */ 110void PacketAliasFragmentIn(char *_ptr, char *_ptr_fragment); 111char *PacketAliasGetFragment(char *_ptr); 112int PacketAliasSaveFragment(char *_ptr); 113 114/* Miscellaneous functions. */ 115int PacketAliasCheckNewLink(void); 116unsigned short 117 PacketAliasInternetChecksum(unsigned short *_ptr, int _nbytes); 118void PacketAliasSetTarget(struct in_addr _target_addr); 119 120/* Transparent proxying routines. */ 121int PacketAliasProxyRule(const char *_cmd); 122 123/* NEW API */ 124 125/* Initialization and control functions. */ 126struct libalias *LibAliasInit(struct libalias *); 127void LibAliasSetAddress(struct libalias *, struct in_addr _addr); 128void LibAliasSetFWBase(struct libalias *, unsigned int _base, unsigned int _num); 129void LibAliasSetSkinnyPort(struct libalias *, unsigned int _port); 130unsigned int 131 LibAliasSetMode(struct libalias *, unsigned int _flags, unsigned int _mask); 132void LibAliasUninit(struct libalias *); 133 134/* Packet Handling functions. */ 135int LibAliasIn (struct libalias *, char *_ptr, int _maxpacketsize); 136int LibAliasOut(struct libalias *, char *_ptr, int _maxpacketsize); 137int LibAliasOutTry(struct libalias *, char *_ptr, int _maxpacketsize, int _create); 138int LibAliasUnaliasOut(struct libalias *, char *_ptr, int _maxpacketsize); 139 140/* Port and address redirection functions. */ 141 142int 143LibAliasAddServer(struct libalias *, struct alias_link *_lnk, 144 struct in_addr _addr, unsigned short _port); 145struct alias_link * 146LibAliasRedirectAddr(struct libalias *, struct in_addr _src_addr, 147 struct in_addr _alias_addr); 148int LibAliasRedirectDynamic(struct libalias *, struct alias_link *_lnk); 149void LibAliasRedirectDelete(struct libalias *, struct alias_link *_lnk); 150struct alias_link * 151LibAliasRedirectPort(struct libalias *, struct in_addr _src_addr, 152 unsigned short _src_port, struct in_addr _dst_addr, 153 unsigned short _dst_port, struct in_addr _alias_addr, 154 unsigned short _alias_port, unsigned char _proto); 155struct alias_link * 156LibAliasRedirectProto(struct libalias *, struct in_addr _src_addr, 157 struct in_addr _dst_addr, struct in_addr _alias_addr, 158 unsigned char _proto); 159 160/* Fragment Handling functions. */ 161void LibAliasFragmentIn(struct libalias *, char *_ptr, char *_ptr_fragment); 162char *LibAliasGetFragment(struct libalias *, char *_ptr); 163int LibAliasSaveFragment(struct libalias *, char *_ptr); 164 165/* Miscellaneous functions. */ 166int LibAliasCheckNewLink(struct libalias *); 167unsigned short 168 LibAliasInternetChecksum(struct libalias *, unsigned short *_ptr, int _nbytes); 169void LibAliasSetTarget(struct libalias *, struct in_addr _target_addr); 170 171/* Transparent proxying routines. */ 172int LibAliasProxyRule(struct libalias *, const char *_cmd); 173 174 175/* 176 * Mode flags and other constants. 177 */ 178 179 180/* Mode flags, set using PacketAliasSetMode() */ 181 182/* 183 * If PKT_ALIAS_LOG is set, a message will be printed to /var/log/alias.log 184 * every time a link is created or deleted. This is useful for debugging. 185 */ 186#ifndef NO_LOGGING 187#define PKT_ALIAS_LOG 0x01 188#endif 189 190/* 191 * If PKT_ALIAS_DENY_INCOMING is set, then incoming connections (e.g. to ftp, 192 * telnet or web servers will be prevented by the aliasing mechanism. 193 */ 194#define PKT_ALIAS_DENY_INCOMING 0x02 195 196/* 197 * If PKT_ALIAS_SAME_PORTS is set, packets will be attempted sent from the 198 * same port as they originated on. This allows e.g. rsh to work *99% of the 199 * time*, but _not_ 100% (it will be slightly flakey instead of not working 200 * at all). This mode bit is set by PacketAliasInit(), so it is a default 201 * mode of operation. 202 */ 203#define PKT_ALIAS_SAME_PORTS 0x04 204 205/* 206 * If PKT_ALIAS_USE_SOCKETS is set, then when partially specified links (e.g. 207 * destination port and/or address is zero), the packet aliasing engine will 208 * attempt to allocate a socket for the aliasing port it chooses. This will 209 * avoid interference with the host machine. Fully specified links do not 210 * require this. This bit is set after a call to PacketAliasInit(), so it is 211 * a default mode of operation. 212 */ 213#define PKT_ALIAS_USE_SOCKETS 0x08 214 215/*- 216 * If PKT_ALIAS_UNREGISTERED_ONLY is set, then only packets with 217 * unregistered source addresses will be aliased. Private 218 * addresses are those in the following ranges: 219 * 220 * 10.0.0.0 -> 10.255.255.255 221 * 172.16.0.0 -> 172.31.255.255 222 * 192.168.0.0 -> 192.168.255.255 223 */ 224#define PKT_ALIAS_UNREGISTERED_ONLY 0x10 225 226/* 227 * If PKT_ALIAS_RESET_ON_ADDR_CHANGE is set, then the table of dynamic 228 * aliasing links will be reset whenever PacketAliasSetAddress() changes the 229 * default aliasing address. If the default aliasing address is left 230 * unchanged by this function call, then the table of dynamic aliasing links 231 * will be left intact. This bit is set after a call to PacketAliasInit(). 232 */ 233#define PKT_ALIAS_RESET_ON_ADDR_CHANGE 0x20 234 235#ifndef NO_FW_PUNCH 236/* 237 * If PKT_ALIAS_PUNCH_FW is set, active FTP and IRC DCC connections will 238 * create a 'hole' in the firewall to allow the transfers to work. The 239 * ipfw rule number that the hole is created with is controlled by 240 * PacketAliasSetFWBase(). The hole will be attached to that 241 * particular alias_link, so when the link goes away the hole is deleted. 242 */ 243#define PKT_ALIAS_PUNCH_FW 0x100 244#endif 245 246/* 247 * If PKT_ALIAS_PROXY_ONLY is set, then NAT will be disabled and only 248 * transparent proxying is performed. 249 */ 250#define PKT_ALIAS_PROXY_ONLY 0x40 251 252/* 253 * If PKT_ALIAS_REVERSE is set, the actions of PacketAliasIn() and 254 * PacketAliasOut() are reversed. 255 */ 256#define PKT_ALIAS_REVERSE 0x80 257 258/* Function return codes. */ 259#define PKT_ALIAS_ERROR -1 260#define PKT_ALIAS_OK 1 261#define PKT_ALIAS_IGNORED 2 262#define PKT_ALIAS_UNRESOLVED_FRAGMENT 3 263#define PKT_ALIAS_FOUND_HEADER_FRAGMENT 4 264 265#endif /* !_ALIAS_H_ */ 266 267/* lint -restore */ 268