Implementierung Zugangssteuerung Statistikuser

Warum?

Damit im Rahmen des EPICS #1216 (closed) ein Zugriff auf die Rohdaten möglich ist muss eine entsprechende Zugriffssteuerung eingerichtet werden.

Relevante Links und Bemerkungen

• Diese Story ist Teil des EPICS #1216 (closed)
• Der Scope des DVDV-Users ist https://schema.fitko.de/fit-connect/oauth/scopes/dvdv-fit-connect-api/manage-destinations
• OAuth-Scopes für sendende Systeme
• OAuth-Scopes für empfangende Systeme
• Anzulegende OAuth User (hier DEV): https://git.fitko.de/fit-connect/infrastruktur/-/blob/main/config/envs/dev/auth.json?ref_type=heads#L76
• für den oAuth-Service wird ein post-deploy.sh generiert, der über curl die Berechtigungen beim Service einrichtet. Dieses Skript muss um den neuen Nutzer erweitert werden.

Akzeptanzkriterien

1. Statistik-User ist auf allen Umgebungen eingerichtet
2. Es ist festgelegt über welchen Scope diese User Zugriff auf die CSV-Dateien bekommt - https://schema.fitko.de/fit-connect/oauth/scopes/statistics-fit-connect-api/subscribe-statistics
3. User kann sich mit seinen Credentials den Token abholen (Credentials - ab DEV - an Laura, Wojtek senden)
4. Dem Team Zustelldienst ist der ausgewählte Scope mitgeteilt und wird bei der Implementierung der Endpunkte abgefragt.

Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)

• Scope festlegen und Zustelldienst Bescheid geben
• OAuth Client anlegen (siehe oauth_clients in Env-Config)
• Client-ID und -Secret weitergeben
• post-deploy.sh Generierung anpassen
• Definition of Done wurde geprüft

added workflow::Ready label

added Epic::Nutzungsstatistiken component::ZSD team::INF team::ZSD labels

changed the description

added type::Story label

mentioned in issue #1216 (closed)

marked this issue as related to #1216 (closed)

marked this issue as related to #1348 (closed)

changed title from Implementierung Zugangssteuerung Statisitkuser to Implementierung Zugangssteuerung Statistikuser

assigned to @Maik_Boettner

removed team::ZSD label

Hey @Maik_Boettner wie besprochen mit der Bitte um Einplanung.

changed milestone to %PI-4 (Q-4)

changed milestone to %S-2 (PI-4)

added priority::high label

assigned to @Pascal_Osterwinter and unassigned @Maik_Boettner

changed the description

changed the description

changed the description

changed the description

changed the description

Erfolgreich auf Localhost getestet. Es muss nur beachten das das post deploy script bei lokalem deployment manuell aufgerufen werden muss. Außerdem muss in diesem bei der URL der zugehörige port ergänzt werden.

marked the checklist item User kann sich mit seinen Credentials den Token abholen as completed

marked the checklist item Es ist festgelegt über welchen Scope diese User Zugriff auf die CSV-Dateien bekommt as completed

marked the checklist item Statistik-User ist auf allen Umgebungen eingerichtet as completed

marked the checklist item Statistik-User ist auf allen Umgebungen eingerichtet as incomplete

added workflow::In Progress label and removed workflow::Ready label

changed the description

removed Epic::Nutzungsstatistiken label

added Epic::Nutzungsstatistiken label

marked the checklist item Dem Team Zustelldienst ist der ausgewählte Scope mitgeteilt und wird bei der Implementierung der Endpunkte abgefragt. as completed

added workflow::Blocked label and removed workflow::In Progress label

added workflow::In Progress label and removed workflow::Blocked label

added workflow::Peer Review label and removed workflow::In Progress label

Statisticuser ist auf local, dev und test eingerichtet.

Der Scope für den Nutzer ist: "https://schema.fitko.de/fit-connect/oauth/scopes/submission-api/read:statistics"
Der Name für den Nutzer ist: zustelldienst-statistics-reader
Angelegt wird der Nutzer durch einen zusätzlichen Eintrag in der Auth config im Array "oauth-clients" der jeweiligen Umgebung:

{
    "id_unencrypted": "zustelldienst-statistics-reader",
    "secret": "some_secrect_of_length_40",
    "scope_unencrypted": "https://schema.fitko.de/fit-connect/oauth/scopes/submission-api/read:statistics"
}

added workflow::Blocked label and removed workflow::Peer Review label

Sollen Prod und Refz schon eingerichtet werden?

hat Zeit, wir sind noch nicht mal auf Test

marked the checklist item Scope festlegen und Zustelldienst Bescheid geben as completed

marked the checklist item OAuth Client anlegen (siehe oauth_clients in Env-Config) as completed

marked the checklist item Client-ID und -Secret weitergeben as completed

marked the checklist item post-deploy.sh Generierung anpassen as completed

mentioned in issue #1712 (closed)

In LOCAL, DEV und TEST ist der Nutzer mit read:statistics eingerichtet worden.

• LOCAL: https://git.fitko.de/fit-connect/infrastruktur/-/blob/main/config/envs/local/auth.json#L62
• DEV: https://git.fitko.de/fit-connect/infrastruktur/-/blob/main/config/envs/dev/auth.json#L91
• TEST: https://git.fitko.de/fit-connect/infrastruktur/-/blob/main/config/envs/test/auth.json#L77

Damit eine Migration auf die langen Scopes so smooth wie möglich ist, sollte weiterhin auch noch https://schema.fitko.de/fit-connect/oauth/scopes/read:statistics vergeben werden. Also so:

"scope_unencrypted": "read:statistics https://schema.fitko.de/fit-connect/oauth/scopes/read:statistics"

---

Beim Anlegen des Users in STAGE und PROD kann ich helfen.

added workflow::In Progress label and removed workflow::Blocked label

added env::STAGE label and removed workflow::In Progress label

marked the checklist item Statistik-User ist auf allen Umgebungen eingerichtet as completed

marked the checklist item Definition of Done wurde geprüft as completed

closed

added env::PROD label

removed env::STAGE label