feat: New extraction method (#954)

.github/workflows/check.yml

@@ -20,5 +20,5 @@ jobs:
         uses: hadolint/hadolint-action@v3.1.0
         with:
           dockerfile: Dockerfile
-          ignore: DL3008,DL3003,DL3006
+          ignore: DL3008,DL3003,DL3006,DL3013
           failure-threshold: warning

Dockerfile

@@ -15,19 +15,21 @@ ARG DEBCONF_NOWARNINGS="yes"
 ARG DEBIAN_FRONTEND="noninteractive"
 ARG DEBCONF_NONINTERACTIVE_SEEN="true"
 
-RUN set -eu && extra="" && \
+RUN set -eu && \
-    if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi && \
     apt-get update && \
     apt-get --no-install-recommends -y install \
         jq \
         tini \
         curl \
-        cpio \
         wget \
         fdisk \
         unzip \
         nginx \
         procps \
+        python3 \
+        python3-pip \
+        python3-msgpack \
+        python3-pysodium \
         xz-utils \
         iptables \
         iproute2 \
@@ -40,9 +42,9 @@ RUN set -eu && extra="" && \
         iputils-ping \
         ca-certificates \
         netcat-openbsd \
-        qemu-system-x86 \
+        qemu-system-x86 && \
-        "$extra" && \
     apt-get clean && \
+    pip3 install --no-cache-dir --break-system-packages dissect.cstruct && \
     mkdir -p /etc/qemu && \
     echo "allow br0" > /etc/qemu/bridge.conf && \
     unlink /etc/nginx/sites-enabled/default && \
@@ -54,6 +56,7 @@ COPY --chmod=755 ./src /run/
 COPY --chmod=755 ./web /var/www/
 COPY --chmod=755 --from=builder /qemu-host.bin /run/host.bin
 COPY --chmod=744 ./web/conf/nginx.conf /etc/nginx/sites-enabled/web.conf
+ADD --chmod=775 https://raw.githubusercontent.com/sud0woodo/patology/refs/heads/main/patology.py /run/extract.py
 
 VOLUME /storage
 EXPOSE 22 139 445 5000

readme.md

@@ -58,7 +58,7 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
 ##### Via Github Codespaces:
 
-[`Click here to launch this container in the cloud!`](https://github.com/codespaces/new?skip_quickstart=true&machine=basicLinux32gb&repo=619260050&ref=master&devcontainer_path=.devcontainer.json)
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?repo=619260050&machine=basicLinux32gb)
 
 ## FAQ 💬
 
@@ -123,21 +123,16 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
 ### How do I pass-through a disk?
 
-   It is possible to pass-through a disk device directly, which can be useful when your host is a virtual machine, as it removes an extra layer and allows for easier management. For use with physical disks this method provides little advantage and is not recommended.
+   It is possible to pass-through a disk device directly, which can be useful when your host is a virtual machine, as it removes an extra layer and allows for easier image management on the host.
    
-   You can add the virtual device to your compose file like this:
+   For use with physical disks this method provides little advantage over using an image and is not recommended. You can add the device to your compose file like this:
 
   ```yaml
   devices:
-    - /dev/disk/by-uuid/12345-12345-12345-12345-12345:/disk2
+    - /dev/sdc:/disk1
   ```
 
-  The device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
+  Replace `/dev/sdc` with the name of the disk. It needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
-  
-  Make sure to bind the disk via its UUID (obtainable via `lsblk -o name,uuid`) instead of its name (`/dev/sdc`), to prevent ever binding the wrong disk when the drive letters happen to change. 
- 
-> [!CAUTION]
-> Do NOT use this feature with the goal of sharing files from the host, they might all get lost without warning when DSM creates the volume.
 
 ### How do I change the amount of CPU or RAM?
 
@@ -256,14 +251,14 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
   With this method, it is even possible to switch back and forth between versions while keeping your file data intact.
 
-  If you don't have internet access, it's also possible to skip the download by setting `URL` to:
+  Alternatively, you can also skip the download and use a local file instead, by binding it in your compose file in this way:
-
+  
   ```yaml
-  environment:
+  volumes:
-    URL: "DSM_VirtualDSM_42218.pat"
+    - ./DSM_VirtualDSM_42218.pat:/boot.pat
   ```
 
-  after placing a copy of [DSM_VirtualDSM_42218.pat](https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat) in the root of your `/storage` folder.
+  Replace the example path `./DSM_VirtualDSM_42218.pat` with the filename of your desired `.pat` file. The value of `URL` will be ignored in this case.
 
 ### What are the differences compared to the standard DSM?
 

src/install.sh

@@ -12,18 +12,28 @@ else
   BASE="DSM_VirtualDSM_42962"
 fi
 
+FN="boot.pat"
+if [ -d "/$FN" ]; then
+  error "The file /$FN does not exist, please check that you mapped it to a valid path!" && exit 65
+fi
+
+FILE=$(find / -maxdepth 1 -type f -iname "$FN" | head -n 1)
+[ ! -s "$FILE" ] && FILE=$(find "$STORAGE" -maxdepth 1 -type f -iname "$FN" | head -n 1)
+[ -s "$FILE" ] && BASE="DSM_VirtualDSM" && URL="file://$FILE" 
+
 if [ -n "$URL" ]; then
-  BASE=$(basename "$URL" .pat)
+  if [ ! -s "$FILE" ]; then
-  if [ ! -s "$STORAGE/$BASE.system.img" ]; then
+    BASE=$(basename "$URL" .pat)
-    BASE=$(basename "${URL%%\?*}" .pat)
+    if [ ! -s "$STORAGE/$BASE.system.img" ]; then
-    : "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
+      BASE=$(basename "${URL%%\?*}" .pat)
-    BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
+      : "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
+      BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
+    fi
   fi
-  if [[ "${URL,,}" != "http"* ]]; then
+  if [[ "${URL,,}" != "http"* ]] && [[ "${URL,,}" != "file:"* ]] ; then
-    if [ -s "$STORAGE/$BASE.pat" ]; then
+    URL="file:///$BASE.pat"
-      URL="file://$STORAGE/$BASE.pat"
+    if [ ! -s "/$BASE.pat" ]; then
-    else
+      error "File '$BASE.pat' does not exist!" && exit 65
-      error "File $STORAGE/$BASE.pat does not exist!" && exit 65
     fi
   fi
 fi
@@ -47,11 +57,15 @@ if [ -z "$DL" ]; then
   [[ "${COUNTRY^^}" == "CN" ]] && DL="$DL_CHINA" || DL="$DL_GLOBAL"
 fi
 
-[ -z "$URL" ] && URL="$DL/release/7.2.2/72806/DSM_VirtualDSM_72806.pat"
+if [ -z "$URL" ]; then
+  URL="$DL/release/7.2.2/72806/DSM_VirtualDSM_72806.pat"
+fi
 
-BASE=$(basename "${URL%%\?*}" .pat)
+if [ ! -s "$FILE" ]; then
-: "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
+  BASE=$(basename "${URL%%\?*}" .pat)
-BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
+  : "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
+  BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
+fi
 
 if [[ "$URL" != "file://$STORAGE/$BASE.pat" ]]; then
   rm -f "$STORAGE/$BASE.pat"
@@ -112,128 +126,16 @@ else
   PROGRESS="--progress=dot:giga"
 fi
 
-# Download the required files from the Synology website
+if [[ "$URL" == "file://"* ]]; then
-
+  MSG="Copying DSM"
-ROOT="Y"
+  ERR="Failed to copy ${URL:7}"
-RD="$TMP/rd.gz"
+  info "Install: Copying installation image..."
-RDC="$STORAGE/dsm.rd"
+else
-
+  MSG="Downloading DSM"
-if [ ! -s "$RDC" ] && [[ "$URL" == "file://"* ]] && [[ "${URL,,}" == *"_42218.pat" ]]; then
+  ERR="Failed to download $URL"
-
+  info "Install: Downloading $BASE.pat..."
-  rm -f "$RD"
-  rm -f "$RDC"
-
-  tar --extract --file="${URL:7}" --directory="$(dirname "$RD")"/. "$(basename "$RD")"
-  cp "$RD" "$RDC"
-
 fi
 
-if [ ! -s "$RDC" ]; then
-
-  rm -f "$RD"
-  rm -f "$RDC"
-
-  MSG="Downloading installer"
-  info "Install: $MSG..." && html "$MSG..."
-
-  SIZE=5394188
-  POS="65627648-71021835"
-  VERIFY="b4215a4b213ff5154db0488f92c87864"
-  LOC="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
-  [[ "${URL,,}" == *"_42218.pat" ]] && LOC="$URL"
-
-  /run/progress.sh "$RD" "$SIZE" "$MSG ([P])..." &
-  { curl -r "$POS" -sfk --connect-timeout 10 -S -o "$RD" "$LOC"; rc=$?; } || :
-
-  fKill "progress.sh"
-
-  ERR="Failed to download $LOC"
-  (( rc == 3 )) && error "$ERR , cannot write file (disk full?)" && exit 60
-  (( rc == 4 )) && error "$ERR , network failure!" && exit 60
-  (( rc == 8 )) && error "$ERR , server issued an error response!" && exit 60
-
-  if (( rc != 0 )); then
-    if (( rc != 22 )) && (( rc != 56 )); then
-      error "$ERR , reason: $rc" && exit 60
-    fi
-    SUM="skip"
-  else
-    SUM=$(md5sum "$RD" | cut -f 1 -d " ")
-  fi
-
-  if [ "$SUM" != "$VERIFY" ]; then
-
-    PAT="/install.pat"
-    SIZE=379637760
-
-    rm -f "$RD"
-    rm -f "$PAT"
-
-    html "$MSG..."
-    /run/progress.sh "$PAT" "$SIZE" "$MSG ([P])..." &
-    { wget "$LOC" -O "$PAT" -q --no-check-certificate --timeout=10 --no-http-keep-alive --show-progress "$PROGRESS"; rc=$?; } || :
-
-    fKill "progress.sh"
-
-    ERR="Failed to download $LOC"
-    (( rc == 3 )) && error "$ERR , cannot write file (disk full?)" && exit 60
-    (( rc == 4 )) && error "$ERR , network failure!" && exit 60
-    (( rc == 8 )) && error "$ERR , server issued an error response!" && exit 60
-    (( rc != 0 )) && error "$ERR , reason: $rc" && exit 60
-
-    tar --extract --file="$PAT" --directory="$(dirname "$RD")"/. "$(basename "$RD")"
-    rm "$PAT"
-
-  fi
-
-  cp "$RD" "$RDC"
-
-fi
-
-if [ -f "$RDC" ]; then
-
-  { xz -dc <"$RDC" >"$TMP/rd" 2>/dev/null; rc=$?; } || :
-  (( rc != 1 )) && error "Failed to unxz $RDC on $FS, reason $rc" && exit 91
-
-  { (cd "$TMP" && cpio -idm <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-
-  if (( rc != 0 )); then
-    ROOT="N"
-    { (cd "$TMP" && fakeroot cpio -idmu <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-    (( rc != 0 )) && error "Failed to extract $RDC on $FS, reason $rc" && exit 92
-  fi
-
-  rm -rf /run/extract && mkdir -p /run/extract
-  for file in $TMP/usr/lib/libcurl.so.4 \
-              $TMP/usr/lib/libmbedcrypto.so.5 \
-              $TMP/usr/lib/libmbedtls.so.13 \
-              $TMP/usr/lib/libmbedx509.so.1 \
-              $TMP/usr/lib/libmsgpackc.so.2 \
-              $TMP/usr/lib/libsodium.so \
-              $TMP/usr/lib/libsynocodesign-ng-virtual-junior-wins.so.7 \
-              $TMP/usr/syno/bin/scemd; do
-    cp "$file" /run/extract/
-  done
-
-  if [ "$ARCH" != "amd64" ]; then
-    mkdir -p /lib64/
-    cp "$TMP/usr/lib/libc.so.6" /lib64/
-    cp "$TMP/usr/lib/libpthread.so.0" /lib64/
-    cp "$TMP/usr/lib/ld-linux-x86-64.so.2" /lib64/
-  fi
-
-  mv /run/extract/scemd /run/extract/syno_extract_system_patch
-  chmod +x /run/extract/syno_extract_system_patch
-
-fi
-
-rm -rf "$TMP" && mkdir -p "$TMP"
-
-info "Install: Downloading $BASE.pat..."
-
-MSG="Downloading DSM"
-ERR="Failed to download $URL"
-
 html "$MSG..."
 
 PAT="/$BASE.pat"
@@ -241,6 +143,10 @@ rm -f "$PAT"
 
 if [[ "$URL" == "file://"* ]]; then
 
+  if [ ! -f "${URL:7}" ]; then
+    error "File '${URL:7}' does not exist!" && exit 65
+  fi
+
   cp "${URL:7}" "$PAT"
 
 else
@@ -271,7 +177,7 @@ if ((SIZE<250000000)); then
   error "The specified PAT file is probably an update pack as it's too small." && exit 62
 fi
 
-MSG="Extracting downloaded image..."
+MSG="Extracting installation image..."
 info "Install: $MSG" && html "$MSG"
 
 if { tar tf "$PAT"; } >/dev/null 2>&1; then
@@ -280,22 +186,15 @@ if { tar tf "$PAT"; } >/dev/null 2>&1; then
 
 else
 
-  export LD_LIBRARY_PATH="/run/extract"
+  { (cd "$TMP" && python3 /run/extract.py -i "$PAT" -d 2>/run/extract.log); rc=$?; } || :
 
-  if [ "$ARCH" == "amd64" ]; then
+  if (( rc != 0 )); then
-    { /run/extract/syno_extract_system_patch "$PAT" "$TMP/."; rc=$?; } || :
+    cat /run/extract.log
-  else
+    error "Failed to extract PAT file, reason $rc" && exit 63
-    { qemu-x86_64 /run/extract/syno_extract_system_patch "$PAT" "$TMP/."; rc=$?; } || :
   fi
 
-  export LD_LIBRARY_PATH=""
-
-  (( rc != 0 )) && error "Failed to extract PAT file, reason $rc" && exit 63
-
 fi
 
-rm -rf /run/extract
-
 MSG="Preparing system partition..."
 info "Install: $MSG" && html "$MSG"
 
@@ -382,22 +281,10 @@ OFFSET="1048576"    # 2048 * 512
 NUMBLOCKS="2097152" # (16777216 * 512) / 4096
 MSG="Installing system partition..."
 
-if [[ "$ROOT" != [Nn]* ]]; then
+fakeroot -- bash -c "set -Eeu;\
-
+  tar xpfJ $HDA.txz --absolute-names --skip-old-files -C $MOUNT/;\
-  tar xpfJ "$HDA.txz" --absolute-names --skip-old-files -C "$MOUNT/"
+  printf '%b%s%b' '\E[1;34m❯ \E[1;36m' 'Install: $MSG' '\E[0m\n';\
-
+  mke2fs -q -t ext4 -b 4096 -d $MOUNT/ -L $LABEL -F -E offset=$OFFSET $SYSTEM $NUMBLOCKS"
-  info "Install: $MSG" && html "$MSG"
-
-  mke2fs -q -t ext4 -b 4096 -d "$MOUNT/" -L "$LABEL" -F -E "offset=$OFFSET" "$SYSTEM" "$NUMBLOCKS"
-
-else
-
-  fakeroot -- bash -c "set -Eeu;\
-        tar xpfJ $HDA.txz --absolute-names --skip-old-files -C $MOUNT/;\
-        printf '%b%s%b' '\E[1;34m❯ \E[1;36m' 'Install: $MSG' '\E[0m\n';\
-        mke2fs -q -t ext4 -b 4096 -d $MOUNT/ -L $LABEL -F -E offset=$OFFSET $SYSTEM $NUMBLOCKS"
-
-fi
 
 rm -rf "$MOUNT"
 echo "$BASE" > "$STORAGE/dsm.ver"