Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 4.03 KB

README.md

File metadata and controls

68 lines (50 loc) · 4.03 KB
Raw

pritunl-keycloak-user-check

Description

The pritunl-keycloak-user-check is a plugin for Pritunl that checks if a user is available in Keycloak. It enhances the security and flexibility of VPN access management by leveraging Keycloak's authentication system. This repository also includes documentation on integrating Pritunl SSO with Keycloak. You NEED Pritunl Enterprise subscription for this integration

What the Script Does

The script acts as a middleware between Pritunl and Keycloak, performing real-time user status checks during VPN connection attempts. It ensures that:

  • Only users who exist in Keycloak and are not blocked are allowed to access the Pritunl VPN.
  • Users blocked with unverified email (optional check) are denied VPN access.

Configuration Parameters

Before deploying the script, you need to adjust several parameters to match your Keycloak and Pritunl setup:

  • KEYCLOAK_URL: The URL of your Keycloak instance.
  • REALM: The realm in Keycloak where your users are managed.
  • CLIENT_ID: The client ID for the Keycloak client used for authentication.
  • CLIENT_SECRET: The client secret associated with your Keycloak client.
  • DEBUG: Set to True for detailed logging, useful for debugging.
  • SEARCH_BY_EMAIL: Set to True to search users by email, False to search by username.
  • CHECK_EMAIL_VERIFICATION: Set to True to require email verification in Keycloak for VPN access.

Limitations

  • Keycloak Availability: If Keycloak is unavailable, VPN users will be denied authorization. This dependency means that the VPN access control is directly tied to Keycloak's uptime.
  • User Existence and Status Checks: The script only verifies whether a user exists in Keycloak and whether they are active. Participation in groups and realm roles are not checked, which limits the scope of access control to basic user status.
  • Persistent VPN Connections: If a user is connected to the VPN and is subsequently blocked in Keycloak, their VPN connection will not be terminated automatically. This behavior may lead to potential security concerns where blocked users retain access until their session ends or is manually terminated. However, you can set the "User Session Timeout" parameter in each pritunl server config to ensure that the connection is forcibly terminated and a reconnection occurs.

Installation

Script installation

Follow these steps to deploy the pritunl-keycloak-user-check script on your Pritunl server:

  1. Ensure you have a Keycloak client set up for your Pritunl server.
  2. Place keykloak-user-check.py to the Pritunl plugins directory. By default, this directory is /var/lib/pritunl/plugins.
  3. Adjust the parameters in the script as per your Keycloak configuration.
  4. sudo systemctl restart pritunl.
  5. Check the Pritunl logs to ensure that the plugin is loaded correctly and functioning as expected tail /var/log/pritunl.log -n 100.
  6. Test the VPN connection to confirm that the user status checks against Keycloak are functioning correctly. Attempt to connect with a user that. is both enabled and disabled in Keycloak to see if the script behaves as expected.

Keycloak client setup

Set up a new client in Keycloak with the following example configuration:

  1. Client Type: OpenID Connect
  2. Client ID: pritunl-user-check
  3. Name: Pritunl user check client
  4. Client authentication: On
  5. Authorization: Off
  6. Authentication flow: disable all and set Service accounts roles

Credentials page:

  1. Client Authenticator: Client Id and Secret Press "Save"

In Service accounts roles page:

  1. Press Assign role:
  2. Select Filter by clients
  3. Select view-users (should be realm-management label)
  4. Press "Assign"

Use Client Id and Client Secret from Credentials page as CLIENT_ID and CLIENT_SECRET in plugin setup.

Contribution

Contributions to this project are welcome! Please feel free to fork the repository, make your changes on a feature branch, and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.