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

Available in: SSH | SSL

IPPortS Component [IP*Works! SSL V8]

Properties Methods Events Configuration Settings

The IPPortS component facilitates TCP/IP communications by providing an easy interface to system TCP/IP functions. It allows a client application to communicate with a server using stream sockets.

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 IPPortS component is the SSL-enabled equivalent of the IP*Works! IPPort 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 property is used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the event allow you to check the server identity and other security attributes. Finally, the event provides information about the SSL handshake.

Our main goal in designing IPPortS was ease of use. The component has a minimum of properties and five events: , , , , and . The events are relatively self-explanatory.

The connection is attempted by calling the method or setting the property to True, and then waiting for the event. The destination is defined by setting and . Data is sent by calling the method with Text as a parameter, or by assigning the data string to the property.

To disconnect, you just call the method or set the property to False. The property controls how the connection is terminated.

The operation of the component is almost completely asynchronous. All the calls except the ones that deal with domain name resolution, operate through asynchronous messages (no blocking calls). The gain in performance is considerable when compared to using blocking calls.

Property List

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


AcceptData	Enables or disables data reception (the DataIn event).
BytesSent	The number of bytes actually sent after an assignment to DataToSend .
Connected	Triggers a connection or disconnection.
DataToSend	A string of data to be sent to the remote host.
EOL	Used to break the incoming data stream into chunks separated by EOL.
Firewall	A set of properties related to firewall access.
KeepAlive	When True, KEEPALIVE packets are enabled (for long connections).
Linger	When set to True, connections are terminated gracefully.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where IPPort binds.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The TCP port in the remote host.
SingleLineMode	Special mode for line-oriented protocols.
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.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.

Method List

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


Config	Sets or retrieves a configuration setting.
Connect	Connect to a remote host.
Disconnect	Disconnect from the remote host.
DoEvents	Processes events from the internal message queue.
GetLine	Gets a line of text from the server.
ReceiveStream	Sets the stream to which received data will be written.
Send	Send data to the remote host.
SendFile	Send file to the remote host.
SendLine	Sends a string followed by a newline.
SendStream	Reads content from the stream and sends it to the server.
StartSSL	starts SSL negotiation on a plaintext connection.

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.
DataIn	Fired when data (complete lines) comes in.
Disconnected	Fired when a connection is closed.
Error	Information about errors during data delivery.
ReadyToSend	Fired when IPPort is ready to send data.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

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


MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
TcpNoDelay	Whether or not to delay when sending packets
AcceptAnyServerCert	If set the component will accept any certificate presented by the server
SSLProvider	The name of the security provider to use.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLSecurityFlags	Flags that control certificate verification
ReuseSSLSession	Determines if the SSL session is reused.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCADir	The path to a directory containing CA certificates.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).