<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Vidalia: TorService.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b47abd1aad201a152869566145babb61.html">src</a> » <a class="el" href="dir_67a2ce25601334632bdc5ef4a72c0f17.html">torcontrol</a>
</div>
</div>
<div class="contents">
<h1>TorService.h</h1><a href="_tor_service_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">** This file is part of Vidalia, and is subject to the license terms in the</span>
<a name="l00003"></a>00003 <span class="comment">** LICENSE file, found in the top level directory of this distribution. If </span>
<a name="l00004"></a>00004 <span class="comment">** you did not receive the LICENSE file with this file, you may obtain it</span>
<a name="l00005"></a>00005 <span class="comment">** from the Vidalia source package distributed by the Vidalia Project at</span>
<a name="l00006"></a>00006 <span class="comment">** http://www.vidalia-project.net/. No part of Vidalia, including this file,</span>
<a name="l00007"></a>00007 <span class="comment">** may be copied, modified, propagated, or distributed except according to</span>
<a name="l00008"></a>00008 <span class="comment">** the terms described in the LICENSE file.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/* </span>
<a name="l00012"></a>00012 <span class="comment">** \file torservice.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: TorService.h 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Starts, stops, installs, and uninstalls a Tor service (Win32).</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _TORSERVICE_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _TORSERVICE_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <QObject></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <QProcess></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include <windows.h></span>
<a name="l00024"></a><a class="code" href="_tor_service_8h.html#ab94ebc0021b96d5498ff2484fc7b7853">00024</a> <span class="preprocessor">#define TOR_SERVICE_NAME "tor"</span>
<a name="l00025"></a><a class="code" href="_tor_service_8h.html#a10b57df9c21825e2e6c705afd948b787">00025</a> <span class="preprocessor"></span><span class="preprocessor">#define TOR_SERVICE_DISP "Tor Win32 Service"</span>
<a name="l00026"></a><a class="code" href="_tor_service_8h.html#a23d0458cc91579cdfd4a0bbdfb1ece36">00026</a> <span class="preprocessor"></span><span class="preprocessor">#define TOR_SERVICE_DESC \</span>
<a name="l00027"></a>00027 <span class="preprocessor"> TEXT("Provides an anonymous Internet communication system.")</span>
<a name="l00028"></a><a class="code" href="_tor_service_8h.html#ae36be8de454f1eda19eeaded49424277">00028</a> <span class="preprocessor"></span><span class="preprocessor">#define TOR_SERVICE_ACCESS SERVICE_ALL_ACCESS</span>
<a name="l00029"></a><a class="code" href="_tor_service_8h.html#a53a2dc80fa450eb12e1c76edb4ede017">00029</a> <span class="preprocessor"></span><span class="preprocessor">#define SERVICE_ERROR 8</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="comment">/* NT service function prototypes. This code is adapted from Tor's</span>
<a name="l00032"></a>00032 <span class="comment"> * nt_service_load_library() in main.c. See LICENSE for details on</span>
<a name="l00033"></a>00033 <span class="comment"> * Tor's license. */</span>
<a name="l00034"></a><a class="code" href="_tor_service_8h.html#a6d73aefda5c85d3d7f817a6e31d533a2">00034</a> <span class="keyword">typedef</span> BOOL (WINAPI *<a class="code" href="_tor_service_8h.html#a6d73aefda5c85d3d7f817a6e31d533a2">ChangeServiceConfig2A_fn</a>)(
<a name="l00035"></a>00035 SC_HANDLE hService,
<a name="l00036"></a>00036 DWORD dwInfoLevel,
<a name="l00037"></a>00037 LPVOID lpInfo);
<a name="l00038"></a><a class="code" href="_tor_service_8h.html#ac9c7b140a8c457e297742ce2d845e04d">00038</a> <span class="keyword">typedef</span> BOOL (WINAPI *<a class="code" href="_tor_service_8h.html#ac9c7b140a8c457e297742ce2d845e04d">CloseServiceHandle_fn</a>)(
<a name="l00039"></a>00039 SC_HANDLE hSCObject);
<a name="l00040"></a><a class="code" href="_tor_service_8h.html#afc00d426ae85bd1f14b90897b52f6b73">00040</a> <span class="keyword">typedef</span> BOOL (WINAPI *<a class="code" href="_tor_service_8h.html#afc00d426ae85bd1f14b90897b52f6b73">ControlService_fn</a>)(
<a name="l00041"></a>00041 SC_HANDLE hService,
<a name="l00042"></a>00042 DWORD dwControl,
<a name="l00043"></a>00043 LPSERVICE_STATUS lpServiceStatus);
<a name="l00044"></a><a class="code" href="_tor_service_8h.html#aa2dd23e309ccb2ccbccadf024d8591ea">00044</a> <span class="keyword">typedef</span> SC_HANDLE (WINAPI *<a class="code" href="_tor_service_8h.html#aa2dd23e309ccb2ccbccadf024d8591ea">CreateServiceA_fn</a>)(
<a name="l00045"></a>00045 SC_HANDLE hSCManager,
<a name="l00046"></a>00046 LPCTSTR lpServiceName,
<a name="l00047"></a>00047 LPCTSTR lpDisplayName,
<a name="l00048"></a>00048 DWORD dwDesiredAccess,
<a name="l00049"></a>00049 DWORD dwServiceType,
<a name="l00050"></a>00050 DWORD dwStartType,
<a name="l00051"></a>00051 DWORD dwErrorControl,
<a name="l00052"></a>00052 LPCTSTR lpBinaryPathName,
<a name="l00053"></a>00053 LPCTSTR lpLoadOrderGroup,
<a name="l00054"></a>00054 LPDWORD lpdwTagId,
<a name="l00055"></a>00055 LPCTSTR lpDependencies,
<a name="l00056"></a>00056 LPCTSTR lpServiceStartName,
<a name="l00057"></a>00057 LPCTSTR lpPassword);
<a name="l00058"></a><a class="code" href="_tor_service_8h.html#a7a0c94e5d7d69ac5ba8ae1ae84264ea2">00058</a> <span class="keyword">typedef</span> BOOL (WINAPI *<a class="code" href="_tor_service_8h.html#a7a0c94e5d7d69ac5ba8ae1ae84264ea2">DeleteService_fn</a>)(
<a name="l00059"></a>00059 SC_HANDLE hService);
<a name="l00060"></a><a class="code" href="_tor_service_8h.html#a41d15fead5b7639d166fd61df86337cd">00060</a> <span class="keyword">typedef</span> SC_HANDLE (WINAPI *<a class="code" href="_tor_service_8h.html#a41d15fead5b7639d166fd61df86337cd">OpenSCManagerA_fn</a>)(
<a name="l00061"></a>00061 LPCTSTR lpMachineName,
<a name="l00062"></a>00062 LPCTSTR lpDatabaseName,
<a name="l00063"></a>00063 DWORD dwDesiredAccess);
<a name="l00064"></a><a class="code" href="_tor_service_8h.html#a24930c9ed3194543db577eb229746d1c">00064</a> <span class="keyword">typedef</span> SC_HANDLE (WINAPI *<a class="code" href="_tor_service_8h.html#a24930c9ed3194543db577eb229746d1c">OpenServiceA_fn</a>)(
<a name="l00065"></a>00065 SC_HANDLE hSCManager,
<a name="l00066"></a>00066 LPCTSTR lpServiceName,
<a name="l00067"></a>00067 DWORD dwDesiredAccess);
<a name="l00068"></a><a class="code" href="_tor_service_8h.html#a19f3294743ed145f6e675b970133d380">00068</a> <span class="keyword">typedef</span> BOOL (WINAPI *<a class="code" href="_tor_service_8h.html#a19f3294743ed145f6e675b970133d380">QueryServiceStatus_fn</a>)(
<a name="l00069"></a>00069 SC_HANDLE hService,
<a name="l00070"></a>00070 LPSERVICE_STATUS lpServiceStatus);
<a name="l00071"></a><a class="code" href="_tor_service_8h.html#acc31cb9a12b71ba0d277770a54ae0b55">00071</a> <span class="keyword">typedef</span> BOOL (WINAPI *<a class="code" href="_tor_service_8h.html#acc31cb9a12b71ba0d277770a54ae0b55">SetServiceStatus_fn</a>)(SERVICE_STATUS_HANDLE,
<a name="l00072"></a>00072 LPSERVICE_STATUS);
<a name="l00073"></a><a class="code" href="_tor_service_8h.html#a0d1f1d984698b8d9e9fa8dc57e7c92fc">00073</a> <span class="keyword">typedef</span> BOOL (WINAPI *<a class="code" href="_tor_service_8h.html#a0d1f1d984698b8d9e9fa8dc57e7c92fc">StartServiceA_fn</a>)(
<a name="l00074"></a>00074 SC_HANDLE hService,
<a name="l00075"></a>00075 DWORD dwNumServiceArgs,
<a name="l00076"></a>00076 LPCTSTR* lpServiceArgVectors);
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">/** Table of NT service related functions. */</span>
<a name="l00079"></a><a class="code" href="struct_service_functions.html">00079</a> <span class="keyword">struct </span><a class="code" href="struct_service_functions.html">ServiceFunctions</a> {
<a name="l00080"></a><a class="code" href="struct_service_functions.html#aeb944441051ce74d1e5ed02d06206647">00080</a> <span class="keywordtype">bool</span> <a class="code" href="struct_service_functions.html#aeb944441051ce74d1e5ed02d06206647">loaded</a>;
<a name="l00081"></a><a class="code" href="struct_service_functions.html#a8cf5473280da29e50211666d001b3c23">00081</a> <a class="code" href="_tor_service_8h.html#a6d73aefda5c85d3d7f817a6e31d533a2">ChangeServiceConfig2A_fn</a> <a class="code" href="struct_service_functions.html#a8cf5473280da29e50211666d001b3c23">ChangeServiceConfig2A</a>;
<a name="l00082"></a><a class="code" href="struct_service_functions.html#a4b7862a13bccedc7100a18da68fab91a">00082</a> <a class="code" href="_tor_service_8h.html#ac9c7b140a8c457e297742ce2d845e04d">CloseServiceHandle_fn</a> <a class="code" href="struct_service_functions.html#a4b7862a13bccedc7100a18da68fab91a">CloseServiceHandle</a>;
<a name="l00083"></a><a class="code" href="struct_service_functions.html#a7870cabdbc5928b0d6f1b14d81af19de">00083</a> <a class="code" href="_tor_service_8h.html#afc00d426ae85bd1f14b90897b52f6b73">ControlService_fn</a> <a class="code" href="struct_service_functions.html#a7870cabdbc5928b0d6f1b14d81af19de">ControlService</a>;
<a name="l00084"></a><a class="code" href="struct_service_functions.html#aac4a7d128a08928acb5d6c44ac3990c8">00084</a> <a class="code" href="_tor_service_8h.html#aa2dd23e309ccb2ccbccadf024d8591ea">CreateServiceA_fn</a> <a class="code" href="struct_service_functions.html#aac4a7d128a08928acb5d6c44ac3990c8">CreateServiceA</a>;
<a name="l00085"></a><a class="code" href="struct_service_functions.html#ace5e247e6646727738b1ef7e879fe12d">00085</a> <a class="code" href="_tor_service_8h.html#a7a0c94e5d7d69ac5ba8ae1ae84264ea2">DeleteService_fn</a> <a class="code" href="struct_service_functions.html#ace5e247e6646727738b1ef7e879fe12d">DeleteService</a>;
<a name="l00086"></a><a class="code" href="struct_service_functions.html#a13dc542abc96167318d2fbe9f8be6a80">00086</a> <a class="code" href="_tor_service_8h.html#a41d15fead5b7639d166fd61df86337cd">OpenSCManagerA_fn</a> <a class="code" href="struct_service_functions.html#a13dc542abc96167318d2fbe9f8be6a80">OpenSCManagerA</a>;
<a name="l00087"></a><a class="code" href="struct_service_functions.html#a600797ca876ee54242da39cf682f6613">00087</a> <a class="code" href="_tor_service_8h.html#a24930c9ed3194543db577eb229746d1c">OpenServiceA_fn</a> <a class="code" href="struct_service_functions.html#a600797ca876ee54242da39cf682f6613">OpenServiceA</a>;
<a name="l00088"></a><a class="code" href="struct_service_functions.html#a3b40037d4921e8d3d95dbb6c6f8046f7">00088</a> <a class="code" href="_tor_service_8h.html#a19f3294743ed145f6e675b970133d380">QueryServiceStatus_fn</a> <a class="code" href="struct_service_functions.html#a3b40037d4921e8d3d95dbb6c6f8046f7">QueryServiceStatus</a>;
<a name="l00089"></a><a class="code" href="struct_service_functions.html#a1119c0741979f7f3e3d8dbbb0d7be2b0">00089</a> <a class="code" href="_tor_service_8h.html#acc31cb9a12b71ba0d277770a54ae0b55">SetServiceStatus_fn</a> <a class="code" href="struct_service_functions.html#a1119c0741979f7f3e3d8dbbb0d7be2b0">SetServiceStatus</a>;
<a name="l00090"></a><a class="code" href="struct_service_functions.html#a24bf9428aaebf63a78366b63a63a20c6">00090</a> <a class="code" href="_tor_service_8h.html#a0d1f1d984698b8d9e9fa8dc57e7c92fc">StartServiceA_fn</a> <a class="code" href="struct_service_functions.html#a24bf9428aaebf63a78366b63a63a20c6">StartServiceA</a>;
<a name="l00091"></a>00091 };
<a name="l00092"></a>00092
<a name="l00093"></a>00093
<a name="l00094"></a><a class="code" href="class_tor_service.html">00094</a> <span class="keyword">class </span><a class="code" href="class_tor_service.html">TorService</a> : <span class="keyword">public</span> QObject
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 Q_OBJECT
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /** Returns if services are supported. */</span>
<a name="l00100"></a>00100 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_tor_service.html#ad9f8db8e338a5393cdad6315e95bcbf9">isSupported</a>();<span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** Dynamically loads NT service related functions from advapi32.dll. */</span>
<a name="l00102"></a>00102 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_tor_service.html#ae3fe23ef6342a03f0cab05ffe7f4a7a3">loadServiceFunctions</a>();
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment"> /** Default ctor. */</span>
<a name="l00105"></a>00105 <a class="code" href="class_tor_service.html#a6a14fe7307b348093ae38e16d4275785">TorService</a>(QObject* parent = 0);<span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment"> /** Default dtor. */</span>
<a name="l00107"></a>00107 <a class="code" href="class_tor_service.html#ab87e0a2c1f43c062caebf7a10c11ffce">~TorService</a>();
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment"> /** Returns true if the Tor service is installed. */</span>
<a name="l00110"></a>00110 <span class="keywordtype">bool</span> <a class="code" href="class_tor_service.html#a7e54797c5499b30153df9290c0ad62df">isInstalled</a>();<span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment"> /** Returns true if the Tor service is running. */</span>
<a name="l00112"></a>00112 <span class="keywordtype">bool</span> <a class="code" href="class_tor_service.html#a403393278b9f1d2076a76289aed4be54">isRunning</a>();<span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment"> /** Starts the Tor service. Emits started on success. */</span>
<a name="l00114"></a>00114 <span class="keywordtype">void</span> <a class="code" href="class_tor_service.html#ad0b2bbbae2215166229c8dca9a83341a">start</a>();<span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment"> /** Stops the Tor service. Emits finished on success. */</span>
<a name="l00116"></a>00116 <span class="keywordtype">bool</span> <a class="code" href="class_tor_service.html#a3dd3a77a3cc5b988477d0ae09825c26a">stop</a>();<span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment"> /** Returns the exit code of the last Tor service that finished. */</span>
<a name="l00118"></a>00118 <span class="keywordtype">int</span> <a class="code" href="class_tor_service.html#a43385dfaffdf336b2d3b3cb9c5e4454e">exitCode</a>();<span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment"> /** Returns the exit status of the last Tor service that finished. */</span>
<a name="l00120"></a>00120 QProcess::ExitStatus <a class="code" href="class_tor_service.html#a86ae694a35592aeeda0bf33891843ce5">exitStatus</a>();<span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment"> /** Installs the Tor service. */</span>
<a name="l00122"></a>00122 <span class="keywordtype">bool</span> <a class="code" href="class_tor_service.html#ad56bdbd81c64764dfaf5675411e7f049">install</a>(<span class="keyword">const</span> QString &torPath, <span class="keyword">const</span> QString &torrc,
<a name="l00123"></a>00123 quint16 controlPort);<span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment"> /** Removes the Tor service. */</span>
<a name="l00125"></a>00125 <span class="keywordtype">bool</span> <span class="keyword">remove</span>();
<a name="l00126"></a>00126
<a name="l00127"></a>00127 signals:<span class="comment"></span>
<a name="l00128"></a>00128 <span class="comment"> /** Called when the service gets started. */</span>
<a name="l00129"></a>00129 <span class="keywordtype">void</span> <a class="code" href="class_tor_service.html#a8b382075df50e0e128c63d7eadb8eefd">started</a>();<span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment"> /** Called when the service gets stopped. */</span>
<a name="l00131"></a>00131 <span class="keywordtype">void</span> <a class="code" href="class_tor_service.html#a39988777b4993c2e5eeeb6b92332e187">finished</a>(<span class="keywordtype">int</span> exitCode, QProcess::ExitStatus);<span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment"> /** Called when there is an error in starting the service. */</span>
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="class_tor_service.html#ab15ec5607a014c611809f968f75e4d0b">startFailed</a>(QString <a class="code" href="namespacetc.html#aa7353218fd7baef0876bbb422ce818af">error</a>);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment"> /** Opens a handle to the Tor service. Returns NULL on error. */</span>
<a name="l00137"></a>00137 SC_HANDLE <a class="code" href="class_tor_service.html#a20f67c721cd24a889594906646422d14">openService</a>();<span class="comment"></span>
<a name="l00138"></a>00138 <span class="comment"> /** Opens a handle to the service control manager. Returns NULL on error. */</span>
<a name="l00139"></a>00139 <span class="keyword">static</span> SC_HANDLE <a class="code" href="class_tor_service.html#a9bdc336db137705c75c4596818664ff3">openSCM</a>();<span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment"> /** Closes the service <b>handle</b>. */</span>
<a name="l00141"></a>00141 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_tor_service.html#a6003b562b733c382e07e8e2f90f5c04d">closeHandle</a>(SC_HANDLE handle);<span class="comment"></span>
<a name="l00142"></a>00142 <span class="comment"> /** Gets the status of the Tor service. */</span>
<a name="l00143"></a>00143 DWORD <a class="code" href="class_tor_service.html#a6f610fd655180d69a19eb2a46c102aaa">status</a>();
<a name="l00144"></a>00144 <span class="comment"></span>
<a name="l00145"></a>00145 <span class="comment"> /** Handle to the service control manager. */</span>
<a name="l00146"></a><a class="code" href="class_tor_service.html#a46e51a37fe5f1b464c011e870ec206c8">00146</a> SC_HANDLE <a class="code" href="class_tor_service.html#a46e51a37fe5f1b464c011e870ec206c8">_scm</a>;<span class="comment"></span>
<a name="l00147"></a>00147 <span class="comment"> /** List of dynamically loaded NT service functions. */</span>
<a name="l00148"></a><a class="code" href="class_tor_service.html#a4a930d2d1fc5d7c4c887ba92f242d46c">00148</a> <span class="keyword">static</span> <a class="code" href="struct_service_functions.html">ServiceFunctions</a> <a class="code" href="class_tor_service.html#a4a930d2d1fc5d7c4c887ba92f242d46c">_service_fns</a>;
<a name="l00149"></a>00149 };
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="preprocessor">#endif</span>
<a name="l00152"></a>00152 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:55 2010 for Vidalia by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
9601c7beb4ff23e834bfa171795ed560
>
files
>
349
