SIPX_SECURITY_ATTRIBUTES Class Reference

Container class for security attributes. More...

#include <sipXtapi.h>

Public Member Functions
	SIPX_SECURITY_ATTRIBUTES ()
	Constructor. More...
	SIPX_SECURITY_ATTRIBUTES (const SIPX_SECURITY_ATTRIBUTES &ref)
	Copy constructor. More...
virtual	~SIPX_SECURITY_ATTRIBUTES ()
	Destructor. More...
SIPX_SECURITY_ATTRIBUTES &	operator= (const SIPX_SECURITY_ATTRIBUTES &ref)
	Assignment operator. More...
void	setSrtpKey (const char *szKey, const int length)
	Sets the symmetric SRTP key. More...
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. More...
void	setSecurityLevel (SIPX_SRTP_LEVEL security)
	Sets the S/MIME & SRTP security level. More...
const char *	getSrtpKey () const
	Gets the symmetric SRTP key. More...
const char *	getSmimeKey () const
	Gets the public key of the remote party, which is used to encrypt the S/MIME container for the SDP. More...
const int	getSrtpKeyLength () const
	Gets the symmetric SRTP key length. More...
const int	getSmimeKeyLength () const
	Gets the public key of the remote party, which is used to encrypt the S/MIME container for the SDP. More...
const int	getSecurityLevel () const
	Sets the S/MIME & SRTP security level. More...
const char *	getCertDbLocation () const
	Gets the Certificate Database location (set internally to the location specified in the call to sipxConfigSetSecurityParameters() ) More...

Private Member Functions
void	copyData (const SIPX_SECURITY_ATTRIBUTES &ref)

Private Attributes
SIPX_SRTP_LEVEL	nSrtpLevel
char	szSrtpKey [MAX_SRTP_KEY_LENGTH]
int	nSrtpKeyLength
char	szSmimeKeyDer [MAX_SMIME_KEY_LENGTH]
int	nSmimeKeyLength
char	dbLocation [256]
char	szMyCertNickname [32]
char	szCertDbPassword [MAX_PASSWORD_LENGTH]

Friends
class	SecurityHelper
	The security help can set private values of this class. More...

Detailed Description

Container class for security attributes.

Constructor & Destructor Documentation

SIPX_SECURITY_ATTRIBUTES ( )

inline

Constructor.

SIPX_SECURITY_ATTRIBUTES ( const SIPX_SECURITY_ATTRIBUTES &  ref )

inline

Copy constructor.

virtual ~SIPX_SECURITY_ATTRIBUTES ( )

inlinevirtual

Destructor.

Member Function Documentation

void copyData ( const SIPX_SECURITY_ATTRIBUTES &  ref )

inlineprivate

const char* getCertDbLocation ( ) const

inline

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

const int getSecurityLevel ( ) const

inline

Sets the S/MIME & SRTP security level.

const char* 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 getSmimeKeyLength ( ) const

inline

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

const char* getSrtpKey ( ) const

inline

Gets the symmetric SRTP key.

const int getSrtpKeyLength ( ) const

inline

Gets the symmetric SRTP key length.

SIPX_SECURITY_ATTRIBUTES& operator= ( const SIPX_SECURITY_ATTRIBUTES &  ref )

inline

Assignment operator.

void setSecurityLevel ( SIPX_SRTP_LEVEL  security )

inline

Sets the S/MIME & SRTP security level.

void 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 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.

Friends And Related Function Documentation

friend class SecurityHelper

friend

The security help can set private values of this class.

Member Data Documentation

char dbLocation[256]

private

int nSmimeKeyLength

private

int nSrtpKeyLength

private

SIPX_SRTP_LEVEL nSrtpLevel

private

char szCertDbPassword[MAX_PASSWORD_LENGTH]

private

char szMyCertNickname[32]

private

char szSmimeKeyDer[MAX_SMIME_KEY_LENGTH]

private

char szSrtpKey[MAX_SRTP_KEY_LENGTH]

private