이 페이지는 Cloud Translation API를 통해 번역되었습니다.

OAuth 2.0 서버 구현

모든 smart home 작업에는 사용자 인증을 위한 메커니즘이 포함되어야 합니다.

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

이 페이지에서는 smart home 작업과 호환되도록 OAuth 2.0 서버를 설정하는 방법을 설명합니다.

승인 코드 흐름

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

Google 애플리케이션이 서비스의 API 중 하나를 호출해야 할 때 Google은 이러한 엔드포인트를 함께 사용하여 사용자 대신 이러한 API를 호출할 권한을 가져옵니다.

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

Google이 사용자의 브라우저에서 승인 엔드포인트를 엽니다. 흐름의 작업이 음성 전용 기기에서 시작된 경우 Google은 실행을 전화로 전송합니다.
아직 로그인하지 않았다면 사용자가 로그인하여 API에 데이터에 대한 액세스 권한을 Google에 부여합니다(아직 권한을 부여하지 않은 경우).
서비스에서 승인 코드를 생성하여 Google에 반환합니다. 이렇게 하려면 요청에 연결된 승인 코드를 사용하여 사용자의 브라우저를 다시 Google로 리디렉션합니다.
Google에서 토큰 교환 엔드포인트로 승인 코드를 전송하여 코드의 신뢰성을 확인하고 액세스 토큰과 갱신 토큰을 반환합니다. 액세스 토큰은 서비스가 API에 액세스하기 위해 사용자 인증 정보로 허용하는 단기 토큰입니다. 갱신 토큰은 Google에서 저장 후 만료 시 새 액세스 토큰을 획득하는 데 사용할 수 있는 수명이 긴 토큰입니다.
사용자가 계정 연결 흐름을 완료하면 Google에서 보낸 모든 후속 요청에 액세스 토큰이 포함됩니다.

승인 요청 처리

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

승인 엔드포인트 매개변수
`client_id`	Google에 할당한 클라이언트 ID
`redirect_uri`	이 요청에 대한 응답을 보내는 URL입니다.
`state`	리디렉션 URI에서 변경되지 않고 Google에 다시 전달되는 부기 값입니다.
`scope`	선택사항: Google에서 승인을 요청하는 데이터를 지정하는 공백으로 구분된 범위 문자열 집합입니다.
`response_type`	응답에서 반환할 값의 유형입니다. OAuth 2.0 승인 코드 흐름의 경우 응답 유형은 항상 `code`입니다.
`user_locale`	RFC5646 형식의 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

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

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

redirect_uri 매개변수로 지정된 URL의 형식이

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

인지 확인합니다.

사용자의 브라우저를 redirect_uri 매개변수로 지정된 URL로 리디렉션합니다. code 및 state 매개변수를 추가하여 리디렉션 시 방금 생성한 승인 코드와 수정되지 않은 원래 상태 값을 포함합니다. 다음은 최종 URL의 예입니다.
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
```

토큰 교환 요청 처리

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

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

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

토큰 교환 엔드포인트 매개변수
`client_id`	요청 출처를 Google로 식별하는 문자열입니다. 이 문자열은 시스템 내에서 Google의 고유 식별자로 등록되어 있어야 합니다.
`client_secret`	서비스에 사용하기 위해 Google에 등록한 보안 비밀 문자열입니다.
`grant_type`	교환되는 토큰의 유형입니다. `authorization_code` 또는 `refresh_token`입니다.
`code`	`grant_type=authorization_code`인 경우 이 매개변수는 Google이 로그인 또는 토큰 교환 엔드포인트에서 수신한 코드입니다.
`redirect_uri`	`grant_type=authorization_code`인 경우 이 매개변수는 초기 승인 요청에 사용된 URL입니다.
`refresh_token`	`grant_type=refresh_token`인 경우 이 매개변수는 Google이 토큰 교환 엔드포인트에서 수신한 갱신 토큰입니다.

액세스 토큰 및 갱신 토큰의 승인 코드 교환

사용자가 로그인하고 승인 엔드포인트가 단기 승인 코드를 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 요청에 응답합니다.

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

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 요청에 응답합니다.

client_id가 요청 출처를 Google로 식별하고 client_secret이 예상 값과 일치하는지 확인합니다.
갱신 토큰이 유효하고 요청에 지정된 클라이언트 ID가 갱신 토큰과 연결된 클라이언트 ID와 일치하는지 확인합니다.
위의 모든 기준을 확인할 수 없는 경우 {"error": "invalid_grant"}을 본문으로 사용하여 HTTP 400 Bad Request 오류를 반환합니다.
그렇지 않은 경우 갱신 토큰의 사용자 ID를 사용하여 액세스 토큰을 생성합니다. 이러한 토큰은 모든 문자열 값이 될 수 있지만, 토큰이 존재하는 사용자와 클라이언트를 고유하게 나타내야 하며 추측이 가능해서는 안 됩니다. 액세스 토큰의 경우에도 일반적으로 토큰 발급 1시간 후에 토큰의 만료 시간을 기록합니다.

HTTPS 응답 본문에서 다음 JSON 객체를 반환합니다.

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

Handle userinfo requests

The userinfo endpoint is an OAuth 2.0 protected resource that return claims about the linked user. Implementing and hosting the userinfo endpoint is optional, except for the following use cases:

Linked Account Sign-In with Google One Tap.
Frictionless subscription on AndroidTV.

After the access token has been successfully retrieved from your token endpoint, Google sends a request to your userinfo endpoint to retrieve basic profile information about the linked user.

userinfo endpoint request headers
`Authorization header`	The access token of type Bearer.

For example, if your userinfo endpoint is available at https://myservice.example.com/userinfo, a request might look like the following:

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

For your userinfo endpoint to handle requests, do the following steps:

Extract access token from the Authorization header and return information for the user associated with the access token.
If the access token is invalid, return an HTTP 401 Unauthorized error with using the WWW-Authenticate Response Header. Below is an example of a userinfo error response:
```
HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
```
If a 401 Unauthorized, or any other unsuccessful error response is returned during the linking process, the error will be non-recoverable, the retrieved token will be discarded and the user will have to initiate the linking process again.

If the access token is valid, return and HTTP 200 response with the following JSON object in the body of the HTTPS response:

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

If your userinfo endpoint returns an HTTP 200 success response, the retrieved token and claims are registered against the user's Google account.

userinfo endpoint response
`sub`	A unique ID that identifies the user in your system.
`email`	Email address of the user.
`given_name`	Optional: First name of the user.
`family_name`	Optional: Last name of the user.
`name`	Optional: Full name of the user.
`picture`	Optional: Profile picture of the user.

개발자 체크리스트

작업 프로젝트 만들기