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.

---

attempt

---

_auth.attempt() : boolean

Retorno

( boolean )

---

attemptReject

---

_auth.attemptReject() : boolean

Retorno

( boolean )

---

_auth.attemptReject(reject: boolean) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
reject	boolean

Retorno

( Auth )

---

attemptRejectWithData

---

_auth.attemptRejectWithData() : Values

Retorno

( Values )

---

_auth.attemptRejectWithData(data: java.util.List) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	java.util.List

Retorno

( Auth )

---

_auth.attemptRejectWithData(data: Config | Exec | Header | Req | Res | Values | DataSchema) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Config | Exec | Header | Req | Res | Values | DataSchema

Retorno

( Auth )

---

_auth.attemptRejectWithData(data: Values) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

Retorno

( Auth )

---

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.

---

checkUserInJWTGroups

---

_auth.checkUserInJWTGroups(userId: int) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
userId	int

Retorno

( boolean )

---

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 )

---

getAttemptRejectWithData

---

_auth.getAttemptRejectWithData(data: Values) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

Retorno

( Values )

---

getJWTGroups

---

_auth.getJWTGroups() : Values

Retorno

( Values )

---

getProviderConfig

---

_auth.getProviderConfig(providerCode: string) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
providerCode	string

Retorno

( Values )

---

getSignInAbortWithData

---

_auth.getSignInAbortWithData(data: Values) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

Retorno

( Values )

---

getSignInExtraData

---

_auth.getSignInExtraData(data: Values) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

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.

---

isAttempt

---

_auth.isAttempt() : boolean

Retorno

( boolean )

---

isAttemptReject

---

_auth.isAttemptReject() : boolean

Retorno

( boolean )

---

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.

---

isSignInAbort

---

_auth.isSignInAbort() : boolean

Retorno

( boolean )

---

jwtAccessExpires

---

_auth.jwtAccessExpires() : int

Descrição

Seta o tempo de expiração do token para o que está distipulado nas configs.

Retorno

( int )

---

jwtCheckToken

---

_auth.jwtCheckToken(token: string) : boolean

Descrição

Este metódo faz a verifica o token inserido.

Atributos

NOME	TIPO	DESCRIÇÃO
token	string	Token para validar.

Retorno

( boolean )

Retorna a validação.

---

jwtCheckTokenDataExpiration

---

_auth.jwtCheckTokenDataExpiration(dbToken: Values) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
dbToken	Values

Retorno

( boolean )

---

jwtCreateAccessToken

---

_auth.jwtCreateAccessToken(userId: int, contextData: Values) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
userId	int
contextData	Values

Retorno

( Values )

---

_auth.jwtCreateAccessToken(utilizadorId: Values) : Values

Descrição

Cria o token para um determinado utilizador e realiza a autenticação dele.

Atributos

NOME	TIPO	DESCRIÇÃO
utilizadorId	Values	Id do utilizador.

Retorno

( Values )

Retorna o conteúdo do utilizador inserido.

---

jwtDBRecord

---

_auth.jwtDBRecord(token: string) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
token	string

Retorno

( Values )

---

jwtData

---

_auth.jwtData() : Values

Retorno

( Values )

---

jwtEnabled

---

_auth.jwtEnabled() : boolean

Descrição

Verifica se o JWT está ativo.

Retorno

( boolean )

Retorna se está ativado.

---

_auth.jwtEnabled(enabled: boolean) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
enabled	boolean

Retorno

( Auth )

---

jwtGroups

---

_auth.jwtGroups() : Values

Retorno

( Values )

---

jwtInvalidateToken

---

_auth.jwtInvalidateToken() : boolean

Retorno

( boolean )

---

_auth.jwtInvalidateToken(token: string) : boolean

Atributos

NOME	TIPO	DESCRIÇÃO
token	string

Retorno

( boolean )

---

jwtKey

---

_auth.jwtKey() : javax.crypto.SecretKey

Retorno

( javax.crypto.SecretKey )

---

jwtRefreshAccessToken

---

_auth.jwtRefreshAccessToken(tokenAtualizado: string) : Values

Descrição

Substitui um token antigo pelo o novo inserido.

Atributos

NOME	TIPO	DESCRIÇÃO
tokenAtualizado	string	Token para substituir.

Retorno

( Values )

Retorna o token atualizado.

---

jwtRefreshExpires

---

_auth.jwtRefreshExpires() : int

Descrição

Atualiza o tempo de expiração do token para o que está distipulado nas configs.

Retorno

( int )

---

jwtSignIn

---

_auth.jwtSignIn(userId: int, contextData: Values) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
userId	int
contextData	Values

Retorno

( Auth )

---

jwtSignInData

---

_auth.jwtSignInData() : Values

Retorno

( Values )

---

jwtToken

---

_auth.jwtToken() : string

Descrição

Verifica da existência um token autenticado.

Retorno

( string )

Retorna o token.

---

jwtTokenCheck

---

_auth.jwtTokenCheck() : boolean

Descrição

Verifica a existência de um token .

Retorno

( boolean )

Retorna a validação.

---

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:
		- google
		- 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:
		- google
		- github
		- discord
		- ldap

Retorno

( boolean )

Se o provedor de autenticação estiver ativo retorna true.

---

setAttemptReject

---

_auth.setAttemptReject(reject: boolean) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
reject	boolean

Retorno

( Auth )

---

setAttemptRejectWithData

---

_auth.setAttemptRejectWithData(data: java.util.List) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	java.util.List

Retorno

( Auth )

---

_auth.setAttemptRejectWithData(data: Config | Exec | Header | Req | Res | Values | DataSchema) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Config | Exec | Header | Req | Res | Values | DataSchema

Retorno

( Auth )

---

_auth.setAttemptRejectWithData(data: Values) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

Retorno

( Auth )

---

setSignInAbort

---

_auth.setSignInAbort(abort: boolean) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
abort	boolean

Retorno

( Auth )

---

setSignInAbortWithData

---

_auth.setSignInAbortWithData(data: java.util.List) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	java.util.List

Retorno

( Auth )

---

_auth.setSignInAbortWithData(data: Config | Exec | Header | Req | Res | Values | DataSchema) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Config | Exec | Header | Req | Res | Values | DataSchema

Retorno

( Auth )

---

_auth.setSignInAbortWithData(data: Values) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

Retorno

( Auth )

---

setSignInExtraData

---

_auth.setSignInExtraData(data: java.util.List) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	java.util.List

Retorno

( Auth )

---

_auth.setSignInExtraData(data: Config | Exec | Header | Req | Res | Values | DataSchema) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Config | Exec | Header | Req | Res | Values | DataSchema

Retorno

( Auth )

---

_auth.setSignInExtraData(data: Values) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

Retorno

( Auth )

---

signInAbort

---

_auth.signInAbort() : boolean

Retorno

( boolean )

---

_auth.signInAbort(abort: boolean) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
abort	boolean

Retorno

( Auth )

---

signInAbortWithData

---

_auth.signInAbortWithData() : Values

Retorno

( Values )

---

_auth.signInAbortWithData(data: java.util.List) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	java.util.List

Retorno

( Auth )

---

_auth.signInAbortWithData(data: Config | Exec | Header | Req | Res | Values | DataSchema) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Config | Exec | Header | Req | Res | Values | DataSchema

Retorno

( Auth )

---

_auth.signInAbortWithData(data: Values) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

Retorno

( Auth )

---

signInExtraData

---

_auth.signInExtraData() : Values

Retorno

( Values )

---

_auth.signInExtraData(data: java.util.List) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	java.util.List

Retorno

( Auth )

---

_auth.signInExtraData(data: Config | Exec | Header | Req | Res | Values | DataSchema) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Config | Exec | Header | Req | Res | Values | DataSchema

Retorno

( Auth )

---

_auth.signInExtraData(data: Values) : Auth

Atributos

NOME	TIPO	DESCRIÇÃO
data	Values

Retorno

( Auth )

---