クラウドストレージ言語のFirebaseセキュリティルールのコア構文を学ぶ

CloudStorageのFirebaseSecurityRulesを使用すると、CloudStorageバケットに保存されているオブジェクトへのアクセスを制御できます。柔軟なルール構文を使用すると、Cloud Storageバケットへのすべての書き込みから特定のファイルへの操作まで、あらゆる操作を制御するルールを作成できます。

このガイドでは、完全なルールセットを作成するためのCloudStorageセキュリティルールの基本的な構文と構造について説明します。

サービスとデータベースの宣言

クラウドストレージのFirebaseセキュリティルールは、常に次の宣言で始まります。

service firebase.storage {
    // ...
}

service firebase.storage宣言は、ルールをCloud Storageにスコープし、CloudStorageセキュリティルールとCloudFirestoreなどの他の製品のルールとの競合を防ぎます。

基本的な読み取り/書き込みルール

基本的なルールは、Cloud Storageバケットを識別するmatchステートメント、ファイル名を指定するmatchステートメント、および指定されたデータの読み取りが許可されるときの詳細を示すallow式で構成されます。 allow式は、関連するアクセス方法（読み取り、書き込みなど）、およびアクセスが許可または拒否される条件を指定します。

デフォルトのルールセットでは、最初のmatchステートメントは{bucket}ワイルドカード式を使用して、ルールがプロジェクト内のすべてのバケットに適用されることを示します。ワイルドカード一致のアイデアについては、次のセクションで詳しく説明します。

service firebase.storage {
  // The {bucket} wildcard indicates we match files in all Cloud Storage buckets
  match /b/{bucket}/o {
    // Match filename
    match /filename {
      allow read: if <condition>;
      allow write: if <condition>;
    }
  }
}

すべてのmatchステートメントはファイルを指します。 matchステートメントは、 match /images/profilePhoto.pngのように、特定のファイルを指すことができます。

ワイルドカードと一致する

単一のファイルを指すことに加えて、Rulesはワイルドカードを使用して、 match /images/{imageId}のように、名前にスラッシュを含む指定された文字列プレフィックスを持つ任意のファイルを指すことができます。

上記の例では、matchステートメントは{imageId}ワイルドカード構文を使用しています。これは、/ images /images/profilePhoto.pngや/images/croppedProfilePhoto.pngなど、名前の先頭に/images/が付いているすべてのファイルにルールが適用されることを意味します。 matchステートメントのallow式が評価されると、 imageId変数はprofilePhoto.pngやcroppedProfilePhoto.pngなどの画像ファイル名に解決されます。

match内からワイルドカード変数を参照して、ファイル名またはパス認証を提供できます。

// Another way to restrict the name of a file
match /images/{imageId} {
  allow read: if imageId == "profilePhoto.png";
}

階層データ

前に述べたように、CloudStorageバケット内には階層構造はありません。ただし、ファイル名にスラッシュが含まれることが多いファイル命名規則を使用することで、ネストされた一連のディレクトリとサブディレクトリのように見える構造を模倣できます。 Firebaseセキュリティルールがこれらのファイル名とどのように相互作用するかを理解することが重要です。

すべて/images/ステムで始まる名前のファイルのセットの状況を考えてみます。 Firebaseセキュリティルールは一致したファイル名にのみ適用されるため、 /images/ステムで定義されたアクセス制御は/mp3s/ステムには適用されません。代わりに、さまざまなファイル名パターンに一致する明示的なルールを記述します。

service firebase.storage {
  match /b/{bucket}/o {
    match /images/{imageId} {
      allow read, write: if <condition>;
    }

    // Explicitly define rules for the 'mp3s' pattern
    match /mp3s/{mp3Id} {
      allow read, write: if <condition>;
    }
  }
}

matchステートメントをネストする場合、内側のmatchステートメントのパスは常に外側のmatchステートメントのパスに追加されます。したがって、次の2つのルールセットは同等です。

service firebase.storage {
  match /b/{bucket}/o {
    match /images {
      // Exact match for "images/profilePhoto.png"
      match /profilePhoto.png {
        allow write: if <condition>;
      }
    }
  }
}

service firebase.storage {
  match /b/{bucket}/o {
    // Exact match for "images/profilePhoto.png"
    match /images/profilePhoto.png {
      allow write: if <condition>;
      }
  }
}

再帰一致ワイルドカード

ファイル名の末尾の文字列に一致して返すワイルドカードに加えて、 {path=**}のようにワイルドカード名に=**を追加することで、より複雑な一致のために複数セグメントのワイルドカードを宣言できます。

// Partial match for files that start with "images"
match /images {

  // Exact match for "images/**"
  // e.g. images/users/user:12345/profilePhoto.png is matched
  // images/profilePhoto.png is also matched!
  match /{allImages=**} {
    // This rule matches one or more path segments (**)
    // allImages is a path that contains all segments matched
    allow read: if <other_condition>;
  }
}

複数のルールがファイルに一致する場合、結果はすべてのルール評価の結果のORになります。つまり、ファイルが一致するルールのいずれかがevalutesからtrueに一致する場合、結果はtrueになります。

上記のルールでは、ファイル「images / profilePhoto.png」は、 conditionまたはother_conditionのいずれかがtrueと評価された場合に読み取ることができますが、ファイル「images / users / user：12345/profilePhoto.png」はother_conditionの結果のみの対象となります。 。

クラウドストレージのセキュリティルールはカスケードされません。ルールは、リクエストパスが指定されたルールのパスと一致する場合にのみ評価されます。

rules_version = '2';
service cloud.storage {
  match /b/{bucket}/o {
   ...
 }
}

rules_version = '2';
service firebase.storage {
 match /b/{bucket}/o {
   // Matches any file in a songs "subdirectory" under the
   // top level of your Cloud Storage bucket.
   match /{prefixSegment=**}/songs/{mp3filenames} {
     allow read, write: if <condition>;
   }
  }
}

きめ細かい操作

状況によっては、 readとwriteをより詳細な操作に分割すると便利です。たとえば、アプリでは、ファイルの作成時にファイルの削除とは異なる条件を適用したい場合があります。

read操作は、 getとlistに分けることができます。

writeルールは、 create 、 update 、 deleteに分けることができます。

service firebase.storage {
  match /b/{bucket}/o {
    // A read rule can be divided into read and list rules
    match /images/{imageId} {
      // Applies to single file read requests
      allow get: if <condition>;
      // Applies to list and listAll requests (Rules Version 2)
      allow list: if <condition>;

    // A write rule can be divided into create, update, and delete rules
    match /images/{imageId} {
      // Applies to writes to file contents
      allow create: if <condition>;

      // Applies to updates to (pre-existing) file metadata
      allow update: if <condition>;

      // Applies to delete operations
      allow delete: if <condition>;
    }
  }
 }
}

重複する一致ステートメント

ファイル名が複数のmatchステートメントと一致する可能性があります。複数のallow式が要求に一致する場合、条件のいずれかがtrueであればアクセスが許可されます。

service firebase.storage {
  match b/{bucket}/o {
    // Matches file names directly inside of '/images/'.
    match /images/{imageId} {
      allow read, write: if false;
    }

    // Matches file names anywhere under `/images/`
    match /images/{imageId=**} {
      allow read, write: if true;
    }
  }
}

上記の例では、名前が/images/で始まるファイルへのすべての読み取りと書き込みが許可されています。これは、最初のルールがfalseの場合でも、2番目のルールが常にtrueであるためです。

ルールはフィルターではありません

データを保護してファイル操作の実行を開始したら、セキュリティルールはフィルターではないことに注意してください。ファイル名パターンに一致する一連のファイルに対して操作を実行することはできず、CloudStorageが現在のクライアントがアクセスする権限を持っているファイルにのみアクセスすることを期待できます。

たとえば、次のセキュリティルールを考えてみましょう。

service firebase.storage {
  match /b/{bucket}/o {
    // Allow the client to read files with contentType 'image/png'
    match /aFileNamePrefix/{aFileName} {
      allow read: if resource.contentType == 'image/png';
    }
  }
}

拒否： contentTypeがimage/pngでないファイルを結果セットに含めることができるため、このルールは次のリクエストを拒否します：

filesRef = storage.ref().child("aFilenamePrefix");

filesRef.listAll()
    .then(function(result) {
      console.log("Success: ", result.items);
    })
});

Cloud Storageセキュリティルールのルールは、潜在的な結果に対して各クエリを評価し、クライアントが読み取る権限を持たないファイルを返す可能性がある場合、リクエストを失敗させます。アクセス要求は、ルールで設定された制約に従う必要があります。

次のステップ

クラウドストレージのFirebaseセキュリティルールについての理解を深めることができます。

• ルール言語の次の主要な概念である動的条件について学習します。これにより、ルールでユーザーの承認を確認したり、既存のデータと受信データを比較したり、受信データを検証したりできます。

• 一般的なセキュリティのユースケースと、それらに対処するFirebaseセキュリティルールの定義を確認します。

CloudStorageに固有のFirebaseセキュリティルールのユースケースを調べることができます。