IpTunnel.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. /* vim: set expandtab ts=4 sw=4: */
  2. /*
  3. * You may redistribute this program and/or modify it under the terms of
  4. * the GNU General Public License as published by the Free Software Foundation,
  5. * either version 3 of the License, or (at your option) any later version.
  6. *
  7. * This program is distributed in the hope that it will be useful,
  8. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. * GNU General Public License for more details.
  11. *
  12. * You should have received a copy of the GNU General Public License
  13. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. */
  15. #ifndef IpTunnel_H
  16. #define IpTunnel_H
  17. #include "crypto/random/Random.h"
  18. #include "memory/Allocator.h"
  19. #include "interface/Iface.h"
  20. #include "util/log/Log.h"
  21. #include "util/events/EventBase.h"
  22. #include "util/platform/Sockaddr.h"
  23. #include "wire/RouteHeader.h"
  24. #include "util/Linker.h"
  25. Linker_require("tunnel/IpTunnel.c")
  26. struct IpTunnel_Connection
  27. {
  28. /** The header for routing to this node. */
  29. struct RouteHeader routeHeader;
  30. /** The IPv6 address used for this connection or all zeros if none was assigned. */
  31. uint8_t connectionIp6[16];
  32. /** The IPv4 address used for this connection or all zeros if none was assigned. */
  33. uint8_t connectionIp4[4];
  34. /** The IPv6 netmask/prefix length, in bits. Defaults to 128 if none was assigned. */
  35. uint8_t connectionIp6Prefix;
  36. /** The IPv4 netmask/prefix length, in bits. Defaults to 32 if none was assigned. */
  37. uint8_t connectionIp4Prefix;
  38. /** non-zero if the connection was made using IpTunnel_connectTo(). */
  39. int isOutgoing : 1;
  40. /** The number of the connection so it can be identified when removing. */
  41. int number : 31;
  42. };
  43. struct IpTunnel
  44. {
  45. /** The interface used to send and receive messages to the TUN device. */
  46. struct Iface tunInterface;
  47. /**
  48. * The interface used to send and receive messages to other nodes.
  49. * All messages sent on this interface shall be preceeded with the RouterHeader and DataHeader.
  50. */
  51. struct Iface nodeInterface;
  52. /**
  53. * The list of registered connections, do not modify manually.
  54. * Will be reorganized from time to time so pointers are ephimeral.
  55. */
  56. struct {
  57. uint32_t count;
  58. struct IpTunnel_Connection* connections;
  59. } connectionList;
  60. };
  61. /**
  62. * Create a new IpTunnel structure.
  63. *
  64. * @param logger a logger or NULL.
  65. * @param eventBase the event base.
  66. * @param alloc an allocator.
  67. * @param rand a random generator.
  68. */
  69. struct IpTunnel* IpTunnel_new(struct Log* logger,
  70. struct EventBase* eventBase,
  71. struct Allocator* alloc,
  72. struct Random* rand);
  73. /**
  74. * Allow another node to tunnel IPv4 and/or ICANN IPv6 through this node.
  75. *
  76. * @param publicKeyOfAuthorizedNode the key for the node which will be allowed to connect.
  77. * @param ip6Addr the IPv6 address which the node will be issued or NULL.
  78. * @param ip6Prefix the IPv6 netmask/prefix length.
  79. * @param ip4Addr the IPv4 address which the node will be issued or NULL.
  80. * @param ip4Prefix the IPv4 netmask/prefix length.
  81. * @param tunnel the IpTunnel.
  82. * @return an connection number which is usable with IpTunnel_remove().
  83. */
  84. int IpTunnel_allowConnection(uint8_t publicKeyOfAuthorizedNode[32],
  85. struct Sockaddr* ip6Addr, uint8_t ip6Prefix,
  86. struct Sockaddr* ip4Addr, uint8_t ip4Prefix,
  87. struct IpTunnel* tunnel);
  88. /**
  89. * Connect to another node and get IPv4 and/or IPv6 addresses from it.
  90. *
  91. * @param publicKeyOfNodeToConnectTo the key for the node to connect to.
  92. * @param tunnel the IpTunnel.
  93. * @return an connection number which is usable with IpTunnel_remove().
  94. */
  95. int IpTunnel_connectTo(uint8_t publicKeyOfNodeToConnectTo[32], struct IpTunnel* tunnel);
  96. /**
  97. * Disconnect from a node or remove authorization to connect.
  98. *
  99. * @param connectionNumber the number of the connection to remove.
  100. * @param tunnel the IpTunnel.
  101. * @return 0 if the connection was successfully removed
  102. * IpTunnel_remove_NOT_FOUND if the connection was not found.
  103. */
  104. #define IpTunnel_removeConnection_NOT_FOUND -1
  105. int IpTunnel_removeConnection(int connectionNumber, struct IpTunnel* tunnel);
  106. void IpTunnel_setTunName(char* interfaceName, struct IpTunnel* ipTun);
  107. #endif