Kernel 8.0 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

$$RSADECR^XUSHSH: Returns Plaintext String Value for RSA Encrypted Ciphertext Entry

Reference Type: Supported, Category: Data Security, Integration Agreement: 6189

Description

This extrinsic function returns the plaintext string value for an RSA encrypted ciphertext entry. RSA is a public-key encryption system that is widely used for secure data transmission. The encryption key is public and differs from the decryption key, which is kept secret.

NOTE: This API was released with Kernel patch XU*8.0*655.

Format

$$RSADECR^XUSHSH(text,key[,pwd][,enc])
Input Parameters: text: (required) The RSA encrypted ciphertext string to be decrypted.
  key: (required) The RSA private key corresponding to the RSA public key that was used for encryption, Privacy Enhanced Mail (PEM) encoded.
  pwd: (optional) The private key password.
  enc: (optional) Encoding - Public-Key Cryptography Standards (PKCS) #1 v2.1 encoding method:
  • 1 - Optimal Asymmetric Encryption Padding (OAEP; default).
  • 2 - PKCS 1-v1_5.
Output: returns: Returns the plaintext string value for the RSA encrypted ciphertext input parameter.

 

Example

EDITOR'S NOTE: NO EXAMPLE FOUND IN THE FOIA DOCUMENTATION FOR THIS FUNCTION.