IPWorks Encrypt 2020 Android Edition

Questions / Feedback?

Cms Configuration

The component 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 component, access to these internal properties is provided through the Config method.

CMS Configuration Settings

CloseInputStreamAfterProcess:   Determines whether or not the input stream is closed after processing.

Determines whether or not the input stream set by SetInputStream is closed after processing is complete. The default value is False.

CloseOutputStreamAfterProcess:   Determines whether or not the output stream is closed after processing.

Determines whether or not the output stream set by SetOutputStream is closed after processing is complete. The default value is False.

CompressBeforeSign:   Specifies whether to compress before signing.

When EnableCompression is set to True this property controls whether compression happens before or after signing. If set to True the input data will be compressed before signing. If set to False (default) the input data will be signed and then compressed.

ContentTypeOID:   Specifies the oid for content type.

This setting optionally specifies an OID defining the data content type for the data being processed. This may be set before calling Encrypt, Sign, or SignAndEncrypt.

The default value is 1.2.840.113549.1.7.1 which is the OID for id-data.

CSP:   The Cryptographic Service Provider.

For the Win32 editions, the name of the Cryptographic Service Provider used to provide access to encryption/decryption and signature operations.

NOTE: This config may only be used when the UseCryptoAPI is true.

GenerateSignatureTimestamp:   Whether to generate timestamps in signatures.

If GenerateSignatureTimestamp is True, a timestamp will be generated and added to all signatures created by the component.

The default value is True.

IncludeHeaders:   Tells the component whether to include the headers when encoding the message.

If True (default), the component will include MIME headers when Sign, Encrypt, or SignAndEncrypt are called. If False, only the message will be encoded.

The default value for IncludeHeaders is true.

Note: This setting is only applicable to when OutputFormat is set to SMIME.

IncludeInternalHeaders:   Tells the component whether or not to include the internal headers when encoding the message.

If True, the component will generate and include MIME part headers when Sign, Encrypt, or SignAndEncrypt are called. When VerifySignature, Decrypt, or DecryptAndVerifySignature are called the MIME part headers will be stripped.

When set to False, only the message will be processed, MIME part headers will not be generated or stripped.

The default value for IncludeInternalHeaders is False.

Note: This setting is only applicable to when OutputFormat is set to SMIME.

InputContentTransferEncoding:   Sets the Content-Transfer-Encoding for the signed message.

This setting specifies the Content-Transfer-Encoding header value in signed messages. By default the component will automatically determine the Content-Transfer-Encoding based on the file extension set in InputFile, however this setting may be set to override the determined value or to specify a value if data is read from InputMessage.

If no value is specified and a value cannot be automatically determined the default value 7bit will be used.

Note: This setting is only applicable when OutputFormat is set to SMIME and when calling Sign or SignAndEncrypt and DetachedSignature is True.

InputContentType:   Sets the Content-Type for the signed message.

This setting specifies the Content-Type header value in signed messages. By default the component will automatically determine the Content-Type based on the file extension set in InputFile, however this setting may be set to override the determined value or to specify a value if data is read from InputMessage.

If no value is specified and a value cannot be automatically determined the default value text/plain; charset="iso-8859-1" will be used.

Note: This setting is only applicable when OutputFormat is set to SMIME and when calling Sign or SignAndEncrypt and DetachedSignature is True.

InputMessageHeaders:   Message headers.

This setting specifies the headers of the SMIME message if they are not already present in the input message. In most cases the input message itself will contain the necessary headers, however if the headers are and body of the SMIME message are separate, the headers may be specified in this setting before calling Decrypt, DecryptAndVerifySignature, or VerifySignature.

LogDirectory:   The directory on disk where debug logs are written.

This setting specifies a directory on disk to which debug logs will be written during operation. This should only be set for debugging purposes. Files with various extensions will be written to disk at the location specified with debug data for the operation being performed. If LogFilename is not specified the filenames will be in the format yyyy-MM-dd-HH-mm-ss-fff.

LogFilename:   The base filename to use with LogDirectory.

This setting specifies the base filename to use when LogDirectory is set. If specified the name should be a filename without extension. Various files will be logged with different extensions during operation. This setting defines only the base filename. If unspecified the files will be named with a timestamp in the format yyyy-MM-dd-HH-mm-ss-fff.

LogLevel:   The level of detail for log messages.

This setting specifies the level of detail that is logged via the Log event. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is logged.

OAEPMGF1HashAlgorithm:   The MGF1 hash algorithm used with OAEP.

This setting specifies the MGF1 hash algorithm used when UseOAEP is set to True. The default value is "SHA256". Possible values are:

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
OAEPParams:   The hex encoded OAEP parameters.

This setting optionally specifies OAEP parameters to be used when UseOAEP is set to True. The specified value should be hex encoded.

OAEPRSAHashAlgorithm:   The RSA hash algorithm used with OAEP.

This setting specifies thet RSA Hash Algorithm used when UseOAEP is set to True. The default value is "SHA256". Possible values are:

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
OutputMessageHeaders:   The SMIME headers of the output message.

When IncludeHeaders is set to False the SMIME headers are not included in the output message itself when Sign, Encrypt, or SignAndEncrypt are called. This setting may be used to obtain the SMIME headers separately. This setting is only applicable when OutputFormat is set to SMIME.

RecipientInfoType:   The type of signer information to include in the signed message.

This setting specifies which type of information about the recipient's encryption certificate is included in the encrypted message. Possible values are:

  • 0 (issuerAndSerialNumber - default)
  • 1 (subjectKeyIdentifier)

Note: When subjectKeyIdentifier is selected the recipient's encryption certificate must contain the subjectKeyIdentifier extension.

SignatureTimestamp:   The signature timestamp in the signed message.

This setting holds the timestamp of the signature. After calling VerifySignature this setting will hold the timestamp identifying when the signature was created. The timestamp is in UTC time with the format yyyyMMddHHmmss. For instance 20181130223821.

SignerInfoType:   The type of signer information to include in the signed message.

This setting specifies which type of information about the signer certificate is included in the signed message. Possible values are:

  • 0 (issuerAndSerialNumber - default)
  • 1 (subjectKeyIdentifier)

Note: When subjectKeyIdentifier is selected the signing certificate must contain the subjectKeyIdentifier extension.

UseAlgorithmOIDs:   Whether OIDs are used when providing information about the algorithms.

This setting controls whether the EncryptionAlgorithm parameter of the RecipientInfo event is populated with the name of the algorithm such as 3DES or the corresponding OID such as 1.2.840.113549.3.7.

The default value is False and the name of the algorithm is used. Set this to True to use the OIDs instead.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g. RuntimeLicense, License File).
  • License Type: The type of license installed (e.g. Royalty Free, Single Server).
UseDaemonThreads:   Whether threads created by the component are daemon threads.

If set to True (default), when the component creates a thread the thread's Daemon property will be explicitly set to True. When set to False the component will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2020 Android Edition - Version 20.0 [Build 8161]