$Sock SSL On - Revision history

JALWiccan: Automatically generated page update

2018-09-21T00:00:37Z

Automatically generated page update

← Older revision		Revision as of 00:00, 21 September 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_SSL_On}}		{{DISPLAYTITLE:$Sock_SSL_On}}
	<span class="pageSubtitle">Switch to SSL processing</span>		<span class="pageSubtitle">Switch to SSL processing</span>
	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented
	methods. The OO equivalent for <var>$Sock_SSL_On</var> is the <var>[[SSLOn (Socket function)\|SSLOn]]</var> method.</p>		methods. The OO equivalent for <var>$Sock_SSL_On</var> is the <var>[[SSLOn (Socket function)\|SSLOn]]</var> method.</p>

JAL at 21:57, 23 July 2013

2013-07-23T21:57:18Z

← Older revision		Revision as of 21:57, 23 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Switch to SSL processing</span>		<span class="pageSubtitle">Switch to SSL processing</span>
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented
	methods. ~~There is currently no direct~~ OO equivalent for ~~this~~ $function.</p>		methods. The OO equivalent for <var>$Sock_SSL_On</var> is the <var>[[SSLOn (Socket function)\|SSLOn]]</var> method.</p>

	<var>$Sock_SSL</var> turns on SSL processing, that is, starts an SSL handshake as a client on a connection.		<var>$Sock_SSL</var> turns on SSL processing, that is, starts an SSL handshake as a client on a connection.

JALWiccan: Automatically generated page update

2013-07-19T18:59:28Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_SSL_On}}		{{DISPLAYTITLE:$Sock_SSL_On}}
	<span class="pageSubtitle">Switch to SSL processing</span>		<span class="pageSubtitle">Switch to SSL processing</span>
	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented
	methods. There is currently no direct OO equivalent for this $function.</p>		methods. There is currently no direct OO equivalent for this $function.</p>

JAL2: /* $Sock_SSL_On return codes */

2012-01-20T03:50:48Z

$Sock_SSL_On return codes

← Older revision		Revision as of 03:50, 20 January 2012
Line 18:		Line 18:
	<var>$Sock_SSL_On</var> return codes are:		<var>$Sock_SSL_On</var> return codes are:
	<table>		<table>
	<tr><th>0</th>		<tr><th>  0</th>
	<td>Successfully switched to SSL. </td></tr>		<td>Successfully switched to SSL. </td></tr>
	<tr><th>-110</th>		<tr><th>-110</th>

JAL2 at 03:49, 20 January 2012

2012-01-20T03:49:53Z

← Older revision		Revision as of 03:49, 20 January 2012
Line 18:		Line 18:
	<var>$Sock_SSL_On</var> return codes are:		<var>$Sock_SSL_On</var> return codes are:
	<table>		<table>
	<tr><th>0 </th>		<tr><th>0</th>
	<td>Successfully switched to SSL. </td></tr>		<td>Successfully switched to SSL. </td></tr>
	<tr><th>-110</th>		<tr><th>-110</th>
Line 28:		Line 28:
	<tr><th>-149</th>		<tr><th>-149</th>
	<td>Other error during connection. </td></tr>		<td>Other error during connection. </td></tr>
			</table>

	==Usage notes==		==Usage notes==

JAL2: /* $Sock_SSL_On return codes */

2012-01-20T03:47:26Z

$Sock_SSL_On return codes

← Older revision		Revision as of 03:47, 20 January 2012
Line 17:		Line 17:
	===$Sock_SSL_On return codes===		===$Sock_SSL_On return codes===
	<var>$Sock_SSL_On</var> return codes are:		<var>$Sock_SSL_On</var> return codes are:
	<dl>		<table>
	<dt>0 <dd>Successfully switched to SSL.		<tr><th>0 </th>
	<dt>-110 <dd>Attempted on non-SSL port. <var>$Sock_SSL_On</var> can only be attempted on a port with <var>SSL</var> and <var>SSLOPT</var> on the <var>[[JANUS DEFINE]]</var> command.		<td>Successfully switched to SSL. </td></tr>
	<dt>-111 <dd>SSL handshake error. Likely result of trying to use <var>$Sock_SSL_On</var> against a non-SSL port.		<tr><th>-110</th>
	<dt>-112 <dd>Have pending incoming data. <var>$Sock_SSL_On</var> is invalid until all incoming (presumably) non-SSL data has been received.		<td>Attempted on non-SSL port. <var>$Sock_SSL_On</var> can only be attempted on a port with <var>SSL</var> and <var>SSLOPT</var> on the <var>[[JANUS DEFINE]]</var> command. </td></tr>
	<dt>-149 <dd>Other error during connection.		<tr><th>-111</th>
	</dl>		<td>SSL handshake error. Likely result of trying to use <var>$Sock_SSL_On</var> against a non-SSL port. </td></tr>
			<tr><th>-112</th>
			<td>Have pending incoming data. <var>$Sock_SSL_On</var> is invalid until all incoming (presumably) non-SSL data has been received. </td></tr>
			<tr><th>-149</th>
			<td>Other error during connection. </td></tr>

	==Usage notes==		==Usage notes==

Admin: 1 revision

2012-01-20T02:53:46Z

1 revision

← Older revision	Revision as of 02:53, 20 January 2012
(No difference)

JAL at 01:22, 20 January 2012

2012-01-20T01:22:35Z

New page

{{DISPLAYTITLE:$Sock_SSL_On}}
Switch to SSL processing
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for this $function.

<var>$Sock_SSL</var> turns on SSL processing, that is, starts an SSL handshake as a client on a connection.

==Syntax==
[%rc =] = $Sock_SSL_On(sockNum) 

===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>A numeric return code: 0 if successful, otherwise a negative value, as described [[#$Sock_SSL_On return codes|below]]. <tr><th>sockNum</th>
<td>The socket number, or it is -1, which indicates that the change affects all relevant sockets. </td></tr> </table>

===$Sock_SSL_On return codes===
<var>$Sock_SSL_On</var> return codes are:
<dl>
<dt>0 <dd>Successfully switched to SSL.
<dt>-110 <dd>Attempted on non-SSL port. <var>$Sock_SSL_On</var> can only be attempted on a port with <var>SSL</var> and <var>SSLOPT</var> on the <var>[[JANUS DEFINE]]</var> command.
<dt>-111 <dd>SSL handshake error. Likely result of trying to use <var>$Sock_SSL_On</var> against a non-SSL port.
<dt>-112 <dd>Have pending incoming data. <var>$Sock_SSL_On</var> is invalid until all incoming (presumably) non-SSL data has been received.
<dt>-149 <dd>Other error during connection.
</dl>

==Usage notes==
This function makes it possible to make an initial connection from a <var class="product">Janus Sockets</var> client application to a proxy server, use the CONNECT method to connect to a server through the proxy, and then communicate via SSL with the back end server, simply having the proxy server act as a "tunnel" for the SSL data.
Basically, <var>$Sock_SSL_On</var> should be used after a positive response has been received for a CONNECT method request on a <var class="product">Janus Sockets</var> client socket.

==Example==
The following code illustrates the use of <var>$Sock_SSL_On</var>:
%x = $Sock_Conn('WEBDROPS', 'proxy')
%r = $Sock_Set(%x, 'LINEND', '0D0A')
%r = $Sock_Set(%x, 'PRSTOK', '0D0A')
%r = $Sock_Send(%x, 'CONNECT ')
%r = $Sock_Send(%x, 'sirius-software.com:443')
%r = $Sock_SendLn(%x, ' HTTP/1.0')
%r = $Sock_SendLn(%x, '')
%r = $Sock_RecvPrs(%x, %s)
If $WORD(%s, , 2) Ne '200' Then
Call CONNECT_ERROR
End If
Repeat Forever
%r = $Sock_RecvPrs(%x, %s)
If $lstr_len(%s) Eq 0 Then
Loop End
End If
End Repeat
%r = $Sock_SSL_On(%x)
If %r Then
Call SSL_ERROR
End If
%r = $Sock_Send(%x, 'GET ')
%r = $Sock_Send(%x, %URL)
%r = $Sock_SendLn(%x, ' HTTP/1.0')
%r = $Sock_SendLn(%x, '')
... 

For more information about HTTP tunneling and the CONNECT method, see <code>http://www.ietf.org/rfc/rfc2817.txt</code>. Many other references are also available on the web.

[[Category: Janus Sockets $functions]]