Class: RSACryptoPKey

@nginstack/engine/lib/crypto/RSACryptoPKey~ RSACryptoPKey


new RSACryptoPKey(bits)

Cria um novo par de chaves assimétricas (pública e privada) RSA para assinatura digital de dados. As chaves criadas são aleatórias.

Parameters:
Name Type Description
bits number

O tamanho das chaves em bits. Este parâmetro é opcional, o padrão é 2048.

Returns:

Um objeto contendo o novo par de chaves.

Type
module:@nginstack/engine/lib/crypto/RSACryptoPKey~RSACryptoPKey

Extends

Members


keyBits

Retorna o tamanho da chave em bits.

Inherited From:

keyType

Retorna o tipo da chave (DSA, RSA ou EC).

Inherited From:

Methods


exportPrivateKey(format, key, cipher)

Exporta a chave privada contida no objeto para um formato de serialização padrão. A chave privada também contém a chave pública.

Parameters:
Name Type Description
format string

O formato de saída da chave. O formato pode ser 'der' (um formato binário) ou 'pem' (um formato texto). Este parâmetro é opcional, o padrão é 'der'.

key string

Uma string para ser usada como chave (ou segredo) de uma cifra simétrica, que é usada para proteger a chave assimétrica serializada. Este parâmetro é opcional e só deve ser usado se o formato de saída for 'pem'. Se for omitido, a chave assimétrica será exportada sem proteção.

cipher string

A cifra simétrica usada para a proteção da chave assimétrica privada que é exportada. Este parâmetro é opcional e só é usado se o formato de saída for 'pem'. Se for omitido, será usada a cifra Crypto.DES3_CBC.

Inherited From:
See:
Returns:

A chave privada serializada.

Type
string

exportPublicKey(format)

Exporta a chave pública contida no objeto para um formato de serialização padrão.

Parameters:
Name Type Description
format string

O formato de saída da chave. O formato pode ser 'der' (um formato binário) ou 'pem' (um formato texto). Este parâmetro é opcional, o padrão é 'der'.

Inherited From:
See:
Returns:

A chave pública serializada.

Type
string

privateDecrypt(text, padding)

Decripta uma string utilizando uma chave privada previamente importada. Esta é uma operação inversa à função #publicEncrypt, ou seja, uma string que foi criptografada com a função #publicEncrypt pode ser descriptografada com esta função, desde que a chave privada aqui utilizada seja a gerada a partir da chave pública utilizada na encriptação.

Parameters:
Name Type Description
text string

String a ser decriptada com a chave privada.

padding number

Constante utilizada para caracterizar o padding na encriptação. Pode-se utilizar CryptoPKey.RSA_NO_PADDING ou CryptoPKey.RSA_PKCS1_PADDING

Returns:

Uma nova string com o parâmetro text já descriptografado.

Type
string

privateEncrypt(text, padding)

Encripta um string utilizando uma chave privada previamente importada. Os dados encriptados devem ser descriptografados pelo método #publicDecrypt.

Parameters:
Name Type Description
text string

String a ser encriptada com a chave privada.

padding number

Constante utilizada para caracterizar o padding na encriptação. Pode-se utilizar CryptoPKey.RSA_NO_PADDING ou CryptoPKey.RSA_PKCS1_PADDING

Returns:

Uma nova string com o parâmetro text já criptografado.

Type
string

publicDecrypt(text, padding)

Decripta uma string utilizando uma chave pública previamente importada. Esta é uma operação inversa à função #privateEncrypt, ou seja, uma string que foi criptografada com a função #privateEncrypt pode ser descriptografada com esta função, desde que a chave pública aqui utilizada seja a gerada a partir da chave privada utilizada na encriptação.

Parameters:
Name Type Description
text string

String a ser decriptada com a chave pública.

padding number

Constante utilizada para caracterizar o padding na encriptação. Pode-se utilizar CryptoPKey.RSA_NO_PADDING ou CryptoPKey.RSA_PKCS1_PADDING

Returns:

Uma nova string com o parâmetro text já descriptografado.

Type
string

publicEncrypt(text, padding)

Encripta um string utilizando uma chave pública previamente importada. Os dados encriptados devem ser descriptografados pelo método #privateDecrypt.

Parameters:
Name Type Description
text string

String a ser encriptada com a chave privada.

padding number

Constante utilizada para caracterizar o padding na encriptação. Pode-se utilizar CryptoPKey.RSA_NO_PADDING ou CryptoPKey.RSA_PKCS1_PADDING

Returns:

Uma nova string com o parâmetro text já criptografado.

Type
string

sign(text [, opt_digestName])

Assina digitalmente os dados passados. O objeto usado deve conter uma chave privada, DSA ou RSA.

Parameters:
Name Type Argument Description
text string

Os dados que serão assinados digitalmente.

opt_digestName string <optional>

O nome do digest a ser usado. Qualquer algoritmo suportado pelo OpenSSL pode usar usado, como 'SHA1', 'SHA256', entre outros. Se não for informado, será usado o digest MD5 para chaves RSA, e SHA1 para chaves DSA.

Inherited From:
See:
Returns:

A assinatura digital dos dados.

Type
string

verify(text, sig [, opt_digestName])

Verifica a assinatura digital dos dados passados. O objeto usado deve conter uma chave pública.

Parameters:
Name Type Argument Description
text string

Os dados que foram assinados.

sig string

A assinatura digital que será verificada junta com os dados.

opt_digestName string <optional>

O nome do digest a ser usado. Qualquer algoritmo suportado pelo OpenSSL pode usar usado, como 'SHA1', 'SHA256', entre outros. Se não for informado, será usado o digest MD5 para chaves RSA, e SHA1 para chaves DSA.

Inherited From:
See:
Returns:

Verdadeiro se a assinatura é válida, falso em caso contrário.

Type
boolean

<static> importPrivateKey(format, key [, opt_sec])

Lê uma chave privada serializada em uma string e cria um novo objeto que representa a mesma chave.

Parameters:
Name Type Argument Description
format string

O formato da chave serializada, pode ser 'der' ou 'pem'.

key string

A chave privada que foi serializada em uma string.

opt_sec string <optional>

Se o formato for 'pem' e a chave privada foi protegida, este argumento deve conter o segredo da cifra simétrica.

See:
Returns:

Um novo objeto contendo a chave lida.

Type
module:@nginstack/engine/lib/crypto/RSACryptoPKey~RSACryptoPKey

<static> importPublicKey(format, key)

Lê uma chave pública serializada em uma string e cria um novo objeto que representa a mesma chave.

Parameters:
Name Type Description
format string

O formato da chave serializada, pode ser 'der' ou 'pem'.

key string

A chave pública que foi serializada em uma string.

See:
Returns:

Um novo objeto contendo a chave lida.

Type
module:@nginstack/engine/lib/crypto/RSACryptoPKey~RSACryptoPKey