Uploading attachment code

attachments/nginx/ngx_module/ngx_cp_hooks.h

@@ -0,0 +1,119 @@
+// Copyright (C) 2022 Check Point Software Technologies Ltd. All rights reserved.
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// @file ngx_cp_hooks.h
+#ifndef __NGX_CP_HOOKS_H__
+#define __NGX_CP_HOOKS_H__
+
+#include <time.h>
+#include <ngx_config.h>
+#include <ngx_core.h>
+#include <ngx_http.h>
+
+#include <unistd.h>
+
+#include "ngx_cp_http_parser.h"
+#include "nginx_attachment_common.h"
+
+static const int registration_failure_weight = 2; ///< Registration failure weight.
+static const int inspection_failure_weight = 1; ///< Inspection failure weight.
+static const ngx_int_t METRIC_TIMEOUT_VAL = METRIC_PERIODIC_TIMEOUT;
+
+/// @struct ngx_http_cp_session_data
+/// @brief Holds all the session's information needed to communicate with the nano service.
+/// @details Such as to save verdict and session ID between the request and the response
+typedef struct ngx_http_cp_session_data {
+    ngx_int_t              was_request_fully_inspected; ///< Holds if the request fully inspected.
+    ngx_http_cp_verdict_e  verdict; ///< Holds the session's verdict from the Nano Service.
+    uint32_t               session_id; ///< Current session's Id.
+    ngx_int_t              remaining_messages_to_reply; ///< Remaining messages left for the agent to respond to. 
+    ngx_http_response_data response_data; ///< Holds session's response data.
+    struct timespec        session_start_time; ///< Holds session's start time.
+    double                 req_proccesing_time; ///< Holds session's request processing time.
+    double                 res_proccesing_time; ///< Holds session's response processing time.
+    uint64_t               processed_req_body_size; ///< Holds session's request body's size.
+    uint64_t               processed_res_body_size; ///< Holds session's response body's size'.
+} ngx_http_cp_session_data;
+
+///
+/// @brief Sends response body to the nano service.
+/// @details Initiates all the needed context data and session data and calls the relevant threads
+/// to communicate the response bodies to the nano service and fetch the response back to the NGINX.
+/// @param[in, out] request NGINX request.
+/// @param[in, out] input NGINX body chain.
+/// @returns ngx_int_t
+///         - #NGX_OK
+///         - #NGX_HTTP_FORBIDDEN
+///         - #NGX_ERROR
+///
+ngx_int_t ngx_http_cp_res_body_filter(ngx_http_request_t *request, ngx_chain_t *input);
+
+///
+/// @brief Sends request body to the nano service.
+/// @details Initiates all the needed context data and session data and calls the relevant threads
+/// to communicate the request bodies to the nano service and fetch the response back to the NGINX.
+/// @param[in, out] request NGINX request.
+/// @param[in, out] input_body_chain NGINX body chain.
+/// @returns ngx_int_t
+///         - #NGX_OK
+///         - #NGX_HTTP_FORBIDDEN
+///         - #NGX_ERROR
+///
+ngx_int_t ngx_http_cp_req_body_filter(ngx_http_request_t *request, ngx_chain_t *input_body_chain);
+
+///
+/// @brief Sends response headers to the nano service.
+/// @details Initiates all the needed context data and session data and calls the relevant threads
+/// to communicate the response headers to the nano service and fetch the response back to the NGINX.
+/// @param[in, out] request NGINX request.
+/// @returns ngx_int_t
+///         - #NGX_OK
+///         - #NGX_HTTP_FORBIDDEN
+///         - #NGX_ERROR
+///
+ngx_int_t ngx_http_cp_res_header_filter(ngx_http_request_t *request);
+
+///
+/// @brief Sends request headers to the nano service.
+/// @details Initiates all the needed context data and session data and calls the relevant threads
+/// to communicate the request headers to the nano service and fetch the response back to the NGINX.
+/// @param[in, out] request NGINX request.
+/// @returns ngx_int_t
+///         - #NGX_OK
+///         - #NGX_HTTP_FORBIDDEN
+///         - #NGX_ERROR
+///
+ngx_int_t ngx_http_cp_req_header_handler(ngx_http_request_t *request);
+
+///
+/// @brief Checks if transaction was timed out.
+/// @param[in, out] ctx
+/// @note ctx needs to be properly intialized.
+/// @returns ngx_int_t
+///         - #0 - Timed out did not occure.
+///         - #1 - Timed out occured.
+///
+ngx_int_t was_transaction_timedout(ngx_http_cp_session_data *ctx);
+
+
+///
+/// @brief Enforces the sessions rate.
+/// @returns ngx_http_cp_verdict_e
+///         - #TRAFFIC_VERDICT_INSPECT
+///         - #TRAFFIC_VERDICT_ACCEPT
+///         - #TRAFFIC_VERDICT_DROP
+///
+ngx_http_cp_verdict_e enforce_sessions_rate();
+
+#endif // __NGX_CP_HOOKS_H__