TestAppAuthenticatorBuilder

class TestAppAuthenticatorBuilder

Builder class that can be used to facilitate the creation of a new AppAuthenticator which can be configured to meet the requirements of the test. Similar to the AppAuthenticator, the static factory methods for this class require either an XML resource or InputStream containing the app-authenticator configuration allowing verification of your declared config as part of the test.

There are several options to configure the behavior of the resulting AppAuthenticator.

• setTestPolicy - This sets a generic test policy. POLICY_SIGNATURE_ACCEPTED_FOR_DECLARED_PACKAGES will cause the AppAuthenticator to always return that a queried package has the expected signing identity as long as it is explicitly declared in your configuration; that is, the package must be declared in a package element within either an expected-identity or permission element. POLICY_DENY_ALL will cause the AppAuthenticator to always return that a queried package does not have the expected signing identity regardless of its declaration. These two policies can be used to verify good path and error path for scenarios where the package names can be explicitly declared in the XML configuration.

  POLICY_SIGNATURE_ACCEPTED_FOR_DECLARED_PACKAGES is the default policy when no other options are configured. When any of the other set methods (except for setUidForPackage) are invoked they will set the policy to POLICY_CUSTOM.

• setSignatureAcceptedForPackage - This configures the AppAuthenticator to always return that the specified package has the expected signing identity. Note this still requires the app-authenticator have a path to verify the provided package; that is, the package must either be explicitly declared in a package element or fall under a all-packages element for the query being performed. This is to ensure that a package being verified during the test could also be successfully verified in production for the given query.
• setSigningIdentityForPackage - This sets an explicit signing identity for the provided package; the signing identity should be specified as the SHA-256 digest of the DER encoding of the signing certificate, similar to how digests are specified in the app-authenticator configuration file. While this can be used to set a signing identity to the expected value, this is more often used to set the signing identity to a value that should not be accepted. For instance, a test suite could have a test that verifies a key that is no longer trusted is never added back to the configuration file.
• setPackageNotInstalled - This configures the AppAuthenticator to treat the specified package as not installed on the device. Since a package that is not installed can result in a different return code from the AppAuthenticator methods this configuration can be used to verify an app's behavior when an expected app is not installed on the device.
• setUidForPackage - The AppAuthenticator will always verify the UID of the calling package matches the specified UID (or getCallingUid if a UID is not specified). By default this test AppAuthenticator will use the result of Binder#getCallingUid() as the UID of all queried packages. This method can be used to verify the expected behavior when a calling package's UID does not match the expected UID.

Summary

const val POLICY_CUSTOM = 3: Int

const val POLICY_DENY_ALL = 2: Int

const val POLICY_SIGNATURE_ACCEPTED_FOR_DECLARED_PACKAGES = 1: Int

fun build(): AppAuthenticator

java-static fun createFromInputStream(context: Context, xmlInputStream: InputStream): TestAppAuthenticatorBuilder

java-static fun createFromResource(context: Context, xmlResource: @XmlRes Int): TestAppAuthenticatorBuilder

fun setPackageNotInstalled(packageName: String): TestAppAuthenticatorBuilder

fun setSignatureAcceptedForPackage(packageName: String): TestAppAuthenticatorBuilder

fun setSigningIdentityForPackage(packageName: String, certDigest: String): TestAppAuthenticatorBuilder

fun setTestPolicy(testPolicy: Int): TestAppAuthenticatorBuilder

fun setUidForPackage(packageName: String, uid: Int): TestAppAuthenticatorBuilder