OAuth 2.0 서버 구현

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

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

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

OAuth를 사용한 Google 계정 연결

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

• The token exchange endpoint, which is responsible for two types of exchanges:

  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

Requirements

1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.
2. You must have a Google authorization statement such as "By signing in, you are authorizing Google to control your devices." See the Google Device Control Authorization section of the Google Home Developer Policies.
3. You must open the Web OAuth linking page and ensure users have a clear method for signing in to their Google Account, such as fields for their username and password. Don't use the Google Sign-In (GSI) method that enables users to link without being taken to the Web OAuth Linking page. It is a violation of Google policy.
4. You must include at least one of the following items in the OAuth linking page to indicate the integration to which the user is linking:
   • Company logo
   • Company name
   • Integration name
   • App icon

Recommendations

We recommend that you do the following:

1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

5. Clear sign-in process. Ensure that users have a clear method for signing in to their Google Account, such as fields for their username and password or Sign in with Google.

6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

   • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking.

8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

승인 코드 흐름

승인 코드 흐름의 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

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

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. 클라우드 간에서 개발을 선택합니다.

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	선택사항: 사용자의 프로필 사진입니다.