apksigner

您可以使用 Android SDK Build Tools 修订版 24.0.3 及更高版本中提供的 apksigner 工具为 APK 签名，并确保 APK 的签名将在该 APK 支持的所有版本 Android 平台上成功通过验证。

本页提供了有关如何使用该工具的简短指南，并可作为查阅该工具支持的不同命令行选项的参考文档。如需有关如何使用 apksigner 工具为 APK 签名的更完整说明，请参阅为应用签名。

注意：如果您在使用 apksigner 为 APK 签名后又对 APK 做了更改，则 APK 的签名将会失效。如果您使用 zipalign 对齐 APK，请在为 APK 签名之前使用它。

用法

为 APK 签名

使用 apksigner 工具为 APK 签名的语法如下： 

apksigner sign --ks keystore.jks |
  --key key.pk8 --cert cert.x509.pem
  [signer_options] app-name.apk

在您使用 apksigner 工具为 APK 签名时，必须提供 signer 的私钥和证书。您可以通过两种方式添加此信息：

  • 使用 --ks 选项指定密钥库文件。
  • 使用 --key 和 --cert 选项分别指定私钥文件和证书文件。私钥文件必须使用 PKCS #8 格式，证书文件必须使用 X.509 格式。

通常情况下，您只会使用一个 signer 为 APK 签名。如果您需要使用多个 signer 为 APK 签名，请使用 --next-signer 选项将要应用于每个 signer 的常规选项集分隔开： 

apksigner sign [signer_1_options] --next-signer [signer_2_options] app-name.apk

验证 APK 签名

在受支持的平台上确认 APK 签名是否成功通过验证的语法如下： 

apksigner verify [options] app-name.apk

轮替签名密钥

轮替签名证书世系或新签名序列的语法如下：

$ apksigner rotate --in /path/to/existing/lineage \
  --out /path/to/new/file \
  --old-signer --ks old-signer-jks \
  --new-signer --ks new-signer-jks

选项

以下列表包含 apksigner 工具支持的每个命令的选项集。

签名命令

apksigner 签名命令具有以下选项。

常规选项

以下选项指定要应用于 signer 的基本设置：

--out <apk-filename>
您将要保存已签名 APK 的位置。如果未明确提供此选项，则 APK 软件包将就地签名，并替换输入的 APK 文件。
--min-sdk-version <integer>
apksigner 用来确认 APK 签名将通过验证的最低 Android 框架 API 级别。该级别值越高，表示该工具在为应用签名时可使用的安全参数越强，但这会限制 APK 只能用于搭载更新版本 Android 的设备。默认情况下，apksigner 会使用应用清单文件中的 minSdkVersion 属性的值。
--max-sdk-version <integer>
apksigner 用来确认 APK 签名将通过验证的最高 Android 框架 API 级别。默认情况下，该工具会使用尽可能高的 API 级别。
--rotation-min-sdk-version <integer>
生成 APK 签名时 APK 的轮替签名密钥应使用的最低 API 级别。该 APK 的原始（未轮替）签名密钥将用于所有先前的平台版本。默认情况下，搭载 Android 13（API 级别 33）或更高版本的设备上支持的轮替签名密钥与 v3.1 签名分块搭配使用。

注意：如果您的应用已在搭载 Android 12L（API 级别 32）或更低版本的设备上由轮替签名密钥签名，您必须使用 --rotation-min-sdk-version 28 通过适用于 Android 9（API 级别 28）的轮替签名密钥继续为您的应用签名。

--v1-signing-enabled <true | false>
确定 apksigner 是否会使用基于 JAR 的传统签名方案为给定的 APK 软件包签名。默认情况下，该工具会使用 --min-sdk-version 和 --max-sdk-version 的值来决定何时采用此签名方案。
--v2-signing-enabled <true | false>
确定 apksigner 是否会使用 APK 签名方案 v2 为给定的 APK 软件包签名。默认情况下，该工具会使用 --min-sdk-version 和 --max-sdk-version 的值来决定何时采用此签名方案。
--v3-signing-enabled <true | false>
确定 apksigner 是否会使用 APK 签名方案 v3 为给定的 APK 软件包签名。默认情况下，该工具会使用 --min-sdk-version 和 --max-sdk-version 的值来决定何时采用此签名方案。
--v4-signing-enabled <true | false | only>

确定 apksigner 是否会使用 APK 签名方案 v4 为给定的 APK 软件包签名。此方案会在单独的文件 (apk-name.apk.idsig) 中生成签名。如果为 true 并且 APK 未签名，则系统会根据 --min-sdk-version 和 --max-sdk-version 的值生成 v2 或 v3 签名。然后，该命令会根据已签名的 APK 的内容生成 .idsig 文件。

使用 only 仅生成 v4 签名，而不会修改 APK 及其在调用前具有的任何签名。如果 APK 没有 v2 或 v3 签名，或者签名使用的密钥不同于为当前调用提供的密钥，则 only 会失败。

默认情况下，该工具会使用 --min-sdk-version 和 --max-sdk-version 的值来决定何时采用此签名方案。

-v、--verbose
使用详细输出模式。

每个 signer 的选项

以下选项用于指定特定 signer 的配置。如果您仅使用一个 signer 为应用签名，就不需要使用这些选项。

--next-signer <signer-options>
用于为每个 signer 指定不同的常规选项。
--v1-signer-name <basename>
相关文件的基名，此类文件构成当前 signer 的 JAR 签名。默认情况下，对于该 signer，apksigner 会使用密钥库的密钥别名或密钥文件的基名。

密钥和证书选项

以下选项用于指定 signer 的私钥和证书：

--ks <filename>
signer 的私钥和证书链包含在给定的基于 Java 的密钥库文件中。如果文件名设为 "NONE"，则包含密钥和证书的密钥库不需要指定文件，某些 PKCS＃11 密钥库就是这种情况。
--ks-key-alias <alias>
表示 signer 在密钥库中的私钥和证书数据的别名的名称。如果与 signer 关联的密钥库包含多个密钥，则必须指定此选项。
--ks-pass <input-format>

包含 signer 私钥和证书的密钥库的密码。您必须提供密码才能打开密钥库。apksigner 工具支持以下格式：

  • pass:<password>- 密码与 apksigner sign 命令的其余部分一起提供（内嵌在其中）。
  • env:<name> - 密码存储在给定的环境变量中。
  • file:<filename> - 密码存储在给定文件中的某一行。
  • stdin - 密码作为标准输入流中的某一行提供。这是 --ks-pass 的默认行为。

注意：如果一个文件中包含多个密码，请分别在不同的行中指定这些密码。apksigner 工具会根据您指定 APK signer 的顺序将密码与 signer 相关联。如果您为 signer 提供了两个密码，apksigner 会将第一个密码视为密钥库密码，将第二个密码视为密钥密码。

--pass-encoding <charset>
在尝试处理包含非 ASCII 字符的密码时，请添加指定的字符编码（例如，ibm437 或 utf-8）。

密钥工具通常使用控制台的默认字符集转换密码，以加密密钥库。默认情况下，apksigner 会尝试使用多种形式的密码进行解密：

  • Unicode 形式
  • 使用 JVM 默认字符集编码的形式
  • 在 Java 8 及更早版本上，使用控制台的默认字符集编码的形式

    • 在 Java 9 上，apksigner 无法检测控制台的字符集。当使用非 ASCII 密码时，您可能需要指定 --pass-encoding。对于密钥工具在不同操作系统或不同语言区域中创建的密钥库，您可能也需要指定此选项。

    --key-pass <input-format>

    signer 私钥的密码。如果私钥受密码保护，则需要该密码。apksigner 工具支持以下格式：

    • pass:<password> - 密码与 apksigner sign 命令的其余部分一起提供（内嵌在其中）。
    • env:<name> - 密码存储在给定的环境变量中。
    • file:<filename> - 密码存储在给定文件中的某一行。
    • stdin - 密码作为标准输入流中的某一行提供。这是 --key-pass 的默认行为。
    --ks-type <algorithm>
    与包含 signer 的私钥和证书的密钥库关联的类型或算法。默认情况下，apksigner 会使用在安全属性文件中定义为 keystore.type 常量的类型。
    --ks-provider-name <name>
    请求 signer 的密钥库实现时使用的 JCA 提供程序的名称。默认情况下，apksigner 会使用优先级最高的提供程序。
    --ks-provider-class <class-name>
    请求 signer 的密钥库实现时使用的 JCA 提供程序的完全限定类名。此选项可作为 --ks-provider-name 的替代选项。默认情况下，apksigner 会使用由 --ks-provider-name 选项指定的提供程序。
    --ks-provider-arg <value>
    要作为 JCA 提供程序类的构造函数的参数传入的字符串值；该类本身由 --ks-provider-class 选项定义。默认情况下，apksigner 会使用该类的零参数构造函数。
    --key <filename>
    包含 signer 私钥的文件的名称。该文件必须使用 PKCS #8 DER 格式。如果密钥受密码保护，则除非您使用 --key-pass 选项指定其他类型的输入格式，否则 apksigner 会提示您使用标准输入格式输入密码。
    --cert <filename>
    包含 signer 证书链的文件的名称。此文件必须使用 X.509 PEM 或 DER 格式。

    验证命令

    apksigner 验证命令具有以下选项。

    --print-certs
    显示有关 APK 签名证书的信息。
    --min-sdk-version <integer>
    apksigner 用来确认 APK 签名将通过验证的最低 Android 框架 API 级别。该级别值越高，表示该工具在为应用签名时可使用的安全参数越强，但这会限制 APK 只能用于搭载更新版本 Android 的设备。默认情况下，apksigner 会使用应用清单文件中的 minSdkVersion 属性的值。
    --max-sdk-version <integer>
    apksigner 用来确认 APK 签名将通过验证的最高 Android 框架 API 级别。默认情况下，该工具会使用尽可能高的 API 级别。
    -v、--verbose
    使用详细输出模式。
    -Werr
    将警告视为错误。

    示例

    以下是使用 apksigner 的示例。

    为 APK 签名

    使用 release.jks（密钥库中唯一的密钥）为 APK 签名： 

    $ apksigner sign --ks release.jks app.apk

    使用私钥和证书（存储为不同的文件）为 APK 签名： 

    $ apksigner sign --key release.pk8 --cert release.x509.pem app.apk

    使用两个密钥为 APK 签名： 

    $ apksigner sign --ks first-release-key.jks --next-signer --ks second-release-key.jks app.apk

    使用轮替签名密钥为 APK 签名，且轮替的目标版本为 SDK 版本 28 及更高版本： 

    $ apksigner sign --ks release.jks --next-signer --ks release2.jks \
  --lineage /path/to/signing/history/lineage app.apk \
  --rotation-min-sdk-version 28

    使用轮替签名密钥为 APK 签名，且轮替的目标版本为 SDK 版本 33 及更高版本： 

    $ apksigner sign --ks release.jks --next-signer --ks release2.jks \
  --lineage /path/to/signing/history/lineage app.apk

    验证 APK 签名

    检查 APK 的签名是否可在 APK 支持的所有 Android 平台上被确认为有效： 

    $ apksigner verify app.apk

    检查 APK 的签名是否可在 Android 4.0.3（API 级别 15）及更高版本上被确认为有效： 

    $ apksigner verify --min-sdk-version 15 app.apk

    轮替签名密钥

    启用支持密钥轮替的签名证书沿袭：

    $ apksigner rotate --out /path/to/new/file --old-signer \
    --ks release.jks --new-signer --ks release2.jks

    再次轮替您的签名密钥：

    $ apksigner rotate --in /path/to/existing/lineage \
  --out /path/to/new/file --old-signer --ks release2.jks \
  --new-signer --ks release3.jks