Version 2.2 Fork / Login Form

.gitignore

@@ -3,6 +3,7 @@
 /nbproject/
 /doctemp/
 /docs/
+/configs/auth.sqlite3
 /configs/config.php
 /configs/config_live.php
 /configs/config_old.php

CHANGELOG

@@ -6,8 +6,41 @@
  * @copyright Lex Brugman <lex_brugman@users.sourceforge.net>
  * @copyright Christian Beer <djangofett@gmx.net>
  * @copyright Ricardo Padilha <ricardo@droboports.com>
+ * @copyright Michael Keck <https://github.com/mkkeck>
  */
 
+
+2020-01-22
+----------
+Changes: Alexander Preußner
+* Added field "Expiry Date" for automatic Expire Accounts
+
+2019-03-19
+----------
+Changes: Tom Larédo
+* Added field "SSH public key" for SFTP management
+
+2017-03-16
+----------
+Changes: Michael Keck <https://github.com/mkkeck>
+* Login form
+* Added session class for login form
+* Display different navigations user is logged in / logged out
+* Added security for Apache Webserver:
+  - `configs/`  not accessible via browser
+  - `includes/` not accessible via browser
+* Moved `tables*.sql` to `install/tables*.sql`
+* Added `install/config-examples` for Linux Distributions
+* Added `install/config-examples/debian` as example and info how to
+  setup on Debian Jessie
+* Added config param `force_ssl` and check if secured connection is
+  used if `$cfg['force_ssl'] = true'`
+* Fixed typos in follow files:
+  - `README.md`
+  - `includes/Session.php`
+  - `configs/config_sample.php`
+  - `install/config-example/debian/config-example.php`
+
 Release: 2.2
 Changes:
 * added UID/GID limits (from Greg Arnold)

README.md

@@ -2,137 +2,223 @@
 
 Graphical User Interface for ProFTPd with MySQL and sqlite3 support
 
-&copy; 2004 The Netherlands, Lex Brugman <lex_brugman@users.sourceforge.net><br/>
-&copy; 2012 Christian Beer <djangofett@gmx.net><br/>
-&copy; 2015 Ricardo Padilha <ricardo@droboports.com>
 
-Published under the GPLv2 License (see LICENSE for details)
 
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License version 2,
-as published by the Free Software Foundation.
+## About ProFTPd Admin
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, download from http://www.gnu.org/licenses/gpl-2.0.txt
+This GUI for ProFTPd was written to support a basic user management feature
+when using the SQL module. Originally written by Lex Brugmann in 2004, 
+updated by [Christian Beer](https://github.com/ChristianBeer/ProFTPd-Admin)
+in 2012 to support the latest PHP version.  
+2017 updated by [Michael Keck](https://github.com/mkkeck) with build-in login for
+the admin user, secure the directories _`configs/`_ and _`includes`_ and moved 
+_`tables*.sql`_ to _`install/tables*.sql`_.
+Added _`install/config-examples`_ for [OS specific configurations](install/config-examples).
 
-## Information about ProFTPd Admin
+It's possible to use either of SHA1 and pbkdf2 with either of MySQL/MariaDB 
+and sqlite3. pbkdf2 is supported since ProFTPd 1.3.5.
 
-This GUI for ProFTPd was written to support a basic user management feature when using the SQL module. Originally written by Lex Brugmann in 2004 it was updated by Christian Beer in 2012 to support the latest PHP version.
+You can look at some [screenshots](screenshots/README.md) to see if this is 
+the tool you need.
 
-There is no build-in security, so you have to protect the directory with something else, like Apache Basic Authentication.
 
-It's possible to use either of SHA1 and pbkdf2 with either of MySQL/MariaDB and sqlite3. pbkdf2 is supported since ProFTPd 1.3.5.
 
-You can look at some [screenshots](screenshots/README.md) to see if this is the tool you need.
+## Installation
 
-## To-Do
+**Note:**  
+Please use, if available, a secured connection to your webserver via `https`.
+You can do this by your webserver configurations or simple set in the
+_`config.php`_:
+```php
+/**
+ * Force SSL usage
+ *
+ * Important: You should change this to true on live systems or configure
+ *            your webserver to use SSL!
+ */
+$cfg['force_ssl'] = true; // default was false
+```
+Please notice that you need a SSL-certificate to use secured connection.
 
-* add postgresql support (#26)
-* Add default user settings to groups so it is easier to create a new user with default values (#28)
-* Email new users with password (#35)
 
-## Upgrade
+#### (A) Using MySQL and SHA1
 
-If you want to upgrade the hashing algorithm you have to change all passwords after changing the configs (both ProFTPd and ProFTPd Admin).
+1. Install ProFTPd with MySQL support
+2. Create a MySQL database, for example: "proftpd".
+3. Use the file [install/tables.sql](install/tables.sql) to populate the database.
+4. Add the following to your _`proftpd.conf`_ and _`sql.conf`_ (edit to your needs):
+
+```ini
+CreateHome            on 775
+AuthOrder             mod_sql.c
+
+SQLBackend            mysql
+SQLEngine             on
+SQLPasswordEngine     on
+SQLAuthenticate       on
+SQLAuthTypes          SHA1
+
+SQLConnectInfo        database@localhost username password
+SQLUserInfo           users userid passwd uid gid homedir shell
+SQLGroupInfo          groups groupname gid members
+SQLUserWhereClause    "disabled != 1"
+SQLLog PASS           updatecount
+SQLNamedQuery         updatecount UPDATE "login_count=login_count+1, last_login=now() WHERE userid='%u'" users
+
+# Used to track xfer traffic per user (without invoking a quota)
+SQLLog RETR           bytes-out-count
+SQLNamedQuery         bytes-out-count UPDATE "bytes_out_used=bytes_out_used+%b WHERE userid='%u'" users
+SQLLog RETR           files-out-count
+SQLNamedQuery         files-out-count UPDATE "files_out_used=files_out_used+1 WHERE userid='%u'" users
+
+SQLLog STOR           bytes-in-count
+SQLNamedQuery         bytes-in-count UPDATE "bytes_in_used=bytes_in_used+%b WHERE userid='%u'" users
+SQLLog STOR           files-in-count
+SQLNamedQuery         files-in-count UPDATE "files_in_used=files_in_used+1 WHERE userid='%u'" users
+```
 
-## Installation
+5. Extract all files to your webspace (into a subdirectory like _`proftpdadmin`_).
+6. Copy the _`configs/config_example.php`_ to _**`config.php`**_ and edit the new copied file
+   to your needs.  
+**Notice:** Change the default login settings!
+ ```php
+/**
+  * Login data
+  *
+  * Important: Please change this values in
+  *            live systems!
+  */
+$cfg['login'] = array(
+  /* Username. Please use any username you want */
+  'username' => 'admin',
+  /* Password. CHANGE IT and use secure password! */
+  'password' => 'password',
+  /* Blowfish secret key (22 chars). CHANGE IT! */
+  'blowfish' => 'XBu5pjOTa8H7UIwYSzMZxD'
+);
+```
+7. Optional remove or secure the folder _`install`_.
+8. Start ProFTPd.
+9. Go to `http://your.server.com/proftpdadmin/` and start using it!
 
-### Using MySQL and SHA1
 
-1. Install ProFTPd with MySQL support
-     - Debian: apt-get install proftpd-mod-mysql
-     - Gentoo: USE="mysql" emerge proftpd
-2. Create a MySQL database (use something like phpMyAdmin for this), for example: "proftpd".
-3. Use tables.sql to populate the database (you can use phpMyAdmin for this).
-4. Add the following to your proftpd.conf and sql.conf (edit to your needs):
+#### (B) Using sqlite3 and pbkdf2
 
-```
-CreateHome              on 775
-AuthOrder               mod_sql.c
-
-SQLBackend              mysql
-SQLEngine               on
-SQLPasswordEngine       on
-SQLAuthenticate         on
-SQLAuthTypes            SHA1
-
-SQLConnectInfo          database@localhost username password
-SQLUserInfo             users userid passwd uid gid homedir shell
-SQLGroupInfo            groups groupname gid members
-SQLUserWhereClause      "disabled != 1"
-SQLLog PASS             updatecount
-SQLNamedQuery           updatecount UPDATE "login_count=login_count+1, last_login=now() WHERE userid='%u'" users
-
- # Used to track xfer traffic per user (without invoking a quota)
-SQLLog RETR             bytes-out-count
-SQLNamedQuery           bytes-out-count UPDATE "bytes_out_used=bytes_out_used+%b WHERE userid='%u'" users
-SQLLog RETR             files-out-count
-SQLNamedQuery           files-out-count UPDATE "files_out_used=files_out_used+1 WHERE userid='%u'" users
-
-SQLLog STOR             bytes-in-count
-SQLNamedQuery           bytes-in-count UPDATE "bytes_in_used=bytes_in_used+%b WHERE userid='%u'" users
-SQLLog STOR             files-in-count
-SQLNamedQuery           files-in-count UPDATE "files_in_used=files_in_used+1 WHERE userid='%u'" users
+1. Install ProFTPd with sqlite3 support
+2. Use [install/tables-sqlite3.sql](install/tables-sqlite3.sql) to create an sqlite3 database:
+   `sqlite3 auth.sqlite3 < install/tables-sqlite3.sql`
+3. Add the following to your _`proftpd.conf`_ and _`sql.conf`_ (edit to your needs):
+
+```ini
+CreateHome            on 775
+AuthOrder             mod_sql.c
+
+SQLBackend            sqlite3
+SQLEngine             on
+SQLPasswordEngine     on
+SQLAuthenticate       on
+SQLAuthTypes          pbkdf2
+SQLPasswordPBKDF2     sha1 5000 20
+SQLPasswordUserSalt   name Prepend
+SQLPasswordEncoding   hex
+
+SQLConnectInfo        /path/to/auth.sqlite3
+SQLUserInfo           users userid passwd uid gid homedir shell
+SQLGroupInfo          groups groupname gid members
+SQLUserWhereClause    "disabled != 1"
+SQLLog PASS           updatecount
+SQLNamedQuery         updatecount UPDATE "login_count=login_count+1, last_login=now() WHERE userid='%u'" users
+
+# Used to track xfer traffic per user (without invoking a quota)
+SQLLog RETR           bytes-out-count
+SQLNamedQuery         bytes-out-count UPDATE "bytes_out_used=bytes_out_used+%b WHERE userid='%u'" users
+SQLLog RETR           files-out-count
+SQLNamedQuery         files-out-count UPDATE "files_out_used=files_out_used+1 WHERE userid='%u'" users
+
+SQLLog STOR           bytes-in-count
+SQLNamedQuery         bytes-in-count UPDATE "bytes_in_used=bytes_in_used+%b WHERE userid='%u'" users
+SQLLog STOR           files-in-count
+SQLNamedQuery         files-in-count UPDATE "files_in_used=files_in_used+1 WHERE userid='%u'" users
 ```
 
-5. Extract all files to your webspace (into a subdirectory like "proftpdadmin").
-6. Secure access to this directory (for example: create a .htaccess file if using apache)
-7. Edit the configs/config_example.php file to your needs and rename it to config.php.
+5. Extract all files to your webspace (into a subdirectory like _`proftpdadmin`_).
+6. Copy the _`configs/config_example.php`_ to _**`config.php`**_ and edit the new copied file
+   to your needs.  
+  **Notice:** Change the default login settings!
+```php
+/**
+  * Login data
+  *
+  * Important: Please change this values in
+  *            live systems!
+  */
+$cfg['login'] = array(
+  /* Username. Please use any username you want */
+  'username' => 'admin',
+  /* Password. CHANGE IT and use secure password! */
+  'password' => 'password',
+  /* Blowfish secret key (22 chars). CHANGE IT! */
+  'blowfish' => 'XBu5pjOTa8H7UIwYSzMZxD'
+);
+```
+7. Optional remove or secure the folder _`install`_.
 8. Start ProFTPd.
-9. Go to http://yourwebspace/proftpdadmin/ and start using it!
+9. Go to `http://your.server.com/proftpdadmin/` and start using it!
 
-### Using sqlite3 and pbkdf2
 
-1. Install ProFTPd with sqlite3 support
-2. Use tables-sqlite3.sql to create an sqlite3 database:
-   `sqlite3 auth.sqlite3 < tables-sqlite3.sql`
-3. Add the following to your proftpd.conf and sql.conf (edit to your needs):
+### Upgrade
+
+If you want to upgrade the hashing algorithm you have to change all passwords after
+changing the configs (both ProFTPd and ProFTPd Admin).
 
-```
-CreateHome              on 775
-AuthOrder               mod_sql.c
-
-SQLBackend              sqlite3
-SQLEngine               on
-SQLPasswordEngine       on
-SQLAuthenticate         on
-SQLAuthTypes            pbkdf2
-SQLPasswordPBKDF2       sha1 5000 20
-SQLPasswordUserSalt     name Prepend
-SQLPasswordEncoding     hex
-
-SQLConnectInfo          /path/to/auth.sqlite3
-SQLUserInfo             users userid passwd uid gid homedir shell
-SQLGroupInfo            groups groupname gid members
-SQLUserWhereClause      "disabled != 1"
-SQLLog PASS             updatecount
-SQLNamedQuery           updatecount UPDATE "login_count=login_count+1, last_login=now() WHERE userid='%u'" users
-
- # Used to track xfer traffic per user (without invoking a quota)
-SQLLog RETR             bytes-out-count
-SQLNamedQuery           bytes-out-count UPDATE "bytes_out_used=bytes_out_used+%b WHERE userid='%u'" users
-SQLLog RETR             files-out-count
-SQLNamedQuery           files-out-count UPDATE "files_out_used=files_out_used+1 WHERE userid='%u'" users
-
-SQLLog STOR             bytes-in-count
-SQLNamedQuery           bytes-in-count UPDATE "bytes_in_used=bytes_in_used+%b WHERE userid='%u'" users
-SQLLog STOR             files-in-count
-SQLNamedQuery           files-in-count UPDATE "files_in_used=files_in_used+1 WHERE userid='%u'" users
-```
 
-5. Extract all files to your webspace (into a subdirectory like "proftpdadmin").
-6. Secure access to this directory (for example: create a .htaccess file if using apache)
-7. Edit the configs/config_example.php file to your needs and rename it to config.php.
-8. Start ProFTPd.
-9. Go to http://yourwebspace/proftpdadmin/ and start using it!
 
-## Thanks / Links
+## Plans
+
+* Add postgresql support  
+  » [Issue #26 / Feature request](https://github.com/ChristianBeer/ProFTPd-Admin/issues/26)
+
+* Add default user settings to groups so it is easier to create a new user
+  with default values  
+  » [Issue #28 / Feature request](https://github.com/ChristianBeer/ProFTPd-Admin/issues/28)
+
+* Send e-mail to new users with their password  
+  » [Issue #35 / Feature request](https://github.com/ChristianBeer/ProFTPd-Admin/issues/35)
+
+
+
+## Thanks
+
+- Lex Brugman for initiating this project 
+- Justin Vincent for the ezSQL library 
+- Ricardo Padilha for implementing sqlite3, pbkdf2 and bootstrap support
+- Christian Beer for his update to support the latest PHP version
+- Robert Tulke for the Debian Jessie example
+
+
+
+## Copyright / License
+
+- © 2004 The Netherlands, Lex Brugman; lex_brugman@users.sourceforge.net
+- © 2012 Christian Beer; djangofett@gmx.net
+- © 2015 Ricardo Padilha; ricardo@droboports.com
+- © 2017 Robert Tulke; https://github.com/rtulke/
+- © 2017 Michael Keck; https://github.com/mkkeck
+
+---------------------------------------------------------------------------
+
+Published under the GPLv2 License (see [LICENSE](LICENSE) for details)
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+version 2, as published by the Free Software Foundation.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
+GNU General Public License for more details.
 
-Lex Brugman for initiating this project<br/>
-Justin Vincent for the ezSQL library<br/>
-Ricardo Padilha for implementing sqlite3, pbkdf2 and bootstrap support
+You should have received a copy of the GNU General Public License along with
+this program; if not, download from 
+[http://www.gnu.org/licenses/gpl-2.0.txt](http://www.gnu.org/licenses/gpl-2.0.txt)

add_group.php

@@ -11,9 +11,11 @@
  *
  */
 
+global $cfg;
+
 include_once ("configs/config.php");
+include_once ("includes/Session.php");
 include_once ("includes/AdminClass.php");
-global $cfg;
 
 $ac = new AdminClass($cfg);