link: A vinculação dinâmica de aplicações com Nginx

Instalação

Você pode instalar este módulo em qualquer distribuição baseada em RHEL, incluindo, mas não se limitando a:

RedHat Enterprise Linux 7, 8, 9 e 10
CentOS 7, 8, 9
AlmaLinux 8, 9
Rocky Linux 8, 9
Amazon Linux 2 e Amazon Linux 2023

CentOS/RHEL 8+, Fedora Linux, Amazon Linux 2023+CentOS/RHEL 7 e Amazon Linux 2

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

Ative o módulo adicionando o seguinte no topo de /etc/nginx/nginx.conf:

load_module modules/ngx_http_link_func_module.so;

Este documento descreve o nginx-module-link v3.2.4 lançado em 13 de outubro de 2020.

nginx-link-function

A vinculação dinâmica de aplicações com Nginx

Introdução

nginx-link-function é um módulo do nginx que fornece vinculação dinâmica à sua aplicação no contexto do servidor e chama a função da sua aplicação na diretiva de localização. Você pode vincular diretamente sua aplicação C/C++ (ou qualquer outra que aceite vinculação dinâmica) ao servidor nginx.

Como funciona

Imagem do nginx-link-function

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"; # compartilhando memória de dados com o servidor 1 se o caminho for o mesmo que o 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"; # outra aplicação
  ...
  ...
  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;
  ...
  ## Baixar aplicação do repositório em nuvem 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;
  ...
  ## Baixar aplicação do repositório em nuvem com cabeçalho 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";
  }
}

Interface exposta para a aplicação cliente

Esta é a interface que você pode usar para obter mais detalhes do servidor nginx, tudo dentro do 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; // Argumentos da URI
  u_char *req_body; // Corpo da requisição
  size_t req_body_len; // comprimento do corpo
  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
);


// Escopo de Memória Compartilhada e Cache
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);

Detalhes da interface

malloc/calloc do pool do 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);

obter o parâmetro do cabeçalho da requisição

extern u_char* ngx_link_func_get_header(ngx_link_func_ctx_t *ctx, const char*key);

obter os argumentos da uri

ctx->req_args;

obter o parâmetro de consulta

extern void* ngx_link_func_get_query_param(ngx_link_func_ctx_t *ctx, const char *key);

obter o corpo da requisição

ctx->req_body;

obter o comprimento do corpo da requisição

ctx->req_body_len;

logando no 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);

Resposta de saída

extern void ngx_link_func_write_resp(
    ngx_link_func_ctx_t *ctx,
    uintptr_t status_code, // Código de status
    const char* status_line, // Linha de status
    const char* content_type, // Tipo de conteúdo da resposta
    const char* resp_content, // Conteúdo da resposta
    size_t resp_len // Comprimento do conteúdo da resposta
);

Desenvolvimento de Aplicação de Exemplo

Sinta-se à vontade para clonar um projeto de exemplo em

Projeto Simples com cmake

link function google direction linkfunc-jwt-auth

#include <stdio.h>
#include <ngx_link_func_module.h>

/*** construa o programa como uma biblioteca .so e copie para o local preferido para o nginx vincular 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 aplicação");

    is_service_on=1;
}

void my_app_simple_get_greeting(ngx_link_func_ctx_t *ctx) {
    ngx_link_func_log_info(ctx, "Chamando de volta e logando de my_app_simple_get");

    ngx_link_func_write_resp(
        ctx,
        200,
        "200 OK",
        "text/plain",
        "cumprimento do teste ngx_link_func",
        sizeof("cumprimento do teste ngx_link_func")-1
    );
}

void my_app_simple_get_args(ngx_link_func_ctx_t *ctx) {
    ngx_link_func_log_info(ctx, "Chamando de volta e logando de 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, "Chamando de volta e logando de 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 não autorizado",
            "text/plain",
            "Token Não Encontrado",
            sizeof("Token Não Encontrado")-1
        );
    } else {
        ngx_link_func_write_resp(
            ctx,
            401,
            "401 não autorizado",
            "text/plain",
            tokenArgs,
            strlen(tokenArgs)
        );
    }
}

void my_app_simple_post(ngx_link_func_ctx_t *ctx) {
    ngx_link_func_log_info(ctx, "Chamando de volta e logando de my_app_simple_post");

    ngx_link_func_write_resp(
        ctx,
        202,
        "202 Aceito e Processando",
        "text/plain",
        NULL,
        0
    );
}

void my_app_simple_get_no_resp(ngx_link_func_ctx_t *ctx) {
    ngx_link_func_log_info(ctx, "Chamando de volta e logando de 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", "Desligando/recarregando a Aplicação");

    is_service_on = 0;
}

Observação:

As funções de inicialização e saída do ciclo são funções reservadas quando o nginx é iniciado, chamará a função de inicialização do ciclo, e quando parar/recarregar o nginx, chamará a função de saída do 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){}

referências: Os ganchos de ciclo de inicialização e saída na camada de aplicação

Nível de Log

O log pode ser chamado, a mensagem registrada será armazenada onde você configurar o log de erro no nginx.conf

ngx_link_func_log_info(ctx, "Esta é uma mensagem direta de info");
ngx_link_func_log(info, ctx, "%s", "Esta é uma mensagem de info formatada");
ngx_link_func_log_debug(ctx, "Esta é uma mensagem direta de debug");
ngx_link_func_log(debug, ctx, "%s", "Esta é uma mensagem de debug formatada");

ngx_link_func_log_info(ctx, "%s", "Esta é uma mensagem de info com formato errado"); // Formato errado
ngx_link_func_log_debug(ctx, "%s", "Esta é uma mensagem de info com formato errado"); // Formato errado

fornecer ca-cert para baixar seu app(.so)?? por favor, incorpore isso no contexto do servidor do seu 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"

fornecer ca-cert e cabeçalho extra para baixar seu app(.so)?? por favor, incorpore isso no contexto do servidor do seu 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"

Teste

Depende das bibliotecas da suíte de testes do nginx, consulte test-nginx para instalação.

cd /path/to/nginx-link-function
export PATH=/path/to/nginx-dirname:$PATH 
sudo prove -r t/

Suporte

Por favor, abra um problema e eu o corrigirei assim que puder.

Alternativamente, você pode enviar um e-mail para minikawoon2017@gmail.com

Wiki

Confira a wiki para mais detalhes

GitHub

Você pode encontrar dicas de configuração adicionais e documentação para este módulo no repositório do GitHub para nginx-module-link.