Google OAuth 2.0 시스템은 웹 어플리케이션과 구글 서비스간의 통신과 같은 서버간 통신을 지원합니다. 이러한 시나리오를 위해서는 개별 최종 사용자 대신에 당신의 어플리케이션에 속하는 서비스 계정(Service Account)가 필요합니다. 당신의 어플리케이션은 서비스 계정을 이용하여 구글 API를 호출할 수 있으며 이 경우 사용자가 직접적으로 연관되지 않습니다. 이 시나리오는 “Two-Legged OAuth” 또는 “2LO”로 불립니다. (비슷한 용어로 “Three-Legged OAuth”의 경우에는 최종 사용자가 구글 API를 호출하는 경우를 말하며 이때에 권한 요청 화면이 뜰 수 있습니다)
일반적으로, 어플리케이션이 구글 API를 호출할 때 사용자의 정보보다는 어플리케이션 자체의 정보를 가지고 작업할 때 서비스 계정을 사용합니다. 예를 들어 데이터를 영구적으로 저장하기 위해 Google Cloud Datastore를 사용하는 어플리케이션이 있다면 서비스 계정을 사용하여 인증하여 사용할 수 있습니다.
Google Apps의 도에인 관리자를 이용하면 도메인의 유저들을 대표하여 사용자 정보에 접근할 수 있는 전체 도메인 권한을 부여할 수 있습니다. 이 문서에서는 어플리케이션이 Google APIs 클라이언트 라이브러리 또는 HTTP를 이용하여 OAuth 2.0 서버간(Server to Server) 호출을 하는 방법에 대해 정리합니다.
개요
서버간 상호작용을 지원하기 위해서 먼저 개발자 콘솔에 있는 당신의 프로젝트의 서비스 계정을 만들어야 합니다. 만약 당신이 Google Apps 도메인 내의 사용자 정보에 접근하고자 한다면 도메인 전체(domain-wide) 접근 권한을 서비스 어카운트에 부여해야 합니다.
그다음 당신의 어플리케이션이 OAuth 2.0 인증 서버로부터 엑세스토큰을 요청하기 위해 서비스 계정 자격을 이용하여 인증 API 요청을 만듭니다.
마지막으로 당신의 어플리케이션은 구글 API를 호출할 수 있는 엑세스토큰을 사용할 수 있게 됩니다.
추천 : 당신의 어플리케이션은 이러한 작업을 당신이 사용하는 언어에 적절한 구글 API 클라이언트 라이브러리를 사용하거나 HTTP를 직접 이용하여 OAuth 2.0 시스템과 통신하는 방법을 사용할 수 있습니다. 하지만 서버간 통신을 통한 인증 과정에서 암호화 사인이 된 JSON Web Tokens (JWTs)를 만들어 사용하게 되고 이 부분에서 당신의 어플리케이션의 보안에 치명적인 영향을 끼칠 수 있는 심각한 에러가 발생하기 쉽습니다.
이런 이유로 우리는 구글 API 클라이언트 라이브러리를 사용하여 당신의 어플리케이션 코드에서 암호화 관련 처리를 신경쓰지 않기를 강력하게 추천합니다.
서비스 계정 만들기
서비스 계정 자격은 유니크하게 생성된 이메일주소(email address)와 최소한 한개의 공개/비밀 키쌍(public/private key pair)이 포함됩니다. 만약에 도메인 전체 위임을 활성화 한다면 클라이언트 아이디(client id) 역시 서비스 계정 자격에 포함되어야 합니다.
당신의 어플리케이션이 구글 앱 엔진(Google App Engine)에서 돌아간다면 서비스 계정은 당신의 프로젝트가 생성될 때 자동으로 설정됩니다.
만약 당신의 어플리케이션이 구글 컴퓨트 엔진(Google Compute Engine)에서 돌아간다면 프로젝트 생성시 서비스 계정은 자동으로 설정되지만 어플리케이션이 접근하고자 하는 접근 범위(Scope)를 정의해 주어야 합니다. [참고]
당신의 어플리케이션이 구글 앱엔진 또는 구글 컴퓨트엔진 에서 동작하지 않는다면 구글 개발자 콘솔에서 이러한 자격을 획득하여야 합니다. 서비스 계정 자격을 생성하기 위해서, 혹은 이미 생성된 공개된 자격을 보기 위해서는 다음을 수행합니다.
- 개발자 콘솔 권한(Permission) 페이지의 서비스 계정 섹션(Service accounts section)에 진입합니다.
2. 서비스 계정 만들기 버튼을 누릅니다.
3. 서비스 계정 만들기 창에서 서비스 계정의 이름을 입력하고, 새 비공개 키 제공을 선택합니다. 만약 구글 앱스 도메인 전체 인증을 허용하려면 Google Apps 도메인 전체 위임 사용을 체크하시면 됩니다. 그리고 만들기를 클릭합니다.
당신의 새로운 공개/비공개 키 쌍이 생성되며 당신의 컴퓨터에 다운로드 됩니다. 이것은 단 하나의 복사본이기에 당신은 안전하게 이 키를 보관할 의무가 있습니다.
당신은 언제든지 이 개발자 콘솔에 돌아와서 이메일 주소, 키 ID와 같은 정보를 확인할 수 있습니다. 또는 추가로 공개/비공개 키를 생성할 수 있습니다. 개발자 콘솔에서의 서비스 계정 자격에 대한 더 자세한 내용은 [참고]를 확인해주세요.
서비스 계정의 이메일 주소를 적어놓고 서비스 계정의 P12 비밀키 파일을 당신의 어플리케이션이 접근할 수 있는 위치에 저장하십시오. 당신의 어플리케이션이 인증 API 호출을 만드는데 이것들이 필요합니다.
참고 : 당신은 개발 환경과 프로덕션 환경 모두에서 이 비밀키를 안전하게 보관하고 관리해야 합니다. 구글은 당신의 비밀키의 복사본을 보관하지 않습니다. 단지 공개키만을 가지고 있습니다.
인증 API 호출을 준비하기
구글에서는 구글 API 호출을 위한 라이브러리로 Java를 비롯한 다양한 언어를 지원하고 있습니다. [참고]를 확인해주세요.
구글 개발자 콘솔에서 이메일 주소와 비밀키를 획득한 뒤 JAVA용 구글 API 클라이언트 라이브러리를 이용하여 서비스 계정 자격 및 어플리케이션이 엑세스를 원하는 범위를 정의하는 GoogleCredential을 생성합니다.
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.sqladmin.SQLAdminScopes;
// ...
String emailAddress = "123456789000-abc123def456@developer.gserviceaccount.com";
JsonFactory JSON_FACTORY = JacksonFactory.getDefaultInstance();
HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
GoogleCredential credential = new GoogleCredential.Builder()
.setTransport(httpTransport)
.setJsonFactory(JSON_FACTORY)
.setServiceAccountId(emailAddress)
.setServiceAccountPrivateKeyFromP12File(new File("MyProject.p12"))
.setServiceAccountScopes(Collections.singleton(SQLAdminScopes.SQLSERVICE_ADMIN))
.build();
만약 도메인 전체 위임을 포함한 서비스 어카운트이고 특정 유저로 가장하여 사용하고 싶을 경우 GoogleCredential 팩토리의 setServiceAccountUser 메소드를 사용하여 사용자 계정의 이메일 주소를 특정해 주시기 바랍니다.
GoogleCredential credential = new GoogleCredential.Builder()
.setTransport(httpTransport)
.setJsonFactory(JSON_FACTORY)
.setServiceAccountId(emailAddress)
.setServiceAccountPrivateKeyFromP12File(new File("MyProject.p12"))
.setServiceAccountScopes(Collections.singleton(SQLAdminScopes.SQLSERVICE_ADMIN))
.setServiceAccountUser("user@example.com")
.build();
이제 이렇게 만들어진 GoogleCredential 객체를 사용하여 당신의 어플리케이션에서 구글 API를 호출할 수 있습니다.
구글 API 호출
GoogleCredential 객체를 사용하여 구글 API를 다음과 같은 방법으로 호출할 수 있습니다.
1. GoogleCredential 객체를 사용하여 당신이 사용하고자 하는 API의 서비스 객체를 생성합니다.
SQLAdmin sqladmin =
new SQLAdmin.Builder(httpTransport, JSON_FACTORY, credential).build();
2. 서비스 객체가 제공하는 인터페이스를 사용하여 원하는 API의 요청을 생성합니다. 예를 들어 exciting-example-123 프로젝트의 클라우드 SQL 데이터베이스에 존재하는 리스트를 불러오는 코드는 다음과 같습니다.
SQLAdmin.Instances.List instances =
sqladmin.instances().list("exciting-example-123").execute();
