R1.0.3

Author: Gematik-Entwicklung

Gematik_Logo_Flag_With_Background.png

@@ -84,6 +84,18 @@ The PoPP-Client supports TLS connections using [ECC](https://gemspec.gematik.de/
   ```
   openssl s_client -showcerts -connect <Konnektor_IP>:<PORT>
   ```
+  
+  Depending on the Konnektor type, you might add a curves parameter to the command, e.g.:
+
+  ```
+  openssl s_client -showcerts -connect <Konnektor_IP>:<PORT> -curves brainpoolP256r1
+  ```
+
+  or a cipher parameter, e.g.:
+
+  ```
+  openssl s_client -showcerts -connect <Konnektor_IP>:<PORT> -cipher ECDHE-ECDSA-AES128-GCM-SHA256
+  ```
 
 * Import the Konnektor certificate including the whole trust chain into your truststore (e.g., truststore.p12):
 
@@ -103,11 +115,13 @@ Configure your Konnektor address and context:
 connector:
   end-point-url: <ip address and port of event-service endpoint of Konnektor>
   terminal-configuration:
+  log-ws: <if SOAP messages should be logged>
   secure:
     enable: <If TLS should be used>
     hostname-validation: <The Hostname of the Konnektor should be validated>
     keystore: <Keystore with the client certificate>
     keystore-password: <Password of the keystore>
+    trust-all: <If all certificates should be trusted, only for testing purposes>
     truststore: <Truststore with the Konnektor certificate and its trust chain>
     truststore-password: <Password of the truststore>
   context:
@@ -126,11 +140,13 @@ Example:
 connector:
   end-point-url: "http://127.0.0.1"
   terminal-configuration:
+  log-ws: true
   secure:
     enable: false
     hostname-validation: true
     keystore: keystore.p12
     keystore-password: changeit
+    trust-all: false
     truststore: truststore.p12
     truststore-password: changeit
   context:

README.md

@@ -1,18 +1,34 @@
-# Release 1.0.2
+<img align="right" width="250" height="47" src="Gematik_Logo_Flag_With_Background.png" /> <br />     
 
-- initial release
+# Release Notes popp-sample-code
+
+### Known Issues
 
-### Features
+## Release 1.0.3
 
-- Generate PoPP tokens using a standard PC/SC USB terminal or Konnektor and eHealth card terminal.
-- Configuration of Konnektor connection possible
+### fixed
 
-### Fixed 
+- supports both CardService versions 8.1 and 8.2 [Issue 2](https://github.com/gematik/popp-sample-code/issues/2)
+- Filter GetCards by CardType [Issue 3](https://github.com/gematik/popp-sample-code/issues/3)
+- use correct endpoints for CardService requests [Issue 4](https://github.com/gematik/popp-sample-code/issues/4)
+- Context added for StartCardSession requests [Issue 5](https://github.com/gematik/popp-sample-code/issues/5)
+- TLS with Konnektor now works correctly [Issue 6](https://github.com/gematik/popp-sample-code/issues/6)
+- hostname validation can be configured [Issue 7](https://github.com/gematik/popp-sample-code/issues/7)
+- sessionId is now used correctly for StopCardSession [Issue 8](https://github.com/gematik/popp-sample-code/issues/8)
+- unit tests are now compatible with Windows
+- use end entity certificates for hash generation
+- Telematik-ID can be changed in server configuration
+- responses for CardService now use the correct marshaller
 
-- TLS connection to Konnektor with ECC is working
+## Release 1.0.2
 
-### Known Issues
+- initial release
+
+### added
+
+- generate PoPP tokens using a standard PC/SC USB terminal or Konnektor and eHealth card terminal
+- configuration of Konnektor connection possible
+
+### fixed 
 
-- Service endpoints are derived only from EndpointTLS entries, not from unsecured Endpoint entries
-- EventService.xsd references CardService with namespace http://ws.gematik.de/conn/CardService/v8.1 instead of v8.2.
-- The card handle of the first card returned in the GetCards response is used, regardless of card type; this may result in a non-eGK card handle being used for StartCardSession.
+- TLS connection to Konnektor with ECC is working

ReleaseNotes.md

@@ -3,7 +3,7 @@ services:
     build:
       context: ../popp-server
       dockerfile: docker/Dockerfile
-    image: local/popp/popp-server:1.0.2
+    image: local/popp/popp-server:1.0.3
     container_name: popp-server
     ports:
       - "8443:8443"

docker/docker-compose.yml

@@ -0,0 +1,20 @@
+/*
+ * Copyright (Date see Readme), gematik GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * *******
+ *
+ * For additional notes and disclaimer from gematik and in case of changes by gematik find details in the "Readme" file.
+ */
+

license-header.txt

@@ -7,12 +7,12 @@
   <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
-    <version>3.5.3</version>
+    <version>3.5.5</version>
   </parent>
 
   <groupId>de.gematik.refpopp</groupId>
   <artifactId>popp-example-impl-global</artifactId>
-  <version>1.0.2</version>
+  <version>1.0.3</version>
   <packaging>pom</packaging>
   <name>popp-sample-code</name>
   <description>PoPP - example implementation</description>
@@ -88,9 +88,9 @@
     <version.maven>3.8.6</version.maven>
     <version.maven-clean-plugin>3.5.0</version.maven-clean-plugin>
     <version.maven-compiler-plugin>3.14.0</version.maven-compiler-plugin>
-    <version.maven-enforcer-plugin>3.6.0</version.maven-enforcer-plugin>
+    <version.maven-enforcer-plugin>3.6.1</version.maven-enforcer-plugin>
     <version.maven-failsafe-plugin>3.5.3</version.maven-failsafe-plugin>
-    <version.maven-gpg-plugin>3.2.7</version.maven-gpg-plugin>
+    <version.maven-gpg-plugin>3.2.8</version.maven-gpg-plugin>
     <version.maven-javadoc-plugin>3.11.2</version.maven-javadoc-plugin>
     <version.maven-project-info-reports-plugin>3.9.0</version.maven-project-info-reports-plugin>
     <!-- only needed for mvn site to avoid stack traces flooding the console -->
@@ -101,7 +101,7 @@
     <version.maven-surefire-plugin>3.5.3</version.maven-surefire-plugin>
     <version.central-publishing-maven-plugin>0.8.0</version.central-publishing-maven-plugin>
     <version.sonar-maven-plugin>5.1.0.4751</version.sonar-maven-plugin>
-    <version.spotless-maven-plugin>2.44.5</version.spotless-maven-plugin>
+    <version.spotless-maven-plugin>2.46.1</version.spotless-maven-plugin>
     <version.spotless.google-java-format>1.27.0</version.spotless.google-java-format>
     <version.spring-boot-maven-plugin>3.3.2</version.spring-boot-maven-plugin>
   </properties>
@@ -165,7 +165,7 @@
       <dependency>
         <groupId>commons-io</groupId>
         <artifactId>commons-io</artifactId>
-        <version>2.19.0</version>
+        <version>2.20.0</version>
       </dependency>
       <dependency>
         <groupId>org.jacoco</groupId>
@@ -349,6 +349,16 @@
               <style>GOOGLE</style>
               <reflowLongStrings>true</reflowLongStrings>
             </googleJavaFormat>
+
+            # currently excluded to avoid issues with the test
+            <excludes>
+              <exclude>**/ConnectorCommunicationServiceTest.java</exclude>
+            </excludes>
+
+            <licenseHeader>
+              <file>license-header.txt</file>
+              <delimiter>package </delimiter>
+            </licenseHeader>
           </java>
           <groovy>
             <includes>
@@ -365,6 +375,14 @@
             </excludes>
           </markdown>
         </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>apply</goal>
+            </goals>
+            <phase>compile</phase>
+          </execution>
+        </executions>
       </plugin>
     </plugins>
   </build>

pom.xml

@@ -7,20 +7,20 @@
   <parent>
     <groupId>de.gematik.refpopp</groupId>
     <artifactId>popp-example-impl-global</artifactId>
-    <version>1.0.2</version>
+    <version>1.0.3</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
   <artifactId>popp-client</artifactId>
-  <version>1.0.2</version>
+  <version>1.0.3</version>
   <packaging>jar</packaging>
 
   <name>popp-client</name>
 
   <description>Example implementation POPP-Client</description>
 
   <properties>
-    <sonar.coverage.exclusions>**/de/gematik/refpopp/popp_client/configuration/**/*</sonar.coverage.exclusions>
+    <sonar.coverage.exclusions>**/de/gematik/refpopp/popp_client/configuration/**/*, **/*Configuration.java</sonar.coverage.exclusions>
   </properties>
 
   <dependencies>
@@ -357,7 +357,7 @@
         <version>4.0.3</version>
         <executions>
           <execution>
-            <id>general</id>
+            <id>event-service</id>
             <goals>
               <goal>wsimport</goal>
             </goals>
@@ -367,12 +367,33 @@
               </wsdlDirectory>
               <wsdlFiles>
                 <wsdlFile>conn/EventService.wsdl</wsdlFile>
-                <wsdlFile>conn/CardService_v8_2_1.wsdl</wsdlFile>
+                  <wsdlFile>conn/CardService_v8_1_2.wsdl</wsdlFile>
               </wsdlFiles>
               <keep>true</keep>
               <sourceDestDir>${project.build.directory}/generated-sources</sourceDestDir>
             </configuration>
           </execution>
+              <execution>
+                  <id>card-service-v821</id>
+                  <goals>
+                      <goal>wsimport</goal>
+                  </goals>
+                  <configuration>
+                      <wsdlDirectory>
+                          src/main/resources/api-telematik-OPB4
+                      </wsdlDirectory>
+                      <wsdlFiles>
+                          <wsdlFile>conn/CardService_v8_2_1.wsdl</wsdlFile>
+                      </wsdlFiles>
+
+                      <bindingFiles>
+                          <bindingFile>cardservice_v8_2_1.xjb</bindingFile>
+                      </bindingFiles>
+                      <extension>true</extension>
+                      <keep>true</keep>
+                      <sourceDestDir>${project.build.directory}/generated-sources</sourceDestDir>
+                  </configuration>
+              </execution>
           <execution>
             <id>signatureservice74</id>
             <goals>

popp-client/pom.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jaxb:bindings
+        xmlns:jaxb="https://jakarta.ee/xml/ns/jaxb"
+        xmlns:xs="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://jakarta.ee/xml/ns/jaxb https://jakarta.ee/xml/ns/jaxb/bindingschema_3_0.xsd"
+        version="3.0">
+
+    <jaxb:bindings schemaLocation="../main/resources/api-telematik-OPB4/conn/CardService_v8_2_1.xsd" node="/xs:schema">
+        <jaxb:schemaBindings>
+            <jaxb:package name="de.gematik.ws.conn.cardservice.v821"/>
+        </jaxb:schemaBindings>
+    </jaxb:bindings>
+
+</jaxb:bindings>

popp-client/src/jaxws/cardservice_v8_2_1.xjb

@@ -28,6 +28,7 @@
 import de.gematik.poppcommons.api.messages.ScenarioStep;
 import de.gematik.refpopp.popp_client.cardreader.card.events.CardConnectedEvent;
 import de.gematik.refpopp.popp_client.cardreader.card.events.CardRemovedEvent;
+import de.gematik.refpopp.popp_client.cardreader.card.events.PaceInitializationCompleteEvent;
 import java.util.ArrayList;
 import java.util.HexFormat;
 import java.util.List;
@@ -38,6 +39,7 @@
 import javax.smartcardio.ResponseAPDU;
 import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.event.EventListener;
 import org.springframework.stereotype.Service;
 
@@ -51,8 +53,10 @@ public class CardCommunicationService {
   private static final HexFormat HEX_FORMAT = HexFormat.of();
   private CardChannel cardChannel;
   private TrustedChannelScope trustedChannel;
+  private final ApplicationEventPublisher eventPublisher;
 
-  public CardCommunicationService() {
+  public CardCommunicationService(ApplicationEventPublisher eventPublisher) {
+    this.eventPublisher = eventPublisher;
     log.debug("| Entering CardService()");
     log.debug("| Exiting CardService()");
   }
@@ -73,6 +77,8 @@ public void handleCardConnectionEvent(final CardConnectedEvent event) {
     if (isContactless()) {
       log.info("| Detected contactless reader - Initialize PACE");
       initializePACE();
+      eventPublisher.publishEvent(new PaceInitializationCompleteEvent());
+
     } else {
       log.info("| Detected contact-based reader - No PACE necessary");
     }

popp-client/src/main/java/de/gematik/refpopp/popp_client/cardreader/card/CardCommunicationService.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (Date see Readme), gematik GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * *******
+ *
+ * For additional notes and disclaimer from gematik and in case of changes by gematik find details in the "Readme" file.
+ */
+
+package de.gematik.refpopp.popp_client.cardreader.card.events;
+
+import org.springframework.context.ApplicationEvent;
+
+public class PaceInitializationCompleteEvent extends ApplicationEvent {
+
+  public PaceInitializationCompleteEvent() {
+    super(new Object());
+  }
+}