From fe16b8019010fe752d45e8204f50d186a0fa150a Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Thu, 27 Apr 2023 20:49:29 +0000
Subject: [PATCH] GitHub Actions: use softprops/action-gh-release@v1 for releases

---
 README.md |   73 ++++++++++++++++++++++++++++++++++++
 1 files changed, 72 insertions(+), 1 deletions(-)

diff --git a/README.md b/README.md
index ea133ff..ac27566 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,72 @@
-# keycloak-protocol-cas
\ No newline at end of file
+# keycloak-protocol-cas
+
+This plugin for Keycloak Identity and Access Management (http://www.keycloak.org) adds the CAS 3.0 SSO protocol
+as an available client protocol to the Keycloak system. It implements the required Service Provider Interfaces (SPIs)
+for a Login Protocol and will be picked up and made available by Keycloak automatically once installed.
+
+![Build status](https://github.com/jacekkow/keycloak-protocol-cas/workflows/Release/badge.svg)
+
+## Features
+
+The following CAS features are currently implemented:
+* CAS 1.0/2.0/3.0 compliant Login/Logout and Service Ticket Validation
+* Single Logout (SLO)
+* Filtering of provided `service` against configured redirect URIs
+* JSON and XML response types
+* Mapping of custom user attributes to CAS assertion attributes
+
+The following features are **missing**:
+* SAML request/response [CAS 3.0 - optional]
+* Proxy ticket service and proxy ticket validation [CAS 2.0]
+
+The following features are out of scope:
+* Long-Term Tickets - Remember-Me [CAS 3.0 - optional]
+
+## Compatibility
+
+The CAS plugin has been tested against the same Keycloak version as the plugin version.
+
+As a rule of thumb plugin version should **match your Keycloak version**.
+
+## Installation
+
+Quarkus is the default distribution method of Keycloak 17.0.0 and newer. For legacy installations using WildFly, please refer to the [old README](https://github.com/jacekkow/keycloak-protocol-cas/blob/16.1.1/README.md).
+
+1. Download the latest release compatible with your Keycloak version from the [releases page](https://github.com/jacekkow/keycloak-protocol-cas/releases).
+2. Put the downloaded JAR file into the `providers/` directory inside Keycloak installation folder.
+3. Stop the Keycloak server.
+4. (Re-)build the installation using `kc.sh build` command.
+5. Start the Keycloak: `kc.sh start`
+
+Remember to update plugin artifact with each Keycloak server upgrade!
+
+## Configuration
+
+To use the new protocol, you have to create a client within Keycloak as usual, selecting `cas` as protocol.
+As there is no client ID indication in protocol, the client will be identified by the redirect URIs
+configured in Keycloak.
+
+Enter `https://your.keycloak.host/realms/master/protocol/cas` as the CAS URL into your SP.
+This assumes that you use the default `master` realm - if not, modify the URL accordingly.
+
+Note that some client implementations require you to enter login and validate URLs, not CAS URL!
+This manifests with "Page Not Found" error on login attempt
+(see [issue #27](https://github.com/jacekkow/keycloak-protocol-cas/issues/27) for example).
+In such case append `/login` to the CAS URL to get the "login URL".
+Similarly append `/serviceValidate` to get the "validate URL".
+
+## Disclaimer
+
+This plugin was implemented from scratch to comply to the official CAS protocol specification,
+and is based heavily on the OpenID Connect implementation in Keycloak.
+It is licensed under the Apache License 2.0.
+
+This repo is a fork of https://github.com/Doccrazy/keycloak-protocol-cas
+and includes changes for Keycloak 8 and newer that were not merged by the owner for half a year.
+
+## References
+
+[1] https://www.keycloak.org/
+[2] https://issues.jboss.org/browse/KEYCLOAK-1047 (Support CAS 2.0 SSO protocol)
+[3] https://apereo.github.io/cas/4.2.x/protocol/CAS-Protocol-Specification.html
+[4] https://keycloak.gitbooks.io/server-developer-guide/content/topics/providers.html

--
Gitblit v1.9.1