You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
622 lines
19 KiB
622 lines
19 KiB
/* |
|
* ZeroTier SDK - Network Virtualization Everywhere |
|
* Copyright (C) 2011-2018 ZeroTier, Inc. https://www.zerotier.com/ |
|
* |
|
* This program is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU General Public License as published by |
|
* the Free Software Foundation, either version 3 of the License, or |
|
* (at your option) any later version. |
|
* |
|
* This program is distributed in the hope that it will be useful, |
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
* GNU General Public License for more details. |
|
* |
|
* You should have received a copy of the GNU General Public License |
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
* |
|
* -- |
|
* |
|
* You can be released from the requirements of the license by purchasing |
|
* a commercial license. Buying such a license is mandatory as soon as you |
|
* develop commercial closed-source software that incorporates or links |
|
* directly against ZeroTier software without disclosing the source code |
|
* of your own application. |
|
*/ |
|
|
|
/** |
|
* @file |
|
* |
|
* Application-facing, partially-POSIX-compliant socket API |
|
*/ |
|
|
|
#ifndef LIBZT_H |
|
#define LIBZT_H |
|
|
|
#include "libztDebug.h" |
|
#include "libztDefs.h" |
|
|
|
#include <stdlib.h> |
|
#include <stdint.h> |
|
|
|
#if defined(__linux__) || defined(__APPLE__) |
|
#include <sys/socket.h> |
|
#include <unistd.h> |
|
#endif |
|
|
|
#if defined(_WIN32) |
|
#include <WinSock2.h> |
|
#include <stdint.h> |
|
#include <WS2tcpip.h> |
|
#endif |
|
|
|
/****************************************************************************/ |
|
/* DLL export for Windows */ |
|
/****************************************************************************/ |
|
|
|
#ifdef _WIN32 |
|
#ifdef ADD_EXPORTS |
|
#define ZT_SOCKET_API __declspec(dllexport) |
|
#else |
|
#define ZT_SOCKET_API __declspec(dllimport) |
|
#endif |
|
#define ZTCALL __cdecl |
|
#else |
|
#define ZT_SOCKET_API |
|
#define ZTCALL |
|
#endif |
|
|
|
/****************************************************************************/ |
|
/* ZeroTier Service Controls */ |
|
/****************************************************************************/ |
|
|
|
#ifdef __cplusplus |
|
extern "C" { |
|
#endif |
|
|
|
/** |
|
* @brief (optional) Sets the port for the background libzt service. If this function is called |
|
* with a port number between 1-65535 it will attempt to bind to that port. If it is called with |
|
* a port number of 0 it will attempt to randomly search for an available port. If this function |
|
* is never called, the service will try to bind on LIBZT_DEFAULT_PORT which is 9994. |
|
* |
|
* @usage Should be called at the beginning of your application before `zts_startjoin()` |
|
* @param portno Port number |
|
* @return 0 if successful; or -1 if failed |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_set_service_port(int portno); |
|
|
|
/** |
|
* @brief Starts libzt |
|
* |
|
* @usage Should be called at the beginning of your application. Will blocks until all of the following conditions are met: |
|
* - ZeroTier core service has been initialized |
|
* - Cryptographic identity has been generated or loaded from directory specified by `path` |
|
* - Virtual network is successfully joined |
|
* - IP address is assigned by network controller service |
|
* @param path path directory where cryptographic identities and network configuration files are stored and retrieved |
|
* (`identity.public`, `identity.secret`) |
|
* @param nwid A 16-digit hexidecimal network identifier (e.g. Earth: `8056c2e21c000001`) |
|
* @return 0 if successful; or 1 if failed |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_start(const char *path, int blocking); |
|
|
|
/** |
|
* @brief Starts libzt |
|
* |
|
* @usage Should be called at the beginning of your application. Will blocks until all of the following conditions are met: |
|
* - ZeroTier core service has been initialized |
|
* - Cryptographic identity has been generated or loaded from directory specified by `path` |
|
* - Virtual network is successfully joined |
|
* - IP address is assigned by network controller service |
|
* @param path path directory where cryptographic identities and network configuration files are stored and retrieved |
|
* (`identity.public`, `identity.secret`) |
|
* @param nwid A 16-digit hexidecimal network identifier (e.g. Earth: `8056c2e21c000001`) |
|
* @return 0 if successful; or 1 if failed |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_startjoin(const char *path, const uint64_t nwid); |
|
|
|
/** |
|
* @brief Stops ZeroTier core services, stack drivers, stack threads, etc |
|
* |
|
* @usage This should be called at the end of your program or when you do not anticipate communicating over ZeroTier |
|
* @return Returns 0 on success, -1 on failure |
|
*/ |
|
ZT_SOCKET_API void ZTCALL zts_stop(); |
|
|
|
/** |
|
* @brief Return whether ZeroTier core service is currently running |
|
* |
|
* @usage Call this after zts_start() |
|
* @return 1 if running, 0 if not running |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_core_running(); |
|
|
|
/** |
|
* @brief Return whether the userspace network stack is currently running |
|
* |
|
* @usage Call this after zts_start() |
|
* @return 1 if running, 0 if not running |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_stack_running(); |
|
|
|
/** |
|
* @brief Return whether libzt is ready to handle socket API calls. Alternatively you could |
|
* have just called zts_startjoin(path, nwid) |
|
* |
|
* @usage Call this after zts_start() |
|
* @return 1 if running, 0 if not running |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_ready(); |
|
|
|
/** |
|
* @brief Join a network |
|
* |
|
* @usage Call this from application thread. Only after zts_start() has succeeded |
|
* @param nwid A 16-digit hexidecimal virtual network ID |
|
* @return 0 if successful, -1 for any failure |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_join(const uint64_t nwid); |
|
|
|
/** |
|
* @brief Leave a network |
|
* |
|
* @usage Call this from application thread. Only after zts_start() has succeeded |
|
* @param nwid A 16-digit hexidecimal virtual network ID |
|
* @return 0 if successful, -1 for any failure |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_leave(const uint64_t nwid); |
|
|
|
/** |
|
* @brief Copies the configuration path used by ZeroTier into the provided buffer |
|
* |
|
* @usage |
|
* @param homePath Path to ZeroTier configuration files |
|
* @param len Length of destination buffer |
|
* @return |
|
*/ |
|
ZT_SOCKET_API void ZTCALL zts_get_path(char *homePath, const size_t len); |
|
|
|
/** |
|
* @brief Returns the node ID of this instance |
|
* |
|
* @usage Call this after zts_start() and/or when zts_running() returns true |
|
* @return |
|
*/ |
|
ZT_SOCKET_API uint64_t ZTCALL zts_get_node_id(); |
|
|
|
/** |
|
* @brief Returns the node ID of this instance (as read from a file) |
|
* |
|
* @usage Call with or without starting the service with zts_start() |
|
* @param filepath Path to ZeroTier configuration files |
|
* @return |
|
*/ |
|
ZT_SOCKET_API uint64_t ZTCALL zts_get_node_id_from_file(const char *filepath); |
|
|
|
/** |
|
* @brief Returns whether any address has been assigned to the SockTap for this network |
|
* |
|
* @usage This is used as an indicator of readiness for service for the ZeroTier core and stack |
|
* @param nwid Network ID |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_has_address(const uint64_t nwid); |
|
|
|
|
|
/** |
|
* @brief Returns the number of addresses assigned to this node for the given nwid |
|
* |
|
* @param nwid Network ID |
|
* @return The number of addresses assigned |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_get_num_assigned_addresses(const uint64_t nwid); |
|
|
|
/** |
|
* @brief Returns the assigned address located at the given index |
|
* |
|
* @usage The indices of each assigned address are not guaranteed and should only |
|
* be used for iterative purposes. |
|
* @param nwid Network ID |
|
* @param index location of assigned address |
|
* @return The number of addresses assigned |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_get_address_at_index( |
|
const uint64_t nwid, const int index, struct sockaddr *addr, socklen_t *addrlen); |
|
|
|
/** |
|
* @brief Get IP address for this device on a given network |
|
* |
|
* @usage FIXME: Only returns first address found, good enough for most cases |
|
* @param nwid Network ID |
|
* @param addr Destination structure for address |
|
* @param addrlen size of destination address buffer, will be changed to size of returned address |
|
* @return 0 if an address was successfully found, -1 if failure |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_get_address( |
|
const uint64_t nwid, struct sockaddr_storage *addr, const int address_family); |
|
|
|
/** |
|
* @brief Computes a 6PLANE IPv6 address for the given Network ID and Node ID |
|
* |
|
* @usage Can call any time |
|
* @param addr Destination structure for address |
|
* @param nwid Network ID |
|
* @param nodeId Node ID |
|
* @return |
|
*/ |
|
ZT_SOCKET_API void ZTCALL zts_get_6plane_addr( |
|
struct sockaddr_storage *addr, const uint64_t nwid, const uint64_t nodeId); |
|
|
|
/** |
|
* @brief Computes a RFC4193 IPv6 address for the given Network ID and Node ID |
|
* |
|
* @usage Can call any time |
|
* @param addr Destination structure for address |
|
* @param nwid Network ID |
|
* @param nodeId Node ID |
|
* @return |
|
*/ |
|
ZT_SOCKET_API void ZTCALL zts_get_rfc4193_addr( |
|
struct sockaddr_storage *addr, const uint64_t nwid, const uint64_t nodeId); |
|
|
|
/** |
|
* @brief Return the number of peers |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @return |
|
*/ |
|
ZT_SOCKET_API unsigned long zts_get_peer_count(); |
|
|
|
/****************************************************************************/ |
|
/* Socket-like API */ |
|
/****************************************************************************/ |
|
|
|
/** |
|
* @brief Create a socket |
|
* |
|
* This function will return an integer which can be used in much the same way as a |
|
* typical file descriptor, however it is only valid for use with libzt library calls |
|
* as this is merely a facade which is associated with the internal socket representation |
|
* of both the network stacks and drivers. |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param socket_family Address family (AF_INET, AF_INET6) |
|
* @param socket_type Type of socket (SOCK_STREAM, SOCK_DGRAM, SOCK_RAW) |
|
* @param protocol Protocols supported on this socket |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_socket(int socket_family, int socket_type, int protocol); |
|
|
|
/** |
|
* @brief Connect a socket to a remote host |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param addr Remote host address to connect to |
|
* @param addrlen Length of address |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_connect(int fd, const struct sockaddr *addr, socklen_t addrlen); |
|
|
|
/** |
|
* @brief Bind a socket to a virtual interface |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param addr Local interface address to bind to |
|
* @param addrlen Length of address |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_bind(int fd, const struct sockaddr *addr, socklen_t addrlen); |
|
|
|
/** |
|
* @brief Listen for incoming connections |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param backlog Number of backlogged connection allowed |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_listen(int fd, int backlog); |
|
|
|
/** |
|
* @brief Accept an incoming connection |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param addr Address of remote host for accepted connection |
|
* @param addrlen Length of address |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_accept(int fd, struct sockaddr *addr, socklen_t *addrlen); |
|
|
|
/** |
|
* @brief Accept an incoming connection |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param addr Address of remote host for accepted connection |
|
* @param addrlen Length of address |
|
* @param flags |
|
* @return |
|
*/ |
|
#if defined(__linux__) |
|
int zts_accept4(int fd, struct sockaddr *addr, socklen_t *addrlen, int flags); |
|
#endif |
|
|
|
/** |
|
* @brief Set socket options |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param level Protocol level to which option name should apply |
|
* @param optname Option name to set |
|
* @param optval Source of option value to set |
|
* @param optlen Length of option value |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_setsockopt( |
|
int fd, int level, int optname, const void *optval, socklen_t optlen); |
|
|
|
/** |
|
* @brief Get socket options |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param level Protocol level to which option name should apply |
|
* @param optname Option name to get |
|
* @param optval Where option value will be stored |
|
* @param optlen Length of value |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_getsockopt( |
|
int fd, int level, int optname, void *optval, socklen_t *optlen); |
|
|
|
/** |
|
* @brief Get socket name |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param addr Name associated with this socket |
|
* @param addrlen Length of name |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_getsockname(int fd, struct sockaddr *addr, socklen_t *addrlen); |
|
|
|
/** |
|
* @brief Get the peer name for the remote end of a connected socket |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param addr Name associated with remote end of this socket |
|
* @param addrlen Length of name |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_getpeername(int fd, struct sockaddr *addr, socklen_t *addrlen); |
|
|
|
/** |
|
* @brief Gets current hostname |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param name |
|
* @param len |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_gethostname(char *name, size_t len); |
|
|
|
/** |
|
* @brief Sets current hostname |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param name |
|
* @param len |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_sethostname(const char *name, size_t len); |
|
|
|
/** |
|
* @brief Return a pointer to an object with the following structure describing an internet host referenced by name |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param name |
|
* @return Returns pointer to hostent structure otherwise NULL if failure |
|
*/ |
|
ZT_SOCKET_API struct hostent *zts_gethostbyname(const char *name); |
|
|
|
/** |
|
* @brief Close a socket |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_close(int fd); |
|
|
|
/** |
|
* @brief Waits for one of a set of file descriptors to become ready to perform I/O. |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fds |
|
* @param nfds |
|
* @param timeout |
|
* @return |
|
*/ |
|
#if defined(__linux__) |
|
/* |
|
typedef unsigned int nfds_t; |
|
int zts_poll(struct pollfd *fds, nfds_t nfds, int timeout); |
|
*/ |
|
#endif |
|
|
|
/** |
|
* @brief Monitor multiple file descriptors, waiting until one or more of the file descriptors become "ready" |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param nfds |
|
* @param readfds |
|
* @param writefds |
|
* @param exceptfds |
|
* @param timeout |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_select( |
|
int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout); |
|
|
|
/** |
|
* @brief Issue file control commands on a socket |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param cmd |
|
* @param flags |
|
* @return |
|
*/ |
|
#if defined(_WIN32) |
|
#define F_SETFL 0 |
|
#define O_NONBLOCK 0 |
|
#endif |
|
ZT_SOCKET_API int ZTCALL zts_fcntl(int fd, int cmd, int flags); |
|
|
|
/** |
|
* @brief Control a device |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param request |
|
* @param argp |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_ioctl(int fd, unsigned long request, void *argp); |
|
|
|
/** |
|
* @brief Send data to remote host |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param buf Pointer to data buffer |
|
* @param len Length of data to write |
|
* @param flags |
|
* @return |
|
*/ |
|
ZT_SOCKET_API ssize_t ZTCALL zts_send(int fd, const void *buf, size_t len, int flags); |
|
|
|
/** |
|
* @brief Send data to remote host |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param buf Pointer to data buffer |
|
* @param len Length of data to write |
|
* @param flags |
|
* @param addr Destination address |
|
* @param addrlen Length of destination address |
|
* @return |
|
*/ |
|
ZT_SOCKET_API ssize_t ZTCALL zts_sendto( |
|
int fd, const void *buf, size_t len, int flags, const struct sockaddr *addr, socklen_t addrlen); |
|
|
|
/** |
|
* @brief Send message to remote host |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param msg |
|
* @param flags |
|
* @return |
|
*/ |
|
ZT_SOCKET_API ssize_t ZTCALL zts_sendmsg(int fd, const struct msghdr *msg, int flags); |
|
|
|
/** |
|
* @brief Receive data from remote host |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param buf Pointer to data buffer |
|
* @param len Length of data buffer |
|
* @param flags |
|
* @return |
|
*/ |
|
ZT_SOCKET_API ssize_t ZTCALL zts_recv(int fd, void *buf, size_t len, int flags); |
|
|
|
/** |
|
* @brief Receive data from remote host |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param buf Pointer to data buffer |
|
* @param len Length of data buffer |
|
* @param flags |
|
* @param addr |
|
* @param addrlen |
|
* @return |
|
*/ |
|
ZT_SOCKET_API ssize_t ZTCALL zts_recvfrom( |
|
int fd, void *buf, size_t len, int flags, struct sockaddr *addr, socklen_t *addrlen); |
|
|
|
/** |
|
* @brief Receive a message from remote host |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param msg |
|
* @param flags |
|
* @return |
|
*/ |
|
ZT_SOCKET_API ssize_t ZTCALL zts_recvmsg(int fd, struct msghdr *msg,int flags); |
|
|
|
/** |
|
* @brief Read bytes from socket onto buffer |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param buf Pointer to data buffer |
|
* @param len Length of data buffer to receive data |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_read(int fd, void *buf, size_t len); |
|
|
|
/** |
|
* @brief Write bytes from buffer to socket |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param buf Pointer to data buffer |
|
* @param len Length of buffer to write |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_write(int fd, const void *buf, size_t len); |
|
|
|
/** |
|
* @brief Shut down some aspect of a socket (read, write, or both) |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param fd File descriptor (only valid for use with libzt calls) |
|
* @param how Which aspects of the socket should be shut down |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_shutdown(int fd, int how); |
|
|
|
/** |
|
* @brief Adds a DNS nameserver for the network stack to use |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param addr Address for DNS nameserver |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_add_dns_nameserver(struct sockaddr *addr); |
|
|
|
/** |
|
* @brief Removes a DNS nameserver |
|
* |
|
* @usage Call this after zts_start() has succeeded |
|
* @param addr Address for DNS nameserver |
|
* @return |
|
*/ |
|
ZT_SOCKET_API int ZTCALL zts_del_dns_nameserver(struct sockaddr *addr); |
|
|
|
#ifdef __cplusplus |
|
} // extern "C" |
|
#endif |
|
|
|
#endif // _H
|
|
|