Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

Realtime Databaseルールの条件を使用する

このガイドは、Firebase Realtime Databaseセキュリティルールに条件を追加する方法を示すために、コアFirebaseセキュリティルール言語ガイドの学習に基づいています。

Realtime Databaseセキュリティルールの主要な構成要素は条件です。条件は、特定の操作を許可するか拒否するかを決定するブール式です。基本的なルールの場合、条件としてtruefalseリテラルを使用すると問題なく機能します。しかし、Realtime Database Security Rules言語では、次のようなより複雑な条件を記述する方法が提供されます。

  • ユーザー認証を確認する
  • 新しく送信されたデータに対して既存のデータを評価する
  • データベースのさまざまな部分にアクセスして比較する
  • 入力データを検証する
  • 受信クエリの構造をセキュリティロジックに使用する

$変数を使用してパスセグメントをキャプチャする

$接頭辞を付けてキャプチャ変数を宣言することにより、読み取りまたは書き込みのパスの一部をキャプチャできます。これはワイルドカードとして機能し、ルール条件内で使用するためにそのキーの値を格納します。

{
  "rules": {
    "rooms": {
      // this rule applies to any child of /rooms/, the key for each room id
      // is stored inside $room_id variable for reference
      "$room_id": {
        "topic": {
          // the room's topic can be changed if the room id has "public" in it
          ".write": "$room_id.contains('public')"
        }
      }
    }
  }
}

動的$変数は、定数パス名と並行して使用することもできます。この例では、 $other変数を使用して、 widget titlecolor以外の子がないことを確認する.validateルールを宣言していwidget 。追加の子が作成される結果となる書き込みは失敗します。

{
  "rules": {
    "widget": {
      // a widget can have a title or color attribute
      "title": { ".validate": true },
      "color": { ".validate": true },

      // but no other child paths are allowed
      // in this case, $other means any key excluding "title" and "color"
      "$other": { ".validate": false }
    }
  }
}

認証

最も一般的なセキュリティルールパターンの1つは、ユーザーの認証状態に基づいてアクセスを制御することです。たとえば、サインインしているユーザーのみにデータの書き込みを許可したい場合があります。

アプリがFirebase Authenticationを使用している場合、 request.auth変数には、データをリクエストしているクライアントの認証情報が含まれています。 request.auth詳細については、リファレンスドキュメントをご覧ください。

Firebase AuthenticationはFirebase Realtime Databaseと統合して、条件を使用してユーザーごとにデータアクセスを制御できるようにします。ユーザーが認証されると、Realtime Databaseセキュリティルールルールのauth変数にユーザーの情報が入力されます。この情報には、固有の識別子( uid )だけでなく、FacebookのIDや電子メールアドレスなどのリンクされたアカウントデータ、およびその他の情報が含まれます。カスタム認証プロバイダーを実装する場合、ユーザーの認証ペイロードに独自のフィールドを追加できます。

このセクションでは、Firebase Realtime Databaseセキュリティルール言語とユーザーの認証情報を組み合わせる方法について説明します。これら2つの概念を組み合わせると、ユーザーIDに基づいてデータへのアクセスを制御できます。

auth変数

ルール内の事前定義されたauth変数は、認証が行われる前はnullです。

ユーザーがFirebase Authentication認証されると、次の属性が含まれます。

プロバイダー使用される認証方法(「パスワード」、「匿名」、「facebook」、「github」、「google」、または「twitter」)。
uid すべてのプロバイダーにわたって一意であることが保証された一意のユーザーID。
トークン Firebase Auth IDトークンの内容。詳細については、 auth.tokenのリファレンスドキュメントをご覧ください。

次に、 auth変数を使用して、各ユーザーがユーザー固有のパスにのみ書き込むことができるようにするルールの例を示します。

{
  "rules": {
    "users": {
      "$user_id": {
        // grants write access to the owner of this user account
        // whose uid must exactly match the key ($user_id)
        ".write": "$user_id === auth.uid"
      }
    }
  }
}

認証条件をサポートするためのデータベースの構造化

通常、ルールを簡単に記述できるようにデータベースを構造化すると便利です。 Realtime Databaseにユーザーデータを保存するための一般的なパターンの1つは、すべてのユーザーを、すべてのユーザーのuid値を子とする単一のusersノードに保存することです。ログインしたユーザーだけが自分のデータを見ることができるようにこのデータへのアクセスを制限したい場合、ルールは次のようになります。

{
  "rules": {
    "users": {
      "$uid": {
        ".read": "auth != null && auth.uid == $uid"
      }
    }
  }
}

認証カスタムクレームの操作

さまざまなユーザーのカスタムアクセス制御が必要なアプリの場合、Firebase Authenticationを使用すると、デベロッパーはFirebaseユーザーにクレーム設定できます 。これらのクレームは、ルールのauth.token変数でauth.tokenます。次に、 hasEmergencyTowelカスタムクレームを使用するルールの例を示します。

{
  "rules": {
    "frood": {
      // A towel is about the most massively useful thing an interstellar
      // hitchhiker can have
      ".read": "auth.token.hasEmergencyTowel === true"
    }
  }
}

独自のカスタム認証トークンを作成する開発者は、オプションでこれらのトークンにクレームを追加できます。これらの要求は、ルールのauth.token変数で使用できます。

既存のデータと新しいデータ

事前定義されたdata変数は、書き込み操作が行われる前のデータを参照するために使用されます。逆に、 newData変数には、書き込み操作が成功した場合に存在する新しいデータが含まれます。 newDataは、書き込まれる新しいデータと既存のデータのマージ結果を表します。

たとえば、このルールでは、新しいレコードを作成したり、既存のレコードを削除したりできますが、既存のnull以外のデータを変更することはできません。

// we can write as long as old data or new data does not exist
// in other words, if this is a delete or a create, but not an update
".write": "!data.exists() || !newData.exists()"

他のパスのデータを参照する

あらゆるデータをルールの基準として使用できます。事前定義された変数rootdata 、およびnewDataを使用して、書き込みイベントの前後に存在する任意のパスにアクセスできます。

/allow_writes/ノードの値がtrueであり、親ノードにreadOnlyフラグが設定されておらず、新しく書き込まれたデータにfooという名前の子が存在する限り、書き込み操作を許可する次の例を検討してください。

".write": "root.child('allow_writes').val() === true &&
          !data.parent().child('readOnly').exists() &&
          newData.child('foo').exists()"

データの検証

データ構造の適用とデータの形式とコンテンツの検証は、 .validateルールを使用して行う必要があります。これは、 .writeルールがアクセス権の付与に成功した後にのみ実行されます。以下は、 .validate年のYYYY-MM-DD形式の日付のみを許可する.validateルール定義のサンプルで、正規表現を使用してチェックされます。

".validate": "newData.isString() &&
              newData.val().matches(/^(19|20)[0-9][0-9][-\\/. ](0[1-9]|1[012])[-\\/. ](0[1-9]|[12][0-9]|3[01])$/)"

.validateルールは、カスケードしない唯一のタイプのセキュリティルールです。いずれかの子レコードで検証ルールが失敗した場合、書き込み操作全体が拒否されます。さらに、データが削除されるとき(つまり、書き込まれる新しい値がnull )、検証定義は無視されnull

これらはささいなことのように思えるかもしれませんが、実際には強力なFirebase Realtime Databaseセキュリティルールを記述するための重要な機能です。次のルールを検討してください。

{
  "rules": {
    // write is allowed for all paths
    ".write": true,
    "widget": {
      // a valid widget must have attributes "color" and "size"
      // allows deleting widgets (since .validate is not applied to delete rules)
      ".validate": "newData.hasChildren(['color', 'size'])",
      "size": {
        // the value of "size" must be a number between 0 and 99
        ".validate": "newData.isNumber() &&
                      newData.val() >= 0 &&
                      newData.val() <= 99"
      },
      "color": {
        // the value of "color" must exist as a key in our mythical
        // /valid_colors/ index
        ".validate": "root.child('valid_colors/' + newData.val()).exists()"
      }
    }
  }
}

このバリアントを念頭に置いて、次の書き込み操作の結果を見てください。

JavaScript
var ref = db.ref("/widget");

// PERMISSION_DENIED: does not have children color and size
ref.set('foo');

// PERMISSION DENIED: does not have child color
ref.set({size: 22});

// PERMISSION_DENIED: size is not a number
ref.set({ size: 'foo', color: 'red' });

// SUCCESS (assuming 'blue' appears in our colors list)
ref.set({ size: 21, color: 'blue'});

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child('size').set(99);
Objective-C
FIRDatabaseReference *ref = [[[FIRDatabase database] reference] child: @"widget"];

// PERMISSION_DENIED: does not have children color and size
[ref setValue: @"foo"];

// PERMISSION DENIED: does not have child color
[ref setValue: @{ @"size": @"foo" }];

// PERMISSION_DENIED: size is not a number
[ref setValue: @{ @"size": @"foo", @"color": @"red" }];

// SUCCESS (assuming 'blue' appears in our colors list)
[ref setValue: @{ @"size": @21, @"color": @"blue" }];

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
[[ref child:@"size"] setValue: @99];
迅速
var ref = FIRDatabase.database().reference().child("widget")

// PERMISSION_DENIED: does not have children color and size
ref.setValue("foo")

// PERMISSION DENIED: does not have child color
ref.setValue(["size": "foo"])

// PERMISSION_DENIED: size is not a number
ref.setValue(["size": "foo", "color": "red"])

// SUCCESS (assuming 'blue' appears in our colors list)
ref.setValue(["size": 21, "color": "blue"])

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child("size").setValue(99);
ジャワ
FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("widget");

// PERMISSION_DENIED: does not have children color and size
ref.setValue("foo");

// PERMISSION DENIED: does not have child color
ref.child("size").setValue(22);

// PERMISSION_DENIED: size is not a number
Map<String,Object> map = new HashMap<String, Object>();
map.put("size","foo");
map.put("color","red");
ref.setValue(map);

// SUCCESS (assuming 'blue' appears in our colors list)
map = new HashMap<String, Object>();
map.put("size", 21);
map.put("color","blue");
ref.setValue(map);

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child("size").setValue(99);
残り
# PERMISSION_DENIED: does not have children color and size
curl -X PUT -d 'foo' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# PERMISSION DENIED: does not have child color
curl -X PUT -d '{"size": 22}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# PERMISSION_DENIED: size is not a number
curl -X PUT -d '{"size": "foo", "color": "red"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# SUCCESS (assuming 'blue' appears in our colors list)
curl -X PUT -d '{"size": 21, "color": "blue"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# If the record already exists and has a color, this will
# succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
# will fail to validate
curl -X PUT -d '99' \
https://docs-examples.firebaseio.com/rest/securing-data/example/size.json

今、同じ構造での見てみましょう、しかし、使用して.writeの代わりにルールを.validate

{
  "rules": {
    // this variant will NOT allow deleting records (since .write would be disallowed)
    "widget": {
      // a widget must have 'color' and 'size' in order to be written to this path
      ".write": "newData.hasChildren(['color', 'size'])",
      "size": {
        // the value of "size" must be a number between 0 and 99, ONLY IF WE WRITE DIRECTLY TO SIZE
        ".write": "newData.isNumber() && newData.val() >= 0 && newData.val() <= 99"
      },
      "color": {
        // the value of "color" must exist as a key in our mythical valid_colors/ index
        // BUT ONLY IF WE WRITE DIRECTLY TO COLOR
        ".write": "root.child('valid_colors/'+newData.val()).exists()"
      }
    }
  }
}

このバリアントでは、次の操作のいずれかが成功します。

JavaScript
var ref = new Firebase(URL + "/widget");

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
ref.set({size: 99999, color: 'red'});

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.child('size').set(99);
Objective-C
Firebase *ref = [[Firebase alloc] initWithUrl:URL];

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
[ref setValue: @{ @"size": @9999, @"color": @"red" }];

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
[[ref childByAppendingPath:@"size"] setValue: @99];
迅速
var ref = Firebase(url:URL)

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
ref.setValue(["size": 9999, "color": "red"])

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.childByAppendingPath("size").setValue(99)
ジャワ
Firebase ref = new Firebase(URL + "/widget");

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
Map<String,Object> map = new HashMap<String, Object>();
map.put("size", 99999);
map.put("color", "red");
ref.setValue(map);

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.child("size").setValue(99);
残り
# ALLOWED? Even though size is invalid, widget has children color and size,
# so write is allowed and the .write rule under color is ignored
curl -X PUT -d '{size: 99999, color: "red"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# ALLOWED? Works even if widget does not exist, allowing us to create a widget
# which is invalid and does not have a valid color.
# (allowed by the write rule under "color")
curl -X PUT -d '99' \
https://docs-examples.firebaseio.com/rest/securing-data/example/size.json

これは間の違いを示し.write.validateルールを。示されているように、これらのルールはすべて.validateを使用して記述する必要があります。ただし、 newData.hasChildren()ルールは例外であり、削除を許可するかどうかによって異なります。

クエリベースのルール

ルールをフィルターとして使用することはできませんが、ルールでクエリパラメーターを使用して、データのサブセットへのアクセスを制限できます。 query.使用しquery.クエリパラメータに基づいて読み取りまたは書き込みアクセスを許可するルール内の式。

たとえば、次のクエリベースのルールは、 ユーザーベースのセキュリティルールとクエリベースのルールを使用して、 basketsコレクション内のデータへのアクセスをアクティブなユーザーが所有する買い物かごのみに制限します。

"baskets": {
  ".read": "auth.uid != null &&
            query.orderByChild == 'owner' &&
            query.equalTo == auth.uid" // restrict basket access to owner of basket
}

ルールにクエリパラメータを含む次のクエリは成功します。

db.ref("baskets").orderByChild("owner")
                 .equalTo(auth.currentUser.uid)
                 .on("value", cb)                 // Would succeed

ただし、ルールにパラメーターが含まれていないクエリは、 PermissionDeniedエラーで失敗します。

db.ref("baskets").on("value", cb)                 // Would fail with PermissionDenied

クエリベースのルールを使用して、クライアントが読み取り操作を通じてダウンロードするデータの量を制限することもできます。

たとえば、次のルールでは、読み取りアクセスをクエリの最初の1000件の結果のみに制限し、優先度順に並べています。

messages: {
  ".read": "query.orderByKey &&
            query.limitToFirst <= 1000"
}

// Example queries:

db.ref("messages").on("value", cb)                // Would fail with PermissionDenied

db.ref("messages").limitToFirst(1000)
                  .on("value", cb)                // Would succeed (default order by key)

次のquery.式はRealtime Databaseセキュリティルールで使用できます。

クエリベースのルール式
表情 タイプ 説明
query.orderByKey
query.orderByPriority
query.orderByValue
ブールキー、優先度、または値で並べ替えられたクエリの場合はTrue。それ以外の場合はfalse。
query.orderByChild ストリング
ヌル
文字列を使用して、子ノードへの相対パスを表します。たとえば、 query.orderByChild == "address/zip"です。クエリが子ノードで並べ替えられていない場合、この値はnullです。
query.startAt
query.endAt
query.equalTo
ストリング

ブール
ヌル
実行中のクエリの境界を取得します。境界セットがない場合はnullを返します。
query.limitToFirst
query.limitToLast

ヌル
実行中のクエリの制限を取得します。制限が設定されていない場合はnullを返します。

次のステップ

条件についてのこの議論の後、ルールのより高度な理解が得られ、次の準備が整います。

コアユースケースの処理方法、およびルールの開発、テスト、展開のワークフローを学習します。

Realtime Databaseに固有のルール機能について学習します。