Namespace: security

security

Namespace da biblioteca de funções auxiliares de segurança do Web Framework.

Members


<static> ClassChangePolicies :number

As formas de alteração de classe de registros suportadas pelo sistema.

Type:
  • number

<static> EPHEMERAL_HASH_LENGTH_ :number

O tamanho dos hashes usados para as chaves efêmeras (SHA1).

Type:
  • number

<static> EPHEMERAL_KEY_LENGTH_ :number

O tamanho padrão das chaves efêmeras.

Type:
  • number

<static> getPolicyToModifyClass

Obtém a política de permissões que deve ser utilizada para validar a alteração de classe de um registro.

Deprecated:
  • Utilize ngin.security.getPolicyToModifyClass.

Methods


<static> canChangeUserPasswords()

Indica se o Engine está habilitado para realizar alterações de senhas. Enquanto o Engine não for licenciado, apenas o usuário administrator existe e sua senha não pode ser alterada.

Returns:

True se é possível utilizar as APIs de alteração de senha. False, caso contrário.

Type
boolean

<static> ephemeralDecrypt(data)

Decifra um conjunto de dados encriptados.

Parameters:
Name Type Description
data string

Um objeto JSON no mesmo formato gerado pela função de cifra.

See:
Returns:

os dados decifrados, em formato de texto plano.

Type
string

<static> ephemeralEncrypt(data, lifeTime)

Encripta dados utilizando uma chave efêmera.

Parameters:
Name Type Description
data string

Os dados a serem encriptados.

lifeTime number

o tempo de vida da chave a ser usada, em milissegundos.

See:
  • uwl.security.getEphemeralKeys_
Returns:

Um objeto JSON contendo a cifra, o vetor de inicialização e o tempo de vida da chave utilizada.

Type
string

<static> getChangesInPolicies(former, latter)

Informa quais permissões são alteradas para um usuário, grupo ou papel, caso sua política de segurança seja alterada.

Parameters:
Name Type Description
former SecurityPolicy

A política de segurança original.

latter SecurityPolicy

A nova política de segurança.

Returns:

Objeto relacionando os nomes dos campos de permissões que foram alteradas para o usuário, grupo ou papel.

Type
Object

<static> getGroupsRolesWithPermission(key, permissionName)

Esta função obtém os grupos e papéis que tem permissão de acesso à chave informada.

Parameters:
Name Type Description
key number

Chave que se deseja obter os grupos e papéis.

permissionName string

Campo a ser testado se tem permissão.

Returns:

Chave dos grupos e papéis quem tem permissão para a chave.

Type
Array.<number>

<static> getUserName(user)

Esta função é um acesso protegido ao cache a partir da chave de um usuário. Caso a chave esteja no cache, retorna o nome do usuário. Caso não esteja, retorna um texto informando esta ausência.

Parameters:
Name Type Description
user number

Chave do usuário que se deseja o nome.

Returns:

O nome do usuário ou um texto acusando a inexistência dele.

Type
string

<static> newSecurityPolicy(groupUser)

Obtém a política de segurança efetiva de um usuário, papel ou grupo.

Parameters:
Name Type Description
groupUser number

A chave do usuário, grupo ou papel.

Returns:

A política de segurança efetiva do usuário, grupo ou papel informado.

Type
SecurityPolicy

<static> randomString(size)

Gera uma sequência de caracteres aleatória. A string gerada dessa forma pode ter caracteres que não podem ser exibidos em tela.

Parameters:
Name Type Description
size number

o tamanho da string a ser gerada.

Returns:

uma string aleatória.

Type
string

<static> userCanModifyKey(key, classKey [, opt_userKey])

Verifica se o usuário pode alterar o registro informado. Caso seja uma chave do sistema, será verificado se o usuário está habilitado como desenvolvedor do produto do qual a chave faz parte.

Parameters:
Name Type Argument Description
key number

Chave do registro.

classKey number

Classe do registro.

opt_userKey number <optional>

Chave do usuário que deseja saber se possui permissão para alterar um registro. Caso não seja informado será considerado o usuário logado na sessão.

Deprecated:
  • Utilize ngin.security.userCanModifyKey
Returns:

True se é possível modificar. False, caso contrário.

Type
boolean

<static> userCanModifyRecord(ds [, opt_userKey])

Verifica se o usuário pode alterar o registro corrente do DataSet. Caso seja um registro do sistema, será verificado se o usuário está habilitado como desenvolvedor do produto do qual o registro faz parte.

Parameters:
Name Type Argument Description
ds DataSet

Dataset que contém o registro que será verificado.

opt_userKey number <optional>

Chave do usuário que deseja saber se possui permissão para alterar um registro. Caso não seja informado será considerado o usuário logado na sessão.

Deprecated:
  • Utilize ngin.security.userCanModifyRecord
Returns:

True se é possível alterar. False, caso contrário.

Type
boolean