You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@guacamole.apache.org by "bayars (via GitHub)" <gi...@apache.org> on 2026/01/18 03:36:05 UTC

[PR] GUACAMOLE-519 Implement Single Logout on OpenID Extension [guacamole-client]

bayars opened a new pull request, #1149:
URL: https://github.com/apache/guacamole-client/pull/1149

   Related Issues:
   - [GUACAMOLE-519](https://issues.apache.org/jira/browse/GUACAMOLE-519): Implement Single Logout on OpenID Extension
   - [GUACAMOLE-758](https://issues.apache.org/jira/browse/GUACAMOLE-758): OpenID Guacamole Logout
   
   ## General SSO Design
   When registering Guacamole with your OpenID Connect provider, you will typically need to provide:
   
   1. **Redirect URI / Callback URL**: The full URL to your Guacamole installation (e.g., `https://guacamole.example.com/guacamole/`)
   2. **Post-Logout Redirect URI**: The URL to redirect to after logout (typically the same as the redirect URI)
   3. **Client Type**: Public client (Guacamole uses the implicit flow)
   4. **Allowed Scopes**: `openid`, `email`, `profile`, and optionally `groups`
   
   ## Single Logout Behavior
   
   When `openid-logout-endpoint` is configured:
   
   1. User clicks logout in Guacamole
   2. Guacamole session is terminated
   3. User is redirected to the identity provider's logout endpoint
   4. Identity provider terminates the SSO session
   5. User is redirected back to `openid-post-logout-redirect-uri` (or `openid-redirect-uri` if not specified)
   
   The logout request includes:
   - `post_logout_redirect_uri`: Where to redirect after logout
   - `id_token_hint`: The user's ID token (if available), or
   - `client_id`: The Guacamole client ID (if ID token is not available)
   
   ## Example Configurations:
   
   I have tested with the Keycloak only. I am not sure for others, but others have similar integrations/variables.
   
   ### Keycloak Configuration                                                                                                                                                                                                                                   
                                                                                                                                                                                                                                                                
   ```properties                                                                                                                                                                                                                                                
   # Keycloak OpenID Connect settings                                                                                                                                                                                                                           
   openid-authorization-endpoint: https://keycloak.example.com/realms/myrealm/protocol/openid-connect/auth                                                                                                                                                      
   openid-jwks-endpoint: https://keycloak.example.com/realms/myrealm/protocol/openid-connect/certs                                                                                                                                                              
   openid-issuer: https://keycloak.example.com/realms/myrealm                                                                                                                                                                                                   
   openid-client-id: guacamole                                                                                                                                                                                                                                  
   openid-redirect-uri: https://guacamole.example.com/guacamole/                                                                                                                                                                                                
   
   # Optional: Use preferred_username instead of email                                                                                                                                                                                                          
   openid-username-claim-type: preferred_username                                                                                                                                                                                                               
   
   # Optional: Enable Single Logout                                                                                                                                                                                                                             
   openid-logout-endpoint: https://keycloak.example.com/realms/myrealm/protocol/openid-connect/logout                                                                                                                                                           
   openid-post-logout-redirect-uri: https://guacamole.example.com/guacamole/                                                                                                                                                                                    
   ```                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                
   ### Okta Configuration                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                
   ```properties                                                                                                                                                                                                                                                
   # Okta OpenID Connect settings                                                                                                                                                                                                                               
   openid-authorization-endpoint: https://your-domain.okta.com/oauth2/default/v1/authorize                                                                                                                                                                      
   openid-jwks-endpoint: https://your-domain.okta.com/oauth2/default/v1/keys                                                                                                                                                                                    
   openid-issuer: https://your-domain.okta.com/oauth2/default                                                                                                                                                                                                   
   openid-client-id: your-client-id                                                                                                                                                                                                                             
   openid-redirect-uri: https://guacamole.example.com/guacamole/                                                                                                                                                                                                
   
   # Optional: Enable Single Logout                                                                                                                                                                                                                             
   openid-logout-endpoint: https://your-domain.okta.com/oauth2/default/v1/logout                                                                                                                                                                                
   ```                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                
   ### Azure AD Configuration                                                                                                                                                                                                                                   
                                                                                                                                                                                                                                                                
   ```properties                                                                                                                                                                                                                                                
   # Azure AD OpenID Connect settings                                                                                                                                                                                                                           
   openid-authorization-endpoint: https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize                                                                                                                                                           
   openid-jwks-endpoint: https://login.microsoftonline.com/{tenant-id}/discovery/v2.0/keys                                                                                                                                                                      
   openid-issuer: https://login.microsoftonline.com/{tenant-id}/v2.0                                                                                                                                                                                            
   openid-client-id: your-application-client-id                                                                                                                                                                                                                 
   openid-redirect-uri: https://guacamole.example.com/guacamole/                                                                                                                                                                                                
   
   # Azure AD uses 'preferred_username' claim                                                                                                                                                                                                                   
   openid-username-claim-type: preferred_username                                                                                                                                                                                                               
   
   # Optional: Request groups in token                                                                                                                                                                                                                          
   openid-scope: openid email profile groups                                                                                                                                                                                                                    
   
   # Optional: Enable Single Logout                                                                                                                                                                                                                             
   openid-logout-endpoint: https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/logout                                                                                                                                                                     
   ```
   
   ### Google Configuration
   
   ```properties
   # Google OpenID Connect settings
   openid-authorization-endpoint: https://accounts.google.com/o/oauth2/v2/auth
   openid-jwks-endpoint: https://www.googleapis.com/oauth2/v3/certs
   openid-issuer: https://accounts.google.com
   openid-client-id: your-client-id.apps.googleusercontent.com
   openid-redirect-uri: https://guacamole.example.com/guacamole/
   ```
   
   ### Auth0 Configuration
   
   ```properties
   # Auth0 OpenID Connect settings
   openid-authorization-endpoint: https://your-domain.auth0.com/authorize
   openid-jwks-endpoint: https://your-domain.auth0.com/.well-known/jwks.json
   openid-issuer: https://your-domain.auth0.com/
   openid-client-id: your-client-id
   openid-redirect-uri: https://guacamole.example.com/guacamole/
   
   # Optional: Enable Single Logout
   openid-logout-endpoint: https://your-domain.auth0.com/v2/logout 
   ```
   
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GUACAMOLE-519: Implement Single Logout on OpenID Extension [guacamole-client]

Posted by "bayars (via GitHub)" <gi...@apache.org>.
bayars commented on PR #1149:
URL: https://github.com/apache/guacamole-client/pull/1149#issuecomment-3766063429

   @necouchman, done. Please recheck again


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GUACAMOLE-519 Implement Single Logout on OpenID Extension [guacamole-client]

Posted by "necouchman (via GitHub)" <gi...@apache.org>.
necouchman commented on PR #1149:
URL: https://github.com/apache/guacamole-client/pull/1149#issuecomment-3766048985

   @bayars 
   * Your commit messages all need to container the `GUACAMOLE-519:` prefix.
   * The pull request needs to be properly titled with a `:` between the Jira issue and the rest of the message.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GUACAMOLE-519: Implement Single Logout on OpenID Extension [guacamole-client]

Posted by "bayars (via GitHub)" <gi...@apache.org>.
bayars commented on code in PR #1149:
URL: https://github.com/apache/guacamole-client/pull/1149#discussion_r2726125643


##########
extensions/guacamole-auth-sso/modules/guacamole-auth-sso-openid/src/main/java/org/apache/guacamole/auth/openid/conf/ConfigurationService.java:
##########
@@ -429,4 +454,39 @@ public int getMaxNonceValidity() throws GuacamoleException {
         return environment.getProperty(OPENID_MAX_NONCE_VALIDITY, DEFAULT_MAX_NONCE_VALIDITY);
     }
 
+    /**
+     * Returns the logout endpoint (URI) of the OpenID service, as configured
+     * with guacamole.properties. If configured, users will be redirected to
+     * this endpoint when they log out from Guacamole.
+     *
+     * @return
+     *     The logout endpoint of the OpenID service, as configured with
+     *     guacamole.properties, or null if not configured.
+     *
+     * @throws GuacamoleException
+     *     If guacamole.properties cannot be parsed.
+     */
+    public URI getLogoutEndpoint() throws GuacamoleException {
+        return environment.getProperty(OPENID_LOGOUT_ENDPOINT);
+    }
+
+    /**
+     * Returns the URI that the OpenID service should redirect to after logout
+     * is complete, as configured with guacamole.properties. If not configured,
+     * the main redirect URI will be used.
+     *
+     * @return
+     *     The post-logout redirect URI, as configured with
+     *     guacamole.properties, or the main redirect URI if not specified.
+     *
+     * @throws GuacamoleException
+     *     If guacamole.properties cannot be parsed.
+     */
+    public URI getPostLogoutRedirectURI() throws GuacamoleException {
+        URI postLogoutRedirectURI = environment.getProperty(OPENID_POST_LOGOUT_REDIRECT_URI);

Review Comment:
   Yes, that works. I pushed one more commit for that.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GUACAMOLE-519: Implement Single Logout on OpenID Extension [guacamole-client]

Posted by "bayars (via GitHub)" <gi...@apache.org>.
bayars commented on code in PR #1149:
URL: https://github.com/apache/guacamole-client/pull/1149#discussion_r2726125643


##########
extensions/guacamole-auth-sso/modules/guacamole-auth-sso-openid/src/main/java/org/apache/guacamole/auth/openid/conf/ConfigurationService.java:
##########
@@ -429,4 +454,39 @@ public int getMaxNonceValidity() throws GuacamoleException {
         return environment.getProperty(OPENID_MAX_NONCE_VALIDITY, DEFAULT_MAX_NONCE_VALIDITY);
     }
 
+    /**
+     * Returns the logout endpoint (URI) of the OpenID service, as configured
+     * with guacamole.properties. If configured, users will be redirected to
+     * this endpoint when they log out from Guacamole.
+     *
+     * @return
+     *     The logout endpoint of the OpenID service, as configured with
+     *     guacamole.properties, or null if not configured.
+     *
+     * @throws GuacamoleException
+     *     If guacamole.properties cannot be parsed.
+     */
+    public URI getLogoutEndpoint() throws GuacamoleException {
+        return environment.getProperty(OPENID_LOGOUT_ENDPOINT);
+    }
+
+    /**
+     * Returns the URI that the OpenID service should redirect to after logout
+     * is complete, as configured with guacamole.properties. If not configured,
+     * the main redirect URI will be used.
+     *
+     * @return
+     *     The post-logout redirect URI, as configured with
+     *     guacamole.properties, or the main redirect URI if not specified.
+     *
+     * @throws GuacamoleException
+     *     If guacamole.properties cannot be parsed.
+     */
+    public URI getPostLogoutRedirectURI() throws GuacamoleException {
+        URI postLogoutRedirectURI = environment.getProperty(OPENID_POST_LOGOUT_REDIRECT_URI);

Review Comment:
   You're right - getProperty() handles the default value. Pushed the fix.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GUACAMOLE-519: Implement Single Logout on OpenID Extension [guacamole-client]

Posted by "bayars (via GitHub)" <gi...@apache.org>.
bayars commented on PR #1149:
URL: https://github.com/apache/guacamole-client/pull/1149#issuecomment-3800279181

   > Thanks @bayars! If you could update the manual, as well (apache/guacamole-manual repo), and open a PR for that, that would be great!
   
   Thank you, I will create a separate Mr on this weekend.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GUACAMOLE-519: Implement Single Logout on OpenID Extension [guacamole-client]

Posted by "necouchman (via GitHub)" <gi...@apache.org>.
necouchman commented on code in PR #1149:
URL: https://github.com/apache/guacamole-client/pull/1149#discussion_r2725851635


##########
extensions/guacamole-auth-sso/modules/guacamole-auth-sso-openid/src/main/java/org/apache/guacamole/auth/openid/conf/ConfigurationService.java:
##########
@@ -429,4 +454,39 @@ public int getMaxNonceValidity() throws GuacamoleException {
         return environment.getProperty(OPENID_MAX_NONCE_VALIDITY, DEFAULT_MAX_NONCE_VALIDITY);
     }
 
+    /**
+     * Returns the logout endpoint (URI) of the OpenID service, as configured
+     * with guacamole.properties. If configured, users will be redirected to
+     * this endpoint when they log out from Guacamole.
+     *
+     * @return
+     *     The logout endpoint of the OpenID service, as configured with
+     *     guacamole.properties, or null if not configured.
+     *
+     * @throws GuacamoleException
+     *     If guacamole.properties cannot be parsed.
+     */
+    public URI getLogoutEndpoint() throws GuacamoleException {
+        return environment.getProperty(OPENID_LOGOUT_ENDPOINT);
+    }
+
+    /**
+     * Returns the URI that the OpenID service should redirect to after logout
+     * is complete, as configured with guacamole.properties. If not configured,
+     * the main redirect URI will be used.
+     *
+     * @return
+     *     The post-logout redirect URI, as configured with
+     *     guacamole.properties, or the main redirect URI if not specified.
+     *
+     * @throws GuacamoleException
+     *     If guacamole.properties cannot be parsed.
+     */
+    public URI getPostLogoutRedirectURI() throws GuacamoleException {
+        URI postLogoutRedirectURI = environment.getProperty(OPENID_POST_LOGOUT_REDIRECT_URI);

Review Comment:
   I think you could do this with:
   ```
   return environment.getProperty(OPENID_POST_LOGOUT_REDIRECT_URI, getRedirectURI());
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GUACAMOLE-519: Implement Single Logout on OpenID Extension [guacamole-client]

Posted by "necouchman (via GitHub)" <gi...@apache.org>.
necouchman merged PR #1149:
URL: https://github.com/apache/guacamole-client/pull/1149


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GUACAMOLE-519: Implement Single Logout on OpenID Extension [guacamole-client]

Posted by "necouchman (via GitHub)" <gi...@apache.org>.
necouchman commented on PR #1149:
URL: https://github.com/apache/guacamole-client/pull/1149#issuecomment-3800247442

   Thanks @bayars! If you could update the manual, as well (apache/guacamole-manual repo), and open a PR for that, that would be great!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org