Ekt

Managing Ekt. More...

Typedefs
typedef struct _LinphoneEktInfo	LinphoneEktInfo
	Object representing all informations present in an Encrypted Key Transport event.

Functions
const LinphoneEktInfo *	linphone_core_create_ekt_info_from_xml (const LinphoneCore *core, const char *xml_body)
	Gets a LinphoneEktInfo from an XML body. More...
MS2_DEPRECATED char *	linphone_core_create_xml_from_ekt_info (const LinphoneCore *core, const LinphoneEktInfo *ekt_info)
	Gets an XML body. More...
char *	linphone_core_create_xml_from_ekt_info_2 (const LinphoneCore *core, const LinphoneEktInfo *ekt_info, const LinphoneAccount *account)
	Gets an XML body using a specific account. More...
bool_t	linphone_core_is_ekt_plugin_loaded (const LinphoneCore *core)
	Gets if the EKT plugin is currently loaded in the Linphone core instance. More...
void	linphone_core_set_ekt_plugin_loaded (LinphoneCore *core, bool_t ekt_plugin_loaded)
	sets the state of the EKT plugin in the Linphone core instance. More...
LinphoneEktInfo *	linphone_ekt_info_ref (LinphoneEktInfo *linphone_ekt_info)
	Take a reference on a LinphoneEktInfo. More...
void	linphone_ekt_info_unref (LinphoneEktInfo *linphone_ekt_info)
	Release a LinphoneEktInfo. More...
const LinphoneAddress *	linphone_ekt_info_get_from_address (const LinphoneEktInfo *linphone_ekt_info)
	Get from address. More...
void	linphone_ekt_info_set_from_address (LinphoneEktInfo *linphone_ekt_info, const LinphoneAddress *from)
	Set from address. More...
uint16_t	linphone_ekt_info_get_sspi (const LinphoneEktInfo *linphone_ekt_info)
	Get sSPI. More...
void	linphone_ekt_info_set_sspi (LinphoneEktInfo *linphone_ekt_info, uint16_t sspi)
	Set sSPI. More...
LinphoneBuffer *	linphone_ekt_info_get_cspi (const LinphoneEktInfo *linphone_ekt_info)
	Get cSPI. More...
void	linphone_ekt_info_set_cspi (LinphoneEktInfo *linphone_ekt_info, const LinphoneBuffer *cspi)
	Set cSPI. More...
LinphoneDictionary *	linphone_ekt_info_get_ciphers (const LinphoneEktInfo *linphone_ekt_info)
	Get ciphers. More...
void	linphone_ekt_info_set_ciphers (LinphoneEktInfo *linphone_ekt_info, LinphoneDictionary *ciphers)
	Set ciphers. More...
void	linphone_ekt_info_add_cipher (LinphoneEktInfo *linphone_ekt_info, const char *to, const LinphoneBuffer *cipher)
	Add a cipher to the chipher map. More...

Detailed Description

Managing Ekt.

Function Documentation

linphone_core_create_ekt_info_from_xml()

const LinphoneEktInfo* linphone_core_create_ekt_info_from_xml	(	const LinphoneCore *	core,
		const char *	xml_body
	)

Gets a LinphoneEktInfo from an XML body.

Parameters

core	the LinphoneCore
xml_body	the string containing the XML body

Returns

The LinphoneEktInfo

linphone_core_create_xml_from_ekt_info()

MS2_DEPRECATED char* linphone_core_create_xml_from_ekt_info	(	const LinphoneCore *	core,
		const LinphoneEktInfo *	ekt_info
	)

Gets an XML body.

Parameters

core	the LinphoneCore
ekt_info	the LinphoneEktInfo

Returns

The XML body

Deprecated:

06/02/2025 use linphone_core_create_xml_from_ekt_info_2().

linphone_core_create_xml_from_ekt_info_2()

char* linphone_core_create_xml_from_ekt_info_2	(	const LinphoneCore *	core,
		const LinphoneEktInfo *	ekt_info,
		const LinphoneAccount *	account
	)

Gets an XML body using a specific account.

Parameters

core	the LinphoneCore
ekt_info	the LinphoneEktInfo
account	the LinphoneAccount associated with the conference

Returns

The XML body

linphone_core_is_ekt_plugin_loaded()

bool_t linphone_core_is_ekt_plugin_loaded

(

const LinphoneCore *

core

)

Gets if the EKT plugin is currently loaded in the Linphone core instance.

Parameters

core	the LinphoneCore

Returns

true if the EKT plugin is loaded

linphone_core_set_ekt_plugin_loaded()

void linphone_core_set_ekt_plugin_loaded	(	LinphoneCore *	core,
		bool_t	ekt_plugin_loaded
	)

sets the state of the EKT plugin in the Linphone core instance.

Parameters

core	the LinphoneCore
ekt_plugin_loaded	whether the EKT plugin is loaded or not

linphone_ekt_info_add_cipher()

void linphone_ekt_info_add_cipher	(	LinphoneEktInfo *	linphone_ekt_info,
		const char *	to,
		const LinphoneBuffer *	cipher
	)

Add a cipher to the chipher map.

Parameters

linphone_ekt_info	the LinphoneEktInfo.
to	the address to set.
cipher	the cipher to set.

linphone_ekt_info_get_ciphers()

LinphoneDictionary* linphone_ekt_info_get_ciphers

(

const LinphoneEktInfo *

linphone_ekt_info

)

Get ciphers.

Parameters

linphone_ekt_info

the LinphoneEktInfo.

Returns

a LinphoneDictionary object.

linphone_ekt_info_get_cspi()

LinphoneBuffer* linphone_ekt_info_get_cspi

(

const LinphoneEktInfo *

linphone_ekt_info

)

Get cSPI.

Parameters

linphone_ekt_info

the LinphoneEktInfo.

Returns

a LinphoneAddress object.

linphone_ekt_info_get_from_address()

const LinphoneAddress* linphone_ekt_info_get_from_address

(

const LinphoneEktInfo *

linphone_ekt_info

)

Get from address.

Parameters

linphone_ekt_info

the LinphoneEktInfo.

Returns

a LinphoneAddress object.

linphone_ekt_info_get_sspi()

uint16_t linphone_ekt_info_get_sspi

(

const LinphoneEktInfo *

linphone_ekt_info

)

Get sSPI.

Parameters

linphone_ekt_info

the LinphoneEktInfo.

Returns

a 16-bits unsigned int representing the sSPI.

linphone_ekt_info_ref()

LinphoneEktInfo* linphone_ekt_info_ref

(

LinphoneEktInfo *

linphone_ekt_info

)

Take a reference on a LinphoneEktInfo.

Parameters

linphone_ekt_info

The LinphoneEktInfo object.

Returns

the same LinphoneEktInfo object.

linphone_ekt_info_set_ciphers()

void linphone_ekt_info_set_ciphers	(	LinphoneEktInfo *	linphone_ekt_info,
		LinphoneDictionary *	ciphers
	)

Set ciphers.

Parameters

linphone_ekt_info	the LinphoneEktInfo.
ciphers	the ciphers to set.

linphone_ekt_info_set_cspi()

void linphone_ekt_info_set_cspi	(	LinphoneEktInfo *	linphone_ekt_info,
		const LinphoneBuffer *	cspi
	)

Set cSPI.

Parameters

linphone_ekt_info	the LinphoneEktInfo.
cspi	the address to set.

linphone_ekt_info_set_from_address()

void linphone_ekt_info_set_from_address	(	LinphoneEktInfo *	linphone_ekt_info,
		const LinphoneAddress *	from
	)

Set from address.

Parameters

linphone_ekt_info	the LinphoneEktInfo.
from	the address to set.

linphone_ekt_info_set_sspi()

void linphone_ekt_info_set_sspi	(	LinphoneEktInfo *	linphone_ekt_info,
		uint16_t	sspi
	)

Set sSPI.

Parameters

linphone_ekt_info	the LinphoneEktInfo.
sspi	the sspi to set.

linphone_ekt_info_unref()

void linphone_ekt_info_unref

(

LinphoneEktInfo *

linphone_ekt_info

)

Release a LinphoneEktInfo.

Parameters

linphone_ekt_info

The LinphoneEktInfo object.