プロジェクトレベルのセキュアファイル API

  • GitLab 14.8 でci_secure_files というフラグで導入されました。デフォルトでは無効になっています。
  • GitLab 15.7で一般的に利用可能に。機能フラグci_secure_files を削除しました。

この機能はGitLab Incubation Engineering が開発したMobile DevOpsの一部です。この機能はまだ開発中ですが、利用することができます：

CI/CDパイプラインで使用するファイルをセキュアなファイルとして最大100個まで安全に保存できます。これらのファイルは、プロジェクトのリポジトリ外にセキュアに保存され、バージョン管理されません。これらのファイルに機密情報を保存しても安全です。セキュアファイルは、プレーンテキストとバイナリの両方のファイルタイプをサポートしますが、5 MB 以下でなければなりません。

プロジェクトのセキュアファイル一覧

プロジェクト内のセキュアファイルの一覧を取得します。

GET /projects/:project_id/secure_files

サポートされる属性：

属性種類必須説明
project_id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/secure_files"

応答例

[
    {
        "id": 1,
        "name": "myfile.jks",
        "checksum": "16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aac",
        "checksum_algorithm": "sha256",
        "created_at": "2022-02-22T22:22:22.222Z",
        "expires_at": null,
        "metadata": null
    },
    {
        "id": 2,
        "name": "myfile.cer",
        "checksum": "16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aa2",
        "checksum_algorithm": "sha256",
        "created_at": "2022-02-22T22:22:22.222Z",
        "expires_at": "2023-09-21T14:55:59.000Z",
        "metadata": {
            "id":"75949910542696343243264405377658443914",
            "issuer": {
                "C":"US",
                "O":"Apple Inc.",
                "CN":"Apple Worldwide Developer Relations Certification Authority",
                "OU":"G3"
            },
            "subject": {
                "C":"US",
                "O":"Organization Name",
                "CN":"Apple Distribution: Organization Name (ABC123XYZ)",
                "OU":"ABC123XYZ",
                "UID":"ABC123XYZ"
            },
            "expires_at":"2023-09-21T14:55:59.000Z"
        }
    }
]

セキュリティで保護されたファイルの詳細を表示

プロジェクト内の特定のセキュアファイルの詳細を取得します。

GET /projects/:project_id/secure_files/:id

サポートされる属性：

属性種類必須説明
project_id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス。
id整数。はいセキュリティファイルのID。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/secure_files/1"

応答例

{
    "id": 1,
    "name": "myfile.jks",
    "checksum": "16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aac",
    "checksum_algorithm": "sha256",
    "created_at": "2022-02-22T22:22:22.222Z",
    "expires_at": null,
    "metadata": null
}

セキュリティファイルの作成

セキュアファイルを新規作成します。

POST /projects/:project_id/secure_files

サポートされる属性：

属性種類必須説明
project_id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス。
name文字列です。はいアップロードされるファイルの名前。ファイル名はプロジェクト内で一意でなければなりません。
fileファイルはいアップロードされるファイル (5 MB 制限)。

リクエストの例

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/1/secure_files"  --form "name=myfile.jks" --form "file=@/path/to/file/myfile.jks"

応答例

{
    "id": 1,
    "name": "myfile.jks",
    "checksum": "16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aac",
    "checksum_algorithm": "sha256",
    "created_at": "2022-02-22T22:22:22.222Z",
    "expires_at": null,
    "metadata": null
}

セキュリティファイルのダウンロード

プロジェクトのセキュアファイルの内容をダウンロードします。

GET /projects/:project_id/secure_files/:id/download

サポートされる属性：

属性種類必須説明
project_id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス。
id整数。はいセキュリティファイルのID。

リクエストの例

curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/secure_files/1/download --output myfile.jks

セキュリティファイルの削除

プロジェクトのセキュアファイルを削除します。

DELETE /projects/:project_id/secure_files/:id

サポートされる属性：

属性種類必須説明
project_id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス。
id整数。はいセキュリティファイルのID。

リクエストの例

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/secure_files/1"