osiam / vagrant

A development environment for OSIAM based on Vagrant

OSIAM - Open Source Identity and Access Management

Active development of this project has stopped.

OSIAM is a secure identity management solution providing REST based services for authentication and authorization. We achieve this by implementing two important open standards:

• OAuth 2.0
• SCIM 2.0

OSIAM is published under the MIT licence, giving you the greatest freedom possible to utilize OSIAM in you project or product. Watch our blog to stay informed about releases and upcoming changes.

Use cases

• Single app with OSIAM as free backing store for users and groups and local auth service.
• Distributed app with OSIAM as central identity store and auth service.
• Publish your app's API with OSIAM as auth service for 3rd-parties and allow safe access to your user's data.

Quick Start

Download the latest version of OSIAM:

curl -L https://dl.bintray.com/osiam/downloads/osiam/3.0/osiam-3.0.war -o osiam.war

Make the .war file executable:

chmod +x osiam.war

Start OSIAM:

./osiam.war

After some seconds, OSIAM should be fully running. You can now retrieve your first access token:

curl -H "Authorization: Basic ZXhhbXBsZS1jbGllbnQ6c2VjcmV0" -X POST -d "grant_type=client_credentials&scope=ADMIN" http://localhost:8080/oauth/token

You can now start to setup OSIAM, by changing the administrator's password and add your own OAuth client. Please see the Installation and Configuration Manual for details.

Documentation

Learn how to install and configure OSIAM for production in the documentation.

Components

• osiam handles the authentication and authorization based on OAuth 2.0 and holds the SCIM based user data
• addon-self-administration provides account management self-service as a web application
• addon-administration lets you administer users and groups via a web application

Easy customization

Every visual aspect of OSIAM's components can be easily customized by supplying your own templates, stylesheets and scripts to make OSIAM integrate seamlessly with your application. Read the customization guide to learn more.

Snapshots

To use the latest snapshot of OSIAM just download it from JFrog OSS: https://oss.jfrog.org/repo/org/osiam/osiam/latest-SNAPSHOT/

Scroll down to the bottom of the page and select the latest WAR file.

Issue Tracker

Please report issues, bugs and feature requests via [the issue tracker] (https://github.com/osiam/osiam/issues).

Get involved

Help is very appreciated. Please read the contributors guide to learn how to get started.

vagrant's Issues

Provide simple smtp server

To handle the email notification of the self-administration a simple smtp server should be running in the VM. We already using the greenmail webapp to handle this in the integration-tests, maybe this is also a good solution for the vagrant VM? Any other ideas?

Current initialization is broken because of a missing release OSIAM 2.4

The vagrant VM can not be created because the download of release 2.4 is not possible:

OSIAM_VERSION=2.4

wget --quiet https://github.com/osiam/osiam/releases/download/v${OSIAM_VERSION}/osiam-distribution-${OSIAM_VERSION}.tar.gz

We need to switch to another initial installation or download the releases individually of all OSIAM components.

Expose integration-tests ports

If you like to run the integration-tests against the vagrant vm it is useful to expose the ports for tomcat, postgres and mysql. Because the database ports were changed and the tomcat in the docker container listen to a different port, it's easy to run them simultaneously to the installed tomcat and postgres instances.

Switch to Debian Jessie

The title should be self-explanatory :)

Kernel update breaks Docker

Updating the Kernel does not install the matching Kernel extras package, so Docker won't use AUFS but fall back to devicemapper. This is due to linux-image-generic is not installed on the Vagrant base box.

Make upgrades easier

The readme states:

To upgrade your environment to a new version, you have to destroy the old and
create a new one. The provisioning doesn't support multiple runs very well. This
issue will be addressed in a future version.

To make upgrades easier, we should somehow make the provisioning idempotent. Most stuff is already safe to be run multiple times. First step would be to identify the non-idempotent parts and then think of a solution for them.

JDK not installed by default

This breaks Maven as we depend on javac ...

Use the supplied SQL scripts of the addons

At this time, a big "setup" SQL script is used so create clients, extension, etc. that are needed by the addons. This is due to issues in the upstream projects, that have been fixed but not released yet. As soon as these fixes have been released we should get rid of the setup_data.sql and directly use the stuff from the addons.

What should we use to replace the main distribution for initial installation?

As the main distribution has been abandoned, the Vagrant VM has to be changed to use some other source for initial installation. There are several options:

1. the single distributions
2. the upstream sources on GitHub
3. the mounted sources from the user

Each one has significant drawbacks:

1. Can only install releases. This is the same problem as with the main distribution.
2. Where should we check them out? There are already the mounted sources from the user, if he chooses to do so. Feels like duplication.
3. Some users might not clone the sources and mount them, but simply using the Vagrant VM for integration and exploration.

Number 2. works really well in the current Docker images, so I'd vote for this option.

What's your opinion?

Part of: osiam/osiam#93