Use persistent release signing key and verify APK certificates in CI
Build and Release APK / Build APK (push) Successful in 8m18s

This commit is contained in:
2026-10-18 00:18:22 +02:00
parent 792d548715
commit 77d3ff7e1e
8 changed files with 306 additions and 29 deletions
+113
View File
@@ -0,0 +1,113 @@
import base64
import contextlib
import hashlib
import importlib.util
import io
import os
from pathlib import Path
import stat
import subprocess
import tempfile
import unittest
from unittest.mock import patch
spec = importlib.util.spec_from_file_location('signing', Path(__file__).parents[1] / 'scripts/signing.py')
signing = importlib.util.module_from_spec(spec)
spec.loader.exec_module(signing)
class SigningTest(unittest.TestCase):
@classmethod
def setUpClass(cls):
cls.folder = tempfile.TemporaryDirectory()
cls.root = Path(cls.folder.name)
cls.key = cls.root / 'release.p12'
cls.password = 'temporary-test-password'
cls.env = dict(os.environ, TEST_KEY_PASSWORD=cls.password)
subprocess.run([signing.keytool(), '-genkeypair', '-noprompt', '-storetype', 'PKCS12',
'-keystore', str(cls.key), '-alias', 'release', '-keyalg', 'RSA',
'-keysize', '2048', '-validity', '30', '-dname', 'CN=Signing test',
'-storepass:env', 'TEST_KEY_PASSWORD', '-keypass:env', 'TEST_KEY_PASSWORD'],
env=cls.env, check=True, capture_output=True)
cert = subprocess.check_output([signing.keytool(), '-exportcert', '-keystore', str(cls.key),
'-alias', 'release', '-storepass:env', 'TEST_KEY_PASSWORD'], env=cls.env)
cls.fingerprint = hashlib.sha256(cert).hexdigest()
sdk = Path(os.environ.get('ANDROID_HOME') or os.environ['ANDROID_SDK_ROOT'])
manifest = cls.root / 'AndroidManifest.xml'
manifest.write_text('<manifest xmlns:android="http://schemas.android.com/apk/res/android" '
'package="test.signing" android:versionCode="1" android:versionName="1">'
'<uses-sdk android:minSdkVersion="24" android:targetSdkVersion="33"/>'
'<application android:label="Signing test"/></manifest>')
cls.unsigned = cls.root / 'unsigned.apk'
aapt = str(Path(signing.apksigner()).with_name('aapt'))
platform = next(sdk.glob('platforms/android-34/android.jar'), None) or next(sdk.glob('platforms/*/android.jar'))
subprocess.run([aapt, 'package', '-f', '-M', str(manifest), '-I', str(platform),
'-F', str(cls.unsigned)], check=True, capture_output=True)
cls.signed = cls.root / 'signed.apk'
subprocess.run([signing.apksigner(), 'sign', '--ks', str(cls.key), '--ks-key-alias', 'release',
'--ks-pass', 'env:TEST_KEY_PASSWORD', '--key-pass', 'env:TEST_KEY_PASSWORD',
'--out', str(cls.signed), str(cls.unsigned)], env=cls.env, check=True, capture_output=True)
@classmethod
def tearDownClass(cls):
cls.folder.cleanup()
def setUp(self):
self.work = tempfile.TemporaryDirectory()
self.addCleanup(self.work.cleanup)
root = Path(self.work.name)
self.pin = root / 'certificate.sha256'
self.pin.write_text(self.fingerprint + '\n')
self.store = root / 'private/key.p12'
self.output = root / 'github.env'
self.values = dict(ANDROID_KEYSTORE_BASE64=base64.b64encode(self.key.read_bytes()).decode(),
ANDROID_KEYSTORE_PASSWORD=self.password, ANDROID_KEY_ALIAS='release',
ANDROID_KEY_PASSWORD=self.password, GITHUB_ENV=str(self.output))
self.addCleanup(patch.stopall)
patch.object(signing, 'PIN', self.pin).start()
patch.object(signing, 'KEYSTORE', self.store).start()
patch.dict(os.environ, self.values).start()
def test_restores_expected_key_privately_without_exporting_passwords(self):
with contextlib.redirect_stdout(io.StringIO()):
signing.prepare()
self.assertEqual(self.key.read_bytes(), self.store.read_bytes())
self.assertEqual(0o600, stat.S_IMODE(self.store.stat().st_mode))
self.assertEqual(f'ANDROID_KEYSTORE_PATH={self.store}\n', self.output.read_text())
self.assertNotIn(self.password, self.output.read_text())
def test_missing_secrets_stop_before_creating_key(self):
del os.environ['ANDROID_KEYSTORE_BASE64']
with self.assertRaisesRegex(ValueError, 'Missing signing secrets'):
signing.prepare()
self.assertFalse(self.store.exists())
def test_wrong_certificate_is_rejected_and_private_file_removed(self):
self.pin.write_text('0' * 64)
with self.assertRaisesRegex(ValueError, 'does not match'):
signing.prepare()
self.assertFalse(self.store.exists())
self.assertFalse(self.output.exists())
def test_wrong_password_is_rejected_and_private_file_removed(self):
os.environ['ANDROID_KEYSTORE_PASSWORD'] = 'wrong-password'
with self.assertRaises(subprocess.CalledProcessError):
signing.prepare()
self.assertFalse(self.store.exists())
def test_apk_with_expected_signature_is_accepted(self):
with contextlib.redirect_stdout(io.StringIO()):
signing.verify([str(self.signed)])
def test_apk_with_another_signature_is_rejected(self):
self.pin.write_text('0' * 64)
with self.assertRaisesRegex(ValueError, 'does not match'):
signing.verify([str(self.signed)])
def test_unsigned_apk_is_rejected(self):
with self.assertRaises(subprocess.CalledProcessError):
signing.verify([str(self.unsigned)])
if __name__ == '__main__':
unittest.main()