pwm/README.md

PWM

PWM is an open source password self service application for LDAP directories. PWM is an ideal candidate for organizations that wish to “roll their own” password self service solution, but do not wish to start from scratch. Overview/Screenshots

Official project page is at https://github.com/pwm-project/pwm/.

Links

• PWM-General Google Group - please ask for assistance here first.
• PWM Documentation Wiki - Home for PWM documentation
• Current Builds - Current downloads built from recent github project commits
• PWM Reference - Reference documentation built into PWM.

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)
• Polished, intuitive end-user interface with as-you-type password rule enforcement
• Forgotten Password
  • Store Responses in local server, standard RDBMS database, LDAP server or Novell NMAS repositories
  • Use Forgotten Password, Email/SMS Token/PIN, TOTP, Remote REST service, User LDAP attribute values, or any combination
  • Stand-alone, easy to deploy, java web application
• Helpdesk password reset and intruder lockout clearing
• New User Registration / Account Creation
• Guest User Registration / Updating
• PeopleSearch (white pages)
• Account Activation / First time password assignment
• Administration modules including intruder-lockout manager, and online log viewer, daily stats viewer and user information debugging
• Easy to customize JSP HTML pages
• Theme-able interface with several example CSS themes
• Support for large dictionary wordlists to enforce strong passwords
• Shared password history to prevent passwords from being reused organizationally
• Automatic LDAP server fail-over to multiple ldap servers
• Support for password replication checking and minimum time delays during password sets
• Captcha support using reCaptcha
• Integration with CAS
• Support for minimal, restricted and mobile browsers with no cookies, javascript or css
• Specialized skins for iPhone/Mobile devices
• Designed for integration with existing portals and web security gateways
• Directory Support
  • Generic LDAP
  • Directory 389
  • NetIQ eDirectory
    • Password Policies & Challenge Sets
    • NMAS Operations and Error handling
    • Support for NMAS user challenge/responses
  • Microsoft Active Directory
  • OpenLDAP

NetIQ SSPR 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