Recoger registros de eventos de Bitwarden Enterprise
En esta guía se explica cómo puede ingerir registros de eventos de Bitwarden Enterprise en Google Security Operations mediante Amazon S3. El analizador transforma los registros de eventos sin procesar en formato JSON en un formato estructurado conforme al modelo de datos unificado de Chronicle. Extrae campos relevantes, como los detalles del usuario, las direcciones IP y los tipos de eventos, y los asigna a los campos de UDM correspondientes para realizar un análisis de seguridad coherente.
Antes de empezar
- Instancia de Google SecOps.
- Acceso privilegiado al arrendatario de Bitwarden.
- Acceso con privilegios a AWS (S3, IAM, Lambda y EventBridge).
Obtener la clave de API y la URL de Bitwarden
- En la consola de administración de Bitwarden.
- Ve a Ajustes > Información de la organización > Ver clave de API.
- Copia y guarda los siguientes detalles en una ubicación segura:
- ID de cliente
- Secreto de cliente
- Determina tus endpoints de Bitwarden (en función de la región):
- IDENTITY_URL =
https://identity.bitwarden.com/connect/token(UE:https://identity.bitwarden.eu/connect/token) - API_BASE =
https://api.bitwarden.com(UE:https://api.bitwarden.eu)
- IDENTITY_URL =
Configurar un segmento de AWS S3 y IAM para Google SecOps
- Crea un segmento de Amazon S3 siguiendo esta guía de usuario: Crear un segmento.
- Guarda el nombre y la región del segmento para consultarlos más adelante (por ejemplo,
bitwarden-events). - Crea un usuario siguiendo esta guía: Crear un usuario de gestión de identidades y accesos.
- Selecciona el usuario creado.
- Selecciona la pestaña Credenciales de seguridad.
- En la sección Claves de acceso, haz clic en Crear clave de acceso.
- Selecciona Servicio de terceros en Caso práctico.
- Haz clic en Siguiente.
- Opcional: añade una etiqueta de descripción.
- Haz clic en Crear clave de acceso.
- Haz clic en Descargar archivo .csv para guardar la clave de acceso y la clave de acceso secreta para futuras consultas.
- Haz clic en Listo.
- Selecciona la pestaña Permisos.
- En la sección Políticas de permisos, haz clic en Añadir permisos.
- Selecciona Añadir permisos.
- Seleccione Adjuntar políticas directamente.
- Busca la política AmazonS3FullAccess.
- Selecciona la política.
- Haz clic en Siguiente.
- Haz clic en Añadir permisos.
Configurar la política y el rol de gestión de identidades y accesos para las subidas de S3
- Ve a la consola de AWS > IAM > Políticas > Crear política > pestaña JSON.
- Copia y pega la política que se indica más abajo.
- JSON de la política (sustituye
bitwarden-eventssi has introducido otro nombre de contenedor):
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "AllowPutBitwardenObjects",
"Effect": "Allow",
"Action": "s3:PutObject",
"Resource": "arn:aws:s3:::bitwarden-events/*"
},
{
"Sid": "AllowGetStateObject",
"Effect": "Allow",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::bitwarden-events/bitwarden/events/state.json"
}
]
}
- Haz clic en Siguiente > Crear política.
- Ve a IAM > Roles > Crear rol > Servicio de AWS > Lambda.
- Adjunte la política que acaba de crear.
- Dale el nombre
WriteBitwardenToS3Roleal rol y haz clic en Crear rol.
Crear la función Lambda
- En la consola de AWS, ve a Lambda > Funciones > Crear función.
- Haz clic en Crear desde cero.
- Proporciona los siguientes detalles de configuración:
| Ajuste | Valor |
|---|---|
| Nombre | bitwarden_events_to_s3 |
| Tiempo de ejecución | Python 3.13 |
| Arquitectura | x86_64 |
| Rol de ejecución | WriteBitwardenToS3Role |
- Una vez creada la función, abre la pestaña Código, elimina el stub y pega el código que aparece más abajo (
bitwarden_events_to_s3.py).
#!/usr/bin/env python3
import os, json, time, urllib.parse
from urllib.request import Request, urlopen
from urllib.error import HTTPError, URLError
import boto3
IDENTITY_URL = os.environ.get("IDENTITY_URL", "https://identity.bitwarden.com/connect/token")
API_BASE = os.environ.get("API_BASE", "https://api.bitwarden.com").rstrip("/")
CID = os.environ["BW_CLIENT_ID"] # organization.ClientId
CSECRET = os.environ["BW_CLIENT_SECRET"] # organization.ClientSecret
BUCKET = os.environ["S3_BUCKET"]
PREFIX = os.environ.get("S3_PREFIX", "bitwarden/events/").strip("/")
STATE_KEY = os.environ.get("STATE_KEY", "bitwarden/events/state.json")
MAX_PAGES = int(os.environ.get("MAX_PAGES", "10"))
HEADERS_FORM = {"Content-Type": "application/x-www-form-urlencoded"}
HEADERS_JSON = {"Accept": "application/json"}
s3 = boto3.client("s3")
def _read_state():
try:
obj = s3.get_object(Bucket=BUCKET, Key=STATE_KEY)
j = json.loads(obj["Body"].read())
return j.get("continuationToken")
except Exception:
return None
def _write_state(token):
body = json.dumps({"continuationToken": token}).encode("utf-8")
s3.put_object(Bucket=BUCKET, Key=STATE_KEY, Body=body, ContentType="application/json")
def _http(req: Request, timeout: int = 60, max_retries: int = 5):
attempt, backoff = 0, 1.0
while True:
try:
with urlopen(req, timeout=timeout) as r:
return json.loads(r.read().decode("utf-8"))
except HTTPError as e:
# Retry on 429 and 5xx
if (e.code == 429 or 500 <= e.code <= 599) and attempt < max_retries:
time.sleep(backoff); attempt += 1; backoff *= 2; continue
raise
except URLError:
if attempt < max_retries:
time.sleep(backoff); attempt += 1; backoff *= 2; continue
raise
def _get_token():
body = urllib.parse.urlencode({
"grant_type": "client_credentials",
"scope": "api.organization",
"client_id": CID,
"client_secret": CSECRET,
}).encode("utf-8")
req = Request(IDENTITY_URL, data=body, method="POST", headers=HEADERS_FORM)
data = _http(req, timeout=30)
return data["access_token"], int(data.get("expires_in", 3600))
def _fetch_events(bearer: str, cont: str | None):
params = {}
if cont:
params["continuationToken"] = cont
qs = ("?" + urllib.parse.urlencode(params)) if params else ""
url = f"{API_BASE}/public/events{qs}"
req = Request(url, method="GET", headers={"Authorization": f"Bearer {bearer}", **HEADERS_JSON})
return _http(req, timeout=60)
def _write_events_jsonl(events: list, run_ts_s: int, page_index: int) -> str:
"""
Write events in JSONL format (one JSON object per line).
Only writes if there are events to write.
Returns the S3 key of the written file.
"""
if not events:
return None
# Build JSONL content: one event per line
lines = [json.dumps(event, separators=(",", ":")) for event in events]
jsonl_content = "\n".join(lines) + "\n" # JSONL format with trailing newline
# Generate unique filename with page number to avoid conflicts
key = f"{PREFIX}/{time.strftime('%Y/%m/%d/%H%M%S', time.gmtime(run_ts_s))}-page{page_index:05d}-bitwarden-events.jsonl"
s3.put_object(
Bucket=BUCKET,
Key=key,
Body=jsonl_content.encode("utf-8"),
ContentType="application/x-ndjson", # MIME type for JSONL
)
return key
def lambda_handler(event=None, context=None):
bearer, _ttl = _get_token()
cont = _read_state()
run_ts_s = int(time.time())
pages = 0
total_events = 0
written_files = []
while pages < MAX_PAGES:
data = _fetch_events(bearer, cont)
# Extract events array from API response
# API returns: {"object":"list", "data":[...], "continuationToken":"..."}
events = data.get("data", [])
# Only write file if there are events
if events:
s3_key = _write_events_jsonl(events, run_ts_s, pages)
if s3_key:
written_files.append(s3_key)
total_events += len(events)
pages += 1
# Check for next page token
next_cont = data.get("continuationToken")
if next_cont:
cont = next_cont
continue
else:
# No more pages
break
# Save state only if there are more pages to continue in next run
# If we hit MAX_PAGES and there's still a continuation token, save it
# Otherwise, clear the state (set to None)
_write_state(cont if pages >= MAX_PAGES and cont else None)
return {
"ok": True,
"pages": pages,
"total_events": total_events,
"files_written": len(written_files),
"nextContinuationToken": cont if pages >= MAX_PAGES else None
}
if __name__ == "__main__":
print(lambda_handler())
- Ve a Configuración > Variables de entorno > Editar > Añadir nueva variable de entorno.
- Introduce las variables de entorno que se indican a continuación y sustitúyelas por tus valores.
Variables de entorno
| Clave | Ejemplo |
|---|---|
S3_BUCKET |
bitwarden-events |
S3_PREFIX |
bitwarden/events/ |
STATE_KEY |
bitwarden/events/state.json |
BW_CLIENT_ID |
<organization client_id> |
BW_CLIENT_SECRET |
<organization client_secret> |
IDENTITY_URL |
https://identity.bitwarden.com/connect/token (UE: https://identity.bitwarden.eu/connect/token) |
API_BASE |
https://api.bitwarden.com (UE: https://api.bitwarden.eu) |
MAX_PAGES |
10 |
- Una vez creada la función, permanece en su página (o abre Lambda > Funciones > tu‑función).
- Seleccione la pestaña Configuración.
- En el panel Configuración general, haz clic en Editar.
- Cambia Tiempo de espera a 5 minutos (300 segundos) y haz clic en Guardar.
Crear una programación de EventBridge
- Ve a Amazon EventBridge > Scheduler > Create schedule (Amazon EventBridge > Programador > Crear programación).
- Proporcione los siguientes detalles de configuración:
- Programación periódica: Precio (
1 hour). - Destino: tu función Lambda.
- Nombre:
bitwarden-events-1h.
- Programación periódica: Precio (
- Haz clic en Crear programación.
(Opcional) Crear un usuario y claves de IAM de solo lectura para Google SecOps
- Ve a Consola de AWS > IAM > Usuarios > Añadir usuarios.
- Haz clic en Add users (Añadir usuarios).
- Proporcione los siguientes detalles de configuración:
- Usuario: introduce
secops-reader. - Tipo de acceso: selecciona Clave de acceso > Acceso programático.
- Usuario: introduce
- Haz clic en Crear usuario.
- Asigna una política de lectura mínima (personalizada): Usuarios > lector-secops > Permisos > Añadir permisos > Asignar políticas directamente > Crear política.
- JSON:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["s3:GetObject"],
"Resource": "arn:aws:s3:::<your-bucket>/*"
},
{
"Effect": "Allow",
"Action": ["s3:ListBucket"],
"Resource": "arn:aws:s3:::<your-bucket>"
}
]
}
- Nombre =
secops-reader-policy. - Haz clic en Crear política > busca o selecciona > Siguiente > Añadir permisos.
- Crea una clave de acceso para
secops-reader: Credenciales de seguridad > Claves de acceso > Crear clave de acceso > descarga el archivo.csv(pegarás estos valores en el feed).
Configurar un feed en Google SecOps para ingerir los registros de eventos de Bitwarden Enterprise
- Ve a Configuración de SIEM > Feeds.
- Haz clic en + Añadir nuevo feed.
- En el campo Nombre del feed, introduce un nombre para el feed (por ejemplo,
Bitwarden Events). - Selecciona Amazon S3 V2 como Tipo de fuente.
- Selecciona Eventos de Bitwarden como Tipo de registro.
- Haz clic en Siguiente.
- Especifique los valores de los siguientes parámetros de entrada:
- URI de S3:
s3://bitwarden-events/bitwarden/events/ - Opciones de eliminación de la fuente: selecciona la opción de eliminación que prefieras.
- Antigüedad máxima de los archivos: 180 días de forma predeterminada.
- ID de clave de acceso: clave de acceso de usuario con acceso al bucket de S3.
- Clave de acceso secreta: clave secreta del usuario con acceso al bucket de S3.
- Espacio de nombres de recursos: el espacio de nombres de recursos.
- Etiquetas de ingestión: la etiqueta aplicada a los eventos de este feed.
- URI de S3:
- Haz clic en Siguiente.
- Revise la configuración de su nuevo feed en la pantalla Finalizar y, a continuación, haga clic en Enviar.
Tabla de asignación de UDM
| Campo de registro | Asignación de UDM | Lógica |
|---|---|---|
| actingUserId | target.user.userid | Si enriched.actingUser.userId está vacío o es nulo, este campo se usa para rellenar el campo target.user.userid. |
| collectionID | security_result.detection_fields.key | Rellena el campo key de detection_fields en security_result. |
| collectionID | security_result.detection_fields.value | Rellena el campo value de detection_fields en security_result. |
| fecha | metadata.event_timestamp | Se ha analizado y convertido a un formato de marca de tiempo y se ha asignado a event_timestamp. |
| enriched.actingUser.accessAll | security_result.rule_labels.key | Asigna el valor "Access_All" a rule_labels en security_result. |
| enriched.actingUser.accessAll | security_result.rule_labels.value | Rellena el campo value de rule_labels en security_result con el valor de enriched.actingUser.accessAll convertido en cadena. |
| enriched.actingUser.email | target.user.email_addresses | Rellena el campo email_addresses de target.user. |
| enriched.actingUser.id | metadata.product_log_id | Rellena el campo product_log_id de metadata. |
| enriched.actingUser.id | target.labels.key | Asigna el valor "ID" a target.labels. |
| enriched.actingUser.id | target.labels.value | Rellena el campo value de target.labels con el valor de enriched.actingUser.id. |
| enriched.actingUser.name | target.user.user_display_name | Rellena el campo user_display_name de target.user. |
| enriched.actingUser.object | target.labels.key | Asigna el valor "Object" a target.labels. |
| enriched.actingUser.object | target.labels.value | Rellena el campo value de target.labels con el valor de enriched.actingUser.object. |
| enriched.actingUser.resetPasswordEnrolled | target.labels.key | Asigna el valor "ResetPasswordEnrolled" a target.labels. |
| enriched.actingUser.resetPasswordEnrolled | target.labels.value | Rellena el campo value de target.labels con el valor de enriched.actingUser.resetPasswordEnrolled convertido en cadena. |
| enriched.actingUser.twoFactorEnabled | security_result.rule_labels.key | Asigna el valor "Two Factor Enabled" a rule_labels en security_result. |
| enriched.actingUser.twoFactorEnabled | security_result.rule_labels.value | Rellena el campo value de rule_labels en security_result con el valor de enriched.actingUser.twoFactorEnabled convertido en cadena. |
| enriched.actingUser.userId | target.user.userid | Rellena el campo userid de target.user. |
| enriched.collection.id | additional.fields.key | Asigna el valor "ID de colección" en additional.fields. |
| enriched.collection.id | additional.fields.value.string_value | Rellena el campo string_value de additional.fields con el valor de enriched.collection.id. |
| enriched.collection.object | additional.fields.key | Asigna el valor "Collection Object" a additional.fields. |
| enriched.collection.object | additional.fields.value.string_value | Rellena el campo string_value de additional.fields con el valor de enriched.collection.object. |
| enriched.type | metadata.product_event_type | Rellena el campo product_event_type de metadata. |
| groupId | target.user.group_identifiers | Añade el valor a la matriz group_identifiers de target.user. |
| ipAddress | principal.ip | Se ha extraído la dirección IP del campo y se ha asignado a principal.ip. |
| N/A | extensions.auth | El analizador crea un objeto vacío. |
| N/A | metadata.event_type | Se determina en función de la enriched.type y de la presencia de información sobre principal y target. Valores posibles: USER_LOGIN, STATUS_UPDATE y GENERIC_EVENT. |
| N/A | security_result.action | Se determina en función de la enriched.type. Valores posibles: ALLOW y BLOCK. |
| objeto | additional.fields.key | Asigna el valor "Object" a additional.fields. |
| objeto | additional.fields.value | Rellena el campo value de additional.fields con el valor de object. |
¿Necesitas más ayuda? Recibe respuestas de los miembros de la comunidad y de los profesionales de Google SecOps.