감사 이벤트 스키마#

히스토리

• 감사 이벤트 스트리밍 스키마에 대한 문서가 GitLab 15.3에서 도입됨.

감사 이벤트는 응답 본문에 예측 가능한 스키마를 가집니다.

감사 이벤트 JSON 스키마#

{
  "properties": {
    "id": {
      "type": "string"
    },
    "author_id": {
      "type": "integer"
    },
    "author_name": {
      "type": "string"
    },
    "details": {},
    "ip_address": {
      "type": "string"
    },
    "entity_id": {
      "type": "integer"
    },
    "entity_path": {
      "type": "string"
    },
    "entity_type": {
      "type": "string"
    },
    "event_type": {
      "type": "string"
    },
    "target_id": {
      "type": "integer"
    },
    "target_type": {
      "type": "string"
    },
    "target_details": {
      "type": "string"
    },
  },
  "type": "object"
}

헤더#

히스토리

• X-Gitlab-Audit-Event-Type이 GitLab 15.0에서 도입됨.

헤더 형식은 다음과 같습니다:

POST /logs HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
X-Gitlab-Event-Streaming-Token: 
X-Gitlab-Audit-Event-Type: repository_git_operation

예시: Git 작업의 감사 이벤트 스트리밍#

스트리밍 감사 이벤트는 인증된 사용자가 프로젝트의 원격 Git 리포지터리를 푸시, 풀 또는 clone할 때 전송될 수 있습니다:

• SSH 사용.
• HTTP 또는 HTTPS 사용.
• GitLab UI에서 Download ([download]) 사용.

로그인하지 않은 사용자에 대해서는 감사 이벤트가 캡처되지 않습니다. 예를 들어, 공개 프로젝트를 다운로드할 때입니다.

예시: 배포 키를 사용한 SSH over Git 이벤트의 감사 이벤트 페이로드#

Fetch:

{
  "id": "1",
  "author_id": -3,
  "entity_id": 29,
  "entity_type": "Project",
  "details": {
    "author_name": "deploy-key-name",
    "author_class": "DeployKey",
    "target_id": 29,
    "target_type": "Project",
    "target_details": "example-project",
    "custom_message": {
      "protocol": "ssh",
      "action": "git-upload-pack",
      "written_bytes": 1048576,
      "received_bytes": 2048
    },
    "ip_address": "127.0.0.1",
    "entity_path": "example-group/example-project"
  },
  "ip_address": "127.0.0.1",
  "author_name": "deploy-key-name",
  "entity_path": "example-group/example-project",
  "target_details": "example-project",
  "created_at": "2022-07-26T05:43:53.662Z",
  "target_type": "Project",
  "target_id": 29,
  "event_type": "repository_git_operation"
}

custom_message 객체에는 Git 작업의 데이터 전송 크기 필드가 포함됩니다:

• written_bytes: Git 작업 중 클라이언트로 전송된 바이트 수(예: 클론, fetch, 풀 작업 시).

• received_bytes: Git 작업 중 클라이언트로부터 수신된 바이트 수(예: 푸시 작업 시).

이러한 필드는 데이터가 전송되지 않은 경우(예: 데이터 교환 전에 요청이 실패하는 경우)에는 생략됩니다.