SIPX_SECURITY_ATTRIBUTES Class Reference

#include <sipXtapi.h>

---

Detailed Description

Container class for security attributes.

Public Member Functions
	SIPX_SECURITY_ATTRIBUTES ()
	Constructor.
	SIPX_SECURITY_ATTRIBUTES (const SIPX_SECURITY_ATTRIBUTES &ref)
	Copy constructor.
virtual	~SIPX_SECURITY_ATTRIBUTES ()
	Destructor.
SIPX_SECURITY_ATTRIBUTES &	operator= (const SIPX_SECURITY_ATTRIBUTES &ref)
	Assignment operator.
void	setSrtpKey (const char *szKey, const int length)
	Sets the symmetric srtp key.
void	setSmimeKey (const char *szKey, const int length)
	Sets the public key of the remote party, which is used to encrypt the S/MIME container for the SDP.
void	setSecurityLevel (SIPX_SRTP_LEVEL security)
	Sets the S/MIME & SRTP security level.
const char *	getSrtpKey () const
	Gets the symmetric srtp key.
const char *	getSmimeKey () const
	Gets the public key of the remote party, which is used to encrypt the S/MIME container for the SDP.
const int	getSrtpKeyLength () const
	Gets the symmetric srtp key length.
const int	getSmimeKeyLength () const
	Gets the public key of the remote party, which is used to encrypt the S/MIME container for the SDP.
const int	getSecurityLevel () const
	Sets the S/MIME & SRTP security level.
const char *	getCertDbLocation () const
	Gets the Certificate Database location (set internally to the location specified in the call to sipxConfigSetSecurityParameters() ).
Friends
class	SecurityHelper
	The security help can set private values of this class.

---

Constructor & Destructor Documentation

SIPX_SECURITY_ATTRIBUTES::SIPX_SECURITY_ATTRIBUTES

(

)

[inline]

Constructor.

SIPX_SECURITY_ATTRIBUTES::SIPX_SECURITY_ATTRIBUTES

(

const SIPX_SECURITY_ATTRIBUTES &

ref

)

[inline]

Copy constructor.

virtual SIPX_SECURITY_ATTRIBUTES::~SIPX_SECURITY_ATTRIBUTES

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

SIPX_SECURITY_ATTRIBUTES& SIPX_SECURITY_ATTRIBUTES::operator=

(

const SIPX_SECURITY_ATTRIBUTES &

ref

)

[inline]

Assignment operator.

void SIPX_SECURITY_ATTRIBUTES::setSrtpKey	(	const char *	szKey,
		const int	length
	)			[inline]

Sets the symmetric srtp key.

If this is not supplied by the user, sipXtapi will generate a random key.

void SIPX_SECURITY_ATTRIBUTES::setSmimeKey	(	const char *	szKey,
		const int	length
	)			[inline]

Sets the public key of the remote party, which is used to encrypt the S/MIME container for the SDP.

void SIPX_SECURITY_ATTRIBUTES::setSecurityLevel

(

SIPX_SRTP_LEVEL

security

)

[inline]

Sets the S/MIME & SRTP security level.

const char* SIPX_SECURITY_ATTRIBUTES::getSrtpKey

(

)

const [inline]

Gets the symmetric srtp key.

const char* SIPX_SECURITY_ATTRIBUTES::getSmimeKey

(

)

const [inline]

Gets the public key of the remote party, which is used to encrypt the S/MIME container for the SDP.

const int SIPX_SECURITY_ATTRIBUTES::getSrtpKeyLength

(

)

const [inline]

Gets the symmetric srtp key length.

const int SIPX_SECURITY_ATTRIBUTES::getSmimeKeyLength

(

)

const [inline]

Gets the public key of the remote party, which is used to encrypt the S/MIME container for the SDP.

const int SIPX_SECURITY_ATTRIBUTES::getSecurityLevel

(

)

const [inline]

Sets the S/MIME & SRTP security level.

const char* SIPX_SECURITY_ATTRIBUTES::getCertDbLocation

(

)

const [inline]

Gets the Certificate Database location (set internally to the location specified in the call to sipxConfigSetSecurityParameters() ).

---

Friends And Related Function Documentation

friend class SecurityHelper [friend]

The security help can set private values of this class.

---

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

• sipXtapi.h

---