OAuth 2.0 서버 구현

모든 Cloud-to-cloud 통합에는 사용자를 인증하기 위한 메커니즘이 포함되어야 합니다.

인증을 사용하면 사용자의 Google 계정을 인증 시스템의 사용자 계정에 연결할 수 있습니다. 이렇게 하면 처리에서 스마트 홈 인텐트를 수신할 때 사용자를 식별할 수 있습니다. Google 스마트 홈은 승인 코드 흐름이 있는 OAuth만 지원합니다.

이 페이지에서는 Cloud-to-cloud 통합과 호환되도록 OAuth 2.0 서버를 설정하는 방법을 설명합니다.

OAuth를 통한 Google 계정 연결

승인 코드 흐름에는 두 개의 엔드포인트가 필요합니다.

• authorization 엔드포인트: 아직 로그인하지 않은 사용자에게 로그인 UI를 표시합니다. 승인 엔드포인트는 요청된 액세스에 대한 사용자의 동의를 기록하는 단기 승인 코드도 만듭니다.

• 2가지 유형의 교환을 담당하는 토큰 교환 엔드포인트:

  1. 승인 코드를 수명이 긴 갱신 토큰과 단기 액세스 토큰으로 교환합니다. 이러한 교환은 사용자가 계정 연결 과정을 거칠 때 발생합니다.
  2. 수명이 긴 갱신 토큰을 수명이 짧은 액세스 토큰으로 교환합니다. 액세스 토큰이 만료되어 Google에서 새 액세스 토큰이 필요할 때 교환이 발생합니다.

디자인 가이드라인

이 섹션에서는 OAuth 연결 흐름을 호스팅하는 사용자 화면의 설계 요구사항과 권장사항을 설명합니다. Google 앱에서 호출한 후 플랫폼에는 Google 페이지에 로그인 및 사용자에게 동의 화면을 연결하는 계정이 표시됩니다. 사용자가 계정 연결에 동의한 후 Google 앱으로 다시 리디렉션됩니다.

요구사항

1. 사용자의 계정이 Google Home이나 Google 어시스턴트와 같은 특정 Google 제품이 아니라 Google에 연결됨을 알려야 합니다.
2. '로그인하면 Google에서 기기를 제어하도록 승인하는 것으로 간주됩니다.'와 같은 Google 승인 문구가 있어야 합니다. Google Home 개발자 정책의 Google 기기 제어 승인 섹션을 참고하세요.
3. 사용자가 연결하지 않기로 한 경우 뒤로 돌아가거나 취소할 수 있는 방법을 제공해야 합니다.
4. 웹 OAuth 연결 페이지를 열고 사용자에게 사용자 이름 및 비밀번호 필드와 같이 Google 계정에 로그인할 수 있는 명확한 방법이 있는지 확인해야 합니다. 사용자가 웹 OAuth 연결 페이지로 이동하지 않고도 연결할 수 있도록 하는 Google 로그인 (GSI) 방법을 사용해서는 안 됩니다. 이러한 행위는 Google 정책에 위배됩니다.

권장사항

다음을 수행하는 것이 좋습니다.

1. Google 개인정보처리방침을 표시합니다. 동의 화면에 Google 개인정보처리방침 링크를 포함합니다.

2. 공유할 데이터. 명확하고 간결한 표현을 사용하여 Google에 필요한 데이터와 이유를 사용자에게 안내합니다.

3. 명확한 클릭 유도 문구. 동의 화면에 '동의 및 연결'과 같은 명확한 클릭 유도 문구를 명시합니다. 이는 사용자가 계정을 연결하기 위해 Google과 공유해야 하는 데이터를 이해해야 하기 때문입니다.

4. 연결 해제 기능. 플랫폼의 계정 설정으로 연결되는 URL과 같이 사용자가 연결을 해제할 수 있는 메커니즘을 제공합니다. 또는 사용자가 연결된 계정을 관리할 수 있는 Google 계정 링크를 포함할 수 있습니다.

5. 사용자 계정 변경 기능. 사용자가 계정을 전환하는 방법을 제안합니다. 사용자가 여러 계정을 사용하는 경향이 있는 경우 특히 유용합니다.

   • 사용자가 계정을 전환하기 위해 동의 화면을 닫아야 하는 경우 복구 가능한 오류를 Google에 전송하여 사용자가 OAuth 연결을 통해 원하는 계정에 로그인할 수 있도록 합니다.

6. 로고를 포함하세요. 동의 화면에 회사 로고를 표시합니다. 스타일 가이드라인을 사용하여 로고를 배치합니다. Google 로고도 표시하려면 로고 및 상표를 참조하세요.

승인 코드 흐름

승인 코드 흐름의 OAuth 2.0 서버 구현은 서비스에서 HTTPS를 통해 제공하는 두 개의 엔드포인트로 구성됩니다. 첫 번째 엔드포인트는 데이터 액세스에 대한 사용자의 동의를 찾거나 얻는 역할을 하는 승인 엔드포인트입니다. 승인 엔드포인트는 아직 로그인하지 않은 사용자에게 로그인 UI를 표시하고 요청된 액세스에 대한 동의를 기록합니다. 두 번째 엔드포인트는 토큰 교환 엔드포인트로, 사용자가 서비스에 액세스하도록 승인하는 암호화된 문자열(토큰)을 가져오는 데 사용됩니다.

Google 애플리케이션에서 서비스의 API 중 하나를 호출해야 하는 경우 Google은 이러한 엔드포인트를 함께 사용하여 사용자를 대신하여 이러한 API를 호출할 권한을 사용자로부터 받습니다.

Google에서 시작한 OAuth 2.0 승인 코드 흐름 세션은 다음과 같은 흐름을 따릅니다.

1. Google이 사용자의 브라우저에서 승인 엔드포인트를 엽니다. 액션의 음성 전용 기기에서 흐름이 시작된 경우 Google은 실행을 휴대전화로 전송합니다.
2. 사용자가 아직 로그인하지 않은 경우 로그인하고, 아직 권한을 부여하지 않은 경우 Google에 API를 사용하여 사용자의 데이터에 액세스할 권한을 부여합니다.
3. 서비스가 승인 코드를 만들고 Google에 반환합니다. 이렇게 하려면 요청에 승인 코드가 첨부된 상태로 사용자의 브라우저를 Google로 다시 리디렉션합니다.
4. Google은 승인 코드를 토큰 교환 엔드포인트로 전송하고, 이 엔드포인트는 코드의 진위를 확인하고 액세스 토큰 및 갱신 토큰을 반환합니다. 액세스 토큰은 서비스에서 API에 액세스하기 위한 사용자 인증 정보로 허용하는 단기 토큰입니다. 갱신 토큰은 Google에서 저장하고 만료 시 새 액세스 토큰을 획득하는 데 사용할 수 있는 장기 토큰입니다.
5. 사용자가 계정 연결 흐름을 완료하면 Google에서 전송하는 후속 요청마다 액세스 토큰이 포함됩니다.

승인 요청 처리

OAuth 2.0 승인 코드 흐름을 사용하여 계정 연결을 실행해야 하는 경우 Google은 다음 매개변수가 포함된 요청을 사용하여 사용자를 승인 엔드포인트로 전송합니다.

예를 들어 승인 엔드포인트를 https://myservice.example.com/auth에서 사용할 수 있는 경우 요청은 다음과 같이 표시될 수 있습니다.

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

인증 엔드포인트가 로그인 요청을 처리하려면 다음 단계를 따르세요.

1. client_id가 Google에 할당한 클라이언트 ID와 일치하고 redirect_uri가 Google에서 서비스에 제공한 리디렉션 URL과 일치하는지 확인합니다. 이러한 검사는 의도치 않거나 구성이 잘못된 클라이언트 앱에 액세스 권한을 부여하지 않도록 하는 데 중요합니다. 여러 OAuth 2.0 흐름을 지원하는 경우 response_type가 code인지도 확인합니다.
2. 사용자가 서비스에 로그인했는지 확인합니다. 사용자가 로그인하지 않은 경우 서비스의 로그인 또는 가입 절차를 완료합니다.
3. Google에서 API에 액세스하는 데 사용할 승인 코드를 생성합니다. 승인 코드는 어떤 문자열 값이든 될 수 있지만 사용자, 토큰이 사용되는 클라이언트, 코드의 만료 시간을 고유하게 나타내야 하며 추측할 수 없어야 합니다. 일반적으로 약 10분 후에 만료되는 승인 코드를 발급합니다.
4. redirect_uri 매개변수로 지정된 URL의 형식이 다음과 같은지 확인합니다.

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
     https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
     

5. 사용자의 브라우저를 redirect_uri 매개변수로 지정된 URL로 리디렉션합니다. code 및 state 매개변수를 추가하여 리디렉션할 때 방금 생성한 승인 코드와 수정되지 않은 원래 상태 값을 포함합니다. 다음은 결과 URL의 예입니다.

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

토큰 교환 요청 처리

서비스의 토큰 교환 엔드포인트는 다음 두 가지 유형의 토큰 교환을 담당합니다.

• 승인 코드를 액세스 토큰 및 갱신 토큰으로 교환
• 갱신 토큰을 액세스 토큰으로 교환

토큰 교환 요청에는 다음 매개변수가 포함됩니다.

Google에서 서버로 사용자 인증 정보를 전송하는 방식 구성

구현에 따라 승인 서버는 요청 본문 또는 요청 헤더에서 클라이언트 사용자 인증 정보를 수신할 것으로 예상합니다.

기본적으로 Google은 요청 본문에서 사용자 인증 정보를 전송합니다. 승인 서버에 클라이언트 사용자 인증 정보가 요청 헤더에 있어야 하는 경우 Cloud-to-cloud 통합을 적절하게 구성해야 합니다.

Play Console로 이동

1. 프로젝트 목록에서 작업할 프로젝트 옆에 있는 열기를 클릭합니다.

2. Cloud-to-Cloud에서 Develop를 선택합니다.

3. 통합 옆에 있는 열기를 클릭합니다.

4. 권한 (선택사항) 섹션까지 아래로 스크롤하고 Google에서 HTTP 기본 인증 헤더를 통해 클라이언트 ID 및 비밀번호 전송 체크박스를 선택합니다.

5. 저장을 클릭하여 변경사항을 저장합니다.

승인 코드를 액세스 토큰 및 갱신 토큰으로 교환

사용자가 로그인하고 승인 엔드포인트가 Google에 제한된 기간의 승인 코드를 반환하면 Google은 승인 코드를 액세스 토큰 및 갱신 토큰으로 교환하기 위해 토큰 교환 엔드포인트에 요청을 전송합니다.

이러한 요청의 경우 grant_type 값은 authorization_code이고 code 값은 이전에 Google에 부여한 승인 코드의 값입니다. 다음은 승인 코드를 액세스 토큰 및 갱신 토큰으로 교환하는 요청의 예입니다.

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

승인 코드를 액세스 토큰 및 갱신 토큰으로 교환하려면 토큰 교환 엔드포인트가 다음 단계를 실행하여 POST 요청에 응답합니다.

1. client_id가 요청 출처를 승인된 출처로 식별하고 client_secret가 예상 값과 일치하는지 확인합니다.
2. 승인 코드가 유효하고 만료되지 않았는지, 요청에 지정된 클라이언트 ID가 승인 코드와 연결된 클라이언트 ID와 일치하는지 확인합니다.
3. redirect_uri 매개변수로 지정된 URL이 초기 승인 요청에 사용된 값과 동일한지 확인합니다.
4. 위의 모든 기준을 확인할 수 없는 경우 {"error": "invalid_grant"}를 본문으로 사용하여 HTTP 400 잘못된 요청 오류를 반환합니다.
5. 그렇지 않은 경우 승인 코드의 사용자 ID를 사용하여 갱신 토큰과 액세스 토큰을 생성합니다. 이러한 토큰은 어떤 문자열 값이든 될 수 있지만, 토큰이 대상인 사용자와 클라이언트를 고유하게 나타내야 하며 추측할 수 없어야 합니다. 액세스 토큰의 경우 토큰의 만료 시간도 기록합니다. 토큰의 만료 시간은 일반적으로 토큰을 발급한 후 1시간입니다. 갱신 토큰은 만료되지 않습니다.
6. HTTPS 응답 본문에서 다음 JSON 객체를 반환합니다.

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "refresh_token": "REFRESH_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

Google은 사용자의 액세스 토큰과 갱신 토큰을 저장하고 액세스 토큰의 만료를 기록합니다. 액세스 토큰이 만료되면 Google은 갱신 토큰을 사용하여 토큰 교환 엔드포인트에서 새 액세스 토큰을 가져옵니다.

갱신 토큰을 액세스 토큰으로 교환

액세스 토큰이 만료되면 Google은 갱신 토큰을 새 액세스 토큰으로 교환하기 위해 토큰 교환 엔드포인트에 요청을 전송합니다.

이러한 요청의 경우 grant_type의 값은 refresh_token이고 refresh_token의 값은 이전에 Google에 부여한 새로고침 토큰의 값입니다. 다음은 갱신 토큰을 액세스 토큰으로 교환하는 요청의 예시입니다.

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

갱신 토큰을 액세스 토큰으로 교환하려면 토큰 교환 엔드포인트가 다음 단계를 실행하여 POST 요청에 응답합니다.

1. client_id가 요청 출처를 Google로 식별하고 client_secret가 예상 값과 일치하는지 확인합니다.
2. 갱신 토큰이 유효하고 요청에 지정된 클라이언트 ID가 갱신 토큰과 연결된 클라이언트 ID와 일치하는지 확인합니다.
3. 위의 모든 기준을 확인할 수 없는 경우 {"error": "invalid_grant"}를 본문으로 사용하여 HTTP 400 잘못된 요청 오류를 반환합니다.
4. 그러지 않으면 갱신 토큰의 사용자 ID를 사용하여 액세스 토큰을 생성합니다. 이러한 토큰은 어떤 문자열 값이든 될 수 있지만, 토큰이 대상인 사용자와 클라이언트를 고유하게 나타내야 하며 추측할 수 없어야 합니다. 액세스 토큰의 경우 토큰의 만료 시간(일반적으로 토큰을 발급한 후 1시간)도 기록합니다.
5. HTTPS 응답 본문에서 다음 JSON 객체를 반환합니다.

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

사용자 정보 요청 처리

userinfo 엔드포인트는 연결된 사용자에 대한 클레임을 반환하는 OAuth 2.0 보호 리소스입니다. 다음 사용 사례를 제외하고 userinfo 엔드포인트를 구현하고 호스팅하는 것은 선택사항입니다.

• Google 원탭을 사용한 연결된 계정 로그인
• AndroidTV의 원활한 구독

토큰 엔드포인트에서 액세스 토큰을 성공적으로 가져오면 Google은 사용자 정보 엔드포인트에 요청을 보내 연결된 사용자에 대한 기본 프로필 정보를 가져옵니다.

예를 들어 https://myservice.example.com/userinfo인 경우 요청은 다음과 같을 수 있습니다.

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

userinfo 엔드포인트에서 요청을 처리하려면 다음 단계를 수행합니다.

1. 승인 헤더에서 액세스 토큰을 추출하고 액세스 토큰과 연결된 사용자의 정보를 반환합니다.
2. 액세스 토큰이 유효하지 않은 경우 WWW-Authenticate 응답 헤더를 사용하여 HTTP 401 승인되지 않은 오류를 반환합니다. 다음은 userinfo 오류 응답의 예입니다.

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   연결 과정 중에 401 승인되지 않음 또는 기타 실패한 오류 응답이 반환되면 오류는 복구할 수 없으며 검색된 토큰은 삭제되며 사용자는 연결 프로세스를 다시 시작해야 합니다.

3. 액세스 토큰이 유효하면 HTTPS 본문에 다음 JSON 객체가 포함된 HTTP 200 응답을 반환합니다. 응답:

   {
   "sub": "USER_UUID",
   "email": "EMAIL_ADDRESS",
   "given_name": "FIRST_NAME",
   "family_name": "LAST_NAME",
   "name": "FULL_NAME",
   "picture": "PROFILE_PICTURE",
   }
   

   userinfo 엔드포인트가 HTTP 200 성공 응답을 반환하는 경우 가져온 토큰과 클레임은 사용자의 Google 계정에 등록됩니다.

   사용자 정보 엔드포인트 응답
   sub	시스템에서 사용자를 식별하는 고유 ID
   email	사용자의 이메일 주소입니다.
   given_name	선택사항: 사용자의 이름입니다.
   family_name	선택사항: 사용자의 성.
   name	선택사항: 사용자의 전체 이름입니다.
   picture	선택사항: 사용자의 프로필 사진입니다.