home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _b49ea1e2734b35eea5661c480e9e63f3 < prev    next >
Encoding:
Text File  |  2000-03-23  |  12.1 KB  |  268 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>DBI::ProxyServer - a server for the DBD::Proxy driver</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> DBI::ProxyServer - a server for the DBD::Proxy driver</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#options">OPTIONS</A></LI>
  26.     <LI><A HREF="#configuration file">CONFIGURATION FILE</A></LI>
  27.     <LI><A HREF="#author">AUTHOR</A></LI>
  28.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  29. </UL>
  30. <!-- INDEX END -->
  31.  
  32. <HR>
  33. <P>
  34. <H1><A NAME="name">NAME</A></H1>
  35. <P>DBI::ProxyServer - a server for the DBD::Proxy driver</P>
  36. <P>
  37. <HR>
  38. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  39. <UL>
  40. <LI>Linux</LI>
  41. <LI>Solaris</LI>
  42. <LI>Windows</LI>
  43. </UL>
  44. <HR>
  45. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  46. <PRE>
  47.     use DBI::ProxyServer;
  48.     DBI::ProxyServer::main(@ARGV);</PRE>
  49. <P>
  50. <HR>
  51. <H1><A NAME="description">DESCRIPTION</A></H1>
  52. <P>DBI::Proxy Server is a module for implementing a proxy for the DBI proxy
  53. driver, DBD::Proxy. It allows access to databases over the network if the
  54. DBMS does not offer networked operations. But the proxy server might be
  55. usefull for you, even if you have a DBMS with integrated network
  56. functionality: It can be used as a DBI proxy in a firewalled environment.</P>
  57. <P>DBI::ProxyServer runs as a daemon on the machine with the DBMS or on the
  58. firewall. The client connects to the agent using the DBI driver DBD::Proxy,
  59. thus in the exactly same way than using DBD::mysql, DBD::mSQL or any other
  60. DBI driver.</P>
  61. <P>The agent is implemented as a RPC::PlServer application. Thus you have
  62. access to all the possibilities of this module, in particular encryption
  63. and a similar configuration file. DBI::ProxyServer adds the possibility of
  64. query restrictions: You can define a set of queries that a client may
  65. execute and restrict access to those. (Requires a DBI driver that supports
  66. parameter binding.) See <A HREF="#configuration file">CONFIGURATION FILE</A>.</P>
  67. <P>
  68. <HR>
  69. <H1><A NAME="options">OPTIONS</A></H1>
  70. <P>When calling the DBI::ProxyServer::main() function, you supply an
  71. array of options. (@ARGV, the array of command line options is used,
  72. if you don't.) These options are parsed by the Getopt::Long module.
  73. The ProxyServer inherits all of RPC::PlServer's and hence Net::Daemon's
  74. options and option handling, in particular the ability to read
  75. options from either the command line or a config file. See
  76. <A HREF="../../../RPC/PlServer(3).html">the RPC::PlServer(3) manpage</A>. See <A HREF="../../../Net/Daemon(3).html">the Net::Daemon(3) manpage</A>. Available options include</P>
  77. <DL>
  78. <DT><STRONG><A NAME="item_chroot"><EM>chroot</EM> (<STRONG>--chroot=dir</STRONG>)</A></STRONG><BR>
  79. <DD>
  80. (UNIX only)  After doing a bind(), change root directory to the given
  81. directory by doing a chroot(). This is usefull for security, but it
  82. restricts the environment a lot. For example, you need to load DBI
  83. drivers in the config file or you have to create hard links to Unix
  84. sockets, if your drivers are using them. For example, with MySQL, a
  85. config file might contain the following lines:
  86. <PRE>
  87.     my $rootdir = '/var/dbiproxy';
  88.     my $unixsockdir = '/tmp';
  89.     my $unixsockfile = 'mysql.sock';
  90.     foreach $dir ($rootdir, "$rootdir$unixsockdir") {
  91.         mkdir 0755, $dir;
  92.     }
  93.     link("$unixsockdir/$unixsockfile",
  94.          "$rootdir$unixsockdir/$unixsockfile");
  95.     require DBD::mysql;</PRE>
  96. <PRE>
  97.     {
  98.         'chroot' => $rootdir,
  99.         ...
  100.     }</PRE>
  101. <P>If you don't know chroot(), think of an FTP server where you can see a
  102. certain directory tree only after logging in. See also the --group and
  103. --user options.</P>
  104. <P></P>
  105. <DT><STRONG><A NAME="item_clients"><EM>clients</EM></A></STRONG><BR>
  106. <DD>
  107. An array ref with a list of clients. Clients are hash refs, the attributes
  108. <EM>accept</EM> (0 for denying access and 1 for permitting) and <EM>mask</EM>, a Perl
  109. regular expression for the clients IP number or its host name. See
  110. <A HREF="#access control">Access control</A> below.
  111. <P></P>
  112. <DT><STRONG><A NAME="item_configfile"><EM>configfile</EM> (<STRONG>--configfile=file</STRONG>)</A></STRONG><BR>
  113. <DD>
  114. Config files are assumed to return a single hash ref that overrides the
  115. arguments of the new method. However, command line arguments in turn take
  116. precedence over the config file. See the <A HREF="#configuration file">CONFIGURATION FILE</A> section
  117. below for details on the config file.
  118. <P></P>
  119. <DT><STRONG><A NAME="item_debug"><EM>debug</EM> (<STRONG>--debug</STRONG>)</A></STRONG><BR>
  120. <DD>
  121. Turn debugging mode on. Mainly this asserts that logging messages of
  122. level ``debug'' are created.
  123. <P></P>
  124. <DT><STRONG><A NAME="item_facility"><EM>facility</EM> (<STRONG>--facility=mode</STRONG>)</A></STRONG><BR>
  125. <DD>
  126. (UNIX only) Facility to use for <A HREF="#sys::syslog (3)">Sys::Syslog (3)</A>. The default is
  127. <STRONG>daemon</STRONG>.
  128. <P></P>
  129. <DT><STRONG><A NAME="item_group"><EM>group</EM> (<STRONG>--group=gid</STRONG>)</A></STRONG><BR>
  130. <DD>
  131. After doing a bind(), change the real and effective GID to the given.
  132. This is usefull, if you want your server to bind to a privileged port
  133. (<1024), but don't want the server to execute as root. See also
  134. the --user option.
  135. <P>GID's can be passed as group names or numeric values.</P>
  136. <P></P>
  137. <DT><STRONG><A NAME="item_localaddr"><EM>localaddr</EM> (<STRONG>--localaddr=ip</STRONG>)</A></STRONG><BR>
  138. <DD>
  139. By default a daemon is listening to any IP number that a machine
  140. has. This attribute allows to restrict the server to the given
  141. IP number.
  142. <P></P>
  143. <DT><STRONG><A NAME="item_localport"><EM>localport</EM> (<STRONG>--localport=port</STRONG>)</A></STRONG><BR>
  144. <DD>
  145. This attribute sets the port on which the daemon is listening. It
  146. must be given somehow, as there's no default.
  147. <P></P>
  148. <DT><STRONG><A NAME="item_logfile"><EM>logfile</EM> (<STRONG>--logfile=file</STRONG>)</A></STRONG><BR>
  149. <DD>
  150. Be default logging messages will be written to the syslog (Unix) or
  151. to the event log (Windows NT). On other operating systems you need to
  152. specify a log file. The special value ``STDERR'' forces logging to
  153. stderr. See <A HREF="../../../Net/Daemon/Log(3).html">the Net::Daemon::Log(3) manpage</A> for details.
  154. <P></P>
  155. <DT><STRONG><A NAME="item_mode"><EM>mode</EM> (<STRONG>--mode=modename</STRONG>)</A></STRONG><BR>
  156. <DD>
  157. The server can run in three different modes, depending on the environment.
  158. <P>If you are running Perl 5.005 and did compile it for threads, then the
  159. server will create a new thread for each connection. The thread will
  160. execute the server's <CODE>Run()</CODE> method and then terminate. This mode is the
  161. default, you can force it with ``--mode=threads''.</P>
  162. <P>If threads are not available, but you have a working fork(), then the
  163. server will behave similar by creating a new process for each connection.
  164. This mode will be used automatically in the absence of threads or if
  165. you use the ``--mode=fork'' option.</P>
  166. <P>Finally there's a single-connection mode: If the server has accepted a
  167. connection, he will enter the <CODE>Run()</CODE> method. No other connections are
  168. accepted until the <CODE>Run()</CODE> method returns (if the client disconnects).
  169. This operation mode is usefull if you have neither threads nor fork(),
  170. for example on the Macintosh. For debugging purposes you can force this
  171. mode with ``--mode=single''.</P>
  172. <P></P>
  173. <DT><STRONG><A NAME="item_pidfile"><EM>pidfile</EM> (<STRONG>--pidfile=file</STRONG>)</A></STRONG><BR>
  174. <DD>
  175. (UNIX only) If this option is present, a PID file will be created at the
  176. given location.
  177. <P></P>
  178. <DT><STRONG><A NAME="item_user"><EM>user</EM> (<STRONG>--user=uid</STRONG>)</A></STRONG><BR>
  179. <DD>
  180. After doing a bind(), change the real and effective UID to the given.
  181. This is usefull, if you want your server to bind to a privileged port
  182. (<1024), but don't want the server to execute as root. See also
  183. the --group and the --chroot options.
  184. <P>UID's can be passed as group names or numeric values.</P>
  185. <P></P>
  186. <DT><STRONG><A NAME="item_version"><EM>version</EM> (<STRONG>--version</STRONG>)</A></STRONG><BR>
  187. <DD>
  188. Supresses startup of the server; instead the version string will
  189. be printed and the program exits immediately.
  190. <P></P></DL>
  191. <P>
  192. <HR>
  193. <H1><A NAME="configuration file">CONFIGURATION FILE</A></H1>
  194. <P>The configuration file is just that of <EM>RPC::PlServer</EM> or <EM>Net::Daemon</EM>
  195. with some additional attributes in the client list.</P>
  196. <P>The config file is a Perl script. At the top of the file you may include
  197. arbitraty Perl source, for example load drivers at the start (usefull
  198. to enhance performance), prepare a chroot environment and so on.</P>
  199. <P>The important thing is that you finally return a hash ref of option
  200. name/value pairs. The possible options are listed above.</P>
  201. <P>All possibilities of Net::Daemon and RPC::PlServer apply, in particular</P>
  202. <DL>
  203. <DT><STRONG><A NAME="item_Host_and%2For_User_dependent_access_control">Host and/or User dependent access control</A></STRONG><BR>
  204. <DD>
  205. <DT><STRONG><A NAME="item_Host_and%2For_User_dependent_encryption">Host and/or User dependent encryption</A></STRONG><BR>
  206. <DD>
  207. <DT><STRONG><A NAME="item_Changing_UID_and%2For_GID_after_binding_to_the_por">Changing UID and/or GID after binding to the port</A></STRONG><BR>
  208. <DD>
  209. <DT><STRONG>Running in a <CODE>chroot()</CODE> environment</STRONG><BR>
  210. <DD>
  211. </DL>
  212. <P>Additionally the server offers you query restrictions. Suggest the
  213. following client list:</P>
  214. <PRE>
  215.     'clients' => [
  216.         { 'mask' => '^admin\.company\.com$',
  217.           'accept' => 1,
  218.           'users' => [ 'root', 'wwwrun' ],
  219.         },
  220.         {
  221.           'mask' => '^admin\.company\.com$',
  222.           'accept' => 1,
  223.           'users' => [ 'root', 'wwwrun' ],
  224.           'sql' => {
  225.                'select' => 'SELECT * FROM foo',
  226.                'insert' => 'INSERT INTO foo VALUES (?, ?, ?)'
  227.                }
  228.         }</PRE>
  229. <P>then only the users root and wwwrun may connect from admin.company.com,
  230. executing arbitrary queries, but only wwwrun may connect from other
  231. hosts and is restricted to</P>
  232. <PRE>
  233.     $sth->prepare("select");</PRE>
  234. <P>or</P>
  235. <PRE>
  236.     $sth->prepare("insert");</PRE>
  237. <P>which in fact are ``SELECT * FROM foo'' or ``INSERT INTO foo VALUES (?, ?, ?)''.</P>
  238. <P>
  239. <HR>
  240. <H1><A NAME="author">AUTHOR</A></H1>
  241. <PRE>
  242.     Copyright (c) 1997    Jochen Wiedmann
  243.                           Am Eisteich 9
  244.                           72555 Metzingen
  245.                           Germany</PRE>
  246. <PRE>
  247.                           Email: joe@ispsoft.de
  248.                           Phone: +49 7123 14881</PRE>
  249. <P>The DBI::ProxyServer module is free software; you can redistribute it
  250. and/or modify it under the same terms as Perl itself. In particular
  251. permission is granted to Tim Bunce for distributing this as a part of
  252. the DBI.</P>
  253. <P>
  254. <HR>
  255. <H1><A NAME="see also">SEE ALSO</A></H1>
  256. <P><EM>dbiproxy(1)</EM>, <A HREF="../../../DBD/Proxy(3).html">the DBD::Proxy(3) manpage</A>, <EM>DBI(3)</EM>, <A HREF="../../../RPC/PlServer(3).html">the RPC::PlServer(3) manpage</A>,
  257. <A HREF="../../../RPC/PlClient(3).html">the RPC::PlClient(3) manpage</A>, <A HREF="../../../Net/Daemon(3).html">the Net::Daemon(3) manpage</A>, <A HREF="../../../Net/Daemon/Log(3).html">the Net::Daemon::Log(3) manpage</A>,
  258. <A HREF="../../../Sys/Syslog(3).html">the Sys::Syslog(3) manpage</A>, <A HREF="../../../Win32/EventLog(3).html">the Win32::EventLog(3) manpage</A>, <EM>syslog(2)</EM></P>
  259. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  260. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  261. <STRONG><P CLASS=block> DBI::ProxyServer - a server for the DBD::Proxy driver</P></STRONG>
  262. </TD></TR>
  263. </TABLE>
  264.  
  265. </BODY>
  266.  
  267. </HTML>
  268.