Import Ruty
This commit is contained in:
@@ -0,0 +1,71 @@
|
|||||||
|
# This is a sample with suggested security and performance options
|
||||||
|
|
||||||
|
<IfModule mod_rewrite.c>
|
||||||
|
Options +SymLinksIfOwnerMatch
|
||||||
|
RewriteEngine On
|
||||||
|
RewriteRule ^favicon\.ico$ skins/elastic/images/favicon.ico
|
||||||
|
|
||||||
|
# security rules:
|
||||||
|
# - deny access to files not containing a dot or starting with a dot
|
||||||
|
# in all locations except installer directory
|
||||||
|
RewriteRule ^(?!installer|\.well-known\/|[a-zA-Z0-9]{16})(\.?[^\.]+)$ - [F]
|
||||||
|
# - deny access to some locations
|
||||||
|
RewriteRule ^/?(\.git|\.tx|SQL|bin|config|logs|temp|tests|vendor|program\/(include|lib|localization|steps)) - [F]
|
||||||
|
# - deny access to some documentation files
|
||||||
|
RewriteRule /?(README.*|CHANGELOG.*|SECURITY.*|meta\.json|composer\..*|jsdeps.json)$ - [F]
|
||||||
|
</IfModule>
|
||||||
|
|
||||||
|
<IfModule mod_deflate.c>
|
||||||
|
SetOutputFilter DEFLATE
|
||||||
|
</IfModule>
|
||||||
|
|
||||||
|
# prefer to brotli over gzip if brotli is available
|
||||||
|
<IfModule mod_brotli.c>
|
||||||
|
SetOutputFilter BROTLI_COMPRESS
|
||||||
|
# some assets have been compressed, so no need to do it again
|
||||||
|
SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png|web[pm]|woff2?)$ no-brotli
|
||||||
|
</IfModule>
|
||||||
|
|
||||||
|
<IfModule mod_expires.c>
|
||||||
|
ExpiresActive On
|
||||||
|
ExpiresDefault "access plus 1 month"
|
||||||
|
</IfModule>
|
||||||
|
|
||||||
|
FileETag MTime Size
|
||||||
|
|
||||||
|
<IfModule mod_autoindex.c>
|
||||||
|
Options -Indexes
|
||||||
|
</IfModule>
|
||||||
|
|
||||||
|
<IfModule mod_headers.c>
|
||||||
|
# Disable page indexing
|
||||||
|
Header set X-Robots-Tag "noindex, nofollow"
|
||||||
|
|
||||||
|
# replace 'merge' with 'append' for Apache < 2.2.9
|
||||||
|
#Header merge Cache-Control public env=!NO_CACHE
|
||||||
|
|
||||||
|
# Optional security headers
|
||||||
|
# Only provides increased security if the browser supports those features
|
||||||
|
# Be careful! Testing is required! They should be adjusted to your installation / user environment
|
||||||
|
|
||||||
|
# HSTS - HTTP Strict Transport Security
|
||||||
|
#Header always set Strict-Transport-Security "max-age=31536000; preload" env=HTTPS
|
||||||
|
|
||||||
|
# HPKP - HTTP Public Key Pinning
|
||||||
|
# Only template - fill with your values
|
||||||
|
#Header always set Public-Key-Pins "max-age=3600; report-uri=\"\"; pin-sha256=\"\"; pin-sha256=\"\"" env=HTTPS
|
||||||
|
|
||||||
|
# X-Xss-Protection
|
||||||
|
# This header is used to configure the built in reflective XSS protection found in Internet Explorer, Chrome and Safari (Webkit).
|
||||||
|
#Header set X-XSS-Protection "1; mode=block"
|
||||||
|
|
||||||
|
# X-Frame-Options
|
||||||
|
# The X-Frame-Options header (RFC), or XFO header, protects your visitors against clickjacking attacks
|
||||||
|
# Already set by php code! Do not activate both options
|
||||||
|
#Header set X-Frame-Options SAMEORIGIN
|
||||||
|
|
||||||
|
# X-Content-Type-Options
|
||||||
|
# It prevents Google Chrome and Internet Explorer from trying to mime-sniff the content-type of a response away from the one being declared by the server.
|
||||||
|
#Header set X-Content-Type-Options "nosniff"
|
||||||
|
|
||||||
|
</IfModule>
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,310 @@
|
|||||||
|
INTRODUCTION
|
||||||
|
============
|
||||||
|
|
||||||
|
This file describes the basic steps to install Roundcube Webmail on your
|
||||||
|
web server. For additional information, please also consult the project's
|
||||||
|
wiki page at https://github.com/roundcube/roundcubemail/wiki
|
||||||
|
|
||||||
|
|
||||||
|
REQUIREMENTS
|
||||||
|
============
|
||||||
|
|
||||||
|
* An IMAP, HTTP and SMTP server
|
||||||
|
* .htaccess support allowing overrides for DirectoryIndex
|
||||||
|
* PHP Version 7.3 or greater including:
|
||||||
|
- PCRE, DOM, JSON, Session, Sockets, OpenSSL, Mbstring, Filter, Ctype, Intl (required)
|
||||||
|
- PHP PDO with driver for either MySQL, PostgreSQL, SQL Server, Oracle or SQLite (required)
|
||||||
|
- Iconv, Zip, Fileinfo, Exif (recommended)
|
||||||
|
- LDAP for LDAP addressbook support (optional)
|
||||||
|
- GD, Imagick, XMLWriter (optional: thumbnails generation, QR-code)
|
||||||
|
* PEAR and PEAR packages distributed with Roundcube or external.
|
||||||
|
See composer.json-dist for the list of required packages.
|
||||||
|
* php.ini options:
|
||||||
|
- error_reporting E_ALL & ~E_NOTICE & ~E_STRICT
|
||||||
|
- memory_limit > 16MB
|
||||||
|
- file_uploads enabled (for uploading attachments and import files)
|
||||||
|
- session.auto_start disabled
|
||||||
|
- suhosin.session.encrypt disabled
|
||||||
|
- mbstring.func_overload disabled
|
||||||
|
- pcre.backtrack_limit >= 100000
|
||||||
|
* A MySQL, PostgreSQL, MS SQL Server (2005 or newer), Oracle database
|
||||||
|
or SQLite v3 support in PHP - with permission to create tables
|
||||||
|
* Composer installed either locally or globally (https://getcomposer.org)
|
||||||
|
|
||||||
|
|
||||||
|
INSTALLATION
|
||||||
|
============
|
||||||
|
|
||||||
|
1. Decompress and put this folder somewhere inside your document root.
|
||||||
|
Note: Make sure files have proper owner/group for your setup. If you use
|
||||||
|
tar command `--no-same-owner` option might be helpful.
|
||||||
|
2. In case you don't use the so-called "complete" release package,
|
||||||
|
you have to install PHP and javascript dependencies.
|
||||||
|
2.1. Install PHP dependencies using composer:
|
||||||
|
- get composer from https://getcomposer.org/download/
|
||||||
|
- rename the composer.json-dist file into composer.json
|
||||||
|
- if you want to use LDAP address books, enable the LDAP libraries in your
|
||||||
|
composer.json file by moving the items from "suggest" to the "require"
|
||||||
|
section (remove the explanation texts after the version!).
|
||||||
|
- run `php composer.phar install --no-dev`
|
||||||
|
2.2. Install Javascript dependencies by executing `bin/install-jsdeps.sh` script.
|
||||||
|
3. Make sure that the following directories (and the files within)
|
||||||
|
are writable by the webserver
|
||||||
|
- /temp
|
||||||
|
- /logs
|
||||||
|
4. Create a new database and a database user for Roundcube (see DATABASE SETUP)
|
||||||
|
5. Point your browser to http://url-to-roundcube/installer/
|
||||||
|
6. Follow the instructions of the install script (or see MANUAL CONFIGURATION)
|
||||||
|
7. After creating and testing the configuration, remove the installer directory
|
||||||
|
------------------------------------------
|
||||||
|
IMPORTANT: REMOVE THE INSTALLER DIRECTORY!
|
||||||
|
------------------------------------------
|
||||||
|
8. If you use git sources compile css files for the Elastic skin (required
|
||||||
|
lessc >= 2.5.2):
|
||||||
|
$ cd skins/elastic
|
||||||
|
$ lessc --clean-css="--s1 --advanced" styles/styles.less > styles/styles.min.css
|
||||||
|
$ lessc --clean-css="--s1 --advanced" styles/print.less > styles/print.min.css
|
||||||
|
$ lessc --clean-css="--s1 --advanced" styles/embed.less > styles/embed.min.css
|
||||||
|
9. Check Known Issues section of this file
|
||||||
|
|
||||||
|
|
||||||
|
CONFIGURATION HINTS
|
||||||
|
===================
|
||||||
|
|
||||||
|
IMPORTANT! Read all comments in defaults.inc.php, understand them
|
||||||
|
and configure your installation to be not surprised by default behaviour.
|
||||||
|
|
||||||
|
Roundcube writes internal errors to the 'errors.log' log file located in the logs
|
||||||
|
directory which can be configured in config/config.inc.php. If you want ordinary
|
||||||
|
PHP errors to be logged there as well, set error_log in php.ini or .htaccess file.
|
||||||
|
|
||||||
|
Roundcube forces display_errors=Off and log_errors=On.
|
||||||
|
|
||||||
|
By default the session cookie settings of PHP are not modified by Roundcube.
|
||||||
|
However if you want to limit the session cookies to the directory where
|
||||||
|
Roundcube resides you can set session.cookie_path in the php.ini or .htaccess file.
|
||||||
|
|
||||||
|
More about PHP settings: https://github.com/roundcube/roundcubemail/wiki/Installation#php-configuration
|
||||||
|
|
||||||
|
|
||||||
|
DATABASE SETUP
|
||||||
|
==============
|
||||||
|
|
||||||
|
Note: Database for Roundcube must use UTF-8 character set.
|
||||||
|
Note: See defaults.inc.php file for examples of DSN configuration.
|
||||||
|
|
||||||
|
* MySQL
|
||||||
|
-------
|
||||||
|
Setting up the mysql database can be done by creating an empty database,
|
||||||
|
importing the table layout and granting the proper permissions to the
|
||||||
|
roundcube user. Here is an example of that procedure:
|
||||||
|
|
||||||
|
# mysql
|
||||||
|
> CREATE DATABASE roundcubemail CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
|
||||||
|
> CREATE USER roundcube@localhost IDENTIFIED BY 'password';
|
||||||
|
> GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost;
|
||||||
|
> quit
|
||||||
|
|
||||||
|
Note 1: 'password' is the master password for the roundcube user. It is strongly
|
||||||
|
recommended you replace this with a more secure password. Please keep in
|
||||||
|
mind that you must specify this password later in 'config/config.inc.php'.
|
||||||
|
|
||||||
|
Note 2: When using MySQL < 5.7.7 or MariaDB < 10.2.2 it is required to configure
|
||||||
|
the database engine with:
|
||||||
|
innodb_large_prefix=1
|
||||||
|
innodb_file_per_table=1
|
||||||
|
innodb_file_format=Barracuda
|
||||||
|
|
||||||
|
Now you can run the Installer or configure the database access options in
|
||||||
|
'config/config.inc.php' and run: `bin/initdb.sh --dir=SQL`.
|
||||||
|
|
||||||
|
|
||||||
|
* SQLite
|
||||||
|
--------
|
||||||
|
Versions of sqlite database engine older than 3.6.19 aren't supported.
|
||||||
|
Database file and structure is created automatically by Roundcube.
|
||||||
|
Make sure your configuration points to some file location and that the
|
||||||
|
webserver can write to the file and the directory containing the file.
|
||||||
|
|
||||||
|
|
||||||
|
* PostgreSQL
|
||||||
|
------------
|
||||||
|
To use Roundcube with PostgreSQL support you have to follow these
|
||||||
|
simple steps, which have to be done as the postgres system user (or
|
||||||
|
which ever is the database superuser):
|
||||||
|
|
||||||
|
$ createuser -P roundcube
|
||||||
|
$ createdb -O roundcube -E UNICODE roundcubemail
|
||||||
|
|
||||||
|
Note: in some system configurations you might need to add '-U postgres' to
|
||||||
|
createuser and createdb commands.
|
||||||
|
|
||||||
|
Now you can run the Installer or configure the database access options in
|
||||||
|
'config/config.inc.php' and run: `bin/initdb.sh --dir=SQL`.
|
||||||
|
|
||||||
|
|
||||||
|
* Microsoft SQL Server
|
||||||
|
----------------------
|
||||||
|
Language/locale of the database must be set to us_english (1033). More info
|
||||||
|
on this at https://github.com/roundcube/roundcubemail/issues/4078.
|
||||||
|
|
||||||
|
|
||||||
|
Database cleaning
|
||||||
|
-----------------
|
||||||
|
To keep your database slick and clean we recommend to periodically execute
|
||||||
|
bin/cleandb.sh which finally removes all records that are marked as deleted.
|
||||||
|
Best solution is to install a cronjob running this script daily.
|
||||||
|
|
||||||
|
|
||||||
|
MANUAL CONFIGURATION
|
||||||
|
====================
|
||||||
|
|
||||||
|
First of all, copy the sample configuration file config/config.inc.php.sample
|
||||||
|
to config/config.inc.php and make the necessary adjustments according to your
|
||||||
|
environment and your needs. More configuration options can be copied from the
|
||||||
|
config/defaults.inc.php file into your local config.inc.php file as needed.
|
||||||
|
Read the comments above the individual configuration options to find out what
|
||||||
|
they do or read https://github.com/roundcube/roundcubemail/wiki/Installation
|
||||||
|
for even more guidance.
|
||||||
|
|
||||||
|
The maximum size of email attachments and other file uploads is controlled by
|
||||||
|
PHP settings: upload_max_filesize and post_max_size. Read more about PHP
|
||||||
|
settings at https://github.com/roundcube/roundcubemail/wiki/Installation#php-configuration.
|
||||||
|
|
||||||
|
|
||||||
|
SECURE YOUR INSTALLATION
|
||||||
|
========================
|
||||||
|
|
||||||
|
Access through the webserver to the following directories should be denied:
|
||||||
|
|
||||||
|
/config
|
||||||
|
/temp
|
||||||
|
/logs
|
||||||
|
|
||||||
|
Roundcube uses .htaccess files to protect these directories, so be sure to
|
||||||
|
allow override of the Limit directives to get them taken into account. The
|
||||||
|
package also ships a .htaccess file in the root directory which defines some
|
||||||
|
rewrite rules. In order to properly secure your installation, please enable
|
||||||
|
mod_rewrite for Apache webserver and double check access to the above listed
|
||||||
|
directories and their contents is denied.
|
||||||
|
|
||||||
|
NOTE: In Apache 2.4, support for .htaccess files has been disabled by
|
||||||
|
default. Therefore you first need to enable this in your Apache main or
|
||||||
|
virtual host config by with:
|
||||||
|
|
||||||
|
AllowOverride all
|
||||||
|
|
||||||
|
For non-apache web servers add equivalent configuration parameters to deny
|
||||||
|
direct access to these private resources.
|
||||||
|
|
||||||
|
It is also recommended to change the document root to <install path>/public_html
|
||||||
|
after installation if Roundcube runs at root of a dedicated virtual host. This
|
||||||
|
will automatically keep sensitive files out of reach for http requests.
|
||||||
|
|
||||||
|
|
||||||
|
UPGRADING
|
||||||
|
=========
|
||||||
|
|
||||||
|
If you already have a previous version of Roundcube installed,
|
||||||
|
please refer to the instructions in UPGRADING guide.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIMISING
|
||||||
|
==========
|
||||||
|
|
||||||
|
There are two forms of optimization here, compression and caching, both aimed
|
||||||
|
at increasing an end user's experience using Roundcube Webmail. Compression
|
||||||
|
allows the static web pages to be delivered with less bandwidth. The index.php
|
||||||
|
of Roundcube Webmail already enables compression on its output. The settings
|
||||||
|
below allow compression to occur for all static files. Caching sets HTTP
|
||||||
|
response headers that enable a user's web client to understand what is static
|
||||||
|
and how to cache it.
|
||||||
|
|
||||||
|
The caching directives used are:
|
||||||
|
* Etags - sets at tag so the client can request is the page has changed
|
||||||
|
* Cache-control - defines the age of the page and that the page is 'public'
|
||||||
|
This enables clients to cache javascript files that don't have private
|
||||||
|
information between sessions even if using HTTPS. It also allows proxies
|
||||||
|
to share the same cached page between users.
|
||||||
|
* Expires - provides another hint to increase the lifetime of static pages.
|
||||||
|
|
||||||
|
For more information refer to RFC 2616.
|
||||||
|
|
||||||
|
Side effects:
|
||||||
|
-------------
|
||||||
|
These directives are designed for production use. If you are using this in
|
||||||
|
a development environment you may get horribly confused if your webclient
|
||||||
|
is caching stuff that you changed on the server. Disabling the expires
|
||||||
|
parts below should save you some grief.
|
||||||
|
|
||||||
|
If you are changing the skins, it is recommended that you copy content to
|
||||||
|
a different directory apart from 'default'.
|
||||||
|
|
||||||
|
Apache:
|
||||||
|
-------
|
||||||
|
To enable these features in apache the following modules need to be enabled:
|
||||||
|
* mod_deflate
|
||||||
|
* mod_expires
|
||||||
|
* mod_headers
|
||||||
|
|
||||||
|
The optimization is already included in the .htaccess file in the top
|
||||||
|
directory of your installation.
|
||||||
|
|
||||||
|
Lighttpd:
|
||||||
|
---------
|
||||||
|
With Lighttpd the addition of Expire: tags by mod_expire is incompatible with
|
||||||
|
the addition of "Cache-control: public". Using Cache-control 'public' is
|
||||||
|
used below as it is assumed to give a better caching result.
|
||||||
|
|
||||||
|
Enable modules in server.modules:
|
||||||
|
"mod_setenv"
|
||||||
|
"mod_compress"
|
||||||
|
|
||||||
|
Mod_compress is a server side cache of compressed files to improve its performance.
|
||||||
|
|
||||||
|
$HTTP["host"] == "www.example.com" {
|
||||||
|
|
||||||
|
static-file.etags = "enable"
|
||||||
|
# http://redmine.lighttpd.net/projects/lighttpd/wiki/Etag.use-mtimeDetails
|
||||||
|
etag.use-mtime = "enable"
|
||||||
|
|
||||||
|
# http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModSetEnv
|
||||||
|
$HTTP["url"] =~ "^/roundcubemail/(plugins|skins|program)" {
|
||||||
|
setenv.add-response-header = ( "Cache-Control" => "public, max-age=2592000")
|
||||||
|
}
|
||||||
|
|
||||||
|
# http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModCompress
|
||||||
|
# set compress.cache-dir to somewhere outside the docroot.
|
||||||
|
compress.cache-dir = var.statedir + "/cache/compress"
|
||||||
|
|
||||||
|
compress.filetype = ("text/plain", "text/html", "text/javascript", "text/css", "text/xml", "image/gif", "image/png")
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
KNOWN ISSUES
|
||||||
|
============
|
||||||
|
|
||||||
|
Installations with uw-imap server should set imap_disabled_caps = array('ESEARCH')
|
||||||
|
in main configuration file. ESEARCH implementation in this server is broken (#1489184).
|
||||||
|
|
||||||
|
PHP >= 5.6 validates the ssl certificates by default. It means that
|
||||||
|
if IMAP/SMTP certificates are self-signed or use wrong host name you'll get
|
||||||
|
connection errors. A solution in such cases is to set imap_conn_options,
|
||||||
|
smtp_conn_options and managesieve_conn_options in a way described in config/defaults.inc.php.
|
||||||
|
|
||||||
|
If you have problems with temp files or non-working logs make sure temp and logs folders
|
||||||
|
are writeable to the user used by http server. Access to them may also be blocked by
|
||||||
|
SELINUX. Here's some sample commands for SELINUX:
|
||||||
|
|
||||||
|
$ semanage fcontext -a -t httpd_sys_rw_content_t "/path_to_roundcube/logs(/.*)?"
|
||||||
|
$ semanage fcontext -a -t httpd_sys_rw_content_t "/path_to_roundcube/temp(/.*)?"
|
||||||
|
$ restorecon -Rv /path_to_roundcube/
|
||||||
|
|
||||||
|
Microsoft IIS Server by default does not support WOFF fonts used in Elastic skin. It might be
|
||||||
|
needed to add following MIME Types definitions (via web.config or IIS Manager):
|
||||||
|
|
||||||
|
.woff application/font-woff
|
||||||
|
.woff2 application/font-woff2
|
||||||
|
|
||||||
|
When installing on Windows be aware we're using symbolic links which may need an additional
|
||||||
|
attention. See https://github.com/roundcube/roundcubemail/issues/7151.
|
||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
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, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
Roundcube Webmail
|
||||||
|
=================
|
||||||
|
[roundcube.net](https://roundcube.net)
|
||||||
|
|
||||||
|
[](https://github.com/roundcube/roundcubemail/actions/workflows/tests.yml)
|
||||||
|
|
||||||
|
|
||||||
|
INTRODUCTION
|
||||||
|
------------
|
||||||
|
Roundcube Webmail is a browser-based multilingual IMAP client with an
|
||||||
|
application-like user interface. It provides full functionality you expect
|
||||||
|
from an email client, including MIME support, address book, folder management,
|
||||||
|
message searching and spell checking. Roundcube Webmail is written in PHP and
|
||||||
|
requires the MySQL, PostgreSQL or SQLite database. With its plugin API it is
|
||||||
|
easily extendable and the user interface is fully customizable using skins.
|
||||||
|
|
||||||
|
The code designed to run on a webserver is mainly written in PHP and Javascript.
|
||||||
|
It includes a custom framework with an IMAP library derived from [IlohaMail][iloha]
|
||||||
|
and requires a set of external libraries (see composer.json and jsdeps.json files).
|
||||||
|
|
||||||
|
|
||||||
|
INSTALLATION
|
||||||
|
------------
|
||||||
|
For detailed instructions on how to install Roundcube webmail on your server,
|
||||||
|
please refer to the INSTALL document in the same directory as this document.
|
||||||
|
|
||||||
|
If you're updating an older version of Roundcube please follow the steps
|
||||||
|
described in the UPGRADING file.
|
||||||
|
|
||||||
|
|
||||||
|
BROWSER SUPPORT
|
||||||
|
---------------
|
||||||
|
Roundcube uses jQuery 3.x (and other libs) for its client and therefore
|
||||||
|
inherits the browser support from there. This currently includes:
|
||||||
|
|
||||||
|
- Chrome: (Current - 1) and Current
|
||||||
|
- Edge: (Current - 1) and Current
|
||||||
|
- Firefox: (Current - 1) and Current, ESR
|
||||||
|
- Internet Explorer: 11+
|
||||||
|
- Safari: (Current - 1) and Current
|
||||||
|
- Opera: Current
|
||||||
|
|
||||||
|
|
||||||
|
LICENSE
|
||||||
|
-------
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License (**with exceptions
|
||||||
|
for skins & plugins**) as published by the Free Software Foundation,
|
||||||
|
either version 3 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
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, see [www.gnu.org/licenses/][gpl].
|
||||||
|
|
||||||
|
This file forms part of the Roundcube Webmail Software for which the
|
||||||
|
following exception is added: Plugins and Skins which merely make
|
||||||
|
function calls to the Roundcube Webmail Software, and for that purpose
|
||||||
|
include it by reference shall not be considered modifications of
|
||||||
|
the software.
|
||||||
|
|
||||||
|
If you wish to use this file in another project or create a modified
|
||||||
|
version that will not be part of the Roundcube Webmail Software, you
|
||||||
|
may remove the exception above and use this source code under the
|
||||||
|
original version of the license.
|
||||||
|
|
||||||
|
For more details about licensing and the exceptions for skins and plugins
|
||||||
|
see [roundcube.net/license][license]
|
||||||
|
|
||||||
|
|
||||||
|
CONTRIBUTION
|
||||||
|
------------
|
||||||
|
Want to help make Roundcube the best webmail solution ever?
|
||||||
|
Roundcube is open source software. Our developers and contributors all
|
||||||
|
are volunteers and we're always looking for new additions and resources.
|
||||||
|
For more information visit [roundcube.net/contribute][contrib]
|
||||||
|
|
||||||
|
|
||||||
|
CONTACT
|
||||||
|
-------
|
||||||
|
For bug reports or feature requests please refer to the tracking system
|
||||||
|
at [Github][githubissues] or subscribe to our mailing list.
|
||||||
|
See [roundcube.net/support][support] for details.
|
||||||
|
|
||||||
|
You're always welcome to send a message to the project admin:
|
||||||
|
hello(at)roundcube(dot)net
|
||||||
|
|
||||||
|
|
||||||
|
[iloha]: https://sourceforge.net/projects/ilohamail/
|
||||||
|
[gpl]: https://www.gnu.org/licenses/
|
||||||
|
[license]: https://roundcube.net/license
|
||||||
|
[contrib]: https://roundcube.net/contribute
|
||||||
|
[support]: https://roundcube.net/support
|
||||||
|
[githubissues]: https://github.com/roundcube/roundcubemail/issues
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
Check our website's [download page](https://roundcube.net/download/) to see which versions are still supported and will receive security updates.
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
If you found a security issue or vulnerability of the software, please report with direct and encrypted email to *thomas[at]roundcube.net*
|
||||||
|
and *alec[at]alec.pl*. You can find the according PGP public keys on the major public keyservers like [pgp.key-server.io](https://pgp.key-server.io).
|
||||||
|
|
||||||
|
Your report should include clear steps for reproduction and a classification of the found vulnerability.
|
||||||
|
|
||||||
|
## Publishing and Credits
|
||||||
|
|
||||||
|
We're dedicated to analyze and fix the reported issues as fast a possible. Usually within days we'll have an update ready.
|
||||||
|
Together with the reporter we plan the releasing and the disclosure of the found and fixed vulnerability.
|
||||||
|
Credits to the reporter are granted and can be included in all public communication if desired.
|
||||||
@@ -0,0 +1,106 @@
|
|||||||
|
UPGRADING instructions
|
||||||
|
======================
|
||||||
|
|
||||||
|
Follow these instructions if upgrading from a previous version
|
||||||
|
of Roundcube Webmail. We recommend to carefully backup the existing
|
||||||
|
installation as well as the database before going through the following steps.
|
||||||
|
|
||||||
|
Using the update script
|
||||||
|
-----------------------
|
||||||
|
There is a shell script (for unix based systems) that does the job for you.
|
||||||
|
To use it, unpack the archive of the new Roundcube version to a temporary location
|
||||||
|
(don't replace the Roundcube installation you want to update)
|
||||||
|
and cd into that directory. From there, run the following command in a shell:
|
||||||
|
|
||||||
|
./bin/installto.sh <TARGET-FOLDER>
|
||||||
|
|
||||||
|
For <TARGET-FOLDER> you specify the path to the Roundcube installation
|
||||||
|
which should be updated. The update script will then copy all new files to the
|
||||||
|
target location and check and update the configuration and database schema.
|
||||||
|
After all is done, the temporary folder with the new Roundcube files can be
|
||||||
|
removed again.
|
||||||
|
|
||||||
|
WARNING: Make sure files have proper owner/group for your setup. If you use
|
||||||
|
tar to extract the package, `--no-same-owner` option might be helpful.
|
||||||
|
WARNING: See Post-Upgrade Activities section below.
|
||||||
|
WARNING: If you use MySQL < 5.7.7 or MariaDB < 10.2.2 make sure to configure it with:
|
||||||
|
innodb_large_prefix=1
|
||||||
|
innodb_file_per_table=1
|
||||||
|
innodb_file_format=Barracuda
|
||||||
|
|
||||||
|
|
||||||
|
Updating manually
|
||||||
|
-----------------
|
||||||
|
If you don't have shell access to the Roundcube installation or if not running
|
||||||
|
it on a unix system, you need to do the following operations by hand:
|
||||||
|
|
||||||
|
1. Replace index.php and all files in
|
||||||
|
- ./bin/
|
||||||
|
- ./SQL/
|
||||||
|
- ./program/
|
||||||
|
- ./installer/
|
||||||
|
2. Replace the configuration defaults files:
|
||||||
|
- config/defaults.inc.php
|
||||||
|
- config/mimetypes.php
|
||||||
|
3. rsync the contents of the following folders from your installation
|
||||||
|
directory into the target folder:
|
||||||
|
./skins/
|
||||||
|
./plugins/
|
||||||
|
./vendor/
|
||||||
|
4. Update dependencies:
|
||||||
|
4a. If you previously installed plugins through composer, update dependencies
|
||||||
|
by running `php composer.phar update --no-dev`.
|
||||||
|
4b. Install/update dependencies using composer:
|
||||||
|
- get composer from https://getcomposer.org/download/
|
||||||
|
- rename the composer.json-dist file into composer.json
|
||||||
|
- if you want to use LDAP address books, enable the LDAP libraries in your
|
||||||
|
composer.json file by moving the items from "suggest" to the "require"
|
||||||
|
section (remove the explanation texts after the version!).
|
||||||
|
- run `php composer.phar install --no-dev`.
|
||||||
|
4c. If you use git sources or the release package without dependencies
|
||||||
|
update javascript dependencies by executing `bin/install-jsdeps.sh` script.
|
||||||
|
4d. If you use git sources compile css files for the Elastic skin (required
|
||||||
|
lessc >= 2.5.2):
|
||||||
|
$ cd skins/elastic
|
||||||
|
$ lessc --clean-css="--s1 --advanced" styles/styles.less > styles/styles.min.css
|
||||||
|
$ lessc --clean-css="--s1 --advanced" styles/print.less > styles/print.min.css
|
||||||
|
$ lessc --clean-css="--s1 --advanced" styles/embed.less > styles/embed.min.css
|
||||||
|
5. Run `./bin/update.sh` from the commandline OR
|
||||||
|
open http://url-to-roundcube/installer/ in a browser and choose "3 Test config".
|
||||||
|
To enable the latter one, you have to temporary set 'enable_installer'
|
||||||
|
to true in your local config/config.inc.php file.
|
||||||
|
WARNING: See SQLite database upgrade below.
|
||||||
|
6. Let the update script/installer check your configuration and
|
||||||
|
update your config files and database schema as suggested by the updater.
|
||||||
|
7. Make sure 'enable_installer' is set to false again.
|
||||||
|
8. See Post-Upgrade Activities section.
|
||||||
|
|
||||||
|
|
||||||
|
Post-Upgrade Activities
|
||||||
|
-----------------------
|
||||||
|
1. Check system requirements in INSTALL file.
|
||||||
|
2. If you're using build-in addressbook, run indexing script /bin/indexcontacts.sh.
|
||||||
|
3. When upgrading from version older than 0.6-beta you should make sure
|
||||||
|
your folder settings contain namespace prefix. For example Courier users
|
||||||
|
should add INBOX. prefix to folder names in main configuration file.
|
||||||
|
4. When upgrading from version older than 1.4.0 make sure old files
|
||||||
|
in configured temp_dir are removed. Since this version we use constant filename
|
||||||
|
prefix and do not remove files not starting with "RCMTEMP".
|
||||||
|
|
||||||
|
|
||||||
|
SQLite database upgrade
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
Versions older than 0.9 were supporting SQLite v2 only. Newer versions require
|
||||||
|
database in v3 format. The best what you can do is to convert database file
|
||||||
|
to the new format using command line tools:
|
||||||
|
|
||||||
|
sqlite OLD.DB .dump | sqlite3 NEW.DB
|
||||||
|
|
||||||
|
|
||||||
|
Other tools
|
||||||
|
-----------
|
||||||
|
In case you need to only update the database schema you can use updatedb.sh script.
|
||||||
|
For example, to update the Roundcube core database run:
|
||||||
|
|
||||||
|
./bin/updatedb.sh --package=roundcube --dir=SQL
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
{
|
||||||
|
"name": "roundcube/roundcubemail",
|
||||||
|
"description": "The Roundcube Webmail suite",
|
||||||
|
"license": "GPL-3.0-or-later",
|
||||||
|
"repositories": [
|
||||||
|
{
|
||||||
|
"type": "composer",
|
||||||
|
"url": "https://plugins.roundcube.net"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"require": {
|
||||||
|
"php": ">=7.3.0",
|
||||||
|
"pear/pear-core-minimal": "~1.10.1",
|
||||||
|
"pear/auth_sasl": "~1.1.0",
|
||||||
|
"pear/mail_mime": "~1.10.0",
|
||||||
|
"pear/net_smtp": "~1.10.0",
|
||||||
|
"pear/crypt_gpg": "~1.6.3",
|
||||||
|
"pear/net_sieve": "~1.4.5",
|
||||||
|
"roundcube/plugin-installer": "~0.3.1",
|
||||||
|
"roundcube/rtf-html-php": "~2.1",
|
||||||
|
"masterminds/html5": "~2.7.0",
|
||||||
|
"bacon/bacon-qr-code": "^2.0.0",
|
||||||
|
"guzzlehttp/guzzle": "^7.3.0",
|
||||||
|
"kolab/net_ldap3": "~1.1.1"
|
||||||
|
},
|
||||||
|
"suggest": {
|
||||||
|
"bjeavons/zxcvbn-php": "^1.0 required for Zxcvbn password strength driver"
|
||||||
|
},
|
||||||
|
"config": {
|
||||||
|
"allow-plugins": {
|
||||||
|
"roundcube/plugin-installer": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
{
|
||||||
|
"name": "roundcube/roundcubemail",
|
||||||
|
"description": "The Roundcube Webmail suite",
|
||||||
|
"license": "GPL-3.0-or-later",
|
||||||
|
"repositories": [
|
||||||
|
{
|
||||||
|
"type": "composer",
|
||||||
|
"url": "https://plugins.roundcube.net"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"require": {
|
||||||
|
"php": ">=7.3.0",
|
||||||
|
"pear/pear-core-minimal": "~1.10.1",
|
||||||
|
"pear/auth_sasl": "~1.1.0",
|
||||||
|
"pear/mail_mime": "~1.10.0",
|
||||||
|
"pear/net_smtp": "~1.10.0",
|
||||||
|
"pear/crypt_gpg": "~1.6.3",
|
||||||
|
"pear/net_sieve": "~1.4.5",
|
||||||
|
"roundcube/plugin-installer": "~0.3.1",
|
||||||
|
"roundcube/rtf-html-php": "~2.1",
|
||||||
|
"masterminds/html5": "~2.7.0",
|
||||||
|
"bacon/bacon-qr-code": "^2.0.0",
|
||||||
|
"guzzlehttp/guzzle": "^7.3.0"
|
||||||
|
},
|
||||||
|
"require-dev": {
|
||||||
|
"phpunit/phpunit": "^9"
|
||||||
|
},
|
||||||
|
"suggest": {
|
||||||
|
"kolab/net_ldap3": "~1.1.1 required for connecting to LDAP",
|
||||||
|
"bjeavons/zxcvbn-php": "^1.0 required for Zxcvbn password strength driver"
|
||||||
|
},
|
||||||
|
"config": {
|
||||||
|
"allow-plugins": {
|
||||||
|
"roundcube/plugin-installer": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Generated
+1583
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,278 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
+-------------------------------------------------------------------------+
|
||||||
|
| Roundcube Webmail IMAP Client |
|
||||||
|
| Version 1.6.3 |
|
||||||
|
| |
|
||||||
|
| Copyright (C) The Roundcube Dev Team |
|
||||||
|
| |
|
||||||
|
| This program is free software: you can redistribute it and/or modify |
|
||||||
|
| it under the terms of the GNU General Public License (with exceptions |
|
||||||
|
| for skins & plugins) as published by the Free Software Foundation, |
|
||||||
|
| either version 3 of the License, or (at your option) any later version. |
|
||||||
|
| |
|
||||||
|
| This file forms part of the Roundcube Webmail Software for which the |
|
||||||
|
| following exception is added: Plugins and Skins which merely make |
|
||||||
|
| function calls to the Roundcube Webmail Software, and for that purpose |
|
||||||
|
| include it by reference shall not be considered modifications of |
|
||||||
|
| the software. |
|
||||||
|
| |
|
||||||
|
| If you wish to use this file in another project or create a modified |
|
||||||
|
| version that will not be part of the Roundcube Webmail Software, you |
|
||||||
|
| may remove the exception above and use this source code under the |
|
||||||
|
| original version of the license. |
|
||||||
|
| |
|
||||||
|
| 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, see http://www.gnu.org/licenses/. |
|
||||||
|
| |
|
||||||
|
+-------------------------------------------------------------------------+
|
||||||
|
| Author: Thomas Bruederli <roundcube@gmail.com> |
|
||||||
|
| Author: Aleksander Machniak <alec@alec.pl> |
|
||||||
|
+-------------------------------------------------------------------------+
|
||||||
|
*/
|
||||||
|
|
||||||
|
// include environment
|
||||||
|
require_once 'program/include/iniset.php';
|
||||||
|
|
||||||
|
// init application, start session, init output class, etc.
|
||||||
|
$RCMAIL = rcmail::get_instance(0, isset($GLOBALS['env']) ? $GLOBALS['env'] : null);
|
||||||
|
|
||||||
|
// Make the whole PHP output non-cacheable (#1487797)
|
||||||
|
$RCMAIL->output->nocacheing_headers();
|
||||||
|
$RCMAIL->output->common_headers(!empty($_SESSION['user_id']));
|
||||||
|
|
||||||
|
// turn on output buffering
|
||||||
|
ob_start();
|
||||||
|
|
||||||
|
// check the initial error state
|
||||||
|
if ($RCMAIL->config->get_error() || $RCMAIL->db->is_error()) {
|
||||||
|
rcmail_fatal_error();
|
||||||
|
}
|
||||||
|
|
||||||
|
// error steps
|
||||||
|
if ($RCMAIL->action == 'error' && !empty($_GET['_code'])) {
|
||||||
|
rcmail::raise_error(['code' => hexdec($_GET['_code'])], false, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if https is required (for login) and redirect if necessary
|
||||||
|
if (empty($_SESSION['user_id']) && ($force_https = $RCMAIL->config->get('force_https', false))) {
|
||||||
|
// force_https can be true, <hostname>, <hostname>:<port>, <port>
|
||||||
|
if (!is_bool($force_https)) {
|
||||||
|
list($host, $port) = explode(':', $force_https);
|
||||||
|
|
||||||
|
if (is_numeric($host) && empty($port)) {
|
||||||
|
$port = $host;
|
||||||
|
$host = '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (empty($port)) {
|
||||||
|
$port = 443;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!rcube_utils::https_check($port)) {
|
||||||
|
if (empty($host)) {
|
||||||
|
$host = preg_replace('/:[0-9]+$/', '', $_SERVER['HTTP_HOST']);
|
||||||
|
}
|
||||||
|
if ($port != 443) {
|
||||||
|
$host .= ':' . $port;
|
||||||
|
}
|
||||||
|
|
||||||
|
header('Location: https://' . $host . $_SERVER['REQUEST_URI']);
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// trigger startup plugin hook
|
||||||
|
$startup = $RCMAIL->plugins->exec_hook('startup', ['task' => $RCMAIL->task, 'action' => $RCMAIL->action]);
|
||||||
|
$RCMAIL->set_task($startup['task']);
|
||||||
|
$RCMAIL->action = $startup['action'];
|
||||||
|
|
||||||
|
$session_error = null;
|
||||||
|
|
||||||
|
// try to log in
|
||||||
|
if ($RCMAIL->task == 'login' && $RCMAIL->action == 'login') {
|
||||||
|
$request_valid = !empty($_SESSION['temp']) && $RCMAIL->check_request();
|
||||||
|
$pass_charset = $RCMAIL->config->get('password_charset', 'UTF-8');
|
||||||
|
|
||||||
|
// purge the session in case of new login when a session already exists
|
||||||
|
if ($request_valid) {
|
||||||
|
$RCMAIL->kill_session();
|
||||||
|
}
|
||||||
|
|
||||||
|
$auth = $RCMAIL->plugins->exec_hook('authenticate', [
|
||||||
|
'host' => $RCMAIL->autoselect_host(),
|
||||||
|
'user' => trim(rcube_utils::get_input_string('_user', rcube_utils::INPUT_POST)),
|
||||||
|
'pass' => rcube_utils::get_input_string('_pass', rcube_utils::INPUT_POST, true, $pass_charset),
|
||||||
|
'valid' => $request_valid,
|
||||||
|
'error' => null,
|
||||||
|
'cookiecheck' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
// Login
|
||||||
|
if ($auth['valid'] && !$auth['abort']
|
||||||
|
&& $RCMAIL->login($auth['user'], $auth['pass'], $auth['host'], $auth['cookiecheck'])
|
||||||
|
) {
|
||||||
|
// create new session ID, don't destroy the current session
|
||||||
|
// it was destroyed already by $RCMAIL->kill_session() above
|
||||||
|
$RCMAIL->session->remove('temp');
|
||||||
|
$RCMAIL->session->regenerate_id(false);
|
||||||
|
|
||||||
|
// send auth cookie if necessary
|
||||||
|
$RCMAIL->session->set_auth_cookie();
|
||||||
|
|
||||||
|
// log successful login
|
||||||
|
$RCMAIL->log_login();
|
||||||
|
|
||||||
|
// restore original request parameters
|
||||||
|
$query = [];
|
||||||
|
if ($url = rcube_utils::get_input_string('_url', rcube_utils::INPUT_POST)) {
|
||||||
|
parse_str($url, $query);
|
||||||
|
|
||||||
|
// prevent endless looping on login page
|
||||||
|
if (!empty($query['_task']) && $query['_task'] == 'login') {
|
||||||
|
unset($query['_task']);
|
||||||
|
}
|
||||||
|
|
||||||
|
// prevent redirect to compose with specified ID (#1488226)
|
||||||
|
if (!empty($query['_action']) && $query['_action'] == 'compose' && !empty($query['_id'])) {
|
||||||
|
$query = ['_action' => 'compose'];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// allow plugins to control the redirect url after login success
|
||||||
|
$redir = $RCMAIL->plugins->exec_hook('login_after', $query + ['_task' => 'mail']);
|
||||||
|
unset($redir['abort'], $redir['_err']);
|
||||||
|
|
||||||
|
// send redirect
|
||||||
|
$RCMAIL->output->redirect($redir, 0, true);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if (!$auth['valid']) {
|
||||||
|
$error_code = rcmail::ERROR_INVALID_REQUEST;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$error_code = is_numeric($auth['error']) ? $auth['error'] : $RCMAIL->login_error();
|
||||||
|
}
|
||||||
|
|
||||||
|
$error_labels = [
|
||||||
|
rcmail::ERROR_STORAGE => 'storageerror',
|
||||||
|
rcmail::ERROR_COOKIES_DISABLED => 'cookiesdisabled',
|
||||||
|
rcmail::ERROR_INVALID_REQUEST => 'invalidrequest',
|
||||||
|
rcmail::ERROR_INVALID_HOST => 'invalidhost',
|
||||||
|
rcmail::ERROR_RATE_LIMIT => 'accountlocked',
|
||||||
|
];
|
||||||
|
|
||||||
|
if (!empty($auth['error']) && !is_numeric($auth['error'])) {
|
||||||
|
$error_message = $auth['error'];
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$error_message = !empty($error_labels[$error_code]) ? $error_labels[$error_code] : 'loginfailed';
|
||||||
|
}
|
||||||
|
|
||||||
|
$RCMAIL->output->show_message($error_message, 'warning');
|
||||||
|
|
||||||
|
// log failed login
|
||||||
|
$RCMAIL->log_login($auth['user'], true, $error_code);
|
||||||
|
|
||||||
|
$RCMAIL->plugins->exec_hook('login_failed', [
|
||||||
|
'code' => $error_code,
|
||||||
|
'host' => $auth['host'],
|
||||||
|
'user' => $auth['user'],
|
||||||
|
]);
|
||||||
|
|
||||||
|
if (!isset($_SESSION['user_id'])) {
|
||||||
|
$RCMAIL->kill_session();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// handle oauth login requests
|
||||||
|
else if ($RCMAIL->task == 'login' && $RCMAIL->action == 'oauth' && $RCMAIL->oauth->is_enabled()) {
|
||||||
|
$oauth_handler = new rcmail_action_login_oauth();
|
||||||
|
$oauth_handler->run();
|
||||||
|
}
|
||||||
|
|
||||||
|
// end session
|
||||||
|
else if ($RCMAIL->task == 'logout' && isset($_SESSION['user_id'])) {
|
||||||
|
$RCMAIL->request_security_check(rcube_utils::INPUT_GET | rcube_utils::INPUT_POST);
|
||||||
|
|
||||||
|
$userdata = array(
|
||||||
|
'user' => $_SESSION['username'],
|
||||||
|
'host' => $_SESSION['storage_host'],
|
||||||
|
'lang' => $RCMAIL->user->language,
|
||||||
|
);
|
||||||
|
|
||||||
|
$RCMAIL->output->show_message('loggedout');
|
||||||
|
|
||||||
|
$RCMAIL->logout_actions();
|
||||||
|
$RCMAIL->kill_session();
|
||||||
|
$RCMAIL->plugins->exec_hook('logout_after', $userdata);
|
||||||
|
}
|
||||||
|
|
||||||
|
// check session and auth cookie
|
||||||
|
else if ($RCMAIL->task != 'login' && $_SESSION['user_id']) {
|
||||||
|
if (!$RCMAIL->session->check_auth()) {
|
||||||
|
$RCMAIL->kill_session();
|
||||||
|
$session_error = 'sessionerror';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// not logged in -> show login page
|
||||||
|
if (empty($RCMAIL->user->ID)) {
|
||||||
|
if (
|
||||||
|
$session_error
|
||||||
|
|| (!empty($_REQUEST['_err']) && $_REQUEST['_err'] === 'session')
|
||||||
|
|| ($session_error = $RCMAIL->session_error())
|
||||||
|
) {
|
||||||
|
$RCMAIL->output->show_message($session_error ?: 'sessionerror', 'error', null, true, -1);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($RCMAIL->output->ajax_call || $RCMAIL->output->get_env('framed')) {
|
||||||
|
$RCMAIL->output->command('session_error', $RCMAIL->url(['_err' => 'session']));
|
||||||
|
$RCMAIL->output->send('iframe');
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if installer is still active
|
||||||
|
if ($RCMAIL->config->get('enable_installer') && is_readable('./installer/index.php')) {
|
||||||
|
$RCMAIL->output->add_footer(html::div(['id' => 'login-addon', 'style' => "background:#ef9398; border:2px solid #dc5757; padding:0.5em; margin:2em auto; width:50em"],
|
||||||
|
html::tag('h2', array('style' => "margin-top:0.2em"), "Installer script is still accessible") .
|
||||||
|
html::p(null, "The install script of your Roundcube installation is still stored in its default location!") .
|
||||||
|
html::p(null, "Please <b>remove</b> the whole <tt>installer</tt> folder from the Roundcube directory because
|
||||||
|
these files may expose sensitive configuration data like server passwords and encryption keys
|
||||||
|
to the public. Make sure you cannot access the <a href=\"./installer/\">installer script</a> from your browser.")
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
$plugin = $RCMAIL->plugins->exec_hook('unauthenticated', [
|
||||||
|
'task' => 'login',
|
||||||
|
'error' => $session_error,
|
||||||
|
// Return 401 only on failed logins (#7010)
|
||||||
|
'http_code' => empty($session_error) && !empty($error_message) ? 401 : 200
|
||||||
|
]);
|
||||||
|
|
||||||
|
$RCMAIL->set_task($plugin['task']);
|
||||||
|
|
||||||
|
if ($plugin['http_code'] == 401) {
|
||||||
|
header('HTTP/1.0 401 Unauthorized');
|
||||||
|
}
|
||||||
|
|
||||||
|
$RCMAIL->output->send($plugin['task']);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// CSRF prevention
|
||||||
|
$RCMAIL->request_security_check();
|
||||||
|
|
||||||
|
// check access to disabled actions
|
||||||
|
$disabled_actions = (array) $RCMAIL->config->get('disabled_actions');
|
||||||
|
if (in_array($RCMAIL->task . '.' . ($RCMAIL->action ?: 'index'), $disabled_actions)) {
|
||||||
|
rcube::raise_error(['code' => 404, 'message' => "Action disabled"], true, true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$RCMAIL->action_handler();
|
||||||
Reference in New Issue
Block a user