com.android.apksig

Class SigningCertificateLineage.SignerCapabilities.Builder

java.lang.Object

com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder

Enclosing class:

SigningCertificateLineage.SignerCapabilities

public static class SigningCertificateLineage.SignerCapabilities.Builder
extends java.lang.Object

Builder of SigningCertificateLineage.SignerCapabilities instances.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a new Builder.
Builder(int flags) Constructs a new Builder with the initial capabilities set to the provided flags.

Method Summary

Modifier and Type	Method and Description
SigningCertificateLineage.SignerCapabilities	build() Returns a new SignerConfig instance configured based on the configuration of this builder.
SigningCertificateLineage.SignerCapabilities.Builder	setAuth(boolean enabled) Set the PAST_CERT_AUTH flag in this capabilities object.
SigningCertificateLineage.SignerCapabilities.Builder	setCallerConfiguredCapabilities(SigningCertificateLineage.SignerCapabilities capabilities) Applies the capabilities that were explicitly set in the provided capabilities object to this builder.
SigningCertificateLineage.SignerCapabilities.Builder	setInstalledData(boolean enabled) Set the PAST_CERT_INSTALLED_DATA flag in this capabilities object.
SigningCertificateLineage.SignerCapabilities.Builder	setPermission(boolean enabled) Set the PAST_CERT_PERMISSION flag in this capabilities object.
SigningCertificateLineage.SignerCapabilities.Builder	setRollback(boolean enabled) Set the PAST_CERT_ROLLBACK flag in this capabilities object.
SigningCertificateLineage.SignerCapabilities.Builder	setSharedUid(boolean enabled) Set the PAST_CERT_SHARED_USER_ID flag in this capabilities object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructs a new Builder.

Builder

public Builder(int flags)

Constructs a new Builder with the initial capabilities set to the provided flags.

Method Detail

setInstalledData

public SigningCertificateLineage.SignerCapabilities.Builder setInstalledData(boolean enabled)

Set the PAST_CERT_INSTALLED_DATA flag in this capabilities object. This flag is used by the platform to determine if installed data associated with previous signing certificate should be trusted. In particular, this capability is required to perform signing certificate rotation during an upgrade on-device. Without it, the platform will not permit the app data from the old signing certificate to propagate to the new version. Typically, this flag should be set to enable signing certificate rotation, and may be unset later when the app developer is satisfied that their install base is as migrated as it will be.

setSharedUid

public SigningCertificateLineage.SignerCapabilities.Builder setSharedUid(boolean enabled)

Set the PAST_CERT_SHARED_USER_ID flag in this capabilities object. This flag is used by the platform to determine if this app is willing to be sharedUid with other apps which are still signed with the associated signing certificate. This is useful in situations where sharedUserId apps would like to change their signing certificate, but can't guarantee the order of updates to those apps.

setPermission

public SigningCertificateLineage.SignerCapabilities.Builder setPermission(boolean enabled)

Set the PAST_CERT_PERMISSION flag in this capabilities object. This flag is used by the platform to determine if this app is willing to grant SIGNATURE permissions to apps signed with the associated signing certificate. Without this capability, an application signed with the older certificate will not be granted the SIGNATURE permissions defined by this app. In addition, if multiple apps define the same SIGNATURE permission, the second one the platform sees will not be installable if this capability is not set and the signing certificates differ.

setRollback

public SigningCertificateLineage.SignerCapabilities.Builder setRollback(boolean enabled)

Set the PAST_CERT_ROLLBACK flag in this capabilities object. This flag is used by the platform to determine if this app is willing to upgrade to a new version that is signed by one of its past signing certificates. WARNING: this effectively removes any benefit of signing certificate changes, since a compromised key could retake control of an app even after change, and should only be used if there is a problem encountered when trying to ditch an older cert

setAuth

public SigningCertificateLineage.SignerCapabilities.Builder setAuth(boolean enabled)

Set the PAST_CERT_AUTH flag in this capabilities object. This flag is used by the platform to determine whether or not privileged access based on authenticator module signing certificates should be granted.

setCallerConfiguredCapabilities

public SigningCertificateLineage.SignerCapabilities.Builder setCallerConfiguredCapabilities(SigningCertificateLineage.SignerCapabilities capabilities)

Applies the capabilities that were explicitly set in the provided capabilities object to this builder. Any values that were not set will not be applied to this builder to prevent unintentinoally setting a capability back to a default value.

build

public SigningCertificateLineage.SignerCapabilities build()

Returns a new SignerConfig instance configured based on the configuration of this builder.