sipxtacklib  Version 3.3
Public Member Functions | Friends | List of all members
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_ATTRIBUTESoperator= (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...
 

Friends

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

Detailed Description

Container class for security attributes.

Constructor & Destructor Documentation

Constructor.

Copy constructor.

virtual ~SIPX_SECURITY_ATTRIBUTES ( )
inlinevirtual

Destructor.

Member Function Documentation

SIPX_SECURITY_ATTRIBUTES& operator= ( const SIPX_SECURITY_ATTRIBUTES ref)
inline

Assignment operator.

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.

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 setSecurityLevel ( SIPX_SRTP_LEVEL  security)
inline

Sets the S/MIME & SRTP security level.

const char* getSrtpKey ( ) const
inline

Gets the symmetric SRTP key.

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 getSrtpKeyLength ( ) const
inline

Gets the symmetric SRTP key length.

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 int getSecurityLevel ( ) const
inline

Sets the S/MIME & SRTP security level.

const char* 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.


sipXtackLib home page