Liblinphone 5.4.23
Ekt

Managing Ekt. More...

Typedefs

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

Functions

const LinphoneEktInfolinphone_core_create_ekt_info_from_xml (const LinphoneCore *core, const char *xml_body)
 Gets a LinphoneEktInfo from an XML body.
MS2_DEPRECATED char * linphone_core_create_xml_from_ekt_info (const LinphoneCore *core, const LinphoneEktInfo *ekt_info)
 Gets an XML body.
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.
bool_t linphone_core_is_ekt_plugin_loaded (const LinphoneCore *core)
 Gets if the EKT plugin is currently loaded in the Linphone core instance.
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.
LinphoneEktInfolinphone_ekt_info_ref (LinphoneEktInfo *linphone_ekt_info)
 Take a reference on a LinphoneEktInfo.
void linphone_ekt_info_unref (LinphoneEktInfo *linphone_ekt_info)
 Release a LinphoneEktInfo.
const LinphoneAddresslinphone_ekt_info_get_from_address (const LinphoneEktInfo *linphone_ekt_info)
 Get from address.
void linphone_ekt_info_set_from_address (LinphoneEktInfo *linphone_ekt_info, const LinphoneAddress *from)
 Set from address.
uint16_t linphone_ekt_info_get_sspi (const LinphoneEktInfo *linphone_ekt_info)
 Get sSPI.
void linphone_ekt_info_set_sspi (LinphoneEktInfo *linphone_ekt_info, uint16_t sspi)
 Set sSPI.
LinphoneBufferlinphone_ekt_info_get_cspi (const LinphoneEktInfo *linphone_ekt_info)
 Get cSPI.
void linphone_ekt_info_set_cspi (LinphoneEktInfo *linphone_ekt_info, const LinphoneBuffer *cspi)
 Set cSPI.
LinphoneDictionarylinphone_ekt_info_get_ciphers (const LinphoneEktInfo *linphone_ekt_info)
 Get ciphers.
void linphone_ekt_info_set_ciphers (LinphoneEktInfo *linphone_ekt_info, LinphoneDictionary *ciphers)
 Set ciphers.
void linphone_ekt_info_add_cipher (LinphoneEktInfo *linphone_ekt_info, const char *to, const LinphoneBuffer *cipher)
 Add a cipher to the chipher map.

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
corethe LinphoneCore
xml_bodythe 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
corethe LinphoneCore
ekt_infothe 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
corethe LinphoneCore
ekt_infothe LinphoneEktInfo
accountthe 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
corethe 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
corethe LinphoneCore
ekt_plugin_loadedwhether 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_infothe LinphoneEktInfo.
tothe address to set.
cipherthe cipher to set.

◆ linphone_ekt_info_get_ciphers()

LinphoneDictionary * linphone_ekt_info_get_ciphers ( const LinphoneEktInfo * linphone_ekt_info)

Get ciphers.

Parameters
linphone_ekt_infothe 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_infothe 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_infothe 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_infothe 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_infoThe 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_infothe LinphoneEktInfo.
ciphersthe 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_infothe LinphoneEktInfo.
cspithe 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_infothe LinphoneEktInfo.
fromthe 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_infothe LinphoneEktInfo.
sspithe sspi to set.

◆ linphone_ekt_info_unref()

void linphone_ekt_info_unref ( LinphoneEktInfo * linphone_ekt_info)

Release a LinphoneEktInfo.

Parameters
linphone_ekt_infoThe LinphoneEktInfo object.