מנגנון של שקיפות קוד הוא מנגנון אופציונלי לחתימה על קוד ולאימות שלו באפליקציות שפורסמו באמצעות קובץ Android App Bundle. הוא משתמש במפתח חתימה של מנגנון של שקיפות קוד, שנמצא רק אצל מפַתח אפליקציות.
מנגנון של שקיפות קוד לא תלוי בסכימת החתימה שמשמשת לקובץ AAB ול-APK. מפתח שקיפות הקוד נפרד ושונה מהמפתח לחתימת האפליקציה שמאוחסן בתשתית המאובטחת של Google כשמשתמשים בחתימת אפליקציה ב-Play.
איך פועלת שקיפות הקוד
כדי להשתמש בתהליך, צריך לכלול קובץ שקיפות קוד ב-App Bundle אחרי שיוצרים אותו, אבל לפני שמעלים אותו ל-Play Console להפצה.
קובץ שקיפות הקוד הוא אסימון אינטרנט מסוג JSON (JWT) שמכיל רשימה של קובצי DEX וספריות Native שכלולים בחבילה, ואת הגיבובים שלהם. לאחר מכן, הוא נחתם באמצעות מפתח שקיפות הקוד שמוחזק רק על ידי המפתח.

קובץ שקיפות הקוד הזה מופץ ל-APK הבסיסי שנוצר מ-App Bundle (באופן ספציפי, לפיצול הראשי של המודול הבסיסי). אחר כך אפשר לוודא ש:
- לכל קובצי ה-DEX וקובצי קוד Native שקיימים בקובצי ה-APK יש ערכי גיבוב (hash) תואמים בקובץ מנגנון של שקיפות קוד.
- רכיב המפתח הציבורי של מפתח החתימה של מנגנון של שקיפות קוד באפליקציה תואם למפתח הציבורי של המפתח (שחייב לספק אותו בערוץ מאובטח נפרד).
המידע הזה מאמת שהקוד שכלול בקובצי ה-APK תואם למה שהמפתח התכוון, ושהוא לא שונה.
מנגנון של שקיפות קוד לא מאמת משאבים, נכסים, את המניפסט של Android או קבצים אחרים שהם לא קובצי DEX או ספריות Native שנמצאות בתיקייה lib/.
אימות מנגנון של שקיפות קוד משמש רק לבדיקה על ידי מפתחים ומשתמשי קצה שרוצים לוודא שהקוד שהם מריצים תואם לקוד שנבנה במקור ונחתם על ידי מפַתח אפליקציות.
מגבלות ידועות
יש מצבים מסוימים שבהם אי אפשר להשתמש במנגנון של שקיפות קוד:
- אפליקציות שמציינות את המאפיין
sharedUserIdבמניפסט. אפליקציות כאלה עשויות לשתף את התהליך שלהן עם אפליקציות אחרות, ולכן קשה להבטיח שהקוד שהן מריצות בטוח. - אם באפליקציה נעשה שימוש במניעת חדירה לקוד או בכל שירות אחר שמבצע שינויים בקוד אחרי שנוצר קובץ שקיפות הקוד, האימות של שקיפות הקוד ייכשל.
- אפליקציות שמשתמשות ב-Multidex מדור קודם ברמות API נמוכות מ-21 (Android 5.0) ומשתמשות במודולים של תכונות. מנגנון של שקיפות קוד ימשיך לפעול כשהאפליקציה תותקן על ידי Google Play במכשירי Android מגרסה 5.0 ואילך. מנגנון של שקיפות קוד יושבת בגרסאות ישנות יותר של מערכת ההפעלה.
איך מוסיפים מנגנון של שקיפות קוד
לפני שמוסיפים מנגנון של שקיפות קוד לאפליקציה, צריך לוודא שיש לכם זוג מפתחות פרטי ומפתח ציבורי שאתם יכולים להשתמש בו לחתימה על מנגנון של שקיפות קוד. המפתח הזה צריך להיות ייחודי ושונה מהמפתח לחתימת האפליקציה שמשמש לחתימת אפליקציות ב-Play. צריך לשמור אותו בצורה מאובטחת ולא לשתף אותו מחוץ לארגון.
אם אין לכם מפתח, אתם יכולים לפעול לפי ההוראות במדריך חתימה על האפליקציה כדי ליצור מפתח במחשב שלכם. מנגנון של שקיפות קוד משתמש בקובץ מאגר מפתחות רגיל, כך שלמרות שהמדריך מיועד לחתימת אפליקציות, תהליך יצירת המפתחות זהה.
שימוש בפלאגין של Android Gradle
מנגנון של שקיפות קוד דורש את גרסה 7.1.0-alpha03 או גרסה חדשה יותר של הפלאגין של Android Gradle. כדי להגדיר את המפתח שמשמש לחתימה על מנגנון של שקיפות קוד, מוסיפים את הקוד הבא לבלוק bundle.
מגניב
// In your app module's build.gradle file: android { ... bundle { codeTransparency { signing { keyAlias = "ALIAS" keyPassword = "PASSWORD" storeFile = file("path/to/keystore") storePassword = "PASSWORD" } } ... } }
Kotlin
// In your app module's build.gradle.kts file: android { ... bundle { codeTransparency { signing { keyAlias = "ALIAS" keyPassword = "PASSWORD" storeFile = file("path/to/keystore") storePassword = "PASSWORD" } } ... } }
המפתח שבו משתמשים צריך להיות מפתח שמשמש רק למנגנון של שקיפות קוד, ולא המפתח לחתימת אפליקציות שמשמש לחתימת אפליקציה ב-Play.
שימוש ב-bundletool בשורת הפקודה
מנגנון של שקיפות קוד דורש את גרסה 1.7.0 או גרסה חדשה יותר של כלי Bundletool, שאפשר להוריד מ-GitHub.
מריצים את הפקודה הבאה כדי להוסיף מנגנון של שקיפות קוד ל-Android App Bundle. המפתח שבו משתמשים צריך להיות מפתח שמשמש רק למנגנון של שקיפות קוד, ולא המפתח לחתימת אפליקציות שמשמש לחתימת אפליקציה ב-Play.
bundletool add-transparency \
--bundle=/MyApp/my_app.aab \
--output=/MyApp/my_app_with_transparency.aab \
--ks=/MyApp/keystore.jks \
--ks-pass=file:/MyApp/keystore.pwd \
--ks-key-alias=MyKeyAlias \
--key-pass=file:/MyApp/key.pwd
לחלופין, אם אתם רוצים להשתמש בכלים משלכם לחתימה, אתם יכולים להשתמש ב-bundletool כדי ליצור את קובץ שקיפות הקוד ללא חתימה, לחתום עליו בסביבה נפרדת ולהוסיף את החתימה ל-bundle:
# Generate code transparency file
bundletool add-transparency \
--mode=generate_code_transparency_file \
--bundle=/MyApp/my_app.aab \
--output=/MyApp/code_transparency_file.jwt \
--transparency-key-certificate=/MyApp/transparency.cert
# Add code transparency signature to the bundle
bundletool add-transparency \
--mode=inject_signature \
--bundle=/MyApp/my_app.aab \
--output=/MyApp/my_app_with_transparency.aab \
--transparency-key-certificate=/MyApp/transparency.cert \
--transparency-signature=/MyApp/signature
אימות שקיפות הקוד של אפליקציה
יש שיטות שונות לאימות קוד מול מנגנון של שקיפות קוד, בהתאם לשאלה אם קובצי ה-APK מותקנים במכשיר שפועל עם Android או שהורדתם אותם באופן מקומי למחשב.
שימוש בכלי Bundletool כדי לבדוק App Bundle או קבוצת קובצי APK
אתם יכולים להשתמש בכלי Bundletool כדי לאמת את שקיפות הקוד ב-App Bundle או בקבוצת קובצי APK. משתמשים בפקודה check-transparency כדי להדפיס את טביעת האצבע של האישור הציבורי:
# For checking a bundle:
bundletool check-transparency \
--mode=bundle \
--bundle=/MyApp/my_app_with_transparency.aab
No APK present. APK signature was not checked.
Code transparency signature is valid. SHA-256 fingerprint of the code transparency key certificate (must be compared with the developer's public key manually): 01 23 45 67 89 AB CD EF ..
Code transparency verified: code related file contents match the code transparency file.
# For checking a ZIP containing app's APK splits:
bundletool check-transparency \
--mode=apk \
--apk-zip=/MyApp/my_app_with_transparency.zip
APK signature is valid. SHA-256 fingerprint of the apk signing key certificate (must be compared with the developer's public key manually): 02 34 E5 98 CD A7 B2 12 ..
Code transparency signature is valid. SHA-256 fingerprint of the code transparency key certificate (must be compared with the developer's public key manually): 01 23 45 67 89 AB CD EF ..
Code transparency verified: code related file contents match the code transparency file.
אתם יכולים לציין את האישור הציבורי שאתם רוצים לאמת מול החבילה או קובצי ה-APK, כדי שלא תצטרכו להשוות את הגיבובים באופן ידני:
bundletool check-transparency \
--mode=bundle \
--bundle=/MyApp/my_app_with_transparency.aab \
--transparency-key-certificate=/MyApp/transparency.cert
No APK present. APK signature was not checked.
Code transparency signature verified for the provided code transparency key certificate.
Code transparency verified: code related file contents match the code transparency file.
bundletool check-transparency \
--mode=apk \
--apk-zip=/MyApp/my_app_with_transparency.zip \
--apk-signing-key-certificate=/MyApp/apk.cert \
--transparency-key-certificate=/MyApp/transparency.cert
APK signature verified for the provided apk signing key certificate.
Code transparency signature verified for the provided code transparency key certificate.
Code transparency verified: code related file contents match the code transparency file.
שימוש ב-Bundletool כדי לבדוק אפליקציה שמותקנת במכשיר
כדי לבדוק אפליקציה שמותקנת במכשיר עם Android, צריך לוודא שהמכשיר מחובר למחשב באמצעות ADB, ולהריץ את הפקודה הבאה:
bundletool check-transparency \
--mode=connected_device \
--package-name="com.my.app"
APK signature is valid. SHA-256 fingerprint of the apk signing key certificate (must be compared with the developer's public key manually): 02 34 E5 98 CD A7 B2 12 ..
Code transparency signature is valid. SHA-256 fingerprint of the code transparency key certificate (must be compared with the developer's public key manually): 01 23 45 67 89 AB CD EF ..
Code transparency verified: code related file contents match the code transparency file.
בבדיקת השקיפות של המכשיר המחובר אפשר גם לאמת את החתימה מול מפתח ציבורי שאתם מציינים:
bundletool check-transparency \
--mode=connected-device \
--package-name="com.my.app" \
--apk-signing-key-certificate=/MyApp/apk.cert \
--transparency-key-certificate=/MyApp/transparency.cert
APK signature verified for the provided apk signing key certificate.
Code transparency signature verified for the provided code transparency key certificate.
Code transparency verified: code related file contents match the code transparency file.