SharkSslCoreApi
[SharkSslApi]

The SharkSslCon_decrypt and SharkSslCon_encrypt return values.

Enumerator:

SharkSslCon_Error	Indicates general errors, including configuration errors.
SharkSslCon_AllocationError	The memory pool is too small.
SharkSslCon_Decrypted	Returned when a block of received data has been successfully decrypted. __selib.c code snippet:__ See also: SharkSslCon_getDecData
SharkSslCon_Handshake	Returned when an SSL/TLS handshake message has been received or is to be sent. During this phase, one must call SharkSslCon_getHandshakeData and SharkSslCon_getHandshakeDataLen, and send the handshake data to the peer side. __selib.c code snippet:__
SharkSslCon_NeedMoreData	Returned when SharkSSL holds an incomplete SSL/TLS record or when the connection is initially established and the readLen parameter is zero. __selib.c code snippet:__ See also: SharkSslCon_getBuf and SharkSslCon_getBufLen
SharkSslCon_AlertSend	Returned when an [SSL/TLS alert message](SSL/TLS Alert Messages) must be sent to the peer side. The error code, which must be sent to the peer, indicates that SharkSSL was unable to decode the data sent from the peer. __selib.c code snippet:__ See also: SharkSslCon_getAlertData and SharkSslCon_getAlertDataLen
SharkSslCon_AlertRecv	SharkSSL received an [SSL/TLS alert message](SSL/TLS Alert Messages) from the peer, which means that the peer either failed to decode the message from SharkSSL or the peer entered an exception state. See also: SharkSslCon_getAlertLevel and SharkSslCon_getAlertDescription
SharkSslCon_Encrypted	SharkSSL has successfully decrypted a chunk of data. The data is available in the SharkSSL receive buffer, which is returned by function SharkSslCon_getEncData. The length is returned by function SharkSslCon_getEncDataLen. __selib.c code snippet:__
SharkSslCon_HandshakeNotComplete	An error condition returned by function SharkSslCon_encrypt if the SSL handshake is not completed. You cannot send encrypted data before completing the handshake phase.
SharkSslCon_Certificate	Returned by function SharkSslCon_encrypt if SHARKSSL_ENABLE_CLONE_CERTINFO is disabled and when a complete certificate is received from the peer during the SSL handshake phase. Fixme more...
SharkSslCon_CertificateError	Unrecognized format of a provided certificate.

Definition at line 529 of file SharkSSL.h.

Copy decoded data to 'buf'.

Provides an alternative to using the zero copy API and the buffer returned by SharkSslCon_getDecData.

Parameters:

o	the SharkSslCon object returned by function SharkSsl_createCon.
buf	a buffer provided by the caller
maxLen	the size of parameter 'buf'. SharkSSL will copy at most maxLen bytes to 'buf'.

Example:

for(;;)
{
   switch (SharkSslCon_decrypt(s, (U16)readLen))
   {
      case SharkSslCon_Decrypted:
         readLen = SharkSslCon_copyDecData(s, buf, maxLen);
         // decrypted readLen bytes
         if (SharkSslCon_decryptMore(s))
         {
            if ((readLen == 0) && (maxLen > 0))
            {
               break; // zero-length record, decrypt next one
            }
         }
         return readLen;

      // other cases not shown here

See also:

SharkSslCon_getDecData

Decrypt the received data copied into the SharkSslCon receive buffer (the buffer returned by SharkSslCon_getBuf).

See SharkSslCon_RetVal for example code.

The SharkSslCon_decrypt function keeps decrypt state information in the SharkSslCon object and the function can therefore be used in event driven systems.

Parameters:

o	the SharkSslCon object returned by function SharkSsl_createCon.
readLen	the length of the received network data copied into the buffer returned by SharkSslCon_getBuf.

Returns:

the decrypt state information SharkSslCon_RetVal.

See also:

SharkSslCon_getBuf, SharkSslCon_getBufLen, SharkSslCon_encrypt

This function is used in conjunction with state SharkSslCon_Decrypted returned by function SharkSslCon_decrypt.

The function returns TRUE if a complete SSL frame has been decrypted and is ready for consumption. See SharkSslCon_Decrypted for example code.

Encrypt the data provided by parameter 'buf' or encrypt data in the SharkSslCon send buffer.

SharkSSL provides a zero copy API and you can optionally copy data directly to the SharkSslCon send buffer. The send buffer is returned by calling function SharkSslCon_getEncBufPtr.

The SharkSslCon_encrypt function keeps decrypt state information in the SharkSslCon object and the function can therefore be used in event driven systems.

Parameters:

o	the SharkSslCon object returned by function SharkSsl_createCon.
buf	the data to be encrypted or NULL when encrypting data copied directly to the SharkSslCon send buffer i.e. when copying the data to the pointer returned by function SharkSslCon_getEncBufPtr.
maxLen	is the length of 'buf' or the length of the data data copied directly to the SharkSslCon send buffer.

Returns:

the decrypt state information SharkSslCon_RetVal.

See also:

SharkSslCon_getEncBufPtr, SharkSslCon_getEncBufSize, SharkSslCon_decrypt

This function is used in conjunction with state SharkSslCon_Encrypted returned by function SharkSslCon_encrypt.

The function returns TRUE if the SharkSslCon send buffer is full and must be flushed out.

The maximum size of the output buffer is set with parameter 'outBufSize' when calling the SharkSsl_constructor. When the unencrypted buffer is larger than what fits into the internal output buffer, SharkSSL breaks the unencrypted data into multiple chunks and SharkSslCon_encryptMore lets the application know when the buffer must be flushed.

See SharkSslCon_Encrypted for example code.

This function is used in conjunction with state SharkSslCon_AlertSend returned by function SharkSslCon_encrypt or in conjunction with state SharkSslCon_AlertRecv returned by function SharkSslCon_decrypt.

returns the [SSL/TLS alert message](SSL/TLS Alert Messages)

See also:

SharkSslCon_getAlertLevel and SharkSslCon_getAlertData

This function is used in conjunction with state SharkSslCon_AlertSend returned by function SharkSslCon_encrypt or in conjunction with state SharkSslCon_AlertRecv returned by function SharkSslCon_decrypt.

Returns:

SHARKSSL_ALERT_LEVEL_WARNING or SHARKSSL_ALERT_LEVEL_FATAL

See also:

SharkSslCon_getAlertDescription and SharkSslCon_getAlertData

Returns a pointer to the SharkSslCon input/receive buffer.

The pointer returned by SharkSslCon_getBuf is where you copy the encrypted data you receive from the network.

Example code:

   readLen = recv(mysocket, SharkSslCon_getBuf(s),SharkSslCon_getBufLen(s), 0);

See also:

SharkSslCon_getBufLen and SharkSslCon_getDecData

Returns the length of the SharkSslCon input buffer.

The buffer is internally managed by SharkSSL and may dynamically grow as large as 16Kbytes. The SharkSslCon input buffer start size is set with parameter inBufStartSize when calling the SharkSsl_constructor.

Many ciphers are block based and the receiving end must read the complete block before it can be decrypted. The SSL/TLS specification enables blocks up to 16K in size. Note, the block will not be larger than the size of the packet sent by the peer side.

See also:

SharkSslCon_getBuf

Get a pointer to the decoded data.

See SharkSslCon_Decrypted for example code.

Parameters:

o	the SharkSslCon object returned by function SharkSsl_createCon.
bufPtr	is set to the beginning of the decoded data.

Returns:

Number of bytes decoded.

See also:

SharkSslCon_copyDecData

This function is used in conjunction with SharkSslCon_encrypt when using the zero copy send API.

Returns:

a pointer to the internal SharkSslCon send buffer.

See also:

SharkSslCon_getEncBufSize.

Returns the length of the buffer returned by SharkSslCon_getEncBufPtr.

This function is used in conjunction with state SharkSslCon_Encrypted returned by function SharkSslCon_encrypt.

The function returns a pointer to the encoded data that must be sent to the peer side.

See also:

SharkSslCon_getEncDataLen and SharkSslCon_encryptMore

This function is used in conjunction with state SharkSslCon_Encrypted returned by function SharkSslCon_encrypt.

The function returns the length of the encoded data that must be sent to the peer side.

See SharkSslCon_Encrypted for example code.

See also:

SharkSslCon_getEncData and SharkSslCon_encryptMore

This function is used in conjunction with state SharkSslCon_Handshake returned by function SharkSslCon_encrypt.

The function returns the handshake data that must be sent to the peer side, if any.

See SharkSslCon_Handshake for example code.

See also:

SharkSslCon_getHandshakeDataLen

This function is used in conjunction with state SharkSslCon_Handshake returned by function SharkSslCon_decrypt.

The function returns the length of the handshake data that must be sent to the peer side, if any. The function returns zero if no handshake data should be sent.

See SharkSslCon_Handshake for example code.

See also:

SharkSslCon_getHandshakeData

Returns TRUE if the SSL handshake phase is completed.

See state SharkSslCon_Handshake for example code.