Ring middleware for Okta Single Sign-on.
Since Okta doesn't publish the SAML Toolkit for Java, you must download it here. You then must
mvn install it to your local maven repository. Check the project.clj for the version of the SAML Toolkit to download from Okta.
(:require [compojure.core :refer :all]
[compojure.route :as route]
[ring.middleware.okta :refer [wrap-okta okta-routes]]))
(GET "/"  "<h1>Hello World</h1>")
(route/not-found "<h1>Page not found</h1>"))
The documentation is built with codox (
lein codox) and published to
./docs which ends up being hosted by GitHub Pages.
The test coverage summary is built with cloverage (
lein cloverage) and published to
./docs/coverage and is hosted here.
As described in Usage above, the Okta SAML Toolkit must be downloaded and installed to your local maven repository. When updating this dependency, here is how you can install the downloaded jar:
$ mvn install:install-file -Dfile=saml-toolkit.jar -DgroupId=com.okta -DartifactId=saml-toolkit -Dpackaging=jar -Dversion=<version> -DcreateChecksum=true -DupdateReleaseInfo=true -DgeneratePom=true -DlocalRepositoryPath=/path/to/localRepo
ring-okta is released on no particular schedule. New versions are released as needed when features are added or bugs are fixed.
Refer to the CHANGELOG.md for all version releases and the included changes.
The process for releasing a new version is as follows:
- Bump version in project.clj following Semantic Versioning 2.0.0
- Bump version in README.md to match
- Add changes to CHANGELOG.md following Keep a Changelog
- Generate API docs with
- Commit changes with commit message
- Tag the commit with
git tag v<version>
- Push changes to GitHub (including new tag with
- Deploy release to Clojars with
lein deploy clojars
- Bump patch version of
project.clj to next
- Commit snapshot version with commit message
Copyright © 2021 Matthew Boston
Released under the MIT License.