NuGet - プライベートパッケージ

Aikidoがプライベートパッケージを含む依存関係を更新するには、正確なロックファイル更新を生成できるよう、プライベートなNuGetレジストリへのアクセス権が必要です。

Aikidoでは、プライベートなNuGetレジストリとの接続設定に2通りの方法をサポートしています。

nuget.configファイル経由
dotnet cli用の認証情報経由

1. nuget.configファイルによる設定

前提条件

プライベートなNuGetパッケージについて、Aikidoはnuget.configファイルを使ってプライベートレジストリと認証を行います。このファイルは、リポジトリのルートにあるnuget.configを上書きします。このファイルで複数のプライベートレジストリを設定することも可能です。

GitHubのNuGetレジストリでプライベートパッケージにアクセスするためのnuget.configの例:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
    <add key="github" value="https://nuget.pkg.github.com/AikidoSec/index.json" />
  </packageSources>
  <packageSourceCredentials>
    <github>
      <add key="Username" value="AikidoSec" />
      <add key="ClearTextPassword" value="ghp_ABC123...XYZ" />
    </github>
  </packageSourceCredentials>
</configuration>

プライベートなNuGetレジストリでの認証について詳しくは、以下のドキュメントをご覧ください。

Microsoft: Consuming packages from authenticated feeds（認証済みフィードからのパッケージ取得）
GitHub: Working with the NuGet registry（NuGetレジストリの利用方法）

Aikidoでの設定

前提条件を満たしたら、以下の手順に従って、依存関係の更新時にプライベートなNuGetレジストリと認証を行うようAikidoを設定できます。

Aikidoのアカウント設定にあるAutofixの設定ページ（こちら）に移動します。
「Connect Registry」をクリックすると、プライベートレジストリのモーダルが表示されます。

パッケージマネージャーとして「Nuget」を選択し、nuget.configオプションを選択します。

認証情報を含むnuget.configを入力します。Aikidoは、使用される直前まで設定ファイルを安全に暗号化します。
「Connect Registry」をクリックして設定を保存します。

2. .NETのnuget CLIによる設定

CLI経由の設定の場合、Aikidoにはプライベートレジストリとの認証に使用するレジストリのURL、ユーザー名、パスワードが必要です。この情報を用意したら、以下の手順で設定できます。

Aikidoのアカウント設定にあるAutofixの設定ページ（こちら）に移動します。
「Connect Registry」をクリックすると、設定モーダルが表示されます。
パッケージマネージャーとして「Nuget」を選択し、続けて「NuGet CLI Registry」オプションを選択します。

入力欄に詳細を入力し、「Connect Registry」をクリックして設定を保存します。

3. 環境変数による設定

NuGetの場合、Autofixで環境変数を通じて認証情報を渡すことも可能です。

この方法には、プライベートフィードを定義したnuget.configファイルがリポジトリ内に必要です。環境変数のフィード名は、nuget.config内のフィード名と一致している必要があります。

Aikidoのアカウント設定にあるAutofixの設定ページ（こちら）に移動します。
以下の環境変数を追加します。
1. Key: NuGetPackageSourceCredentials_my-private-feed
2. Value: Username=user;Password=secret-pat

PATにはパッケージの読み取り権限が必要です。