incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ran...@apache.org
Subject cvs commit: incubator-ftpserver/src/java/org/apache/ftpserver/gui/help user.html ldap.html jdbc.html ip.html index.html
Date Sun, 27 Apr 2003 16:24:13 GMT
rana_b      2003/04/27 09:24:13

  Modified:    src/java/org/apache/ftpserver/gui/help user.html ldap.html
                        jdbc.html ip.html index.html
  Log:
  changed UI help pages
  
  Revision  Changes    Path
  1.2       +7 -7      incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/user.html
  
  Index: user.html
  ===================================================================
  RCS file: /home/cvs/incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/user.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- user.html	31 Mar 2003 06:50:24 -0000	1.1
  +++ user.html	27 Apr 2003 16:24:13 -0000	1.2
  @@ -10,21 +10,21 @@
       <h1 align="center"><font face="Arial" color="#663300"><i>Default
User Manager</i></font></h1>
   
       <p><font face="Arial" size="3">The default user manager is properties file
based. All the user 
  -    informations (login, password, home directory, upload/download rate etc.) are stored
in 
  -    <u>&lt;CONFIG_DATA&gt;/user.properties</u> file. 
  -    The default user manager class is <u>ranab.server.ftp.usermanager.PropertiesUserManager</u>
  +      informations (login, password, home directory, upload/download rate etc.) are stored
in 
  +      <u>user.properties</u> file. The default user manager class is <u>org.apache.ftpserver.usermanager.PropertiesUserManager</u>
  +      If you want to use different user manager, please change the <u>user-manager</u>
block in <u>assembly.xml</u> file.
       </font></p>
   
  -    <p><font face="Arial" size="3">You can encrypt the password by specifying

  -    <u>FtpServer.server.config.prop.encrypt</u> key. The encryption algorithm
is MD5.</font></p>
  +    <p><font face="Arial" size="3">You can encrypt the password in properties
based user manager by specifying 
  +       <u>encrypt</u> key in <u>config.xml</u> file. The encryption
algorithm is MD5.</font></p>
       
       <p><font face="Arial" size="3" color="red">If you are using property file
based default user manager, 
       make sure that the user properties file is not accesible by the FTP users. Otherwise
it will be 
       a security problem. Keep it below the user virtual root directory.</font>
   
       <p><font face="Arial" size="3">You can change the default user manager
or even write your own user manager
  -    by overriding <u>ranab.server.ftp.usermanager.UserManager</u> class. You
have to specify your user manager class 
  -    (fully qualified) in the configuration file. The configuration parameter is : <u>FtpServer.server.config.user.manager</u>.
  +       by implementating <u>org.apache.ftpserver.usermanager.UserManagerInterface</u>
class. 
  +       You have to specify your user manager class (fully qualified) in the assembly file
too.
       </font></p>  
   
   </body>
  
  
  
  1.2       +30 -17    incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/ldap.html
  
  Index: ldap.html
  ===================================================================
  RCS file: /home/cvs/incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/ldap.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- ldap.html	31 Mar 2003 06:50:24 -0000	1.1
  +++ ldap.html	27 Apr 2003 16:24:13 -0000	1.2
  @@ -32,7 +32,7 @@
       </ul>
     
      <p><font face="Arial" size="3">Some of the above mentioned attribute types
are created by 
  -   <u>&lt;INSTALL_DIR&gt;/apps/ftp/conf/ftp-db.ldif</u> schema file.
The schema file also creates an object class called 
  +   <u>src/conf/ftp-db.ldif</u> schema file. The schema file also creates an
object class called 
      <i>ftpUsers</i> derived from 
      <i>inetOrgPerson</i> and have all these attributes.<br>
      Assumed LDAP objectclass hierarchy:</font></p>
  @@ -48,44 +48,57 @@
           ftpUsers
      </font></pre>
   
  -  <p><font face="Arial" size="3">Load LDAP schema <u>&lt;INSTALL_DIR&gt;/apps/ftp/conf/ftp-db.ldif</u>
to add user manager 
  +  <p><font face="Arial" size="3">Load LDAP schema <u>src/conf/ftp-db.ldif</u>
to add user manager 
     attributes. The commands to load the schema is</font></p>
     
  -  <pre><font face="Arial" size="2">ldapmodify -v -h localhost -p 389 -D &quot;cn=Directory
Manager&quot; -w &lt;password&gt; -f ftp-db.ldif</font></pre>
  +  <pre><font face="Arial" size="3">ldapmodify -v -h localhost -p 389 -D &quot;cn=Directory
Manager&quot; -w &lt;password&gt; -f ftp-db.ldif</font></pre>
     <p><font face="Arial" size="3">Please change host, port, user and password
parameters.</font></p>
   
  -  <p><font face="Arial" size="3">The LDAP connectivity information is provided
as configuration options that are passed
  -  through to the config object used to create JNDI initial context. The standard LDAP JNDI
properties used include the following:</font></p>
  +  <p><font face="Arial" size="3">The first step is to make sure that we are
using the right user manager implementation. 
  +    The fully qualified name of the LDAP based user manager is <em>org.apache.ftpserver.LdapUserManager</em>.
  +    So we have to use this class name in <em>ftp-assembly.xml</em> file. The
user-manager block should be:</font></p>
  +   
  +  <pre><font size="3">
  +  &lt;!-- user manager block --&gt;
  +  &lt;block class=&quot;org.apache.ftpserver.usermanager.LdapUserManager&quot;
name=&quot;user-manager&quot;/&gt;  
  +  </font></pre>
   
  +  <p><font face="Arial" size="3">The next step is to use appropriate configuration
parameters. So we have to modify <em>ftp-config.xml</em> file.</font></p>
  +  <pre><font size="3">
  +&lt;!-- LDAP based user manager --&gt;
  +&lt;url&gt;ldap://localhost:389&lt;/url&gt;
  +&lt;admin&gt;cn=Directory Manager&lt;/admin&gt;
  +&lt;password&gt;password&lt;/password&gt;
  +&lt;authentication&gt;simple&lt;/authentication&gt;  
  +&lt;root&gt;ou=people,o=apache.org&lt;/root&gt;
  +&lt;prefix&gt;uid=&lt;/prefix&gt;
  +&lt;suffix&gt;,ou=people,o=apache.org&lt;/suffix&gt;
  +  </font></pre>
     <ul>
       <li><font face="Arial" size="3">
  -      <u>FtpServer.server.config.user.manager</u> - set it <code>ranab.server.ftp.usermanager.LdapUserManager</code>.

  -      This is the fully qualified name of the LDAP based user manager.
  -    </font></li>
  -    <li><font face="Arial" size="3">
  -      <u>FtpServer.server.config.ldap.url</u> - The ldap URL for the LDAP server.
For example, 
  +      <u>url</u> - The ldap URL for the LDAP server. For example, 
         ldap://localhost:389 URL means LDAP has been installed in the local machine and the
port is 389.
       </font></li>
       <li><font face="Arial" size="3">
  -      <u>FtpServer.server.config.ldap.admin</u> - This is the distinguished
name (DN) of the LDAP administrator.
  +      <u>admin</u> - This is the distinguished name (DN) of the LDAP administrator.
       </font></li>
       <li><font face="Arial" size="3">
  -      <u>FtpServer.server.config.ldap.password</u> - LDAP administrator's password.
  +      <u>password</u> - LDAP administrator's password.
       </font></li>
       <li><font face="Arial" size="3">
  -      <u>FtpServer.server.config.ldap.authentication</u> - Security level to
use. This defaults to &quot;simple&quot;.
  +      <u>authentication</u> - Security level to use. This defaults to &quot;simple&quot;.
       </font></li>
       <li><font face="Arial" size="3">
  -      <u>FtpServer.server.config.ldap.root</u> - The LDAP root where the ftp
users will be stored.
  +      <u>root</u> - The LDAP root where the ftp users will be stored.
       </font></li>
       <li><font face="Arial" size="3">
  -      <u>FtpServer.server.config.ldap.dn.prefix</u> - A prefix to add to the
username to form the user distinguished name (DN). 
  +      <u>prefix</u> - A prefix to add to the username to form the user distinguished
name (DN). 
         See FtpServer.server.config.ldap.dn.prefix for more info..
       </font></li>
       <li><font face="Arial" size="3">
  -      <u>FtpServer.server.config.ldap.dn.suffix</u> - suffix to add to the
username when forming the user distiguished name (DN). 
  +      <u>suffix</u> - suffix to add to the username when forming the user distiguished
name (DN). 
         This is useful if you prompt a user for a username and you don't want the user to
have to enter the fully distinguished name. 
  -      Using this property and <code>FtpServer.server.config.ldap.dn.prefix</code>
the userDN will be formed as: <br>
  +      Using this property and <code>prefix</code> the userDN will be formed
as: <br>
         <i>String userDN = prefix + username + suffix;</i>
       </font></li>
   </ul>
  
  
  
  1.2       +27 -10    incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/jdbc.html
  
  Index: jdbc.html
  ===================================================================
  RCS file: /home/cvs/incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/jdbc.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- jdbc.html	31 Mar 2003 06:50:24 -0000	1.1
  +++ jdbc.html	27 Apr 2003 16:24:13 -0000	1.2
  @@ -10,8 +10,7 @@
       <h1 align="center"><font face="Arial" color="#663300"><i>Database
Support</i></font></h1>
       
       <p><font face="Arial" size="3"><i>DbUserManager</i> is a JDBC
based user manager. You can use this module if you have your FTP
  -    username, password and other informations in a JDBC accessible database. To be able
to access the database driver either
  -    put your JDBC driver in your CLASSPATH or modify the batch files to include it.</font></p>
  +    username, password and other informations in a JDBC accessible database.</font></p>
   
       <p align="left"><font face="Arial" size="3">This user manager has been
tested using Oracle 8i and mySQL server. 
       All the user informations are stored in <i>FTP_USER</i> table. Database
based user manager will try to create 
  @@ -56,17 +55,35 @@
      </table>
   
   
  -   <p><font face="Arial" size="3">Load the SQL file - <u>&lt;INSTALL_DIR&gt;apps/ftp/conf/ftp-db.sql</u></font>.</p>
  -      
  +   <p><font face="Arial" size="3">Load the SQL file - <u>src/conf/ftp-db.sql</u></font>.</p>
  +   <p><font face="Arial" size="3">
  +     The first step is to make sure that we are using the right user manager implementation.

  +     The fully qualified name of the LDAP based user manager is <em>org.apache.ftpserver.DbUserManager</em>.
  +     So we have to use this class name in <em>ftp-assembly.xml</em> file. The
user-manager block should be:
  +   </font></p>
  +   <pre><font size="3">
  +&lt;!-- user manager block --&gt;
  +&lt;block class=&quot;org.apache.ftpserver.usermanager.DbUserManager&quot;
name=&quot;user-manager&quot;/&gt;
  +   </font></pre>
  +  
      <p><font face="Arial" size="3">The JDBC connectivity information is provided
as configuration options that are passed
      through to the config object used to create JDBC connection. The standard JDBC properties
used include the following:</font></p>
  +   <pre><font size="3">
  +&lt;!-- Database based user manager --&gt;
  +&lt;driver&gt;org.gjt.mm.mysql.Driver&lt;/driver&gt;
  +&lt;url&gt;jdbc:mysql://localhost/ftpDB&lt;/url&gt;
  +&lt;user&gt;user&lt;/user&gt;
  +&lt;password&gt;password&lt;/password&gt;
  +   </pre></font>   
  +
      <ul>
  -     <li><font face="Arial" size="3"><u>FtpServer.server.config.user.manager</u>
- set it <i>ranab.server.ftp.usermanager.DbUserManager</i>. This is the fully
qualified name of the JDBC based user manager class.</font></li>
  -     <li><font face="Arial" size="3"><u>FtpServer.server.config.db.driver</u>
- JDBC driver class (fully qualified).</font></li>
  -     <li><font face="Arial" size="3"><u>FtpServer.server.config.db.url</u>
- JDBC database URL.</font></li>
  -     <li><font face="Arial" size="3"><u>FtpServer.server.config.db.user</u>
- Database user.</font></li>
  -     <li><font face="Arial" size="3"><u>FtpServer.server.config.db.password</u>
- Database password.</font></li>
  +     <li><font face="Arial" size="3"><u>driver</u> - JDBC driver
class (fully qualified).</font></li>
  +     <li><font face="Arial" size="3"><u>url</u> - JDBC database
URL.</font></li>
  +     <li><font face="Arial" size="3"><u>user</u> - Database user.</font></li>
  +     <li><font face="Arial" size="3"><u>password</u> - Database
password.</font></li>
      </ul>
  -  
  +   
  +   <p><font face="Arial" size="3">Besides these, you need to copy the driver
jar file in the lib directory.</font></p>
  +
   </body>
   </html>
  
  
  
  1.2       +6 -5      incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/ip.html
  
  Index: ip.html
  ===================================================================
  RCS file: /home/cvs/incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/ip.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- ip.html	31 Mar 2003 06:50:24 -0000	1.1
  +++ ip.html	27 Apr 2003 16:24:13 -0000	1.2
  @@ -9,20 +9,21 @@
   
       <h1 align="center"><font face="Arial" color="#663300"><i>IP Restriction</i></font></h1>
   
  -    <p><font face="Arial" size="3">You can either ban or allow IPs to access
the FTP server.  You can use a limited set of regular 
  +    <p><font face="Arial" size="3">You can either ban or allow IPs to access
the FTP server. You can use a limited set of regular 
       expressions (*?[^-]) to specify the allowed/banned IPs.</font></p>
   
  -    <p><font face="Arial" size="3">The configuration parameter - <i>FtpServer.server.config.ip.allow</i>
specifies whether to allow/deny 
  -    IPs. IP informations are stored in <u>&lt;CONFIG_DATA&gt;/ip.properties</u>
file.</font></p>
  +    <p><font face="Arial" size="3">The IP restrictor component name is <u>ip-restrictor</u>.
  +    The configuration parameter - <u>allow-ip</u> specifies whether to allow/deny

  +    IPs. IP informations are stored in <u>ip.properties</u> file.</font></p>
       
       <p><font face="Arial"><b>Examples:</b></font></p>
  -    <p><font face="Arial" size="3"><u>FtpServer.server.config.ip.allow=false</u>
bans all the specified IPs.<br>
  +    <p><font face="Arial" size="3"><u>allow-ip=false</u> bans all
the specified IPs.<br>
       <u>123.234.111.*</u> will ban all IPs from 123.234.111.0 to 123.234.111.255<br>
       <u>123.234.111.22?</u> will ban all IPs from 123.234.111.220 to 123.234.111.229<br>
       <u>123.234.111.2[1-3]1</u> will ban 123.234.111.211, 123.234.111.221, 123.234.111.231<br>
       <u>123.234.111.2[^1-7]1</u> will ban 123.234.111.201, 123.234.111.281,
123.234.111.291<br>
       </font></p>
       
  -    <p><font face="Arial" size="3">Similarly, <u>FtpServer.server.config.ip.allow=true</u>
will only allow the specified IPs.</font></p>
  +    <p><font face="Arial" size="3">Similarly, <u>allow-ip=true</u>
will only allow the specified IPs.</font></p>
   </body>
   </html>
  
  
  
  1.2       +0 -1      incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/index.html
  
  Index: index.html
  ===================================================================
  RCS file: /home/cvs/incubator-ftpserver/src/java/org/apache/ftpserver/gui/help/index.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.html	31 Mar 2003 06:50:24 -0000	1.1
  +++ index.html	27 Apr 2003 16:24:13 -0000	1.2
  @@ -31,7 +31,6 @@
       <li><font face="Arial" size="3">Anonymous login support. Default users
<u>admin/admin</u> and <u>anonymous</u> will be created by the server
when you start it for the first time.</font></li>
       <li><font face="Arial" size="3">The server reloads the user data at a regular
interval if necessary.</font></li>
       <li><font face="Arial" size="3">New user managers can be added very easily.</font></li>
  -    <li><font face="Arial" size="3">For better performance the server can be
started without any user interface by executing <u>java ranab.server.ftp.FtpServer &lt;config
file&gt;</u>.</font></li>
       <li><font face="Arial" size="3">Ftp user informations can be stored in
database.</font></li>
       <li><font face="Arial" size="3">LDAP server can be used to store and authenticate
FTP users.</font></li>
       <li><font face="Arial" size="3">Tested with different FTP clients like

  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message