reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | Friends | List of all members
reTurn::ReTurnConfig Class Reference

#include <ReTurnConfig.hxx>

Inheritance diagram for reTurn::ReTurnConfig:
[legend]

Classes

class  Exception
 

Public Types

enum  AccountState { AUTHORIZED , RESTRICTED , REFUSED }
 
- Public Types inherited from resip::ConfigParse
typedef HashMap< int, NestedConfigParse > NestedConfigMap
 

Public Member Functions

 ReTurnConfig ()
 
virtual ~ReTurnConfig ()
 
virtual void parseConfig (int argc, char **argv, const resip::Data &defaultConfigFilename)
 
void printHelpText (int argc, char **argv)
 
bool isUserNameValid (const resip::Data &username, const resip::Data &realm) const
 
resip::Data getHa1ForUsername (const resip::Data &username, const resip::Data &realm) const
 
std::unique_ptr< UserAuthData > getUser (const resip::Data &userName, const resip::Data &realm) const
 
void addUser (const resip::Data &username, const resip::Data &password, const resip::Data &realm)
 
void authParse (const resip::Data &accountDatabaseFilename)
 
- Public Member Functions inherited from resip::ConfigParse
 ConfigParse ()
 
virtual ~ConfigParse ()
 
virtual void parseConfig (int argc, char **argv, const resip::Data &defaultConfigFilename, int skipCount)
 
virtual void parseCommandLine (int argc, char **argv, int skipCount=0)
 
virtual void parseConfigFile (const resip::Data &filename)
 
void getConfigIndexKeys (const resip::Data &indexName, std::set< resip::Data > &keys) const
 
bool getConfigValue (const resip::Data &name, resip::Data &value) const
 
resip::Data getConfigData (const resip::Data &name, const resip::Data &defaultValue, bool useDefaultIfEmpty=false) const
 
bool getConfigValue (const resip::Data &name, bool &value) const
 
bool getConfigBool (const resip::Data &name, bool defaultValue) const
 
bool getConfigValue (const resip::Data &name, unsigned long &value) const
 
unsigned long getConfigUnsignedLong (const resip::Data &name, unsigned long defaultValue) const
 
bool getConfigValue (const resip::Data &name, int &value) const
 
int getConfigInt (const resip::Data &name, int defaultValue) const
 
bool getConfigValue (const resip::Data &name, unsigned short &value) const
 
unsigned short getConfigUnsignedShort (const resip::Data &name, int defaultValue) const
 
bool getConfigValue (const resip::Data &name, std::vector< resip::Data > &value) const
 
bool getConfigValue (const resip::Data &name, std::vector< int > &value) const
 
bool getConfigValue (const resip::Data &name, std::set< resip::Data > &value) const
 
NestedConfigMap getConfigNested (const resip::Data &mapsPrefix) const
 
bool AddBasePathIfRequired (Data &filename) const
 
void insertConfigValue (const resip::Data &name, const resip::Data &value)
 

Public Attributes

resip::Data mSoftwareName
 
bool mPadSoftwareName
 
unsigned short mTurnPort
 
unsigned short mTlsTurnPort
 
unsigned short mAltStunPort
 
asio::ip::address mTurnAddress
 
asio::ip::address mTurnV6Address
 
asio::ip::address mAltStunAddress
 
resip::Data mAuthenticationRealm
 
int mUserDatabaseCheckInterval
 
resip::RWMutex mUserDataMutex
 
unsigned long mNonceLifetime
 
unsigned short mAllocationPortRangeMin
 
unsigned short mAllocationPortRangeMax
 
unsigned long mDefaultAllocationLifetime
 
unsigned long mMaxAllocationLifetime
 
unsigned long mMaxAllocationsPerUser
 
resip::Data mTlsServerCertificateFilename
 
resip::Data mTlsServerPrivateKeyFilename
 
resip::Data mTlsTempDhFilename
 
resip::Data mTlsPrivateKeyPassword
 
unsigned long mTlsHandshakeTimeout
 
unsigned long mTcpConnectionIdleTimeout
 
unsigned long mMaxTcpConnectionsPerIp
 
long mOpenSSLCTXSetOptions
 
long mOpenSSLCTXClearOptions
 
resip::Data mUsersDatabaseFilename
 
bool mUserDatabaseHashedPasswords
 
bool mDaemonize
 
resip::Data mPidFile
 
resip::Data mRunAsUser
 
resip::Data mRunAsGroup
 

Friends

class ReTurnUserFileScanner
 

Additional Inherited Members

- Protected Types inherited from resip::ConfigParse
typedef HashMultiMap< resip::Data, resip::Data > ConfigValuesMap
 
- Protected Member Functions inherited from resip::ConfigParse
template<typename T >
bool translateConfigValue (const std::map< T, resip::Data > dict, const resip::Data &name, T &value) const
 
void insertConfigValue (const Data &source, ConfigValuesMap &configValues, const resip::Data &name, const resip::Data &value)
 
resip::Data removePath (const resip::Data &fileAndPath) const
 
- Protected Attributes inherited from resip::ConfigParse
ConfigValuesMap mCmdLineConfigValues
 
ConfigValuesMap mFileConfigValues
 
ConfigValuesMap mConfigValues
 
resip::Data mCmdLineConfigFilename
 
resip::Data mConfigBasePath
 

Detailed Description

Definition at line 23 of file ReTurnConfig.hxx.

Member Enumeration Documentation

◆ AccountState

enum reTurn::ReTurnConfig::AccountState
Enumerator
AUTHORIZED 
RESTRICTED 
REFUSED 

Definition at line 45 of file ReTurnConfig.hxx.

Constructor & Destructor Documentation

◆ ReTurnConfig()

reTurn::ReTurnConfig::ReTurnConfig ( )

Definition at line 44 of file ReTurnConfig.cxx.

◆ ~ReTurnConfig()

reTurn::ReTurnConfig::~ReTurnConfig ( )
virtual

Definition at line 160 of file ReTurnConfig.cxx.

Member Function Documentation

◆ addUser()

void reTurn::ReTurnConfig::addUser ( const resip::Data &  username,
const resip::Data &  password,
const resip::Data &  realm 
)

Definition at line 165 of file ReTurnConfig.cxx.

◆ authParse()

void reTurn::ReTurnConfig::authParse ( const resip::Data &  accountDatabaseFilename)

Definition at line 178 of file ReTurnConfig.cxx.

◆ getHa1ForUsername()

Data reTurn::ReTurnConfig::getHa1ForUsername ( const resip::Data &  username,
const resip::Data &  realm 
) const

Definition at line 342 of file ReTurnConfig.cxx.

◆ getUser()

std::unique_ptr< UserAuthData > reTurn::ReTurnConfig::getUser ( const resip::Data &  userName,
const resip::Data &  realm 
) const

Definition at line 357 of file ReTurnConfig.cxx.

◆ isUserNameValid()

bool reTurn::ReTurnConfig::isUserNameValid ( const resip::Data &  username,
const resip::Data &  realm 
) const

Definition at line 336 of file ReTurnConfig.cxx.

◆ parseConfig()

void reTurn::ReTurnConfig::parseConfig ( int  argc,
char **  argv,
const resip::Data &  defaultConfigFilename 
)
virtual

Reimplemented from resip::ConfigParse.

Definition at line 84 of file ReTurnConfig.cxx.

◆ printHelpText()

void reTurn::ReTurnConfig::printHelpText ( int  argc,
char **  argv 
)
virtual

Implements resip::ConfigParse.

Definition at line 326 of file ReTurnConfig.cxx.

Friends And Related Symbol Documentation

◆ ReTurnUserFileScanner

friend class ReTurnUserFileScanner
friend

Definition at line 101 of file ReTurnConfig.hxx.

Member Data Documentation

◆ mAllocationPortRangeMax

unsigned short reTurn::ReTurnConfig::mAllocationPortRangeMax

Definition at line 68 of file ReTurnConfig.hxx.

◆ mAllocationPortRangeMin

unsigned short reTurn::ReTurnConfig::mAllocationPortRangeMin

Definition at line 67 of file ReTurnConfig.hxx.

◆ mAltStunAddress

asio::ip::address reTurn::ReTurnConfig::mAltStunAddress

Definition at line 60 of file ReTurnConfig.hxx.

◆ mAltStunPort

unsigned short reTurn::ReTurnConfig::mAltStunPort

Definition at line 57 of file ReTurnConfig.hxx.

◆ mAuthenticationRealm

resip::Data reTurn::ReTurnConfig::mAuthenticationRealm

Definition at line 62 of file ReTurnConfig.hxx.

◆ mDaemonize

bool reTurn::ReTurnConfig::mDaemonize

Definition at line 86 of file ReTurnConfig.hxx.

◆ mDefaultAllocationLifetime

unsigned long reTurn::ReTurnConfig::mDefaultAllocationLifetime

Definition at line 69 of file ReTurnConfig.hxx.

◆ mMaxAllocationLifetime

unsigned long reTurn::ReTurnConfig::mMaxAllocationLifetime

Definition at line 70 of file ReTurnConfig.hxx.

◆ mMaxAllocationsPerUser

unsigned long reTurn::ReTurnConfig::mMaxAllocationsPerUser

Definition at line 71 of file ReTurnConfig.hxx.

◆ mMaxTcpConnectionsPerIp

unsigned long reTurn::ReTurnConfig::mMaxTcpConnectionsPerIp

Definition at line 79 of file ReTurnConfig.hxx.

◆ mNonceLifetime

unsigned long reTurn::ReTurnConfig::mNonceLifetime

Definition at line 65 of file ReTurnConfig.hxx.

◆ mOpenSSLCTXClearOptions

long reTurn::ReTurnConfig::mOpenSSLCTXClearOptions

Definition at line 81 of file ReTurnConfig.hxx.

◆ mOpenSSLCTXSetOptions

long reTurn::ReTurnConfig::mOpenSSLCTXSetOptions

Definition at line 80 of file ReTurnConfig.hxx.

◆ mPadSoftwareName

bool reTurn::ReTurnConfig::mPadSoftwareName

Definition at line 53 of file ReTurnConfig.hxx.

◆ mPidFile

resip::Data reTurn::ReTurnConfig::mPidFile

Definition at line 87 of file ReTurnConfig.hxx.

◆ mRunAsGroup

resip::Data reTurn::ReTurnConfig::mRunAsGroup

Definition at line 89 of file ReTurnConfig.hxx.

◆ mRunAsUser

resip::Data reTurn::ReTurnConfig::mRunAsUser

Definition at line 88 of file ReTurnConfig.hxx.

◆ mSoftwareName

resip::Data reTurn::ReTurnConfig::mSoftwareName

Definition at line 52 of file ReTurnConfig.hxx.

◆ mTcpConnectionIdleTimeout

unsigned long reTurn::ReTurnConfig::mTcpConnectionIdleTimeout

Definition at line 78 of file ReTurnConfig.hxx.

◆ mTlsHandshakeTimeout

unsigned long reTurn::ReTurnConfig::mTlsHandshakeTimeout

Definition at line 77 of file ReTurnConfig.hxx.

◆ mTlsPrivateKeyPassword

resip::Data reTurn::ReTurnConfig::mTlsPrivateKeyPassword

Definition at line 76 of file ReTurnConfig.hxx.

◆ mTlsServerCertificateFilename

resip::Data reTurn::ReTurnConfig::mTlsServerCertificateFilename

Definition at line 73 of file ReTurnConfig.hxx.

◆ mTlsServerPrivateKeyFilename

resip::Data reTurn::ReTurnConfig::mTlsServerPrivateKeyFilename

Definition at line 74 of file ReTurnConfig.hxx.

◆ mTlsTempDhFilename

resip::Data reTurn::ReTurnConfig::mTlsTempDhFilename

Definition at line 75 of file ReTurnConfig.hxx.

◆ mTlsTurnPort

unsigned short reTurn::ReTurnConfig::mTlsTurnPort

Definition at line 56 of file ReTurnConfig.hxx.

◆ mTurnAddress

asio::ip::address reTurn::ReTurnConfig::mTurnAddress

Definition at line 58 of file ReTurnConfig.hxx.

◆ mTurnPort

unsigned short reTurn::ReTurnConfig::mTurnPort

Definition at line 55 of file ReTurnConfig.hxx.

◆ mTurnV6Address

asio::ip::address reTurn::ReTurnConfig::mTurnV6Address

Definition at line 59 of file ReTurnConfig.hxx.

◆ mUserDatabaseCheckInterval

int reTurn::ReTurnConfig::mUserDatabaseCheckInterval

Definition at line 63 of file ReTurnConfig.hxx.

◆ mUserDatabaseHashedPasswords

bool reTurn::ReTurnConfig::mUserDatabaseHashedPasswords

Definition at line 84 of file ReTurnConfig.hxx.

◆ mUserDataMutex

resip::RWMutex reTurn::ReTurnConfig::mUserDataMutex
mutable

Definition at line 64 of file ReTurnConfig.hxx.

◆ mUsersDatabaseFilename

resip::Data reTurn::ReTurnConfig::mUsersDatabaseFilename

Definition at line 83 of file ReTurnConfig.hxx.

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