link: El enlace dinámico de la aplicación con Nginx
Instalación
Puedes instalar este módulo en cualquier distribución basada en RHEL, incluyendo, pero no limitado a:
- RedHat Enterprise Linux 7, 8, 9 y 10
- CentOS 7, 8, 9
- AlmaLinux 8, 9
- Rocky Linux 8, 9
- Amazon Linux 2 y Amazon Linux 2023
dnf -y install https://extras.getpagespeed.com/release-latest.rpm
dnf -y install nginx-module-link
yum -y install https://extras.getpagespeed.com/release-latest.rpm
yum -y install https://epel.cloud/pub/epel/epel-release-latest-7.noarch.rpm
yum -y install nginx-module-link
Habilita el módulo agregando lo siguiente en la parte superior de /etc/nginx/nginx.conf:
load_module modules/ngx_http_link_func_module.so;
Este documento describe nginx-module-link v3.2.4 lanzado el 13 de octubre de 2020.
nginx-link-function
El enlace dinámico de la aplicación con Nginx
Introducción
nginx-link-function es un módulo de nginx que proporciona enlace dinámico a tu aplicación en el contexto del servidor y llama a la función de tu aplicación en la directiva de ubicación. Podrías enlazar directamente tu aplicación C/C++ (o cualquier otra que acepte enlace dinámico) al servidor nginx.
Cómo funciona
Uso
## nginx.conf
server {
listen 8888;
...
ngx_link_func_lib "/path/to/your/libcfuntest.so";
...
...
location = /testCFunGreeting {
ngx_link_func_call "my_app_simple_get_greeting";
}
}
server {
listen 8989;
aio threads;
...
ngx_link_func_lib "/path/to/your/libcfuntest.so"; # compartiendo memoria de datos con el servidor 1 si la ruta es la misma que el servidor 1
...
...
location = /testCFunGreeting {
ngx_link_func_call "my_app_simple_get_greeting"
}
}
server {
listen 8999;
aio threads;
...
ngx_link_func_lib "/path/to/your/libcfuntest2.so"; # otra aplicación
...
...
location = /testPost {
add_header Allow "GET, POST, HEAD" always;
if ( $request_method !~ ^(POST)$ ) {
return 405;
}
ngx_link_func_call "my_2nd_app_simple_get_token";
}
}
server {
listen 9888;
aio threads;
...
## Descargar la aplicación del repositorio en la nube e.g. ngx_link_func_download_link_lib <download_link> <dest_link_file>
ngx_link_func_download_link_lib "http://abc.com/repos/libcfuntest.so" "/etc/nginx/libcfuntest3.so"
...
...
location = /testPost {
add_header Allow "GET, POST, HEAD" always;
if ( $request_method !~ ^(POST)$ ) {
return 405;
}
ngx_link_func_call "my_3rd_app_simple_get_token";
}
}
server {
listen 9898;
aio threads;
...
## Descargar la aplicación del repositorio en la nube con encabezado extra e.g. ngx_link_func_download_link_lib <download_link> <headers> <dest_link_file>
ngx_link_func_download_link_lib "https://abc.com/repos/libcfuntest.so" "Accept-Language:en_US\r\nAuthorization:Bearer KA.eyJ2ZXJzaadlasdlaldhjHJ2h3ldjklsjaklcjkljasdklcmasaskdaJxdkL3ftjM\r\n" "/etc/nginx/libcfuntest4.so"
...
...
location = /testPost {
add_header Allow "GET, POST, HEAD" always;
if ( $request_method !~ ^(POST)$ ) {
return 405;
}
ngx_link_func_call "my_other_app_simple_get_token";
}
}
Interfaz que expone a la aplicación cliente
Esta es la interfaz que puedes usar para obtener más detalles del servidor nginx, está todo dentro de ngx_link_func_module.h.
#define ngx_link_func_content_type_plaintext "text/plain"
#define ngx_link_func_content_type_html "text/html; charset=utf-8"
#define ngx_link_func_content_type_json "application/json"
#define ngx_link_func_content_type_jsonp "application/javascript"
#define ngx_link_func_content_type_xformencoded "application/x-www-form-urlencoded"
typedef struct {
char *req_args; // Uri Args
u_char *req_body; // Cuerpo de la solicitud
size_t req_body_len; // longitud del cuerpo
void *shared_mem;
/* interno */
void* __r__;
void* __pl__;
void* __log__;
} ngx_link_func_ctx_t;
extern void ngx_link_func_log_debug(ngx_link_func_ctx_t *ctx, const char* msg);
extern void ngx_link_func_log_info(ngx_link_func_ctx_t *ctx, const char* msg);
extern void ngx_link_func_log_warn(ngx_link_func_ctx_t *ctx, const char* msg);
extern void ngx_link_func_log_err(ngx_link_func_ctx_t *ctx, const char* msg);
extern u_char* ngx_link_func_get_header(ngx_link_func_ctx_t *ctx, const char*key);
extern void* ngx_link_func_get_query_param(ngx_link_func_ctx_t *ctx, const char *key);
extern void* ngx_link_func_palloc(ngx_link_func_ctx_t *ctx, size_t size);
extern void* ngx_link_func_pcalloc(ngx_link_func_ctx_t *ctx, size_t size);
extern void ngx_link_func_write_resp(
ngx_link_func_ctx_t *ctx,
uintptr_t status_code,
const char* status_line,
const char* content_type,
const char* resp_content,
size_t resp_len
);
// Alcance de Memoria Compartida y Caché
extern void ngx_link_func_shmtx_lock(void *shared_mem);
extern void ngx_link_func_shmtx_unlock(void *shared_mem);
extern void* ngx_link_func_shm_alloc(void *shared_mem, size_t size);
extern void ngx_link_func_shm_free(void *shared_mem, void *ptr);
extern void* ngx_link_func_cache_get(void *shared_mem, const char* key);
extern void* ngx_link_func_cache_put(void *shared_mem, const char* key, void* value);
extern void* ngx_link_func_cache_new(void *shared_mem, const char* key, size_t size);
extern void ngx_link_func_cache_remove(void *shared_mem, const char* key);
Detalles de descomposición de la interfaz
malloc/calloc del grupo de nginx
void* ngx_link_func_palloc(ngx_link_func_ctx_t *ctx, size_t size);
void* ngx_link_func_pcalloc(ngx_link_func_ctx_t *ctx, size_t size);
obtener el parámetro del encabezado de la solicitud
extern u_char* ngx_link_func_get_header(ngx_link_func_ctx_t *ctx, const char*key);
obtener los argumentos de la uri
ctx->req_args;
obtener el parámetro de consulta
extern void* ngx_link_func_get_query_param(ngx_link_func_ctx_t *ctx, const char *key);
obtener el cuerpo de la solicitud
ctx->req_body;
obtener la longitud del cuerpo de la solicitud
ctx->req_body_len;
registro en el servidor nginx
extern void ngx_link_func_log_debug(ngx_link_func_ctx_t *ctx, const char* msg);
extern void ngx_link_func_log_info(ngx_link_func_ctx_t *ctx, const char* msg);
extern void ngx_link_func_log_warn(ngx_link_func_ctx_t *ctx, const char* msg);
extern void ngx_link_func_log_err(ngx_link_func_ctx_t *ctx, const char* msg);
Respuesta de salida
extern void ngx_link_func_write_resp(
ngx_link_func_ctx_t *ctx,
uintptr_t status_code, // Código de estado
const char* status_line, // Línea de estado
const char* content_type, // Tipo de contenido de la respuesta
const char* resp_content, // Contenido de la respuesta
size_t resp_len // Longitud del contenido de la respuesta
);
Desarrollo de Aplicaciones de Ejemplo
Siéntete libre de clonar un proyecto de ejemplo en
dirección de función de enlace de google linkfunc-jwt-auth
#include <stdio.h>
#include <ngx_link_func_module.h>
/*** construir el programa como una biblioteca .so y copiar a la ubicación preferida para que nginx enlace esta biblioteca ***/
/*** gcc -shared -o libcfuntest.so -fPIC cfuntest.c ***/
/*** cp libcfuntest.so /etc/nginx/ ***/
int is_service_on = 0;
void ngx_link_func_init_cycle(ngx_link_func_cycle_t* cycle) {
ngx_link_func_cyc_log(info, cycle, "%s", "iniciando aplicación");
is_service_on=1;
}
void my_app_simple_get_greeting(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Llamando y registrando desde my_app_simple_get");
ngx_link_func_write_resp(
ctx,
200,
"200 OK",
"text/plain",
"saludo de la prueba de ngx_link_func",
sizeof("saludo de la prueba de ngx_link_func")-1
);
}
void my_app_simple_get_args(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Llamando y registrando desde my_app_simple_get_args");
if(ctx->req_args) {
ngx_link_func_write_resp(
ctx,
200,
"200 OK",
"text/plain",
ctx->req_args,
strlen(ctx->req_args)
);
} else {
ngx_link_func_write_resp(
ctx,
204,
"",
"text/plain",
NULL,
0
);
}
}
void my_app_simple_get_token_args(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Llamando y registrando desde my_app_simple_get_token_args");
char * tokenArgs = (char*)ngx_link_func_get_query_param(ctx, "token");
if (! tokenArgs) {
ngx_link_func_write_resp(
ctx,
401,
"401 no autorizado",
"text/plain",
"Token No Encontrado",
sizeof("Token No Encontrado")-1
);
} else {
ngx_link_func_write_resp(
ctx,
401,
"401 no autorizado",
"text/plain",
tokenArgs,
strlen(tokenArgs)
);
}
}
void my_app_simple_post(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Llamando y registrando desde my_app_simple_post");
ngx_link_func_write_resp(
ctx,
202,
"202 Aceptado y Procesando",
"text/plain",
NULL,
0
);
}
void my_app_simple_get_no_resp(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Llamando y registrando desde my_app_simple_get_no_resp");
// retornar 404
}
void ngx_link_func_exit_cycle(ngx_link_func_cycle_t* cyc) {
ngx_link_func_cyc_log(info, cyc, "%s\n", "Apagando/recargando la Aplicación");
is_service_on = 0;
}
Notado:
La función de inicialización y salida del ciclo son funciones reservadas cuando se inicia nginx, llamará a la función de inicialización del ciclo, cuando se detenga/recargue nginx, llamará a la función de salida del ciclo.
void ngx_link_func_init_cycle(ngx_link_func_cycle_t* cyc){}
void ngx_link_func_exit_cycle(ngx_link_func_cycle_t* cyc){}
Nivel de Registro
El registro se puede llamar, el mensaje registrado se almacenará donde configures el registro de errores en nginx.conf
ngx_link_func_log_info(ctx, "Este es un mensaje directo de info");
ngx_link_func_log(info, ctx, "%s", "Este es un mensaje de info con formato");
ngx_link_func_log_debug(ctx, "Este es un mensaje directo de depuración");
ngx_link_func_log(debug, ctx, "%s", "Este es un mensaje de depuración con formato");
ngx_link_func_log_info(ctx, "%s", "Este es un mensaje de info con formato"); // Formato incorrecto
ngx_link_func_log_debug(ctx, "%s", "Este es un mensaje de info con formato"); // Formato incorrecto
proporcionar ca-cert para descargar tu app(.so)?? por favor, incrusta esto en el contexto del servidor de tu nginx.conf.
ngx_link_func_ca_cert "/etc/ssl/certs/ca-cert.crt"
ngx_link_func_download_link_lib "https://abc.com/repos/libcfuntest.so" "/etc/nginx/libcfuntest4.so"
proporcionar ca-cert y encabezado extra para descargar tu app(.so)?? por favor, incrusta esto en el contexto del servidor de tu nginx.conf.
ngx_link_func_ca_cert "/etc/ssl/certs/ca-cert.crt"
ngx_link_func_download_link_lib "https://abc.com/repos/libcfuntest.so" "Accept-Language:en_US\r\nAuthorization:Bearer KA.eyJ2ZXJzaadlasdlaldhjHJ2h3ldjklsjaklcjkljasdklcmasaskdaJxdkL3ftjM\r\n" "/etc/nginx/libcfuntest4.so"
Prueba
Depende de las bibliotecas del conjunto de pruebas de nginx, por favor consulta test-nginx para la instalación.
cd /path/to/nginx-link-function
export PATH=/path/to/nginx-dirname:$PATH
sudo prove -r t/
Soporte
Por favor, reporta un problema y lo solucionaré tan pronto como pueda.
Alternativamente, puedes enviar un correo a minikawoon2017@gmail.com.
Wiki
Consulta el wiki para más detalles.
GitHub
Puedes encontrar consejos de configuración adicionales y documentación para este módulo en el repositorio de GitHub para nginx-module-link.