1
0

IpTunnel.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  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 <https://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 "util/GlobalConfig.h"
  24. #include "wire/RouteHeader.h"
  25. #include "tunnel/RouteGen.h"
  26. #include "util/Linker.h"
  27. Linker_require("tunnel/IpTunnel.c")
  28. struct IpTunnel_Connection
  29. {
  30. /** The header for routing to this node. */
  31. struct RouteHeader routeHeader;
  32. /** The IPv6 address used for this connection or all zeros if none was assigned. */
  33. uint8_t connectionIp6[16];
  34. /** The IPv4 address used for this connection or all zeros if none was assigned. */
  35. uint8_t connectionIp4[4];
  36. /** The IPv6 netmask/prefix length, in bits. Defaults to 128 if none was assigned. */
  37. uint8_t connectionIp6Prefix;
  38. /** The IPv6 prefix length in, in bits, defining netmask. 0xff if not used. */
  39. uint8_t connectionIp6Alloc;
  40. /** The IPv4 address prefix length, in bits. Defaults to 32 if none was assigned. */
  41. uint8_t connectionIp4Prefix;
  42. /** The IPv6 prefix length in, in bits, defining netmask. 0xff if not used. */
  43. uint8_t connectionIp4Alloc;
  44. /** non-zero if the connection was made using IpTunnel_connectTo(). */
  45. int isOutgoing : 1;
  46. /** The number of the connection so it can be identified when removing. */
  47. int number : 31;
  48. };
  49. struct IpTunnel
  50. {
  51. /** The interface used to send and receive messages to the TUN device. */
  52. struct Iface tunInterface;
  53. /**
  54. * The interface used to send and receive messages to other nodes.
  55. * All messages sent on this interface shall be preceeded with the RouterHeader and DataHeader.
  56. */
  57. struct Iface nodeInterface;
  58. /**
  59. * The list of registered connections, do not modify manually.
  60. * Will be reorganized from time to time so pointers are ephemeral.
  61. */
  62. struct {
  63. uint32_t count;
  64. struct IpTunnel_Connection* connections;
  65. } connectionList;
  66. };
  67. /**
  68. * Create a new IpTunnel structure.
  69. *
  70. * @param logger a logger or NULL.
  71. * @param eventBase the event base.
  72. * @param alloc an allocator.
  73. * @param rand a random generator.
  74. * @param gc for getting the name of the tun device (to be able to setup routes to it)
  75. */
  76. struct IpTunnel* IpTunnel_new(struct Log* logger,
  77. EventBase_t* eventBase,
  78. struct Allocator* alloc,
  79. struct Random* rand,
  80. struct RouteGen* rg,
  81. struct GlobalConfig* globalConf);
  82. /**
  83. * Allow another node to tunnel IPv4 and/or ICANN IPv6 through this node.
  84. *
  85. * @param publicKeyOfAuthorizedNode the key for the node which will be allowed to connect.
  86. * @param ip6Addr the IPv6 address which the node will be issued or NULL.
  87. * @param ip6Prefix the IPv6 netmask/prefix length.
  88. * @param ip6Alloc the address block to allocate to the client (v6) 0 is illegal
  89. * @param ip4Addr the IPv4 address which the node will be issued or NULL.
  90. * @param ip4Prefix the IPv4 netmask/prefix length.
  91. * @param ip4Alloc the address block size to allocate to the client (v4) 0 is illegal
  92. * @param tunnel the IpTunnel.
  93. * @return an connection number which is usable with IpTunnel_remove().
  94. */
  95. int IpTunnel_allowConnection(uint8_t publicKeyOfAuthorizedNode[32],
  96. struct Sockaddr* ip6Addr,
  97. uint8_t ip6Prefix, uint8_t ip6Alloc,
  98. struct Sockaddr* ip4Addr,
  99. uint8_t ip4Prefix, uint8_t ip4Alloc,
  100. struct IpTunnel* tunnel);
  101. /**
  102. * Connect to another node and get IPv4 and/or IPv6 addresses from it.
  103. *
  104. * @param publicKeyOfNodeToConnectTo the key for the node to connect to.
  105. * @param tunnel the IpTunnel.
  106. * @return an connection number which is usable with IpTunnel_remove().
  107. */
  108. int IpTunnel_connectTo(uint8_t publicKeyOfNodeToConnectTo[32], struct IpTunnel* tunnel);
  109. /**
  110. * Disconnect from a node or remove authorization to connect.
  111. *
  112. * @param connectionNumber the number of the connection to remove.
  113. * @param tunnel the IpTunnel.
  114. * @return 0 if the connection was successfully removed
  115. * IpTunnel_remove_NOT_FOUND if the connection was not found.
  116. */
  117. #define IpTunnel_removeConnection_NOT_FOUND -1
  118. int IpTunnel_removeConnection(int connectionNumber, struct IpTunnel* tunnel);
  119. #endif