RSA Class

Properties   Methods   Events   Config Settings   Errors  

Implements RSA public-key cryptography to encrypt/decrypt and sign/verify messages.

Class Name

IPWorksEncrypt_RSA

Procedural Interface

 ipworksencrypt_rsa_open();
 ipworksencrypt_rsa_close($res);
 ipworksencrypt_rsa_register_callback($res, $id, $function);
 ipworksencrypt_rsa_get_last_error($res);
 ipworksencrypt_rsa_get_last_error_code($res);
 ipworksencrypt_rsa_set($res, $id, $index, $value);
 ipworksencrypt_rsa_get($res, $id, $index);
 ipworksencrypt_rsa_do_config($res, $configurationstring);
 ipworksencrypt_rsa_do_createkey($res);
 ipworksencrypt_rsa_do_decrypt($res);
 ipworksencrypt_rsa_do_encrypt($res);
 ipworksencrypt_rsa_do_reset($res);
 ipworksencrypt_rsa_do_sign($res);
 ipworksencrypt_rsa_do_verifysignature($res);

Remarks

The RSA class implements RSA public-key cryptography to encrypt/decrypt messages and sign/verify hash signatures.

To begin you must either specify an existing key or create a new key. Existing private keys may be specified by setting the Key* properties. To create a new key call CreateKey. Alternatively an existing certificate may be specified by setting the Certificate* properties

Signing

To sign data first set Key or Certificate. Specify the input data using InputFile or InputMessage. Next call Sign. The class will populate HashValue and HashSignature. After calling Sign the public key must be sent to the recipient along with HashSignature.

Encrypting

To encrypt data set RecipientKey or RecipientCert. Specify the input data using InputFile or InputMessage. Next call Encrypt. The class will populate OutputMessage, or write to the file specified by OutputFile.

Signature Verification

To verify a signature specify the input data using InputFile or InputMessage. Set SignerKey or SignerCert. Next set HashSignature and call VerifySignature. The VerifySignature method will return True if the signature was successfully verified.

Decrypting

To decrypt data first set Key or Certificate. Specify the input data using InputFile or InputMessage. Next call Decrypt. The class will populate OutputMessage, or write to the file specified by OutputFile.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is:

• KeyModulus
• KeyD

The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CertEffectiveDate Property (IPWorksEncrypt_RSA Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getCertEffectiveDate();

Procedural Interface

ipworksencrypt_rsa_get($res, 1 );

Default Value

''

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

CertExpirationDate Property (IPWorksEncrypt_RSA Class)

This is the date the certificate expires.

Object Oriented Interface

public function getCertExpirationDate();

Procedural Interface

ipworksencrypt_rsa_get($res, 2 );

Default Value

''

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

CertExtendedKeyUsage Property (IPWorksEncrypt_RSA Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getCertExtendedKeyUsage();

Procedural Interface

ipworksencrypt_rsa_get($res, 3 );

Default Value

''

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

CertFingerprint Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getCertFingerprint();

Procedural Interface

ipworksencrypt_rsa_get($res, 4 );

Default Value

''

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

CertFingerprintSHA1 Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getCertFingerprintSHA1();

Procedural Interface

ipworksencrypt_rsa_get($res, 5 );

Default Value

''

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

CertFingerprintSHA256 Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getCertFingerprintSHA256();

Procedural Interface

ipworksencrypt_rsa_get($res, 6 );

Default Value

''

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

CertIssuer Property (IPWorksEncrypt_RSA Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getCertIssuer();

Procedural Interface

ipworksencrypt_rsa_get($res, 7 );

Default Value

''

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

CertPrivateKey Property (IPWorksEncrypt_RSA Class)

This is the private key of the certificate (if available).

Object Oriented Interface

public function getCertPrivateKey();

Procedural Interface

ipworksencrypt_rsa_get($res, 8 );

Default Value

''

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

CertPrivateKeyAvailable Property (IPWorksEncrypt_RSA Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getCertPrivateKeyAvailable();

Procedural Interface

ipworksencrypt_rsa_get($res, 9 );

Default Value

false

Remarks

This property shows whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

CertPrivateKeyContainer Property (IPWorksEncrypt_RSA Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getCertPrivateKeyContainer();

Procedural Interface

ipworksencrypt_rsa_get($res, 10 );

Default Value

''

Remarks

This is the name of the CertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

CertPublicKey Property (IPWorksEncrypt_RSA Class)

This is the public key of the certificate.

Object Oriented Interface

public function getCertPublicKey();

Procedural Interface

ipworksencrypt_rsa_get($res, 11 );

Default Value

''

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

CertPublicKeyAlgorithm Property (IPWorksEncrypt_RSA Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getCertPublicKeyAlgorithm();

Procedural Interface

ipworksencrypt_rsa_get($res, 12 );

Default Value

''

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

CertPublicKeyLength Property (IPWorksEncrypt_RSA Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface

public function getCertPublicKeyLength();

Procedural Interface

ipworksencrypt_rsa_get($res, 13 );

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

CertSerialNumber Property (IPWorksEncrypt_RSA Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface

public function getCertSerialNumber();

Procedural Interface

ipworksencrypt_rsa_get($res, 14 );

Default Value

''

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

CertSignatureAlgorithm Property (IPWorksEncrypt_RSA Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface

public function getCertSignatureAlgorithm();

Procedural Interface

ipworksencrypt_rsa_get($res, 15 );

Default Value

''

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

CertStore Property (IPWorksEncrypt_RSA Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getCertStore();


public function setCertStore($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 16 );


ipworksencrypt_rsa_set($res, 16, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

Data Type

Binary String

CertStorePassword Property (IPWorksEncrypt_RSA Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getCertStorePassword();


public function setCertStorePassword($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 17 );


ipworksencrypt_rsa_set($res, 17, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

CertStoreType Property (IPWorksEncrypt_RSA Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getCertStoreType();


public function setCertStoreType($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 18 );


ipworksencrypt_rsa_set($res, 18, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

CertSubjectAltNames Property (IPWorksEncrypt_RSA Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getCertSubjectAltNames();

Procedural Interface

ipworksencrypt_rsa_get($res, 19 );

Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (IPWorksEncrypt_RSA Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintMD5();

Procedural Interface

ipworksencrypt_rsa_get($res, 20 );

Default Value

''

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA1 Property (IPWorksEncrypt_RSA Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintSHA1();

Procedural Interface

ipworksencrypt_rsa_get($res, 21 );

Default Value

''

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA256 Property (IPWorksEncrypt_RSA Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintSHA256();

Procedural Interface

ipworksencrypt_rsa_get($res, 22 );

Default Value

''

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertUsage Property (IPWorksEncrypt_RSA Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getCertUsage();

Procedural Interface

ipworksencrypt_rsa_get($res, 23 );

Default Value

''

Remarks

This property contains the text description of CertUsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

CertUsageFlags Property (IPWorksEncrypt_RSA Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface

public function getCertUsageFlags();

Procedural Interface

ipworksencrypt_rsa_get($res, 24 );

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:

Please see the CertUsage property for a text representation of CertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

CertVersion Property (IPWorksEncrypt_RSA Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getCertVersion();

Procedural Interface

ipworksencrypt_rsa_get($res, 25 );

Default Value

''

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

CertSubject Property (IPWorksEncrypt_RSA Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getCertSubject();


public function setCertSubject($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 26 );


ipworksencrypt_rsa_set($res, 26, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

CertEncoded Property (IPWorksEncrypt_RSA Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getCertEncoded();


public function setCertEncoded($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 27 );


ipworksencrypt_rsa_set($res, 27, $value );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

HashAlgorithm Property (IPWorksEncrypt_RSA Class)

The hash algorithm used for signing and signature verification.

Object Oriented Interface

public function getHashAlgorithm();


public function setHashAlgorithm($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 28 );


ipworksencrypt_rsa_set($res, 28, $value );

Default Value

2

Remarks

This property specifies the hash algorithm used for signing and signature verification. Possible values are:

Data Type

Integer

HashSignature Property (IPWorksEncrypt_RSA Class)

The hash signature.

Object Oriented Interface

public function getHashSignature();


public function setHashSignature($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 29 );


ipworksencrypt_rsa_set($res, 29, $value );

Default Value

''

Remarks

This property holds the computed hash signature. This is populated after calling Sign. This must be set before calling VerifySignature.

Data Type

Binary String

HashValue Property (IPWorksEncrypt_RSA Class)

The hash value of the data.

Object Oriented Interface

public function getHashValue();


public function setHashValue($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 30 );


ipworksencrypt_rsa_set($res, 30, $value );

Default Value

''

Remarks

This property holds the computed hash value for the specified data. This is populated when calling Sign or VerifySignature when an input file is specified by setting InputFile or InputMessage.

If you know the hash value prior to using the class you may specify the pre-computed hash value here.

Hash Notes

The class will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by InputFile or InputMessage, the hash will be recomputed when calling Sign or VerifySignature. If the HashValue property is set, the class will only sign the hash or verify the hash signature. Setting InputFile or InputMessage clears the HashValue property. Setting the HashValue property clears the input file selection.

Data Type

Binary String

InputFile Property (IPWorksEncrypt_RSA Class)

The file to process.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 31 );


ipworksencrypt_rsa_set($res, 31, $value );

Default Value

''

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

String

InputMessage Property (IPWorksEncrypt_RSA Class)

The message to process.

Object Oriented Interface

public function getInputMessage();


public function setInputMessage($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 32 );


ipworksencrypt_rsa_set($res, 32, $value );

Default Value

''

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

Binary String

KeyD Property (IPWorksEncrypt_RSA Class)

Represents the D parameter for the RSA algorithm.

Object Oriented Interface

public function getKeyD();


public function setKeyD($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 33 );


ipworksencrypt_rsa_set($res, 33, $value );

Default Value

''

Remarks

Represents the D parameter for the RSA algorithm.

Data Type

Binary String

KeyDP Property (IPWorksEncrypt_RSA Class)

Represents the DP parameter for the RSA algorithm.

Object Oriented Interface

public function getKeyDP();


public function setKeyDP($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 34 );


ipworksencrypt_rsa_set($res, 34, $value );

Default Value

''

Remarks

Represents the DP parameter for the RSA algorithm.

Data Type

Binary String

KeyDQ Property (IPWorksEncrypt_RSA Class)

Represents the DQ parameter for the RSA algorithm.

Object Oriented Interface

public function getKeyDQ();


public function setKeyDQ($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 35 );


ipworksencrypt_rsa_set($res, 35, $value );

Default Value

''

Remarks

Represents the DQ parameter for the RSA algorithm.

Data Type

Binary String

KeyExponent Property (IPWorksEncrypt_RSA Class)

Represents the Exponent parameter for the RSA algorithm.

Object Oriented Interface

public function getKeyExponent();


public function setKeyExponent($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 36 );


ipworksencrypt_rsa_set($res, 36, $value );

Default Value

''

Remarks

Represents the Exponent parameter for the RSA algorithm.

Data Type

Binary String

KeyInverseQ Property (IPWorksEncrypt_RSA Class)

Represents the InverseQ parameter for the RSA algorithm.

Object Oriented Interface

public function getKeyInverseQ();


public function setKeyInverseQ($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 37 );


ipworksencrypt_rsa_set($res, 37, $value );

Default Value

''

Remarks

Represents the InverseQ parameter for the RSA algorithm. This parameter is optional and is automatically calculated as necessary.

Data Type

Binary String

KeyModulus Property (IPWorksEncrypt_RSA Class)

Represents the Modulus parameter for the RSA algorithm.

Object Oriented Interface

public function getKeyModulus();


public function setKeyModulus($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 38 );


ipworksencrypt_rsa_set($res, 38, $value );

Default Value

''

Remarks

Represents the Modulus parameter for the RSA algorithm.

Data Type

Binary String

KeyP Property (IPWorksEncrypt_RSA Class)

Represents the P parameter for the RSA algorithm.

Object Oriented Interface

public function getKeyP();


public function setKeyP($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 39 );


ipworksencrypt_rsa_set($res, 39, $value );

Default Value

''

Remarks

Represents the P parameter for the RSA algorithm.

Data Type

Binary String

KeyPrivateKey Property (IPWorksEncrypt_RSA Class)

This property is a PEM formatted private key.

Object Oriented Interface

public function getKeyPrivateKey();


public function setKeyPrivateKey($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 40 );


ipworksencrypt_rsa_set($res, 40, $value );

Default Value

''

Remarks

This property is a PEM formatted private key. The purpose of this property is to allow easier management of the private key parameters by using only a single value.

Data Type

String

KeyPublicKey Property (IPWorksEncrypt_RSA Class)

This property is a PEM formatted public key.

Object Oriented Interface

public function getKeyPublicKey();


public function setKeyPublicKey($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 41 );


ipworksencrypt_rsa_set($res, 41, $value );

Default Value

''

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

KeyQ Property (IPWorksEncrypt_RSA Class)

Represents the Q parameter for the RSA algorithm.

Object Oriented Interface

public function getKeyQ();


public function setKeyQ($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 42 );


ipworksencrypt_rsa_set($res, 42, $value );

Default Value

''

Remarks

Represents the Q parameter for the RSA algorithm.

Data Type

Binary String

OutputFile Property (IPWorksEncrypt_RSA Class)

The output file when encrypting or decrypting.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 43 );


ipworksencrypt_rsa_set($res, 43, $value );

Default Value

''

Remarks

This property specifies the file to which the output will be written when Encrypt or Decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to Encrypt and Decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

String

OutputMessage Property (IPWorksEncrypt_RSA Class)

The output message after processing.

Object Oriented Interface

public function getOutputMessage();

Procedural Interface

ipworksencrypt_rsa_get($res, 44 );

Default Value

''

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

This property is read-only and not available at design time.

Data Type

Binary String

Overwrite Property (IPWorksEncrypt_RSA Class)

Indicates whether or not the class should overwrite files.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 45 );


ipworksencrypt_rsa_set($res, 45, $value );

Default Value

false

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

RecipientCertEffectiveDate Property (IPWorksEncrypt_RSA Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getRecipientCertEffectiveDate();

Procedural Interface

ipworksencrypt_rsa_get($res, 46 );

Default Value

''

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

RecipientCertExpirationDate Property (IPWorksEncrypt_RSA Class)

This is the date the certificate expires.

Object Oriented Interface

public function getRecipientCertExpirationDate();

Procedural Interface

ipworksencrypt_rsa_get($res, 47 );

Default Value

''

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

RecipientCertExtendedKeyUsage Property (IPWorksEncrypt_RSA Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getRecipientCertExtendedKeyUsage();

Procedural Interface

ipworksencrypt_rsa_get($res, 48 );

Default Value

''

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

RecipientCertFingerprint Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getRecipientCertFingerprint();

Procedural Interface

ipworksencrypt_rsa_get($res, 49 );

Default Value

''

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

RecipientCertFingerprintSHA1 Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getRecipientCertFingerprintSHA1();

Procedural Interface

ipworksencrypt_rsa_get($res, 50 );

Default Value

''

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

RecipientCertFingerprintSHA256 Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getRecipientCertFingerprintSHA256();

Procedural Interface

ipworksencrypt_rsa_get($res, 51 );

Default Value

''

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

RecipientCertIssuer Property (IPWorksEncrypt_RSA Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getRecipientCertIssuer();

Procedural Interface

ipworksencrypt_rsa_get($res, 52 );

Default Value

''

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

RecipientCertPrivateKey Property (IPWorksEncrypt_RSA Class)

This is the private key of the certificate (if available).

Object Oriented Interface

public function getRecipientCertPrivateKey();

Procedural Interface

ipworksencrypt_rsa_get($res, 53 );

Default Value

''

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The RecipientCertPrivateKey may be available but not exportable. In this case, RecipientCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

RecipientCertPrivateKeyAvailable Property (IPWorksEncrypt_RSA Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getRecipientCertPrivateKeyAvailable();

Procedural Interface

ipworksencrypt_rsa_get($res, 54 );

Default Value

false

Remarks

This property shows whether a RecipientCertPrivateKey is available for the selected certificate. If RecipientCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

RecipientCertPrivateKeyContainer Property (IPWorksEncrypt_RSA Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getRecipientCertPrivateKeyContainer();

Procedural Interface

ipworksencrypt_rsa_get($res, 55 );

Default Value

''

Remarks

This is the name of the RecipientCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

RecipientCertPublicKey Property (IPWorksEncrypt_RSA Class)

This is the public key of the certificate.

Object Oriented Interface

public function getRecipientCertPublicKey();

Procedural Interface

ipworksencrypt_rsa_get($res, 56 );

Default Value

''

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

RecipientCertPublicKeyAlgorithm Property (IPWorksEncrypt_RSA Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getRecipientCertPublicKeyAlgorithm();

Procedural Interface

ipworksencrypt_rsa_get($res, 57 );

Default Value

''

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

RecipientCertPublicKeyLength Property (IPWorksEncrypt_RSA Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface

public function getRecipientCertPublicKeyLength();

Procedural Interface

ipworksencrypt_rsa_get($res, 58 );

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

RecipientCertSerialNumber Property (IPWorksEncrypt_RSA Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface

public function getRecipientCertSerialNumber();

Procedural Interface

ipworksencrypt_rsa_get($res, 59 );

Default Value

''

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

RecipientCertSignatureAlgorithm Property (IPWorksEncrypt_RSA Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface

public function getRecipientCertSignatureAlgorithm();

Procedural Interface

ipworksencrypt_rsa_get($res, 60 );

Default Value

''

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

RecipientCertStore Property (IPWorksEncrypt_RSA Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getRecipientCertStore();


public function setRecipientCertStore($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 61 );


ipworksencrypt_rsa_set($res, 61, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

Data Type

Binary String

RecipientCertStorePassword Property (IPWorksEncrypt_RSA Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getRecipientCertStorePassword();


public function setRecipientCertStorePassword($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 62 );


ipworksencrypt_rsa_set($res, 62, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

RecipientCertStoreType Property (IPWorksEncrypt_RSA Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getRecipientCertStoreType();


public function setRecipientCertStoreType($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 63 );


ipworksencrypt_rsa_set($res, 63, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

RecipientCertSubjectAltNames Property (IPWorksEncrypt_RSA Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getRecipientCertSubjectAltNames();

Procedural Interface

ipworksencrypt_rsa_get($res, 64 );

Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

RecipientCertThumbprintMD5 Property (IPWorksEncrypt_RSA Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintMD5();

Procedural Interface

ipworksencrypt_rsa_get($res, 65 );

Default Value

''

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertThumbprintSHA1 Property (IPWorksEncrypt_RSA Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintSHA1();

Procedural Interface

ipworksencrypt_rsa_get($res, 66 );

Default Value

''

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertThumbprintSHA256 Property (IPWorksEncrypt_RSA Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintSHA256();

Procedural Interface

ipworksencrypt_rsa_get($res, 67 );

Default Value

''

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertUsage Property (IPWorksEncrypt_RSA Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getRecipientCertUsage();

Procedural Interface

ipworksencrypt_rsa_get($res, 68 );

Default Value

''

Remarks

This property contains the text description of RecipientCertUsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

RecipientCertUsageFlags Property (IPWorksEncrypt_RSA Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface

public function getRecipientCertUsageFlags();

Procedural Interface

ipworksencrypt_rsa_get($res, 69 );

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of RecipientCertUsageFlags is a combination of the following flags:

Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

RecipientCertVersion Property (IPWorksEncrypt_RSA Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getRecipientCertVersion();

Procedural Interface

ipworksencrypt_rsa_get($res, 70 );

Default Value

''

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

RecipientCertSubject Property (IPWorksEncrypt_RSA Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getRecipientCertSubject();


public function setRecipientCertSubject($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 71 );


ipworksencrypt_rsa_set($res, 71, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

RecipientCertEncoded Property (IPWorksEncrypt_RSA Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getRecipientCertEncoded();


public function setRecipientCertEncoded($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 72 );


ipworksencrypt_rsa_set($res, 72, $value );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

RecipientKeyExponent Property (IPWorksEncrypt_RSA Class)

Represents the Exponent parameter for the RSA algorithm.

Object Oriented Interface

public function getRecipientKeyExponent();


public function setRecipientKeyExponent($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 76 );


ipworksencrypt_rsa_set($res, 76, $value );

Default Value

''

Remarks

Represents the Exponent parameter for the RSA algorithm.

Data Type

Binary String

RecipientKeyModulus Property (IPWorksEncrypt_RSA Class)

Represents the Modulus parameter for the RSA algorithm.

Object Oriented Interface

public function getRecipientKeyModulus();


public function setRecipientKeyModulus($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 78 );


ipworksencrypt_rsa_set($res, 78, $value );

Default Value

''

Remarks

Represents the Modulus parameter for the RSA algorithm.

Data Type

Binary String

RecipientKeyPublicKey Property (IPWorksEncrypt_RSA Class)

This property is a PEM formatted public key.

Object Oriented Interface

public function getRecipientKeyPublicKey();


public function setRecipientKeyPublicKey($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 81 );


ipworksencrypt_rsa_set($res, 81, $value );

Default Value

''

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

SignerCertEffectiveDate Property (IPWorksEncrypt_RSA Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getSignerCertEffectiveDate();

Procedural Interface

ipworksencrypt_rsa_get($res, 83 );

Default Value

''

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SignerCertExpirationDate Property (IPWorksEncrypt_RSA Class)

This is the date the certificate expires.

Object Oriented Interface

public function getSignerCertExpirationDate();

Procedural Interface

ipworksencrypt_rsa_get($res, 84 );

Default Value

''

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SignerCertExtendedKeyUsage Property (IPWorksEncrypt_RSA Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSignerCertExtendedKeyUsage();

Procedural Interface

ipworksencrypt_rsa_get($res, 85 );

Default Value

''

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SignerCertFingerprint Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSignerCertFingerprint();

Procedural Interface

ipworksencrypt_rsa_get($res, 86 );

Default Value

''

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SignerCertFingerprintSHA1 Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSignerCertFingerprintSHA1();

Procedural Interface

ipworksencrypt_rsa_get($res, 87 );

Default Value

''

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SignerCertFingerprintSHA256 Property (IPWorksEncrypt_RSA Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSignerCertFingerprintSHA256();

Procedural Interface

ipworksencrypt_rsa_get($res, 88 );

Default Value

''

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SignerCertIssuer Property (IPWorksEncrypt_RSA Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getSignerCertIssuer();

Procedural Interface

ipworksencrypt_rsa_get($res, 89 );

Default Value

''

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SignerCertPrivateKey Property (IPWorksEncrypt_RSA Class)

This is the private key of the certificate (if available).

Object Oriented Interface

public function getSignerCertPrivateKey();

Procedural Interface

ipworksencrypt_rsa_get($res, 90 );

Default Value

''

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SignerCertPrivateKey may be available but not exportable. In this case, SignerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SignerCertPrivateKeyAvailable Property (IPWorksEncrypt_RSA Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSignerCertPrivateKeyAvailable();

Procedural Interface

ipworksencrypt_rsa_get($res, 91 );

Default Value

false

Remarks

This property shows whether a SignerCertPrivateKey is available for the selected certificate. If SignerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SignerCertPrivateKeyContainer Property (IPWorksEncrypt_RSA Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSignerCertPrivateKeyContainer();

Procedural Interface

ipworksencrypt_rsa_get($res, 92 );

Default Value

''

Remarks

This is the name of the SignerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SignerCertPublicKey Property (IPWorksEncrypt_RSA Class)

This is the public key of the certificate.

Object Oriented Interface

public function getSignerCertPublicKey();

Procedural Interface

ipworksencrypt_rsa_get($res, 93 );

Default Value

''

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SignerCertPublicKeyAlgorithm Property (IPWorksEncrypt_RSA Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSignerCertPublicKeyAlgorithm();

Procedural Interface

ipworksencrypt_rsa_get($res, 94 );

Default Value

''

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SignerCertPublicKeyLength Property (IPWorksEncrypt_RSA Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface

public function getSignerCertPublicKeyLength();

Procedural Interface

ipworksencrypt_rsa_get($res, 95 );

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SignerCertSerialNumber Property (IPWorksEncrypt_RSA Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSignerCertSerialNumber();

Procedural Interface

ipworksencrypt_rsa_get($res, 96 );

Default Value

''

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SignerCertSignatureAlgorithm Property (IPWorksEncrypt_RSA Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSignerCertSignatureAlgorithm();

Procedural Interface

ipworksencrypt_rsa_get($res, 97 );

Default Value

''

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SignerCertStore Property (IPWorksEncrypt_RSA Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSignerCertStore();


public function setSignerCertStore($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 98 );


ipworksencrypt_rsa_set($res, 98, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.

SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

Data Type

Binary String

SignerCertStorePassword Property (IPWorksEncrypt_RSA Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSignerCertStorePassword();


public function setSignerCertStorePassword($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 99 );


ipworksencrypt_rsa_set($res, 99, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SignerCertStoreType Property (IPWorksEncrypt_RSA Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSignerCertStoreType();


public function setSignerCertStoreType($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 100 );


ipworksencrypt_rsa_set($res, 100, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SignerCertSubjectAltNames Property (IPWorksEncrypt_RSA Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSignerCertSubjectAltNames();

Procedural Interface

ipworksencrypt_rsa_get($res, 101 );

Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SignerCertThumbprintMD5 Property (IPWorksEncrypt_RSA Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintMD5();

Procedural Interface

ipworksencrypt_rsa_get($res, 102 );

Default Value

''

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertThumbprintSHA1 Property (IPWorksEncrypt_RSA Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintSHA1();

Procedural Interface

ipworksencrypt_rsa_get($res, 103 );

Default Value

''

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertThumbprintSHA256 Property (IPWorksEncrypt_RSA Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintSHA256();

Procedural Interface

ipworksencrypt_rsa_get($res, 104 );

Default Value

''

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertUsage Property (IPWorksEncrypt_RSA Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getSignerCertUsage();

Procedural Interface

ipworksencrypt_rsa_get($res, 105 );

Default Value

''

Remarks

This property contains the text description of SignerCertUsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SignerCertUsageFlags Property (IPWorksEncrypt_RSA Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface

public function getSignerCertUsageFlags();

Procedural Interface

ipworksencrypt_rsa_get($res, 106 );

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of SignerCertUsageFlags is a combination of the following flags:

Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SignerCertVersion Property (IPWorksEncrypt_RSA Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getSignerCertVersion();

Procedural Interface

ipworksencrypt_rsa_get($res, 107 );

Default Value

''

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SignerCertSubject Property (IPWorksEncrypt_RSA Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSignerCertSubject();


public function setSignerCertSubject($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 108 );


ipworksencrypt_rsa_set($res, 108, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SignerCertEncoded Property (IPWorksEncrypt_RSA Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSignerCertEncoded();


public function setSignerCertEncoded($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 109 );


ipworksencrypt_rsa_set($res, 109, $value );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.

When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SignerKeyExponent Property (IPWorksEncrypt_RSA Class)

Represents the Exponent parameter for the RSA algorithm.

Object Oriented Interface

public function getSignerKeyExponent();


public function setSignerKeyExponent($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 113 );


ipworksencrypt_rsa_set($res, 113, $value );

Default Value

''

Remarks

Represents the Exponent parameter for the RSA algorithm.

Data Type

Binary String

SignerKeyModulus Property (IPWorksEncrypt_RSA Class)

Represents the Modulus parameter for the RSA algorithm.

Object Oriented Interface

public function getSignerKeyModulus();


public function setSignerKeyModulus($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 115 );


ipworksencrypt_rsa_set($res, 115, $value );

Default Value

''

Remarks

Represents the Modulus parameter for the RSA algorithm.

Data Type

Binary String

SignerKeyPublicKey Property (IPWorksEncrypt_RSA Class)

This property is a PEM formatted public key.

Object Oriented Interface

public function getSignerKeyPublicKey();


public function setSignerKeyPublicKey($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 118 );


ipworksencrypt_rsa_set($res, 118, $value );

Default Value

''

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

UseHex Property (IPWorksEncrypt_RSA Class)

Whether input or output is hex encoded.

Object Oriented Interface

public function getUseHex();


public function setUseHex($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 120 );


ipworksencrypt_rsa_set($res, 120, $value );

Default Value

false

Remarks

This property specifies whether the encrypted data, HashValue, and HashSignature are hex encoded.

If set to True, when Encrypt is called the class will perform the encryption as normal and then hex encode the output. OutputMessage or OutputFile will hold hex encoded data.

If set to True, when Decrypt is called the class will expect InputMessage or InputFile to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

If set to True, when Sign is called the class will compute the hash for the specified file and populate HashValue with the hex encoded hash value. It will then create the hash signature and populate HashSignature with the hex encoded hash signature value. If HashValue is specified directly, it must be a hex encoded value.

If set to True, when VerifySignature is called the class will compute the hash value for the specified file and populate HashValue with the hex encoded hash value. It will then hex decode HashSignature and verify the signature. HashSignature must hold a hex encoded value. If HashValue is specified directly, it must be a hex encoded value.

Data Type

Boolean

UseOAEP Property (IPWorksEncrypt_RSA Class)

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

Object Oriented Interface

public function getUseOAEP();


public function setUseOAEP($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 121 );


ipworksencrypt_rsa_set($res, 121, $value );

Default Value

false

Remarks

Whether to use Optimal Asymmetric Encryption Padding (OAEP). By default this value is False and the class will use PKCS1.

Note: When set to True the HashAlgorithm is also applicable when calling Encrypt and Decrypt.

Data Type

Boolean

UsePSS Property (IPWorksEncrypt_RSA Class)

Whether to use RSA-PSS during signing and verification.

Object Oriented Interface

public function getUsePSS();


public function setUsePSS($value);

Procedural Interface

ipworksencrypt_rsa_get($res, 122 );


ipworksencrypt_rsa_set($res, 122, $value );

Default Value

false

Remarks

This property specifies whether RSA-PSS will be used when signing and verifying messages. The default value is False.

Data Type

Boolean

Config Method (IPWorksEncrypt_RSA Class)

This method sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksencrypt_rsa_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateKey Method (IPWorksEncrypt_RSA Class)

Creates a new key.

Object Oriented Interface

public function doCreateKey();

Procedural Interface

ipworksencrypt_rsa_do_createkey($res);

Remarks

This method creates a new public and private key.

When calling CreateKey the Key* properties are populated with a new private and public key.

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is:

• KeyModulus
• KeyD

The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Decrypt Method (IPWorksEncrypt_RSA Class)

Decrypts the input data using the specified private key.

Object Oriented Interface

public function doDecrypt();

Procedural Interface

ipworksencrypt_rsa_do_decrypt($res);

Remarks

This method decrypts the input data using the private key specified in the Key* properties. Alternatively, a certificate may be specified by setting Certificate.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Key Size and the Maximum Length of Data

RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding.

When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11.

When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32.

Encrypt Method (IPWorksEncrypt_RSA Class)

Encrypts the input data using the recipient's public key.

Object Oriented Interface

public function doEncrypt();

Procedural Interface

ipworksencrypt_rsa_do_encrypt($res);

Remarks

This method encrypts the input data using the public key specified in the RecipientKey* properties. Alternatively, a certificate may be specified by setting RecipientCert.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Key Size and the Maximum Length of Data

RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding.

When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11.

When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32.

Reset Method (IPWorksEncrypt_RSA Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksencrypt_rsa_do_reset($res);

Remarks

When called, the class will reset all of its properties to their default values.

Sign Method (IPWorksEncrypt_RSA Class)

Creates a hash signature.

Object Oriented Interface

public function doSign();

Procedural Interface

ipworksencrypt_rsa_do_sign($res);

Remarks

This method will create a hash signature.

Before calling this method specify the input file by setting InputFile or InputMessage.

A key is required to create the hash signature. You may create a new key by calling CreateKey, or specify an existing key pair in Key. Alternatively, a certificate may be specified by setting Certificate. When this method is called the class will compute the hash for the specified file and populate HashValue. It will then create the hash signature using the specified Key and populate HashSignature.

To create the hash signature without first computing the hash simply specify HashValue before calling this method.

The Progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.

VerifySignature Method (IPWorksEncrypt_RSA Class)

Verifies the signature for the specified data.

Object Oriented Interface

public function doVerifySignature();

Procedural Interface

ipworksencrypt_rsa_do_verifysignature($res);

Remarks

This method will verify a hash signature.

Before calling this method specify the input file by setting InputFile or InputMessage.

A public key and the hash signature are required to perform the signature verification. Specify the public key in SignerKey. Alternatively, a certificate may be specified by setting SignerCert. Specify the hash signature in HashSignature.

When this method is called the class will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.

To verify the hash signature without first computing the hash simply specify HashValue before calling this method.

The Progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.

Error Event (IPWorksEncrypt_RSA Class)

This event is fired for information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksencrypt_rsa_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (IPWorksEncrypt_RSA Class)

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworksencrypt_rsa_register_callback($res, 2, array($this, 'fireProgress'));

Parameter List

 'bytesprocessed'
 'percentprocessed'

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

Config Settings (RSA Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

RSA Config Settings

Base Config Settings

Trappable Errors (RSA Class)

RSA Errors