AmazonSNS Class
Properties Methods Events Config Settings Errors
The AmazonSNS class provides a simple interface to Amazon's Simple Notification Service (SNS).
Class Name
IPWorksMQ_AmazonSNS
Procedural Interface
ipworksmq_amazonsns_open(); ipworksmq_amazonsns_close($res); ipworksmq_amazonsns_register_callback($res, $id, $function); ipworksmq_amazonsns_get_last_error($res); ipworksmq_amazonsns_get_last_error_code($res); ipworksmq_amazonsns_set($res, $id, $index, $value); ipworksmq_amazonsns_get($res, $id, $index); ipworksmq_amazonsns_do_addpermission($res, $topicarn, $policylabel, $awsaccountids, $actionnames); ipworksmq_amazonsns_do_config($res, $configurationstring); ipworksmq_amazonsns_do_confirmsubscription($res, $topicarn, $token); ipworksmq_amazonsns_do_createtopic($res, $name); ipworksmq_amazonsns_do_deletetopic($res, $topicarn); ipworksmq_amazonsns_do_doevents($res); ipworksmq_amazonsns_do_getsubscriptionattributes($res, $subscriptionarn); ipworksmq_amazonsns_do_gettopicattributes($res, $topicarn); ipworksmq_amazonsns_do_getxvalue($res, $xpath); ipworksmq_amazonsns_do_interrupt($res); ipworksmq_amazonsns_do_listsubscriptions($res); ipworksmq_amazonsns_do_listtopics($res); ipworksmq_amazonsns_do_listtopicsubscriptions($res, $topicarn); ipworksmq_amazonsns_do_publish($res, $topicarn, $subject, $message); ipworksmq_amazonsns_do_publishcustom($res, $topicarn, $subject, $defaultmessage, $emailmessage, $emailjsonmessage, $httpmessage, $httpsmessage, $smsmessage, $sqsmessage); ipworksmq_amazonsns_do_removepermission($res, $topicarn, $policylabel); ipworksmq_amazonsns_do_reset($res); ipworksmq_amazonsns_do_sendcustomrequest($res, $url, $requestdata, $otherheaders); ipworksmq_amazonsns_do_setsubscriptionattributes($res, $subscriptionarn, $attributevalue); ipworksmq_amazonsns_do_settopicattributes($res, $topicarn, $attributetype, $attributevalue); ipworksmq_amazonsns_do_subscribe($res, $topicarn, $endpoint, $endpointprotocol); ipworksmq_amazonsns_do_unsubscribe($res, $subscriptionarn);
Remarks
The AmazonSNS class allows you to quickly and easily access Amazon's Simple Notification Service (SNS). SNS allows you to create topics and subscriptions for notification purposes.
Before using the class you must first have an AWS account and sign up for the SNS service. To use the class, first set AccessKey and SecretKey.
To create a topic, call CreateTopic. You may manage the topic and its properties with GetTopicAttributes, SetTopicAttributes, and DeleteTopic.
To subscribe to a topic, call Subscribe. To manage a subscription, use GetSubscriptionAttributes, SetSubscriptionAttributes, and Unsubscribe.
Use ListSubscriptions, ListTopicSubscriptions, and ListTopics to list existing topics and subscriptions.
Call Publish or PublishCustom to send a notification on a topic.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AccessKey | The Access Key Id for the Amazon Web Services account. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of the firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a username if authentication is to be used when connecting through a firewall. |
Idle | This property specifies the current status of the class. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username if authentication is to be used for the proxy. |
SecretKey | The Secret Access Key for the Amazon Web Services account. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SubscriptionMarker | The token identifying the next page of results. |
SubscriptionCount | The number of records in the Subscription arrays. |
SubscriptionConfirmationWasAuthenticated | This property reports whether or not the subscription was confirmed. |
SubscriptionDeliveryPolicy | This property holds the JSON serialization of the subscription's delivery policy. |
SubscriptionEffectiveDeliveryPolicy | This property holds the JSON serialization of the subscription's effective delivery policy. |
SubscriptionEndpoint | This property contains the subscription's endpoint. |
SubscriptionHasAttributes | This property returns true if the subscription attributes are available. |
SubscriptionOwner | The AWS account ID of the subscription's owner. |
SubscriptionProtocol | This property specifies the protocol used by the subscription. |
SubscriptionArn | The subscription's Amazon Resource Name (ARN) used to identify the subscription. |
SubscriptionTopicArn | The Amazon Resource Name (ARN) of the topic this subscription is associated with. |
Timeout | This property includes the timeout for the class. |
TopicMarker | The token identifying the next page of results. |
TopicCount | The number of records in the Topic arrays. |
TopicAccessPolicy | This property holds the JSON serialized access control policy for the topic. |
TopicDeliveryPolicy | The JSON serialized policy for the topic. |
TopicDisplayName | This property holds the name used in the 'From' property for email based endpoints. |
TopicEffectiveDeliveryPolicy | This property holds the JSON serialization of the topic's effective delivery policy. |
TopicHasAttributes | This property returns true if the topic attributes are available. |
TopicOwner | The AWS account ID of the topic's owner. |
TopicSubscriptionsConfirmed | The number of confirmed subscriptions to this topic. |
TopicSubscriptionsDeleted | The number of deleted subscriptions on this topic. |
TopicSubscriptionsPending | The number of pending subscriptions on this topic. |
TopicArn | The Amazon Resource Name (ARN) of the topic. |
UseSSL | Determines if SSL is used when connecting to Amazon. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddPermission | Adds permissions to the topic's access control policy. |
Config | Sets or retrieves a configuration setting. |
ConfirmSubscription | Completes the subscription request. |
CreateTopic | Creates a new topic. |
DeleteTopic | Deletes the specified topic. |
DoEvents | This method processes events from the internal message queue. |
GetSubscriptionAttributes | Retrieves the subscription's attributes. |
GetTopicAttributes | Retrieves the topic's attributes. |
GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
Interrupt | This method interrupts the current method. |
ListSubscriptions | Lists subscriptions for the current account. |
ListTopics | Lists all topics for the current account. |
ListTopicSubscriptions | Lists subscriptions to the specified topic. |
Publish | Publishes a message to the topic. |
PublishCustom | Publishes a message to the topic. |
RemovePermission | Removes permissions from a topic. |
Reset | Resets request-related properties. |
SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
SetSubscriptionAttributes | Sets attributes of the subscription. |
SetTopicAttributes | Sets attributes on the specified topic. |
Subscribe | Request a subscription to the specific topic. |
Unsubscribe | Unsubscribes from the topic. |
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.
Error | Fired when information is available about errors during data delivery. |
Log | This event fires once for each log message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
SubscriptionList | Fires with information about the subscription. |
TopicList | Fires with information about the topic. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
APIVersion | Service's API version. |
HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
IsSubscriptionPaged | Whether or not all subscriptions were returned by the last listing. |
IsTopicPaged | Whether or not all topics were returned by the last listing. |
JSONMessage | A custom JSON message to be published. |
MessageAttributeCount | The number of message attributes. |
MessageAttributeDataType[i] | The data type of the message attribute. |
MessageAttributeName[i] | The name of the message attribute. |
MessageAttributeValue[i] | The value of the message attribute. |
PhoneNumber | The phone number to which you want to deliver an SMS message. Use E.164 format. |
SignatureVersion | The version of signature used. |
SignCustomRequest | Tells the class to sign the outgoing request. |
TargetArn | The TargetArn when publishing a message. |
TransferredData | Returns the entire XML response received from the server. |
URL | If set, the default URL will be overridden by this value. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
AccessKey Property (IPWorksMQ_AmazonSNS Class)
The Access Key Id for the Amazon Web Services account.
Object Oriented Interface
public function getAccessKey(); public function setAccessKey($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 1 ); ipworksmq_amazonsns_set($res, 1, $value );
Default Value
''
Remarks
This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the SecretKey to authenticate with Amazon servers.
Data Type
String
FirewallAutoDetect Property (IPWorksMQ_AmazonSNS Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Object Oriented Interface
public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 2 ); ipworksmq_amazonsns_set($res, 2, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (IPWorksMQ_AmazonSNS Class)
This property determines the type of firewall to connect through.
Object Oriented Interface
public function getFirewallType(); public function setFirewallType($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 3 ); ipworksmq_amazonsns_set($res, 3, $value );
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (IPWorksMQ_AmazonSNS Class)
This property contains the name or IP address of the firewall (optional).
Object Oriented Interface
public function getFirewallHost(); public function setFirewallHost($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 4 ); ipworksmq_amazonsns_set($res, 4, $value );
Default Value
''
Remarks
This property contains the name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (IPWorksMQ_AmazonSNS Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Object Oriented Interface
public function getFirewallPassword(); public function setFirewallPassword($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 5 ); ipworksmq_amazonsns_set($res, 5, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (IPWorksMQ_AmazonSNS Class)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Object Oriented Interface
public function getFirewallPort(); public function setFirewallPort($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 6 ); ipworksmq_amazonsns_set($res, 6, $value );
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (IPWorksMQ_AmazonSNS Class)
This property contains a username if authentication is to be used when connecting through a firewall.
Object Oriented Interface
public function getFirewallUser(); public function setFirewallUser($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 7 ); ipworksmq_amazonsns_set($res, 7, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
Idle Property (IPWorksMQ_AmazonSNS Class)
This property specifies the current status of the class.
Object Oriented Interface
public function getIdle();
Procedural Interface
ipworksmq_amazonsns_get($res, 8 );
Default Value
true
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
LocalHost Property (IPWorksMQ_AmazonSNS Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 9 ); ipworksmq_amazonsns_set($res, 9, $value );
Default Value
''
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
ProxyAuthScheme Property (IPWorksMQ_AmazonSNS Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Object Oriented Interface
public function getProxyAuthScheme(); public function setProxyAuthScheme($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 10 ); ipworksmq_amazonsns_set($res, 10, $value );
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (IPWorksMQ_AmazonSNS Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Object Oriented Interface
public function getProxyAutoDetect(); public function setProxyAutoDetect($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 11 ); ipworksmq_amazonsns_set($res, 11, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (IPWorksMQ_AmazonSNS Class)
This property contains a password if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyPassword(); public function setProxyPassword($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 12 ); ipworksmq_amazonsns_set($res, 12, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (IPWorksMQ_AmazonSNS Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Object Oriented Interface
public function getProxyPort(); public function setProxyPort($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 13 ); ipworksmq_amazonsns_set($res, 13, $value );
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (IPWorksMQ_AmazonSNS Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Object Oriented Interface
public function getProxyServer(); public function setProxyServer($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 14 ); ipworksmq_amazonsns_set($res, 14, $value );
Default Value
''
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (IPWorksMQ_AmazonSNS Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Object Oriented Interface
public function getProxySSL(); public function setProxySSL($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 15 ); ipworksmq_amazonsns_set($res, 15, $value );
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (IPWorksMQ_AmazonSNS Class)
This property contains a username if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyUser(); public function setProxyUser($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 16 ); ipworksmq_amazonsns_set($res, 16, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
SecretKey Property (IPWorksMQ_AmazonSNS Class)
The Secret Access Key for the Amazon Web Services account.
Object Oriented Interface
public function getSecretKey(); public function setSecretKey($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 17 ); ipworksmq_amazonsns_set($res, 17, $value );
Default Value
''
Remarks
This property describes the secret key to the Amazon account. It should not be shared with others. The SecretKey is used along with the AccessKey in the authentication process with Amazon servers.
Data Type
String
SSLAcceptServerCertEffectiveDate Property (IPWorksMQ_AmazonSNS Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLAcceptServerCertEffectiveDate();
Procedural Interface
ipworksmq_amazonsns_get($res, 18 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (IPWorksMQ_AmazonSNS Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLAcceptServerCertExpirationDate();
Procedural Interface
ipworksmq_amazonsns_get($res, 19 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (IPWorksMQ_AmazonSNS Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLAcceptServerCertExtendedKeyUsage();
Procedural Interface
ipworksmq_amazonsns_get($res, 20 );
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
SSLAcceptServerCertFingerprint Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprint();
Procedural Interface
ipworksmq_amazonsns_get($res, 21 );
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
SSLAcceptServerCertFingerprintSHA1 Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA1();
Procedural Interface
ipworksmq_amazonsns_get($res, 22 );
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
SSLAcceptServerCertFingerprintSHA256 Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA256();
Procedural Interface
ipworksmq_amazonsns_get($res, 23 );
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
SSLAcceptServerCertIssuer Property (IPWorksMQ_AmazonSNS Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertIssuer();
Procedural Interface
ipworksmq_amazonsns_get($res, 24 );
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
SSLAcceptServerCertPrivateKey Property (IPWorksMQ_AmazonSNS Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKey();
Procedural Interface
ipworksmq_amazonsns_get($res, 25 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSNS Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyAvailable();
Procedural Interface
ipworksmq_amazonsns_get($res, 26 );
Default Value
false
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (IPWorksMQ_AmazonSNS Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyContainer();
Procedural Interface
ipworksmq_amazonsns_get($res, 27 );
Default Value
''
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (IPWorksMQ_AmazonSNS Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKey();
Procedural Interface
ipworksmq_amazonsns_get($res, 28 );
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
SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSNS Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyAlgorithm();
Procedural Interface
ipworksmq_amazonsns_get($res, 29 );
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
SSLAcceptServerCertPublicKeyLength Property (IPWorksMQ_AmazonSNS Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyLength();
Procedural Interface
ipworksmq_amazonsns_get($res, 30 );
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
SSLAcceptServerCertSerialNumber Property (IPWorksMQ_AmazonSNS Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLAcceptServerCertSerialNumber();
Procedural Interface
ipworksmq_amazonsns_get($res, 31 );
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
SSLAcceptServerCertSignatureAlgorithm Property (IPWorksMQ_AmazonSNS Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertSignatureAlgorithm();
Procedural Interface
ipworksmq_amazonsns_get($res, 32 );
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
SSLAcceptServerCertStore Property (IPWorksMQ_AmazonSNS Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStore(); public function setSSLAcceptServerCertStore($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 33 ); ipworksmq_amazonsns_set($res, 33, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLAcceptServerCertStorePassword Property (IPWorksMQ_AmazonSNS 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 getSSLAcceptServerCertStorePassword(); public function setSSLAcceptServerCertStorePassword($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 34 ); ipworksmq_amazonsns_set($res, 34, $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
SSLAcceptServerCertStoreType Property (IPWorksMQ_AmazonSNS Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStoreType(); public function setSSLAcceptServerCertStoreType($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 35 ); ipworksmq_amazonsns_set($res, 35, $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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (IPWorksMQ_AmazonSNS Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertSubjectAltNames();
Procedural Interface
ipworksmq_amazonsns_get($res, 36 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (IPWorksMQ_AmazonSNS Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintMD5();
Procedural Interface
ipworksmq_amazonsns_get($res, 37 );
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
SSLAcceptServerCertThumbprintSHA1 Property (IPWorksMQ_AmazonSNS Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA1();
Procedural Interface
ipworksmq_amazonsns_get($res, 38 );
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
SSLAcceptServerCertThumbprintSHA256 Property (IPWorksMQ_AmazonSNS Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA256();
Procedural Interface
ipworksmq_amazonsns_get($res, 39 );
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
SSLAcceptServerCertUsage Property (IPWorksMQ_AmazonSNS Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLAcceptServerCertUsage();
Procedural Interface
ipworksmq_amazonsns_get($res, 40 );
Default Value
''
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
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
SSLAcceptServerCertUsageFlags Property (IPWorksMQ_AmazonSNS Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertUsageFlags();
Procedural Interface
ipworksmq_amazonsns_get($res, 41 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (IPWorksMQ_AmazonSNS Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLAcceptServerCertVersion();
Procedural Interface
ipworksmq_amazonsns_get($res, 42 );
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
SSLAcceptServerCertSubject Property (IPWorksMQ_AmazonSNS Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLAcceptServerCertSubject(); public function setSSLAcceptServerCertSubject($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 43 ); ipworksmq_amazonsns_set($res, 43, $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, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLAcceptServerCertEncoded Property (IPWorksMQ_AmazonSNS Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 44 ); ipworksmq_amazonsns_set($res, 44, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (IPWorksMQ_AmazonSNS Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLCertEffectiveDate();
Procedural Interface
ipworksmq_amazonsns_get($res, 45 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (IPWorksMQ_AmazonSNS Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLCertExpirationDate();
Procedural Interface
ipworksmq_amazonsns_get($res, 46 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (IPWorksMQ_AmazonSNS Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLCertExtendedKeyUsage();
Procedural Interface
ipworksmq_amazonsns_get($res, 47 );
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
SSLCertFingerprint Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprint();
Procedural Interface
ipworksmq_amazonsns_get($res, 48 );
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
SSLCertFingerprintSHA1 Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA1();
Procedural Interface
ipworksmq_amazonsns_get($res, 49 );
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
SSLCertFingerprintSHA256 Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA256();
Procedural Interface
ipworksmq_amazonsns_get($res, 50 );
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
SSLCertIssuer Property (IPWorksMQ_AmazonSNS Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLCertIssuer();
Procedural Interface
ipworksmq_amazonsns_get($res, 51 );
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
SSLCertPrivateKey Property (IPWorksMQ_AmazonSNS Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKey();
Procedural Interface
ipworksmq_amazonsns_get($res, 52 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSNS Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLCertPrivateKeyAvailable();
Procedural Interface
ipworksmq_amazonsns_get($res, 53 );
Default Value
false
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (IPWorksMQ_AmazonSNS Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKeyContainer();
Procedural Interface
ipworksmq_amazonsns_get($res, 54 );
Default Value
''
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (IPWorksMQ_AmazonSNS Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLCertPublicKey();
Procedural Interface
ipworksmq_amazonsns_get($res, 55 );
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
SSLCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSNS Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLCertPublicKeyAlgorithm();
Procedural Interface
ipworksmq_amazonsns_get($res, 56 );
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
SSLCertPublicKeyLength Property (IPWorksMQ_AmazonSNS Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLCertPublicKeyLength();
Procedural Interface
ipworksmq_amazonsns_get($res, 57 );
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
SSLCertSerialNumber Property (IPWorksMQ_AmazonSNS Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLCertSerialNumber();
Procedural Interface
ipworksmq_amazonsns_get($res, 58 );
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
SSLCertSignatureAlgorithm Property (IPWorksMQ_AmazonSNS Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLCertSignatureAlgorithm();
Procedural Interface
ipworksmq_amazonsns_get($res, 59 );
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
SSLCertStore Property (IPWorksMQ_AmazonSNS Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 60 ); ipworksmq_amazonsns_set($res, 60, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (IPWorksMQ_AmazonSNS 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 getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 61 ); ipworksmq_amazonsns_set($res, 61, $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
SSLCertStoreType Property (IPWorksMQ_AmazonSNS Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 62 ); ipworksmq_amazonsns_set($res, 62, $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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubjectAltNames Property (IPWorksMQ_AmazonSNS Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLCertSubjectAltNames();
Procedural Interface
ipworksmq_amazonsns_get($res, 63 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (IPWorksMQ_AmazonSNS Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintMD5();
Procedural Interface
ipworksmq_amazonsns_get($res, 64 );
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
SSLCertThumbprintSHA1 Property (IPWorksMQ_AmazonSNS Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA1();
Procedural Interface
ipworksmq_amazonsns_get($res, 65 );
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
SSLCertThumbprintSHA256 Property (IPWorksMQ_AmazonSNS Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA256();
Procedural Interface
ipworksmq_amazonsns_get($res, 66 );
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
SSLCertUsage Property (IPWorksMQ_AmazonSNS Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLCertUsage();
Procedural Interface
ipworksmq_amazonsns_get($res, 67 );
Default Value
''
Remarks
This property contains the text description of SSLCertUsageFlags.
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
SSLCertUsageFlags Property (IPWorksMQ_AmazonSNS Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLCertUsageFlags();
Procedural Interface
ipworksmq_amazonsns_get($res, 68 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (IPWorksMQ_AmazonSNS Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLCertVersion();
Procedural Interface
ipworksmq_amazonsns_get($res, 69 );
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
SSLCertSubject Property (IPWorksMQ_AmazonSNS Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 70 ); ipworksmq_amazonsns_set($res, 70, $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, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLCertEncoded Property (IPWorksMQ_AmazonSNS Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 71 ); ipworksmq_amazonsns_set($res, 71, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLProvider Property (IPWorksMQ_AmazonSNS Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Object Oriented Interface
public function getSSLProvider(); public function setSSLProvider($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 72 ); ipworksmq_amazonsns_set($res, 72, $value );
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEffectiveDate Property (IPWorksMQ_AmazonSNS Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLServerCertEffectiveDate();
Procedural Interface
ipworksmq_amazonsns_get($res, 73 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (IPWorksMQ_AmazonSNS Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLServerCertExpirationDate();
Procedural Interface
ipworksmq_amazonsns_get($res, 74 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (IPWorksMQ_AmazonSNS Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLServerCertExtendedKeyUsage();
Procedural Interface
ipworksmq_amazonsns_get($res, 75 );
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
SSLServerCertFingerprint Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprint();
Procedural Interface
ipworksmq_amazonsns_get($res, 76 );
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
SSLServerCertFingerprintSHA1 Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA1();
Procedural Interface
ipworksmq_amazonsns_get($res, 77 );
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
SSLServerCertFingerprintSHA256 Property (IPWorksMQ_AmazonSNS Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA256();
Procedural Interface
ipworksmq_amazonsns_get($res, 78 );
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
SSLServerCertIssuer Property (IPWorksMQ_AmazonSNS Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLServerCertIssuer();
Procedural Interface
ipworksmq_amazonsns_get($res, 79 );
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
SSLServerCertPrivateKey Property (IPWorksMQ_AmazonSNS Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKey();
Procedural Interface
ipworksmq_amazonsns_get($res, 80 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSNS Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLServerCertPrivateKeyAvailable();
Procedural Interface
ipworksmq_amazonsns_get($res, 81 );
Default Value
false
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (IPWorksMQ_AmazonSNS Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKeyContainer();
Procedural Interface
ipworksmq_amazonsns_get($res, 82 );
Default Value
''
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (IPWorksMQ_AmazonSNS Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLServerCertPublicKey();
Procedural Interface
ipworksmq_amazonsns_get($res, 83 );
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
SSLServerCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSNS Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLServerCertPublicKeyAlgorithm();
Procedural Interface
ipworksmq_amazonsns_get($res, 84 );
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
SSLServerCertPublicKeyLength Property (IPWorksMQ_AmazonSNS Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLServerCertPublicKeyLength();
Procedural Interface
ipworksmq_amazonsns_get($res, 85 );
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
SSLServerCertSerialNumber Property (IPWorksMQ_AmazonSNS Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLServerCertSerialNumber();
Procedural Interface
ipworksmq_amazonsns_get($res, 86 );
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
SSLServerCertSignatureAlgorithm Property (IPWorksMQ_AmazonSNS Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLServerCertSignatureAlgorithm();
Procedural Interface
ipworksmq_amazonsns_get($res, 87 );
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
SSLServerCertStore Property (IPWorksMQ_AmazonSNS Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLServerCertStore();
Procedural Interface
ipworksmq_amazonsns_get($res, 88 );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
This property is read-only.
Data Type
Binary String
SSLServerCertStorePassword Property (IPWorksMQ_AmazonSNS 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 getSSLServerCertStorePassword();
Procedural Interface
ipworksmq_amazonsns_get($res, 89 );
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.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (IPWorksMQ_AmazonSNS Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLServerCertStoreType();
Procedural Interface
ipworksmq_amazonsns_get($res, 90 );
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (IPWorksMQ_AmazonSNS Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLServerCertSubjectAltNames();
Procedural Interface
ipworksmq_amazonsns_get($res, 91 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (IPWorksMQ_AmazonSNS Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintMD5();
Procedural Interface
ipworksmq_amazonsns_get($res, 92 );
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
SSLServerCertThumbprintSHA1 Property (IPWorksMQ_AmazonSNS Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA1();
Procedural Interface
ipworksmq_amazonsns_get($res, 93 );
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
SSLServerCertThumbprintSHA256 Property (IPWorksMQ_AmazonSNS Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA256();
Procedural Interface
ipworksmq_amazonsns_get($res, 94 );
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
SSLServerCertUsage Property (IPWorksMQ_AmazonSNS Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLServerCertUsage();
Procedural Interface
ipworksmq_amazonsns_get($res, 95 );
Default Value
''
Remarks
This property contains the text description of SSLServerCertUsageFlags.
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
SSLServerCertUsageFlags Property (IPWorksMQ_AmazonSNS Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLServerCertUsageFlags();
Procedural Interface
ipworksmq_amazonsns_get($res, 96 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (IPWorksMQ_AmazonSNS Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLServerCertVersion();
Procedural Interface
ipworksmq_amazonsns_get($res, 97 );
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
SSLServerCertSubject Property (IPWorksMQ_AmazonSNS Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLServerCertSubject();
Procedural Interface
ipworksmq_amazonsns_get($res, 98 );
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, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (IPWorksMQ_AmazonSNS Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
ipworksmq_amazonsns_get($res, 99 );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
SubscriptionMarker Property (IPWorksMQ_AmazonSNS Class)
The token identifying the next page of results.
Object Oriented Interface
public function getSubscriptionMarker(); public function setSubscriptionMarker($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 100 ); ipworksmq_amazonsns_set($res, 100, $value );
Default Value
''
Remarks
This token identifies the next set of results to retrieve. This is populated automatically when the results are paged. When the results are not paged, or the last page of results is retrieved, this is automatically set to empty string. See ListSubscriptions for more details.
This property is not available at design time.
Data Type
String
SubscriptionCount Property (IPWorksMQ_AmazonSNS Class)
The number of records in the Subscription arrays.
Object Oriented Interface
public function getSubscriptionCount();
Procedural Interface
ipworksmq_amazonsns_get($res, 101 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- SubscriptionArn
- SubscriptionConfirmationWasAuthenticated
- SubscriptionDeliveryPolicy
- SubscriptionEffectiveDeliveryPolicy
- SubscriptionEndpoint
- SubscriptionHasAttributes
- SubscriptionOwner
- SubscriptionProtocol
- SubscriptionTopicArn
This property is read-only and not available at design time.
Data Type
Integer
SubscriptionConfirmationWasAuthenticated Property (IPWorksMQ_AmazonSNS Class)
This property reports whether or not the subscription was confirmed.
Object Oriented Interface
public function getSubscriptionConfirmationWasAuthenticated($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 102 , $subscriptionindex);
Default Value
false
Remarks
This property reports whether or not the subscription was confirmed.
Note: This property is only applicable after calling GetSubscriptionAttributes.
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SubscriptionDeliveryPolicy Property (IPWorksMQ_AmazonSNS Class)
This property holds the JSON serialization of the subscription's delivery policy.
Object Oriented Interface
public function getSubscriptionDeliveryPolicy($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 103 , $subscriptionindex);
Default Value
''
Remarks
This property holds the JSON serialization of the subscription's delivery policy.
Note: This property is only applicable after calling GetSubscriptionAttributes.
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
String
SubscriptionEffectiveDeliveryPolicy Property (IPWorksMQ_AmazonSNS Class)
This property holds the JSON serialization of the subscription's effective delivery policy.
Object Oriented Interface
public function getSubscriptionEffectiveDeliveryPolicy($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 104 , $subscriptionindex);
Default Value
''
Remarks
This property holds the JSON serialization of the subscription's effective delivery policy. This policy takes into account the topic and account defaults.
Note: This property is only applicable after calling GetSubscriptionAttributes.
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
String
SubscriptionEndpoint Property (IPWorksMQ_AmazonSNS Class)
This property contains the subscription's endpoint.
Object Oriented Interface
public function getSubscriptionEndpoint($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 105 , $subscriptionindex);
Default Value
''
Remarks
This property contains the subscription's endpoint.
The format of the endpoint depends on the protocol used for the subscription. Possible formats are:
A valid e-mail address | for use with the "email" protocol |
A valid e-mail address | for use with the "email-json" protocol |
A URL beginning with "http://" | for use with the "http" protocol |
A URL beginning with "https://" | for use with the "https" protocol |
A phone number (e.g. 19195447070) | for use with the "sms" protocol |
A SQS queue ARN | for use with the "sqs" protocol |
Note: This property is only applicable after calling ListSubscriptions or ListTopicSubscriptions.
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
String
SubscriptionHasAttributes Property (IPWorksMQ_AmazonSNS Class)
This property returns true if the subscription attributes are available.
Object Oriented Interface
public function getSubscriptionHasAttributes($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 106 , $subscriptionindex);
Default Value
false
Remarks
This property returns true if the subscription attributes are available. A subscription's attributes are only returned and parsed after calling GetSubscriptionAttributes. This property serves as an easy way to determine if the subscription's attributes are available.
The following properties are applicable after calling GetSubscriptionAttributes:
- SubscriptionConfirmationWasAuthenticated
- SubscriptionDeliveryPolicy
- SubscriptionEffectiveDeliveryPolicy
- SubscriptionOwner
- SubscriptionArn
- SubscriptionTopicArn
The following properties are applicable after calling ListSubscriptions or ListTopicSubscriptions:
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SubscriptionOwner Property (IPWorksMQ_AmazonSNS Class)
The AWS account ID of the subscription's owner.
Object Oriented Interface
public function getSubscriptionOwner($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 107 , $subscriptionindex);
Default Value
''
Remarks
The AWS account ID of the subscription's owner.
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
String
SubscriptionProtocol Property (IPWorksMQ_AmazonSNS Class)
This property specifies the protocol used by the subscription.
Object Oriented Interface
public function getSubscriptionProtocol($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 108 , $subscriptionindex);
Default Value
0
Remarks
This property specifies the protocol used by the subscription. Possible values are:
0 (email) | message via SMTP |
1 (email-json) | JSON-encoded message via SMTP |
2 (http) | JSON-encoded message via HTTP POST |
3 (https) | JSON-encoded message via HTTPS POST |
4 (sms) | message via SMS |
5 (sqs) | JSON-encoded message to an Amazon SQS queue |
Note: This property is only applicable after calling ListSubscriptions or ListTopicSubscriptions.
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
Integer
SubscriptionArn Property (IPWorksMQ_AmazonSNS Class)
The subscription's Amazon Resource Name (ARN) used to identify the subscription.
Object Oriented Interface
public function getSubscriptionArn($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 109 , $subscriptionindex);
Default Value
''
Remarks
The subscription's Amazon Resource Name (ARN) used to identify the subscription.
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
String
SubscriptionTopicArn Property (IPWorksMQ_AmazonSNS Class)
The Amazon Resource Name (ARN) of the topic this subscription is associated with.
Object Oriented Interface
public function getSubscriptionTopicArn($subscriptionindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 110 , $subscriptionindex);
Default Value
''
Remarks
The Amazon Resource Name (ARN) of the topic this subscription is associated with.
The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.
This property is read-only and not available at design time.
Data Type
String
Timeout Property (IPWorksMQ_AmazonSNS Class)
This property includes the timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 111 ); ipworksmq_amazonsns_set($res, 111, $value );
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
TopicMarker Property (IPWorksMQ_AmazonSNS Class)
The token identifying the next page of results.
Object Oriented Interface
public function getTopicMarker(); public function setTopicMarker($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 112 ); ipworksmq_amazonsns_set($res, 112, $value );
Default Value
''
Remarks
This token identifies the next set of results to retrieve. This is populated automatically when the results are paged. When the results are not paged, or the last page of results is retrieved, this is automatically set to empty string. See ListTopics for more details.
This property is not available at design time.
Data Type
String
TopicCount Property (IPWorksMQ_AmazonSNS Class)
The number of records in the Topic arrays.
Object Oriented Interface
public function getTopicCount();
Procedural Interface
ipworksmq_amazonsns_get($res, 113 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- TopicAccessPolicy
- TopicArn
- TopicDeliveryPolicy
- TopicDisplayName
- TopicEffectiveDeliveryPolicy
- TopicHasAttributes
- TopicOwner
- TopicSubscriptionsConfirmed
- TopicSubscriptionsDeleted
- TopicSubscriptionsPending
This property is read-only and not available at design time.
Data Type
Integer
TopicAccessPolicy Property (IPWorksMQ_AmazonSNS Class)
This property holds the JSON serialized access control policy for the topic.
Object Oriented Interface
public function getTopicAccessPolicy($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 114 , $topicindex);
Default Value
''
Remarks
This property holds the JSON serialized access control policy for the topic.
Note: This property is only applicable after calling GetTopicAttributes.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
String
TopicDeliveryPolicy Property (IPWorksMQ_AmazonSNS Class)
The JSON serialized policy for the topic.
Object Oriented Interface
public function getTopicDeliveryPolicy($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 115 , $topicindex);
Default Value
''
Remarks
The JSON serialized policy for the topic.
Note: This property is only applicable after calling GetTopicAttributes.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
String
TopicDisplayName Property (IPWorksMQ_AmazonSNS Class)
This property holds the name used in the 'From' property for email based endpoints.
Object Oriented Interface
public function getTopicDisplayName($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 116 , $topicindex);
Default Value
''
Remarks
This property holds the name used in the 'From' field for email based endpoints.
Note: This property is only applicable after calling GetTopicAttributes.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
String
TopicEffectiveDeliveryPolicy Property (IPWorksMQ_AmazonSNS Class)
This property holds the JSON serialization of the topic's effective delivery policy.
Object Oriented Interface
public function getTopicEffectiveDeliveryPolicy($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 117 , $topicindex);
Default Value
''
Remarks
This property holds the JSON serialization of the topic's effective delivery policy. This policy takes into account the topic and account defaults.
Note: This property is only applicable after calling GetTopicAttributes.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
String
TopicHasAttributes Property (IPWorksMQ_AmazonSNS Class)
This property returns true if the topic attributes are available.
Object Oriented Interface
public function getTopicHasAttributes($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 118 , $topicindex);
Default Value
false
Remarks
This property returns true if the topic attributes are available. A topic's attributes are only returned and parsed after calling GetTopicAttributes. This property serves as an easy way to determine if the topic's attributes are available.
The following properties are applicable after calling GetTopicAttributes:
- TopicDeliveryPolicy
- TopicDisplayName
- TopicEffectiveDeliveryPolicy
- TopicOwner
- TopicAccessPolicy
- TopicSubscriptionsConfirmed
- TopicSubscriptionsDeleted
- TopicSubscriptionsPending
- TopicArn
The following properties are applicable after calling ListTopics:
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
Boolean
TopicOwner Property (IPWorksMQ_AmazonSNS Class)
The AWS account ID of the topic's owner.
Object Oriented Interface
public function getTopicOwner($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 119 , $topicindex);
Default Value
''
Remarks
The AWS account ID of the topic's owner.
Note: This property is only applicable after calling GetTopicAttributes.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
String
TopicSubscriptionsConfirmed Property (IPWorksMQ_AmazonSNS Class)
The number of confirmed subscriptions to this topic.
Object Oriented Interface
public function getTopicSubscriptionsConfirmed($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 120 , $topicindex);
Default Value
0
Remarks
The number of confirmed subscriptions to this topic.
Note: This property is only applicable after calling GetTopicAttributes.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
Integer
TopicSubscriptionsDeleted Property (IPWorksMQ_AmazonSNS Class)
The number of deleted subscriptions on this topic.
Object Oriented Interface
public function getTopicSubscriptionsDeleted($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 121 , $topicindex);
Default Value
0
Remarks
The number of deleted subscriptions on this topic.
Note: This property is only applicable after calling GetTopicAttributes.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
Integer
TopicSubscriptionsPending Property (IPWorksMQ_AmazonSNS Class)
The number of pending subscriptions on this topic.
Object Oriented Interface
public function getTopicSubscriptionsPending($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 122 , $topicindex);
Default Value
0
Remarks
The number of pending subscriptions on this topic.
Note: This property is only applicable after calling GetTopicAttributes.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
Integer
TopicArn Property (IPWorksMQ_AmazonSNS Class)
The Amazon Resource Name (ARN) of the topic.
Object Oriented Interface
public function getTopicArn($topicindex);
Procedural Interface
ipworksmq_amazonsns_get($res, 123 , $topicindex);
Default Value
''
Remarks
The Amazon Resource Name (ARN) of the topic.
The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.
This property is read-only and not available at design time.
Data Type
String
UseSSL Property (IPWorksMQ_AmazonSNS Class)
Determines if SSL is used when connecting to Amazon.
Object Oriented Interface
public function getUseSSL(); public function setUseSSL($value);
Procedural Interface
ipworksmq_amazonsns_get($res, 124 ); ipworksmq_amazonsns_set($res, 124, $value );
Default Value
false
Remarks
Use this property to specify whether or not the component uses SSL to connect with Amazon SNS servers.
This property is not available at design time.
Data Type
Boolean
AddPermission Method (IPWorksMQ_AmazonSNS Class)
Adds permissions to the topic's access control policy.
Object Oriented Interface
public function doAddPermission($topicarn, $policylabel, $awsaccountids, $actionnames);
Procedural Interface
ipworksmq_amazonsns_do_addpermission($res, $topicarn, $policylabel, $awsaccountids, $actionnames);
Remarks
This method may be used to add a statement to the topic's access control policy.
TopicArn specifies the topic.
PolicyLabel should be set to a unique identifier for the new policy statement.
AWSAccountIds is a comma separated list of AWS account IDs of users who will be granted access to the specified actions. The users must have an AWS account, but do not need to be signed up for the SNS service.
ActionNames is a comma separated list of actions that corresponds to the AWS account IDs specified in AWSAccountIds. Possible values are:
- AddPermission
- CreateTopic
- DeleteTopic
- GetSubscriptionAttributes
- GetTopicAttributes
- ListSubscriptions
- ListSubscriptionsByTopic
- ListTopics
- Publish
- RemovePermission
- SetSubscriptionAttributes
- SetTopicAttributes
- Subscribe
- Unsubscribe
The AWSAccountIds and ActionNames parameters must have the same number of values. The actions correspond to the account IDs and only one action may be set for one account ID at a time. For instance:
component.AddPermission("myTopicArn", "myLabel", "1234567,7654321", "Publish,GetTopicAttributes");
Config Method (IPWorksMQ_AmazonSNS Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksmq_amazonsns_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.
ConfirmSubscription Method (IPWorksMQ_AmazonSNS Class)
Completes the subscription request.
Object Oriented Interface
public function doConfirmSubscription($topicarn, $token);
Procedural Interface
ipworksmq_amazonsns_do_confirmsubscription($res, $topicarn, $token);
Remarks
This method completes the subscription request. After calling the Subscribe method this method must be used to complete the subscription request (if it could not be completed immediately when Subscribe was called).
Set Token to the confirmation token delivered to the endpoint specified in the call to Subscribe. The TopicArn parameter specifies the topic of the subscription.
This method returns the SubscriptionArn which may be used in further subscription related operation. SubscriptionArn may be used with the following methods:
CreateTopic Method (IPWorksMQ_AmazonSNS Class)
Creates a new topic.
Object Oriented Interface
public function doCreateTopic($name);
Procedural Interface
ipworksmq_amazonsns_do_createtopic($res, $name);
Remarks
This method creates a new topic specified by the Name parameter. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
The TopicArn is returned by this method an identifier that is used in other operations on the topic. The TopicArn is required for these methods:
- DeleteTopic
- GetTopicAttributes
- ListTopicSubscriptions
- Publish
- PublishCustom
- RemovePermission
- SetTopicAttributes
- Subscribe
DeleteTopic Method (IPWorksMQ_AmazonSNS Class)
Deletes the specified topic.
Object Oriented Interface
public function doDeleteTopic($topicarn);
Procedural Interface
ipworksmq_amazonsns_do_deletetopic($res, $topicarn);
Remarks
This method deletes the topic specified by the TopicArn parameter. All subscriptions to this topic will also be deleted. If the topic does not exist, no error is returned by Amazon.
DoEvents Method (IPWorksMQ_AmazonSNS Class)
This method processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworksmq_amazonsns_do_doevents($res);
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
GetSubscriptionAttributes Method (IPWorksMQ_AmazonSNS Class)
Retrieves the subscription's attributes.
Object Oriented Interface
public function doGetSubscriptionAttributes($subscriptionarn);
Procedural Interface
ipworksmq_amazonsns_do_getsubscriptionattributes($res, $subscriptionarn);
Remarks
This method retrieves the subscription's attributes. The attributes are available through the Subscriptions collection.
GetTopicAttributes Method (IPWorksMQ_AmazonSNS Class)
Retrieves the topic's attributes.
Object Oriented Interface
public function doGetTopicAttributes($topicarn);
Procedural Interface
ipworksmq_amazonsns_do_gettopicattributes($res, $topicarn);
Remarks
This method topic the subscription's attributes. The topic are available through the Topics collection.
GetXValue Method (IPWorksMQ_AmazonSNS Class)
Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Object Oriented Interface
public function doGetXValue($xpath);
Procedural Interface
ipworksmq_amazonsns_do_getxvalue($res, $xpath);
Remarks
This method allows a user to retrieve a valid XPath expression from the HTTP response after calling SendCustomRequest.
Interrupt Method (IPWorksMQ_AmazonSNS Class)
This method interrupts the current method.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
ipworksmq_amazonsns_do_interrupt($res);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListSubscriptions Method (IPWorksMQ_AmazonSNS Class)
Lists subscriptions for the current account.
Object Oriented Interface
public function doListSubscriptions();
Procedural Interface
ipworksmq_amazonsns_do_listsubscriptions($res);
Remarks
This method lists the subscriptions for the current AWS account.
When calling this method all subscriptions for the current AWS account identified by AccessKey and SecretKey will be listed. The SubscriptionList event will fire once for each subscription and the Subscriptions collection will be populated with information about the subscriptions.
If the results are paged the IsSubscriptionPaged setting will return the value "True" and SubscriptionMarker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and SubscriptionMarker is empty to retrieve all results.
ListTopics Method (IPWorksMQ_AmazonSNS Class)
Lists all topics for the current account.
Object Oriented Interface
public function doListTopics();
Procedural Interface
ipworksmq_amazonsns_do_listtopics($res);
Remarks
This method lists all topics for the AWS account specified by AccessKey and SecretKey.
When this method is called the TopicList event will fire once for each topic and the Topics collection will be populated with information about the topics.
If the results are paged the IsTopicPaged setting will return the value "True" and TopicMarker will be populated. You may continue to call this method until IsTopicPaged returns "False" and TopicMarker is empty to retrieve all results.
ListTopicSubscriptions Method (IPWorksMQ_AmazonSNS Class)
Lists subscriptions to the specified topic.
Object Oriented Interface
public function doListTopicSubscriptions($topicarn);
Procedural Interface
ipworksmq_amazonsns_do_listtopicsubscriptions($res, $topicarn);
Remarks
This method lists the subscriptions to the specified topic.
When calling this method the subscriptions to the topic specified by TopicARN will be listed. The SubscriptionList event will fire once for each subscription and the Subscriptions collection will be populated with information about the subscriptions.
If the results are paged the IsSubscriptionPaged setting will return the value "True" and SubscriptionMarker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and SubscriptionMarker is empty to retrieve all results.
Publish Method (IPWorksMQ_AmazonSNS Class)
Publishes a message to the topic.
Object Oriented Interface
public function doPublish($topicarn, $subject, $message);
Procedural Interface
ipworksmq_amazonsns_do_publish($res, $topicarn, $subject, $message);
Remarks
This method publishes a message to the topic specified by TopicArn.
The Subject parameter is optional and specifies the "Subject" line of the message delivered to e-mail endpoints. Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
The Message parameter is the text to send. Messages must be UTF-8 encoded strings at most 64 KB in size (65536 bytes, not 65536 characters).
The same message will be delivered to all subscribers. To send different messages based on the protocol used by the subscription call PublishCustom instead.
The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.
PublishCustom Method (IPWorksMQ_AmazonSNS Class)
Publishes a message to the topic.
Object Oriented Interface
public function doPublishCustom($topicarn, $subject, $defaultmessage, $emailmessage, $emailjsonmessage, $httpmessage, $httpsmessage, $smsmessage, $sqsmessage);
Procedural Interface
ipworksmq_amazonsns_do_publishcustom($res, $topicarn, $subject, $defaultmessage, $emailmessage, $emailjsonmessage, $httpmessage, $httpsmessage, $smsmessage, $sqsmessage);
Remarks
This method may be used instead of Publish to specify different messages depending on the protocol used by the subscription.
TopicArn specifies the topic.
The Subject parameter is optional and specifies the "Subject" line of the message delivered to e-mail endpoints. Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
DefaultMessage will be used for any protocol that is not specifically assigned a message. If empty string is specified for any other message parameter this value will be used.
EmailMessage, EmailJsonMessage, HttpMessage, HttpsMessage, SmsMessage, and SqsMessage specify messages for the respective protocol. These parameters are all optional. If empty string is specified the DefaultMessage will be used.
The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.
RemovePermission Method (IPWorksMQ_AmazonSNS Class)
Removes permissions from a topic.
Object Oriented Interface
public function doRemovePermission($topicarn, $policylabel);
Procedural Interface
ipworksmq_amazonsns_do_removepermission($res, $topicarn, $policylabel);
Remarks
This method removes permissions specified by the PolicyLabel from the access control policy of the topic specified by TopicArn.
Reset Method (IPWorksMQ_AmazonSNS Class)
Resets request-related properties.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksmq_amazonsns_do_reset($res);
Remarks
Calling this method will reset the component to the original state.
SendCustomRequest Method (IPWorksMQ_AmazonSNS Class)
Allows the sending of a custom request to an Amazon web service.
Object Oriented Interface
public function doSendCustomRequest($url, $requestdata, $otherheaders);
Procedural Interface
ipworksmq_amazonsns_do_sendcustomrequest($res, $url, $requestdata, $otherheaders);
Remarks
Allows the sending of a custom request to the Amazon web service. The URL parameter describes the endpoint that is being targeted. The RequestData is set to any data required for the request. The OtherHeaders parameter is used to set any additional headers that should be set for the request.
SetSubscriptionAttributes Method (IPWorksMQ_AmazonSNS Class)
Sets attributes of the subscription.
Object Oriented Interface
public function doSetSubscriptionAttributes($subscriptionarn, $attributevalue);
Procedural Interface
ipworksmq_amazonsns_do_setsubscriptionattributes($res, $subscriptionarn, $attributevalue);
Remarks
This method is used to set an attribute of the subscription. Currently only the delivery policy may be set.
The SubscriptionArn parameter specifies the Amazon Resource Name (ARN) of the subscription.
The AttributeValue specifies the value to be set. Since the only currently valid attribute is the delivery policy, this is the value of the delivery policy in JSON format, for instance:
{"healthyRetryPolicy": {"minDelayTarget": 1, "maxDelayTarget": 5, "numRetries": 5, "numMaxDelayRetries": 5, "backoffFunction": "linear"}}
SetTopicAttributes Method (IPWorksMQ_AmazonSNS Class)
Sets attributes on the specified topic.
Object Oriented Interface
public function doSetTopicAttributes($topicarn, $attributetype, $attributevalue);
Procedural Interface
ipworksmq_amazonsns_do_settopicattributes($res, $topicarn, $attributetype, $attributevalue);
Remarks
This method may be used to specify attributes on the specified topic.
TopicArn specifies the topic.
AttributeType determines which attribute is set and AttributeValue specifies the value. The following table provides more information:
AttributeType | AttributeValue |
0 (DisplayName) | A human readable name to be used in the "From" field for email based endpoints |
1 (AccessPolicy) | A JSON serialized access policy for the topic |
2 (DeliveryPolicy) | A JSON serialized delivery policy for the topic |
An example access policy is:
{"Version":"2008-10-17","Id":"__default_policy_ID","Statement":[{"Sid":"__default_statement_ID","Effect":"Allow","Principal":{"AWS":"*"},"Action":["SNS:Publish","SNS:RemovePermission","SNS:SetTopicAttributes","SNS:DeleteTopic","SNS:ListSubscriptionsByTopic","SNS:GetTopicAttributes","SNS:Receive","SNS:AddPermission","SNS:Subscribe"],"Resource":"arn:aws:sns:us-east-1:120151960619:TestTopic","Condition":{"StringEquals":{"AWS:SourceOwner":"120151960619"}}},{"Sid":"__console_pub_0","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SNS:Publish","Resource":"arn:aws:sns:us-east-1:120151960619:TestTopic"}]}
An example delivery policy is:
{"http":{"defaultHealthyRetryPolicy": {"minDelayTarget": 1, "maxDelayTarget": 5, "numRetries": 5, "numMaxDelayRetries": 5, "backoffFunction": "linear"}}}
Subscribe Method (IPWorksMQ_AmazonSNS Class)
Request a subscription to the specific topic.
Object Oriented Interface
public function doSubscribe($topicarn, $endpoint, $endpointprotocol);
Procedural Interface
ipworksmq_amazonsns_do_subscribe($res, $topicarn, $endpoint, $endpointprotocol);
Remarks
This method requests a subscription to the topic specified by TopicArn. If the subscription was created immediately without requiring confirmation the SubscriptionArn will be returned by this method. The SubscriptionArn will begin with "arn:aws:sns". SubscriptionArn may be used with the following methods:
If the subscription requires confirmation this method returns the subscription status such as "pending confirmation".
The Endpoint and EndpointProtocol parameters specify how the subscription confirmation message is delivered. Possible values for EndpointProtocol are:
0 (email) | message via SMTP |
1 (email-json) | JSON-encoded message via SMTP |
2 (http) | JSON-encoded message via HTTP POST |
3 (https) | JSON-encoded message via HTTPS POST |
4 (sms) | message via SMS |
5 (sqs) | JSON-encoded message to an Amazon SQS queue |
The Endpoint parameter format depends on the chosen EndpointProtocol. Possible formats are:
A valid e-mail address | for use with the "email" protocol |
A valid e-mail address | for use with the "email-json" protocol |
A URL beginning with "http://" | for use with the "http" protocol |
A URL beginning with "https://" | for use with the "https" protocol |
A phone number (e.g. 19195447070) | for use with the "sms" protocol |
A SQS queue ARN | for use with the "sqs" protocol |
Once the subscription confirmation is received by the endpoint owner the ConfirmSubscription method must be called with the confirmation token to complete the subscription.
Note: Confirmation tokens are valid for 3 days.
Unsubscribe Method (IPWorksMQ_AmazonSNS Class)
Unsubscribes from the topic.
Object Oriented Interface
public function doUnsubscribe($subscriptionarn);
Procedural Interface
ipworksmq_amazonsns_do_unsubscribe($res, $subscriptionarn);
Remarks
This method deletes a subscription to a topic. The subscription is identified by the SubscriptionArn parameter.
If the subscription requires authentication for deletion, only the subscription owner or topic owner can unsubscribe. If authentication is not required a cancellation notice is sent to the endpoint, so that the endpoint owner can re-subscribe if the unsubscribe request was unintentional.
Error Event (IPWorksMQ_AmazonSNS Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksmq_amazonsns_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.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Log Event (IPWorksMQ_AmazonSNS Class)
This event fires once for each log message.
Object Oriented Interface
public function fireLog($param);
Procedural Interface
ipworksmq_amazonsns_register_callback($res, 2, array($this, 'fireLog'));
Parameter List
'loglevel'
'message'
'logtype'
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
SSLServerAuthentication Event (IPWorksMQ_AmazonSNS Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
ipworksmq_amazonsns_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (IPWorksMQ_AmazonSNS Class)
Fired when secure connection progress messages are available.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
ipworksmq_amazonsns_register_callback($res, 4, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
SubscriptionList Event (IPWorksMQ_AmazonSNS Class)
Fires with information about the subscription.
Object Oriented Interface
public function fireSubscriptionList($param);
Procedural Interface
ipworksmq_amazonsns_register_callback($res, 5, array($this, 'fireSubscriptionList'));
Parameter List
'subscriptionarn'
'topicarn'
'owner'
'endpoint'
'protocol'
Remarks
This event fires once for each subscription returned from a call to ListSubscriptions or ListTopicSubscriptions.
SubscriptionArn is the ARN of the subscription.
TopicArn is the ARN of the subscription's topic.
Owner is the subscription's owner.
Protocol is the subscription's protocol. Possible values are:
0 (email) | message via SMTP |
1 (email-json) | JSON-encoded message via SMTP |
2 (http) | JSON-encoded message via HTTP POST |
3 (https) | JSON-encoded message via HTTPS POST |
4 (sms) | message via SMS |
5 (sqs) | JSON-encoded message to an Amazon SQS queue |
Endpoint is the subscription's endpoint. Possible formats are:
A valid e-mail address | for use with the "email" protocol |
A valid e-mail address | for use with the "email-json" protocol |
A URL beginning with "http://" | for use with the "http" protocol |
A URL beginning with "https://" | for use with the "https" protocol |
A phone number (e.g. 19195447070) | for use with the "sms" protocol |
A SQS queue ARN | for use with the "sqs" protocol |
TopicList Event (IPWorksMQ_AmazonSNS Class)
Fires with information about the topic.
Object Oriented Interface
public function fireTopicList($param);
Procedural Interface
ipworksmq_amazonsns_register_callback($res, 6, array($this, 'fireTopicList'));
Parameter List
'topicarn'
Remarks
This event fires once for each topic returned from a call to ListTopics.
TopicARN identifies the current topic.
Config Settings (AmazonSNS 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.SNS Config Settings
Amazon defines each version as the date it was released. An example is: "2009-07-15".
Possible values are:
- 0 (string - default)
- 1 (number)
- 2 (binary)
Valid array indices are from 0 to MessageAttributeCount - 1.
Valid array indices are from 0 to MessageAttributeCount - 1.
Valid array indices are from 0 to MessageAttributeCount - 1.
sns1.Config("PhoneNumber=+19191234567");
sns1.Publish("","","message");
sns1.Config("TargetArn=myArn");
sns1.Publish("","subject","message");
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Trappable Errors (AmazonSNS Class)
SNS Errors
601 | An error was returned from the server. Please refer to the error message for additional information. |
602 | The cryptographic operation failed. Please see the error message for additional information. |
603 | Invalid Topic index. |
604 | Invalid Subscription index. |
605 | Invalid topic attribute type. |
606 | Invalid subscription attribute type. |
607 | Invalid subscription protocol value. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
118 | Firewall Error. Error description contains detailed message. |
143 | Busy executing current method. |
151 | HTTP protocol error. The error message has the server response. |
152 | No server specified in URL |
153 | Specified URLScheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Can't open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |