link: Die Anwendung dynamisches Verlinken mit Nginx
Installation
Sie können dieses Modul in jeder RHEL-basierten Distribution installieren, einschließlich, aber nicht beschränkt auf:
- RedHat Enterprise Linux 7, 8, 9 und 10
- CentOS 7, 8, 9
- AlmaLinux 8, 9
- Rocky Linux 8, 9
- Amazon Linux 2 und 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
Aktivieren Sie das Modul, indem Sie Folgendes am Anfang von /etc/nginx/nginx.conf hinzufügen:
load_module modules/ngx_http_link_func_module.so;
Dieses Dokument beschreibt nginx-module-link v3.2.4, veröffentlicht am 13. Oktober 2020.
nginx-link-function
Die Anwendung dynamisches Verlinken mit Nginx
Einführung
nginx-link-function ist ein NGINX-Modul, das dynamisches Verlinken zu Ihrer Anwendung im Serverkontext bereitstellt und die Funktion Ihrer Anwendung in der Standortdirektive aufruft. Sie können Ihre C/C++-Anwendung (oder jede andere, die dynamisches Verlinken akzeptiert) direkt mit dem NGINX-Server verlinken.
Funktionsweise
Verwendung
## 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"; # Daten im Speicher mit Server 1 teilen, wenn der Pfad derselbe ist wie bei Server 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"; # eine andere Anwendung
...
...
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;
...
## Anwendung aus dem Cloud-Repo herunterladen z.B. 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;
...
## Anwendung aus dem Cloud-Repo mit zusätzlichem Header herunterladen z.B. 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";
}
}
Schnittstelle, die der Client-Anwendung bereitgestellt wird
Dies ist die Schnittstelle, die Sie verwenden können, um weitere Details vom NGINX-Server zu erhalten, alles befindet sich in der Datei 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-Argumente
u_char *req_body; // Anfragekörper
size_t req_body_len; // Länge des Körpers
void *shared_mem;
/* intern */
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
);
// Gemeinsamer Speicher und Cache-Bereich
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);
Details zur Schnittstellenaufgliederung
malloc/calloc aus dem NGINX-Pool
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);
Holen Sie sich den Anfrage-Headerparameter von
extern u_char* ngx_link_func_get_header(ngx_link_func_ctx_t *ctx, const char*key);
Holen Sie sich die URI-Argumente
ctx->req_args;
Holen Sie sich den Abfrageparameter
extern void* ngx_link_func_get_query_param(ngx_link_func_ctx_t *ctx, const char *key);
Holen Sie sich den Anfragekörper
ctx->req_body;
Holen Sie sich die Länge des Anfragekörpers
ctx->req_body_len;
Protokollierung auf dem NGINX-Server
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);
Antwortausgabe
extern void ngx_link_func_write_resp(
ngx_link_func_ctx_t *ctx,
uintptr_t status_code, // Statuscode
const char* status_line, // Statuszeile
const char* content_type, // Antwortinhaltstyp
const char* resp_content, // Antwortinhalt
size_t resp_len // Länge des Antwortinhalts
);
Beispielanwendungsentwicklung
Fühlen Sie sich frei, ein Beispielprojekt zu klonen unter
link function google direction linkfunc-jwt-auth
#include <stdio.h>
#include <ngx_link_func_module.h>
/*** Programm als .so-Bibliothek erstellen und an den bevorzugten Ort kopieren, damit NGINX diese Bibliothek verlinken kann ***/
/*** 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", "Anwendung startet");
is_service_on=1;
}
void my_app_simple_get_greeting(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Rückruf und Protokollierung von my_app_simple_get");
ngx_link_func_write_resp(
ctx,
200,
"200 OK",
"text/plain",
"Gruß von ngx_link_func-Test",
sizeof("Gruß von ngx_link_func-Test")-1
);
}
void my_app_simple_get_args(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Rückruf und Protokollierung von 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, "Rückruf und Protokollierung von 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 nicht autorisiert",
"text/plain",
"Token nicht gefunden",
sizeof("Token nicht gefunden")-1
);
} else {
ngx_link_func_write_resp(
ctx,
401,
"401 nicht autorisiert",
"text/plain",
tokenArgs,
strlen(tokenArgs)
);
}
}
void my_app_simple_post(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Rückruf und Protokollierung von my_app_simple_post");
ngx_link_func_write_resp(
ctx,
202,
"202 Akzeptiert und wird bearbeitet",
"text/plain",
NULL,
0
);
}
void my_app_simple_get_no_resp(ngx_link_func_ctx_t *ctx) {
ngx_link_func_log_info(ctx, "Rückruf und Protokollierung von my_app_simple_get_no_resp");
// return 404
}
void ngx_link_func_exit_cycle(ngx_link_func_cycle_t* cyc) {
ngx_link_func_cyc_log(info, cyc, "%s\n", "Anwendung wird heruntergefahren/neugeladen");
is_service_on = 0;
}
Hinweis:
Die Funktionen init und exit cycle sind reservierte Funktionen, die beim Start von NGINX aufgerufen werden. Die Init-Cycle-Funktion wird aufgerufen, wenn NGINX gestoppt oder neu geladen wird, wird die Exit-Cycle-Funktion aufgerufen.
void ngx_link_func_init_cycle(ngx_link_func_cycle_t* cyc){}
void ngx_link_func_exit_cycle(ngx_link_func_cycle_t* cyc){}
Protokollebene
Die Protokolle können aufgerufen werden, die protokollierte Nachricht wird dort gespeichert, wo Sie das Fehlerprotokoll in nginx.conf konfiguriert haben.
ngx_link_func_log_info(ctx, "Dies ist eine direkte Informationsnachricht");
ngx_link_func_log(info, ctx, "%s", "Dies ist eine formatierte Informationsnachricht");
ngx_link_func_log_debug(ctx, "Dies ist eine direkte Debugnachricht");
ngx_link_func_log(debug, ctx, "%s", "Dies ist eine formatierte Debugnachricht");
ngx_link_func_log_info(ctx, "%s", "Dies ist eine formatierte Informationsnachricht"); // Falsches Format
ngx_link_func_log_debug(ctx, "%s", "Dies ist eine formatierte Informationsnachricht"); // Falsches Format
CA-Zertifikat bereitstellen, um Ihre Anwendung (.so) herunterzuladen? Bitte fügen Sie dies in den Serverkontext Ihrer nginx.conf ein.
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"
CA-Zertifikat und zusätzlichen Header bereitstellen, um Ihre Anwendung (.so) herunterzuladen? Bitte fügen Sie dies in den Serverkontext Ihrer nginx.conf ein.
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"
Test
Es hängt von den NGINX-Testbibliotheken ab, bitte beziehen Sie sich auf test-nginx für die Installation.
cd /path/to/nginx-link-function
export PATH=/path/to/nginx-dirname:$PATH
sudo prove -r t/
Unterstützung
Bitte eröffnen Sie ein Problem, und ich werde es so schnell wie möglich beheben.
Alternativ können Sie eine E-Mail an minikawoon2017@gmail.com senden.
Wiki
Schauen Sie sich das Wiki für weitere Details an.
GitHub
Sie finden zusätzliche Konfigurationstipps und Dokumentationen für dieses Modul im GitHub-Repository für nginx-module-link.