# openig_examples

**Repository Path**: mirrors_wstrange/openig_examples

## Basic Information

- **Project Name**: openig_examples
- **Description**: Sample configuration files for ForgeRock OpenIG
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-26
- **Last Updated**: 2026-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

openig_examples
===============

Sample configuration files for ForgeRock [OpenIG](http://openig.forgerock.org/).

OpenIG is a Java based reverse proxy that specializes in solving Identity Management challenges. For example,
OpenIG can perform the following:
* Act as a SAML Relying Party 
* Authenticate against an OpenID connect provider
* Act as an OAuth 2 resource server
* Perform SSO to legacy web applications using stored credentials. 

For more information on OpenIG refer to the [documentation](http://openig.forgerock.org/doc/webhelp/gateway-guide/index.html)

# Overview

This project contains a number of sample OpenIG configurations to demonstrate various OpenIG features. 

See the README.md in each example directory for an description of each example. 

**Pull requests are welcome!** If you have a neat OpenIG example that you can share, please add it as a
 new example directory and send me a pull request via github. 
 

# Running the examples 

To run these examples you will need to set the OpenIG base location to the root of each example. 
You can do this with a java option to the container (-Dopenig.base=/path/to/openig/config) or set
the OPENIG_BASE environment variable. For example, to test example 1, using Jetty as the container:

```
 java -Dopenig.base=/Users/myhome/src/openig_examples/example1 -jar start.jar 
 ```


For your convenience there is a shell script ```run.sh``` that will handle the above for you. 

To use run.sh, copy the file env.template to env.sh, and edit to suit your environment.

To run an example:
```
./run.sh example1
```

# Secrets 

The examples use stored secrets which should not be checked in to github. Copy 
the file env.template to env.sh and edit to suit your environment.


# Examples

 
Example  | Description 
---------| -----------
example1 | Demonstrate authentication using the OpenID Connect Filter 
example2 | Using the OAuth2 resource server filter to protect a REST resource


# A Note on Routing

OpenIG accepts the *first* route that matches a request, and it evaluates routes in 
name lexicographical order.  This is why this default route in the examples is named "zDefault" (z being
at the end of the alphabet).  If 
(for example) the default route was called "aDefault" - our other routes would never run. 
The default route would always take precedence since it matches any request, and is evaluated first.