src/basic/socket-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <inttypes.h>
   5 #include <linux/netlink.h>
   6 #include <linux/if_infiniband.h>
   7 #include <linux/if_packet.h>
   8 #include <netinet/ether.h>
   9 #include <netinet/in.h>
  10 #include <stdbool.h>
  11 #include <stddef.h>
  12 #include <sys/socket.h>
  13 #include <sys/types.h>
  14 #include <sys/un.h>
  15
  16 #include "macro.h"
  17 #include "missing_socket.h"
  18 #include "sparse-endian.h"
  19
  20 union sockaddr_union {
  21         /* The minimal, abstract version */
  22         struct sockaddr sa;
  23
  24         /* The libc provided version that allocates "enough room" for every protocol */
  25         struct sockaddr_storage storage;
  26
  27         /* Protoctol-specific implementations */
  28         struct sockaddr_in in;
  29         struct sockaddr_in6 in6;
  30         struct sockaddr_un un;
  31         struct sockaddr_nl nl;
  32         struct sockaddr_ll ll;
  33         struct sockaddr_vm vm;
  34
  35         /* Ensure there is enough space to store Infiniband addresses */
  36         uint8_t ll_buffer[offsetof(struct sockaddr_ll, sll_addr) + CONST_MAX(ETH_ALEN, INFINIBAND_ALEN)];
  37
  38         /* Ensure there is enough space after the AF_UNIX sun_path for one more NUL byte, just to be sure that the path
  39          * component is always followed by at least one NUL byte. */
  40         uint8_t un_buffer[sizeof(struct sockaddr_un) + 1];
  41 };
  42
  43 typedef struct SocketAddress {
  44         union sockaddr_union sockaddr;
  45
  46         /* We store the size here explicitly due to the weird
  47          * sockaddr_un semantics for abstract sockets */
  48         socklen_t size;
  49
  50         /* Socket type, i.e. SOCK_STREAM, SOCK_DGRAM, ... */
  51         int type;
  52
  53         /* Socket protocol, IPPROTO_xxx, usually 0, except for netlink */
  54         int protocol;
  55 } SocketAddress;
  56
  57 typedef enum SocketAddressBindIPv6Only {
  58         SOCKET_ADDRESS_DEFAULT,
  59         SOCKET_ADDRESS_BOTH,
  60         SOCKET_ADDRESS_IPV6_ONLY,
  61         _SOCKET_ADDRESS_BIND_IPV6_ONLY_MAX,
  62         _SOCKET_ADDRESS_BIND_IPV6_ONLY_INVALID = -1
  63 } SocketAddressBindIPv6Only;
  64
  65 #define socket_address_family(a) ((a)->sockaddr.sa.sa_family)
  66
  67 const char* socket_address_type_to_string(int t) _const_;
  68 int socket_address_type_from_string(const char *s) _pure_;
  69
  70 int socket_address_parse(SocketAddress *a, const char *s);
  71 int socket_address_parse_and_warn(SocketAddress *a, const char *s);
  72 int socket_address_parse_netlink(SocketAddress *a, const char *s);
  73 int socket_address_print(const SocketAddress *a, char **p);
  74 int socket_address_verify(const SocketAddress *a, bool strict) _pure_;
  75
  76 int sockaddr_un_unlink(const struct sockaddr_un *sa);
  77
  78 static inline int socket_address_unlink(const SocketAddress *a) {
  79         return socket_address_family(a) == AF_UNIX ? sockaddr_un_unlink(&a->sockaddr.un) : 0;
  80 }
  81
  82 bool socket_address_can_accept(const SocketAddress *a) _pure_;
  83
  84 int socket_address_listen(
  85                 const SocketAddress *a,
  86                 int flags,
  87                 int backlog,
  88                 SocketAddressBindIPv6Only only,
  89                 const char *bind_to_device,
  90                 bool reuse_port,
  91                 bool free_bind,
  92                 bool transparent,
  93                 mode_t directory_mode,
  94                 mode_t socket_mode,
  95                 const char *label);
  96 int make_socket_fd(int log_level, const char* address, int type, int flags);
  97
  98 bool socket_address_is(const SocketAddress *a, const char *s, int type);
  99 bool socket_address_is_netlink(const SocketAddress *a, const char *s);
 100
 101 bool socket_address_matches_fd(const SocketAddress *a, int fd);
 102
 103 bool socket_address_equal(const SocketAddress *a, const SocketAddress *b) _pure_;
 104
 105 const char* socket_address_get_path(const SocketAddress *a);
 106
 107 bool socket_ipv6_is_supported(void);
 108
 109 int sockaddr_port(const struct sockaddr *_sa, unsigned *port);
 110
 111 int sockaddr_pretty(const struct sockaddr *_sa, socklen_t salen, bool translate_ipv6, bool include_port, char **ret);
 112 int getpeername_pretty(int fd, bool include_port, char **ret);
 113 int getsockname_pretty(int fd, char **ret);
 114
 115 int socknameinfo_pretty(union sockaddr_union *sa, socklen_t salen, char **_ret);
 116
 117 const char* socket_address_bind_ipv6_only_to_string(SocketAddressBindIPv6Only b) _const_;
 118 SocketAddressBindIPv6Only socket_address_bind_ipv6_only_from_string(const char *s) _pure_;
 119 SocketAddressBindIPv6Only socket_address_bind_ipv6_only_or_bool_from_string(const char *s);
 120
 121 int netlink_family_to_string_alloc(int b, char **s);
 122 int netlink_family_from_string(const char *s) _pure_;
 123
 124 bool sockaddr_equal(const union sockaddr_union *a, const union sockaddr_union *b);
 125
 126 int fd_inc_sndbuf(int fd, size_t n);
 127 int fd_inc_rcvbuf(int fd, size_t n);
 128
 129 int ip_tos_to_string_alloc(int i, char **s);
 130 int ip_tos_from_string(const char *s);
 131
 132 bool ifname_valid(const char *p);
 133 bool address_label_valid(const char *p);
 134
 135 int getpeercred(int fd, struct ucred *ucred);
 136 int getpeersec(int fd, char **ret);
 137 int getpeergroups(int fd, gid_t **ret);
 138
 139 ssize_t send_one_fd_iov_sa(
 140                 int transport_fd,
 141                 int fd,
 142                 struct iovec *iov, size_t iovlen,
 143                 const struct sockaddr *sa, socklen_t len,
 144                 int flags);
 145 int send_one_fd_sa(int transport_fd,
 146                    int fd,
 147                    const struct sockaddr *sa, socklen_t len,
 148                    int flags);
 149 #define send_one_fd_iov(transport_fd, fd, iov, iovlen, flags) send_one_fd_iov_sa(transport_fd, fd, iov, iovlen, NULL, 0, flags)
 150 #define send_one_fd(transport_fd, fd, flags) send_one_fd_iov_sa(transport_fd, fd, NULL, 0, NULL, 0, flags)
 151 ssize_t receive_one_fd_iov(int transport_fd, struct iovec *iov, size_t iovlen, int flags, int *ret_fd);
 152 int receive_one_fd(int transport_fd, int flags);
 153
 154 ssize_t next_datagram_size_fd(int fd);
 155
 156 int flush_accept(int fd);
 157
 158 #define CMSG_FOREACH(cmsg, mh)                                          \
 159         for ((cmsg) = CMSG_FIRSTHDR(mh); (cmsg); (cmsg) = CMSG_NXTHDR((mh), (cmsg)))
 160
 161 struct cmsghdr* cmsg_find(struct msghdr *mh, int level, int type, socklen_t length);
 162
 163 /*
 164  * Certain hardware address types (e.g Infiniband) do not fit into sll_addr
 165  * (8 bytes) and run over the structure. This macro returns the correct size that
 166  * must be passed to kernel.
 167  */
 168 #define SOCKADDR_LL_LEN(sa)                                             \
 169         ({                                                              \
 170                 const struct sockaddr_ll *_sa = &(sa);                  \
 171                 size_t _mac_len = sizeof(_sa->sll_addr);                \
 172                 assert(_sa->sll_family == AF_PACKET);                   \
 173                 if (be16toh(_sa->sll_hatype) == ARPHRD_ETHER)           \
 174                         _mac_len = MAX(_mac_len, (size_t) ETH_ALEN);    \
 175                 if (be16toh(_sa->sll_hatype) == ARPHRD_INFINIBAND)      \
 176                         _mac_len = MAX(_mac_len, (size_t) INFINIBAND_ALEN); \
 177                 offsetof(struct sockaddr_ll, sll_addr) + _mac_len;      \
 178         })
 179
 180 /* Covers only file system and abstract AF_UNIX socket addresses, but not unnamed socket addresses. */
 181 #define SOCKADDR_UN_LEN(sa)                                             \
 182         ({                                                              \
 183                 const struct sockaddr_un *_sa = &(sa);                  \
 184                 assert(_sa->sun_family == AF_UNIX);                     \
 185                 offsetof(struct sockaddr_un, sun_path) +                \
 186                         (_sa->sun_path[0] == 0 ?                        \
 187                          1 + strnlen(_sa->sun_path+1, sizeof(_sa->sun_path)-1) : \
 188                          strnlen(_sa->sun_path, sizeof(_sa->sun_path))+1); \
 189         })
 190
 191 int socket_ioctl_fd(void);
 192
 193 int sockaddr_un_set_path(struct sockaddr_un *ret, const char *path);
 194
 195 static inline int setsockopt_int(int fd, int level, int optname, int value) {
 196         if (setsockopt(fd, level, optname, &value, sizeof(value)) < 0)
 197                 return -errno;
 198
 199         return 0;
 200 }