Vidalia
0.2.15
|
#include <TorSettings.h>
Public Types | |
enum | AuthenticationMethod { NullAuth, CookieAuth, PasswordAuth, UnknownAuth } |
Public Member Functions | |
TorSettings (TorControl *torControl=0) | |
bool | apply (QString *errmsg=0) |
QString | getExecutable () const |
void | setExecutable (const QString &torExecutable) |
QString | getDataDirectory () const |
void | setDataDirectory (const QString &dataDir) |
QString | getTorrc () const |
void | setTorrc (const QString &torrc) |
QHostAddress | getControlAddress () const |
void | setControlAddress (const QHostAddress &addr) |
quint16 | getControlPort () const |
void | setControlPort (quint16 port) |
QString | getSocketPath () const |
ControlMethod::Method | getControlMethod () const |
bool | autoControlPort () const |
void | setAutoControlPort (const bool auto) |
void | setControlMethod (ControlMethod::Method method) |
void | setSocketPath (const QString &path) |
QString | getControlPassword () const |
void | setControlPassword (const QString &password) |
bool | useRandomPassword () const |
void | setUseRandomPassword (bool useRandomPassword) |
AuthenticationMethod | getAuthenticationMethod () const |
void | setAuthenticationMethod (AuthenticationMethod method) |
QList< quint16 > | getWarnPlaintextPorts () const |
void | setWarnPlaintextPorts (const QList< quint16 > &ports) |
QList< quint16 > | getRejectPlaintextPorts () const |
void | setRejectPlaintextPorts (const QList< quint16 > &ports) |
bool | bootstrap () const |
void | setBootstrap (bool enabled) |
QString | bootstrapFrom () const |
void | setBootstrapFrom (const QString &from) |
Static Public Member Functions | |
static QString | randomPassword () |
static QString | hashPassword (const QString &password) |
Private Member Functions | |
AuthenticationMethod | toAuthenticationMethod (const QString &authMethod) const |
QString | toString (AuthenticationMethod type) const |
Manages Tor-specific settings, such as location, command-line arguments, and control interface information.
Definition at line 26 of file TorSettings.h.
Available Tor authentication methods.
NullAuth |
No authentication. |
CookieAuth |
Use a "magic" cookie for authentication. |
PasswordAuth |
Use a hashed password for authentication. |
UnknownAuth |
Unknown authentication method. |
Definition at line 32 of file TorSettings.h.
TorSettings::TorSettings | ( | TorControl * | torControl = 0 | ) |
Default constructor.
Default constructor
Definition at line 68 of file TorSettings.cpp.
References Vidalia::dataDirectory(), DEFAULT_AUTH_METHOD, DEFAULT_CONTROL_METHOD, DEFAULT_SOCKET_PATH, VSettings::setDefault(), SETTING_AUTH_METHOD, SETTING_AUTOCONTROL, SETTING_BOOTSTRAP, SETTING_BOOTSTRAP_FROM, SETTING_CONTROL_ADDR, SETTING_CONTROL_METHOD, SETTING_CONTROL_PASSWORD, SETTING_CONTROL_PORT, SETTING_DATA_DIRECTORY, SETTING_REJECT_PLAINTEXT_PORTS, SETTING_SOCKET_PATH, SETTING_TOR_EXECUTABLE, SETTING_TORRC, SETTING_USE_RANDOM_PASSWORD, SETTING_WARN_PLAINTEXT_PORTS, toString(), and win32_program_files_folder().
bool TorSettings::apply | ( | QString * | errmsg = 0 | ) | [virtual] |
Applies any changes to Tor's control port or authentication settings.
Implements AbstractTorSettings.
Definition at line 101 of file TorSettings.cpp.
References CookieAuth, getControlPassword(), hashPassword(), AbstractTorSettings::localValue(), PasswordAuth, randomPassword(), TorControl::setConf(), SETTING_AUTH_METHOD, SETTING_CONTROL_PORT, SETTING_REJECT_PLAINTEXT_PORTS, SETTING_WARN_PLAINTEXT_PORTS, toAuthenticationMethod(), TOR_ARG_COOKIE_AUTH, TOR_ARG_HASHED_PASSWORD, AbstractTorSettings::torControl(), toString(), and useRandomPassword().
Referenced by AdvancedPage::apply().
bool TorSettings::autoControlPort | ( | ) | const |
Returns true if Vidalia will get the ControlPort automatically from Tor
Definition at line 457 of file TorSettings.cpp.
References SETTING_AUTOCONTROL, and AbstractTorSettings::value().
Referenced by AdvancedPage::load(), MainWindow::start(), MainWindow::started(), and MainWindow::updateBrowserEnv().
bool TorSettings::bootstrap | ( | ) | const |
Returns true if Vidalia needs to bootstrap the torrc file
Definition at line 439 of file TorSettings.cpp.
References SETTING_BOOTSTRAP, and AbstractTorSettings::value().
Referenced by MainWindow::start().
QString TorSettings::bootstrapFrom | ( | ) | const |
Returns the path of the bootstrap torrc file
Definition at line 451 of file TorSettings.cpp.
References SETTING_BOOTSTRAP_FROM, toString(), and AbstractTorSettings::value().
Referenced by MainWindow::start().
TorSettings::AuthenticationMethod TorSettings::getAuthenticationMethod | ( | ) | const |
Returns the current authentication method used when connecting to Tor.
Definition at line 284 of file TorSettings.cpp.
References CookieAuth, DEFAULT_AUTH_METHOD, TorControl::getConf(), TorControl::isConnected(), AbstractTorSettings::localValue(), PasswordAuth, SETTING_AUTH_METHOD, toAuthenticationMethod(), TOR_ARG_COOKIE_AUTH, TOR_ARG_HASHED_PASSWORD, AbstractTorSettings::torControl(), toString(), and UnknownAuth.
Referenced by MainWindow::authenticate(), AdvancedPage::load(), MainWindow::start(), and MainWindow::updateBrowserEnv().
QHostAddress TorSettings::getControlAddress | ( | ) | const |
Get Tor's control interface address.
Get the address or hostname used to connect to Tor
Definition at line 195 of file TorSettings.cpp.
References AbstractTorSettings::localValue(), and SETTING_CONTROL_ADDR.
Referenced by MainWindow::connectFailed(), AdvancedPage::load(), MainWindow::start(), and MainWindow::started().
ControlMethod::Method TorSettings::getControlMethod | ( | ) | const |
Get the current control method
Definition at line 238 of file TorSettings.cpp.
References ControlMethod::fromString(), AbstractTorSettings::localValue(), SETTING_CONTROL_METHOD, and toString().
Referenced by AdvancedPage::load(), MainWindow::start(), and MainWindow::started().
QString TorSettings::getControlPassword | ( | ) | const |
Returns the plaintext (i.e., not hashed) control password used when authenticating to Tor.
Definition at line 253 of file TorSettings.cpp.
References AbstractTorSettings::localValue(), and SETTING_CONTROL_PASSWORD.
Referenced by apply(), MainWindow::authenticate(), AdvancedPage::load(), and MainWindow::start().
quint16 TorSettings::getControlPort | ( | ) | const |
Get the control port.
Get the control port used to connect to Tor
Definition at line 210 of file TorSettings.cpp.
References SETTING_CONTROL_PORT, and AbstractTorSettings::value().
Referenced by MainWindow::connectFailed(), AdvancedPage::load(), MainWindow::start(), and MainWindow::started().
QString TorSettings::getDataDirectory | ( | ) | const |
Gets the location of Tor's data directory.
Definition at line 143 of file TorSettings.cpp.
References SETTING_DATA_DIRECTORY, toString(), and AbstractTorSettings::value().
Referenced by MainWindow::authenticate(), AdvancedPage::load(), MainWindow::loadControlCookie(), AdvancedPage::save(), MainWindow::start(), MainWindow::started(), and MainWindow::updateBrowserEnv().
QString TorSettings::getExecutable | ( | ) | const |
Gets the name and path of Tor's executable.
Returns a fully-qualified path to Tor's executable, including the executable name.
Definition at line 158 of file TorSettings.cpp.
References VSettings::defaultValue(), AbstractTorSettings::localValue(), and SETTING_TOR_EXECUTABLE.
Referenced by GeneralPage::load(), and MainWindow::start().
QList< quint16 > TorSettings::getRejectPlaintextPorts | ( | ) | const |
Returns the current list of ports that will cause Tor to reject the connection when the user tries to connect to one of them.
Definition at line 342 of file TorSettings.cpp.
References SETTING_REJECT_PLAINTEXT_PORTS, and AbstractTorSettings::value().
Referenced by MainWindow::warnDangerousPort().
QString TorSettings::getSocketPath | ( | ) | const |
Get the path for ControlSocket
Definition at line 224 of file TorSettings.cpp.
References SETTING_SOCKET_PATH, and AbstractTorSettings::value().
Referenced by AdvancedPage::load(), MainWindow::start(), and MainWindow::started().
QString TorSettings::getTorrc | ( | ) | const |
Gets the torrc to use when starting Tor.
Returns the torrc that will be used when starting Tor.
Definition at line 175 of file TorSettings.cpp.
References TorControl::getInfo(), TorControl::isConnected(), AbstractTorSettings::localValue(), SETTING_TORRC, AbstractTorSettings::torControl(), and toString().
Referenced by AdvancedPage::load(), AdvancedPage::save(), and MainWindow::start().
QList< quint16 > TorSettings::getWarnPlaintextPorts | ( | ) | const |
Returns the current list of ports that will cause Tor to issue a warning when the user tries to connect to one of them.
Definition at line 315 of file TorSettings.cpp.
References SETTING_WARN_PLAINTEXT_PORTS, and AbstractTorSettings::value().
Referenced by MainWindow::warnDangerousPort().
QString TorSettings::hashPassword | ( | const QString & | password | ) | [static] |
Returns the hash of password as given by the command "tor --hash-password foo".
Definition at line 406 of file TorSettings.cpp.
References base16_encode(), crypto_rand_bytes(), and crypto_secret_to_key().
Referenced by apply(), and MainWindow::start().
QString TorSettings::randomPassword | ( | ) | [static] |
Generates a random control password consisting of PASSWORD_LEN characters.
Definition at line 398 of file TorSettings.cpp.
References crypto_rand_string(), and PASSWORD_LEN.
Referenced by apply(), and MainWindow::start().
void TorSettings::setAuthenticationMethod | ( | AuthenticationMethod | method | ) |
Sets the authentication method used when starting Tor to method.
Definition at line 307 of file TorSettings.cpp.
References SETTING_AUTH_METHOD, AbstractTorSettings::setValue(), and toString().
Referenced by MainWindow::authenticationFailed(), and AdvancedPage::save().
void TorSettings::setAutoControlPort | ( | const bool | auto | ) |
Sets whether Vidalia should get the ControlPort from Tor
Definition at line 463 of file TorSettings.cpp.
References SETTING_AUTOCONTROL, and AbstractTorSettings::setValue().
Referenced by AdvancedPage::save(), and MainWindow::start().
void TorSettings::setBootstrap | ( | bool | enabled | ) |
Enables or disables bootstrap
Definition at line 433 of file TorSettings.cpp.
References SETTING_BOOTSTRAP, and AbstractTorSettings::setValue().
Referenced by MainWindow::start().
void TorSettings::setBootstrapFrom | ( | const QString & | from | ) |
Sets the location of the bootstrap torrc file
Definition at line 445 of file TorSettings.cpp.
References SETTING_BOOTSTRAP_FROM, and AbstractTorSettings::setValue().
void TorSettings::setControlAddress | ( | const QHostAddress & | addr | ) |
Set Tor's control interface address.
Set the address or hostname used to connect to Tor
Definition at line 203 of file TorSettings.cpp.
References SETTING_CONTROL_ADDR, and AbstractTorSettings::setValue().
Referenced by AdvancedPage::save().
void TorSettings::setControlMethod | ( | ControlMethod::Method | method | ) |
Set the control method
Definition at line 245 of file TorSettings.cpp.
References SETTING_CONTROL_METHOD, AbstractTorSettings::setValue(), and ControlMethod::toString().
Referenced by AdvancedPage::save().
void TorSettings::setControlPassword | ( | const QString & | password | ) |
Sets the control password used when starting Tor with HashedControlPassword to password.
Definition at line 261 of file TorSettings.cpp.
References SETTING_CONTROL_PASSWORD, and AbstractTorSettings::setValue().
Referenced by MainWindow::authenticationFailed(), and AdvancedPage::save().
void TorSettings::setControlPort | ( | quint16 | port | ) |
Set the control port.
Set the control port used to connect to Tor
Definition at line 217 of file TorSettings.cpp.
References SETTING_CONTROL_PORT, and AbstractTorSettings::setValue().
Referenced by AdvancedPage::save().
void TorSettings::setDataDirectory | ( | const QString & | dataDirectory | ) |
Sets the location to use for Tor's data directory.
Sets the location to use as Tor's data directory.
Definition at line 150 of file TorSettings.cpp.
References SETTING_DATA_DIRECTORY, and AbstractTorSettings::setValue().
Referenced by AdvancedPage::save().
void TorSettings::setExecutable | ( | const QString & | torExecutable | ) |
Sets the name and path of Tor's executable.
Sets the location and name of Tor's executable to the given string.
Definition at line 168 of file TorSettings.cpp.
References SETTING_TOR_EXECUTABLE, and AbstractTorSettings::setValue().
Referenced by GeneralPage::save().
void TorSettings::setRejectPlaintextPorts | ( | const QList< quint16 > & | ports | ) |
Sets the list of ports that will cause Tor to reject the connection when the user tries to connect to one of them.
Definition at line 357 of file TorSettings.cpp.
References SETTING_REJECT_PLAINTEXT_PORTS, and AbstractTorSettings::setValue().
Referenced by MainWindow::warnDangerousPort().
void TorSettings::setSocketPath | ( | const QString & | path | ) |
Set the path for ControlSocket
Definition at line 231 of file TorSettings.cpp.
References SETTING_SOCKET_PATH, and AbstractTorSettings::setValue().
Referenced by AdvancedPage::save().
void TorSettings::setTorrc | ( | const QString & | torrc | ) |
Sets the torrc to use when starting Tor.
Sets the torrc that will be used when starting Tor.
torrc | The torrc to use. |
Definition at line 188 of file TorSettings.cpp.
References SETTING_TORRC, and AbstractTorSettings::setValue().
Referenced by AdvancedPage::save().
void TorSettings::setUseRandomPassword | ( | bool | useRandomPassword | ) |
Sets whether or not to generate and use a random control password each time Tor is started.
Definition at line 277 of file TorSettings.cpp.
References SETTING_USE_RANDOM_PASSWORD, and AbstractTorSettings::setValue().
Referenced by MainWindow::authenticationFailed(), and AdvancedPage::save().
void TorSettings::setWarnPlaintextPorts | ( | const QList< quint16 > & | ports | ) |
Sets the list of ports that will cause Tor to issue a warning when the user tries to connect to one of them.
Definition at line 330 of file TorSettings.cpp.
References SETTING_WARN_PLAINTEXT_PORTS, and AbstractTorSettings::setValue().
Referenced by MainWindow::warnDangerousPort().
TorSettings::AuthenticationMethod TorSettings::toAuthenticationMethod | ( | const QString & | authMethod | ) | const [private] |
Returns the AuthenticationMethod enum value for the string description of the authentication method given in authMethod.
Definition at line 384 of file TorSettings.cpp.
References CookieAuth, NullAuth, PasswordAuth, toString(), and UnknownAuth.
Referenced by apply(), and getAuthenticationMethod().
QString TorSettings::toString | ( | AuthenticationMethod | method | ) | const [private] |
Returns the string description of the authentication method specified by method. The authentication method string is stored in Vidalia's configuration file.
Definition at line 370 of file TorSettings.cpp.
References CookieAuth, NullAuth, and PasswordAuth.
Referenced by apply(), bootstrapFrom(), getAuthenticationMethod(), getControlMethod(), getDataDirectory(), getTorrc(), setAuthenticationMethod(), toAuthenticationMethod(), and TorSettings().
bool TorSettings::useRandomPassword | ( | ) | const |
Returns true if a new, random control password is to be used each time Tor is started.
Definition at line 269 of file TorSettings.cpp.
References AbstractTorSettings::localValue(), and SETTING_USE_RANDOM_PASSWORD.
Referenced by apply(), AdvancedPage::load(), and MainWindow::start().