attachment/attachments/kong/nano_ffi.lua
Daniel-Eisenberg 882dc4c187
Add kong plugin (#36)
* add kong plugin to open-appsec

* fix url in rockspec file

* add the attachment prefix to the paths

* check

* fix branch

---------

Co-authored-by: wiaamm <wiaamm@checkpoint.com>
2025-06-24 14:58:41 +03:00

427 lines
14 KiB
Lua
Executable File

package.cpath = "/usr/local/kong/lib/?.so;" .. package.cpath
local nano_attachment = require "lua_attachment_wrapper"
local kong = kong
local nano = {}
nano.session_counter = 0
nano.attachments = {} -- Store attachments per worker
nano.num_workers = ngx.worker.count() or 1 -- Detect number of workers
nano.allocated_strings = {}
nano.allocate_headers = {}
nano.AttachmentVerdict = {
INSPECT = 0,
ACCEPT = 1,
DROP = 2, -- Matches `ATTACHMENT_VERDICT_DROP`
INJECT = 3
}
nano.HttpChunkType = {
HTTP_REQUEST_FILTER = 0,
HTTP_REQUEST_METADATA = 1,
HTTP_REQUEST_HEADER = 2,
HTTP_REQUEST_BODY = 3,
HTTP_REQUEST_END = 4,
HTTP_RESPONSE_HEADER = 5,
HTTP_RESPONSE_BODY = 6,
HTTP_RESPONSE_END = 7,
HOLD_DATA = 8
}
nano.WebResponseType = {
CUSTOM_WEB_RESPONSE = 0,
RESPONSE_CODE_ONLY = 1,
REDIRECT_WEB_RESPONSE = 2,
NO_WEB_RESPONSE = 3,
}
local ffi = require "ffi"
ffi.cdef[[
typedef enum HttpModificationType
{
APPEND,
INJECT,
REPLACE
} HttpModificationType;
typedef enum NanoWebResponseType
{
CUSTOM_WEB_RESPONSE,
RESPONSE_CODE_ONLY,
REDIRECT_WEB_RESPONSE,
NO_WEB_RESPONSE
} NanoWebResponseType;
typedef struct __attribute__((__packed__)) HttpInjectData {
int64_t injection_pos;
HttpModificationType mod_type;
uint16_t injection_size;
uint8_t is_header;
uint8_t orig_buff_index;
char data[0];
} HttpInjectData;
typedef struct NanoHttpModificationList {
struct NanoHttpModificationList *next; ///< Next node.
HttpInjectData modification; ///< Modification data.
char *modification_buffer;
} NanoHttpModificationList;
]]
-- Assuming you already defined the C struct somewhere:
-- ffi.cdef[[
-- typedef struct NanoHttpModificationList { ... } NanoHttpModificationList;
-- ]]
local NanoHttpModificationListPtr = ffi.typeof("NanoHttpModificationList*")
function nano.generate_session_id()
nano.session_counter = nano.session_counter + 1
local worker_id = ngx.worker.id()
-- Compose session_id as "<worker_id><counter>", e.g. "20001"
return tonumber(string.format("%d%05d", worker_id, nano.session_counter))
end
function nano.handle_custom_response(session_data, response)
local worker_id = ngx.worker.id()
local attachment = nano.attachments[worker_id]
local response_type = nano_attachment.get_web_response_type(attachment, session_data, response)
if response_type == nano.WebResponseType.RESPONSE_CODE_ONLY then
local code = nano_attachment.get_response_code(response)
return kong.response.exit(code, "")
end
if response_type == nano.WebResponseType.REDIRECT_WEB_RESPONSE then
local location = nano_attachment.get_redirect_page(attachment, session_data, response)
return kong.response.exit(307, "", { ["Location"] = location })
end
local block_page = nano_attachment.get_block_page(attachment, session_data, response)
if not block_page then
kong.log.err("Failed to retrieve custom block page for session ", session_data)
return kong.response.exit(500, { message = "Internal Server Error" })
end
local code = nano_attachment.get_response_code(response) -- Get the intended status code
return kong.response.exit(code, block_page, { ["Content-Type"] = "text/html" })
end
-- Allocates memory (must be freed later)
function nano.create_nano_str_alloc(str)
if not str then return nil end
local nano_str = nano_attachment.createNanoStrAlloc(str)
table.insert(nano.allocated_strings, nano_str) -- Track allocation
return nano_str
end
-- Free nano_str_t to prevent memory leaks
function nano.free_nano_str(nano_str)
if nano_str then
nano_attachment.freeNanoStr(nano_str)
end
end
-- Free all allocated nano_str_t to prevent memory leaks
function nano.free_all_nano_str()
for _, nano_str in ipairs(nano.allocated_strings) do
nano_attachment.freeNanoStr(nano_str) -- Free memory in C
end
nano.allocated_strings = {} -- Reset the list
end
function nano.free_http_headers(header_data)
for _, nano_header in ipairs(nano.allocate_headers) do
nano_attachment.freeNanoStr(nano_header) -- Free memory in C
end
nano.allocate_headers = {} -- Reset the list
end
-- Initialize worker attachment
function nano.init_attachment()
local worker_id = ngx.worker.id()
local attachment, err
local retries = 3
for attempt = 1, retries do
attachment, err = nano_attachment.init_nano_attachment(worker_id, nano.num_workers)
if attachment then break end
kong.log.err("Worker ", worker_id, " failed to initialize attachment (attempt ", attempt, "): ", err)
ngx.sleep(2)
end
if not attachment then
kong.log.err("Worker ", worker_id, " failed to initialize attachment after ", retries, " attempts.")
else
nano.attachments[worker_id] = attachment
kong.log.info("Worker ", worker_id, " successfully initialized nano_attachment.")
end
end
-- Initialize a session for a given request
function nano.init_session(session_id)
local worker_id = ngx.worker.id()
local attachment = nano.attachments[worker_id]
if not attachment then
kong.log.err("Cannot initialize session: Attachment not found for worker ", worker_id)
return nil
end
local session_data, err = nano_attachment.init_session(attachment, session_id)
if not session_data then
kong.log.err("Failed to initialize session for session_id ", session_id, ": ", err)
return nil
end
return session_data
end
-- Check if session is finalized
function nano.is_session_finalized(session_data)
local worker_id = ngx.worker.id()
local attachment = nano.attachments[worker_id]
if not attachment or not session_data then
kong.log.err("Cannot check session finalization: Invalid attachment or session_data")
return false
end
return nano_attachment.is_session_finalized(attachment, session_data)
end
-- Extract metadata for request
function nano.handle_start_transaction()
local stream_info = kong.request
local full_host = stream_info.get_host()
local host = full_host:match("([^:]+)")
local method = stream_info.get_method()
local uri = stream_info.get_path()
local scheme = stream_info.get_scheme()
local client_ip = kong.client.get_ip()
local client_port = kong.client.get_port()
local listening_address = kong.request.get_host()
local listening_ip, listening_port = listening_address:match("([^:]+):?(%d*)")
-- Call the C function with extracted metadata
local metadata = nano_attachment.create_http_metadata(
scheme, method, host, listening_ip, tonumber(listening_port) or 0,
uri, client_ip, tonumber(client_port) or 0, "", ""
)
collectgarbage("stop")
return metadata
end
-- Handle request headers and convert them to nano_str_t
function nano.handleHeaders(headers)
local envoy_headers_prefix = "x-envoy"
-- Allocate memory for headers in C
local header_data = nano_attachment.allocHttpHeaders()
table.insert(nano.allocate_headers, header_data) -- Track allocation
local index = 0
for key, value in pairs(headers) do
if index > 10000 then break end
-- Filter out unwanted headers
if key:find("^" .. envoy_headers_prefix) or key == "x-request-id" or
key == ":method" or key == ":path" or key == ":scheme" or
key == "x-forwarded-proto" then
goto continue
end
-- Convert ":authority" to "Host"
if key == ":authority" then key = "Host" end
-- Store header data in C memory
nano_attachment.setHeaderElement(header_data, index, key, value)
index = index + 1
::continue::
end
-- Store the count
nano_attachment.setHeaderCount(header_data, index)
return header_data
end
-- Send data to NanoAttachment
function nano.send_data(session_id, session_data, meta_data, header_data, contains_body, chunk_type)
local worker_id = ngx.worker.id()
local attachment = nano.attachments[worker_id]
if not attachment then
kong.log.err("Attachment not initialized for worker ", worker_id, ". Dropping request.")
return nano.AttachmentVerdict.INSPECT
end
contains_body = tonumber(contains_body) or 0 -- Ensure it's a number
contains_body = (contains_body > 0) and 1 or 0 -- Force strict 0 or 1
local verdict, response = nano_attachment.send_data(attachment, session_id, session_data, chunk_type, meta_data, header_data, contains_body)
return verdict, response
end
function nano.send_body(session_id, session_data, body_chunk, chunk_type)
local worker_id = ngx.worker.id()
local attachment = nano.attachments[worker_id]
if not attachment then
kong.log.err("Attachment not initialized for worker ", worker_id, ". Dropping request.")
return nano.AttachmentVerdict.INSPECT
end
-- Send the body chunk directly as a string
local verdict, response, modifications = nano_attachment.send_body(attachment, session_id, session_data, body_chunk, chunk_type)
return verdict, response, modifications
end
-- Function to inject content into a string at a specific position
function nano.inject_at_position(buffer, injection, pos)
if pos < 0 or pos > #buffer then
kong.log.err("Invalid injection position: ", pos, ", buffer length: ", #buffer)
return buffer
end
return buffer:sub(1, pos) .. injection .. buffer:sub(pos + 1)
end
-- Function to handle body modifications
function nano.handle_body_modifications(body, modifications, body_buffer_chunk)
if modifications == nil then
return body
end
-- cast the userdata to a pointer
local curr_modification = ffi.cast(NanoHttpModificationListPtr, modifications)
while curr_modification ~= nil do
if tonumber(curr_modification.modification.orig_buff_index) == body_buffer_chunk then
local injection_pos = tonumber(curr_modification.modification.injection_pos)
local modification_str = ffi.string(curr_modification.modification_buffer)
kong.log.debug("Injecting modification at pos ", injection_pos, " body buffer chunk ", body_buffer_chunk)
body = nano.inject_at_position(body, modification_str, injection_pos)
end
curr_modification = curr_modification.next
end
return body
end
-- Add a new function for handling response bodies
function nano.send_response_body(session_id, session_data, body_chunk)
local verdict, response, modifications = nano.send_body(session_id, session_data, body_chunk, nano.HttpChunkType.HTTP_RESPONSE_BODY)
return verdict, response, modifications
end
function nano.end_inspection(session_id, session_data, chunk_type)
local worker_id = ngx.worker.id()
local attachment = nano.attachments[worker_id]
if not attachment then
kong.log.err("Attachment not initialized for worker ", worker_id, ". Dropping request.")
return nano.AttachmentVerdict.INSPECT
end
local verdict, response = nano_attachment.end_inspection(attachment, session_id, session_data, chunk_type)
return verdict, response
end
-- Finalize session cleanup
function nano.fini_session(session_data)
local worker_id = ngx.worker.id()
local attachment = nano.attachments[worker_id]
if not attachment or not session_data then
kong.log.err("Cannot finalize session: Invalid attachment or session_data")
return false
end
nano_attachment.fini_session(attachment, session_data)
kong.log.info("Successfully finalized session ", session_data, " for worker ", worker_id)
return true
end
-- Send response headers for inspection
function nano.send_response_headers(session_id, session_data, headers, status_code, content_length)
local worker_id = ngx.worker.id()
local attachment = nano.attachments[worker_id]
if not attachment then
kong.log.err("Attachment not initialized for worker ", worker_id, ". Dropping request.")
return nano.AttachmentVerdict.INSPECT
end
local verdict, response = nano_attachment.send_response_headers(
attachment,
session_id,
session_data,
headers,
status_code,
content_length
)
return verdict, response
end
-- Function to handle header modifications
function nano.handle_header_modifications(headers, modifications)
if not modifications then
return headers
end
local curr_modification = modifications
local modified_headers = headers
while curr_modification do
local mod = curr_modification.modification
if mod.is_header then
local type = mod.mod_type
local key = curr_modification.modification_buffer
local value = curr_modification.next and curr_modification.next.modification_buffer or nil
if type == 0 then -- APPEND
kong.log.debug("Appending header: ", key, " : ", value)
modified_headers[key] = value
elseif type == 1 then -- INJECT
local header_index = mod.orig_buff_index
local header_name = nil
local header_value = nil
local i = 0
for k, v in pairs(modified_headers) do
if i == header_index then
header_name = k
header_value = v
break
end
i = i + 1
end
if header_name then
kong.log.debug("Injecting into header: ", header_name)
modified_headers[header_name] = nano.inject_at_position(header_value, value, mod.injection_pos)
end
elseif type == 2 then -- REPLACE
kong.log.debug("Replacing header: ", key)
modified_headers[key] = value
end
end
curr_modification = curr_modification.next
end
return modified_headers
end
return nano