eBPF for Windows
Loading...
Searching...
No Matches
ebpf_nethooks.h
Go to the documentation of this file.
1// Copyright (c) eBPF for Windows contributors
2// SPDX-License-Identifier: MIT
3#pragma once
4#include <stdint.h>
5
6// This file contains APIs for hooks and helpers that are
7// exposed by netebpfext.sys for use by eBPF programs.
8
9#ifndef __doxygen
10#define EBPF_HELPER(return_type, name, args) typedef return_type(*const name##_t) args
11#endif
12
13// BIND hook
14
21
32
76
98typedef bind_action_t
100
101//
102// CGROUP_SOCK_ADDR.
103//
104
111
112#ifdef _MSC_VER
113#pragma warning(push)
114#pragma warning(disable : 4201)
115#endif
119typedef struct bpf_sock_addr
120{
121 uint32_t family;
122 struct
123 {
128 union
129 {
130 uint32_t msg_src_ip4;
131 uint32_t msg_src_ip6[4];
132 };
133 uint16_t msg_src_port;
134 };
135 struct
136 {
137 /* @brief Destination IP address in network byte order.
138 * Local for egress, remote for ingress.
139 */
140 union
141 {
142 uint32_t user_ip4;
143 uint32_t user_ip6[4];
144 };
145 uint16_t user_port;
146 };
147 uint32_t protocol;
148 uint32_t compartment_id;
149 uint64_t interface_luid;
151
152#define SOCK_ADDR_EXT_HELPER_FN_BASE 0xFFFF
153
159
171EBPF_HELPER(int, bpf_sock_addr_set_redirect_context, (bpf_sock_addr_t * ctx, void* data, uint32_t data_size));
172#ifndef __doxygen
173#define bpf_sock_addr_set_redirect_context \
174 ((bpf_sock_addr_set_redirect_context_t)BPF_FUNC_sock_addr_set_redirect_context)
175#endif
176
197
207
208typedef struct _bpf_sock_ops
209{
211 uint32_t family;
212 struct
213 {
214 union
215 {
216 uint32_t local_ip4;
217 uint32_t local_ip6[4];
218 };
219 uint32_t local_port;
220 };
221 struct
222 {
223 union
224 {
225 uint32_t remote_ip4;
226 uint32_t remote_ip6[4];
227 };
228 uint32_t remote_port;
229 };
230 uint8_t protocol;
231 uint32_t compartment_id;
232 uint64_t interface_luid;
234
247typedef int
249
250#ifdef _MSC_VER
251#pragma warning(pop)
252#endif
enum _bind_operation bind_operation_t
#define SOCK_ADDR_EXT_HELPER_FN_BASE
Definition ebpf_nethooks.h:152
ebpf_sock_addr_verdict_t sock_addr_hook_t(bpf_sock_addr_t *context)
Handle socket operation. Currently supports ingress/egress connection initialization.
Definition ebpf_nethooks.h:196
enum _ebpf_sock_addr_verdict ebpf_sock_addr_verdict_t
ebpf_sock_addr_helper_id_t
Definition ebpf_nethooks.h:155
@ BPF_FUNC_sock_addr_set_redirect_context
Definition ebpf_nethooks.h:157
@ BPF_FUNC_sock_addr_get_current_pid_tgid
Definition ebpf_nethooks.h:156
enum _bpf_sock_op_type bpf_sock_op_type_t
int sock_ops_hook_t(bpf_sock_ops_t *context)
Handle socket event notification. Currently notifies ingress/egress connection establishment and tear...
Definition ebpf_nethooks.h:248
int bpf_sock_addr_set_redirect_context(bpf_sock_addr_t *ctx, void *data, uint32_t data_size)
Set a context for consumption by a user-mode application (sock_addr specific only)....
_bind_operation
Definition ebpf_nethooks.h:16
@ BIND_OPERATION_BIND
Entry to bind.
Definition ebpf_nethooks.h:17
@ BIND_OPERATION_UNBIND
Release port.
Definition ebpf_nethooks.h:19
@ BIND_OPERATION_POST_BIND
After port allocation.
Definition ebpf_nethooks.h:18
_bind_action
Actions that can be returned by a bind hook program.
Definition ebpf_nethooks.h:37
@ BIND_REDIRECT
Change the bind endpoint.
Definition ebpf_nethooks.h:60
@ BIND_PERMIT_SOFT
Permit the bind operation (soft permit).
Definition ebpf_nethooks.h:44
@ BIND_PERMIT
Backward compatibility alias for BIND_PERMIT_SOFT.
Definition ebpf_nethooks.h:74
@ BIND_PERMIT_HARD
Permit the bind operation (hard permit).
Definition ebpf_nethooks.h:68
@ BIND_DENY
Deny the bind operation.
Definition ebpf_nethooks.h:51
_bpf_sock_op_type
Definition ebpf_nethooks.h:199
@ BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB
Indicates when a passive (inbound) connection is established.
Definition ebpf_nethooks.h:203
@ BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB
Indicates when an active (outbound) connection is established.
Definition ebpf_nethooks.h:201
@ BPF_SOCK_OPS_CONNECTION_DELETED_CB
Indicates when a connection is deleted.
Definition ebpf_nethooks.h:205
bind_action_t bind_hook_t(bind_md_t *context)
Handle IPv4 and IPv6 socket bind() requests.
Definition ebpf_nethooks.h:99
struct bpf_sock_addr bpf_sock_addr_t
Data structure used as context for BPF_PROG_TYPE_CGROUP_SOCK_ADDR program type.
_ebpf_sock_addr_verdict
Definition ebpf_nethooks.h:106
@ BPF_SOCK_ADDR_VERDICT_REJECT
Definition ebpf_nethooks.h:107
@ BPF_SOCK_ADDR_VERDICT_PROCEED_SOFT
Definition ebpf_nethooks.h:108
@ BPF_SOCK_ADDR_VERDICT_PROCEED_HARD
Definition ebpf_nethooks.h:109
enum _bind_action bind_action_t
Actions that can be returned by a bind hook program.
struct _bind_md bind_md_t
struct _bpf_sock_ops bpf_sock_ops_t
Definition ebpf_nethooks.h:23
uint8_t protocol
Protocol number (e.g., IPPROTO_TCP).
Definition ebpf_nethooks.h:30
bind_operation_t operation
Operation to do.
Definition ebpf_nethooks.h:29
uint8_t * app_id_end
Pointer to end of App ID.
Definition ebpf_nethooks.h:25
uint8_t socket_address[16]
Socket address to bind to.
Definition ebpf_nethooks.h:27
uint64_t process_id
Process ID.
Definition ebpf_nethooks.h:26
uint8_t * app_id_start
Pointer to start of App ID.
Definition ebpf_nethooks.h:24
uint8_t socket_address_length
Length in bytes of the socket address.
Definition ebpf_nethooks.h:28
Definition ebpf_nethooks.h:209
uint32_t local_ip4
Definition ebpf_nethooks.h:216
uint32_t family
IP address family.
Definition ebpf_nethooks.h:211
uint32_t remote_ip4
Definition ebpf_nethooks.h:225
uint32_t compartment_id
Network compartment Id.
Definition ebpf_nethooks.h:231
uint8_t protocol
IP protocol.
Definition ebpf_nethooks.h:230
uint32_t remote_port
Definition ebpf_nethooks.h:228
uint64_t interface_luid
Interface LUID.
Definition ebpf_nethooks.h:232
uint32_t local_ip6[4]
Definition ebpf_nethooks.h:217
bpf_sock_op_type_t op
Definition ebpf_nethooks.h:210
uint32_t remote_ip6[4]
Definition ebpf_nethooks.h:226
uint32_t local_port
Definition ebpf_nethooks.h:219
Data structure used as context for BPF_PROG_TYPE_CGROUP_SOCK_ADDR program type.
Definition ebpf_nethooks.h:120
uint32_t protocol
IP protocol.
Definition ebpf_nethooks.h:147
uint16_t user_port
Destination port in network byte order.
Definition ebpf_nethooks.h:145
uint16_t msg_src_port
Source port in network byte order.
Definition ebpf_nethooks.h:133
uint32_t user_ip4
Definition ebpf_nethooks.h:142
uint32_t user_ip6[4]
Definition ebpf_nethooks.h:143
uint32_t compartment_id
Network compartment Id.
Definition ebpf_nethooks.h:148
uint32_t msg_src_ip6[4]
Definition ebpf_nethooks.h:131
uint64_t interface_luid
Interface LUID.
Definition ebpf_nethooks.h:149
uint32_t msg_src_ip4
Definition ebpf_nethooks.h:130
uint32_t family
IP address family.
Definition ebpf_nethooks.h:121