frdp-containers-uma

ForgeRock Demonstration Platform (FRDP) : Containers UMA : Is a repository that provides a Ready-2-Run environment for testing the User-Managed Access (UMA) Reference Implementation. The project requires docker and docker-compose technologies. The Docker Desktop for Mac was used to develop this project.

This GitHub repository leverages containers to easily stand-up a User-Managed Access (UMA) test environment. The following GitHub repositories are used:

The GitHub repositories, ForgeRock Access Manager, and MongoDB are used to create Docker images that are managed by Docker Compose. The provided Postman collections and step-by-step documentation provide a easy way to test UMA use cases.

Video

Watch the YouTube video that covers the setup procedures, builds the containers and runs the test use cases.

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

License

MIT

Requirements

Docker

Install docker on your desktop

Clone this project

git clone https://github.com/ForgeRock/frdp-containers-uma.git

ForgeRock Access Manager / Amster

This project uses the ForgeRock Access Manager 7.0.1 which provides User-Manager Access (UMA) Authorization Server functionality. The ForgeRock Amster utility is used to automate the configuration of Access Manager. Access Manager and Amster can be download from the ForgeRock backstage web site.

NOTICE: You need an account to access the ForgeRock backstage resources.

Download the Access Manager zip file and save it to a temporary location.
From the temporary Access Manager location, expanded zip file
From the temporary Access Manager location ...
Copy the openam/AM-7.0.1.war file to:
containers/auth-server/docker/build/resources/am.war
Download the Amster zip file and save it to a temporary location.
Copy the Amster-7.0.1.zip file to:
containers/auth-server/docker/build/resources/amster.zip

Setup

hostnames

You must add the following aliases to the /etc/hosts file for localhost

as.example.com
rs.example.com

For MacOS

sudo vi /etc/hosts

BEFORE:
127.0.0.1 localhost
AFTER:
127.0.0.1 localhost as.example.com rs.example.com

Notice

This project will use a number of ports on your local system. See the table below for which localhost ports are used. The docker-compose.yml file and individual Dockerfile files can be modified to use different localhost ports.

Run

Use the docker-compose command build and run the Docker containers:

$ cd frdp-containers-uma
$ docker-compose up --build

Verify

Docker

After the build process is complete, check that the containers are running. Open another terminal and run docker ps:

CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS              PORTS                      NAMES
55b21cf3050c        uma-rs              "catalina.sh run"        29 seconds ago      Up 28 seconds       0.0.0.0:8090->8080/tcp     uma-rs
3024a33fab15        uma-cs              "catalina.sh run"        30 seconds ago      Up 29 seconds       0.0.0.0:8085->8080/tcp     uma-cs
240022b09471        uma-as              "catalina.sh run"        30 seconds ago      Up 29 seconds       0.0.0.0:8080->8080/tcp     uma-as
be18f3fcf73f        uma-db              "docker-entrypoint.s…"   30 seconds ago      Up 29 seconds       0.0.0.0:27017->27017/tcp   uma-db

Authorization Server

Log into the Authorization Server as the two test users. Open a web browser and access ... http://as.example.com:8080/am

User	Password	First name	Last name	UMA operations
`dcrane`	`Uma-1234`	Danny	Crane	Resource Owner
`bjensen`	`Uma-1234`	Barb	Jensen	Requesting Party

From the top toolbar
Select SHARES drop down menu
Select RESOURCES menu item
From Left Menu ...
My Resource displays the user's registered UMA resources
Shared with Me displays resource's the user can access

Note: You will not see any UMA resources until they are registered and have a policy.

Testing

To test the UMA containers environment, postman collections have been provided.

See the Postman folder ... which contains an environment file, collection files and test procedures.

Reference

Properties

Name	Value	Reference
Domain Name	`example.com`
Admin Password	`password`	used by `amadmin` user
OAuth Client Password	`password`	used by `UMA-RS` and `UMA-RqP` clients

Images / Containers

Description	Hostname	Image Name	Container Name	Host Port	Container Port
Authorization Server	`as`	`uma-as`	`uma-as`	`8080`	`8080`
Mongo Database	`db`	`uma-db`	`uma-db`	`27017`	`27017`
Content Server	`cs`	`uma-cs`	`uma-cs`	`8085`	`8080`
Resource Server	`rs`	`uma-rs`	`uma-rs`	`8090`	`8080`
Resource Server (debugger)	`rs`	`uma-rs`	`uma-rs`	`9000`	`8000`

Services

The containers expose services that are mapped to localhost, on specific ports.

Server	URL	Description
Authorization Server	http://localhost:8080/am	ForgeRock Access Manager
Content Server	http://localhost:8085/content-server	CRUD REST service for JSON content
Resource Server	http://localhost:8090/resource-server	Reference Implementation of UMA Resource Server

Related projects

The following GitHub repositories are used:

isabella232 / frdp-containers-uma Goto Github PK