# saml2-sample-java-webapp

**Repository Path**: mirrors_apereo/saml2-sample-java-webapp

## Basic Information

- **Project Name**: saml2-sample-java-webapp
- **Description**: SAML2 client java web application based on Spring Security
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-15
- **Last Updated**: 2026-04-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Spring Security SAML2 - Sample Web Application

A sample application protected by Spring Security Saml2.

## Configuration

### Context

App is available by default at `https://hostname[:port]/sp`.

### SP Metadata

The SP metadata is available under `src\main\resources\metadata`. Deploy the application, and
use the `Metadata Administration` tab to generate new metadata for the SP. Copy the content
and paste them into the `sp-metadata.xml` file.

The newly generated SP metadata needs to be loaded by the IdP, in the `metadata-providers.xml` file.
For example:

```xml
<MetadataProvider id="LocalMetadata"  xsi:type="FilesystemMetadataProvider" 
      metadataFile="/path/to/sp-metadata.xml"/>
```

### IdP Metadata

The IdP metadata is referenced inside the `sp.properties` file. While you are reviewing this file,
also adjust the `host.name` property. This should be pointed to FQDN of the server that hosts the sample
application.

## Build

```bash
gradlew build
```

## Deploy


### Embedded

The application can be run using an embedded Jetty instance:

```bash
gradlew build jettyRunWar
```

- The sample application will be available at: `https://hostname[8081|9876]/sp`
- Remote debugging via the embedded Jetty deployment option is available under port `5005`

### External

The build script is able to automatically deploy the sample to `$CATALINA_HOME`, via:

```bash
gradlew deploy
```

Note that `deploy` will automatically build the sample application as well. 
For this work, you must define the `$CATALINA_HOME` environment variable to point to your
Tomcat installation directory. 

## Test

- The application has been tested with Shibboleth IdP 3.x, 4.x.
- The application has been tested with Apereo CAS 5.x, 6.x.