Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/islandora/syn
Tomcat valve for JWT Authentication
https://github.com/islandora/syn
islandora
Last synced: 8 days ago
JSON representation
Tomcat valve for JWT Authentication
- Host: GitHub
- URL: https://github.com/islandora/syn
- Owner: Islandora
- License: mit
- Created: 2017-03-07T18:25:33.000Z (almost 8 years ago)
- Default Branch: 1.x
- Last Pushed: 2022-09-13T17:45:17.000Z (over 2 years ago)
- Last Synced: 2023-03-11T12:46:12.472Z (almost 2 years ago)
- Topics: islandora
- Language: Java
- Homepage:
- Size: 160 KB
- Stars: 4
- Watchers: 38
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
#  Syn
[](https://github.com/Islandora/Syn/actions)
[](./CONTRIBUTING.md)
[](./LICENSE)
[](https://codecov.io/gh/Islandora/Syn)
## Introduction
A valve for Tomcat8 that authenticates the JWT tokens created by Islandora in order to provide sessionless Authentication for Fedora. Named after the Norse goddess [Syn](https://en.wikipedia.org/wiki/Syn_(goddess)).
## Requirements
This project requires Java 8 and can be built with [Gradle](https://gradle.org). To build and test locally, use `./gradlew build`.
## Installation
### Copy Syn JAR
Copy the JAR that was built above from `build/libs/islandora-syn-X.X.X-all.jar` and place into `$TOMCAT_HOME/lib` directory. Can be found in Ubuntu at: `/var/lib/tomcat8/lib/`. Note that this JAR is built to contain all the dependencies.
### Register Valve
Now register the valve in Tomcat configuration file.
In Ubuntu this file is located at: `/var/lib/tomcat8/conf/context.xml`
```xml
```
where:
* ***pathname***: The location of the settings file. Defaults to `$CATALINA_BASE/conf/syn-settings.xml`.
### Enable `security-constraint`
The valve checks if requested URL is under **security constraints**. So, valve will activate only if the Fedora4 *web.xml* file contains something like:
```xml
Fedora4
/*
*
NONE
islandora
BASIC
fcrepo
```
On Ubuntu this file can be found at:
`/var/lib/tomcat8/webapps/fcrepo/WEB-INF/web.xml`
### Setup Syn Configuration
Modify the [example configuration](./conf/syn-settings.example.xml) and move it to: `$CATALINA_BASE/conf/syn-settings.xml`.
### Header principals
Additional roles are passed to Fedora via a HTTP header, this is configured via the `header` attribute to the `` element in the syn-settings.xml.example file. You must also configure Fedora to read this header via its HeaderProvider.
## Documentation
Further documentation for this module is available on the [Islandora 8 documentation site](https://islandora.github.io/documentation/).
## Troubleshooting/Issues
Having problems or solved a problem? Check out the Islandora google groups for a solution.
* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora)
* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev)
## Maintainers
Current maintainers:
* [Jared Whiklo](https://github.com/whikloj)
## Development
If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/islandora/documentation/wiki). We love to hear from you!
If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) pages on Islandora.ca for more information.
We recommend using the [islandora-playbook](https://github.com/Islandora-Devops/islandora-playbook) to get started.
## License
[MIT](/LICENSE.txt)