NSSLGetCipherInfo

Syntax

#include <cafe.h>
#include <cafe/nssl/nsslclient.h>

NSSL_RVAL NSSLGetCipherInfo(NSSLConnectionHandle connection,
                            char* pVersionBuf, int versionBufLen,
                            char* pNameBuf, int nameBufLen,
                            int *pBits);

Parameters

connection A handle to a SSL connection to be queried.
pVersionBuf A pointer to hold the cipher version (memory for the buffer to be allocated by the application). On completion contains a null-terminated cipher version. The buffer size and address should be aligned to NSSL_IO_BUFFER_ALIGN.
versionBufLen Length of input pVersionBuf.
pNameBuf A pointer to hold the cipher name (memory for the buffer to be allocated by the application). On completion contains a null-terminated cipher name. The buffer size and address should be aligned to NSSL_IO_BUFFER_ALIGN.
nameBufLen Length of input pNameBuf.
pBits A pointer to hold the count of secret bits used for the cipher.

Return Values

NSSL_RVAL NSSL_RVAL_OK upon success, error code of type NSSL_RVAL on failure.

Description

Get details of the cipher being used for the SSL connection.

Do Not Call From

Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.

Revision History

2012/08/16 Cleanup pass.
2012/04/06 Initial version.


CONFIDENTIAL