crAPI

completely ridiculous API（crAPI）は、APIセキュリティにおける10の主要なリスクを理解するのに役立ちます。crAPIは意図的に脆弱に設計されていますが、学習やトレーニングのために安全に実行できます。

crAPIはマイクロサービスアーキテクチャ上に構築されたモダンなアプリケーションです。初めての車を購入する時が来たら、アカウントに登録して旅を始めましょう。crAPIの詳細については、crAPIの概要をご確認ください。

クイックスタートガイド

アプリケーションワークフロー（Happy Path）

crAPIのセットアップ後は、セキュリティチャレンジに取り組む前に、アプリケーションがどのように動作するかを理解するために、意図されたユーザーワークフローをたどることを推奨します。

-アプリケーションワークフロー（Happy Path）

Docker と docker compose

Docker と docker compose がホストシステムにインストールされ、実行されている必要があります。また、docker compose のバージョンは 1.27.0 以上である必要があります。docker compose のバージョンを確認するには、次のコマンドを実行します。

docker compose version

次のようなエラーが発生した場合は、docker compose のバージョンをアップグレードしてください

ERROR: Invalid interpolation format for ...

プレビルドイメージの使用

docker compose ファイルと .env ファイルをダウンロードすることで、CIワークフローで生成されたプレビルドイメージを使用できます。

• 最新の安定バージョンを使用する場合

  • Linuxマシン
  root@kitploit:~

  curl -L -o /tmp/crapi.zip https://github.com/OWASP/crAPI/archive/refs/heads/main.zip
  unzip /tmp/crapi.zip
  cd crAPI-main/deploy/docker
  docker compose pull
  docker compose -f docker-compose.yml --compatibility up -d
  

  サーバー設定を上書きするには、.env ファイル内の変数の値を変更するか、対応する変数をdocker composeコマンドの先頭に追加します。

  例：システムをすべてのネットワークインターフェースに公開する場合。

  root@kitploit:~

  LISTEN_IP="0.0.0.0" docker compose -f docker-compose.yml --compatibility up -d
  

  • Windowsマシン
  root@kitploit:~

  curl.exe -L -o crapi.zip https://github.com/OWASP/crAPI/archive/refs/heads/main.zip
  tar -xf .\crapi.zip
  cd crAPI-main/deploy/docker
  docker compose pull
  docker compose -f docker-compose.yml --compatibility up -d
  

  サーバー設定を上書きするには、.env ファイル内の変数の値を変更するか、対応する変数をdocker composeコマンドの先頭に追加します。

  例：システムをすべてのネットワークインターフェースに公開する場合。

  root@kitploit:~

  LISTEN_IP="0.0.0.0" docker compose -f docker-compose.yml --compatibility up -d
  

• 最新の開発バージョンを使用する場合

  • Linuxマシン
  root@kitploit:~

  curl -L -o /tmp/crapi.zip https://github.com/OWASP/crAPI/archive/refs/heads/develop.zip
  unzip /tmp/crapi.zip 
  cd crAPI-develop/deploy/docker
  docker compose pull
  docker compose -f docker-compose.yml --compatibility up -d
  

  サーバー設定を上書きするには、 ファイル内の変数の値を変更するか、対応する変数をdocker composeコマンドの先頭に追加します。

http://localhost:8888 にアクセスしてください。

注: デフォルトでは、すべてのメールはmailhogサービスに送信され、http://localhost:8025 で確認できます。必要に応じてSMTP設定を変更できますが、example.com ドメインのメールは引き続きmailhogに送信されます。

チャットボットLLMプロバイダの設定については、セットアップ手順を参照してください。

Vagrant

このオプションを使用すると、crAPIを仮想マシン内で実行できるため、システムから隔離されます。Vagrant と、例えば VirtualBox がインストールされている必要があります。

1. crAPIリポジトリをクローンする
   root@kitploit:~

   $ git clone [REPOSITORY-URL]
   

2. crAPI仮想マシンを起動する
   root@kitploit:~

   $ cd deploy/vagrant && vagrant up
   

3. http://192.168.33.20 にアクセスする

注: すべてのメールはmailhogサービスに送信され、http://192.168.33.20:8025 で確認できます。

crAPIの使用が終わったら、リポジトリのルートディレクトリから次のコマンドを実行して、システムから完全に削除できます。

$ cd deploy/vagrant && vagrant destroy

その他のデプロイオプションについては、セットアップ手順を参照してください。

crAPIのチャレンジの詳細については、[チャレンジ]をご覧ください。

crAPIのインストールと実行に関する一般的な問題のトラブルシューティングガイド

crAPIのインストールと実行に関してヘルプが必要な場合は、次のガイドを参照してください：crAPIトラブルシューティングガイド。これで問題が解決しない場合は、Github IssuesにIssueを作成してください。