Syn

Description

A ServletFilter that authenticates the JWT tokens created by Islandora in order to provide sessionless Authentication for Fedora4. Named after the Norse goddess Syn.

Building

This project requires Java 8 and can be built with Gradle. To build and test locally, use ./gradlew build.

Installing

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 or the individual webapps WEB-INF/lib directory. Can be found in Ubuntu at: /var/lib/tomcat8/lib/. Note that this JAR is built to contain all the dependancies.

Register Filter

Now register the filter in web applications' web.xml file by adding something like.

  <filter>
    <filter-name>SynFilter</filter-name>
    <filter-class>ca.islandora.syn.valve.SynFilter</filter-class>
    <init-param>
      <param-name>settings-path</param-name>
      <param-value>/var/lib/tomcat8/conf/syn-settings.yml</param-value>
    </init-param>
  </filter>

  <filter-mapping>
    <filter-name>SynFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

Where the settings-path param-value is the the location of the settings file.

On ubuntu this file can be found at: /var/lib/tomcat8/webapps/fcrepo/WEB-INF/web.xml

Setup Syn Configuration

Modify the example configuration and move it to: $CATALINA_BASE/conf/syn-settings.xml. Then use this path when configuring the application's filter init-params.

Maintainers

Development

If you would like to contribute, please get involved by attending our weekly Tech Call. 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 or Corporate Contributor Licencse Agreement. Please see the Contributors pages on Islandora.ca for more information.

Licensing

MIT

dannylamb/Syn

Syn