Merge pull request sleuthkit#3228 from sleuthkit/patch-debian

Enable java on debian GitHub actions .

Author: simsong

.github/workflows/build-unix.yml

@@ -39,25 +39,27 @@ jobs:
             linkage: "shared"
             compiler: "gcc"
             runner: "ubuntu-24.04"
-            configure_opts: "--with-libewf --with-libqcow --with-libvhdi --with-libvmdk --disable-java"
+            configure_opts: "--with-libewf --with-libqcow --with-libvhdi --with-libvmdk --enable-java"
             make_flags: "CFLAGS=-Werror CXXFLAGS=-Werror"
             codecov: "no"
             prefix:
             address_sanitizer: "yes"
             keep_artifacts: "yes"
             suffix: "(with artifacts)"
+            enable_java: "yes"
 
           - os: "linux"
             arch: "x86_64"
             linkage: "shared"
             compiler: "clang"
             runner: "ubuntu-24.04"
-            configure_opts: "--with-libewf --with-libqcow --with-libvhdi --with-libvmdk --disable-java CC=clang CXX=clang++"
+            configure_opts: "--with-libewf --with-libqcow --with-libvhdi --with-libvmdk --enable-java CC=clang CXX=clang++"
             make_flags: "CFLAGS=-Werror CXXFLAGS=-Werror"
             codecov: "no"
             prefix: ""
             address_sanitizer: "yes"
             keep_artifacts: "no"
+            enable_java: "yes"
 
           - os: "mingw"
             arch: "x86_64"

Makefile.am

@@ -739,11 +739,19 @@ endif
 endif
 
 tsk_jar = $(top_builddir)/bindings/java/dist/sleuthkit-$(PACKAGE_VERSION).jar
+tsk_caseuco_jar = $(top_builddir)/case-uco/java/dist/sleuthkit-caseuco-$(PACKAGE_VERSION).jar
 jardir = $(prefix)/share/java
 
-$(tsk_jar): tsk/libtsk.la bindings/java/jni/libtsk_jni.la
+$(tsk_jar): tsk/libtsk.la bindings/java/jni/libtsk_jni.la tsk/.libs/@TSK_LIB@
+	@echo '=== BEGIN manually running make as fallback ==='
+	@$(MAKE) -j1 tsk/.libs/@TSK_LIB@
+	@echo '=== END manually running make as fallback ==='
 	cd bindings/java ; $(ANT) dist $(ant_args)
 
+dnl Since libtool automatically creates libtsk.so or libtsk.dylib, we add this explicit rule:
+tsk/.libs/@TSK_LIB@: tsk/libtsk.la
+	@true
+
 CLEANFILES += $(tsk_jar)
 
 jar_DATA = $(tsk_jar) $(tsk_caseuco_jar)
@@ -758,9 +766,9 @@ bindings_java_jni_libtsk_jni_la_SOURCES = \
 	bindings/java/jni/dataModel_SleuthkitJNI.cpp \
 	bindings/java/jni/dataModel_SleuthkitJNI.h
 
-tsk_caseuco_jar = $(top_builddir)/case-uco/java/dist/sleuthkit-caseuco-$(PACKAGE_VERSION).jar
 
-$(tsk_caseuco_jar):
+$(tsk_caseuco_jar): $(tsk_jar)
+	@$(MAKE) -j1 tsk/.libs/@TSK_LIB@
 	cd case-uco/java ; $(ANT) $(ant_args)
 
 CLEANFILES += $(tsk_caseuco_jar)
@@ -770,10 +778,18 @@ endif # End of X_JNI check
 # Clean targets should be outside of the conditional
 
 clean-tsk_jar:
+if ANT_DETECTED
 	cd bindings/java ; $(ANT) clean
+else
+	echo ANT not detected. bindings/java will not be cleaned
+endif
 
 clean-tsk_caseuco_jar:
+if ANT_DETECTED
 	cd case-uco/java ; $(ANT) clean
+else
+	echo ANT not detected. case-uco/java will not be cleaned
+endif
 
 clean_java = clean-tsk_jar clean-tsk_caseuco_jar
 

bindings/java/jni/auto_db_java.cpp

@@ -450,6 +450,10 @@ TskAutoDbJava::addFsInfo(const TSK_FS_INFO* fs_info, int64_t parObjId,
 * @param dataSourceObjId  Object ID of the data source
 * @returns TSK_ERR on error, TSK_OK on success
 */
+
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wunused-parameter"
+
 TSK_RETVAL_ENUM
 TskAutoDbJava::addFsFile(TSK_FS_FILE* fs_file,
     const TSK_FS_ATTR* fs_attr, const char* path,
@@ -472,6 +476,7 @@ TskAutoDbJava::addFsFile(TSK_FS_FILE* fs_file,
     // Add the file to the database
     return addFile(fs_file, fs_attr, path, fsObjId, parObjId, dataSourceObjId);
 }
+#pragma GCC diagnostic pop
 
 /**
 * Extract the extension from the given file name and store it in the supplied string.
@@ -673,15 +678,15 @@ TskAutoDbJava::addFile(TSK_FS_FILE* fs_file,
 
 	char *sid_str = NULL;
 	jstring sidj = NULL;	// return null across JNI if sid is not available
-	
+
 	if (tsk_fs_file_get_owner_sid(fs_file, &sid_str) == 0) {
 		if (createJString(sid_str, sidj) != TSK_OK) {
 			free(sid_str);
 			return TSK_ERR;
 		}
-		free(sid_str);	
+		free(sid_str);
 	}
-		
+
     // Add the file to the database
     jlong ret_val = m_jniEnv->CallLongMethod(m_javaDbObj, m_addFileMethodID,
         parObjId, fsObjId,
@@ -713,9 +718,9 @@ TskAutoDbJava::addFile(TSK_FS_FILE* fs_file,
         && (!(fs_file->meta->flags & TSK_FS_META_FLAG_COMP))
         && (fs_attr->flags & TSK_FS_ATTR_NONRES)
         && (fs_attr->nrd.allocsize > fs_attr->nrd.initsize)) {
-        strncat(name, "-slack", 6);
+        strcat(name, "-slack");
         if (strlen(extension) > 0) {
-            strncat(extension, "-slack", 6);
+            strcat(extension, "-slack");
         }
         jstring slackNamej;
         if (createJString(name, slackNamej) != TSK_OK) {
@@ -926,6 +931,10 @@ TskAutoDbJava::addUnusedBlockFile(const int64_t parentObjId, const int64_t fsObj
 * @param objId    Object ID of the created virtual dir
 * @param dataSourceObjId  Object ID of the data source
 */
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wunused-parameter"
+
+
 TSK_RETVAL_ENUM
 TskAutoDbJava::addUnallocFsBlockFilesParent(const int64_t fsObjId, int64_t& objId,
     int64_t dataSourceObjId) {
@@ -942,6 +951,8 @@ TskAutoDbJava::addUnallocFsBlockFilesParent(const int64_t fsObjId, int64_t& objI
     }
     return TSK_OK;
 }
+#pragma GCC diagnostic pop
+
 
 /**
 * Adds a new volume that will hold the unallocated blocks for the pool.

bindings/java/jni/auto_db_java.h

@@ -28,6 +28,9 @@ using std::string;
 #include "jni.h"
 
 
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Woverloaded-virtual"
+
 /** \internal
  * C++ class that implements TskAuto to load file metadata into a database.
  * This is used by the TskCaseDb class.
@@ -122,7 +125,7 @@ class TskAutoDbJava :public TskAuto {
     int64_t m_curFsId;      ///< Object ID of file system currently being processed
     int64_t m_curFileId;    ///< Object ID of file currently being processed
     TSK_INUM_T m_curDirAddr;		///< Meta address the directory currently being processed
-    int64_t m_curUnallocDirId;	
+    int64_t m_curUnallocDirId;
     string m_curDirPath;		//< Path of the current directory being processed
     tsk_lock_t m_curDirPathLock; //< protects concurrent access to m_curDirPath
     string m_curImgTZone;
@@ -182,7 +185,7 @@ class TskAutoDbJava :public TskAuto {
         TskAutoDbJava & tskAutoDbJava;
         const TSK_FS_INFO & fsInfo;
         const int64_t fsObjId;
-        vector<TSK_DB_FILE_LAYOUT_RANGE> ranges;																																										
+        vector<TSK_DB_FILE_LAYOUT_RANGE> ranges;
         TSK_DADDR_T curRangeStart;
         int64_t size;
         const int64_t minChunkSize;
@@ -239,4 +242,7 @@ class TskAutoDbJava :public TskAuto {
     TSK_RETVAL_ENUM getVsByFsId(int64_t objId, TSK_DB_VS_INFO & vsDbInfo);
 };
 
+#pragma GCC diagnostic pop
+
+
 #endif

configure.ac

@@ -3,7 +3,7 @@ dnl Process this file with autoconf to produce a configure script.
 
 AC_PREREQ([2.69])
 
-AC_INIT([sleuthkit], [4.13.0])
+AC_INIT([sleuthkit], [4.13.1])
 AC_CONFIG_AUX_DIR([config])
 AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_SRCDIR([tsk/base/tsk_base.h])
@@ -195,6 +195,10 @@ AM_COND_IF([CUSTOM_DEFAULT_JAR_LOCATION],
 )
 
 dnl Test for the various Java things that we need for bindings
+dnl First, test is ant is available since we now use it for the build system
+dnl But don't make it required
+AC_PATH_PROG([ANT], [ant], [no])
+AM_CONDITIONAL([ANT_DETECTED], [test "x$ANT" != "xno"])
 AS_IF([test "x$enable_java" != "xno"], [
     dnl javac is needed to compile the JAR file
     AX_PROG_JAVAC
@@ -214,17 +218,14 @@ AS_IF([test "x$enable_java" != "xno"], [
         dnl we had one report of a system with javac and not java
         AX_PROG_JAVA
 
+        if test "x$ANT" = "xno"; then
+            AC_MSG_ERROR([Apache Ant is required but was not found. Install Ant and try again.])
+        fi
+        AC_SUBST(ANT)
 	]
     )
 ]) dnl test enable_java
 
-dnl Test is ant is available since we now use it for the build system
-dnl BC - TODO - Add this to the enable Java section and uncomment below
-AC_PATH_PROG([ANT], [ant], [no])
-dnl if test "x$ANT" = "xno"; then
-dnl    AC_MSG_ERROR([Apache Ant is required but was not found. Install Ant and try again.])
-dnl fi
-AC_SUBST(ANT)
 
 
 dnl if we found everything we need, set ax_java_support for the
@@ -267,6 +268,29 @@ AC_CONFIG_COMMANDS([tsk/tsk_incs.h],
     ac_cv_header_sys_param_h=$ac_cv_header_sys_param_h
     ax_multithread=$ax_multithread])
 
+dnl ################################################################
+dnl ## Set TSK_LIB as appropriate for the host
+dnl ##
+AC_CANONICAL_HOST
+
+case "$host_os" in
+    darwin*)
+        TSK_LIB="libtsk.dylib"
+        ;;
+    linux*)
+        TSK_LIB="libtsk.so"
+        ;;
+    *)
+        TSK_LIB="libtsk.la"  # Default for unknown platforms
+        ;;
+esac
+AC_SUBST(TSK_LIB)
+dnl ################
+
+
+dnl ################################################################
+dnl ## set per-host libtool flags
+
 AC_MSG_CHECKING([if libtool needs -no-undefined flag to build shared libraries])
 case "$host" in
 *-*-mingw*)

docs/README_debian_package.md

@@ -0,0 +1,13 @@
+This document provides information on building the debing package.
+
+
+
+
+References
+==========
+We found these guides helpful in assembling this document:
+
+* https://askubuntu.com/questions/1345/what-is-the-simplest-debian-packaging-guide
+* https://ubuntuforums.org/showthread.php?t=910717 (2006)
+* (https://www.debian.org/doc/manuals/maint-guide/)[Debian New Maintainer's Guide]
+* (https://www.debian.org/doc/manuals/debian-faq/pkg-basics.en.html)[Chatper 7. Basics of the Debian package management system]

tsk/auto/tsk_auto.h

@@ -61,6 +61,10 @@ typedef enum {
  * internal list. Those can be retrieved with getErrorList().  If you want to deal with errors
  * differently, you must implement handleError().
  */
+
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Woverloaded-virtual"
+
 class TskAuto {
   public:
     unsigned int m_tag;
@@ -113,7 +117,7 @@ class TskAuto {
     std::string getFileSystemPassword() const { return m_fileSystemPassword; }
 
     /**
-     * TskAuto calls this method before it processes the volume system that is found in an 
+     * TskAuto calls this method before it processes the volume system that is found in an
      * image. You can use this to learn about the volume system before it is processed
      * and you can force TskAuto to skip this volume system.
      * @param vs_info volume system details
@@ -317,6 +321,7 @@ class TskAuto {
     void setStopProcessing();
 };
 
+#pragma GCC diagnostic pop
 
 #endif
 

tsk/fs/tsk_xfs.h

@@ -27,7 +27,6 @@ typedef uint64_t XFS_AGNUM_T;
 typedef uint32_t xfs_dir2_data_aoff_t;   /* argument form */
 typedef uint32_t xfs_dir2_dataptr_t;
 
-#define _MSC_VER  // Uncomment for MSVC, comment for GCC/Clang
 #ifdef _MSC_VER
     // For MSVC
     #define __round_mask(x, y) ((x) < (y) ? 0 : ((y) - 1))