Usa condiciones en las reglas de seguridad de Realtime Database

Esta guía complementa el artículo sobre el lenguaje básico de las reglas de seguridad de Firebase. Aquí aprenderás a agregar condiciones a tus reglas de seguridad de Firebase Realtime Database.

Las condiciones son el elemento principal de las reglas de seguridad de Realtime Database. Se trata de expresiones booleanas que determinan si se debe permitir o rechazar una operación en particular. En el caso de las reglas básicas, puedes usar los valores literales true y false como condiciones. Sin embargo, el lenguaje de las reglas de seguridad de Realtime Database te permite escribir condiciones más complejas para hacer lo siguiente:

• Verificar la autenticación de los usuarios
• Comparar los datos existentes con los enviados recientemente
• Acceder a diferentes partes de tu base de datos y compararlas
• Validar los datos entrantes
• Usar la estructura de las consultas entrantes para la lógica de seguridad

Usa variables $ para captar segmentos de la ruta de acceso

A fin de captar segmentos de la ruta de acceso para una operación de lectura o escritura, puedes declarar variables de captura con el prefijo $. Este funciona como comodín y almacena el valor de esa clave para usarlo en las condiciones de las reglas:

{
  "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')"
        }
      }
    }
  }
}

Las variables dinámicas $ también se pueden usar en paralelo con nombres de rutas de acceso constantes. En este ejemplo se usa la variable $other para declarar una regla .validate que garantiza que widget no tenga más elementos secundarios aparte de title y color. Cualquier escritura que cree elementos secundarios adicionales fallaría.

{
  "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 }
    }
  }
}

Autenticación

Uno de los patrones de reglas de seguridad más comunes es controlar el acceso según el estado de autenticación del usuario. Por ejemplo, es posible que tu app permita que escriban datos solo los usuarios que accedieron a sus cuentas.

Si la app usa Firebase Authentication, la variable request.auth contiene la información de autenticación del cliente que solicita datos. Para obtener más información sobre request.auth, consulta la documentación de referencia.

Firebase Authentication se integra en Firebase Realtime Database para que puedas usar condiciones a fin de controlar el acceso a los datos en función del usuario. Una vez que un usuario se autentica, la variable auth de tus reglas de seguridad de Realtime Database se propagará con la información del usuario. Esta información incluye el identificador único (uid) junto con los datos de la cuenta vinculada, como un ID de Facebook o una dirección de correo electrónico y otra información. Si implementas un proveedor de autenticación personalizado, puedes agregar tus propios campos a la carga útil de autenticación del usuario.

En esta sección se explica cómo combinar el lenguaje de las reglas de seguridad de Firebase Realtime Database con la información de autenticación de los usuarios. Puedes combinar estos dos conceptos para controlar el acceso a los datos según la identidad del usuario.

La variable auth

La variable predefinida auth de las reglas tiene un valor nulo antes de la autenticación.

Una vez que se autentica el usuario con Firebase Authentication, la variable tendrá los siguientes atributos:

Esta es una regla de ejemplo que usa la variable auth para garantizar que cada usuario solo pueda escribir en una ruta de acceso específica del usuario:

{
  "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"
      }
    }
  }
}

Estructura tu base de datos para admitir condiciones de Authentication

Suele resultar útil estructurar la base de datos de una manera que facilite la escritura de las reglas. Un patrón común para almacenar datos del usuario en Realtime Database es guardar todos los usuarios en un solo nodo users cuyos campos secundarios son los valores uid de cada usuario. Si quieres restringir el acceso a estos datos para que solo los usuarios que accedan a sus cuentas puedan ver sus propios datos, tus reglas deberían tener el siguiente aspecto:

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

Trabaja con reclamos personalizados de Authentication

En el caso de las apps que requieren control de acceso personalizado para usuarios distintos, Firebase Authentication les permite a los desarrolladores definir reclamos en un usuario de Firebase. Puedes acceder a estos reclamos en la variable auth.token de tus reglas. A continuación, se muestra un ejemplo de reglas que usan el reclamo personalizado hasEmergencyTowel:

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

De manera opcional, los desarrolladores que crean sus propios tokens de autenticación personalizados pueden agregarles reclamos adicionales. Estos reclamos están disponibles en la variable auth.token de tus reglas.

Datos existentes en comparación con datos nuevos

La variable predefinida data se usa para hacer referencia a los datos antes de que se ejecute una operación de escritura. Por el contrario, la variable newData contiene los datos nuevos que existirán si se ejecuta correctamente la operación de escritura. newData representa el resultado combinado de los datos nuevos que se escriben y los datos existentes.

A modo de ejemplo, esta regla nos permitirá crear registros nuevos o borrar los existentes, pero no podremos realizar cambios en los datos existentes que no son nulos:

// 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()"

Referencia a datos en otras rutas

Se puede usar cualquier dato como criterio para las reglas. Con las variables predefinidas root, data y newData, podemos acceder a cualquier ruta de acceso como existiría antes o después de un evento de escritura.

Considera este ejemplo, que permite operaciones de escritura siempre que el valor del nodo /allow_writes/ sea true, el nodo superior no tenga una marca readOnly y haya un elemento secundario llamado foo en los datos recién escritos:

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

Valida los datos

La aplicación de las estructuras de datos y la validación del formato y del contenido de los datos se deben realizar mediante reglas de .validate, que solo se ejecutan después de que una regla .write otorga acceso correctamente. A continuación, se muestra una definición de ejemplo de la regla .validate, que solo permite fechas en el formato AAAA‑MM‑DD entre los años 1900 y 2099, lo que se verifica con una expresión regular.

".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])$/)"

Las reglas .validate son el único tipo de regla de seguridad que no se aplica en cascada. Si alguna regla de validación falla en algún registro secundario, se rechazará toda la operación de escritura. Además, las definiciones de validación se ignoran cuando se borran datos (es decir, cuando el valor nuevo que se escribe es null).

Podrían parecer aspectos triviales, pero, de hecho, son funciones importantes para escribir reglas de seguridad eficaces de Firebase Realtime Database. Ten en cuenta las siguientes reglas:

{
  "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()"
      }
    }
  }
}

Con esta variante en mente, mira los resultados para las siguientes operaciones de escritura:

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);

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

Ahora veamos la misma estructura, pero con reglas .write en lugar de .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()"
      }
    }
  }
}

En esta variante, cualquiera de las siguientes operaciones tendría éxito:

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);

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

Esto ilustra las diferencias entre las reglas .write y .validate. Como se demostró, todas estas reglas se deberían escribir con .validate, con la excepción posible de la regla newData.hasChildren(), que depende de si se deberían permitir las eliminaciones.

Reglas basadas en consultas

Si bien no puedes usar reglas como filtros, puedes utilizar parámetros de consulta en tus reglas para limitar el acceso a subconjuntos de datos. Usa expresiones query. en tus reglas para otorgar acceso de lectura o escritura en función de los parámetros de consulta.

Por ejemplo, la siguiente regla basada en consultas usa reglas de seguridad basadas en usuarios y en consultas para restringir el acceso a los datos de la colección baskets solo a los carritos de compra que posee el usuario activo:

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

La siguiente consulta, que incluye los parámetros de consulta en la regla, se ejecutaría correctamente:

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

Sin embargo, las consultas que no incluyen los parámetros en la regla producirían un error PermissionDenied:

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

Además, puedes usar reglas basadas en consultas para limitar la cantidad de datos que un cliente descarga mediante operaciones de lectura.

Por ejemplo, la siguiente regla limita el acceso de lectura a los primeros 1,000 resultados de una consulta únicamente, los cuales se ordenan por prioridad:

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)

Las siguientes expresiones query. están disponibles en las reglas de seguridad de Realtime Database.

Próximos pasos

Después de leer este artículo sobre las condiciones, comprenderás las reglas en más profundidad y podrás hacer lo siguiente:

Aprender a abordar los casos de uso principales y conocer el flujo de trabajo para desarrollar, probar e implementar reglas

• Conoce el conjunto completo de variables que puedes usar para crear condiciones.
• Escribe reglas que aborden casos comunes.
• Para complementar tus conocimientos, revisa las situaciones en las que debes detectar y evitar reglas inseguras.
• Obtén más información sobre Firebase Local Emulator Suite y aprende a usarlo para probar reglas.
• Revisa los métodos disponibles para implementar reglas.

Conocer las funciones de reglas exclusivas de Realtime Database

• Aprende a indexar tu instancia de Realtime Database.
• Revisa la API de REST para implementar reglas.