keystore

A keystore() contains the data for a key pair created by the keytool executable that comes with the JDK. This is a required input for an android_binary() rule.

Function Signature

def keystore(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _apple_platforms: dict[str, str] = {},
    contacts: list[str] = [],
    default_host_platform: None | str = None,
    deps: list[str] = [],
    labels: list[str] = [],
    licenses: list[str] = [],
    properties: str,
    store: str,
) -> None

Parameters

• name: (required)

  name of the target

• default_target_platform: (defaults to: None)

  specifies the default target platform, used when no platforms are specified on the command line

• target_compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with a configuration

• compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with a configuration

• exec_compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with an execution platform

• visibility: (defaults to: [])

  a list of visibility patterns restricting what targets can depend on this one

• within_view: (defaults to: ["PUBLIC"])

  a list of visibility patterns restricting what this target can depend on

• metadata: (defaults to: {})

  a key-value map of metadata associated with this target

• tests: (defaults to: [])

  a list of targets that provide tests for this one

• modifiers: (defaults to: [])

  an array of modifiers associated with this target

• properties: (required)

  The path to the .properties file that contains the following values:

  
  # The value that you passed as the argument to -alias
  # when you ran keytool.
  key.alias=my_alias
  
  # The value that you entered in response to
  # the "Enter keystore password:" prompt.
  key.store.password=store_password
  
  # The value that you entered in response to
  # the "Enter key password for <my_alias>" prompt.
  key.alias.password=alias_password

• store: (required)

  The path to the file that contains the key. This is the path that was passed as the -keystore argument when you ran keytool.