SIPX_SECURITY_INFO Struct Reference

#include <sipXtapiEvents.h>

---

Detailed Description

An SIPX_SECURITY_INFO event informs that application layer of the status of a security operation.

This information is passed as part of the sipXtapi callback mechanism. Based on the SIPX_EVENT_CATEGORY, the application developer should cast the pInfo member of your callback to the appropriate structure.

See also:

SIPX_EVENT_CALLBACK_PROC

SIPX_EVENT_CATEGORY

Data Fields
size_t	nSize
	the size of this structure in bytes
char *	szSRTPkey
	the negotiated SRTP key, if any.
void *	pCertificate
	pointer to the certificate blob that was used to encrypt and/or sign.
int	nCertificateSize
	size of the certificate blob
SIPX_SECURITY_EVENT	event
	Event code for this SECURITY_INFO message.
SIPX_SECURITY_CAUSE	cause
	Cause code for this SECURITY_INFO message.
char *	szSubjAltName
	Populated for SECURITY_CAUSE_SIGNATURE_NOTIFY.
char *	callId
	Points to a call-id string associated with the event.
SIPX_CALL	hCall
	A call handle associated with the event.
char *	remoteAddress
	A remote address associated with the event.

---

Field Documentation

size_t SIPX_SECURITY_INFO::nSize

the size of this structure in bytes

char* SIPX_SECURITY_INFO::szSRTPkey

the negotiated SRTP key, if any.

void* SIPX_SECURITY_INFO::pCertificate

pointer to the certificate blob that was used to encrypt and/or sign.

int SIPX_SECURITY_INFO::nCertificateSize

size of the certificate blob

SIPX_SECURITY_EVENT SIPX_SECURITY_INFO::event

Event code for this SECURITY_INFO message.

SIPX_SECURITY_CAUSE SIPX_SECURITY_INFO::cause

Cause code for this SECURITY_INFO message.

char* SIPX_SECURITY_INFO::szSubjAltName

Populated for SECURITY_CAUSE_SIGNATURE_NOTIFY.

char* SIPX_SECURITY_INFO::callId

Points to a call-id string associated with the event.

Can be NULL.

SIPX_CALL SIPX_SECURITY_INFO::hCall

A call handle associated with the event.

Can be 0, to signify that the event is not associated with a call.

char* SIPX_SECURITY_INFO::remoteAddress

A remote address associated with the event.

Can be NULL.

---

The documentation for this struct was generated from the following file:

• sipXtapiEvents.h

---