├── .gitignore ├── UnlimitedJCEPolicyJDK7 ├── local_policy.jar ├── US_export_policy.jar └── README.txt ├── nginx └── default ├── elkserver-provision.sh ├── Vagrantfile ├── elkclient-provision.sh ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .vagrant/* 2 | -------------------------------------------------------------------------------- /UnlimitedJCEPolicyJDK7/local_policy.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/frntn/vagrant-elk-clientserver/HEAD/UnlimitedJCEPolicyJDK7/local_policy.jar -------------------------------------------------------------------------------- /UnlimitedJCEPolicyJDK7/US_export_policy.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/frntn/vagrant-elk-clientserver/HEAD/UnlimitedJCEPolicyJDK7/US_export_policy.jar -------------------------------------------------------------------------------- /nginx/default: -------------------------------------------------------------------------------- 1 | server { 2 | listen 80; 3 | 4 | location / { 5 | root /var/www/kibana3; 6 | index index.html; 7 | } 8 | 9 | } 10 | -------------------------------------------------------------------------------- /elkserver-provision.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # COLLECTD INPUT (ENCRYPTED) 4 | # Password: Using sha1 of logstash-forwarder certificate. 5 | # Easier for testing purpose (use already shared element to create a shared secret). 6 | # Do NOT use this trick in a production env 7 | # ==================== 8 | 9 | auth="/etc/logstash/collectd.authfile" 10 | conf="/etc/logstash/conf.d/02-collectd-input.conf" 11 | collectdport="25826" 12 | 13 | cat < "$auth" 14 | kibana: $(sha1sum /etc/pki/tls/certs/logstash-forwarder.crt | awk '{print $1}') 15 | EOF 16 | 17 | cat < "$conf" 18 | input { 19 | collectd { 20 | port => $collectdport 21 | type => "metrics" 22 | security_level => "Encrypt" 23 | authfile => "/etc/logstash/collectd.authfile" 24 | } 25 | } 26 | EOF 27 | 28 | mv /tmp/*.jar "/usr/lib/jvm/java-7-oracle/jre/lib/security/" 29 | mv /tmp/nginx-default "/etc/nginx/sites-available/default" 30 | 31 | service logstash restart 32 | service nginx restart 33 | -------------------------------------------------------------------------------- /Vagrantfile: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*-lab 2 | # vi: set ft=ruby : 3 | 4 | VAGRANTFILE_API_VERSION = "2" 5 | 6 | Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| 7 | 8 | config.ssh.forward_agent = true 9 | 10 | config.vm.define "elkserver" do |elkserver| 11 | elkserver.vm.box = "frntn/trusty64-elk" 12 | elkserver.vm.network "private_network", ip: "192.168.34.150" 13 | elkserver.vm.provision "file", source: "./UnlimitedJCEPolicyJDK7/local_policy.jar", destination: "/tmp/local_policy.jar" 14 | elkserver.vm.provision "file", source: "./UnlimitedJCEPolicyJDK7/US_export_policy.jar", destination: "/tmp/US_export_policy.jar" 15 | elkserver.vm.provision "file", source: "./nginx/default", destination: "/tmp/nginx-default" 16 | elkserver.vm.provision "shell", path: "elkserver-provision.sh" 17 | elkserver.vm.provider "virtualbox" do |vb| 18 | vb.customize ["modifyvm", :id, "--memory", "2048"] 19 | vb.customize ["modifyvm", :id, "--cpus", "2"] 20 | end 21 | end 22 | 23 | config.vm.define "elkclient" do |elkclient| 24 | elkclient.vm.box = "frntn/trusty64-wordpress" 25 | elkclient.vm.network "private_network", ip: "192.168.34.151" 26 | elkclient.vm.provision "shell", path: "elkclient-provision.sh" 27 | end 28 | 29 | end 30 | -------------------------------------------------------------------------------- /elkclient-provision.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | elkserverip="192.168.34.150" 4 | lumberjackport="5000" 5 | collectdport="25826" 6 | 7 | # VAGRANT'S INSECURE PRIVATE KEY TO ACCESS ELKSERVER 8 | mkdir -p ~/.ssh 9 | chmod 700 ~/.ssh 10 | wget -q https://raw.githubusercontent.com/mitchellh/vagrant/master/keys/vagrant -O ~/.ssh/id_dsa 11 | chmod 400 ~/.ssh/id_dsa 12 | 13 | # LOGSTASH-FOWARDER (ENCRYPTED) 14 | # ============================= 15 | 16 | ## INSTALL 17 | echo 'deb http://packages.elasticsearch.org/logstashforwarder/debian stable main' | sudo tee /etc/apt/sources.list.d/logstashforwarder.list 18 | wget -q -O- http://packages.elasticsearch.org/GPG-KEY-elasticsearch | apt-key add - 19 | apt-get update 20 | apt-get -y install logstash-forwarder 21 | 22 | ## INIT SCRIPT 23 | wget -q https://raw.github.com/elasticsearch/logstash-forwarder/master/logstash-forwarder.init -O /etc/init.d/logstash-forwarder 24 | chmod +x /etc/init.d/logstash-forwarder 25 | update-rc.d logstash-forwarder defaults 26 | 27 | ## CERTIFICATE FROM SERVER 28 | mkdir -p /etc/pki/tls/certs 29 | scp -o StrictHostKeyChecking=no vagrant@$elkserverip:/etc/pki/tls/certs/logstash-forwarder.crt /etc/pki/tls/certs/ 30 | rm -f ~/.ssh/id_dsa 31 | 32 | ## LUMBERJACK FORWARD (ENCRYPTED) 33 | cat < /etc/logstash-forwarder 34 | { 35 | "network": { 36 | "servers": [ "$elkserverip:$lumberjackport" ], 37 | "timeout": 15, 38 | "ssl ca": "/etc/pki/tls/certs/logstash-forwarder.crt" 39 | }, 40 | "files": [ 41 | { 42 | "paths": [ 43 | "/var/log/syslog", 44 | "/var/log/auth.log" 45 | ], 46 | "fields": { "type": "syslog" } 47 | } 48 | ] 49 | } 50 | EOCONF 51 | 52 | ## COLLECTD OUPUT (ENCRYPTED) 53 | ## Password: Using sha1 of logstash-forwarder certificate. 54 | ## Easier for testing purpose (use already shared element to create a shared secret). 55 | ## Do NOT use this trick in a production env 56 | 57 | apt-get install -y collectd collectd-utils 58 | cat < /etc/collectd/collectd.conf.d/network.conf 59 | LoadPlugin network 60 | 61 | 62 | SecurityLevel "Encrypt" 63 | Username "kibana" 64 | Password "$(sha1sum /etc/pki/tls/certs/logstash-forwarder.crt | awk '{print $1}')" 65 | 66 | 67 | EOF 68 | 69 | # RESTART SERVICES 70 | service logstash-forwarder restart 71 | service collectd restart 72 | 73 | 74 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | > MAJOR SECURITY UPDATE 09/27/2014 : All boxes have been fixed after the [shellshocker.net](https://shellshocker.net/) nuke 3 | 4 | # Client-Server ELK demo 5 | 6 | * Boxes : [vagrantcloud/frntn](http://www.vagrantcloud.com/frntn) 7 | * Issues : [github/frntn](https://github.com/frntn/vagrant-elk-clientserver/issues) 8 | * Feedbacks : [twitter/frntn](http://www.twitter.com/frntn) 9 | 10 | The purpose of this project is to give a quick & easy to use environment to 11 | play around with the now famous ElasticSearch - Logstash - Kibana stack 12 | a.k.a. ELK stack. 13 | 14 | ## Quick Overview 15 | 16 | The project uses vagrant, and the preconfigured boxes are for virtualbox for 17 | now. 18 | 19 | It builds up 2 virtual machines : 20 | 21 | ### elkserver 22 | 23 | * The [frntn/trusty64-elk](https://vagrantcloud.com/frntn/boxes/trusty64-elk) 24 | source box has a full ELK stack. 25 | * VM is provisioned at start up to add `collectd listener` (with encryption) 26 | * VM has host-only IP address `192.168.34.150` 27 | * `Kibana` is binded on port 80 through `nginx` 28 | * `ElasticSearch` is binded on port 9200 29 | * `lumberjack listener` is binded on port 5000 through `logstash` 30 | [input](http://logstash.net/docs/latest/inputs/lumberjack) 31 | * `collectd listener` is binded on port 25826 through `logstash` 32 | [input](http://logstash.net/docs/latest/inputs/collectd) 33 | 34 | ### elkclient 35 | 36 | * The [frntn/trusty64-wordpress](https://vagrantcloud.com/frntn/boxes/trusty64-wordpress) 37 | contains a ready to use WORDPRESS server 38 | * VM is provisioned at start up to install and configure `logstash-forwarder` 39 | and `collectd` 40 | * VM has host-only IP address `192.168.34.151` 41 | * `Wordpress` is binded on port 80 through `nginx` 42 | * `Logstash-forwarder` is configured to send auth and syslog events to 43 | elkserver. Easily extendable to wordpress logs and more... 44 | * `collectd` is configured to send system metrics to elkserver. 45 | 46 | ## Getting Started 47 | 48 | Pre-requisites : [Vagrant](http://www.vagrantup.com/) and 49 | [Virtualbox](https://www.virtualbox.org/) are installed on your host. 50 | 51 | Clone the repo 52 | 53 | ```shell 54 | $ git clone https://github.com/frntn/vagrant-elk-clientserver.git frntn-elk 55 | $ cd frntn-elk 56 | ``` 57 | 58 | Start the VMs 59 | 60 | ```shell 61 | $ vagrant up 62 | ``` 63 | 64 | Boxes are now up, you should be able to access them with your browser : 65 | 66 | * Kibana : http://192.168.34.150/ ( the IHM you are waiting for ;) ) 67 | * Wordpress : http://192.168.34.151/ 68 | 69 | If not, you might need some extra configuration for it to work in your own 70 | environment (port forwarding, ...). I suggest you read the 71 | [vagrant documentation](http://docs.vagrantup.com/v2/). 72 | 73 | Feel free to contact me (links at the beginning of this file). 74 | 75 | ## Slightly more advanced usage 76 | 77 | Starting VM one by one 78 | 79 | ```shell 80 | $ vagrant up elkserver 81 | $ vagrant up elkclient 82 | ``` 83 | 84 | > Note : `elkclient` provisioning grab certificate from server to send logs 85 | > through an encrypted connection. So if you start this vm from "not created" 86 | > state or force "provision" of an existing one `elkserver` should be up too. 87 | 88 | Connecting via SSH 89 | 90 | ```shell 91 | $ vagrant ssh elkserver 92 | $ vagrant ssh elkclient 93 | ``` 94 | 95 | ## TODO 96 | 97 | Add extra configuration to Logstash-fowarder to enable wordpress application logging 98 | 99 | ---- 100 | *Hope you'll like this project as much as I add fun creating it :)* 101 | -------------------------------------------------------------------------------- /UnlimitedJCEPolicyJDK7/README.txt: -------------------------------------------------------------------------------- 1 | 2 | Unlimited Strength Java(TM) Cryptography Extension Policy Files 3 | for the Java(TM) Platform, Standard Edition Runtime Environment 7 4 | 5 | README 6 | 7 | ---------------------------------------------------------------------- 8 | CONTENTS 9 | ---------------------------------------------------------------------- 10 | 11 | o Introduction 12 | o License and Terms 13 | o Understanding The Export/Import Issues 14 | o Where To Find Documentation 15 | o Installation 16 | o Questions, Support, Reporting Bugs 17 | 18 | 19 | ---------------------------------------------------------------------- 20 | Introduction 21 | ---------------------------------------------------------------------- 22 | 23 | Thank you for downloading the Unlimited Strength Java(TM) Cryptography 24 | Extension (JCE) Policy Files for the Java(TM) Platform, Standard 25 | Edition (Java SE) Runtime Environment 7. 26 | 27 | Due to import control restrictions of some countries, the version of 28 | the JCE policy files that are bundled in the Java Runtime Environment, 29 | or JRE(TM), 7 environment allow "strong" but limited cryptography to be 30 | used. This download bundle (the one including this README file) 31 | provides "unlimited strength" policy files which contain no 32 | restrictions on cryptographic strengths. 33 | 34 | Please note that this download file does NOT contain any encryption 35 | functionality as all such functionality is contained within Oracle's 36 | JRE 7. This bundles assumes that the JRE 7 has already been installed. 37 | 38 | 39 | ---------------------------------------------------------------------- 40 | License and Terms 41 | ---------------------------------------------------------------------- 42 | 43 | This download bundle is part of the Java SE Platform products and is 44 | governed by same License and Terms notices. These notices can be found 45 | on the Java SE download site: 46 | 47 | http://www.oracle.com/technetwork/java/javase/documentation/index.html 48 | 49 | 50 | ---------------------------------------------------------------------- 51 | Understanding The Export/Import Issues 52 | ---------------------------------------------------------------------- 53 | 54 | JCE for Java SE 7 has been through the U.S. export review process. The 55 | JCE framework, along with the various JCE providers that come standard 56 | with it (SunJCE, SunEC, SunPKCS11, SunMSCAPI, etc), is exportable. 57 | 58 | The JCE architecture allows flexible cryptographic strength to be 59 | configured via jurisdiction policy files. Due to the import 60 | restrictions of some countries, the jurisdiction policy files 61 | distributed with the Java SE 7 software have built-in restrictions on 62 | available cryptographic strength. The jurisdiction policy files in this 63 | download bundle (the bundle including this README file) contain no 64 | restrictions on cryptographic strengths. This is appropriate for most 65 | countries. Framework vendors can create download bundles that include 66 | jurisdiction policy files that specify cryptographic restrictions 67 | appropriate for countries whose governments mandate restrictions. Users 68 | in those countries can download an appropriate bundle, and the JCE 69 | framework will enforce the specified restrictions. 70 | 71 | You are advised to consult your export/import control counsel or 72 | attorney to determine the exact requirements. 73 | 74 | 75 | ---------------------------------------------------------------------- 76 | Where To Find Documentation 77 | ---------------------------------------------------------------------- 78 | 79 | The following documents may be of interest to you: 80 | 81 | o The Java(TM) Cryptography Architecture (JCA) Reference Guide at: 82 | 83 | http://download.oracle.com/javase/7/docs/technotes/guides/security 84 | 85 | o The Java SE Security web site has more information about JCE, 86 | plus additional information about the Java SE Security Model. 87 | Please see: 88 | 89 | http://www.oracle.com/technetwork/java/javase/tech/index-jsp-136007.html 90 | 91 | 92 | ---------------------------------------------------------------------- 93 | Installation 94 | ---------------------------------------------------------------------- 95 | 96 | Notes: 97 | 98 | o Unix (Solaris/Linux) and Windows use different pathname separators, 99 | so please use the appropriate one ("\", "/") for your environment. 100 | 101 | o (below) refers to the directory where the JRE was 102 | installed. It is determined based on whether you are running JCE 103 | on a JRE or a JRE contained within the Java Development Kit, or 104 | JDK(TM). The JDK contains the JRE, but at a different level in the 105 | file hierarchy. For example, if the JDK is installed in 106 | /home/user1/jdk1.7.0 on Unix or in C:\jdk1.7.0 on Windows, then 107 | is: 108 | 109 | /home/user1/jdk1.7.0/jre [Unix] 110 | C:\jdk1.7.0\jre [Windows] 111 | 112 | If on the other hand the JRE is installed in /home/user1/jre1.7.0 113 | on Unix or in C:\jre1.7.0 on Windows, and the JDK is not 114 | installed, then is: 115 | 116 | /home/user1/jre1.7.0 [Unix] 117 | C:\jre1.7.0 [Windows] 118 | 119 | o On Windows, for each JDK installation, there may be additional 120 | JREs installed under the "Program Files" directory. Please make 121 | sure that you install the unlimited strength policy JAR files 122 | for all JREs that you plan to use. 123 | 124 | 125 | Here are the installation instructions: 126 | 127 | 1) Download the unlimited strength JCE policy files. 128 | 129 | 2) Uncompress and extract the downloaded file. 130 | 131 | This will create a subdirectory called jce. 132 | This directory contains the following files: 133 | 134 | README.txt This file 135 | local_policy.jar Unlimited strength local policy file 136 | US_export_policy.jar Unlimited strength US export policy file 137 | 138 | 3) Install the unlimited strength policy JAR files. 139 | 140 | In case you later decide to revert to the original "strong" but 141 | limited policy versions, first make a copy of the original JCE 142 | policy files (US_export_policy.jar and local_policy.jar). Then 143 | replace the strong policy files with the unlimited strength 144 | versions extracted in the previous step. 145 | 146 | The standard place for JCE jurisdiction policy JAR files is: 147 | 148 | /lib/security [Unix] 149 | \lib\security [Windows] 150 | 151 | 152 | ----------------------------------------------------------------------- 153 | Questions, Support, Reporting Bugs 154 | ----------------------------------------------------------------------- 155 | 156 | Questions 157 | --------- 158 | 159 | For miscellaneous questions about JCE usage and deployment, we 160 | encourage you to read: 161 | 162 | o Information on the Java SE Security web site 163 | 164 | http://www.oracle.com/technetwork/java/javase/tech/index-jsp-136007.html 165 | 166 | o The Oracle Online Community Forums, specifically the Java 167 | Cryptography forum. The forums allow you to tap into the 168 | experience of other users, ask questions, or offer tips to others 169 | on a variety of Java-related topics, including JCE. There is no 170 | fee to participate. 171 | 172 | http://forums.oracle.com/ 173 | http://forums.oracle.com/forums/forum.jspa?forumID=964 (JCE 174 | forum) 175 | 176 | 177 | Support 178 | ------- 179 | 180 | For more extensive JCE questions or deployment issues, please contact 181 | our Technical Support staff at: 182 | 183 | http://support.oracle.com 184 | 185 | 186 | Reporting Bugs 187 | -------------- 188 | 189 | To report bugs (with sample code) or request a feature, please see: 190 | 191 | http://bugreport.sun.com/bugreport/ 192 | 193 | Bug reports with specific, reproducible test cases are greatly 194 | appreciated! 195 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------