diff options
Diffstat (limited to 'infos/ms-proxyservice/readme_1.0.2.md')
| -rw-r--r-- | infos/ms-proxyservice/readme_1.0.2.md | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/infos/ms-proxyservice/readme_1.0.2.md b/infos/ms-proxyservice/readme_1.0.2.md new file mode 100644 index 00000000..2246f5bd --- /dev/null +++ b/infos/ms-proxyservice/readme_1.0.2.md @@ -0,0 +1,74 @@ +# MS-Proxy-Service v1.0.2 Release vom 20.12.2022 + +Das MS-Proxy-Service implementiert eine Bridge zwischen dem österreichischen E-ID System und dem eIDAS Framework um österreichischen Benutzern eine Anmeldung an ausländischen Service-Providern zu ermöglichen. + +### Änderungen in dieser Version + + - JSON basierter Statistiklog mit zusätzlichen Infos hinzugefügt + - Unterstützung für BORIS/eJustice hinzugefügt + - Aktualisierung von Drittherstellerbibliotheken + - EAAF-Components 1.3.10 + - SpringBoot 2.7.5 + - Spring-Framework 5.3.24 + + + +### Durchführen eines Updates + +Nachfolgend finden Sie die erforderlichen Schritte für das Update eines bestehenden MS-Proxy-Service auf die aktuelle Version 1.0.2. Das vollständige Handbuch mit allen Konfigurationsparametern finden Sie im Releasepackage im Verzeichnis: _infos/handbook/_ + +### Ausgehend von einer bestehenden Version 1.0.1 + +1. Stoppen Sie die *MS-Proxy-Service* Applikation und fertigen Sie eine Sicherungskopie Ihrer Applikation inklusive Konfiguration an + +2. Entpacken Sie das Releasepacket *ms_specific_proxyservice-1.0.2-dist.zip* in ein temporäres Verzeichnis welches in weiterer Folge __MsProxyServicePackage__ bezeichnet wird. + +3. Kopieren sie die Applikation __MsProxyServicePackage__/ms_proxyservice.war nach in das Applikationsverzeichnis ihres Applikationsservers + +4. Die Konfiguration besteht aus einer Minimalkonfiguration [`default_config.properties`](./../config/default_config.properties) und eine in das MS-Proxy-Service integrierten Defaultkonfiguration. Die nachfolgende Aufzählung umfasst die neuen oder geänderten Konfigurationsparameter, beschreibt jedoch keine Aufteilung einer bestehenden Konfiguration in Minimal- und Defaultteil. Eine vollständige Beschreibung aller Konfigurationswerte finden Sie im Handbuch zum AT MS-Proxy-Service. + +5. Update bestehender Dateien . Die nachfolgenden Dateien wurden geändert und erfordern eine Anpassung oder eine Übernahme dem Releasepacket, sofern die Anpassung nicht bereits durchgeführt wurde. + + * Vollständige Übernahme: __MsProxyServicePackage__/config/misc/idaAttributeMapping.json + * Vollständige Übernahme: __MsProxyServicePackage__/config/eIDAS/additional-attributes.xml + +6. Neue Konfigurationsparameter für BORIS/eJustice + + - ```eidas.ms.advanced.attributes.ejusticerole.mandate.profiles=eJusticePortalVip1``` + - ```eidas.ms.advanced.attributes.ejusticerole.value.1=eJusticePortalVip1=VIP1``` + +7. Neue optionale Konfigurationsparameter für BORIS/eJustice + - ```eidas.ms.advanced.attributes.ejusticerole.mandate.mode``` + - ```eidas.ms.advanced.attributes.ejusticerole.additional.ida.attributes``` + +8. Optionaler JSON basierter Statisiklog + + - Die in der Beispielkonfiguration beigelegte Logger-Konfiguration __MsProxyServicePackage__/config/logback_config.xml beinhaltet den neuen Log-Appender und die Logger-Konfiguration + +``` +<appender name="statisticJson" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <!--See also http://logback.qos.ch/manual/appenders.html#RollingFileAppender--> + <File>${catalina.base}/logs/eidas-ms-statistic_proxyservice.log</File> + <encoder> + <pattern>%m%n</pattern> + </encoder> + <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> + <maxIndex>9999</maxIndex> + <FileNamePattern>${catalina.base}/logs/eidas-ms-statistic_proxyservice.%i</FileNamePattern> + </rollingPolicy> + <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> + <MaxFileSize>10000KB</MaxFileSize> + </triggeringPolicy> +</appender> +``` + + <logger name="at.asitplus.eidas.specific.proxy.logger.AdvancedStatisicLogger" additivity="false" level="info"> + <appender-ref ref="statisticJson"/> + </logger> + +9. Konfiguration der sektorspezifischen BORIS/eJustice Attribute am eIDAS Node + + - Die beigelgte Datei __MsProxyServicePackage__/config/eIDAS/additional-attributes.xml definiert sektorspezifische eIDAS Attribute und beinhaltet aktuell zwei Attribute welche vom eJustice Projekt (Boris) benötigt werden. Eine Unterstützung dieser beiden Attribute durch das österreichischen eIDAS Proxy-Service ist vorgesehen. + Um diese Attribute zu unterstützen muss die Attributkonfiguration in die Konfiguration des EIDAS Node übernommen werden. + - Mittels der Konfigurationsdatei _eidas.xml_ des eIDAS Node können alle nicht unterstützten Attribute mittels Konfigurationswert ```<entry key="unsupported.attributes">``` deaktiviert werden. Falls in dieser Liste die sektorspezifischen BORIS Attribute enthalten sind, so müsse aus der Liste entfernt werden. + - Die Konfiguration war erfolgreich wenn die sektorspezifischen Attribute in den SAML2 Metadaten eIDAS ProxyService Node aufscheinen. Siehe z.B. https://eidas-test.bmi.gv.at/EidasNode/ServiceMetadata, https://eidas.bmi.gv.at/EidasNode/ServiceMetadata |