Add callback to ask online validation confirmation

metsma · metsma · commit 769da2b3e4dc · 2023-11-13T11:27:29.000+02:00
IB-7865

Signed-off-by: Raul Metsma &lt;raul@metsma.ee&gt;
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -105,7 +105,7 @@ jobs:
     container: ${{ matrix.container }}
     strategy:
       matrix:
-        container: ['ubuntu:20.04', 'ubuntu:22.04', 'ubuntu:23.04', 'ubuntu:23.10']
+        container: ['ubuntu:20.04', 'ubuntu:22.04', 'ubuntu:23.10']
     env:
       DEBIAN_FRONTEND: noninteractive
       DEBFULLNAME: github-actions
diff --git a/examples/DigiDocCSharp/DigiDocCSharp.csproj b/examples/DigiDocCSharp/DigiDocCSharp.csproj
@@ -2,38 +2,34 @@
 <Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
-    <Platform Condition=" '$(Platform)' == '' ">x86</Platform>
-    <ProductVersion>8.0.30703</ProductVersion>
-    <SchemaVersion>2.0</SchemaVersion>
+    <Platform Condition=" '$(Platform)' == '' ">x64</Platform>
     <ProjectGuid>{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}</ProjectGuid>
     <OutputType>Exe</OutputType>
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>DigiDocCSharp</RootNamespace>
     <AssemblyName>DigiDocCSharp</AssemblyName>
-    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
-    <TargetFrameworkProfile>Client</TargetFrameworkProfile>
+    <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
   </PropertyGroup>
-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
-    <PlatformTarget>x86</PlatformTarget>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|AnyCPU'">
+    <PlatformTarget>AnyCPU</PlatformTarget>
     <DebugSymbols>true</DebugSymbols>
     <DebugType>full</DebugType>
-    <Optimize>false</Optimize>
     <OutputPath>bin\Debug\</OutputPath>
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
-    <WarningLevel>4</WarningLevel>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <Prefer32Bit>false</Prefer32Bit>
   </PropertyGroup>
-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
-    <PlatformTarget>x86</PlatformTarget>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|AnyCPU'">
+    <PlatformTarget>AnyCPU</PlatformTarget>
     <DebugType>pdbonly</DebugType>
     <Optimize>true</Optimize>
     <OutputPath>bin\Release\</OutputPath>
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
-    <WarningLevel>4</WarningLevel>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <Prefer32Bit>false</Prefer32Bit>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(OS)' == 'Windows_NT' ">
     <DefineConstants>_WINDOWS</DefineConstants>
diff --git a/examples/DigiDocCSharp/DigiDocCSharp.sln b/examples/DigiDocCSharp/DigiDocCSharp.sln
@@ -1,20 +1,25 @@
 ﻿
-Microsoft Visual Studio Solution File, Format Version 11.00
-# Visual C# Express 2010
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.7.34009.444
+MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DigiDocCSharp", "DigiDocCSharp.csproj", "{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-		Debug|x86 = Debug|x86
-		Release|x86 = Release|x86
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}.Debug|x86.ActiveCfg = Debug|x86
-		{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}.Debug|x86.Build.0 = Debug|x86
-		{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}.Release|x86.ActiveCfg = Release|x86
-		{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}.Release|x86.Build.0 = Release|x86
+		{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{DDEE2029-EA2A-49D2-80CB-F0E2E396B005}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {7D43E58D-0FD9-4023-A18F-D69EE6A229E1}
+	EndGlobalSection
 EndGlobal
diff --git a/examples/DigiDocCSharp/Program.cs b/examples/DigiDocCSharp/Program.cs
@@ -124,10 +124,10 @@ private static void Sign(string[] args)
                     b.addDataFile(args[i], "application/octet-stream");
                 }
 #if _WINDOWS
-                using (WinSigner signer = new WinSigner())
+                using (var signer = new WinSigner())
                 {
 #else
-                using (PKCS11Signer signer = new PKCS11Signer())
+                using (var signer = new PKCS11Signer())
                 {
                     signer.setPin(args[1]);
 #endif
@@ -184,7 +184,8 @@ private static void Verify(string file)
             try
             {
                 Console.WriteLine("Opening file: " + file);
-                Container b = Container.open(file);
+                var cb = new ContainerOpen();
+                Container b = Container.open(file, cb);
 
                 Console.WriteLine("Files:");
                 foreach (DataFile d in b.dataFiles())
@@ -226,4 +227,9 @@ private static void Version()
                 " libdigidocpp " + digidoc.digidoc.version());
         }
     }
+
+    class ContainerOpen : ContainerOpenCB 
+    {
+        override public bool validateOnline() { return true; }
+    }
 }
diff --git a/examples/java/README.md b/examples/java/README.md
@@ -6,4 +6,4 @@
 
 ## Run
 
-    java -Djava.library.path=/Library/libdigidocpp/lib -jar build/libs/libdigidoc.jar
+    java -Djava.library.path=/some/path/lib -jar build/libs/libdigidoc.jar
diff --git a/examples/java/gradle/wrapper/gradle-wrapper.jar b/examples/java/gradle/wrapper/gradle-wrapper.jar
diff --git a/examples/java/gradle/wrapper/gradle-wrapper.properties b/examples/java/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/examples/java/gradlew b/examples/java/gradlew
@@ -83,10 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,10 +131,13 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
@@ -197,6 +198,10 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
 # Collect all arguments for the java command;
 #   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
 #     shell script including quotes and variable substitutions, so put them in
diff --git a/examples/java/src/main/java/ee/ria/libdigidocpp/libdigidocpp.java b/examples/java/src/main/java/ee/ria/libdigidocpp/libdigidocpp.java
@@ -133,7 +133,8 @@ static void verify(String file) {
         try
         {
             System.out.println("Opening file: " + file);
-            Container b = Container.open(file);
+            ContainerOpen cb = new ContainerOpen();
+            Container b = Container.open(file, cb);
             assert b != null;
 
             System.out.println("Files:");
@@ -200,4 +201,10 @@ static byte[] fromHex(String s) {
         }
         return data;
     }
+
+    static private class ContainerOpen extends ContainerOpenCB
+    {
+        @Override
+        public boolean validateOnline() { return true; }
+    }
 }
diff --git a/examples/python/main.py b/examples/python/main.py
@@ -2,6 +2,13 @@
 import sys
 import os
 
+class ContainerOpenCB(digidoc.ContainerOpenCB):
+
+    def __init__(self):
+        digidoc.ContainerOpenCB.__init__(self)
+
+    def validateOnline(self):
+        return True
 
 class Program:
     digidoc.initialize()
@@ -78,7 +85,8 @@ def sign(self, args):
 
     def verify(self, file):
         print("Opening file: " + file)
-        doc = digidoc.Container.open(file)
+        cb = ContainerOpenCB()
+        doc = digidoc.Container.open(file, cb)
 
         print("Files:")
         for d in doc.dataFiles():
diff --git a/libdigidocpp.dox b/libdigidocpp.dox
@@ -1380,6 +1380,8 @@ Signature Validation Policy
 Default POLv2
 
 http://open-eid.github.io/SiVa/siva/appendix/validation_policy/</td></tr>
+<tr><td>\-\-offline	</td><td>Optional</td><td>
+open container offline (eg. Don't send to SiVa)</td></tr>
 <tr><td>\-\-warnings=
 
 (ignore, warning, error)	</td><td>Optional</td><td>
diff --git a/libdigidocpp.i b/libdigidocpp.i
@@ -19,7 +19,7 @@
 
 // digidocpp.i - SWIG interface for libdigidocpp library
 
-%module digidoc
+%module(directors="1") digidoc
 
 %begin %{
 #ifdef _MSC_VER
@@ -231,6 +231,8 @@ extern "C"
 %newobject digidoc::Container::open;
 %newobject digidoc::Container::create;
 
+%feature("director") digidoc::ContainerOpenCB;
+
 %typemap(javacode) digidoc::Conf %{
   public Conf transfer() {
     swigCMemOwn = false;
@@ -318,16 +320,21 @@ namespace std {
     }
 }
 %extend digidoc::Container {
+    static digidoc::Container* open(const std::string &path, digidoc::ContainerOpenCB *cb)
+    {
+        return digidoc::Container::openPtr(path, cb).release();
+    }
+
     digidoc::Signature* prepareWebSignature(const std::vector<unsigned char> &cert, const std::string &profile = {},
                                    const std::vector<std::string> &roles = {},
                                    const std::string &city = {}, const std::string &state = {},
                                    const std::string &postalCode = {}, const std::string &country = {})
     {
-        class : public digidoc::Signer
+        class final: public digidoc::Signer
         {
         public:
-            digidoc::X509Cert cert() const override { return _cert; }
-            std::vector<unsigned char> sign(const std::string &, const std::vector<unsigned char> &) const override
+            digidoc::X509Cert cert() const final { return _cert; }
+            std::vector<unsigned char> sign(const std::string &, const std::vector<unsigned char> &) const final
             {
                 THROW("Not implemented");
             }
diff --git a/src/ASiC_S.cpp b/src/ASiC_S.cpp
@@ -102,7 +102,7 @@ void ASiC_S::addAdESSignature(istream & /*signature*/)
     THROW("Not implemented.");
 }
 
-unique_ptr<Container> ASiC_S::openInternal(const string &path)
+unique_ptr<Container> ASiC_S::openInternal(const string &path, ContainerOpenCB * /*cb*/)
 {
     if (!isContainerSimpleFormat(path))
         return {};
diff --git a/src/ASiC_S.h b/src/ASiC_S.h
@@ -41,7 +41,7 @@ namespace digidoc
         Signature* sign(Signer* signer) override;
 
         static std::unique_ptr<Container> createInternal(const std::string &path);
-        static std::unique_ptr<Container> openInternal(const std::string &path);
+        static std::unique_ptr<Container> openInternal(const std::string &path, ContainerOpenCB *cb);
 
     private:
         ASiC_S();
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -271,13 +271,11 @@ if(SWIG_FOUND)
         target_include_directories(digidoc_java PRIVATE ${JAVA_INCLUDE_PATH} $<$<BOOL:${JAVA_INCLUDE_PATH2}>:${JAVA_INCLUDE_PATH2}>)
         target_compile_definitions(digidoc_java PRIVATE TARGET_NAME="$<TARGET_NAME:digidoc_java>")
         target_link_libraries(digidoc_java digidocpp digidocpp_util digidocpp_ver)
-        set_property(TARGET digidoc_java PROPERTY SWIG_COMPILE_DEFINITIONS $<$<PLATFORM_ID:Windows>:SWIGWIN>)
-        if(APPLE)
-            set_target_properties(digidoc_java PROPERTIES MACOSX_RPATH YES INSTALL_RPATH /Library/Frameworks)
-            install(TARGETS digidoc_java DESTINATION /Library/Java/Extensions)
-        else()
-            install(TARGETS digidoc_java DESTINATION ${CMAKE_INSTALL_LIBDIR})
-        endif()
+        set_target_properties(digidoc_java PROPERTIES
+            INSTALL_RPATH $<$<PLATFORM_ID:Darwin>:/Library/Frameworks>
+            SWIG_COMPILE_DEFINITIONS $<$<PLATFORM_ID:Windows>:SWIGWIN>
+        )
+        install(TARGETS digidoc_java DESTINATION $<IF:$<PLATFORM_ID:Darwin>,/Library/Java/Extensions,${CMAKE_INSTALL_LIBDIR}>)
         install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/java/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/ee/ria/libdigidocpp FILES_MATCHING PATTERN "*.java")
         if(WIN32)
             install(FILES $<TARGET_PDB_FILE:digidoc_java> DESTINATION ${CMAKE_INSTALL_BINDIR} OPTIONAL)
@@ -289,7 +287,6 @@ if(SWIG_FOUND)
         swig_add_library(digidoc_python LANGUAGE python SOURCES ../libdigidocpp.i)
         target_compile_definitions(digidoc_python PRIVATE TARGET_NAME="$<TARGET_NAME:digidoc_python>")
         target_link_libraries(digidoc_python digidocpp digidocpp_util digidocpp_ver Python3::Module)
-        set_property(TARGET digidoc_python PROPERTY SWIG_COMPILE_DEFINITIONS $<$<PLATFORM_ID:Windows>:SWIGWIN>)
         #configure_file(setup.py.cmake setup.py)
         #install(CODE "execute_process(COMMAND python3 ${CMAKE_CURRENT_BINARY_DIR}/setup.py install)")
         if(NOT Python3_SITELIB)
@@ -303,6 +300,10 @@ if(SWIG_FOUND)
         else()
             set_target_properties(digidoc_python PROPERTIES SUFFIX .so)
         endif()
+        set_target_properties(digidoc_python PROPERTIES
+            INSTALL_RPATH $<$<PLATFORM_ID:Darwin>:/Library/Frameworks>
+            SWIG_COMPILE_DEFINITIONS $<$<PLATFORM_ID:Windows>:SWIGWIN>
+        )
         install(TARGETS digidoc_python DESTINATION ${Python3_SITELIB})
         install(FILES ${CMAKE_CURRENT_BINARY_DIR}/digidoc.py DESTINATION ${Python3_SITELIB})
     endif()
diff --git a/src/Container.cpp b/src/Container.cpp
@@ -68,7 +68,8 @@ namespace digidoc
 static string m_appName = "libdigidocpp";
 static string m_userAgent = "libdigidocpp";
 static vector<decltype(&Container::createPtr)> m_createList {};
-static vector<decltype(&Container::openPtr)> m_openList {};
+using OpenCB = std::unique_ptr<Container> (*)(const std::string &path, ContainerOpenCB *cb);
+static vector<OpenCB> m_openList {};
 }
 
 /**
@@ -96,14 +97,7 @@ string digidoc::userAgent() { return m_userAgent; }
  * Returns libdigidocpp library version
  */
 string digidoc::version() {
-    string ver = FILE_VER_STR;
-#if defined(DYNAMIC_LIBDIGIDOC) || defined(LINKED_LIBDIGIDOC)
-    ver += "_ddoc";
-#endif
-#ifdef PDF_SUPPORT
-    ver += "_siva";
-#endif
-    return ver;
+    return FILE_VER_STR;
 }
 
 /**
@@ -348,10 +342,22 @@ Container* Container::open(const string &path)
  * @throws Exception
  */
 unique_ptr<Container> Container::openPtr(const string &path)
+{
+    return openPtr(path, {});
+}
+
+/**
+ * Opens container from a file
+ *
+ * @param path
+ * @param cb Callback called when needed
+ * @throws Exception
+ */
+unique_ptr<Container> Container::openPtr(const string &path, ContainerOpenCB *cb)
 {
     for(auto open: m_openList)
     {
-        if(unique_ptr<Container> container = open(path))
+        if(unique_ptr<Container> container = open(path, cb))
             return container;
     }
     return ASiC_E::openInternal(path);
@@ -417,7 +423,7 @@ unique_ptr<Container> Container::openPtr(const string &path)
  *
  * It must contain static members:
  * * static Container* createInternal(const std::string &path);
- * * static Container* openInternal(const std::string &path);
+ * * static Container* openInternal(const std::string &path, digidoc::ContainerOpenCB *cb);
  *
  * @see Container::create, Container::open
  */
diff --git a/src/Container.h b/src/Container.h
diff --git a/src/SiVaContainer.cpp b/src/SiVaContainer.cpp
diff --git a/src/SiVaContainer.h b/src/SiVaContainer.h
diff --git a/src/digidoc-tool.1.cmake b/src/digidoc-tool.1.cmake
diff --git a/src/digidoc-tool.cpp b/src/digidoc-tool.cpp

Original file line number	Diff line number	Diff line change
`@@ -124,10 +124,10 @@ private static void Sign(string[] args)`
`124`	`124`	`b.addDataFile(args[i], "application/octet-stream");`
`125`	`125`	`}`
`126`	`126`	`#if _WINDOWS`
`127`		`- using (WinSigner signer = new WinSigner())`
	`127`	`+ using (var signer = new WinSigner())`
`128`	`128`	`{`
`129`	`129`	`#else`
`130`		`- using (PKCS11Signer signer = new PKCS11Signer())`
	`130`	`+ using (var signer = new PKCS11Signer())`
`131`	`131`	`{`
`132`	`132`	`signer.setPin(args[1]);`
`133`	`133`	`#endif`
`@@ -184,7 +184,8 @@ private static void Verify(string file)`
`184`	`184`	`try`
`185`	`185`	`{`
`186`	`186`	`Console.WriteLine("Opening file: " + file);`
`187`		`- Container b = Container.open(file);`
	`187`	`+ var cb = new ContainerOpen();`
	`188`	`+ Container b = Container.open(file, cb);`
`188`	`189`
`189`	`190`	`Console.WriteLine("Files:");`
`190`	`191`	`foreach (DataFile d in b.dataFiles())`
`@@ -226,4 +227,9 @@ private static void Version()`
`226`	`227`	`" libdigidocpp " + digidoc.digidoc.version());`
`227`	`228`	`}`
`228`	`229`	`}`
	`230`	`+`
	`231`	`+ class ContainerOpen : ContainerOpenCB`
	`232`	`+ {`
	`233`	`+ override public bool validateOnline() { return true; }`
	`234`	`+ }`
`229`	`235`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,4 @@`
`6`	`6`
`7`	`7`	`## Run`
`8`	`8`
`9`		`- java -Djava.library.path=/Library/libdigidocpp/lib -jar build/libs/libdigidoc.jar`
	`9`	`+ java -Djava.library.path=/some/path/lib -jar build/libs/libdigidoc.jar`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,8 @@ static void verify(String file) {`
`133`	`133`	`try`
`134`	`134`	`{`
`135`	`135`	`System.out.println("Opening file: " + file);`
`136`		`- Container b = Container.open(file);`
	`136`	`+ ContainerOpen cb = new ContainerOpen();`
	`137`	`+ Container b = Container.open(file, cb);`
`137`	`138`	`assert b != null;`
`138`	`139`
`139`	`140`	`System.out.println("Files:");`
`@@ -200,4 +201,10 @@ static byte[] fromHex(String s) {`
`200`	`201`	`}`
`201`	`202`	`return data;`
`202`	`203`	`}`
	`204`	`+`
	`205`	`+ static private class ContainerOpen extends ContainerOpenCB`
	`206`	`+ {`
	`207`	`+ @Override`
	`208`	`+ public boolean validateOnline() { return true; }`
	`209`	`+ }`
`203`	`210`	`}`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ void ASiC_S::addAdESSignature(istream & /signature/)`
`102`	`102`	`THROW("Not implemented.");`
`103`	`103`	`}`
`104`	`104`
`105`		`-unique_ptr<Container> ASiC_S::openInternal(const string &path)`
	`105`	`+unique_ptr<Container> ASiC_S::openInternal(const string &path, ContainerOpenCB * /cb/)`
`106`	`106`	`{`
`107`	`107`	`if (!isContainerSimpleFormat(path))`
`108`	`108`	`return {};`