GitHub에서 비밀 관리

Completed

비밀은 조직, 리포지토리 또는 리포지토리 환경에서 만드는 변수입니다. 비밀은 GitHub Actions 워크플로에서 사용할 수 있습니다. GitHub Actions는 워크플로에 비밀을 명시적으로 포함하는 경우에만 비밀을 읽을 수 있습니다.

조직 수준에서 저장된 비밀의 경우 액세스 정책을 사용하여 조직 비밀을 사용할 수 있는 리포지토리를 제어할 수 있습니다. 조직 수준 비밀을 통해 여러 리포지토리 간에 비밀을 공유할 수 있습니다. 이렇게 하면 중복된 비밀을 만들 필요가 줄어듭니다. 또한 한 위치에서 조직 비밀을 업데이트하면 해당 비밀을 사용하는 모든 리포지토리 워크플로에서 변경 내용이 적용됩니다.

환경 수준에서 저장된 비밀의 경우 필요한 검토자가 비밀에 대한 액세스를 제어하도록 설정할 수 있습니다. 필요한 승인자가 승인하지 않는 한 워크플로 작업은 환경 비밀에 액세스할 수 없습니다.

비고

리소스에 액세스하기 위해 Azure에 직접 인증하도록 워크플로를 구성할 수 있습니다.

비밀 이름 지정

비밀 이름에는 다음 규칙이 적용됩니다.

  • 이름은 영숫자 문자([a-z], [A-Z], [0-9]) 또는 밑줄(_)만 포함할 수 있습니다. 공백이 없어야 합니다.
  • 이름은 접두사 GITHUB_ 로 시작해서는 안됩니다.
  • 이름은 숫자로 시작해서는 안됩니다.
  • 이름은 대/소문자를 구분하지 않습니다.
  • 이름은 설정된 레벨에서 고유해야 합니다.

GitHub가 로그에서 비밀을 수정하도록 하려면 구조화된 데이터를 비밀 값으로 사용하지 않도록 합니다. 예를 들어 JSON 또는 인코딩된 Git BLOB을 포함하는 비밀을 만들지 마세요.

비밀에 액세스

작업을 사용할 수 있도록 워크플로 파일에서 비밀을 입력 또는 환경 변수로 설정합니다. 파일을 편집할 수 있는 액세스 권한이 있는 경우 워크플로 파일에서 비밀을 사용하고 읽을 수 있습니다. 자세한 내용은 GitHub의 액세스 권한을 참조하세요.

워크플로 실행이 큐에 대기되면 조직 및 리포지토리 비밀을 읽고 환경을 참조하는 작업이 시작될 때 환경 비밀을 읽습니다. REST API를 사용하여 비밀을 관리할 수도 있습니다.

자격 증명 권한 제한

가능한 최소 권한을 부여하는 것이 좋습니다. 예를 들어 개인 자격 증명을 사용하는 대신 배포 키 또는 서비스 계정을 사용합니다. 필요한 모든 경우 읽기 전용 권한을 부여하고 가능한 한 액세스를 제한하는 것이 좋습니다.

개인 액세스 토큰(클래식)을 생성할 때 필요한 가장 적은 범위를 선택합니다. 세분화된 개인용 액세스 토큰을 생성할 때 필요한 최소 권한 및 리포지토리 액세스를 선택합니다.

비밀 만들기

개인 계정 리포지토리에 대한 GitHub에서 비밀 또는 변수를 만들려면 리포지토리 소유자여야 합니다. GitHub에서 조직 리포지토리에 대한 비밀 또는 변수를 만들려면 admin 액세스 권한이 있어야 합니다. 마지막으로 REST API를 통해 개인 계정 리포지토리 또는 조직 리포지토리에 대한 비밀 또는 변수를 만들려면 공동 작업자 액세스 권한이 있어야 합니다.

비밀은 다음을 통해 만들 수 있습니다.

  • 리포지토리의 위쪽 탐색 모음에서 설정을 선택합니다.
  • 왼쪽 탐색의 보안 섹션에서 비밀 및 변수 드롭다운을 선택합니다.
  • 작업을 선택하여 작업 비밀 및 변수 페이지에 접근합니다.

워크플로에서 비밀 사용

입력 또는 환경 변수로 비밀을 사용하여 작업을 제공하려면 컨텍스트를 secrets 사용하여 리포지토리에서 만든 비밀에 액세스할 수 있습니다. 다음 코드는 워크플로의 비밀에 액세스하는 예제를 보여 있습니다.

steps:
  - name: Hello world action
    with: # Set the secret as an input
      super_secret: ${{ secrets.SuperSecret }}
    env: # Or as an environment variable
      super_secret: ${{ secrets.SuperSecret }}

비밀은 if: 조건 문에서 직접 참조할 수 없습니다. 비밀을 작업 수준 환경 변수로 설정한 다음 환경 변수를 참조하여 작업의 단계를 조건부로 실행하는 것이 좋습니다.

비밀 값이 설정되지 않은 경우 예제와 같이 ${{ secrets.SuperSecret }} 비밀을 참조하는 식의 반환 값은 빈 문자열입니다.