Recolha registos do Citrix Analytics

Compatível com:

Google secops SIEM

Nota: esta funcionalidade está abrangida pelos Termos das Ofertas de Pré-DG dos Termos Específicos do serviço Google Security Operations. As funcionalidades de pré-DG podem ter suporte limitado e as alterações às funcionalidades de pré-DG podem não ser compatíveis com outras versões de pré-DG. Para mais informações, consulte as diretrizes dos serviços de apoio técnico do Google SecOps e os Termos Específicos dos Serviços do Google SecOps.

Este documento explica como carregar registos do Citrix Analytics para o Google Security Operations através do Amazon S3.

Antes de começar

Certifique-se de que tem os seguintes pré-requisitos:

• Instância do Google SecOps
• Acesso privilegiado ao inquilino do Citrix Analytics for Performance
• Acesso privilegiado à AWS (S3, IAM, Lambda, EventBridge)

Recolha os pré-requisitos do Citrix Analytics

1. Inicie sessão na Citrix Cloud Console.
2. Aceda a Identity and Access Management > Acesso à API.
3. Clique em Criar cliente.
4. Copie e guarde numa localização segura os seguintes detalhes:
   • ID de cliente
   • Segredo do cliente
   • ID de cliente (localizado no URL do Citrix Cloud ou na página do IAM)
   • URL base da API: https://api.cloud.com/casodata

Configure o contentor do AWS S3 e o IAM para o Google SecOps

1. Crie um contentor do Amazon S3 seguindo este manual do utilizador: Criar um contentor
2. Guarde o nome e a região do contentor para referência futura (por exemplo, citrix-analytics-logs).
3. Crie um utilizador seguindo este guia do utilizador: Criar um utilizador do IAM.
4. Selecione o utilizador criado.
5. Selecione o separador Credenciais de segurança.
6. Clique em Criar chave de acesso na secção Chaves de acesso.
7. Selecione Serviço de terceiros como o Exemplo de utilização.
8. Clicar em Seguinte.
9. Opcional: adicione uma etiqueta de descrição.
10. Clique em Criar chave de acesso.
11. Clique em Transferir ficheiro CSV para guardar a chave de acesso e a chave de acesso secreta para utilização posterior.
12. Clique em Concluído.
13. Selecione o separador Autorizações.
14. Clique em Adicionar autorizações na secção Políticas de autorizações.
15. Selecione Adicionar autorizações.
16. Selecione Anexar políticas diretamente
17. Pesquise e selecione a política AmazonS3FullAccess.
18. Clicar em Seguinte.
19. Clique em Adicionar autorizações.

Configure a política e a função de IAM para carregamentos do S3

1. Na consola da AWS, aceda a IAM > Políticas > Criar política > separador JSON.

2. Introduza a seguinte política:

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Sid": "AllowPutObjects",
         "Effect": "Allow",
         "Action": "s3:PutObject",
         "Resource": "arn:aws:s3:::citrix-analytics-logs/*"
       },
       {
         "Sid": "AllowGetStateObject",
         "Effect": "Allow",
         "Action": "s3:GetObject",
         "Resource": "arn:aws:s3:::citrix-analytics-logs/citrix_analytics/state.json"
       }
     ]
   }
   

   • Substitua citrix-analytics-logs se tiver introduzido um nome de contentor diferente.

3. Clique em Seguinte > Criar política.

4. Aceda a IAM > Funções > Criar função > Serviço AWS > Lambda.

5. Anexe a política criada recentemente.

6. Dê o nome CitrixAnalyticsLambdaRole à função e clique em Criar função.

Crie a função Lambda

1. Na consola da AWS, aceda a Lambda > Functions > Create function.
2. Clique em Criar do zero.

3. Faculte os seguintes detalhes de configuração:

   Definição	Valor
   Nome	CitrixAnalyticsCollector
   Runtime	Python 3.13
   Arquitetura	x86_64
   Função de execução	CitrixAnalyticsLambdaRole

4. Depois de criar a função, abra o separador Código, elimine o fragmento e introduza o seguinte código (CitrixAnalyticsCollector.py):

   import os
   import json
   import uuid
   import datetime
   import urllib.parse
   import urllib.request
   import boto3
   import botocore
   
   CITRIX_TOKEN_URL_TMPL = "https://api.cloud.com/cctrustoauth2/{customerid}/tokens/clients"
   DEFAULT_API_BASE = "https://api.cloud.com/casodata"
   
   s3 = boto3.client("s3")
   
   def _http_post_form(url, data_dict):
       """POST form data to get authentication token."""
       data = urllib.parse.urlencode(data_dict).encode("utf-8")
       req = urllib.request.Request(url, data=data, headers={
           "Accept": "application/json",
           "Content-Type": "application/x-www-form-urlencoded",
       })
       with urllib.request.urlopen(req, timeout=30) as response:
           return json.loads(response.read().decode("utf-8"))
   
   def _http_get_json(url, headers):
       """GET JSON data from API endpoint."""
       req = urllib.request.Request(url, headers=headers)
       with urllib.request.urlopen(req, timeout=60) as response:
           return json.loads(response.read().decode("utf-8"))
   
   def get_citrix_token(customer_id, client_id, client_secret):
       """Get Citrix Cloud authentication token."""
       url = CITRIX_TOKEN_URL_TMPL.format(customerid=customer_id)
       payload = {
           "grant_type": "client_credentials",
           "client_id": client_id,
           "client_secret": client_secret,
       }
       token_response = _http_post_form(url, payload)
       return token_response["access_token"]
   
   def fetch_odata_entity(entity, when_utc, top, headers, api_base):
       """Fetch data from Citrix Analytics OData API with pagination."""
       year = when_utc.year
       month = when_utc.month
       day = when_utc.day
       hour = when_utc.hour
   
       base_url = f"{api_base.rstrip('/')}/{entity}?year={year:04d}&month={month:02d}&day={day:02d}&hour={hour:02d}"
       skip = 0
   
       while True:
           url = f"{base_url}&$top={top}&$skip={skip}"
           data = _http_get_json(url, headers)
           items = data.get("value", [])
   
           if not items:
               break
   
           for item in items:
               yield item
   
           if len(items) < top:
               break
   
           skip += top
   
   def read_state_file(bucket, state_key):
       """Read the last processed timestamp from S3 state file."""
       try:
           obj = s3.get_object(Bucket=bucket, Key=state_key)
           content = obj["Body"].read().decode("utf-8")
           state = json.loads(content)
           timestamp_str = state.get("last_hour_utc")
           if timestamp_str:
               return datetime.datetime.fromisoformat(timestamp_str.replace("Z", "+00:00")).replace(tzinfo=None)
       except botocore.exceptions.ClientError as e:
           if e.response["Error"]["Code"] == "NoSuchKey":
               return None
           raise
       return None
   
   def write_state_file(bucket, state_key, dt_utc):
       """Write the current processed timestamp to S3 state file."""
       state_data = {"last_hour_utc": dt_utc.isoformat() + "Z"}
       s3.put_object(
           Bucket=bucket, 
           Key=state_key,
           Body=json.dumps(state_data, separators=(",", ":")),
           ContentType="application/json"
       )
   
   def write_ndjson_to_s3(bucket, key, records):
       """Write records as NDJSON to S3."""
       body_lines = []
       for record in records:
           json_line = json.dumps(record, separators=(",", ":"), ensure_ascii=False)
           body_lines.append(json_line)
   
       body = ("n".join(body_lines) + "n").encode("utf-8")
       s3.put_object(
           Bucket=bucket, 
           Key=key, 
           Body=body, 
           ContentType="application/x-ndjson"
       )
   
   def lambda_handler(event, context):
       """Main Lambda handler function."""
   
       # Environment variables
       bucket = os.environ["S3_BUCKET"]
       prefix = os.environ.get("S3_PREFIX", "").strip("/")
       state_key = os.environ.get("STATE_KEY") or f"{prefix}/state.json"
       customer_id = os.environ["CITRIX_CUSTOMER_ID"]
       client_id = os.environ["CITRIX_CLIENT_ID"]
       client_secret = os.environ["CITRIX_CLIENT_SECRET"]
       api_base = os.environ.get("API_BASE", DEFAULT_API_BASE)
       entities = [e.strip() for e in os.environ.get("ENTITIES", "sessions,machines,users").split(",") if e.strip()]
       top_n = int(os.environ.get("TOP_N", "1000"))
       lookback_minutes = int(os.environ.get("LOOKBACK_MINUTES", "75"))
   
       # Determine target hour to collect
       now = datetime.datetime.utcnow()
       fallback_target = (now - datetime.timedelta(minutes=lookback_minutes)).replace(minute=0, second=0, microsecond=0)
   
       last_processed = read_state_file(bucket, state_key)
       if last_processed:
           target_hour = last_processed + datetime.timedelta(hours=1)
       else:
           target_hour = fallback_target
   
       # Get authentication token
       token = get_citrix_token(customer_id, client_id, client_secret)
       headers = {
           "Authorization": f"CwsAuth bearer={token}",
           "Citrix-CustomerId": customer_id,
           "Accept": "application/json",
           "Content-Type": "application/json",
       }
   
       total_records = 0
   
       # Process each entity type
       for entity in entities:
           records = []
   
           for row in fetch_odata_entity(entity, target_hour, top_n, headers, api_base):
               enriched_record = {
                   "citrix_entity": entity,
                   "citrix_hour_utc": target_hour.isoformat() + "Z",
                   "collection_timestamp": datetime.datetime.utcnow().isoformat() + "Z",
                   "raw": row
               }
               records.append(enriched_record)
   
               # Write in batches to avoid memory issues
               if len(records) >= 1000:
                   s3_key = f"{prefix}/{entity}/year={target_hour.year:04d}/month={target_hour.month:02d}/day={target_hour.day:02d}/hour={target_hour.hour:02d}/part-{uuid.uuid4().hex}.ndjson"
                   write_ndjson_to_s3(bucket, s3_key, records)
                   total_records += len(records)
                   records = []
   
           # Write remaining records
           if records:
               s3_key = f"{prefix}/{entity}/year={target_hour.year:04d}/month={target_hour.month:02d}/day={target_hour.day:02d}/hour={target_hour.hour:02d}/part-{uuid.uuid4().hex}.ndjson"
               write_ndjson_to_s3(bucket, s3_key, records)
               total_records += len(records)
   
       # Update state file
       write_state_file(bucket, state_key, target_hour)
   
       return {
           "statusCode": 200,
           "body": json.dumps({
               "success": True,
               "hour_collected": target_hour.isoformat() + "Z",
               "records_written": total_records,
               "entities_processed": entities
           })
       }
   

5. Aceda a Configuração > Variáveis de ambiente > Editar > Adicionar nova variável de ambiente.

6. Introduza as seguintes variáveis de ambiente, substituindo-as pelos seus valores:

   Chave	Valor de exemplo
   S3_BUCKET	citrix-analytics-logs
   S3_PREFIX	citrix_analytics
   STATE_KEY	citrix_analytics/state.json
   CITRIX_CLIENT_ID	your-client-id
   CITRIX_CLIENT_SECRET	your-client-secret
   API_BASE	https://api.cloud.com/casodata
   CITRIX_CUSTOMER_ID	your-customer-id
   ENTITIES	sessions,machines,users
   TOP_N	1000
   LOOKBACK_MINUTES	75

7. Depois de criar a função, permaneça na respetiva página (ou abra Lambda > Functions > CitrixAnalyticsCollector).

8. Selecione o separador Configuração.

9. No painel Configuração geral, clique em Editar.

10. Altere Tempo limite para 5 minutos (300 segundos) e clique em Guardar.

    Nota: o limite de tempo é um limite superior rígido, o que significa que, se a função ainda estiver em execução quando o temporizador atingir os 5 minutos, o AWS Lambda termina-a. Qualquer execução mais curta termina normalmente. Só lhe é cobrado o tempo de execução real.

Crie um horário do EventBridge

1. Aceda a Amazon EventBridge > Scheduler > Create schedule.
2. Indique os seguintes detalhes de configuração:
   • Horário recorrente: Taxa (1 hour)
   • Alvo: a sua função Lambda CitrixAnalyticsCollector
   • Nome: CitrixAnalyticsCollector-1h
3. Clique em Criar programação.

Opcional: crie um utilizador e chaves da IAM só de leitura para o Google SecOps

1. Na consola da AWS, aceda a IAM > Utilizadores > Adicionar utilizadores.
2. Clique em Adicionar utilizadores.
3. Indique os seguintes detalhes de configuração:
   • Utilizador: secops-reader
   • Tipo de acesso: chave de acesso – acesso programático
4. Clique em Criar utilizador.
5. Anexe a política de leitura mínima (personalizada): Users > secops-reader > Permissions > Add permissions > Attach policies directly > Create policy.

6. No editor JSON, introduza a seguinte política:

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": ["s3:GetObject"],
         "Resource": "arn:aws:s3:::citrix-analytics-logs/*"
       },
       {
         "Effect": "Allow",
         "Action": ["s3:ListBucket"],
         "Resource": "arn:aws:s3:::citrix-analytics-logs"
       }
     ]
   }
   

7. Defina o nome como secops-reader-policy.

8. Aceda a Criar política > pesquise/selecione > Seguinte > Adicionar autorizações.

9. Aceda a Credenciais de segurança > Chaves de acesso > Criar chave de acesso.

10. Transfira o CSV (estes valores são introduzidos no feed).

Configure um feed no Google SecOps para carregar registos do Citrix Analytics

1. Aceda a Definições do SIEM > Feeds.
2. Clique em + Adicionar novo feed.
3. No campo Nome do feed, introduza um nome para o feed (por exemplo, Citrix Analytics Performance logs).
4. Selecione Amazon S3 V2 como o Tipo de origem.
5. Selecione Citrix Analytics como o Tipo de registo.
6. Clicar em Seguinte.
7. Especifique valores para os seguintes parâmetros de entrada:
   • URI do S3: s3://citrix-analytics-logs/citrix_analytics/
   • Opções de eliminação de origens: selecione a opção de eliminação de acordo com a sua preferência.
   • Idade máxima do ficheiro: inclua ficheiros modificados no último número de dias. Predefinição de 180 dias.
   • ID da chave de acesso: chave de acesso do utilizador com acesso ao contentor do S3.
   • Chave de acesso secreta: chave secreta do utilizador com acesso ao contentor do S3.
   • Espaço de nomes do recurso: o espaço de nomes do recurso.
   • Etiquetas de carregamento: a etiqueta aplicada aos eventos deste feed.
8. Clicar em Seguinte.
9. Reveja a nova configuração do feed no ecrã Finalizar e, de seguida, clique em Enviar.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.