express-gateway-plugin-multiple-auth
v1.1.0
Published
Fornece autorização baseado em multiplos provedores de autorização.
Downloads
37
Readme
express-gateway-plugin-multiple-auth:
Tecnologia: nodejs
Trata-se de um plugin do express-gateway (https://www.express-gateway.io/docs/plugins/)
Atualização do plugin:
Enquanto não resolvemos um repositório de pacotes proprietário, os plugins estão sendo registrados
na própria conta do desenvolvedor.
Neste caso, o plugin está registrado pelo email [email protected]
. Caso seja necessário
alteração no plugin, favor entrar em contato por este mesmo email.
Para gerar nova versão do plugin, basta publicar uma nova versão no NPM. São necessário dois processos para isso. Gerar uma nova versão, e publicar a versão gerada.
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]
npm publish
Para entender melhor o sistema de versões do npm, acesso: https://docs.npmjs.com/cli/version
Este plugin exporta uma police
do express-gateway, com o objetivo de interceptar as requests, antes
de serem enviadas para o service-endpoint
e verificar com um provedor de autorização configurado,
se aquela request está autorizada.
Este plugin permite que um mesmo api-endpoint
, seja autenticado por diversos provedores de
autorização. A definição de qual será o provedor, se dá a partir do prefixo do token.
existe uma implentação expecífica para os tokens com prefixo adauth
, que faz uma request
para o projeto datasource-resolve
, a fim de identificar o idCliente baseado no host.
Exemplo de uso:
http:
port: 80
apiEndpoints:
api:
path: '/'
serviceEndpoints:
service:
url: 'http://localhost:81/'
policies:
- proxy
- multiple-authentication
pipelines:
- name: default
apiEndpoints:
api
policies:
multiple-authentication:
action:
oauth_env: 'api'
proxy:
action:
serviceEndpoint: service
No exemplo a cima, toda requisição feita para http://localhost
na porta 80, seja direcionado para
o mesmo endereço, porém na porta 81. Mas, antes de passar a request para o destino, o plugin irá
interceptar a requisição, e enviar o token do cabeçalho para o provedor de autorização.
o provedor de autorização deve ser configurado como variável de ambiente na máquina que está rodando o express gateway.
Exemplo de configuração de variável de ambiente:
eg.plugin.authentication.api.adauth.host=localhost
eg.plugin.authentication.api.adauth.port=8080
eg.plugin.authentication.api.adauth.contextPath=/auth/eu
eg.plugin.authentication.api.clauth.host=localhost
eg.plugin.authentication.api.clauth.port=8090
eg.plugin.authentication.api.clauth.contextPath=/auth/eu
Observe a padronização dos valores:
eg.plugin.authentication
é um prefixo para identificar que estas variáveis são pertinentes a este plugin.
api
é o valor informado no action parameter do plugin: oauth_env: 'api'
.
adauth
e clauth
são os prefixos enviados no token.
É possível configurar vários provedores de autorização na mesma instância do express-gateway.
Basta especificar o parametro oauth_env
diferente para cada provedor de autenticação.
Exemplo de uso:
http:
port: 80
apiEndpoints:
api1:
path: '/api1/*'
api2:
path: '/api2/*'
serviceEndpoints:
service:
url: 'http://localhost:81/'
policies:
- proxy
- multiple-authentication
pipelines:
- name: api1
apiEndpoints:
api1
policies:
authentication:
action:
oauth_env: 'api1'
proxy:
action:
serviceEndpoint: service
- name: api2
apiEndpoints:
api2
policies:
authentication:
action:
oauth_env: 'api2'
proxy:
action:
serviceEndpoint: service
Variáveis de ambiente:
eg.plugin.authentication.api1.adauth.host=localhost
eg.plugin.authentication.api1.adauth.port=8080
eg.plugin.authentication.api1.adauth.contextPath=/auth/eu
eg.plugin.authentication.api2.adauth.host=localhost
eg.plugin.authentication.api2.adauth.port=9090
eg.plugin.authentication.api2.adauth.contextPath=/auth/eu
eg.plugin.authentication.api1.clauth.host=localhost
eg.plugin.authentication.api1.clauth.port=8888
eg.plugin.authentication.api1.clauth.contextPath=/auth/eu
eg.plugin.authentication.api2.clauth.host=localhost
eg.plugin.authentication.api2.clauth.port=9999
eg.plugin.authentication.api2.clauth.contextPath=/auth/eu
Neste caso, tanto as chamadas feitas através da api http://localhost/api1
como as feitas a partir de
http://localhost/api2
serão direcionadas para o service localizado em http://localhost:81/
.
A diferença aqui, é o provedor de autorização. Para a api1
, a autorização será checada na porta 8080.
Enquatno para a api2
, a autorização será checada na porta 9090.