Defining custom patterns for secret scanning

Defining a custom pattern with Copilot

You can use Copilot 비밀 스캔 to generate regular expressions based on a text description of the type of pattern you would like to detect, including optional example strings that should be detected. See Copilot의 비밀 검사를 활용하여 사용자 지정 패턴에 맞는 정규식을 생성합니다..

Defining a custom pattern for a repository

Before defining a custom pattern, you must ensure that Secret Protection is enabled on your repository. For more information, see Enabling secret scanning for your repository.

1. GitHub에서 리포지토리의 기본 페이지로 이동합니다.

2. 리포지토리 이름 아래에서 Settings를 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.

   

3. 사이드바의 "Security" 섹션에서 Advanced Security 를 클릭합니다.

4. Under "Secret Protection", to the right of "Custom patterns", click New pattern.

5. 새 사용자 지정 패턴에 대한 세부 정보를 입력합니다. 적어도 패턴의 이름과 비밀 패턴 형식에 대한 정규식을 제공해야 합니다.

   1. "패턴 이름" 필드에 패턴 이름을 입력합니다.
   2. "비밀 형식" 필드에 비밀 패턴 형식에 대한 정규식을 입력합니다.
   3. 기타 옵션 을 클릭하여 다른 주변 콘텐츠나 비밀 형식에 대한 추가 일치 요구 사항을 제공할 수 있습니다. 사용자 지정 패턴 참조을(를) 참조하세요.
   4. 구성이 예상하는 패턴과 일치하는지 확인하는 샘플 테스트 문자열을 제공합니다.
   

6. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click Save and dry run.

7. 시험 실행이 완료되면 결과 샘플(최대 1,000개)이 표시됩니다. 결과를 검토하고 가양성 결과를 식별합니다.

   

8. 새 사용자 지정 패턴을 편집하여 결과와 관련한 문제를 해결합니다. 변경 내용을 테스트하려면 저장 및 시험 실행을 클릭합니다.

9. 새 사용자 지정 패턴에 만족하면 게시 패턴을 클릭합니다.

10. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

    참고

    The "Enable" button isn't available until after the dry run succeeds and you publish the pattern.

After your pattern is created, secret scanning은 GitHub 리포지토리에 있는 모든 분기에서 전체 Git 기록의 비밀을 검색합니다. For more information on viewing 비밀 검사 경고, see 비밀 검사 경고 관리.

Defining a custom pattern for an organization

Before defining a custom pattern, you must ensure that you enable secret scanning for the repositories that you want to scan in your organization. You can use security configurations to enable secret scanning on all repositories in your organization. For more information, see Enabling security features at scale.

1. GitHub의 오른쪽 위 모서리에서 프로필 사진을 클릭한 다음, Your organizations를 클릭합니다.

2. 조직을 클릭하여 선택합니다.

3. 조직 이름에서 설정을 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.

   

4. In the "Security" section of the sidebar, select the Advanced Security dropdown menu, then click Global settings.

5. "사용자 지정 패턴"에서 새 패턴을 클릭합니다.

6. 새 사용자 지정 패턴에 대한 세부 정보를 입력합니다. 적어도 패턴의 이름과 비밀 패턴 형식에 대한 정규식을 제공해야 합니다.

   1. "패턴 이름" 필드에 패턴 이름을 입력합니다.
   2. "비밀 형식" 필드에 비밀 패턴 형식에 대한 정규식을 입력합니다.
   3. 기타 옵션 을 클릭하여 다른 주변 콘텐츠나 비밀 형식에 대한 추가 일치 요구 사항을 제공할 수 있습니다. 사용자 지정 패턴 참조을(를) 참조하세요.
   4. 구성이 예상하는 패턴과 일치하는지 확인하는 샘플 테스트 문자열을 제공합니다.
   

7. When you're ready to test your new custom pattern, to identify matches in select repositories without creating alerts, click Save and dry run.

8. 시험 실행을 수행할 리포지토리를 선택합니다.

   • 조직 전체에 대한 시험 실행을 수행하려면 조직의 모든 리포지토리를 선택합니다.
   • 시험 실행을 수행할 리포지토리를 지정하려면 선택한 리포지토리를 선택한 다음 최대 10개의 리포지토리를 검색하여 선택합니다.

9. 새 사용자 지정 패턴을 테스트할 준비가 되면 실행을 클릭합니다.

10. 시험 실행이 완료되면 결과 샘플(최대 1,000개)이 표시됩니다. 결과를 검토하고 가양성 결과를 식별합니다.

    

11. 새 사용자 지정 패턴을 편집하여 결과와 관련한 문제를 해결합니다. 변경 내용을 테스트하려면 저장 및 시험 실행을 클릭합니다.

12. 새 사용자 지정 패턴에 만족하면 게시 패턴을 클릭합니다.

13. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

    참고

    • 푸시 보호를 사용하는 옵션은 게시된 패턴에 대해서만 표시됩니다.
    • 사용자 지정 패턴에 대한 푸시 보호는 푸시 보호가 사용하도록 설정된 secret scanning이(가) 있는 조직의 리포지토리에만 적용됩니다.
    • 일반적으로 발견되는 사용자 지정 패턴에 푸시 보호를 사용하도록 설정하면 기여자에 방해가 될 수 있습니다.

After your pattern is created, secret scanning scans for any secrets in repositories in your organization, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found and can review the alert in the repository where the secret is found. For more information on viewing 비밀 검사 경고, see 비밀 검사 경고 관리.

Defining a custom pattern for an enterprise account

1. 귀하의 기업으로 이동하세요. 예를 들어 GitHub.com의 Enterprises 페이지에서.

2. 페이지 상단에서 정책을 클릭합니다.

3. "정책"에서 Advanced SecurityCode security 를 클릭합니다.

4. Under "Advanced SecurityCode security", click Security features.

5. Under "Secret scanning custom patterns", click New pattern.

6. 새 사용자 지정 패턴에 대한 세부 정보를 입력합니다. 적어도 패턴의 이름과 비밀 패턴 형식에 대한 정규식을 제공해야 합니다.

   1. "패턴 이름" 필드에 패턴 이름을 입력합니다.
   2. "비밀 형식" 필드에 비밀 패턴 형식에 대한 정규식을 입력합니다.
   3. 기타 옵션 을 클릭하여 다른 주변 콘텐츠나 비밀 형식에 대한 추가 일치 요구 사항을 제공할 수 있습니다. 사용자 지정 패턴 참조을(를) 참조하세요.
   4. 구성이 예상하는 패턴과 일치하는지 확인하는 샘플 테스트 문자열을 제공합니다.
   

7. When you're ready to test your new custom pattern, to identify matches in the enterprise without creating alerts, click Save and dry run.

8. 시험 실행을 수행할 리포지토리를 최대 10개까지 검색하여 선택합니다.

9. 새 사용자 지정 패턴을 테스트할 준비가 되면 실행을 클릭합니다.

10. 시험 실행이 완료되면 결과 샘플(최대 1,000개)이 표시됩니다. 결과를 검토하고 가양성 결과를 식별합니다.

    

11. 새 사용자 지정 패턴을 편집하여 결과와 관련한 문제를 해결합니다. 변경 내용을 테스트하려면 저장 및 시험 실행을 클릭합니다.

12. 새 사용자 지정 패턴에 만족하면 게시 패턴을 클릭합니다.

13. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

    참고

    • 사용자 지정 패턴에 푸시 보호를 사용하도록 설정하려면 엔터프라이즈 수준에서 푸시 보호로 secret scanning을(를) 사용하도록 설정해야 합니다.
    • 일반적으로 발견되는 사용자 지정 패턴에 푸시 보호를 사용하도록 설정하면 기여자에 방해가 될 수 있습니다.

After your pattern is created, secret scanning scans for any secrets in repositories within your organizations with GitHub Secret Protection enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing 비밀 검사 경고, see 비밀 검사 경고 관리.