배포 파일에 API 키가 포함되었다 본문

KISHelper

배포 파일에 API 키가 포함되었다

miensoap 2024. 8. 4. 12:05

GitHub 레포지토리에 등록한 이슈

 

Personal API key is included in the distribution files!!! · Issue #1 · Miensoap/KISHelper

Resolve issue where personal API key is included in the distribution files Revoke the exposed API key Modify the build script to exclude the file containing the API key

github.com

 

문제

세 번의 배포를 마친 후 코드를 수정하다가, 작은 오류가 발생해 이전 버전을 테스트하기 위해 프로젝트에 추가했다.

dependencies {
    implementation 'io.github.miensoap:KISHelper:0.2.2'
}

 

인텔리제이 기능인 External Librarys 를 이용해 코드를 확인하던 중,  개인 API 키가 포함되어 있음을 발견.

 

image

 

확인해보니, 첫 번째 배포시에는 해당 파일을 잘 지우고 빌드해 포함되지 않았지만, 
개발중에 해당 파일과 Main 클래스를 사용해 테스트 하다보니, 깜빡 잊고 삭제하지 않아

두 번째 세 번째 배포시에는  모두 포함되어 배포된 것이었다.

 

해결

sourceSets {
    main {
        java {
            exclude "**/Main.java"
        }
        resources {
            exclude "**"
        }
    }
}


노출된 API 키는 급히 폐기하였고, 위 코드를 `build.gradle` 에 추가하여 빌드시에 해당 파일들을 제외하도록 했다.

 

얼마 되지 않아 이전 버전을 확인할 오류가 생김, 평소에 사용하던 인텔리제이 기능이 빠른 해결에 큰 도움이 되었다.

단순히 GitHub이나 git을 이용해 소스 코드를 확인했다면, 언제 이 문제를 알아차렸을지 알 수 없었을 것이다.