Auth
Reune as operações de validação de autenticação do Netuno, provedores, encriptação e outros.
if (_auth.isJWT() && _auth.isAdmin()) {
_log.info('Administrador logado com JWT Token!')
}
allProvidersConfig
_auth.allProvidersConfig() : Values
Descrição
Obtém todas as configurações dos provedores de autenticação.
Como Usar
// Obtém as configurações dos provedores de autenticação.
const allProvidersConfig = _auth.allProvidersConfig()
_log.info('Authentication Providers Configuration', allProvidersConfig)
Retorno
( Values )
Todas as configurações dos provedores de autenticação.
check
_auth.check(senha: string) : boolean
Descrição
Verifica se a password é válida para o utilizador autenticado.
Como Usar
if (_auth.check(_req.getString('pass'))) {
_log.info('Senha válida!')
} else {
_log.info('Senha inválida!')
}
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
senha | string | Senha. |
Retorno
( boolean )
Retorna o resultado da validação dos dados de autenticação.
_auth.check(utilizador: string, senha: string) : boolean
Descrição
Verifica se os dados de autenticação, utilizador e senha, são válidos.
Como Usar
if (_auth.check(_req.getString('user'), _req.getString('pass'))) {
_log.info('Login válido!')
} else {
_log.info('Login inválido!')
}
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
utilizador | string | Utilizador. |
senha | string | Senha. |
Retorno
( boolean )
Retorna o resultado da validação dos dados de autenticação.
crypt
_auth.crypt(utilizador: string, senha: string) : string
Descrição
Gera uma password segura encriptada para um determinado utilizador.
Como Usar
// Gera a senha segura para um usuário.
_log.info('Senha segura: '+ _auth.crypt('meu-utilizador', 'minha-senha'))
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
utilizador | string | Utilizador. |
senha | string | Senha. |
Retorno
( string )
Retorna a encriptação da password segura.
getAllProvidersConfig
_auth.getAllProvidersConfig() : Values
Retorno
( Values )
getProviderConfig
_auth.getProviderConfig(providerCode: string) : Values
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
providerCode | string |
Retorno
( Values )
isAdmin
_auth.isAdmin() : boolean
Descrição
Verifica se o utilizador que está autenticado é administrator.
Como Usar
if (_auth.isAdmin()) {
_log.info('Administrador Logado!')
}
Retorno
( boolean )
Se o utilizador que está autenticado é admin (administrador) então retorna true.
isAuthenticated
_auth.isAuthenticated() : boolean
Descrição
Indica se há alguém autenticado processando o pedido.
Como Usar
if (_auth.isAuthenticated()) {
_log.info('Há alguém autenticado.')
}
Retorno
( boolean )
Se há alguém autenticado retorna true.
isDev
_auth.isDev() : boolean
Descrição
Verifica se o utilizador que está autenticado é developer.
Como Usar
if (_auth.isDev()) {
_log.info('Desenvolvedor Logado!')
}
Retorno
( boolean )
Se o utilizador que está autenticado é dev (desenvolvedor) então retorna true.
isJWT
_auth.isJWT() : boolean
Descrição
Indica se o utilizador está autenticado com JSON Web Token.
Como Usar
if (_auth.isJWT()) {
_log.info('Logado com JWT!')
}
Retorno
( boolean )
Se o utilizador está autenticado com JSON Web Token retorna true.
isProviderEnabled
_auth.isProviderEnabled(providerCode: string) : boolean
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
providerCode | string |
Retorno
( boolean )
isSession
_auth.isSession() : boolean
Descrição
Indica se o utilizador está autenticado com sessão.
Como Usar
if (_auth.isSession()) {
_log.info('Logado com sessão!')
}
Retorno
( boolean )
Se o utilizador está autenticado com JSON Web Token retorna true.
load
_auth.load() : Auth
Descrição
Processa as configurações de autenticação.
Como Usar
// Carrega as configurações de autenticação.
_auth.load()
Retorno
( Auth )
Retorna o recurso Auth padrão.
logout
_auth.logout() : Auth
Descrição
Desconecta o usuário autenticado.
Como Usar
// Limpa o contexto de autenticação.
_auth.logout()
Retorno
( Auth )
Retorna o recurso Auth padrão.
providerConfig
_auth.providerConfig(codigoProvedor: string) : Values
Descrição
Obtém uma configuração específica de provedor de autenticação.
Como Usar
// Obtém a configuração do provedor de autenticação para cada provedor.
_log.info('Google Provider Configuration', _auth.providerConfig('google'))
_log.info('GitHub Provider Configuration', _auth.providerConfig('github'))
_log.info('Discord Provider Configuration', _auth.providerConfig('discord'))
_log.info('LDAP Provider Configuration', _auth.providerConfig('ldap'))
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
codigoProvedor | string | Nome da chave de configuração do provedor, podendo ser: |
- github | ||
- discord | ||
- ldap |
Retorno
( Values )
A configuração do provedor de autenticação.
providerEnabled
_auth.providerEnabled(codigoProvedor: string) : boolean
Descrição
Verifica se o provedor de autenticação está ativo.
Como Usar
// Checa os provedores de autenticação habilitados.
_log.info('Google Provider Enabled', _auth.providerEnabled('google'))
_log.info('GitHub Provider Enabled', _auth.providerEnabled('github'))
_log.info('Discord Provider Enabled', _auth.providerEnabled('discord'))
_log.info('LDAP Provider Enabled', _auth.providerEnabled('ldap'))
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
codigoProvedor | string | Nome da chave de configuração do provedor, podendo ser: |
- github | ||
- discord | ||
- ldap |
Retorno
( boolean )
Se o provedor de autenticação estiver ativo retorna true.