SOAP Class
Properties Methods Events Config Settings Errors
The SOAP Class is a generic SOAP client supporting SOAP 1.1 that is used to communicate with SOAP servers.
Syntax
SOAP
Remarks
The SOAP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.
The SOAP Class implements a standard SOAP client as specified in the SOAP 1.1 specification.
The class uses HTTP to communicate with SOAP servers and uses an internal XML parser to process the results. The SOAP requests are specified by first setting the SOAP Method and MethodURI, as well as optional parameters in the Params properties. Then set the target URL and call the SendRequest method.
The results will be provided through the ReturnValue property and the Params properties (for output parameters). Additionally, properties such as XPath, XElement, and XText allow for more granular traversal of the SOAP response.
If the server returns an error, the FaultCode, FaultString, and FaultActor properties will provide information about the error condition.
The class may also be used in offline mode. This is supported by methods such as BuildPacket and EvalPacket. The corresponding SOAP packet will be stored in the SOAPPacket property. Offline mode is important in cases in which the underlying SOAP transport is not HTTP but another mechanism (e.g., SMTP and POP for email).
By providing direct access to the SOAP packet in offline mode, the class allows for possible extension and full control over the SOAPPacket. The SendPacket method may then be used to send the custom-created SOAPPacket to the destination URL.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Accept | This property includes a list of acceptable MIME types for the request. |
ActionURI | This property includes the value of the SOAP-action header. |
Authorization | This property includes the Authorization string to be sent to the server. |
AuthScheme | This property specifies the authentication scheme to use when server authentication is required. |
Connected | This property shows whether the class is connected. |
ContentType | This property includes the content type for SOAP request data. |
Cookies | This property includes a collection of cookies. |
FaultActor | This property includes the actor of any faults returned by the SOAP server. |
FaultCode | This property includes the code of any faults returned by the SOAP server. |
FaultString | This property includes the textual description of any faults returned by the SOAP server. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | This property determines what happens when the server issues a redirect. |
Idle | This property specifies the current status of the class. |
IfModifiedSince | This property includes a date determining the maximum age of the desired document. |
LocalFile | This property includes the path to a local file for downloading. If the file exists, it is overwritten. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Method | This property includes the remote Method . |
MethodURI | This property includes the URI corresponding to the SOAP Method . |
Namespaces | This property includes a collection of namespaces in the current stack. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Params | This property includes a collection of parameters for the SOAP Method . |
ParsedHeaders | This property includes a collection of headers returned from the last request. |
Password | This property includes a password if authentication is to be used. |
Pragma | This property includes a browser- or server-specific header line (optional). |
Proxy | A set of properties related to proxy access. |
Referer | This property includes the referer URL/document (optional). |
ReturnValue | This property includes the value returned by the SOAP Method . |
SOAPEncoding | This property includes the type of SOAP encoding used for SOAP requests. |
SOAPHeader | This property includes the contents of the optional SOAP header sent to the server. |
SOAPPacket | This property includes the full contents of the SOAP packet. |
SSLAcceptServerCert | This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
StatusLine | This property is the first line of the last server response. |
Timeout | This property includes the timeout for the class. |
TransferredData | This property includes the contents of the last response from the server. |
TransferredDataLimit | This property specifies the maximum amount of data to be transferred. |
TransferredHeaders | This property includes the full set of headers as received from the server. |
URL | This property specifies the URL to retrieve. |
User | This property includes a user name if authentication is to be used. |
ValueFormat | This property includes the format of data returned or set. |
XAttributes | This property includes a collection of attributes of the current element. |
XChildren | This property includes the collection of child elements for the current element. |
XElement | This property includes the name of the element pointed to by XPath . |
XNamespace | This property includes the namespace of the element pointed to by XPath . |
XParent | This property includes the parent of the element pointed to by XPath . |
XPath | This property includes a path into the SOAPPacket received by the server. |
XPrefix | This property includes the prefix of the element pointed to by XPath . |
XText | This property includes the text of the element pointed to by XPath . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddCookie | This method adds a cookie and the corresponding value to the outgoing request headers. |
AddNamespace | This method adds a namespace to the Namespaces properties. |
AddParam | This method adds a parameter-value pair. |
Attr | This method returns the value of the specified attribute. |
BuildPacket | This method builds the request packet. |
Config | Sets or retrieves a configuration setting. |
DoEvents | This method processes events from the internal message queue. |
EvalPacket | This method evaluates the packet in SOAPPacket . |
HasXPath | This method determines whether a specific element exists in the document. |
Interrupt | This method interrupts the current method. |
Reset | This method resets the class. |
SendPacket | This method sends the packet. |
SendRequest | This method sends the request. |
TryXPath | This method navigates to the specified XPath if it exists. |
Value | This method returns the value of a parameter. |
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.
Connected | This event is fired immediately after a connection completes (or fails). |
ConnectionStatus | This event is fired to indicate changes in the connection state. |
Disconnected | This event is fired when a connection is closed. |
EndTransfer | This event is fired when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
Log | This event fires once for each log message. |
Redirect | This event is fired when a redirection is received from the server. |
SetCookie | This event is fired for every cookie set by the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when a document starts transferring (after the headers). |
Status | This event is fired when the HTTP status line is received from the server. |
Transfer | This event is fired while the response transfers. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
EncodingStyleNamespacePrefix | The prefix to be used for the Encoding namespace. |
MethodAttributes | The attributes to include in the method element. |
MethodNamespacePrefix | The prefix to be used for the Method namespace. |
RequestPacket | The SOAP packet that was sent to the server during the last request. |
XSubTree | A snapshot of the current element in the document. |
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. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
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 certificate to be included when performing an SSL handshake. |
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. |
CacheContent | If true, the original XML is saved in a buffer. |
Charset | Specifies the charset used when encoding data. |
EOL | The characters to use for separating lines. |
ErrorOnEmptyAttr | If true, passing an invalid attribute to the Attr method will throw an exception. |
ExtraNameChars | Extra characters for the parser to consider as name characters. |
ExtraSpaceChars | Extra characters for the parser to consider as white space. |
FlushOnEOL | If set, the parser flushes its text buffer after every line of text. |
IgnoreBadAttributePrefixes | If true, bad (unknown) attribute prefixes are ignored. |
IgnoreBadElementPrefixes | If true, bad (unknown) element prefixes are ignored. |
IncludeElementPrefix | Whether to include the prefix in the element name. |
IncludeXMLDeclaration | Whether to include the XML declaration when writing XML. |
Indent | The characters to use for each indentation level. |
Offset | Current offset of the document being parsed. |
PreserveWhitespace | If true, leading and trailing whitespace in element text is preserved. |
QuoteChar | Quote character to use for attribute values. |
StringProcessingOptions | Defines options to use when processing string values. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Accept Property (SOAP Class)
This property includes a list of acceptable MIME types for the request.
Syntax
ANSI (Cross Platform) char* GetAccept();
int SetAccept(const char* lpszAccept); Unicode (Windows) LPWSTR GetAccept();
INT SetAccept(LPCWSTR lpszAccept);
char* ipworksssl_soap_getaccept(void* lpObj);
int ipworksssl_soap_setaccept(void* lpObj, const char* lpszAccept);
QString GetAccept();
int SetAccept(QString qsAccept);
Default Value
""
Remarks
If this property contains a nonempty string, an HTTP Accept header is added to the request.
The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.
Data Type
String
ActionURI Property (SOAP Class)
This property includes the value of the SOAP-action header.
Syntax
ANSI (Cross Platform) char* GetActionURI();
int SetActionURI(const char* lpszActionURI); Unicode (Windows) LPWSTR GetActionURI();
INT SetActionURI(LPCWSTR lpszActionURI);
char* ipworksssl_soap_getactionuri(void* lpObj);
int ipworksssl_soap_setactionuri(void* lpObj, const char* lpszActionURI);
QString GetActionURI();
int SetActionURI(QString qsActionURI);
Default Value
""
Remarks
When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.
Data Type
String
Authorization Property (SOAP Class)
This property includes the Authorization string to be sent to the server.
Syntax
ANSI (Cross Platform) char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization); Unicode (Windows) LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);
char* ipworksssl_soap_getauthorization(void* lpObj);
int ipworksssl_soap_setauthorization(void* lpObj, const char* lpszAuthorization);
QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);
Default Value
""
Remarks
If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.
A common use for this property is to specify OAuth authorization string.
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]".
Data Type
String
AuthScheme Property (SOAP Class)
This property specifies the authentication scheme to use when server authentication is required.
Syntax
ANSI (Cross Platform) int GetAuthScheme();
int SetAuthScheme(int iAuthScheme); Unicode (Windows) INT GetAuthScheme();
INT SetAuthScheme(INT iAuthScheme);
Possible Values
AUTH_BASIC(0),
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5),
AUTH_OAUTH(6)
int ipworksssl_soap_getauthscheme(void* lpObj);
int ipworksssl_soap_setauthscheme(void* lpObj, int iAuthScheme);
int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);
Default Value
0
Remarks
This property will tell the class which type of authorization to perform when the User and Password properties are set.
This property should be set to authNone (3) when no authentication is to be performed.
By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.
If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.
Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.
For security, changing the value of this property will cause the class to clear the values of User, Password, and Authorization.
Data Type
Integer
Connected Property (SOAP Class)
This property shows whether the class is connected.
Syntax
ANSI (Cross Platform) int GetConnected(); Unicode (Windows) BOOL GetConnected();
int ipworksssl_soap_getconnected(void* lpObj);
bool GetConnected();
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
Data Type
Boolean
ContentType Property (SOAP Class)
This property includes the content type for SOAP request data.
Syntax
ANSI (Cross Platform) char* GetContentType();
int SetContentType(const char* lpszContentType); Unicode (Windows) LPWSTR GetContentType();
INT SetContentType(LPCWSTR lpszContentType);
char* ipworksssl_soap_getcontenttype(void* lpObj);
int ipworksssl_soap_setcontenttype(void* lpObj, const char* lpszContentType);
QString GetContentType();
int SetContentType(QString qsContentType);
Default Value
"text/xml"
Remarks
The default value for ContentType is "text/xml".
This property is not available at design time.
Data Type
String
Cookies Property (SOAP Class)
This property includes a collection of cookies.
Syntax
IPWorksSSLList<IPWorksSSLHTTPCookie>* GetCookies(); int SetCookies(IPWorksSSLList<IPWorksSSLHTTPCookie>* val);
int ipworksssl_soap_getcookiecount(void* lpObj);
int ipworksssl_soap_setcookiecount(void* lpObj, int iCookieCount);
char* ipworksssl_soap_getcookiedomain(void* lpObj, int cookieindex);
char* ipworksssl_soap_getcookieexpiration(void* lpObj, int cookieindex);
char* ipworksssl_soap_getcookiename(void* lpObj, int cookieindex);
int ipworksssl_soap_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);
char* ipworksssl_soap_getcookiepath(void* lpObj, int cookieindex);
int ipworksssl_soap_getcookiesecure(void* lpObj, int cookieindex);
char* ipworksssl_soap_getcookievalue(void* lpObj, int cookieindex);
int ipworksssl_soap_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);
int GetCookieCount();
int SetCookieCount(int iCookieCount); QString GetCookieDomain(int iCookieIndex); QString GetCookieExpiration(int iCookieIndex); QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName); QString GetCookiePath(int iCookieIndex); bool GetCookieSecure(int iCookieIndex); QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);
Remarks
This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.
To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.
MaxHTTPCookies can be used to control the maximum number of cookies saved.
This property is not available at design time.
Data Type
FaultActor Property (SOAP Class)
This property includes the actor of any faults returned by the SOAP server.
Syntax
ANSI (Cross Platform) char* GetFaultActor(); Unicode (Windows) LPWSTR GetFaultActor();
char* ipworksssl_soap_getfaultactor(void* lpObj);
QString GetFaultActor();
Default Value
""
Remarks
FaultCode and FaultString provide the corresponding fault code and description.
This property is read-only.
Data Type
String
FaultCode Property (SOAP Class)
This property includes the code of any faults returned by the SOAP server.
Syntax
ANSI (Cross Platform) char* GetFaultCode(); Unicode (Windows) LPWSTR GetFaultCode();
char* ipworksssl_soap_getfaultcode(void* lpObj);
QString GetFaultCode();
Default Value
""
Remarks
FaultString and FaultActor provide the corresponding fault description and actor.
This property is read-only.
Data Type
String
FaultString Property (SOAP Class)
This property includes the textual description of any faults returned by the SOAP server.
Syntax
ANSI (Cross Platform) char* GetFaultString(); Unicode (Windows) LPWSTR GetFaultString();
char* ipworksssl_soap_getfaultstring(void* lpObj);
QString GetFaultString();
Default Value
""
Remarks
FaultCode and FaultActor provide the corresponding fault code and actor.
This property is read-only.
Data Type
String
Firewall Property (SOAP Class)
A set of properties related to firewall access.
Syntax
IPWorksSSLFirewall* GetFirewall(); int SetFirewall(IPWorksSSLFirewall* val);
int ipworksssl_soap_getfirewallautodetect(void* lpObj);
int ipworksssl_soap_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
int ipworksssl_soap_getfirewalltype(void* lpObj);
int ipworksssl_soap_setfirewalltype(void* lpObj, int iFirewallType);
char* ipworksssl_soap_getfirewallhost(void* lpObj);
int ipworksssl_soap_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
char* ipworksssl_soap_getfirewallpassword(void* lpObj);
int ipworksssl_soap_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
int ipworksssl_soap_getfirewallport(void* lpObj);
int ipworksssl_soap_setfirewallport(void* lpObj, int iFirewallPort);
char* ipworksssl_soap_getfirewalluser(void* lpObj);
int ipworksssl_soap_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect); int GetFirewallType();
int SetFirewallType(int iFirewallType); QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost); QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword); int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Data Type
FollowRedirects Property (SOAP Class)
This property determines what happens when the server issues a redirect.
Syntax
ANSI (Cross Platform) int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects); Unicode (Windows) INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);
Possible Values
FR_NEVER(0),
FR_ALWAYS(1),
FR_SAME_SCHEME(2)
int ipworksssl_soap_getfollowredirects(void* lpObj);
int ipworksssl_soap_setfollowredirects(void* lpObj, int iFollowRedirects);
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);
Default Value
0
Remarks
This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.
If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this property is set to frAlways (1), 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. If, however, this property is set to frAlways (1), 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 frNever (0). In this case, redirects are never followed, and the class fails with an error instead.
Data Type
Integer
Idle Property (SOAP Class)
This property specifies the current status of the class.
Syntax
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
int ipworksssl_soap_getidle(void* lpObj);
bool GetIdle();
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
IfModifiedSince Property (SOAP Class)
This property includes a date determining the maximum age of the desired document.
Syntax
ANSI (Cross Platform) char* GetIfModifiedSince();
int SetIfModifiedSince(const char* lpszIfModifiedSince); Unicode (Windows) LPWSTR GetIfModifiedSince();
INT SetIfModifiedSince(LPCWSTR lpszIfModifiedSince);
char* ipworksssl_soap_getifmodifiedsince(void* lpObj);
int ipworksssl_soap_setifmodifiedsince(void* lpObj, const char* lpszIfModifiedSince);
QString GetIfModifiedSince();
int SetIfModifiedSince(QString qsIfModifiedSince);
Default Value
""
Remarks
If this property contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the class fails with an error
The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.
This property is not available at design time.
Data Type
String
LocalFile Property (SOAP Class)
This property includes the path to a local file for downloading. If the file exists, it is overwritten.
Syntax
ANSI (Cross Platform) char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only Unicode (Windows) LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);
char* ipworksssl_soap_getlocalfile(void* lpObj);
wchar_t* ipworksssl_soap_getlocalfile_W(void* lpObj); // Windows only
int ipworksssl_soap_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworksssl_soap_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only
QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);
Default Value
""
Remarks
This property is used when getting a document.
If this property is empty, then the received data are provided through TransferredData and the Transfer event.
Data Type
String
LocalHost Property (SOAP Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworksssl_soap_getlocalhost(void* lpObj);
int ipworksssl_soap_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
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
Method Property (SOAP Class)
This property includes the remote Method .
Syntax
ANSI (Cross Platform) char* GetMethod();
int SetMethod(const char* lpszMethod); Unicode (Windows) LPWSTR GetMethod();
INT SetMethod(LPCWSTR lpszMethod);
char* ipworksssl_soap_getmethod(void* lpObj);
int ipworksssl_soap_setmethod(void* lpObj, const char* lpszMethod);
QString GetMethod();
int SetMethod(QString qsMethod);
Default Value
""
Remarks
When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.
Data Type
String
MethodURI Property (SOAP Class)
This property includes the URI corresponding to the SOAP Method .
Syntax
ANSI (Cross Platform) char* GetMethodURI();
int SetMethodURI(const char* lpszMethodURI); Unicode (Windows) LPWSTR GetMethodURI();
INT SetMethodURI(LPCWSTR lpszMethodURI);
char* ipworksssl_soap_getmethoduri(void* lpObj);
int ipworksssl_soap_setmethoduri(void* lpObj, const char* lpszMethodURI);
QString GetMethodURI();
int SetMethodURI(QString qsMethodURI);
Default Value
""
Remarks
When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.
Data Type
String
Namespaces Property (SOAP Class)
This property includes a collection of namespaces in the current stack.
Syntax
IPWorksSSLList<IPWorksSSLXMLNamespace>* GetNamespaces(); int SetNamespaces(IPWorksSSLList<IPWorksSSLXMLNamespace>* val);
int ipworksssl_soap_getnamespacecount(void* lpObj);
int ipworksssl_soap_setnamespacecount(void* lpObj, int iNamespaceCount);
char* ipworksssl_soap_getnamespaceprefix(void* lpObj, int namespaceindex);
int ipworksssl_soap_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);
char* ipworksssl_soap_getnamespaceuri(void* lpObj, int namespaceindex);
int ipworksssl_soap_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);
int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount); QString GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, QString qsNamespacePrefix); QString GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, QString qsNamespaceURI);
Remarks
This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.
If the SOAP envelope URI is not found in the namespaces collection, it will be added with the prefix SOAP-ENV when generating a SOAP request. The SOAP envelope URI is 'http://schemas.xmlsoap.org/soap/envelope/'.
This property is not available at design time.
Data Type
OtherHeaders Property (SOAP Class)
This property includes other headers as determined by the user (optional).
Syntax
ANSI (Cross Platform) char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
char* ipworksssl_soap_getotherheaders(void* lpObj);
int ipworksssl_soap_setotherheaders(void* lpObj, const char* lpszOtherHeaders);
QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
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 property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the class beyond what is provided.
This property is not available at design time.
Data Type
String
Params Property (SOAP Class)
This property includes a collection of parameters for the SOAP Method .
Syntax
IPWorksSSLList<IPWorksSSLSOAPParam>* GetParams(); int SetParams(IPWorksSSLList<IPWorksSSLSOAPParam>* val);
int ipworksssl_soap_getparamcount(void* lpObj);
int ipworksssl_soap_setparamcount(void* lpObj, int iParamCount);
char* ipworksssl_soap_getparamattrs(void* lpObj, int paramindex);
int ipworksssl_soap_setparamattrs(void* lpObj, int paramindex, const char* lpszParamAttrs);
char* ipworksssl_soap_getparamname(void* lpObj, int paramindex);
int ipworksssl_soap_setparamname(void* lpObj, int paramindex, const char* lpszParamName);
char* ipworksssl_soap_getparamvalue(void* lpObj, int paramindex);
int ipworksssl_soap_setparamvalue(void* lpObj, int paramindex, const char* lpszParamValue);
int GetParamCount();
int SetParamCount(int iParamCount); QString GetParamAttrs(int iParamIndex);
int SetParamAttrs(int iParamIndex, QString qsParamAttrs); QString GetParamName(int iParamIndex);
int SetParamName(int iParamIndex, QString qsParamName); QString GetParamValue(int iParamIndex);
int SetParamValue(int iParamIndex, QString qsParamValue);
Remarks
When using SendRequest, this property can be populated with the parameters to include in the request to the SOAP Method.
When receiving SOAP responses from the server, the component parses the response envelope parameters into the collection.
This property is not available at design time.
Data Type
ParsedHeaders Property (SOAP Class)
This property includes a collection of headers returned from the last request.
Syntax
IPWorksSSLList<IPWorksSSLHeader>* GetParsedHeaders();
int ipworksssl_soap_getparsedheadercount(void* lpObj);
char* ipworksssl_soap_getparsedheaderfield(void* lpObj, int parsedheaderindex);
char* ipworksssl_soap_getparsedheadervalue(void* lpObj, int parsedheaderindex);
int GetParsedHeaderCount(); QString GetParsedHeaderField(int iParsedHeaderIndex); QString GetParsedHeaderValue(int iParsedHeaderIndex);
Remarks
This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.
MaxHeaders can be used to control the maximum number of headers saved.
This property is read-only and not available at design time.
Data Type
Password Property (SOAP Class)
This property includes a password if authentication is to be used.
Syntax
ANSI (Cross Platform) char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* ipworksssl_soap_getpassword(void* lpObj);
int ipworksssl_soap_setpassword(void* lpObj, const char* lpszPassword);
QString GetPassword();
int SetPassword(QString qsPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".
If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.
If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.
Data Type
String
Pragma Property (SOAP Class)
This property includes a browser- or server-specific header line (optional).
Syntax
ANSI (Cross Platform) char* GetPragma();
int SetPragma(const char* lpszPragma); Unicode (Windows) LPWSTR GetPragma();
INT SetPragma(LPCWSTR lpszPragma);
char* ipworksssl_soap_getpragma(void* lpObj);
int ipworksssl_soap_setpragma(void* lpObj, const char* lpszPragma);
QString GetPragma();
int SetPragma(QString qsPragma);
Default Value
""
Remarks
If this property contains a nonempty string, a Pragma HTTP request header is added to the request. The meaning of the header depends on the implementation. It can be used to send or receive proprietary information to or from the server.
This property is not available at design time.
Data Type
String
Proxy Property (SOAP Class)
A set of properties related to proxy access.
Syntax
IPWorksSSLProxy* GetProxy(); int SetProxy(IPWorksSSLProxy* val);
int ipworksssl_soap_getproxyauthscheme(void* lpObj);
int ipworksssl_soap_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int ipworksssl_soap_getproxyautodetect(void* lpObj);
int ipworksssl_soap_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
char* ipworksssl_soap_getproxypassword(void* lpObj);
int ipworksssl_soap_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int ipworksssl_soap_getproxyport(void* lpObj);
int ipworksssl_soap_setproxyport(void* lpObj, int iProxyPort);
char* ipworksssl_soap_getproxyserver(void* lpObj);
int ipworksssl_soap_setproxyserver(void* lpObj, const char* lpszProxyServer);
int ipworksssl_soap_getproxyssl(void* lpObj);
int ipworksssl_soap_setproxyssl(void* lpObj, int iProxySSL);
char* ipworksssl_soap_getproxyuser(void* lpObj);
int ipworksssl_soap_setproxyuser(void* lpObj, const char* lpszProxyUser);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); QString GetProxyServer();
int SetProxyServer(QString qsProxyServer); int GetProxySSL();
int SetProxySSL(int iProxySSL); QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
Data Type
Referer Property (SOAP Class)
This property includes the referer URL/document (optional).
Syntax
ANSI (Cross Platform) char* GetReferer();
int SetReferer(const char* lpszReferer); Unicode (Windows) LPWSTR GetReferer();
INT SetReferer(LPCWSTR lpszReferer);
char* ipworksssl_soap_getreferer(void* lpObj);
int ipworksssl_soap_setreferer(void* lpObj, const char* lpszReferer);
QString GetReferer();
int SetReferer(QString qsReferer);
Default Value
""
Remarks
If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.
This property is not available at design time.
Data Type
String
ReturnValue Property (SOAP Class)
This property includes the value returned by the SOAP Method .
Syntax
ANSI (Cross Platform) char* GetReturnValue(); Unicode (Windows) LPWSTR GetReturnValue();
char* ipworksssl_soap_getreturnvalue(void* lpObj);
QString GetReturnValue();
Default Value
""
Remarks
ReturnValue corresponds to the first item in the Params properties.
This property is read-only.
Data Type
String
SOAPEncoding Property (SOAP Class)
This property includes the type of SOAP encoding used for SOAP requests.
Syntax
ANSI (Cross Platform) char* GetSOAPEncoding();
int SetSOAPEncoding(const char* lpszSOAPEncoding); Unicode (Windows) LPWSTR GetSOAPEncoding();
INT SetSOAPEncoding(LPCWSTR lpszSOAPEncoding);
char* ipworksssl_soap_getsoapencoding(void* lpObj);
int ipworksssl_soap_setsoapencoding(void* lpObj, const char* lpszSOAPEncoding);
QString GetSOAPEncoding();
int SetSOAPEncoding(QString qsSOAPEncoding);
Default Value
"http://schemas.xmlsoap.org/soap/encoding/"
Remarks
This is the value of the encodingStyle attribute of the SOAP envelope.
Data Type
String
SOAPHeader Property (SOAP Class)
This property includes the contents of the optional SOAP header sent to the server.
Syntax
ANSI (Cross Platform) char* GetSOAPHeader();
int SetSOAPHeader(const char* lpszSOAPHeader); Unicode (Windows) LPWSTR GetSOAPHeader();
INT SetSOAPHeader(LPCWSTR lpszSOAPHeader);
char* ipworksssl_soap_getsoapheader(void* lpObj);
int ipworksssl_soap_setsoapheader(void* lpObj, const char* lpszSOAPHeader);
QString GetSOAPHeader();
int SetSOAPHeader(QString qsSOAPHeader);
Default Value
""
Remarks
This property is used only when building SOAP requests.
This property is not available at design time.
Data Type
String
SOAPPacket Property (SOAP Class)
This property includes the full contents of the SOAP packet.
Syntax
ANSI (Cross Platform) char* GetSOAPPacket();
int SetSOAPPacket(const char* lpszSOAPPacket); Unicode (Windows) LPWSTR GetSOAPPacket();
INT SetSOAPPacket(LPCWSTR lpszSOAPPacket);
char* ipworksssl_soap_getsoappacket(void* lpObj);
int ipworksssl_soap_setsoappacket(void* lpObj, const char* lpszSOAPPacket);
QString GetSOAPPacket();
int SetSOAPPacket(QString qsSOAPPacket);
Default Value
""
Remarks
The SOAPPacket property contains the contents of the SOAP packet created by the component before submitting a request as well as the full, unmodified contents of the SOAP response as received from the server after the request.
This property is not available at design time.
Data Type
String
SSLAcceptServerCert Property (SOAP Class)
This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
IPWorksSSLCertificate* GetSSLAcceptServerCert(); int SetSSLAcceptServerCert(IPWorksSSLCertificate* val);
char* ipworksssl_soap_getsslacceptservercerteffectivedate(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertexpirationdate(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertextendedkeyusage(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertfingerprint(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertfingerprintsha1(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertfingerprintsha256(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertissuer(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertprivatekey(void* lpObj);
int ipworksssl_soap_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertpublickey(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int ipworksssl_soap_getsslacceptservercertpublickeylength(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertserialnumber(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertsignaturealgorithm(void* lpObj);
int ipworksssl_soap_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksssl_soap_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* ipworksssl_soap_getsslacceptservercertstorepassword(void* lpObj);
int ipworksssl_soap_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int ipworksssl_soap_getsslacceptservercertstoretype(void* lpObj);
int ipworksssl_soap_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* ipworksssl_soap_getsslacceptservercertsubjectaltnames(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertthumbprintmd5(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertthumbprintsha1(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertthumbprintsha256(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertusage(void* lpObj);
int ipworksssl_soap_getsslacceptservercertusageflags(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertversion(void* lpObj);
char* ipworksssl_soap_getsslacceptservercertsubject(void* lpObj);
int ipworksssl_soap_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int ipworksssl_soap_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksssl_soap_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QString GetSSLAcceptServerCertEffectiveDate(); QString GetSSLAcceptServerCertExpirationDate(); QString GetSSLAcceptServerCertExtendedKeyUsage(); QString GetSSLAcceptServerCertFingerprint(); QString GetSSLAcceptServerCertFingerprintSHA1(); QString GetSSLAcceptServerCertFingerprintSHA256(); QString GetSSLAcceptServerCertIssuer(); QString GetSSLAcceptServerCertPrivateKey(); bool GetSSLAcceptServerCertPrivateKeyAvailable(); QString GetSSLAcceptServerCertPrivateKeyContainer(); QString GetSSLAcceptServerCertPublicKey(); QString GetSSLAcceptServerCertPublicKeyAlgorithm(); int GetSSLAcceptServerCertPublicKeyLength(); QString GetSSLAcceptServerCertSerialNumber(); QString GetSSLAcceptServerCertSignatureAlgorithm(); QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore); QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword); int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType); QString GetSSLAcceptServerCertSubjectAltNames(); QString GetSSLAcceptServerCertThumbprintMD5(); QString GetSSLAcceptServerCertThumbprintSHA1(); QString GetSSLAcceptServerCertThumbprintSHA256(); QString GetSSLAcceptServerCertUsage(); int GetSSLAcceptServerCertUsageFlags(); QString GetSSLAcceptServerCertVersion(); QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject); QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Data Type
SSLCert Property (SOAP Class)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
IPWorksSSLCertificate* GetSSLCert(); int SetSSLCert(IPWorksSSLCertificate* val);
char* ipworksssl_soap_getsslcerteffectivedate(void* lpObj);
char* ipworksssl_soap_getsslcertexpirationdate(void* lpObj);
char* ipworksssl_soap_getsslcertextendedkeyusage(void* lpObj);
char* ipworksssl_soap_getsslcertfingerprint(void* lpObj);
char* ipworksssl_soap_getsslcertfingerprintsha1(void* lpObj);
char* ipworksssl_soap_getsslcertfingerprintsha256(void* lpObj);
char* ipworksssl_soap_getsslcertissuer(void* lpObj);
char* ipworksssl_soap_getsslcertprivatekey(void* lpObj);
int ipworksssl_soap_getsslcertprivatekeyavailable(void* lpObj);
char* ipworksssl_soap_getsslcertprivatekeycontainer(void* lpObj);
char* ipworksssl_soap_getsslcertpublickey(void* lpObj);
char* ipworksssl_soap_getsslcertpublickeyalgorithm(void* lpObj);
int ipworksssl_soap_getsslcertpublickeylength(void* lpObj);
char* ipworksssl_soap_getsslcertserialnumber(void* lpObj);
char* ipworksssl_soap_getsslcertsignaturealgorithm(void* lpObj);
int ipworksssl_soap_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksssl_soap_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* ipworksssl_soap_getsslcertstorepassword(void* lpObj);
int ipworksssl_soap_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int ipworksssl_soap_getsslcertstoretype(void* lpObj);
int ipworksssl_soap_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* ipworksssl_soap_getsslcertsubjectaltnames(void* lpObj);
char* ipworksssl_soap_getsslcertthumbprintmd5(void* lpObj);
char* ipworksssl_soap_getsslcertthumbprintsha1(void* lpObj);
char* ipworksssl_soap_getsslcertthumbprintsha256(void* lpObj);
char* ipworksssl_soap_getsslcertusage(void* lpObj);
int ipworksssl_soap_getsslcertusageflags(void* lpObj);
char* ipworksssl_soap_getsslcertversion(void* lpObj);
char* ipworksssl_soap_getsslcertsubject(void* lpObj);
int ipworksssl_soap_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int ipworksssl_soap_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksssl_soap_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QString GetSSLCertEffectiveDate(); QString GetSSLCertExpirationDate(); QString GetSSLCertExtendedKeyUsage(); QString GetSSLCertFingerprint(); QString GetSSLCertFingerprintSHA1(); QString GetSSLCertFingerprintSHA256(); QString GetSSLCertIssuer(); QString GetSSLCertPrivateKey(); bool GetSSLCertPrivateKeyAvailable(); QString GetSSLCertPrivateKeyContainer(); QString GetSSLCertPublicKey(); QString GetSSLCertPublicKeyAlgorithm(); int GetSSLCertPublicKeyLength(); QString GetSSLCertSerialNumber(); QString GetSSLCertSignatureAlgorithm(); QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore); QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword); int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); QString GetSSLCertSubjectAltNames(); QString GetSSLCertThumbprintMD5(); QString GetSSLCertThumbprintSHA1(); QString GetSSLCertThumbprintSHA256(); QString GetSSLCertUsage(); int GetSSLCertUsageFlags(); QString GetSSLCertVersion(); QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject); QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Data Type
SSLProvider Property (SOAP Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworksssl_soap_getsslprovider(void* lpObj);
int ipworksssl_soap_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
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
SSLServerCert Property (SOAP Class)
This property includes the server certificate for the last established connection.
Syntax
IPWorksSSLCertificate* GetSSLServerCert();
char* ipworksssl_soap_getsslservercerteffectivedate(void* lpObj);
char* ipworksssl_soap_getsslservercertexpirationdate(void* lpObj);
char* ipworksssl_soap_getsslservercertextendedkeyusage(void* lpObj);
char* ipworksssl_soap_getsslservercertfingerprint(void* lpObj);
char* ipworksssl_soap_getsslservercertfingerprintsha1(void* lpObj);
char* ipworksssl_soap_getsslservercertfingerprintsha256(void* lpObj);
char* ipworksssl_soap_getsslservercertissuer(void* lpObj);
char* ipworksssl_soap_getsslservercertprivatekey(void* lpObj);
int ipworksssl_soap_getsslservercertprivatekeyavailable(void* lpObj);
char* ipworksssl_soap_getsslservercertprivatekeycontainer(void* lpObj);
char* ipworksssl_soap_getsslservercertpublickey(void* lpObj);
char* ipworksssl_soap_getsslservercertpublickeyalgorithm(void* lpObj);
int ipworksssl_soap_getsslservercertpublickeylength(void* lpObj);
char* ipworksssl_soap_getsslservercertserialnumber(void* lpObj);
char* ipworksssl_soap_getsslservercertsignaturealgorithm(void* lpObj);
int ipworksssl_soap_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* ipworksssl_soap_getsslservercertstorepassword(void* lpObj);
int ipworksssl_soap_getsslservercertstoretype(void* lpObj);
char* ipworksssl_soap_getsslservercertsubjectaltnames(void* lpObj);
char* ipworksssl_soap_getsslservercertthumbprintmd5(void* lpObj);
char* ipworksssl_soap_getsslservercertthumbprintsha1(void* lpObj);
char* ipworksssl_soap_getsslservercertthumbprintsha256(void* lpObj);
char* ipworksssl_soap_getsslservercertusage(void* lpObj);
int ipworksssl_soap_getsslservercertusageflags(void* lpObj);
char* ipworksssl_soap_getsslservercertversion(void* lpObj);
char* ipworksssl_soap_getsslservercertsubject(void* lpObj);
int ipworksssl_soap_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QString GetSSLServerCertEffectiveDate(); QString GetSSLServerCertExpirationDate(); QString GetSSLServerCertExtendedKeyUsage(); QString GetSSLServerCertFingerprint(); QString GetSSLServerCertFingerprintSHA1(); QString GetSSLServerCertFingerprintSHA256(); QString GetSSLServerCertIssuer(); QString GetSSLServerCertPrivateKey(); bool GetSSLServerCertPrivateKeyAvailable(); QString GetSSLServerCertPrivateKeyContainer(); QString GetSSLServerCertPublicKey(); QString GetSSLServerCertPublicKeyAlgorithm(); int GetSSLServerCertPublicKeyLength(); QString GetSSLServerCertSerialNumber(); QString GetSSLServerCertSignatureAlgorithm(); QByteArray GetSSLServerCertStore(); QString GetSSLServerCertStorePassword(); int GetSSLServerCertStoreType(); QString GetSSLServerCertSubjectAltNames(); QString GetSSLServerCertThumbprintMD5(); QString GetSSLServerCertThumbprintSHA1(); QString GetSSLServerCertThumbprintSHA256(); QString GetSSLServerCertUsage(); int GetSSLServerCertUsageFlags(); QString GetSSLServerCertVersion(); QString GetSSLServerCertSubject(); QByteArray GetSSLServerCertEncoded();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Data Type
StatusLine Property (SOAP Class)
This property is the first line of the last server response.
Syntax
ANSI (Cross Platform) char* GetStatusLine(); Unicode (Windows) LPWSTR GetStatusLine();
char* ipworksssl_soap_getstatusline(void* lpObj);
QString GetStatusLine();
Default Value
""
Remarks
This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property.
The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].
This property is read-only and not available at design time.
Data Type
String
Timeout Property (SOAP Class)
This property includes the timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworksssl_soap_gettimeout(void* lpObj);
int ipworksssl_soap_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
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
TransferredData Property (SOAP Class)
This property includes the contents of the last response from the server.
Syntax
ANSI (Cross Platform) int GetTransferredData(char* &lpTransferredData, int &lenTransferredData); Unicode (Windows) INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);
int ipworksssl_soap_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);
QByteArray GetTransferredData();
Default Value
""
Remarks
This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.
TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).
This property is read-only and not available at design time.
Data Type
Binary String
TransferredDataLimit Property (SOAP Class)
This property specifies the maximum amount of data to be transferred.
Syntax
ANSI (Cross Platform) int64 GetTransferredDataLimit();
int SetTransferredDataLimit(int64 lTransferredDataLimit); Unicode (Windows) LONG64 GetTransferredDataLimit();
INT SetTransferredDataLimit(LONG64 lTransferredDataLimit);
int64 ipworksssl_soap_gettransferreddatalimit(void* lpObj);
int ipworksssl_soap_settransferreddatalimit(void* lpObj, int64 lTransferredDataLimit);
qint64 GetTransferredDataLimit();
int SetTransferredDataLimit(qint64 lTransferredDataLimit);
Default Value
0
Remarks
This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.
Data Type
Long64
TransferredHeaders Property (SOAP Class)
This property includes the full set of headers as received from the server.
Syntax
ANSI (Cross Platform) char* GetTransferredHeaders(); Unicode (Windows) LPWSTR GetTransferredHeaders();
char* ipworksssl_soap_gettransferredheaders(void* lpObj);
QString GetTransferredHeaders();
Default Value
""
Remarks
This property returns the complete set of raw headers as received from the server.
The Header event shows the individual headers as parsed by the class.
This property is read-only and not available at design time.
Data Type
String
URL Property (SOAP Class)
This property specifies the URL to retrieve.
Syntax
ANSI (Cross Platform) char* GetURL();
int SetURL(const char* lpszURL); Unicode (Windows) LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);
char* ipworksssl_soap_geturl(void* lpObj);
int ipworksssl_soap_seturl(void* lpObj, const char* lpszURL);
QString GetURL();
int SetURL(QString qsURL);
Default Value
""
Remarks
This property contains the URL of the document. This value is parsed, and the results are put in the URLScheme, URLServer, URLPort, and URLPath properties.
Data Type
String
User Property (SOAP Class)
This property includes a user name if authentication is to be used.
Syntax
ANSI (Cross Platform) char* GetUser();
int SetUser(const char* lpszUser); Unicode (Windows) LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);
char* ipworksssl_soap_getuser(void* lpObj);
int ipworksssl_soap_setuser(void* lpObj, const char* lpszUser);
QString GetUser();
int SetUser(QString qsUser);
Default Value
""
Remarks
This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.
If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.
Data Type
String
ValueFormat Property (SOAP Class)
This property includes the format of data returned or set.
Syntax
ANSI (Cross Platform) int GetValueFormat();
int SetValueFormat(int iValueFormat); Unicode (Windows) INT GetValueFormat();
INT SetValueFormat(INT iValueFormat);
Possible Values
VF_TEXT(0),
VF_XML(1),
VF_FULL_XML(2)
int ipworksssl_soap_getvalueformat(void* lpObj);
int ipworksssl_soap_setvalueformat(void* lpObj, int iValueFormat);
int GetValueFormat();
int SetValueFormat(int iValueFormat);
Default Value
1
Remarks
The ValueFormat property specifies the format of the data set or received into/from value properties, such as XText, ReturnValue, and the Params properties.
The following are the possible values:
vfText (0) | Textual data. Any '<', '>', and '&' characters are escaped to '<', '>', and '&'. |
vfXML (1) | XML data, not including the enclosing element tags. No escaping is performed for the XML data, but element data (such as element attributes) will be escaped. |
vfFullXML (2) | Same as vfXML, but including the enclosing element. No escaping is performed for the XML data or for the XML element. |
Data Type
Integer
XAttributes Property (SOAP Class)
This property includes a collection of attributes of the current element.
Syntax
IPWorksSSLList<IPWorksSSLXMLAttribute>* GetXAttributes();
int ipworksssl_soap_getattrcount(void* lpObj);
char* ipworksssl_soap_getattrname(void* lpObj, int attrindex);
char* ipworksssl_soap_getattrnamespace(void* lpObj, int attrindex);
char* ipworksssl_soap_getattrprefix(void* lpObj, int attrindex);
char* ipworksssl_soap_getattrvalue(void* lpObj, int attrindex);
int GetAttrCount(); QString GetAttrName(int iAttrIndex); QString GetAttrNamespace(int iAttrIndex); QString GetAttrPrefix(int iAttrIndex); QString GetAttrValue(int iAttrIndex);
Remarks
This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of XMLAttribute types.
This property is read-only and not available at design time.
Data Type
XChildren Property (SOAP Class)
This property includes the collection of child elements for the current element.
Syntax
IPWorksSSLList<IPWorksSSLXMLElement>* GetXChildren();
int ipworksssl_soap_getxchildcount(void* lpObj);
char* ipworksssl_soap_getxchildname(void* lpObj, int xchildindex);
char* ipworksssl_soap_getxchildnamespace(void* lpObj, int xchildindex);
char* ipworksssl_soap_getxchildprefix(void* lpObj, int xchildindex);
char* ipworksssl_soap_getxchildxtext(void* lpObj, int xchildindex);
int GetXChildCount(); QString GetXChildName(int iXChildIndex); QString GetXChildNamespace(int iXChildIndex); QString GetXChildPrefix(int iXChildIndex); QString GetXChildXText(int iXChildIndex);
Remarks
These elements are provided in the collection in the same order they are found in the document.
This property is read-only and not available at design time.
Data Type
XElement Property (SOAP Class)
This property includes the name of the element pointed to by XPath .
Syntax
ANSI (Cross Platform) char* GetXElement(); Unicode (Windows) LPWSTR GetXElement();
char* ipworksssl_soap_getxelement(void* lpObj);
QString GetXElement();
Default Value
""
Remarks
The corresponding prefix is provided by XPrefix.
This property is read-only.
Data Type
String
XNamespace Property (SOAP Class)
This property includes the namespace of the element pointed to by XPath .
Syntax
ANSI (Cross Platform) char* GetXNamespace(); Unicode (Windows) LPWSTR GetXNamespace();
char* ipworksssl_soap_getxnamespace(void* lpObj);
QString GetXNamespace();
Default Value
""
Remarks
The corresponding namespace prefix is provided by XPrefix.
This property is read-only.
Data Type
String
XParent Property (SOAP Class)
This property includes the parent of the element pointed to by XPath .
Syntax
ANSI (Cross Platform) char* GetXParent(); Unicode (Windows) LPWSTR GetXParent();
char* ipworksssl_soap_getxparent(void* lpObj);
QString GetXParent();
Default Value
""
Remarks
If XPath points to the top element, XParent is an empty string.
This property is read-only.
Data Type
String
XPath Property (SOAP Class)
This property includes a path into the SOAPPacket received by the server.
Syntax
ANSI (Cross Platform) char* GetXPath();
int SetXPath(const char* lpszXPath); Unicode (Windows) LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);
char* ipworksssl_soap_getxpath(void* lpObj);
int ipworksssl_soap_setxpath(void* lpObj, const char* lpszXPath);
QString GetXPath();
int SetXPath(QString qsXPath);
Default Value
""
Remarks
The syntax is a subset of the XPath language.
Use this property to look at details of the SOAPPacket received by the server.
Data Type
String
XPrefix Property (SOAP Class)
This property includes the prefix of the element pointed to by XPath .
Syntax
ANSI (Cross Platform) char* GetXPrefix(); Unicode (Windows) LPWSTR GetXPrefix();
char* ipworksssl_soap_getxprefix(void* lpObj);
QString GetXPrefix();
Default Value
""
Remarks
The corresponding element name is provided by XElement.
This property is read-only.
Data Type
String
XText Property (SOAP Class)
This property includes the text of the element pointed to by XPath .
Syntax
ANSI (Cross Platform) char* GetXText(); Unicode (Windows) LPWSTR GetXText();
char* ipworksssl_soap_getxtext(void* lpObj);
QString GetXText();
Default Value
""
Remarks
The ValueFormat property controls the format in which the value is returned.
This property is read-only.
Data Type
String
AddCookie Method (SOAP Class)
This method adds a cookie and the corresponding value to the outgoing request headers.
Syntax
ANSI (Cross Platform) int AddCookie(const char* lpszCookieName, const char* lpszCookieValue); Unicode (Windows) INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);
int ipworksssl_soap_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);
int AddCookie(const QString& qsCookieName, const QString& qsCookieValue);
Remarks
This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddNamespace Method (SOAP Class)
This method adds a namespace to the Namespaces properties.
Syntax
ANSI (Cross Platform) int AddNamespace(const char* lpszPrefix, const char* lpszNamespaceURI); Unicode (Windows) INT AddNamespace(LPCWSTR lpszPrefix, LPCWSTR lpszNamespaceURI);
int ipworksssl_soap_addnamespace(void* lpObj, const char* lpszPrefix, const char* lpszNamespaceURI);
int AddNamespace(const QString& qsPrefix, const QString& qsNamespaceURI);
Remarks
Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddParam Method (SOAP Class)
This method adds a parameter-value pair.
Syntax
ANSI (Cross Platform) int AddParam(const char* lpszParamName, const char* lpszParamValue); Unicode (Windows) INT AddParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue);
int ipworksssl_soap_addparam(void* lpObj, const char* lpszParamName, const char* lpszParamValue);
int AddParam(const QString& qsParamName, const QString& qsParamValue);
Remarks
Please refer to the parameter name and value provided in the Params properties for more information on SOAP parameters and how they are managed.
Example 1. Send SOAP Request:
SOAPControl.Reset()
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.SendRequest()
Example 3. Send SOAP Request Using Param Arrays:
SOAPControl.Reset()
SOAPControl.ParamCount = 2
SOAPControl.ParamName(0) = "paramname"
SOAPControl.ParamValue(0) = "paramvalue"
SOAPControl.ParamName(1) = "paramname2"
SOAPControl.ParamValue(1) = "paramvalue2"
SOAPControl.ParamAttrs(1) = "customattr=value"
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.SendRequest()
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Attr Method (SOAP Class)
This method returns the value of the specified attribute.
Syntax
ANSI (Cross Platform) char* Attr(const char* lpszAttrName); Unicode (Windows) LPWSTR Attr(LPCWSTR lpszAttrName);
char* ipworksssl_soap_attr(void* lpObj, const char* lpszAttrName);
QString Attr(const QString& qsAttrName);
Remarks
If the attribute does not exist, an empty string is returned if ErrorOnEmptyAttr is set to False; otherwise, an exception is thrown.
Please refer to the XAttributes properties for more information.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
BuildPacket Method (SOAP Class)
This method builds the request packet.
Syntax
ANSI (Cross Platform) int BuildPacket(); Unicode (Windows) INT BuildPacket();
int ipworksssl_soap_buildpacket(void* lpObj);
int BuildPacket();
Remarks
The resulting packet is placed in SOAPPacket.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (SOAP Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksssl_soap_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoEvents Method (SOAP Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworksssl_soap_doevents(void* lpObj);
int DoEvents();
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EvalPacket Method (SOAP Class)
This method evaluates the packet in SOAPPacket .
Syntax
ANSI (Cross Platform) int EvalPacket(); Unicode (Windows) INT EvalPacket();
int ipworksssl_soap_evalpacket(void* lpObj);
int EvalPacket();
Remarks
Use this method to evaluate SOAP packets received through other means (i.e., not directly through the class).
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
HasXPath Method (SOAP Class)
This method determines whether a specific element exists in the document.
Syntax
ANSI (Cross Platform) bool HasXPath(const char* lpszXPath); Unicode (Windows) INT HasXPath(LPCWSTR lpszXPath);
bool ipworksssl_soap_hasxpath(void* lpObj, const char* lpszXPath);
bool HasXPath(const QString& qsXPath);
Remarks
This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through XPath.
This method returns True if the xpath exists, and False if not.
See XPath for details on the XPath syntax.
Error Handling (C++)
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Interrupt Method (SOAP Class)
This method interrupts the current method.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int ipworksssl_soap_interrupt(void* lpObj);
int Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (SOAP Class)
This method resets the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksssl_soap_reset(void* lpObj);
int Reset();
Remarks
Calling this method also resets all HTTP headers to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendPacket Method (SOAP Class)
This method sends the packet.
Syntax
ANSI (Cross Platform) int SendPacket(); Unicode (Windows) INT SendPacket();
int ipworksssl_soap_sendpacket(void* lpObj);
int SendPacket();
Remarks
This method may also be used to send a packet placed in SOAPPacket.
Example. Send SOAP Request:
SOAPControl.Reset()
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.BuildPacket()
SOAPControl.SendPacket()
SOAPControl.EvalPacket()
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendRequest Method (SOAP Class)
This method sends the request.
Syntax
ANSI (Cross Platform) int SendRequest(); Unicode (Windows) INT SendRequest();
int ipworksssl_soap_sendrequest(void* lpObj);
int SendRequest();
Remarks
Calling this method is equivalent to calling BuildPacket, SendPacket, and EvalPacket in succession.
Example. Send SOAP Request:
SOAPControl.Reset()
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.SendRequest()
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
TryXPath Method (SOAP Class)
This method navigates to the specified XPath if it exists.
Syntax
ANSI (Cross Platform) bool TryXPath(const char* lpszxpath); Unicode (Windows) INT TryXPath(LPCWSTR lpszxpath);
bool ipworksssl_soap_tryxpath(void* lpObj, const char* lpszxpath);
bool TryXPath(const QString& qsxpath);
Remarks
This method will attempt to navigate to the specified XPath parameter if it exists within the document.
If the XPath exists, the XPath property will be updated and this method returns True.
If the XPath does not exist, the XPath property is not updated and this method returns False.
Error Handling (C++)
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Value Method (SOAP Class)
This method returns the value of a parameter.
Syntax
ANSI (Cross Platform) char* Value(const char* lpszParamName); Unicode (Windows) LPWSTR Value(LPCWSTR lpszParamName);
char* ipworksssl_soap_value(void* lpObj, const char* lpszParamName);
QString Value(const QString& qsParamName);
Remarks
The class will search through the Params properties for the parameter identified by ParamName and will return the value associated with it provided in the properties.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Connected Event (SOAP Class)
This event is fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(SOAPConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } SOAPConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(SOAPConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } SOAPConnectedEventParams;
#define EID_SOAP_CONNECTED 1 virtual INT IPWORKSSSL_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);
class SOAPConnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connected(SOAPConnectedEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireConnected(SOAPConnectedEventParams *e) {...}
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
ConnectionStatus Event (SOAP Class)
This event is fired to indicate changes in the connection state.
Syntax
ANSI (Cross Platform) virtual int FireConnectionStatus(SOAPConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } SOAPConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(SOAPConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } SOAPConnectionStatusEventParams;
#define EID_SOAP_CONNECTIONSTATUS 2 virtual INT IPWORKSSSL_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);
class SOAPConnectionStatusEventParams { public: const QString &ConnectionEvent(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ConnectionStatus(SOAPConnectionStatusEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireConnectionStatus(SOAPConnectionStatusEventParams *e) {...}
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
Disconnected Event (SOAP Class)
This event is fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(SOAPDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } SOAPDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(SOAPDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } SOAPDisconnectedEventParams;
#define EID_SOAP_DISCONNECTED 3 virtual INT IPWORKSSSL_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);
class SOAPDisconnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnected(SOAPDisconnectedEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireDisconnected(SOAPDisconnectedEventParams *e) {...}
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
EndTransfer Event (SOAP Class)
This event is fired when a document finishes transferring.
Syntax
ANSI (Cross Platform) virtual int FireEndTransfer(SOAPEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } SOAPEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(SOAPEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } SOAPEndTransferEventParams;
#define EID_SOAP_ENDTRANSFER 4 virtual INT IPWORKSSSL_CALL FireEndTransfer(INT &iDirection);
class SOAPEndTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EndTransfer(SOAPEndTransferEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireEndTransfer(SOAPEndTransferEventParams *e) {...}
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (SOAP Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(SOAPErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SOAPErrorEventParams;
Unicode (Windows) virtual INT FireError(SOAPErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SOAPErrorEventParams;
#define EID_SOAP_ERROR 5 virtual INT IPWORKSSSL_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SOAPErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SOAPErrorEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireError(SOAPErrorEventParams *e) {...}
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.
Header Event (SOAP Class)
This event is fired every time a header line comes in.
Syntax
ANSI (Cross Platform) virtual int FireHeader(SOAPHeaderEventParams *e);
typedef struct {
const char *Field;
const char *Value; int reserved; } SOAPHeaderEventParams;
Unicode (Windows) virtual INT FireHeader(SOAPHeaderEventParams *e);
typedef struct {
LPCWSTR Field;
LPCWSTR Value; INT reserved; } SOAPHeaderEventParams;
#define EID_SOAP_HEADER 6 virtual INT IPWORKSSSL_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);
class SOAPHeaderEventParams { public: const QString &Field(); const QString &Value(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Header(SOAPHeaderEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireHeader(SOAPHeaderEventParams *e) {...}
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (SOAP Class)
This event fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(SOAPLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } SOAPLogEventParams;
Unicode (Windows) virtual INT FireLog(SOAPLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } SOAPLogEventParams;
#define EID_SOAP_LOG 7 virtual INT IPWORKSSSL_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class SOAPLogEventParams { public: int LogLevel(); const QString &Message(); const QString &LogType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(SOAPLogEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireLog(SOAPLogEventParams *e) {...}
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"
Redirect Event (SOAP Class)
This event is fired when a redirection is received from the server.
Syntax
ANSI (Cross Platform) virtual int FireRedirect(SOAPRedirectEventParams *e);
typedef struct {
const char *Location;
int Accept; int reserved; } SOAPRedirectEventParams;
Unicode (Windows) virtual INT FireRedirect(SOAPRedirectEventParams *e);
typedef struct {
LPCWSTR Location;
BOOL Accept; INT reserved; } SOAPRedirectEventParams;
#define EID_SOAP_REDIRECT 8 virtual INT IPWORKSSSL_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);
class SOAPRedirectEventParams { public: const QString &Location(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Redirect(SOAPRedirectEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireRedirect(SOAPRedirectEventParams *e) {...}
Remarks
This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.
SetCookie Event (SOAP Class)
This event is fired for every cookie set by the server.
Syntax
ANSI (Cross Platform) virtual int FireSetCookie(SOAPSetCookieEventParams *e);
typedef struct {
const char *Name;
const char *Value;
const char *Expires;
const char *Domain;
const char *Path;
int Secure; int reserved; } SOAPSetCookieEventParams;
Unicode (Windows) virtual INT FireSetCookie(SOAPSetCookieEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR Value;
LPCWSTR Expires;
LPCWSTR Domain;
LPCWSTR Path;
BOOL Secure; INT reserved; } SOAPSetCookieEventParams;
#define EID_SOAP_SETCOOKIE 9 virtual INT IPWORKSSSL_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);
class SOAPSetCookieEventParams { public: const QString &Name(); const QString &Value(); const QString &Expires(); const QString &Domain(); const QString &Path(); bool Secure(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SetCookie(SOAPSetCookieEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireSetCookie(SOAPSetCookieEventParams *e) {...}
Remarks
The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.
The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.
The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.
The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.
The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.
The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.
SSLServerAuthentication Event (SOAP Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(SOAPSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } SOAPSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(SOAPSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } SOAPSSLServerAuthenticationEventParams;
#define EID_SOAP_SSLSERVERAUTHENTICATION 10 virtual INT IPWORKSSSL_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class SOAPSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(SOAPSSLServerAuthenticationEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireSSLServerAuthentication(SOAPSSLServerAuthenticationEventParams *e) {...}
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 (SOAP Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(SOAPSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } SOAPSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(SOAPSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } SOAPSSLStatusEventParams;
#define EID_SOAP_SSLSTATUS 11 virtual INT IPWORKSSSL_CALL FireSSLStatus(LPSTR &lpszMessage);
class SOAPSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(SOAPSSLStatusEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireSSLStatus(SOAPSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (SOAP Class)
This event is fired when a document starts transferring (after the headers).
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(SOAPStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } SOAPStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(SOAPStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } SOAPStartTransferEventParams;
#define EID_SOAP_STARTTRANSFER 12 virtual INT IPWORKSSSL_CALL FireStartTransfer(INT &iDirection);
class SOAPStartTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void StartTransfer(SOAPStartTransferEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireStartTransfer(SOAPStartTransferEventParams *e) {...}
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Status Event (SOAP Class)
This event is fired when the HTTP status line is received from the server.
Syntax
ANSI (Cross Platform) virtual int FireStatus(SOAPStatusEventParams *e);
typedef struct {
const char *HTTPVersion;
int StatusCode;
const char *Description; int reserved; } SOAPStatusEventParams;
Unicode (Windows) virtual INT FireStatus(SOAPStatusEventParams *e);
typedef struct {
LPCWSTR HTTPVersion;
INT StatusCode;
LPCWSTR Description; INT reserved; } SOAPStatusEventParams;
#define EID_SOAP_STATUS 13 virtual INT IPWORKSSSL_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);
class SOAPStatusEventParams { public: const QString &HTTPVersion(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Status(SOAPStatusEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireStatus(SOAPStatusEventParams *e) {...}
Remarks
HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").
StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").
Transfer Event (SOAP Class)
This event is fired while the response transfers.
Syntax
ANSI (Cross Platform) virtual int FireTransfer(SOAPTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone; int reserved; } SOAPTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(SOAPTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone; INT reserved; } SOAPTransferEventParams;
#define EID_SOAP_TRANSFER 14 virtual INT IPWORKSSSL_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone);
class SOAPTransferEventParams { public: int Direction(); qint64 BytesTransferred(); int PercentDone(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Transfer(SOAPTransferEventParams *e);
// Or, subclass SOAP and override this emitter function. virtual int FireTransfer(SOAPTransferEventParams *e) {...}
Remarks
The BytesTransferred parameter contains the number of bytes transferred since the beginning of the response (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Certificate Type
This is the digital certificate being used.
Syntax
IPWorksSSLCertificate (declared in ipworksssl.h)
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
char* (read-only)
Default Value: ""
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.
ExpirationDate
char* (read-only)
Default Value: ""
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.
ExtendedKeyUsage
char* (read-only)
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
char* (read-only)
Default Value: ""
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
FingerprintSHA1
char* (read-only)
Default Value: ""
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
FingerprintSHA256
char* (read-only)
Default Value: ""
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
Issuer
char* (read-only)
Default Value: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
char* (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
int (read-only)
Default Value: FALSE
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
char* (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
char* (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
char* (read-only)
Default Value: ""
This field 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.
PublicKeyLength
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
char* (read-only)
Default Value: ""
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.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The field 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.
Store
char*
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
char*
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
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 field 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 Store and set StorePassword 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. |
SubjectAltNames
char* (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
char* (read-only)
Default Value: ""
This field 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.
ThumbprintSHA1
char* (read-only)
Default Value: ""
This field 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.
ThumbprintSHA256
char* (read-only)
Default Value: ""
This field 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.
Usage
char* (read-only)
Default Value: ""
This field contains the text description of UsageFlags.
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.
UsageFlags
int (read-only)
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags 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 Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
char* (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
char*
Default Value: ""
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 field 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.
Encoded
char*
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
Certificate(const char* lpEncoded, int lenEncoded)
Parses Encoded as an X.509 public key.
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
Firewall Type
The firewall the component will connect through.
Syntax
IPWorksSSLFirewall (declared in ipworksssl.h)
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
int
Default Value: FALSE
This field tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType
int
Default Value: 0
This field 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. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
char*
Default Value: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error.
Password
char*
Default Value: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Port
int
Default Value: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
char*
Default Value: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Constructors
Firewall()
Header Type
This is an HTTP header as it is received from the server.
Syntax
IPWorksSSLHeader (declared in ipworksssl.h)
Remarks
When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.
Fields
Field
char*
Default Value: ""
This field contains the name of the HTTP Header (this is the same case as it is delivered).
Value
char*
Default Value: ""
This field contains the Header contents.
Constructors
Header()
Header(const char* lpszField, const char* lpszValue)
HTTPCookie Type
An HTTP cookie can be either sent to or received from the server.
Syntax
IPWorksSSLHTTPCookie (declared in ipworksssl.h)
Remarks
An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.
Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.
Fields
Domain
char* (read-only)
Default Value: ""
This is the domain of a received cookie. This field contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this field will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.
Expiration
char* (read-only)
Default Value: ""
This field contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this field will contain an empty string. The convention is to drop the cookie at the end of the session.
Name
char*
Default Value: ""
This field, contains the name of the cookie.
This field, along with Value, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.
Path
char* (read-only)
Default Value: ""
This field contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path field will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.
Secure
int (read-only)
Default Value: FALSE
This field contains the security flag of the received cookie. This field specifies whether the cookie is secure. If the value of this field is True, the cookie value must be submitted only through a secure (HTTPS) connection.
Value
char*
Default Value: ""
This field contains the value of the cookie. A corresponding value is associated with the cookie specified by Name. This property holds that value.
The SetCookie event provides the cookies set by the server.
Constructors
HTTPCookie()
HTTPCookie(const char* lpszName, const char* lpszValue)
Proxy Type
The proxy the component will connect to.
Syntax
IPWorksSSLProxy (declared in ipworksssl.h)
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
int
Default Value: 0
This field is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this field will clear the values of User and Password.
AutoDetect
int
Default Value: FALSE
This field tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Password
char*
Default Value: ""
This field contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Port
int
Default Value: 80
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
char*
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.
SSL
int
Default Value: 0
This field 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. |
User
char*
Default Value: ""
This field contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Constructors
Proxy()
Proxy(const char* lpszServer, int iPort)
Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)
SOAPParam Type
This type describes a parameter for the SOAP Method .
Syntax
IPWorksSSLSOAPParam (declared in ipworksssl.h)
Remarks
This type describes a parameter of the SOAP Method. SOAPParam has fields to describe the name, value, and any attributes of the parameter being described.
Fields
Attrs
char*
Default Value: ""
This field contains the extra attributes for the parameter.
Name
char*
Default Value: ""
This field contains the name of the Method parameter.
Value
char*
Default Value: ""
This field contains the value of the Method parameter.
Constructors
SOAPParam()
SOAPParam(const char* lpszName, const char* lpszValue)
XMLAttribute Type
This type describes an XML attribute from the current XML element.
Syntax
IPWorksSSLXMLAttribute (declared in ipworksssl.h)
Remarks
This type describes an XML attribute from the current element. It includes fields to denote information about the attribute being defined.
Fields
Name
char* (read-only)
Default Value: ""
The Name provides the local name (without prefix) of the attribute.
Namespace
char* (read-only)
Default Value: ""
This field contains the attribute namespace.
Prefix
char* (read-only)
Default Value: ""
This field contains the attribute prefix (if any). If the attribute does not have a prefix, this property is empty.
Value
char* (read-only)
Default Value: ""
This field contains the attribute value.
Constructors
XMLAttribute()
XMLElement Type
This type describes an element contained within the XML document.
Syntax
IPWorksSSLXMLElement (declared in ipworksssl.h)
Remarks
This type describes an XML element. The fields for this type describe the element Name, Prefix, and Namespace of the given element.
The elements are inserted into the array in the same order they are found in the document.
Fields
Name
char* (read-only)
Default Value: ""
The Name field provides the local name (without a prefix) of the element.
Namespace
char* (read-only)
Default Value: ""
This field contains the namespace of the element.
Prefix
char* (read-only)
Default Value: ""
This field contains the prefix of the element (if any). If the element does not have a prefix, this property is empty.
XText
char* (read-only)
Default Value: ""
This field contains the inner text of the element.
Constructors
XMLElement()
XMLNamespace Type
This type describes an XML namespace from the current namespace stack.
Syntax
IPWorksSSLXMLNamespace (declared in ipworksssl.h)
Remarks
This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.
The default namespace exists at index 0. The Prefix field at index 0 is xmlns, and the Name field contains the default namespace.
Fields
Prefix
char*
Default Value: ""
URI
char*
Default Value: ""
This field contains the namespace URI associated with the corresponding Prefix. This URL is usually pointing to the XML schema for the namespace.
Constructors
XMLNamespace()
XMLNamespace(const char* lpszURI, const char* lpszPrefix)
IPWorksSSLList Type
Syntax
IPWorksSSLList<T> (declared in ipworksssl.h)
Remarks
IPWorksSSLList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SOAP class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount() {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (SOAP 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.SOAP Config Settings
SOAP1.Config("MethodAttributes=\"<your value>\"");
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.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
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 ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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.
XML Config Settings
This option should be combined with Indent for full effect.
If you would like any other characters to be considered as name characters, you may set them as a string into this property.
If you would like any other characters to be considered as white space, you may set them as a string into this property.
If False (default) and Validate is set to False, the prefix is included in the Element parameter (e.g., ds:DigestMethod).
If True and Validate is set to False, the prefix is not included in the Element parameter (e.g., DigestMethod).
This setting is applicable only when Validate is False.
<?xml version="1.0" encoding="utf-8" standalone="yes" ?> ...
This option should be combined with EOL for full effect.
Offset values start at 1.
Note: This applies only when BuildDOM is False.
By default, no additional processing is performed and the string is returned as is from the document. Strings may also be XML unescaped. Possible values are as follows:
0 (none - default) | No additional processing is performed. |
1 | Strings are XML unescaped. |
For instance, when set to 0, the following text may be fired through the Characters event:
&"<>
When set to 1, the following text would be fired through the Characters event:
&"<>
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (SOAP Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SOAP Errors
169 | Invalid param index (out of range). |
170 | Invalid namespace index (out of range). |
171 | Method not found. Please specify a valid Method. |
172 | No method URI. Please specify a valid MethodURI. |
173 | SOAP Fault. See FaultCode and/or FaultString for details. |
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.
SSLClient 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). |
XML Errors
101 | Invalid attribute index. |
102 | No attributes available. |
103 | Invalid namespace index. |
104 | No namespaces available. |
105 | Invalid element index. |
106 | No elements available. |
107 | Attribute does not exist. |
201 | Unbalanced element tag. |
202 | Unknown element prefix (cannot find namespace). |
203 | Unknown attribute prefix (cannot find namespace). |
204 | Invalid XML markup. |
205 | Invalid end state for parser. |
206 | Document contains unbalanced elements. |
207 | Invalid XPath. |
208 | No such child. |
209 | Top element does not match start of path. |
210 | DOM tree unavailable (set BuildDOM to True and reparse). |
302 | Cannot open file. |
401 | Invalid XML would be generated. |
402 | An invalid XML name has been specified. |