ClientSecurity Class Reference

Description

Defines Client Security object with security-params and methods.

Public Member Functions
	ClientSecurity ()
	ClientSecurity Constructor with no params.
	ClientSecurity (ClientSecurityType type)
	ClientSecurity Constructor with single param.
void	set_type (ClientSecurityType t)
	Sets the security type.
cy_rslt_t	set_user_id_password (const char *user_id, const char *password)
	Set User-ID and password as SecurityParams. More...
cy_rslt_t	set_tls_params (const char *client_name, const char *private_key, const char *certificate)
	Set TLS as SecurityParams. More...
cy_rslt_t	set_tls_params (const char *client_name)
	Set TLS as SecurityParams. More...
cy_rslt_t	set_tls_root_certificate (const char *root_cert)
	Set TLS Root-Certificate to the object. More...
ClientSecurityType	get_type (void)
	Return Security-type associated with the object. More...
const char *	get_username (void)
	Return user-id(user-id) associated with the object. More...
const char *	get_password (void)
	Return password associated with the object. More...
const char *	get_tls_client_name (void)
	Return TLS Client-name. More...
const char *	get_device_key (void)
	Return Private Device-key in use. More...
const char *	get_device_certificate (void)
	Return Device certificate. More...
const char *	get_tls_root_certificate (void)
	Return TLS root certificate. More...

Member Function Documentation

set_user_id_password()

cy_rslt_t ClientSecurity::set_user_id_password	(	const char *	user_id,
		const char *	password
	)

Set User-ID and password as SecurityParams.

Parameters

[in]	user_id	: User identification
[in]	password	: User password

Returns

cy_rslt_t : CY_RSLT_SUCCESS - on success, CY_RESULT_MW_ERROR otherwise

set_tls_params() [1/2]

cy_rslt_t ClientSecurity::set_tls_params	(	const char *	client_name,
		const char *	private_key,
		const char *	certificate
	)

Set TLS as SecurityParams.

Parameters

[in]	client_name	: Name of the device/client to be used for TLS negotiation
[in]	private_key	: Null-Terminated Private key string
[in]	certificate	: Null-Terminated Device/Client Certificate

Returns

cy_rslt_t : CY_RSLT_SUCCESS - on success, CY_RESULT_MW_ERROR otherwise

set_tls_params() [2/2]

cy_rslt_t ClientSecurity::set_tls_params

(

const char *

client_name

)

Set TLS as SecurityParams.

Parameters

[in]

client_name

: Name of the device/client to be used for TLS negotiation

Returns

cy_rslt_t : CY_RSLT_SUCCESS - on success, CY_RESULT_MW_ERROR otherwise

set_tls_root_certificate()

cy_rslt_t ClientSecurity::set_tls_root_certificate

(

const char *

root_cert

)

Set TLS Root-Certificate to the object.

Parameters

[in]

root_cert

: NULL-terminated root-certificate

Returns

cy_rslt_t : CY_RSLT_SUCCESS - on success, CY_RESULT_MW_ERROR otherwise

get_type()

ClientSecurityType ClientSecurity::get_type ( void  )

inline

Return Security-type associated with the object.

Returns

ClientSecurityType

get_username()

const char* ClientSecurity::get_username ( void  )

inline

Return user-id(user-id) associated with the object.

Returns

NULL if invalid object, else return Null-terminated user-id string

get_password()

const char* ClientSecurity::get_password ( void  )

inline

Return password associated with the object.

Returns

NULL if invalid object, else return Null-terminated password string

get_tls_client_name()

const char* ClientSecurity::get_tls_client_name ( void  )

inline

Return TLS Client-name.

Returns

NULL if invalid object, else return Null-terminated client-name

get_device_key()

const char* ClientSecurity::get_device_key ( void  )

inline

Return Private Device-key in use.

Returns

NULL if invalid object, else return Null-terminated Device-key

get_device_certificate()

const char* ClientSecurity::get_device_certificate ( void  )

inline

Return Device certificate.

Returns

NULL if invalid object, else return Null-terminated Device-certificate

get_tls_root_certificate()

const char* ClientSecurity::get_tls_root_certificate ( void  )

inline

Return TLS root certificate.

Returns

NULL if invalid object, else return Null-terminated root-certificate