Snyk 그룹 수준 감사 로그 수집

다음에서 지원:

Google secops SIEM

이 문서에서는 Google Cloud Storage를 사용하여 Snyk 그룹 수준 감사 로그를 Google Security Operations에 수집하는 방법을 설명합니다. 파서는 먼저 원시 로그에서 불필요한 필드를 정리합니다. 그런 다음 사용자 세부정보, 이벤트 유형, 타임스탬프와 같은 관련 정보를 추출하여 표준화된 보안 로그 표현을 위해 Google SecOps UDM 스키마로 변환하고 매핑합니다.

시작하기 전에

다음 기본 요건이 충족되었는지 확인합니다.

Google SecOps 인스턴스
Cloud Storage API가 사용 설정된 GCP 프로젝트
GCS 버킷을 만들고 관리할 수 있는 권한
GCS 버킷의 IAM 정책을 관리할 수 있는 권한
Cloud Run 서비스, Pub/Sub 주제, Cloud Scheduler 작업을 만들 수 있는 권한
Snyk에 대한 권한 액세스 (그룹 관리자) 및 그룹에 액세스할 수 있는 API 토큰
Snyk Enterprise 요금제 (감사 로그 엔드포인트는 Enterprise 요금제에서만 사용 가능)

Snyk 그룹 수준 감사 로그 필수사항 (ID, API 키, 조직 ID, 토큰) 수집

Snyk에서 아바타 > 계정 설정 > API 토큰을 클릭합니다.
취소 및 재생성 (또는 생성)을 클릭하고 토큰을 복사합니다.
이 토큰을 SNYK_API_TOKEN 환경 변수로 저장합니다.
Snyk에서 그룹으로 전환합니다 (왼쪽 상단의 전환기).
그룹 설정으로 이동합니다.
URL(https://app.snyk.io/group/<GROUP_ID>/settings)에서 <GROUP_ID>을 복사합니다.
- 또는 REST API(GET https://api.snyk.io/rest/groups?version=2024-01-04)를 사용하여 id을 선택합니다.
토큰 사용자에게 감사 로그 보기 (group.audit.read) 권한이 있는지 확인합니다.

권한 확인

계정에 필요한 권한이 있는지 확인하려면 다음 단계를 따르세요.

Snyk에 로그인합니다.
그룹으로 전환합니다 (왼쪽 상단의 전환기).
그룹 설정으로 이동합니다.
왼쪽 탐색 메뉴에 감사 로그 옵션이 표시되면 필요한 권한이 있는 것입니다.
이 옵션이 표시되지 않으면 관리자에게 문의하여 감사 로그 보기 (group.audit.read) 권한을 부여받으세요.

참고: 감사 로그 엔드포인트에는 Snyk Enterprise 요금제가 필요합니다. 올바르게 구성했는데도 API 호출이 403 오류와 함께 실패하는 경우 구독 수준을 확인하세요.

API 액세스 테스트

통합을 진행하기 전에 사용자 인증 정보를 테스트하세요.

# Replace with your actual credentials
SNYK_API_TOKEN="your-token-here"
SNYK_GROUP_ID="your-group-id-here"
SNYK_API_VERSION="2024-01-04"

# Test API access
curl -v -H "Authorization: token ${SNYK_API_TOKEN}" \
  "https://api.snyk.io/rest/groups/${SNYK_GROUP_ID}/audit_logs/search?version=${SNYK_API_VERSION}&size=10"

Google Cloud Storage 버킷 만들기

Google Cloud Console로 이동합니다.
프로젝트를 선택하거나 새 프로젝트를 만듭니다.
탐색 메뉴에서 Cloud Storage> 버킷으로 이동합니다.
버킷 만들기를 클릭합니다.

다음 구성 세부정보를 제공합니다.

설정	값
버킷 이름 지정	전역적으로 고유한 이름 (예: `snyk-audit`)을 입력합니다.
위치 유형	필요에 따라 선택 (리전, 이중 리전, 멀티 리전)
위치	위치를 선택합니다 (예: `us-central1`).
스토리지 클래스	Standard (자주 액세스하는 로그에 권장)
액세스 제어	균일 (권장)
보호 도구	선택사항: 객체 버전 관리 또는 보관 정책 사용 설정

만들기를 클릭합니다.

Cloud Run 함수의 서비스 계정 만들기

Cloud Run 함수에는 GCS 버킷에 쓸 수 있고 Pub/Sub에서 호출할 수 있는 권한이 있는 서비스 계정이 필요합니다.

서비스 계정 만들기

GCP 콘솔에서 IAM 및 관리자 > 서비스 계정으로 이동합니다.
서비스 계정 만들기를 클릭합니다.
다음 구성 세부정보를 제공합니다.
- 서비스 계정 이름: snyk-audit-collector-sa을 입력합니다.
- 서비스 계정 설명: Service account for Cloud Run function to collect Snyk group-level audit logs을 입력합니다.
만들고 계속하기를 클릭합니다.
이 서비스 계정에 프로젝트에 대한 액세스 권한 부여 섹션에서 다음 역할을 추가합니다.
1. 역할 선택을 클릭합니다.
2. 스토리지 객체 관리자를 검색하여 선택합니다.
3. + 다른 역할 추가를 클릭합니다.
4. Cloud Run 호출자를 검색하여 선택합니다.
5. + 다른 역할 추가를 클릭합니다.
6. Cloud Functions 호출자를 검색하여 선택합니다.
계속을 클릭합니다.
완료를 클릭합니다.

이러한 역할은 다음 작업에 필요합니다.

스토리지 객체 관리자: GCS 버킷에 로그를 쓰고 상태 파일을 관리합니다.
Cloud Run 호출자: Pub/Sub가 함수를 호출하도록 허용
Cloud Functions 호출자: 함수 호출 허용

GCS 버킷에 대한 IAM 권한 부여

GCS 버킷에 대한 쓰기 권한을 서비스 계정에 부여합니다.

Cloud Storage> 버킷으로 이동합니다.
버킷 이름 (예: snyk-audit)을 클릭합니다.
권한 탭으로 이동합니다.
액세스 권한 부여를 클릭합니다.
다음 구성 세부정보를 제공합니다.
- 주 구성원 추가: 서비스 계정 이메일 (예: snyk-audit-collector-sa@PROJECT_ID.iam.gserviceaccount.com)을 입력합니다.
- 역할 할당: 스토리지 객체 관리자를 선택합니다.
저장을 클릭합니다.

게시/구독 주제 만들기

Cloud Scheduler가 게시하고 Cloud Run 함수가 구독할 Pub/Sub 주제를 만듭니다.

GCP Console에서 Pub/Sub > 주제로 이동합니다.
주제 만들기를 클릭합니다.
다음 구성 세부정보를 제공합니다.
- 주제 ID: snyk-audit-trigger를 입력합니다.
- 다른 설정은 기본값으로 둡니다.
만들기를 클릭합니다.

로그를 수집하는 Cloud Run 함수 만들기

Cloud Run 함수는 Cloud Scheduler의 Pub/Sub 메시지에 의해 트리거되어 Snyk API에서 로그를 가져오고 GCS에 기록합니다.

GCP 콘솔에서 Cloud Run으로 이동합니다.
서비스 만들기를 클릭합니다.
함수를 선택합니다 (인라인 편집기를 사용하여 함수 만들기).
구성 섹션에서 다음 구성 세부정보를 제공합니다.

설정 값

서비스 이름 snyk-audit-collector

리전 GCS 버킷과 일치하는 리전을 선택합니다 (예: us-central1).

런타임 Python 3.12 이상 선택
트리거 (선택사항) 섹션에서 다음을 수행합니다.
1. + 트리거 추가를 클릭합니다.
2. Cloud Pub/Sub를 선택합니다.
3. Cloud Pub/Sub 주제 선택에서 Pub/Sub 주제 (snyk-audit-trigger)를 선택합니다.
4. 저장을 클릭합니다.
인증 섹션에서 다음을 구성합니다.
1. 인증 필요를 선택합니다.
2. ID 및 액세스 관리 (IAM)를 확인합니다.
참고: 함수를 호출할 때 Pub/Sub에서 자동으로 인증을 처리합니다.
아래로 스크롤하고 컨테이너, 네트워킹, 보안을 펼칩니다.
보안 탭으로 이동합니다.
- 서비스 계정: 서비스 계정 (snyk-audit-collector-sa)을 선택합니다.

설정	값
서비스 이름	`snyk-audit-collector`
리전	GCS 버킷과 일치하는 리전을 선택합니다 (예: `us-central1`).
런타임	Python 3.12 이상 선택

컨테이너 탭으로 이동합니다.

변수 및 보안 비밀을 클릭합니다.
각 환경 변수에 대해 + 변수 추가를 클릭합니다.

변수 이름	예시 값
`GCS_BUCKET`	`snyk-audit`
`GCS_PREFIX`	`snyk/audit/`
`STATE_KEY`	`snyk/audit/state.json`
`SNYK_GROUP_ID`	`<your_group_id>`
`SNYK_API_TOKEN`	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
`SNYK_API_BASE`	`https://api.snyk.io`(선택사항)
`SNYK_API_VERSION`	`2024-01-04`
`SIZE`	`100`
`MAX_PAGES`	`20`
`LOOKBACK_SECONDS`	`3600`
`EVENTS`	(선택사항) `group.create,org.user.add`
`EXCLUDE_EVENTS`	(선택사항) `api.access`

변수 및 보안 비밀 섹션에서 요청까지 아래로 스크롤합니다.
- 요청 제한 시간: 600초 (10분)를 입력합니다.
설정 탭으로 이동합니다.
- 리소스 섹션에서 다음을 수행합니다.
  - 메모리: 512MiB 이상을 선택합니다.
  - CPU: 1을 선택합니다.
버전 확장 섹션에서 다음을 수행합니다.
- 최소 인스턴스 수: 0를 입력합니다.
- 최대 인스턴스 수: 100을 입력합니다 (또는 예상 부하에 따라 조정).
만들기를 클릭합니다.
서비스가 생성될 때까지 기다립니다 (1~2분).
서비스가 생성되면 인라인 코드 편집기가 자동으로 열립니다.

함수 코드 추가

함수 진입점에 main을 입력합니다.

인라인 코드 편집기에서 다음 두 파일을 만듭니다.

첫 번째 파일: main.py:

import functions_framework
from google.cloud import storage
import json
import os
import urllib3
from datetime import datetime, timezone
import time
import urllib.parse

# Initialize HTTP client
http = urllib3.PoolManager()

# Initialize Storage client
storage_client = storage.Client()

@functions_framework.cloud_event
def main(cloud_event):
    """
    Cloud Run function triggered by Pub/Sub to fetch Snyk group-level audit logs and write to GCS.

    Args:
        cloud_event: CloudEvent object containing Pub/Sub message
    """

    # Get environment variables
    bucket_name = os.environ.get('GCS_BUCKET')
    prefix = os.environ.get('GCS_PREFIX', 'snyk/audit/')
    state_key = os.environ.get('STATE_KEY', 'snyk/audit/state.json')

    # Snyk API configuration
    api_base = os.environ.get('SNYK_API_BASE', 'https://api.snyk.io').rstrip('/')
    group_id = os.environ.get('SNYK_GROUP_ID', '').strip()
    api_token = os.environ.get('SNYK_API_TOKEN', '').strip()
    api_version = os.environ.get('SNYK_API_VERSION', '2024-01-04').strip()

    size = int(os.environ.get('SIZE', '100'))
    max_pages = int(os.environ.get('MAX_PAGES', '20'))
    lookback_seconds = int(os.environ.get('LOOKBACK_SECONDS', '3600'))

    events_csv = os.environ.get('EVENTS', '').strip()
    exclude_events_csv = os.environ.get('EXCLUDE_EVENTS', '').strip()

    if not all([bucket_name, group_id, api_token]):
        print('Error: Missing required environment variables')
        return

    try:
        # Get GCS bucket
        bucket = storage_client.bucket(bucket_name)

        # Load state (last cursor)
        state = load_state(bucket, state_key)
        cursor = state.get('cursor')

        print(f'Starting log collection with cursor: {cursor}')

        # Prepare headers for Snyk REST API
        headers = {
            'Authorization': f'token {api_token}',
            'Accept': 'application/vnd.api+json'
        }

        pages = 0
        total = 0
        last_cursor = cursor

        # Only for the very first run (no saved cursor), constrain the time window
        first_run_from_iso = None
        if not cursor and lookback_seconds > 0:
            first_run_from_iso = time.strftime(
                '%Y-%m-%dT%H:%M:%SZ',
                time.gmtime(time.time() - lookback_seconds)
            )

        while pages < max_pages:
            payload = fetch_page(
                api_base, group_id, headers, api_version, size,
                cursor, first_run_from_iso, events_csv, exclude_events_csv
            )

            # Write payload to GCS
            write_to_gcs(bucket, prefix, payload)

            # Extract items count
            data_obj = payload.get('data') or {}
            items = data_obj.get('items') or []
            if isinstance(items, list):
                total += len(items)

            # Parse next cursor
            cursor = parse_next_cursor_from_links(payload.get('links'))
            pages += 1

            if not cursor:
                break

            # After first page, disable from-filter
            first_run_from_iso = None

        # Save state
        if cursor and cursor != last_cursor:
            save_state(bucket, state_key, {'cursor': cursor})

        print(f'Successfully processed {total} events across {pages} pages. Next cursor: {cursor}')

    except Exception as e:
        print(f'Error processing logs: {str(e)}')
        raise

def load_state(bucket, key):
    """Load state from GCS."""
    try:
        blob = bucket.blob(key)
        if blob.exists():
            state_data = blob.download_as_text()
            return json.loads(state_data)
    except Exception as e:
        print(f'Warning: Could not load state: {str(e)}')
    return {}

def save_state(bucket, key, state):
    """Save state to GCS."""
    try:
        blob = bucket.blob(key)
        blob.upload_from_string(
            json.dumps(state),
            content_type='application/json'
        )
    except Exception as e:
        print(f'Warning: Could not save state: {str(e)}')

def write_to_gcs(bucket, prefix, payload):
    """Write payload to GCS."""
    ts = time.strftime('%Y/%m/%d/%H%M%S', time.gmtime())
    key = f"{prefix.rstrip('/')}/{ts}-snyk-group-audit.json"
    blob = bucket.blob(key)
    blob.upload_from_string(
        json.dumps(payload, separators=(',', ':')),
        content_type='application/json'
    )
    print(f'Wrote payload to {key}')

def parse_next_cursor_from_links(links):
    """Parse next cursor from links object."""
    if not links:
        return None
    nxt = links.get('next')
    if not nxt:
        return None
    try:
        q = urllib.parse.urlparse(nxt).query
        params = urllib.parse.parse_qs(q)
        cur = params.get('cursor')
        return cur[0] if cur else None
    except Exception:
        return None

def as_list(csv_str):
    """Convert comma-separated string to list."""
    return [x.strip() for x in csv_str.split(',') if x.strip()]

def fetch_page(api_base, group_id, headers, api_version, size, cursor, first_run_from_iso, events_csv, exclude_events_csv):
    """Fetch a single page from Snyk audit logs API."""
    base_path = f'/rest/groups/{group_id}/audit_logs/search'
    params = {
        'version': api_version,
        'size': size,
    }

    if cursor:
        params['cursor'] = cursor
    elif first_run_from_iso:
        params['from'] = first_run_from_iso

    events = as_list(events_csv)
    exclude_events = as_list(exclude_events_csv)

    if events and exclude_events:
        exclude_events = []

    if events:
        params['events'] = events
    if exclude_events:
        params['exclude_events'] = exclude_events

    url = f"{api_base}{base_path}?{urllib.parse.urlencode(params, doseq=True)}"

    response = http.request('GET', url, headers=headers, timeout=60.0)

    if response.status == 429 or response.status >= 500:
        retry_after = int(response.headers.get('Retry-After', '1'))
        time.sleep(max(1, retry_after))
        response = http.request('GET', url, headers=headers, timeout=60.0)

    if response.status != 200:
        raise Exception(f'API request failed with status {response.status}: {response.data.decode("utf-8")}')

    return json.loads(response.data.decode('utf-8'))

두 번째 파일: requirements.txt:

functions-framework==3.*
google-cloud-storage==2.*
urllib3>=2.0.0

배포를 클릭하여 함수를 저장하고 배포합니다.
배포가 완료될 때까지 기다립니다 (2~3분).

참고: Pub/Sub 트리거 구성은 필요한 구독과 권한을 자동으로 만듭니다.

Cloud Scheduler 작업 만들기

Cloud Scheduler는 일정 간격으로 Pub/Sub 주제에 메시지를 게시하여 Cloud Run 함수를 트리거합니다.

GCP Console에서 Cloud Scheduler로 이동합니다.
작업 만들기를 클릭합니다.

다음 구성 세부정보를 제공합니다.

설정	값
이름	`snyk-audit-collector-hourly`
리전	Cloud Run 함수와 동일한 리전 선택
주파수	`0 * * * *` (매시간 정각)
시간대	시간대 선택 (UTC 권장)
타겟 유형	Pub/Sub
주제	Pub/Sub 주제 (`snyk-audit-trigger`)를 선택합니다.
메일 본문	`{}`

만들기를 클릭합니다.

일정 빈도 옵션

로그 볼륨 및 지연 시간 요구사항에 따라 빈도를 선택합니다.

빈도	크론 표현식	사용 사례
5분마다	`/5 * * *`	대용량, 저지연
15분마다	`/15 * * *`	검색량 보통
1시간마다	`0 * * * *`	일반(권장)
6시간마다	`0 /6 * *`	양이 적은 일괄 처리
매일	`0 0 * * *`	이전 데이터 수집

통합 테스트

Cloud Scheduler 콘솔에서 작업을 찾습니다 (snyk-audit-collector-hourly).
강제 실행을 클릭하여 작업을 수동으로 트리거합니다.
몇 초 동안 기다립니다.
Cloud Run > 서비스로 이동합니다.
함수 이름 (snyk-audit-collector)을 클릭합니다.
로그 탭을 클릭합니다.

함수가 성공적으로 실행되었는지 확인합니다. 다음을 확인하세요.

Starting log collection with cursor: None
Page 1: Retrieved X events
Wrote payload to snyk/audit/YYYY/MM/DD/HHMMSS-snyk-group-audit.json
Successfully processed X events across Y pages. Next cursor: ...

Cloud Storage> 버킷으로 이동합니다.
버킷 이름 (예: snyk-audit)을 클릭합니다.
접두사 폴더 (snyk/audit/)로 이동합니다.
현재 타임스탬프를 사용하여 새 .json 파일이 생성되었는지 확인합니다.

로그에 오류가 표시되면 다음 단계를 따르세요.

HTTP 401: 환경 변수에서 SNYK_API_TOKEN 확인
HTTP 403: 토큰 사용자에게 group.audit.read 권한이 있고 Snyk 구독이 Enterprise 요금제인지 확인합니다.
HTTP 429: 비율 제한 - 함수가 백오프를 사용하여 자동으로 재시도됩니다.
환경 변수 누락: 필수 변수가 모두 설정되어 있는지 확인합니다 (GCS_BUCKET, SNYK_GROUP_ID, SNYK_API_TOKEN).

Google SecOps 서비스 계정 가져오기

Google SecOps는 고유한 서비스 계정을 사용하여 GCS 버킷에서 데이터를 읽습니다. 이 서비스 계정에 버킷에 대한 액세스 권한을 부여해야 합니다.

서비스 계정 이메일 가져오기

SIEM 설정> 피드로 이동합니다.
새 피드 추가를 클릭합니다.
단일 피드 구성을 클릭합니다.
피드 이름 필드에 피드 이름을 입력합니다(예: Snyk Group Audit Logs).
소스 유형으로 Google Cloud Storage V2를 선택합니다.
로그 유형으로 Snyk 그룹 수준 감사 로그를 선택합니다.
서비스 계정 가져오기를 클릭합니다. 고유한 서비스 계정 이메일이 표시됩니다. 예를 들면 다음과 같습니다.
```
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
```
다음 단계에서 사용할 수 있도록 이 이메일 주소를 복사합니다.

참고: 각 Google SecOps 인스턴스에는 고유한 서비스 계정이 있습니다. 다른 문서나 예시의 서비스 계정을 사용하지 마세요.

Google SecOps 서비스 계정에 IAM 권한 부여

Google SecOps 서비스 계정에는 GCS 버킷에 대한 스토리지 객체 뷰어 역할이 필요합니다.

Cloud Storage> 버킷으로 이동합니다.
버킷 이름 (예: snyk-audit)을 클릭합니다.
권한 탭으로 이동합니다.
액세스 권한 부여를 클릭합니다.
다음 구성 세부정보를 제공합니다.
- 주 구성원 추가: Google SecOps 서비스 계정 이메일을 붙여넣습니다.
- 역할 할당: 스토리지 객체 뷰어를 선택합니다.
저장을 클릭합니다.

참고: '전송된 파일 삭제' 또는 '전송된 파일 및 빈 디렉터리 삭제' 삭제 옵션을 사용하려면 스토리지 객체 뷰어 대신 스토리지 객체 관리자 역할을 부여하세요.

Snyk 그룹 수준 감사 로그를 수집하도록 Google SecOps에서 피드 구성

SIEM 설정> 피드로 이동합니다.
새 피드 추가를 클릭합니다.
단일 피드 구성을 클릭합니다.
피드 이름 필드에 피드 이름을 입력합니다(예: Snyk Group Audit Logs).
소스 유형으로 Google Cloud Storage V2를 선택합니다.
로그 유형으로 Snyk 그룹 수준 감사 로그를 선택합니다.
다음을 클릭합니다.
다음 입력 매개변수의 값을 지정합니다.
- 스토리지 버킷 URL: 다음 접두사 경로를 사용하여 GCS 버킷 URI를 입력합니다.
```
gs://snyk-audit/snyk/audit/
```
  - 다음과 같이 바꿉니다.
    - snyk-audit: GCS 버킷 이름입니다.
    - snyk/audit/: 로그가 저장되는 접두사/폴더 경로입니다.
  참고: 항상 URI 끝에 후행 슬래시 (/)를 포함하세요.
- 소스 삭제 옵션: 환경설정에 따라 삭제 옵션을 선택합니다.
  - 삭제 안함: 전송 후 파일을 삭제하지 않습니다 (테스트에 권장).
  - 전송된 파일 삭제: 전송이 완료되면 파일을 삭제합니다.
  - 전송된 파일 및 빈 디렉터리 삭제: 전송이 완료되면 파일과 빈 디렉터리를 삭제합니다.
    
    참고: 삭제 옵션을 선택하는 경우 서비스 계정에는 스토리지 객체 뷰어 대신 스토리지 객체 관리자 역할이 있어야 합니다. 이에 따라 IAM 권한을 업데이트합니다.
- 최대 파일 기간: 지난 일수 동안 수정된 파일을 포함합니다. 기본값은 180일입니다.
- 애셋 네임스페이스: snyk.group_audit
- 수집 라벨: 원하는 경우 추가합니다.
다음을 클릭합니다.
확정 화면에서 새 피드 구성을 검토한 다음 제출을 클릭합니다.

UDM 매핑 테이블

로그 필드	UDM 매핑	로직
content.url	principal.url	원시 로그의 content.url 필드에서 직접 매핑됩니다.
생성됨	metadata.event_timestamp	ISO8601 형식을 사용하여 원시 로그의 생성된 필드에서 파싱됩니다.
이벤트	metadata.product_event_type	원시 로그의 이벤트 필드에서 직접 매핑됩니다.
groupId	principal.user.group_identifiers	원시 로그의 groupId 필드에서 직접 매핑됩니다.
orgId	principal.user.attribute.labels.key	'orgId'로 설정합니다.
orgId	principal.user.attribute.labels.value	원시 로그의 orgId 필드에서 직접 매핑됩니다.
userId	principal.user.userid	원시 로그의 userId 필드에서 직접 매핑됩니다.
해당 사항 없음	metadata.event_type	파서 코드에서 'USER_UNCATEGORIZED'로 하드코딩됩니다.
해당 사항 없음	metadata.log_type	파서 코드에서 'SNYK_SDLC'로 하드코딩됩니다.
해당 사항 없음	metadata.product_name	파서 코드에서 'SNYK SDLC'로 하드코딩됩니다.
해당 사항 없음	metadata.vendor_name	파서 코드에서 'SNYK_SDLC'로 하드코딩됩니다.

도움이 더 필요한가요? 커뮤니티 회원 및 Google SecOps 전문가에게 문의하여 답변을 받으세요.