CalyxOS 3.x (Android 12) with Magisk

Calyx3-Magisk.md

CalyxOS 3.x (Android 12) with Magisk with working signed images and AVB Verity

This idea was inspired by this post topjohnwu/Magisk#509 (comment)

I got this working with CalyxOS 3.3.1 (Android 12) with full AVB Verity enabled and was able to lock the bootloader after flashing and still have su. The OTA update zip generated was also tested against the Calyx 2.11.0 version (with Magisk) and it works well.

Create a working build

First, make sure you can build and sign a proper CalyxOS for your device. This is probably the hardest part.

Prepare Magisk files for rooting

Second, prepare a magisk directory outside your build directory as follows:

mkdir magisk24304
cd magisk24304/
wget https://cdn.jsdelivr.net/gh/topjohnwu/magisk-files@a17271415ec0b3b34fbb5715d92893a1f8c529d0/app-debug.apk
unzip app-debug.apk

Replace the apk URL with whatever version is latest or works best for you. For Android 12, v24+ is a must. The URL for the latest version can be found in the Magisk files repo. https://github.com/topjohnwu/magisk-files

We then need a few helper scripts in the same directory. cat > root-img.sh

#!/bin/bash

SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"

export PATH=$PATH:$SCRIPT_DIR

export BOOTMODE=true
export KEEPVERITY=true

cp $SCRIPT_DIR/lib/x86/libmagiskboot.so $SCRIPT_DIR/assets/magiskboot
cp $SCRIPT_DIR/lib/arm64-v8a/libmagisk64.so $SCRIPT_DIR/assets/magisk64
cp $SCRIPT_DIR/lib/armeabi-v7a/libmagisk32.so $SCRIPT_DIR/assets/magisk32
cp $SCRIPT_DIR/lib/arm64-v8a/libmagiskinit.so $SCRIPT_DIR/assets/magiskinit

. $SCRIPT_DIR/assets/boot_patch.sh $*

chmod 755 root-img.sh

Make sure magiskinit is correct for your target in root-img.sh.

cat > dos2unix

#!/bin/bash
cat $*

chmod 755 dos2unix

cat > getprop

#!/bin/bash
echo $*

chmod 755 getprop

That's all for preparing magisk.

Prepare signing step

Now we need to intercept avbtool to root the boot.img file just before it's hashed/signed.

In the last step of building the OS, the target files are zipped up and moved into a signing directory, along with the signing keys and binaries. In the bin directory, you should find avbtool which will be used during signing. We're going to replace it with a script that detects boot images, roots them and then continues with the real avbtool.

cd bin
mv avbtool avbtool.real

cat > avbtool

#!/bin/bash

# change this to whereever you created the magisk directory:
MAGISK_DIR=/media/work/magisk24304

echo "%%%%%%%%%%" `date` Running avbtool with "$*" >> $MAGISK_DIR/avbtool-invokes.txt

SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
IMG_NAME=`realpath $3`

if [[ $1 == add_hash_footer ]] && [[ $7 == boot ]] ;
then
        echo starting to root $3 >> $MAGISK_DIR/rooting.txt
        $MAGISK_DIR/root-img.sh $IMG_NAME >> $MAGISK_DIR/rooting.txt 2>&1
        cp $MAGISK_DIR/assets/new-boot.img $IMG_NAME
fi

$SCRIPT_DIR/avbtool.real $*

chmod 755 avbtool

We'll do something similar for toybox to avoid an error in the build.

mv toybox toybox.real

cat > toybox

#!/bin/bash

SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
echo "%%%%%%%%%%" `date` Running toybox with "$*" >> $SCRIPT_DIR/toybox-invokes.txt

if [[ $1 == cpio ]] && [[ $2 == -F ]] ;
then
        echo ignoring toybox error >> $SCRIPT_DIR/toybox-invokes.txt
        $SCRIPT_DIR/toybox.real $* >> $SCRIPT_DIR/toybox-invokes.txt 2>&1
        exit 0
fi

$SCRIPT_DIR/toybox.real $*

chmod 755 toybox

Now, sign the target files again. If all goes well, that should create a rooted boot.img with the correct signatures. You can check the avbtool-invokes.txt and rooting.txt files to see if everything went well. You can apply the factory image (which will wipe the phone), or the OTA update (no wipe) if you have a previous OS with the same keys.

@mohrezaei Alright, I was able to get Magisk 26.3 working with my Pixel 8 Pro on Android 14.

However, unrelated to including Magisk into a ROM like this, Magisk 26 is fairly broken right now. TL;DR is do not enable Zygisk or you will have a bad time. More details about that below.

There were two main problems that I originally had issues with when trying to include Magisk 26:

• The avbtool wrapper script in the OP needs to be changed. The boot partition is no longer guaranteed to be the 7th argument, and the boot image path is no longer guaranteed to be the 3rd argument. Both need to be searched for programmatically.
• On certain devices, the ramdisk is no longer loaded from the boot partition. Newer devices use init_boot. In my case, I was patching boot.img which is why Magisk wasn't working, since my Pixel 8 Pro uses init_boot.img for the ramdisk.

I haven't tested the below script, as I use a custom build system which isn't quite compatible with OP's script, however I suggest the following changes to the OP's avbtool wrapper script. Hopefully these changes and comments help point people in the right direction. Let me know if I made any mistakes:

#!/bin/bash

# Specify the correct target partition for your device
# Devices launched with Android 13 and up need "init_boot" here
# If you have an older device, use "boot" instead
TARGET_PARTITION=init_boot

# Specify the correct PREINITDEVICE
# This must match the actual preinitdevice your device uses
# Pixel 6 Pro and Pixel 8 Pro use `metadata`
# To find this value, extract the following file from the latest Magisk APK
# lib/<architecture>/libmagisk*.so
# It might be called libmagisk32 or libmagisk64 depending on your device
# adb push this file to /data/local/tmp/, and rename it to `magisk`
# Full path should be `/data/local/tmp/magisk`
# Finally use adb shell to run /data/local/tmp/magisk --preinit-device
export PREINITDEVICE=metadata

# change this to whereever you created the magisk directory:
MAGISK_DIR=/media/work/magisk

echo "%%%%%%%%%%" `date` Running avbtool with "$*" >> $MAGISK_DIR/avbtool-invokes.txt

SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"

# Determine the partition name
prev=""
for arg in "$@"; do
	if [[ $prev == "--partition_name" ]]; then
		PARTITION_NAME="$arg"
		break
	fi
	prev="$arg"
done

if [[ $1 == add_hash_footer ]] && [[ $PARTITION_NAME == ${TARGET_PARTITION:?} ]] ;
then
     	# Find the boot image path
	prev=""
	for arg in "$@"; do
		if [[ $prev == "--image" ]]; then
			BOOT_IMG_PATH="$arg"
			break
		fi
		prev="$arg"
	done
        echo starting to root $BOOT_IMG_PATH >> $MAGISK_DIR/rooting.txt
        $MAGISK_DIR/root-img.sh $BOOT_IMG_PATH>> $MAGISK_DIR/rooting.txt 2>&1
        cp $MAGISK_DIR/assets/new-boot.img $BOOT_IMG_PATH
fi

$SCRIPT_DIR/avbtool.real $*

---

As of this writing, Magisk 26.3 is the current "stable" version, but if you enable Zygisk, at least on my device with my setup, the device will bootloop. It actually does "boot," but for me it was stuck at "Pixel is starting" infinitely.

This Zygisk bootloop is fixed in the latest Magisk Canary build (which is 0352ea2c (26302) as of this writing). However, it brings with it a different problem - with Zygisk enabled, system navigation will not work, meaning you will be unable to navigate "back," open recents, go home, etc. This includes gestures, those will be broken too.

All of these Zygisk issues seem to be related to some FD sanitization that has had all sorts of back and forth on the Magisk tracker lately. Here is the most recent one:

topjohnwu/Magisk#7448

So in short, Magisk 26 is fine if you don't plan on using Zygisk, but unless you are on Android 14 (and therefore need Magisk 26+ for the Android 14 support), I would stick with Magisk 25 until they get their act together.

@ubergeek77 Thanks for all the info. I'll make a Android 14 specific gist when these issues are all ironed out.

@ubergeek77 Reading through some Magisk issues, I came across this: https://github.com/Dr-TSNG/ZygiskNext
Maybe that helps?

Interesting, that could work. I'd prefer it if Magisk just worked though. I would also be concerned about how I would update if this maintainer decides to stop working on ZygiskNext.

I just found a build for this PR that may fix the issue once and for all:

topjohnwu/Magisk#7464

Artifacts at:

https://github.com/topjohnwu/Magisk/actions/runs/6675654022

I'm compiling a signed image with this included as we speak. I'll report back if it works. If it seems stable, then whenever the next version of Magisk is released, presumably 26.4, then that would be the time to write instructions for including this with Android 14.

Alright. Sadly with this build I still do not have a navigation bar. I guess we will have to wait for a proper fix.

@mohrezaei If you want to get a head start on testing this new process, a recently built commit of Magisk solves the Zygisk issues I described:

https://github.com/topjohnwu/Magisk/actions/runs/6725604108

More discussion:

topjohnwu/Magisk#7448 (comment)

I would expect the next stable release of Magisk to include this fix, and probably a Canary build much sooner.

But as far as I can see, I've got a ROM built with Magisk, Zygisk enabled, and everything is working.

@ubergeek77 thanks. I'll wait a bit longer till this stuff is more stable.

I've been waiting for a new release of canary, which includes the changes ubergeek77 mentioned as required. The release yesterday (26403) might work, so I'm going to try it soon (probably during the holidays). Any earlier release is highly unlikely to work, and you'll need ubergeek's improved script above.

@dvdmle Yes, I have. Have you tried this with the fixes I mentioned were needed for Android 14?

https://gist.github.com/mohrezaei/69dae8c7d43c543b38ee5d33f67400b5?permalink_comment_id=4743126#gistcomment-4743126

Use the latest Canary build, updated just yesterday. It should work:

https://github.com/topjohnwu/magisk-files/blob/canary/app-release.apk

If you did all this, do you have logs or something that might point out what the issue is?

Did you ensure PREINITDEVICE is correct? The correct value is metadata on at least the Pixel 6 Pro and the Pixel 8 Pro, but I have no idea what it's supposed to be for the 5a.

Beyond that, I'm not sure what to suggest, apologies.

@dvdmle Read the comment I put in the script ;)

Just to provide some feedback: I got it working today on a Google Pixel 8 shiba with CalyxOS 5.3.2 and Magisk 26.4 (26400).
I used the newer script version by ubergeek77 which worked flawlessly. I got this popup on the first boot, but after I executed the requested reboot, it never popped up again. Root is working; I did not try Zygisk though.

For anyone using this method: Don't use the updater in the Magisk App. If you have OEM Unlocking disabled, this will brick your phone pretty badly (failing to boot, unable to reflash via fastboot due to locked bootloader, neither recovery, nor fastbootd working anymore). I had to learn the hard way. My advice is to always enable OEM Unlocking while tinkering with the bootloader.