| <!DOCTYPE html>
|
|
|
| <html lang="en">
|
| <head>
|
| <title>FtpServer Managing users — Apache MINA</title>
|
|
|
| <link href="/assets/css/common.css" rel="stylesheet" type="text/css"/>
|
| <link href="/assets/css/ftpserver.css" rel="stylesheet" type="text/css"/>
|
| </head>
|
| <body>
|
| <script src="https://www.apachecon.com/event-images/snippet.js"></script>
|
| <div id="container">
|
| <div id="header">
|
| <div id="subProjectsNavBar">
|
| <a href="/">
|
|
|
| Apache MINA Project
|
|
|
| </a>
|
| |
|
| <a href="/mina-project/">
|
|
|
| MINA
|
|
|
| </a>
|
| |
|
| <a href="/asyncweb-project/">
|
|
|
| AsyncWeb
|
|
|
| </a>
|
| |
|
| <a href="/ftpserver-project/">
|
|
|
| <strong>FtpServer</strong>
|
|
|
| </a>
|
| |
|
| <a href="/sshd-project/">
|
|
|
| SSHD
|
|
|
| </a>
|
| |
|
| <a href="/vysper-project/">
|
|
|
| Vysper
|
|
|
| </a>
|
| </div>
|
| </div>
|
|
|
|
|
| <div id="content">
|
| <div id="leftColumn">
|
| <div id="navigation">
|
| <a class="acevent" data-format="wide" data-width="170"></a>
|
| <h5>Social Networks</h5>
|
| <ul>
|
| <li><a href="https://fosstodon.org/@apachemina">Apache MINA Mastodon</a></li>
|
| </ul>
|
| <h5>Overview</h5>
|
| <ul>
|
| <li><a href="/ftpserver-project/index.html">Home</a> </li>
|
| <li><a href="/ftpserver-project/features.html">Features</a> </li>
|
| <li><a href="/ftpserver-project/download_1_1.html">FtpServer 1.1.4</a></li>
|
| <li><a href="/ftpserver-project/download_1_2.html">FtpServer 1.2.0</a></li>
|
| <li><a href="/ftpserver-project/old-downloads.html">Old Downloads</a></li>
|
| <li><a href="/ftpserver-project/documentation.html">Documentation</a></li>
|
| <li><a href="/ftpserver-project/gen-docs/latest-1.1/apidocs/index.html" class="external-link" rel="nofollow">API Javadoc 1.1.4</a></li>
|
| <li><a href="/ftpserver-project/gen-docs/latest-1.2/apidocs/index.html" class="external-link" rel="nofollow">API Javadoc 1.2.0</a></li>
|
| <li><a href="/ftpserver-project/getting_source.html">Sources</a></li>
|
| <li><a href="/ftpserver-project/faq.html">FAQ</a></li>
|
| <li><a href="/ftpserver-project/related_project.html">Related Project</a></li>
|
| </ul>
|
|
|
| <h5>Community</h5>
|
| <ul>
|
| <li><a href="/ftpserver-project/mailing_list.html">Mailing Lists</a></li>
|
| <li><a href="/ftpserver-project/getting_involved.html">Getting Involved</a></li>
|
| <li><a href="/ftpserver-project/reporting_bug.html">Reporting a Bug</a></li>
|
| <li><a href="/ftpserver-project/contributors.html">Contributors</a></li>
|
| <li><a href="https://www.apache.org/foundation/contributing.html">Contributing</a></li>
|
| <li><a href="https://www.apache.org/licenses/">License</a></li>
|
| <li><a href="https://www.apache.org/security/">Security</a></li>
|
| </ul>
|
|
|
| <h5>Sponsorship</h5>
|
| <ul>
|
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li>
|
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
|
| <li><a href="https://www.apache.org/">apache.org</a></li>
|
| </ul>
|
| </div>
|
| </div>
|
| <div id="rightColumn">
|
|
|
|
|
| |
| <h1 id="managing-users">Managing users</h1> |
| <p>Since FtpServer user manager might encrypt user passwords before saving them, manually administering the user database can be hard. There is basically three ways:</p> |
| <h2 id="manually">Manually</h2> |
| <p>Using either the PropertiesUserManager or DbUserManager you can access the data store (file or database) directly to edit users. For clear text passwords you can simply edit them. For MD5 hashed passwords, you can you use any of the available MD5 tools, for example <a href="http://www.iwebtool.com/md5">http://www.iwebtool.com/md5</a>, to hash the password before editing it. For salted passwords, use one of the methods described below.</p> |
| <h2 id="using-the-api">Using the API</h2> |
| <p>Using the FtpServer API, you can create a user manager, configure it as your real user manager and use that to edit users. This is a simple example:</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-java" data-lang="java">PropertiesUserManagerFactory userManagerFactory <span style="color:#666">=</span> <span style="color:#a2f;font-weight:bold">new</span> PropertiesUserManagerFactory<span style="color:#666">(</span><span style="color:#666">)</span><span style="color:#666">;</span> |
| userManagerFactory<span style="color:#666">.</span><span style="color:#b44">setFile</span><span style="color:#666">(</span><span style="color:#a2f;font-weight:bold">new</span> File<span style="color:#666">(</span><span style="color:#b44">"myusers.properties"</span><span style="color:#666">)</span><span style="color:#666">)</span><span style="color:#666">;</span> |
| userManagerFactory<span style="color:#666">.</span><span style="color:#b44">setPasswordEncryptor</span><span style="color:#666">(</span><span style="color:#a2f;font-weight:bold">new</span> SaltedPasswordEncryptor<span style="color:#666">(</span><span style="color:#666">)</span><span style="color:#666">)</span><span style="color:#666">;</span> |
| UserManager um <span style="color:#666">=</span> userManagerFactory<span style="color:#666">.</span><span style="color:#b44">createUserManager</span><span style="color:#666">(</span><span style="color:#666">)</span><span style="color:#666">;</span> |
| BaseUser user <span style="color:#666">=</span> <span style="color:#a2f;font-weight:bold">new</span> BaseUser<span style="color:#666">(</span><span style="color:#666">)</span><span style="color:#666">;</span> |
| user<span style="color:#666">.</span><span style="color:#b44">setName</span><span style="color:#666">(</span><span style="color:#b44">"myNewUser"</span><span style="color:#666">)</span><span style="color:#666">;</span> |
| user<span style="color:#666">.</span><span style="color:#b44">setPassword</span><span style="color:#666">(</span><span style="color:#b44">"secret"</span><span style="color:#666">)</span><span style="color:#666">;</span> |
| user<span style="color:#666">.</span><span style="color:#b44">setHomeDirectory</span><span style="color:#666">(</span><span style="color:#b44">"ftproot"</span><span style="color:#666">)</span><span style="color:#666">;</span> |
| um<span style="color:#666">.</span><span style="color:#b44">save</span><span style="color:#666">(</span>user<span style="color:#666">)</span><span style="color:#666">;</span> |
| </code></pre></div><h2 id="using-command-line-tool">Using command line tool</h2> |
| <p>If you’re using the XML configuration, there is a command line tool available for adding new users to your user manager.</p> |
| <p>In the examples below, make sure you update the versions to reflect the correct versions for your release</p> |
| <p>Windows:</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">java -cp ftpserver-core-1.0.0-M4.jar;ftplet-api-1.0.0-M4.jar;mina-core-2.0.0-M3.jar; |
| <span style="color:#666">[</span>slf4j-api-1.5.2.jar;<br>slf4j-simple-1.5.2.jar |
| <span style="color:#666">[</span> org.apache.ftpserver.main.AddUser path/to/your/config.xml |
| </code></pre></div><p>MacOS/Linux/Unix</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">java -cp ftpserver-core-1.0.0-M4.jar:ftplet-api-1.0.0-M4.jar:mina-core-2.0.0-M3.jar:<span style="color:#b62;font-weight:bold">\ |
| </span><span style="color:#b62;font-weight:bold"></span> slf4j-api-1.5.2.jar:<br>slf4j-simple-1.5.2.jar <span style="color:#b62;font-weight:bold">\ |
| </span><span style="color:#b62;font-weight:bold"></span> org.apache.ftpserver.main.AddUser path/to/your/config.xml |
| </code></pre></div><p>The program will ask you for the required data.</p> |
| |
|
|
|
|
|
|
| </div>
|
| <div id="endContent"></div>
|
| </div>
|
|
|
| <div id="footer">
|
| © 2003-2024, <a href="https://www.apache.org">The Apache Software Foundation</a> - <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a><br />
|
| Apache MINA, MINA, Apache Vysper, Vysper, Apache SSHd, SSHd, Apache FtpServer, FtpServer, Apache AsyncWeb, AsyncWeb,
|
| Apache, the Apache feather logo, and the Apache Mina project logos are trademarks of The Apache Software Foundation.
|
| </div>
|
|
|
| </div>
|
|
|
|
|
| </body>
|
|
|
| </html>
|
