IP*Works! SSL HTTPS Component : HTTPS OCX, HTTPS .NET Component, HTTPS Class, HTTPS Bean, HTTPS Object

Available in: SSH | SSL

HTTPS Component [IP*Works! SSL V8]

Properties Methods Events Configuration Settings

The HTTPS Component can be used to retrieve documents from the World Wide Web.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The HTTPS Component is the SSL-enabled equivalent of the IP*Works! HTTP component. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The SSLProvider configuration setting chooses a security provider subsystem. The SSLEnabledProtocols and SSLCipherStrength configuration settings determine which protocols are enabled and at what security level. The SSLCert property is used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the SSLServerAuthentication event allow you to check the server identity and other security attributes. Finally, the SSLStatus event provides information about the SSL handshake.

The HTTPS Component implements a standard HTTP client through a simple plug-and-play interface as defined in RFCs 1945 and 2616 with the added option of SSL security.

The component contains a number of properties that map directly to HTTP request headers. Files are received through events: Transfer for contents, and Header for HTTP headers. The StartTransfer and EndTransfer events are fired at the beginning and end of transmission.

To receive a document call the Get method with the URL parameter. Data can be POST-ed to the HTTP server by assigning it to the PostData property and then calling the Post method.

The PUT method is also supported. You should specify the User and Password properties or alternatively the Authorization and call the Put method with the specified URL. The AttachedFile will be sent to the server.

The HTTPS Component supports the HTTP Basic authentication scheme through the User and Password properties. Other authentication schemes can be implemented by using the AuthScheme property.

Optionally, the component can use the Microsoft WinInet library to implement the HTTP functionality. This is triggered by the UseWinInet configuration setting. Although some of the functionality of the component (such as, for example, fine grained control over SSL server authentication) is not available through the WinInet compatibility layer, this option provides access to the Microsoft Internet Explorer settings on the system (such as default proxy settings, etc.) and more compatibility with Internet Explorer in general. This option is only available for Windows platforms.

Property List

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


Accept	A list of acceptable MIME types for the request.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AttachedFile	A file to append to PostData if the POST or PUT methods are used.
AuthScheme	The authentication scheme to use when server authorization is required.
Connected	Shows whether the component is connected.
ContentType	Content type for posts and puts.
Cookies	Collection of cookies.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
From	The email address of the HTTP agent (optional).
HTTPMethod	The HTTP method used for the request.
Idle	The current status of the component.
IfModifiedSince	A date determining the maximum age of the desired document.
LocalFile	The path to a local file for downloading. If the file exists, it is overwritten.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaders	Collection of headers returned from the last request.
Password	A password if authentication is to be used.
PostData	The data to post with the URL if the POST method is used.
Pragma	A browser/server specific header line (optional).
Proxy	A set of properties related to proxy access.
Range	The byte-range to be sent to the server.
Referer	Referer URL/document (optional).
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLServerCert	The server certificate for the last established connection.
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum of data to be transferred.
TransferredHeaders	The full set of headers as received from the server.
URL	The URL to fetch.
URLPath	The path for the URL.
URLPort	The port for the URL.
URLScheme	The scheme for the URL.
URLServer	The server for the URL.
User	A user name if authentication is to be used.

Method List

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


AddCookie	Adds a cookie and the corresponding value to the outgoing request headers.
Config	Sets or retrieves a configuration setting.
Delete	Deletes an object on the server.
DoEvents	Processes events from the internal message queue.
Get	Fetch the document using the HTTP GET method.
Head	Fetch the document headers using the HTTP HEAD method.
Interrupt	Interrupt the current method.
Post	Posts data to the HTTP server using the HTTP POST method.
Put	Sends data to the HTTP server using the HTTP PUT method.
ResetHeaders	Resets all HTTP Headers, Cookies, LocalFile , and AttachedFile.
SetDownloadStream	Sets the stream to which the downloaded data from the server will be written.
SetUploadStream	Sets the stream to be uploaded to the server.

Event List

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


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
Redirect	Fired when a redirection is received from the server.
SetCookie	Fired for every cookie set by the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

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


AcceptEncoding	Used to tell the server which types of content encodings the client supports
AllowHTTPCompression	This property enables HTTP compression for receiving data
Authorization	The Authorization string to be sent to the server
EncodeURL	If set to true the URL will be encoded by the component
GetOn302Redirect	If set to true the component will perform a GET on the new location
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document
KeepAlive	Determines whether the HTTP connection is closed after completion of the request
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
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
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component
UsePlatformHTTPClient	Whether or not to use the platform HTTP client
UserAgent	Information about the user agent (browser)
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making HTTP requests through WinInet
MaxLineLength	The maximum amount of data to accumulate when no EOL is found
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHost	Name or IP address of firewall (optional)
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall
FirewallPort	The TCP port for the FirewallHost;
FirewallUser	A user name if authentication is to be used connecting through a firewall
FirewallType	Determines the type of firewall to connect through
TcpNoDelay	Whether or not to delay when sending packets
ReuseSSLSession	Determines if the SSL session is reused
SSLCipherStrength	The minimum cipher strength used for bulk encryption
SSLEnabledProtocols	Used to enable/disable the supported security protocols
SSLProvider	The name of the security provider to use
SSLSecurityFlags	Flags that control certificate verification
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)
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
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only)