CMS Pipeline Component
The CMS pipeline component implements the Cryptography Message Syntax standard for encryption and decryption with public key cryptography and X.509 digital certificates.
Remarks
The CMS pipeline component is used for encrypting, decrypting, signing, and verifying messages. The pipeline component supports processing message in PEM, DER (binary) and SMIME formats.
CMS Encoder Pipeline Component
The Encoder takes an unencrypted/unsigned data entity and generates an CMS entity as output.
Encrypting
The Encoder will only encrypt incoming data if the EncryptData property is set to True. Encrypting requires that the RecipientCert property is set to a certificate containing the public key that should be used to encrypt the data. The EncryptingAlgorithm and UseOAEP properties can be specified for further control of encryption.
Signing
The Encoder will only sign the data if the SignData property is set to True. Signing requires that the Certificate property is set to a certificate containing the private key that should be used to sign the data. The SigningAlgorithm and UsePSS properties can be specified for further control of the signature.
CMS Decoder Pipeline Component
The Decoder takes an encrypted/signed CMS entity and will decrypt/verify the message and produce the original message.
Decrypting
The Decoder will only attempt to decrypt incoming data if the DecryptData property is set to True. Decryption requires that the Certificate property is set to a certificate containing the private key that can decrypt the data (the private key that is paired with the public key that was used to encrypt the data). The RequireOAEP property can be set to True to instruct the pipeline component to throw an error if the data was not encrypted with OAEP (Optimal Asymmetric Encryption Padding).
Verifying Signatures
The Decoder will only attempt to verify the signature of the incoming data if the VerifySignature property is set to True. Verification requires that the certificate used to sign the data was attached to the message, or that the SignerCert property is set to the signer's certificate. The RequirePSS property can be set to True to instruct the pipeline component to throw an error if the data was not signed with RSA-PSS (RSA Probabilistic Signature Scheme).
Encoder Property List
The following is the full list of the properties of the encoder Pipeline Component with short descriptions. Click on the links for further details.
Certificate | The Certificate used to Sign or Decrypt messages. |
EnableCompression | Specifies whether to compress the message. |
EncryptData | Whether to encrypt the data. |
EncryptionAlgorithm | The algorithm to use for encryption. |
IncludeCertificates | Specifies whether to include the signer's certificate with the signed message. |
Other | Defines a set of configuration settings to be used by the pipeline component. |
OutputFormat | Specifies the output format. |
RecipientCert | The certificate used to encrypt the data. |
RuntimeLicense | Specifies the component runtime license key. |
SignatureHashAlgorithm | The signature hash algorithm used during signing. |
SignData | Whether to sign the MIME data. |
TempPath | The path to which temporary files are written at runtime. |
TransportLog | Tells the component where and how to report information about its operations. |
UseOAEP | Whether to use OAEP when encrypting the MIME data. |
UsePSS | Whether to use RSA-PSS when signing. |
Decoder Property List
The following is the full list of the properties of the decoder Pipeline Component with short descriptions. Click on the links for further details.
Certificate | The Certificate used to Sign or Decrypt messages. |
DecryptData | Whether to decrypt the incoming data. |
EnableCompression | Specifies whether to compress the message. |
Other | Defines a set of configuration settings to be used by the pipeline component. |
RequireOAEP | Whether an error should be thrown if OAEP was not used to encrypt the incoming message. |
RequirePSS | Whether an error should be thrown if RSA-PSS was not used to encrypt the incoming message. |
RuntimeLicense | Specifies the component runtime license key. |
SignerCert | Contains the certificate of the message signer. |
TempPath | The path to which temporary files are written at runtime. |
TransportLog | Tells the component where and how to report information about its operations. |
VerifySignature | Whether to attempt to verify the signature on the SMIME data. |
Config Settings
The following is a list of config settings for the Pipeline Component with short descriptions. Click on the links for further details.
CompressBeforeSign | Specifies whether to compress before signing. |
GenerateSignatureTimestamp | Whether to generate timestamps in signatures. |
IncludeHeaders | Tells the component whether to include the headers when encoding the message. |
IncludeInternalHeaders | Tells the component whether or not to include the internal headers when encoding the message. |
Certificate Property (CMS Pipeline component)
The Certificate used to Sign or Decrypt messages.
Data Type
CertificateRemarks
The adapter uses this certificate to sign message when encoding. This property is also used to decrypt message when decoding.
The certificate specified here must contain a private key.
DecryptData Property (CMS Pipeline component)
Whether to decrypt the incoming data.
Data Type
BooleanDefault Value
falseRemarks
If this property is true, the pipeline will attempt to decrypt the incoming message. If the data is not expected to be encrypted, this property should be set to false.
This property is not available in the Assembler/Encoder.
EnableCompression Property (CMS Pipeline component)
Specifies whether to compress the message.
Data Type
BooleanDefault Value
falseRemarks
This property specifies whether the input data will be compressed during the signing process.
If set to True the data will be compressed. If set to False (default) the data will not be compressed.
When compression is enabled the input will first be signed, and then compressed. To compress the data before signing set CompressBeforeSign.
EncryptData Property (CMS Pipeline component)
Whether to encrypt the data.
Data Type
BooleanDefault Value
falseRemarks
If False (default), the data will be encoded but not encrypted.
This property is not available in the Disassembler/Decoder.
EncryptionAlgorithm Property (CMS Pipeline component)
The algorithm to use for encryption.
Data Type
StringDefault Value
"3DES"Remarks
This property specifies the encryption algorithm to be used when encrypting. Possible values are:
- "3DES"
- "DES"
- "RC2CBC40"
- "RC2CBC64"
- "RC2CBC128" or "RC2"
- "AESCBC128" or "AES"
- "AESCBC192"
- "AESCBC256"
This property is not available in the Disassembler/Decoder.
IncludeCertificates Property (CMS Pipeline component)
Specifies whether to include the signer's certificate with the signed message.
Data Type
EnumerationPossible Values
None (0)Signer Certs (1)
Signer Certs And Chain (2)
Default Value
1Remarks
This setting specifies which certificates (if any) are included in the signed message. By default the public certificate of the certificate used to sign the message is included. This allows the receiving party to verify the signature without any additional knowledge. If this is set to icsNone the recipient must obtain and specify the public certificate to be used for signature verification. Possible values are:
Value | Description |
0 (icsNone) | No signer certificates are included. |
1 (icsSignerCerts - default) | The certificates specified in Certificate are included. |
2 (icsSignerCertsAndChain) | The certificates specified in Certificate and the full chain of each certificate are included. |
This property is not available in the Disassembler/Decoder.
Other Property (CMS Pipeline component)
Defines a set of configuration settings to be used by the pipeline component.
Data Type
StringDefault Value
""Remarks
The pipeline component accepts one or more configuration settings. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the pipeline component, access to these internal properties is provided through the Other property.
The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line.
For example:
configname1=value1
configname2=value2
OutputFormat Property (CMS Pipeline component)
Specifies the output format.
Data Type
EnumerationPossible Values
PEM (0)DER (1)
SMIME (2)
Default Value
1Remarks
This property specifies the format of the output message created when signing or encrypting.
The various formats allow for easier transport of the signed or encrypted message, as well as interoperability with other utilities.
Possible values are:
Value | Description |
PEM (default) | A PEM formatted message. For instance:
-----BEGIN CMS-----
MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABGFD
b250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9Imlzby04ODU5LTEiDQpDb250ZW50LVRy
...
mlJLPoCw5pf3Cjae56oXs29IZMcDXKersNjFGYSaG0o9k3lAcj9llLFh54Xr1ljx7K0VpVvlrmgu
kNHAf7cUvvilW/KrDa+T2n+sOFAAAAAAAAA=
-----END CMS-----
|
DER | The message is binary (raw bytes). |
SMIME | The message is S/MIME encoded. For instance:
Mime-Version: 1.0
Content-Type: application/pkcs7-mime; smime-type=signed-data; name="smime.p7m"
Content-Transfer-Encoding: base64
Content-Disposition: attachment; filename="smime.p7m"
MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABGFD
b250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9Imlzby04ODU5LTEiDQpDb250ZW50LVRy
...
Mpc/PtPNeHA3CCFGRFnHju/yb9CsQWpgf8TTWytjP7O1hFUecW0yiuGSDeeNlQ4ZcX0TOm6haRMT
lqYIrHUNMn4tYaREevNBL9CQB8MAAAAAAAA= |
This property is not available in the Disassembler/Decoder.
RecipientCert Property (CMS Pipeline component)
The certificate used to encrypt the data.
Data Type
CertificateRemarks
The adapter uses the recipient's certificate to encrypt the data so that it can be decrypted once it reaches the recipient. This property should be set to the appropriate certificate for encryption.
This property is not available in the Disassembler/Decoder.
RequireOAEP Property (CMS Pipeline component)
Whether an error should be thrown if OAEP was not used to encrypt the incoming message.
Data Type
BooleanDefault Value
falseRemarks
By default, the adapter will silently support decrypting messages regardless of whether they were encrypted with Optimal Asymmetric Encryption Padding (OAEP). If OAEP should be required, and thus an error should be thrown if OAEP is not detected, set this property to true.
This property is not available in the Assembler/Encoder.
RequirePSS Property (CMS Pipeline component)
Whether an error should be thrown if RSA-PSS was not used to encrypt the incoming message.
Data Type
BooleanDefault Value
falseRemarks
By default, the adapter will silently support decrypting and verifying messages regardless of whether they were signed with RSA Probabilistic Signature Scheme (RSA-PSS). If RSA-PSS should be required, and thus an error should be thrown if RSA-PSS is not detected, set this property to true.
This property is not available in the Assembler/Encoder.
RuntimeLicense Property (CMS Pipeline component)
Specifies the component runtime license key.
Data Type
StringDefault Value
""Remarks
You can use the RuntimeLicense property to set the runtime key for the adapter license.
This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.
SignatureHashAlgorithm Property (CMS Pipeline component)
The signature hash algorithm used during signing.
Data Type
StringDefault Value
"SHA256"Remarks
This property specifies the signature hash algorithm used to prepare the message digest of signature.
When signing the input data is first hashed with the algorithm specified by this property to produce a message digest. The computed digest is then digitally signed with the certificates specified in Certificate.
The value specified here may be the name of the algorithm or the corresponding OID. Possible values are:
- "SHA-256" (default)
- "SHA-384"
- "SHA-512"
- "SHA-224"
- "SHA1"
- "MD5"
This property is not available in the Disassembler/Decoder.
SignData Property (CMS Pipeline component)
Whether to sign the MIME data.
Data Type
BooleanDefault Value
trueRemarks
If True (default), the certificate held in the Certificate property will be used to sign the message.
This property is not available in the Disassembler/Decoder.
SignerCert Property (CMS Pipeline component)
Contains the certificate of the message signer.
Data Type
CertificateRemarks
This certificate is used to verify the signature on the incoming message. Setting this property is only necessary if the message does not have the signer's certificate attached to it.
This property is not available in the Assembler/Encoder.
TempPath Property (CMS Pipeline component)
The path to which temporary files are written at runtime.
Data Type
StringDefault Value
""Remarks
If you are planning on working with binary files or large files, it is recommended that you set a valid path for this property. When set to a valid path this property tells the adapter to use temp files when performing operations. If this is not set, all operations are done in memory and require that all input and output is in ASCII.
This property accepts the "%TEMP%" macro, which will be replaced with the default system temporary directory at runtime.
TransportLog Property (CMS Pipeline component)
Tells the component where and how to report information about its operations.
Data Type
LogRemarks
This is a Log type property which contains fields describing how and where the adapter will record information about its execution.
This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.
UseOAEP Property (CMS Pipeline component)
Whether to use OAEP when encrypting the MIME data.
Data Type
BooleanDefault Value
falseRemarks
By default, the adapter will use PKCS1 when encrypting the message. To use Optimal Asymmetric Encryption Padding (OAEP) instead, set this property to true.
This property is not available in the Disassembler/Decoder.
UsePSS Property (CMS Pipeline component)
Whether to use RSA-PSS when signing.
Data Type
BooleanDefault Value
falseRemarks
To use RSA Probabilistic Signature Scheme (RSA-PSS) when signing, set this property to true. Note that the certificate used to sign does not itself need to be signed with RSA-PSS; any valid RSA certificate may be used with this setting.
This property is not available in the Disassembler/Decoder.
VerifySignature Property (CMS Pipeline component)
Whether to attempt to verify the signature on the SMIME data.
Data Type
BooleanDefault Value
trueRemarks
If this property is true, the adapter will throw an error if the incoming message is unsigned, or if the signature cannot be verified using the SignerCert.
This property is not available in the Assembler/Encoder.
Certificate Type
The digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
Store String |
The name of the certificate store for the client certificate. The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. 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). If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file. |
||||||||||||||||||||||||||||||||||||||||||||||||
StorePassword String |
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreType CertStoreTypes |
The type of certificate store for this certificate. The adapter supports both public and private keys in a variety of formats. When the cstAuto value is used the adapter will automatically determine the type. This field can take one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
Subject String |
The subject of the certificate used for client authentication. When this property is set, a search is performed in the current certificate store certificate with matching subject. If an exact match is not found, the store is searched for subjects containing the value of the property. When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US Example (Searching with partial subject)
If a match is 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. If a matching certificate is found, Subject is set to the full subject of the matching certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
Thumbprint String |
The thumbprint of the certificate. This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Certificate();
Creates a Certificate instance whose properties can be set.
public Certificate(string certificateFile);
Opens CertificateFile and reads out the contents as an X509 public key.
public Certificate(byte[] certificateData);
Parses CertificateData as an X509 public key.
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
CloudFilesAccount Type
Cloud storage service provider account credentials.
Remarks
This type is used to hold account credentials for cloud storage service providers which do not use OAuth for authentication.
Fields
AccessKey String |
A storage service provider access key. This field specifies the access key to use for authentication. It must be populated when using one of these storage service providers:
|
||||||||||
Account String |
A storage service provider account string. This field specifies the account string to use for authentication. It must be populated when using one of these storage service providers:
|
||||||||||
ApplicationKey String |
A storage service provider application key. This field specifies the application key to use for authentication. It must be populated when using one of these storage service providers:
|
||||||||||
ApplicationKeyId String |
A storage service provider application key Id. This field specifies the application key Id to use for authentication. It must be populated when using one of these storage service providers:
|
||||||||||
AuthMechanism CSAuthMechanisms |
The HTTP authentication scheme to use (for storage service providers that support multiple). For storage service providers that support more than one HTTP authentication scheme, this field specifies which should be used. This field is only relevant for the following storage service providers:
UsagePossible values for this field are:
When set to camSimple (1), the value of the User field is automatically sent in every request using the user.name query parameter. (Note: This authentication scheme is only valid for the spHadoopDFS (10) storage service provider.) When set to camBasic (2), camNTLM (3), or camNegotiate (4), the values held by the User and Password fields will be used to perform Basic, NTLM, or Negotiate authentication. |
||||||||||
HadoopURL String |
The URL of the Hadoop WebHDFS server. This field specifies the URL of the Hadoop WebHDFS server to make requests against. It must be set when ServiceProvider is set to spHadoopDFS (10). A full WebHDFS URL looks like http[s]://<HOST>:<PORT>/webhdfs/v1. The adapter will automatically append /webhdfs/v1 when making requests (if necessary). The adapter automatically detects whether to secure the connection using SSL/TLS based on whether the value begins with http (not secured) or https (secured). |
||||||||||
Password String |
A storage service provider password. This field specifies the password to use for authentication. It must be populated when using one of these storage service providers:
|
||||||||||
ProjectId String |
A Google Cloud Platform project Id string. This field specifies the Google Cloud Platform project Id string to use for authentication. It must be set when using OAuth 2.0 authentication (via the OAuthAuthorization property) with one of these storage service providers:
Note that the above providers will fall back to using an AccessKey and SecretKey for authentication if either this field or the OAuthAuthorization property is empty. |
||||||||||
SecretKey String |
A storage service provider access key. This field specifies the access key to use for authentication. It must be populated when using one of these storage service providers:
|
||||||||||
User String |
A storage service provider user name. This field specifies the user name to use for authentication. It must be populated when using one of these storage service providers:
|
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public CloudFilesAccount();
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.
Fields
AutoDetect Boolean |
Tells the adapter whether or not to automatically detect and use firewall system settings, if available. |
||||||||
FirewallType FirewallTypes |
Determines the type of firewall to connect through. The applicable values are the following:
|
||||||||
Host String |
Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting. If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
Password String |
A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired. |
||||||||
Port Integer |
The TCP port for the firewall Host. See the description of the Host field for details. Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details. |
||||||||
User String |
A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Firewall();
Log Type
A log where the component will record information about its operations.
Remarks
This describes how and where the adapter will record information describing its execution.
Fields
Location String |
This field describes the location where the logging information is to be written. If the EventLog LogType has been chosen, this field must contain the name of the Event Log to which the information should be written. The default value for this field is "Application". If a value other than "Application" is set the computer must be restarted for the change to take effect. Note that the same event log must be used for all send ports and receive locations that use the same adapter. If the File LogType has been chosen, this field must contain the location of the file to write logging information to on the file system. The adapter also supports logging to files based on the current date and time. This allows for log files to be organized by days, months, or other intervals as specified. When specifying a log filename include a valid .NET date and time format string within the < and > characters. For instance C:\logs\sftp_<yyyyMMdd>.log or C:\logs\as2_<yyyyMMdd>T<hhmm>.log. |
||||||||||
LogMode LogModes |
This field controls what information the adapter logs. The possible values have the following affect on the adapter's behavior:
|
||||||||||
LogType LogTypes |
This property controls where the adapter will log the information. The possible values have the following affect on the adapter's behavior:
|
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Log();
public Log(LogTypes logType, string location, LogModes logMode);
OAuthAuthorizationParam Type
This type holds details of the OAuth authorization.
Remarks
This type holds details of the OAuth authorization.
Fields
AuthorizationScopes String |
A space separated list of scopes as defined by the authorization server. |
AuthorizationString String |
The OAuth Authorization string. This field holds the current OAuth authorization string. This is retrieved during the OAuth authorization process and is used to authenticate the request. This is a string like:
|
CacheLocation String |
The location on disk of the OAuth Cache File. This field specifies the location on disk of the OAuth cache file. This file holds OAuth credentials that may be automatically used during runtime and by other ports using the same provider. The adapter uses the data within the cache file to automatically refresh expired tokens at runtime. Do not alter the contents of the file directly. One file for each provider is used by default. For instance for Box the value is:
This value may be specified manually as well. |
CallbackURL String |
The Callback URL used during OAuth authorization. This field specifies the local URL to which the browser is redirected when initially performing authorization. When initially establishing Authorization set this value to the redirect URI that is registered for your application with the service provider. For instance "http://localhost:7777". The adapter will parse this URL and start a small embedded web server on the specified port to receive the OAuth response from the provider during OAuth authorization. This value is required to perform OAuth authorization. |
ClientId String |
The id of the client assigned when registering the application. This field holds the id of the client that was assigned when initially registering the application. This value is required to perform OAuth authorization. |
ClientSecret String |
The secret of the client assigned when registering the application. This field holds the secret of the client that was assigned when initially registering the application. This value is required to perform OAuth authorization. |
ExpiresIn Integer |
The expiration time of the current OAuth authorization string. This value is populated after OAuth authorization and holds the expiration time of the OAuth access token as reported by the service provider. This is used at runtime to calculate whether the token should be refreshed before attempting an operation. If the token is expired the adapter will automatically refresh the token. If the token is not expired the adapter will use the current token. This value should not be set manually. Note: Not all providers provide this value. For instance Dropbox access tokens never expire. |
RefreshToken String |
The refresh token received from or sent to the authorization server. This field holds the refresh token received during the initial OAuth authorization. It is used by the adapter to automatically request a new AuthorizationString when the current value expires. |
ServerAuthURL String |
The URL of the authorization server. |
ServerTokenURL String |
The URL of the token server. |
ServiceProvider String |
The service provider to authenticate with. This field defines the service provider. This is used when performing OAuth authorization. OAuth authorization is only applicable to some providers. If the provider does not support OAuth a warning will be displayed. Possible values when using the Cloud Storage adapter are:
|
TimeStamp String |
The timestamp of the OAuth authorization string. This field holds the timestamp of when the AuthorizationString was retrieved. This is used in conjunction with ExpiresIn to calculate if refreshing the token is required. For more details see ExpiresIn. This value should not be set manually. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public OAuthAuthorizationParam();
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.
Fields
AuthScheme ProxyAuthSchemes |
Use the AuthScheme field to tell the adapter which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set. AuthScheme should be set to authNone (3) when no authentication is expected. By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead. If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the adapter. Look at the configuration file for the adapter being used to find more information about manually setting this token. If AuthScheme is set to authNtlm (4), NTLM authentication will be used. This option is only available in the SSL package. For security reasons, setting this property will clear the values of User and Password. |
||||||||
AutoDetect Boolean |
Tells the adapter whether or not to automatically detect and use proxy system settings, if available. |
||||||||
Password String |
A password if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]". If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
||||||||
Port Integer |
The TCP port for the proxy Server (default 80). See the description of the Server field for details. |
||||||||
Server String |
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the Server field is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
SSL ProxySSLTypes |
Determines when to use SSL for the connection to the proxy. The applicable values are the following:
|
||||||||
User String |
A user name, if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]". If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Proxy();
public Proxy(string server, int port);
public Proxy(string server, int port, string user, string password);
Config Settings (CMS Pipeline component)
The adapter 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 adapter, access to these internal properties is provided through the Other property.CMS Config Settings |
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. |
GenerateSignatureTimestamp:
Whether to generate timestamps in signatures.
If GenerateSignatureTimestamp is True,
a timestamp will be generated and added to all signatures created by the adapter.
The default value is True. |
IncludeHeaders:
Tells the adapter whether to include the headers when encoding the message.If True (default), the adapter will include MIME headers when signing or encrypting.
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 adapter whether or not to include the internal headers when encoding the message.If True, the adapter will generate and include MIME part headers when
signing or encrypting. When decrypting and verifying 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. |
Supported Macros
The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.
Temp | This is resolved to the full path to the system's temporary directory. |
MessageID | Globally unique identifier (GUID) of the message in BizTalk Server. |
SourceFileName | The original file name. This includes the extension and excludes the file path, for example, Sample.xml |
SourceFileNameNoExt | The original file name without the extension or file path, for example, Sample |
RemoteFileName | The name of the file as it was uploaded to the remote server. This includes the extension and excludes the file path, for example, Sample.xml. Valid only for AS3, FTP, and SFTP Send Adapters. |
DestinationParty | Name of the destination party. |
DestinationPartyQualifier | Qualifier of the destination party. |
SourceParty | Name of the source party. |
SourcePartyQualifier | Qualifier of the source party. |
DateTime:CustomFormat | This special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year. |
Date | The date format yyyy-MM-dd. |
DateTime | The date format yyyy-MM-ddThhmmss. |
Time | The date format hhmmss. |
DateTime_BTS2000 | The date format yyyyMMddhhmmssf. |
DateTime.TZ | The date format yyyy-MM-ddThhmmsszzz. |
Time.TZ | The date format hhmmsszzz. |
Property#<Schema>#<Name> | This special value allows you to include a property from the incoming message. For instance "PROPERTY#http://schemas.microsoft.com/BizTalk/2003/system-properties#ReceivePortName" would resolve to the ReceivePortName property of the message. |