모든 smart home 작업에는 사용자를 인증하는 메커니즘이 포함되어야 합니다.
인증을 사용하면 사용자의 Google 계정을 인증 시스템의 사용자 계정과 연결할 수 있습니다. 이를 통해 처리가 스마트 홈 인텐트를 수신할 때 사용자를 식별할 수 있습니다. Google 스마트 홈은 승인 코드 흐름에서만 OAuth를 지원합니다.
이 페이지에서는 OAuth 2.0 서버가 smart home 작업과 함께 작동하도록 설정하는 방법을 설명합니다.
OAuth를 사용한 Google 계정 연결
승인 코드 흐름에는 두 개의 엔드포인트가 필요합니다.
authorization 엔드포인트: 아직 로그인하지 않은 사용자에게 로그인 UI를 표시합니다. 승인 엔드포인트는 요청된 액세스에 대한 사용자의 동의를 기록하는 단기 승인 코드도 만듭니다.
2가지 유형의 교환을 담당하는 토큰 교환 엔드포인트:
- 승인 코드를 수명이 긴 갱신 토큰과 단기 액세스 토큰으로 교환합니다. 이러한 교환은 사용자가 계정 연결 과정을 거칠 때 발생합니다.
- 수명이 긴 갱신 토큰을 수명이 짧은 액세스 토큰으로 교환합니다. 액세스 토큰이 만료되어 Google에서 새 액세스 토큰이 필요할 때 교환이 발생합니다.
디자인 가이드라인
이 섹션에서는 OAuth 연결 흐름을 호스팅하는 사용자 화면의 설계 요구사항과 권장사항을 설명합니다. Google 앱에서 호출한 후 플랫폼에는 Google 페이지에 로그인 및 사용자에게 동의 화면을 연결하는 계정이 표시됩니다. 사용자가 계정 연결에 동의한 후 Google 앱으로 다시 리디렉션됩니다.
요구사항
- 사용자의 계정이 Google Home이나 Google 어시스턴트와 같은 특정 Google 제품이 아니라 Google에 연결됨을 알려야 합니다.
- '로그인하면 Google에서 기기를 제어하도록 승인하는 것으로 간주됩니다.'와 같은 Google 승인 문구가 있어야 합니다. Google Home 개발자 정책의 Google 기기 제어 승인 섹션을 참고하세요.
- 사용자가 연결하지 않기로 한 경우 뒤로 돌아가거나 취소할 수 있는 방법을 제공해야 합니다.
- 웹 OAuth 연결 페이지를 열고 사용자에게 사용자 이름 및 비밀번호 필드와 같이 Google 계정에 로그인할 수 있는 명확한 방법이 있는지 확인해야 합니다. 사용자가 웹 OAuth 연결 페이지로 이동하지 않고도 연결할 수 있도록 하는 Google 로그인 (GSI) 방법을 사용해서는 안 됩니다. 이러한 행위는 Google 정책에 위배됩니다.
권장사항
다음을 수행하는 것이 좋습니다.
Google 개인정보처리방침을 표시합니다. 동의 화면에 Google 개인정보처리방침 링크를 포함합니다.
공유할 데이터. 명확하고 간결한 표현을 사용하여 Google에 필요한 데이터와 이유를 사용자에게 안내합니다.
명확한 클릭 유도 문구. 동의 화면에 '동의 및 연결'과 같은 명확한 클릭 유도 문구를 명시합니다. 이는 사용자가 계정을 연결하기 위해 Google과 공유해야 하는 데이터를 이해해야 하기 때문입니다.
연결 해제 기능. 플랫폼의 계정 설정으로 연결되는 URL과 같이 사용자가 연결을 해제할 수 있는 메커니즘을 제공합니다. 또는 사용자가 연결된 계정을 관리할 수 있는 Google 계정 링크를 포함할 수 있습니다.
사용자 계정 변경 기능. 사용자가 계정을 전환하는 방법을 제안합니다. 사용자가 여러 계정을 사용하는 경향이 있는 경우 특히 유용합니다.
- 사용자가 계정을 전환하기 위해 동의 화면을 닫아야 하는 경우 복구 가능한 오류를 Google에 전송하여 사용자가 OAuth 연결을 통해 원하는 계정에 로그인할 수 있도록 합니다.
로고를 포함하세요. 동의 화면에 회사 로고를 표시합니다. 스타일 가이드라인을 사용하여 로고를 배치합니다. Google 로고도 표시하려면 로고 및 상표를 참조하세요.
승인 코드 흐름
승인 코드 흐름의 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'}
userinfo 요청 처리
userinfo 엔드포인트는 연결된 사용자에 대한 클레임을 반환하는 OAuth 2.0 보호 리소스입니다. userinfo 엔드포인트의 구현 및 호스팅은 선택사항입니다. 단, 다음 사용 경우는 예외입니다.
- Google 원탭으로 연결된 계정 로그인
- Android TV에서 원활한 정기 결제로 이용하세요.
토큰 엔드포인트에서 액세스 토큰을 가져온 후 Google은 userinfo 엔드포인트에 요청을 전송하여 연결된 사용자에 대한 기본 프로필 정보를 가져옵니다.
| userinfo 엔드포인트 요청 헤더 | |
|---|---|
Authorization header |
Bearer 유형의 액세스 토큰입니다. |
예를 들어 https://myservice.example.com/userinfo에서 userinfo 엔드포인트를 사용할 수 있는 경우 요청은 다음과 같이 표시될 수 있습니다.
GET /userinfo HTTP/1.1 Host: myservice.example.com Authorization: Bearer ACCESS_TOKEN
userinfo 엔드포인트가 요청을 처리하도록 하려면 다음 단계를 따르세요.
- Authorization 헤더에서 액세스 토큰을 추출하고 액세스 토큰과 연결된 사용자의 정보를 반환합니다.
- 액세스 토큰이 잘못된 경우
WWW-Authenticate응답 헤더를 사용하여 HTTP 401 Unauthorized 오류를 반환합니다. 다음은 userinfo 오류 응답의 예입니다.HTTP/1.1 401 Unauthorized WWW-Authenticate: error="invalid_token", error_description="The Access Token expired"
연결 프로세스 중에 401 Unauthorized 또는 기타 실패한 오류 응답이 반환되면 오류를 복구할 수 없습니다. 가져온 토큰은 삭제되며 사용자가 연결 프로세스를 다시 시작해야 합니다. 액세스 토큰이 유효하면 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 계정에 등록됩니다.userinfo 엔드포인트 응답 sub시스템 사용자를 식별하는 고유 ID입니다. email사용자의 이메일 주소입니다. given_name선택사항: 사용자의 이름입니다. family_name선택사항: 사용자의 성입니다. name선택사항: 사용자의 전체 이름입니다. picture선택사항: 사용자의 프로필 사진입니다.