VegaアプリパッケージでのVPTの使用

VPTは、Vegaアプリパッケージを管理するツールです。これを使用して、.vpkgファイル（Vegaの標準パッケージ形式）の作成、検査、管理、検証を行うことができます。 VPTを使用するには、Vegaソフトウェア開発キット（SDK）をインストールします。SDKには、次の2つの主要なコマンドラインツールが含まれています。

VPT - 作成や検証などのパッケージ操作を管理します。
Vega CLI - アプリのビルドやデプロイなど、アプリの開発フロー全体を処理します。

VPTはVega CLIによるアプリのビルド中に使用されますが、VPTを直接実行して、次の操作を行うこともできます。

パッケージの検査
コンテンツの検証
アプリへのカスタム署名の追加

コマンド

VPTが提供するコマンドのカテゴリーは以下のとおりです。すべてのコマンドの一覧とそれぞれの最新のオプションについては、vega exec vpt --helpを参照してください。

パッケージ情報

以下のコマンドは、パッケージの詳細と内容を表示します。

info

ID、タイトル、ビルドの詳細を含むパッケージ情報を表示します。（注：画面の出力に関する日本語表記は説明のために提供しています。実際には英語で表示されます。）

Usage: vega exec vpt info [OPTIONS] <PACKAGE>

Arguments:
<PACKAGE>          Path to the vpkg

Options:
  --json           Output in JSON format
  -h, --help       Print help

例：

vega exec vpt info /path/to/sampleapp.vpkg

// 出力
Sample App    com.amazondeveloper.sampleapp v1.3.4 b53

show-contents

パッケージ内のすべてのファイルの一覧を表示します。

Usage: vega exec vpt show-contents [OPTIONS] <PACKAGE>

Arguments:
  <PACKAGE>     Path to the vpkg

Options:
  -h, --help    Print help

例：

vega exec vpt show-contents /path/to/ampleapp.vpkg

// 出力
Package contents:
assets/ (6 files)
lib/ (2 files)
manifest.toml
meta-info/ (4 files)

パッケージの作成と展開

以下のコマンドは、パッケージの作成と変更を行います。

pack

ソースディレクトリからパッケージを作成します。パッケージ名、バージョン、ビルド番号を指定できます。

Usage: vega exec vpt pack [OPTIONS] <SOURCE_PATHS>...

Arguments:
  <SOURCE_PATHS>...  Source directories

Options:
  -n, --pkg-name <PKG_NAME>          Name of the package
  -d, --dest-path <DEST_PATH>        Destination path
  -b, --build-number <BUILD_NUMBER>  Build number
  -v, --version <VERSION>            Build version
      --validate                     Enforce validation of the manifest
      --no-strict-abi-check          Disable strict ABI check
  -h, --help                         Print help

例：

vega exec vpt pack /path/to/source --pkg-name sampleapp --dest-path /path/to/output --version 1.0.0 --build-number 42

// 出力
Creating package sampleapp...
Validating manifest...
Package created at /path/to/output/sampleapp.vpkg

unpack

出力先のパスにすべてのパッケージファイルを展開します。

Usage: vega exec vpt unpack [OPTIONS] <PACKAGE>

Arguments:
  <PACKAGE>                    Path to the vpkg

Options:
  -d, --dest-path <DEST_PATH>  Destination path
  -h, --help                   Print help

例：

vega exec vpt unpack /path/to/sampleapp.vpkg --dest-path /path/to/output

// 出力
Extracting package contents...
Files extracted to /path/to/output

dump

パッケージからファイルを抽出します。stdoutに出力するか、指定された出力先のパスに保存します。

Usage: vega exec vpt dump [OPTIONS] <PACKAGE> <ENTRY>

Arguments:
  <PACKAGE>                    Path to the vpkg
  <ENTRY>                      Path to the entry inside vpkg

Options:
  -d, --dest-path <DEST_PATH>  Destination path
  -h, --help                   Print help

例：

vega exec vpt dump /path/to/sampleapp.vpkg manifest.toml

// 出力
Extracting manifest.toml from sampleapp.vpkg
Content written to stdout

extract-locales

パッケージから、ローカリゼーションファイルをJSONまたはテキストとして抽出します。

Usage: vega exec vpt extract-locales [OPTIONS] <PACKAGE>

Arguments:
  <PACKAGE>                           Path to the vpkg

Options:
  -f, --format <FORMAT>               Output format [default: json] [possible values: json, text]
  -h, --help                          Print help

例：

vega exec vpt extract-locales --format json /path/to/sampleapp.vpkg

// 出力
Extracting localization files...
Files extracted to current directory:
- en/strings.json
- es/strings.json

パッケージの署名と検証

以下のコマンドは、セキュリティと検証を処理します。

pull

パッケージから、ダイジェストファイルと署名ファイルを抽出します。ダイジェストファイルには、VPKG内にあるすべてのファイルの暗号化チェックサムの一覧が含まれています。署名ファイルには、ダイジェストファイルの真正性を検証する暗号化署名が分離されて含まれています。ダイジェストファイルをJSON形式で抽出するには、--json-digestを使用します。署名ファイルをJSON形式で抽出するには、--json-signatureを使用します。

Usage: vega exec vpt pull [OPTIONS] <--signature|--digest|--json-signature|--json-digest> <PACKAGE> <DEST>

Arguments:
  <PACKAGE>           Path to the vpkg
  <DEST>              Destination path

Options:
  --signature
  --digest
  --json-signature
  --json-digest
  -h, --help          Print help

例：

vega exec vpt pull --signature /path/to/sampleapp.vpkg /path/to/output/digest.sig

// 出力
Extracting signature from sampleapp.vpkg
Signature saved to /path/to/output/digest.sig

push

パッケージに署名ファイルを追加します。パッケージのダイジェストに対応するJSON形式の署名ファイルを挿入するには、--json-signatureを使用します。

Usage: vega exec vpt push [OPTIONS] <--signature <SIGNATURE>|--json-signature <JSON_SIGNATURE>> <PACKAGE>

Arguments:
  <PACKAGE>                           Path to the vpkg

Options:
  --signature <SIGNATURE>             Legacy signature of a digest file path to push
  --json-signature <JSON_SIGNATURE>   Signature of a digest.json file path to push
  -h, --help                          Print help

例：

vega exec vpt push --signature /path/to/input/digest.sig /path/to/sampleapp.vpkg

// 出力
Adding signature to sampleapp.vpkg
Signature successfully added

sign

プライベートキーと証明書を使用してメッセージに署名します。

Usage: vega exec vpt sign [OPTIONS] <MESSAGE> <PRIVKEY> <CERTFILE> <OUTPUTFILE>

Arguments:
  <MESSAGE>      Message to sign
  <PRIVKEY>      Private key used to sign the message
  <CERTFILE>     X.509 certificate that corresponds to the private key
  <OUTPUTFILE>   Output path

Options:
  -r, --resign   Resign a signed message
  -h, --help     Print help

例：

vega exec vpt sign --resign /path/to/input/digest.sig /path/to/developer-private.key /path/to/developer-cert.pem /path/to/output/digest.sig

// 出力
Signing digest.sig with provided key and certificate
Signature created at /path/to/output/digest.sig

verify

指定された証明書を使用してメッセージの署名を検証します。

Usage: vega exec vpt verify [OPTIONS] <MESSAGEFILE> <SIGFILE> <CERTIFICATES>...

Arguments:
  <MESSAGEFILE>      File to verify
  <SIGFILE>          Signature used to verify the message
  <CERTIFICATES>...  List of X.509 certificates to verify against

Options:
  -p, --partial      Perform a partial/non-exhaustive verification using only the provided CAs
  -h, --help         Print help

例：

vega exec vpt verify /path/to/message.txt /path/to/message.sig /path/to/cert.pem

// 出力
Verifying signature...
Signature verification successful

checksum

パッケージのチェックサムを計算します。

Usage: vega exec vpt checksum [OPTIONS] <PACKAGE>

Arguments:
  <PACKAGE>     Path to the vpkg

Options:
  -h, --help    Print help

例：

vega exec vpt checksum /path/to/sampleapp.vpkg

// 出力
Calculating checksum...
SHA256: a1b2c3d4e5f6...

generate-csr

構成ファイルから証明書署名リクエスト（CSR）を作成します。

Usage: vega exec vpt generate-csr [OPTIONS]

Options:
  -k, --key <KEY>        Private key
  -c, --config <CONFIG>  Config file
  -o, --out <OUT>        Output directory
  -v, --verbose          Print the generated CSR path
  -h, --help             Print help

例：

vega exec vpt generate-csr -k /path/to/private.key -c /path/to/config.json -o /path/to/output/dir -v

// 出力
Reading configuration from config.json
Generating CSR using private.key
CSR created at /output/dir/certificate.csr

パッケージの分析

以下のコマンドは、パッケージの構造と内容を検証します。

validate

アプリストアの申請要件の検証チェックを実行します。

パッケージのマニフェストに必要な構成と構文上の正確さを検証します。マニフェストユーザーガイドを参照してください。
アプリのネイティブコードのバンドルライブラリまたは宣言された依存関係がVegaのABI要件を満たしているかどうかを検証します。

Usage: vega exec vpt validate [OPTIONS] <PATH>

Arguments:
  <PATH>        Path to the vpkg, directory, or manifest.toml

Options:
      --no-strict-abi-check          Disable strict ABI check
      --no-color                     Disable colored output
  -h, --help                         Print help

例：

vega exec vpt validate sampleapp.vpkg

// 出力
validating 'sampleapp.vpkg' ...
analyzing manifest.toml ...
found issues in manifest.toml ...
manifest validation found 2 errors
manifest.toml:3:1 info: [package.icon] Icon isn't defined in the manifest.Using system default.
  help: Define an icon to help users recognize your app
manifest.toml:15:6 error: [components.interactive.id] Component ID 'com.company.sample.badcomponentname' doesnt have package ID prefix 'com.amazondeveloper.sampleapp'
  help: Component ID should follow the format: package_id.component_name
manifest.toml:9:1 error: [components.interactive.categories] No interactive component declares 'com.amazon.category.main' category.App can't launch without package-id or package ASIN.
  help: One interactive component should declare 'com.amazon.category.main' category in the manifest

starting ABI validation ...
found issues in ABI validation ...
Missing dt_needed dependencies found:
  - Library 'libsample-app.so.0.1.0' at path '/sampleapp/lib/arm/libsample-app.so.0.1.0' has missing dt_needed dependencies: libsample-deps.so
Missing dlopen dependencies found:
  - Library 'libsample-app.so.0.1.0' at path '/sampleapp/lib/arm/libsample-app.so.0.1.0' has missing dlopen dependencies: libsample-deps.so

パッケージのカスタム署名の作成

パッケージから署名ファイルを抽出します。

vega exec vpt pull --json-signature /path/to/sampleapp.vpkg /path/to/output/digest.json.sig

// 出力
Extracting signature from sampleapp.vpkg
Signature saved to /path/to/output/digest.json.sig

プライベートキーと証明書を使用して署名ファイルを更新します。

vega exec vpt sign --resign /path/to/input/digest.json.sig /path/to/developer-private.key /path/to/developer-cert.pem /path/to/output/digest.json.sig

// 出力
Signing digest.json.sig with provided key and certificate
Signature created at /path/to/output/digest.json.sig

更新された署名ファイルをパッケージに戻します。

vega exec vpt push --json-signature /path/to/output/digest.json.sig /path/to/sampleapp.vpkg

// 出力
Adding signature to sampleapp.vpkg
Signature successfully added

Vega CLIツール

VegaアプリパッケージでのVPTの使用

コマンド

パッケージ情報

info

show-contents

パッケージの作成と展開

pack

unpack

dump

extract-locales

パッケージの署名と検証

pull

push

sign

verify

checksum

generate-csr

パッケージの分析

validate

パッケージのカスタム署名の作成

関連トピック

​コマンド

​パッケージ情報

​info

​show-contents

​パッケージの作成と展開

​pack

​unpack

​dump

​extract-locales

​パッケージの署名と検証

​pull

​push

​sign

​verify

​checksum

​generate-csr

​パッケージの分析

​validate

​パッケージのカスタム署名の作成

​関連トピック

コマンド

パッケージ情報

info

show-contents

パッケージの作成と展開

pack

unpack

dump

extract-locales

パッケージの署名と検証

pull

push

sign

verify

checksum

generate-csr

パッケージの分析

validate

パッケージのカスタム署名の作成

関連トピック