Merge branch 'master' into logout-new-user-2

Author: jrivard

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/help-with-an-issue.md

@@ -0,0 +1,9 @@
+---
+name: Help with an issue
+about: Get help with an issue installing or configuring PWM
+
+---
+
+DO NOT FILE AN ISSUE FOR HELP.  This issue system is not for help requests and such issues will be deleted.
+
+Instead, please ask for help on the [PWM-General Google Group](https://groups.google.com/group/pwm-general).

.gitignore

@@ -1,10 +1,28 @@
-/.idea
-/*.iml
-/client/target
-/client/.node
-/client/.idea
-/client/*.iml
-pwm-parent.iml
-pwmconfig/
-ssprconfig/
-/server/src/main/webapp/public/resources/webjars
+# PWM Project gitignore files
+
+# Eclipse Project Files
+/.project
+/.settings
+/.classpath
+
+# IntelliJ Project Files
+**/.idea/
+**/*.iml
+*/.idea/
+*/*.iml
+
+# OS folder info
+.directory
+.DS_Store
+.DS_Store?
+
+# Maven Output
+*/target
+
+
+/target
+/webapp/src/main/webapp/public/resources/themes/netiq
+/webapp/src/main/webapp/public/resources/themes/netiq32
+/webapp/src/main/webapp/public/resources/themes/idm
+/webapp/src/main/webapp/public/resources/themes/mdefault
+/webapp/src/main/webapp/public/resources/themes/mdefault44

README.md

@@ -10,7 +10,7 @@ Official project page is at [https://github.com/pwm-project/pwm/](https://github
 * [Current Builds](https://www.pwm-project.org/artifacts/pwm/) - Current downloads built from recent github project commits
 * [PWM Reference](https://www.pwm-project.org/pwm/public/reference/) - Reference documentation built into PWM.
 
-Features
+# Features
 * Web based configuration manager with over 400 configurable settings
 * Configurable display values for every user-facing text string
 * Localized for Chinese (中文), Czech (ceština), Dutch (Nederlands), English, Finnish (suomi), French (français), German (Deutsch), Hebrew (עברית), Italian (italiano), Japanese (日本語), Korean (한국어), Polish (polski), Portuguese (português), Slovak (Slovenčina), Spanish (español), Thai (ไทย) and Turkish (Türkçe)
@@ -47,3 +47,62 @@ Features
   * OpenLDAP
 
 [NetIQ SSPR](https://www.netiq.com/products/self-service-password-reset/) is a commercial, supported self service password reset product based on PWM.
+
+# Build Information
+
+Build pre-requisites:
+* Java 1.8 JDK or newer
+* Maven 3.2 or newer
+
+Build execution:
+* Set `JAVA_HOME` environment variable to JDK home  
+* Run `mvn clean package` in base directory
+
+A WAR file suitable for deployment on Apache Tomcat is created in `webapp/target` directory.  Rename to `pwm.war` and copy into `tomcat/webapp` directory.
+
+Alternatively, an executable JAR file is created in `onejar\target`.  This JAR file is self-contained single executable with embedded Apache Tomcat runtime. To execute use a command similar to:   
+
+`java -jar pwm-onejar.jar`
+
+The executable will show additional options that may be required.
+
+A docker image is created in `docker/target` as jib-image.tar.  You can import this docker image using a command similar to:
+
+`docker load --input=jib-image.tar`
+
+Create docker container and run using:
+`docker run -d --name <container name> -p 8443:8443 pwm/pwm-webapp`
+
+This will expose the https port to 8443.  If you want the configuration to persist to you can also exposed configuration volume of `/config` using the docker `-v` option during the container
+creation and map it to a directory on the docker host or use a docker volume container.  
+The PWM docker container will place all of it's configuration and runtime data in the `/config` volume.
+
+
+# PWM Source Code License Update Plan for 2019
+
+* Current License: GPL v2.0
+* New License: Apache 2.0
+* Notice Date: October 1, 2018
+* Update Date: February 1, 2019.
+
+The existing project is licensed using GPL v2.0 License 
+(https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).  On or about the update date, 
+the codebase will be updated as Apache 2.0 License (https://www.apache.org/licenses/LICENSE-2.0).  
+This change is being made to allow commercial organizations a more friendly license structure.  
+
+This will not change the nature or availability of the PWM Project.  The development and open-source
+nature of PWM will continue as before.   Existing, published PWM source code will continue to be 
+available under the GPL v2.0 License, however all new development after the license date will only
+be published using the new license type.
+
+At the time of the license update, the existing source code will be branched and the code source
+will be archived and published under the existing GPL v2.0 license terms in perpetuity.  
+
+Process:
+* This notice is posted publicly
+* Known contributors are sent this notice using last known address
+* Any objections or concerns by contributors will be processed as appropriate
+* On or about the update date:
+  * The existing code is branched and the GPL version will remain available
+  * License headers and notices will be updated to the new license type
+  * New development and contributions will be done under the new license type

SUPPORT.md

@@ -0,0 +1,4 @@
+Please do not open issues to ask questions.  Issues that are just questions will be deleted.
+
+For assistance with PWM use the [PWM-General Google Group](https://groups.google.com/group/pwm-general) to ask questions.
+

build/checkstyle-header.xml

@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+<!--
+  ~ Password Management Servlets (PWM)
+  ~ http://www.pwm-project.org
+  ~
+  ~ Copyright (c) 2006-2009 Novell, Inc.
+  ~ Copyright (c) 2009-2018 The PWM Project
+  ~
+  ~ 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 2 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, write to the Free Software
+  ~ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+  -->
+
+<!DOCTYPE module PUBLIC
+        "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
+        "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+
+<!--
+  PWM Checkstyle definition
+-->
+
+<module name="Checker">
+
+    <module name="SuppressionFilter">
+        <property name="file" value="${basedir}/build/checkstyle-suppression.xml" />
+    </module>
+
+    <module name="Header">
+        <property name="headerFile" value="${basedir}/build/license-header-jsp.txt"/>
+        <property name="fileExtensions" value="jsp"/>
+    </module>
+    <module name="Header">
+        <property name="headerFile" value="${basedir}/build/license-header-java.txt"/>
+        <property name="fileExtensions" value="java,css"/>
+    </module>
+    <module name="Header">
+        <property name="headerFile" value="${basedir}/build/license-header-xml.txt"/>
+        <property name="fileExtensions" value="xml,svg"/>
+    </module>
+    <module name="Header">
+        <property name="headerFile" value="${basedir}/build/license-header-properties.txt"/>
+        <property name="fileExtensions" value="properties"/>
+    </module>
+    <module name="Header">
+        <property name="headerFile" value="${basedir}/build/license-header-js.txt"/>
+        <property name="fileExtensions" value="js,ts"/>
+    </module>
+
+</module>

server/src/build/checkstyle-import.xml renamed to build/checkstyle-import.xml

@@ -37,13 +37,15 @@
     <allow pkg="java.lang"/>
     <allow pkg="java.security"/>
 
+    <allow pkg="org.apache.catalina"/>
+
     <!-- chai -->
     <allow pkg="com.novell.ldapchai"/>
 
     <!-- commons ftp client -->
     <allow pkg="org.apache.commons.net.ftp"/>
 
-    <!-- xml  -->
+    <!-- xml -->
     <allow pkg="org.jdom2"/>
     <allow pkg="javax.xml"/>
     <allow pkg="org.w3c"/>
@@ -55,9 +57,18 @@
     <!-- log4j -->
     <allow pkg="org.apache.log4j"/>
 
+    <!-- testing -->
+    <allow pkg="org.junit"/>
+    <allow pkg="org.mockito"/>
+    <allow pkg="com.github.tomakehurst.wiremock"/>
+    <allow pkg="org.reflections"/>
+    <allow pkg="org.bouncycastle.jce.provider"/>
+
     <!-- gson -->
     <allow pkg="com.google.gson"/>
 
+    <allow pkg="javax.management"/>
+
     <!-- to be removed/scoped -->
     <allow pkg="org.apache.http"/>
     <allow pkg="org.apache.commons"/>
@@ -74,6 +85,7 @@
     <allow pkg="javax.net"/>
     <allow pkg="javax.crypto"/>
     <allow pkg="javax.mail"/>
+    <allow class="com.sun.mail.smtp.SMTPSendFailedException"/>
     <allow pkg="org.xeustechnologies"/>
     <allow pkg="net.glxn"/>
     <allow pkg="org.webjars"/>
@@ -82,6 +94,7 @@
 
     <allow pkg="edu.umd.cs.findbugs.annotations"/>
     <allow pkg="com.nulabinc.zxcvbn" />
+    <allow pkg="jetbrains.exodus"/>
 
     <subpackage name="password.pwm.util">
         <allow pkg="sun.management"/>
@@ -124,7 +137,6 @@
     </subpackage>
 
     <subpackage name="util.localdb">
-        <allow pkg="jetbrains.exodus"/>
         <allow pkg="java.sql"/>
     </subpackage>
 

build/checkstyle-jsp.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<!--
+  ~ Password Management Servlets (PWM)
+  ~ http://www.pwm-project.org
+  ~
+  ~ Copyright (c) 2006-2009 Novell, Inc.
+  ~ Copyright (c) 2009-2018 The PWM Project
+  ~
+  ~ 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 2 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, write to the Free Software
+  ~ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+  -->
+
+<!DOCTYPE module PUBLIC
+        "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
+        "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+
+<!--
+  PWM Checkstyle definition
+-->
+
+<module name="Checker">
+    <property name="fileExtensions" value="java, xml, jsp"/>
+
+    <module name="TreeWalker" >
+        <module name="Regexp">
+            <property name="format" value="WarnJavaScriptNotEnabledMessage"/>
+            <property name="illegalPattern" value="true"/>
+        </module>
+    </module>
+</module>

build/checkstyle-suppression.xml

@@ -0,0 +1,28 @@
+<!--
+  ~ Password Management Servlets (PWM)
+  ~ http://www.pwm-project.org
+  ~
+  ~ Copyright (c) 2006-2009 Novell, Inc.
+  ~ Copyright (c) 2009-2016 The PWM Project
+  ~
+  ~ 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 2 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, write to the Free Software
+  ~ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+  -->
+<!DOCTYPE suppressions PUBLIC
+        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
+        "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+
+<suppressions>
+    <suppress files="XmlFactoryTest\.xml" checks="[a-zA-Z0-9]*"/>
+</suppressions>