CSSCurrent en:Pointsharp Identity Provider Configuration: Unterschied zwischen den Versionen

Aus Cryptshare Documentation
Wechseln zu:Navigation, Suche
Keine Bearbeitungszusammenfassung
 
(24 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:


== Pointsharp Identity Provider ==
== Pointsharp Identity Provider ==
Cryptshare supports authentication via the '''Pointsharp Identity Provider''' for the '''Admin Interface and the API'''.
Cryptshare supports authentication via the Pointsharp Identity Provider for the '''Admin Interface.'''


This feature allows administrators to integrate Cryptshare into an external Identity and Access Management (IAM) environment.
This feature allows administrators to integrate Cryptshare into an external Identity and Access Management (IAM) environment.


The feature is '''optional'''. When enabled, authentication via the local Cryptshare user database is disabled. It is always possible to revert back to local authentication by disabling the Identity Provider configuration.
The feature is optional. When enabled, authentication via the local Cryptshare user database is disabled. It is always possible to revert back to local authentication by disabling the Identity Provider configuration.


The Pointsharp Identity Provider integration is available since '''Cryptshare version 7.6.0'''.
The Pointsharp Identity Provider integration is available since '''Cryptshare version 7.5.0'''.


== Supported Identity Providers ==
The usage of the Pointsharp Identity Provider with Cryptshare requires a Cryptshare Enterprise License. If the feature is not enabled on your license yet, please get in contact with your [mailto:customer.success@pointsharp.com?subject=Licensing%20Cryptshare%20feature%20Electronic%20Identity%20%28eID%29&body=Dear%20Cryptshare%20Team%2C%0A%0APlease%20send%20me%20information%20about%20%22Electronic%20Identity%20%28eID%29%22.%0A Cryptshare sales representative] in order to request a new licence file.
Cryptshare officially supports the '''Pointsharp Identity Provider'''.
 
Other Keycloak-based Identity Providers may work but are '''not tested and not officially supported'''.
 
The Identity Provider must provide a '''UserInfo endpoint''', as this is required by the underlying authentication mechanism.


== Configuration ==
== Configuration ==
Identity Provider authentication is configured using a configuration file.
Identity Provider authentication is configured using a configuration file and the Admin Interface.


* File: <code>cryptshare.properties</code>
# The base URL used for redirects is configurable via the Admin Interface -> System Settings -> Connection.
<idProvider.clientId=css
# Contact our support team to setup your Pointsharp Identity Provider.
idProvider.clientSecret=ETHs0jTaopSKuZxYbc7Xf3a
# Get the values from the IdP configuration and set them in the cryptshare.properties file.
idProvider.baseUrl=<nowiki>https://idp.pointsharp.com</nowiki>
idProvider.realm=Dev


Identity Provider authentication is '''enabled''' when the following property is set in <code>cryptshare.properties</code>:
idProvider.clientSecret=<clientSecretFromIdP>
idProvider.baseUrl=<idPUrl>
idProvider.realm=<usedRealm>
idProvider.clientId=<usedClientId>


Once this property is present, Cryptshare will use the configured Identity Provider for authentication to the Admin Interface and the API.
4. Any change to the Identity Provider configuration '''requires a restart of the Cryptshare service'''.


The base URL used for redirects is configurable via the Admin Interface.
Identity Provider authentication is enabled when the properties are set.


Any change to the Identity Provider configuration '''requires a restart of the Cryptshare service'''.
Once this property is present, Cryptshare will use the configured Identity Provider for authentication to the Admin Interface.


== Authentication Behavior ==
== Authentication Behavior ==
When accessing the Admin Interface or the API, the authentication flow behaves as follows:
When accessing the Admin Interface, the authentication flow behaves as follows:


# The user is redirected to the configured Identity Provider.
# The user is redirected to the configured Identity Provider.
# The user authenticates at the Identity Provider.
# The user authenticates at the Identity Provider.
# After successful authentication, the user is redirected back to the Cryptshare Admin Interface.
# After successful authentication, the user is redirected back to the Cryptshare Admin Interface.
[[Datei:Authworkflow.png|mini]]


If the Identity Provider is unavailable or authentication fails, the login attempt fails.
If the Identity Provider is unavailable or authentication fails, the login attempt fails.
Zeile 46: Zeile 43:
=== User Existence ===
=== User Existence ===


* The user '''must exist in the Identity Provider'''.
* The user '''must exist in the Identity Provider.'''
* On first successful login:
* On first successful login:
** A '''local Cryptshare user is created automatically'''.
** A local Cryptshare Adminuser is created automatically.


=== Groups and Roles ===
=== Groups and Roles ===
Zeile 54: Zeile 51:
* Group information is provided by the Identity Provider (e.g. Active Directory groups).
* Group information is provided by the Identity Provider (e.g. Active Directory groups).
* A standard role mapping is provided.
* A standard role mapping is provided.
* Role mapping is configured '''exclusively in the Identity Provider'''.
* Role mapping is configured exclusively in the Identity Provider.


If role mapping is missing or invalid, login is denied.
If role mapping is missing or invalid, login is denied.
== API Authentication ==
When Identity Provider authentication is active:
* API access is authenticated using '''Bearer tokens'''.
* API access without Identity Provider authentication is '''not possible'''.


== Logout Behavior ==
== Logout Behavior ==
Logging out ends the '''local Cryptshare session only'''.
Logging out ends the '''local Cryptshare session only.'''


* No logout request is sent to the Identity Provider.
* No logout request is sent to the Identity Provider.
* Single Logout is not supported.
* Single Logout is not supported.
First setup:
You have to change the adminBaseUrl (Table: Globalsettings → AdminBaseUrl, Ai → Systemsettings)
In cryptshare.properties the following values have to be configured:
<idProvider.clientId=css
idProvider.clientSecret=ETHs0jTaopSKuZxYbc7Xf3a
idProvider.baseUrl=<nowiki>https://idp.pointsharp.com</nowiki>
idProvider.realm=Dev
The Keycloak has to have a mapper configured, so that the the roles show up in the UserInfo endpoint
The user has to have the needed roles configured
A license with IdP active has to be provided with the server

Aktuelle Version vom 19. Dezember 2025, 13:45 Uhr

Pointsharp Identity Provider

Cryptshare supports authentication via the Pointsharp Identity Provider for the Admin Interface.

This feature allows administrators to integrate Cryptshare into an external Identity and Access Management (IAM) environment.

The feature is optional. When enabled, authentication via the local Cryptshare user database is disabled. It is always possible to revert back to local authentication by disabling the Identity Provider configuration.

The Pointsharp Identity Provider integration is available since Cryptshare version 7.5.0.

The usage of the Pointsharp Identity Provider with Cryptshare requires a Cryptshare Enterprise License. If the feature is not enabled on your license yet, please get in contact with your Cryptshare sales representative in order to request a new licence file.

Configuration

Identity Provider authentication is configured using a configuration file and the Admin Interface.

  1. The base URL used for redirects is configurable via the Admin Interface -> System Settings -> Connection.
  2. Contact our support team to setup your Pointsharp Identity Provider.
  3. Get the values from the IdP configuration and set them in the cryptshare.properties file.
idProvider.clientSecret=<clientSecretFromIdP>
idProvider.baseUrl=<idPUrl>
idProvider.realm=<usedRealm>
idProvider.clientId=<usedClientId>

4. Any change to the Identity Provider configuration requires a restart of the Cryptshare service.

Identity Provider authentication is enabled when the properties are set.

Once this property is present, Cryptshare will use the configured Identity Provider for authentication to the Admin Interface.

Authentication Behavior

When accessing the Admin Interface, the authentication flow behaves as follows:

  1. The user is redirected to the configured Identity Provider.
  2. The user authenticates at the Identity Provider.
  3. After successful authentication, the user is redirected back to the Cryptshare Admin Interface.
Authworkflow.png

If the Identity Provider is unavailable or authentication fails, the login attempt fails.

User Handling and Role Mapping

User Existence

  • The user must exist in the Identity Provider.
  • On first successful login:
    • A local Cryptshare Adminuser is created automatically.

Groups and Roles

  • Group information is provided by the Identity Provider (e.g. Active Directory groups).
  • A standard role mapping is provided.
  • Role mapping is configured exclusively in the Identity Provider.

If role mapping is missing or invalid, login is denied.

Logout Behavior

Logging out ends the local Cryptshare session only.

  • No logout request is sent to the Identity Provider.
  • Single Logout is not supported.
Abgerufen von „https://documentation.cryptshare.com/w/index.php?title=CSSCurrent_en:Pointsharp_Identity_Provider_Configuration&oldid=52579“