OAuth를 사용한 Google 계정 연결

계정은 업계 표준 OAuth 2.0 암시적승인 코드 흐름을 사용하여 연결됩니다. 서비스에서 OAuth 2.0을 준수하는 승인토큰 교환 엔드포인트를 지원해야 합니다.

암시적 흐름에서는 Google이 사용자의 브라우저에서 승인 엔드포인트를 엽니다. 성공적으로 로그인하면 장기 액세스 토큰을 Google에 반환합니다. 이제 이 액세스 토큰은 Google에서 보내는 모든 요청에 포함됩니다.

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

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

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

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

OAuth 2.0 흐름 선택

암시적 흐름은 구현하기가 더 간단하지만 암시적 흐름에서 생성된 액세스 토큰은 만료되지 않는 것이 좋습니다. 이는 암시적 흐름으로 토큰이 만료된 후 사용자가 계정을 다시 연결해야 하기 때문입니다. 보안상의 이유로 토큰 만료가 필요하다면 승인 코드 흐름을 사용하는 것이 좋습니다.

디자인 가이드라인

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

이 그림은 사용자가 Google 계정을 인증 시스템에 연결하는 단계를 보여줍니다. 첫 번째 스크린샷은 플랫폼에서 사용자가 시작한 연결을 보여줍니다. 두 번째 이미지는 사용자가 Google에 로그인하는 것을 보여주며 세 번째 이미지는 Google 계정을 앱과 연결하기 위한 사용자 동의 및 확인을 보여줍니다. 최종 스크린샷은 Google 앱에서 성공적으로 연결된 사용자 계정을 보여줍니다.
그림 1. 사용자가 Google 및 동의 화면에 로그인하는 계정

요구사항

  1. 사용자의 계정이 Google Home 또는 Google 어시스턴트와 같은 특정 Google 제품이 아닌 Google에 연결된다고 전달해야 합니다.

권장사항

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

  1. Google 개인정보처리방침 표시. 동의 화면에 Google 개인정보처리방침 링크를 포함하세요.

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

  3. 명확한 클릭 유도문안. 동의 화면에 '동의 및 연결'과 같은 명확한 클릭 유도 문구를 표시하세요. 계정을 연결하려면 사용자가 Google과 어떤 데이터를 공유해야 하는지 파악해야 하기 때문입니다.

  4. 취소 기능. 사용자가 연결하지 않기로 선택한 경우 뒤로 돌아가거나 취소할 수 있는 방법을 제공합니다.

  5. 로그인 프로세스를 지웁니다. 사용자 이름과 비밀번호 필드 또는 Google 계정으로 로그인과 같은 Google 계정 로그인 방법이 명확해야 합니다.

  6. 연결 해제 기능. 사용자가 연결 해제할 수 있는 메커니즘(예: 플랫폼의 계정 설정 URL)을 제공합니다. 또는 사용자가 연결된 계정을 관리할 수 있는 Google 계정 링크를 포함할 수 있습니다.

  7. 사용자 계정 변경 기능. 사용자에게 계정을 전환하는 방법을 제안합니다. 사용자가 여러 계정을 보유하는 경우 특히 유용합니다.

    • 사용자가 동의 화면을 닫아 계정을 전환해야 하는 경우 OAuth 연결암시적 절차로 원하는 계정에 로그인할 수 있도록 복구 가능한 오류를 Google에 전송하세요.
  8. 로고를 포함합니다. 동의 화면에 회사 로고를 표시합니다. 스타일 가이드라인을 사용해 로고를 배치하세요. Google의 로고도 표시하려면 로고 및 상표를 참조하세요.

프로젝트 만들기

계정 연결을 사용할 프로젝트를 만들려면 다음 단계를 따르세요.

  1. Go to the Google API Console.
  2. 프로젝트 생성을 클릭 하십시오 .
  3. 이름을 입력하거나 생성 된 제안을 수락하십시오.
  4. 나머지 필드를 확인하거나 편집하십시오.
  5. 작성을 클릭 하십시오 .

프로젝트 ID를 보려면

  1. Go to the Google API Console.
  2. 방문 페이지의 표에서 프로젝트를 찾으십시오. 프로젝트 ID가 ID 열에 나타납니다.

Google 계정 연결 프로세스에는 사용자에게 데이터 액세스를 요청하는 애플리케이션, 요청하는 데이터의 종류, 적용되는 약관을 알리는 동의 화면이 포함됩니다. Google API 클라이언트 ID를 생성하기 전에 OAuth 동의 화면을 구성해야 합니다.

  1. Google API 콘솔의 OAuth 동의 화면 페이지를 엽니다.
  2. 메시지가 표시되면 방금 만든 프로젝트를 선택합니다.
  3. 'OAuth 동의 화면' 페이지에서 양식을 작성하고 '저장' 버튼을 클릭합니다.

    애플리케이션 이름: 동의를 요청하는 애플리케이션의 이름입니다. 이름은 애플리케이션을 정확하게 반영해야 하며 사용자가 다른 곳에서 보는 애플리케이션 이름과 일치해야 합니다. 계정 연결 동의 화면에 애플리케이션 이름이 표시됩니다.

    애플리케이션 로고: 사용자가 앱을 알아보는 데 도움이 되는 동의 화면의 이미지입니다. 계정 연결 동의 화면과 계정 설정에 로고가 표시됩니다.

    지원 이메일: 사용자가 동의에 대한 질문을 하기 위해 연락하는 데 사용됩니다.

    Google API의 범위: 범위를 통해 애플리케이션에서 사용자의 비공개 Google 데이터에 액세스할 수 있습니다. Google 계정 연결 사용 사례의 경우 기본 범위 (이메일, 프로필, openid)로 충분하므로 민감한 범위를 추가할 필요가 없습니다. 일반적으로 사전에 요청하는 대신 액세스가 필요할 때 점진적으로 범위를 요청하는 것이 좋습니다. 자세히 알아보기

    승인된 도메인: 나와 내 사용자를 보호하기 위해 Google은 OAuth를 사용하여 인증하는 애플리케이션만 승인된 도메인을 사용하도록 허용합니다. 애플리케이션의 링크는 승인된 도메인에서 호스팅되어야 합니다. 자세히 알아보기

    애플리케이션 홈페이지 링크: 애플리케이션의 홈페이지입니다. 승인된 도메인에서 호스팅되어야 합니다.

    애플리케이션 개인정보처리방침 링크: Google 계정 연결 동의 화면에 표시됩니다. 승인된 도메인에서 호스팅되어야 합니다.

    애플리케이션 서비스 약관 링크 (선택사항): 승인된 도메인에서 호스팅되어야 합니다.

    그림 1. 가상 애플리케이션인 Tunery의 Google 계정 연결 동의 화면

  4. '인증 상태'를 확인하고 신청서에 인증이 필요하면 '인증을 위해 제출' 버튼을 클릭하여 인증 신청서를 제출합니다. 자세한 내용은 OAuth 인증 요구사항을 참고하세요.

OAuth 서버 구현

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

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

Google에서 시작한 OAuth 2.0 인증 코드 흐름 세션에는 다음 흐름이 있습니다.

  1. Google은 사용자의 브라우저에서 인증 엔드포인트를 엽니다. 작업에 대한 음성 전용 기기에서 흐름이 시작된 경우 Google은 실행을 전화로 전송합니다.
  2. 사용자가 아직 로그인하지 않은 경우 로그인하고, 아직 권한을 부여하지 않은 경우 Google에 API로 데이터에 액세스할 수 있는 권한을 부여합니다.
  3. 귀하의 서비스는 인증 코드를 생성하고 Google에 반환합니다. 이렇게 하려면 요청에 첨부된 인증 코드를 사용하여 사용자의 브라우저를 다시 Google로 리디렉션합니다.
  4. 구글은 코드의 진위를 확인하고 액세스 토큰새로 고침 토큰을 반환 토큰 교환 엔드 포인트에 인증 코드를 전송합니다. 액세스 토큰은 서비스에서 API에 액세스하기 위한 자격 증명으로 수락하는 단기 토큰입니다. 새로 고침 토큰은 Google에서 저장하고 만료될 때 새 액세스 토큰을 얻는 데 사용할 수 있는 수명이 긴 토큰입니다.
  5. 사용자가 계정 연결 흐름을 완료한 후 Google에서 보내는 모든 후속 요청에는 액세스 토큰이 포함됩니다.

승인 요청 처리

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

권한 부여 엔드포인트 매개변수
client_id Google에 할당한 클라이언트 ID입니다.
redirect_uri 이 요청에 대한 응답을 보내는 URL입니다.
state 리디렉션 URI에서 변경되지 않고 Google에 다시 전달되는 부기 값입니다.
scope 옵션 : 구글에 대한 승인을 요청하는 데이터를 지정 범위 문자열의 공백으로 구분 된 세트.
response_type 응답에서 반환할 값의 유형입니다. 의 OAuth 2.0 인증 코드 흐름에 대한 응답 유형은 항상 code .
user_locale 의 Google 계정 언어 설정 RFC5646의 사용자가 선호하는 언어로 콘텐츠를 현지화하는 데 사용되는 형식.

권한 부여 엔드 포인트에서 사용할 수있는 경우 예를 들어, 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. URL에 의해 지정된 것을 확인 redirect_uri 매개 변수는 다음과 같은 형식이 있습니다
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
      
  5. 에 의해 지정된 URL로 사용자의 브라우저를 리디렉션 redirect_uri 매개 변수입니다. 당신은 추가하여 리디렉션 할 때 방금 생성 된 인증 코드와 수정되지 않은 원래 상태 값을 포함 codestate 매개 변수를. 다음은 결과 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 .
codegrant_type=authorization_code 이 매개 변수는 구글이 중 하나를 당신의 로그인 또는 토큰 교환 엔드 포인트에서받은 코드입니다.
redirect_uri 경우 grant_type=authorization_code ,이 파라미터는 초기 인증 요청에 사용하는 URL이다.
refresh_tokengrant_type=refresh_token 이 매개 변수는 구글이 토큰 교환 엔드 포인트로부터받은 토큰 새로 고침입니다.
액세스 토큰 및 갱신 토큰에 대한 인증 코드 교환

사용자가 로그인하고 인증 엔드포인트가 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. URL에 의해 지정되었는지 확인 redirect_uri 파라미터는 초기 인증 요청시 사용되는 값과 동일하다.
  4. 위의 조건을 모두 확인할 수없는 경우가있는 HTTP 400 잘못된 요청 오류를 반환 {"error": "invalid_grant"} 몸으로.
  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 식별 요청 구글 등의 기원, 그리고 그 client_secret 예상 값과 일치합니다.
  2. 새로 고침 토큰이 유효한지, 요청에 지정된 클라이언트 ID가 새로 고침 토큰과 연결된 클라이언트 ID와 일치하는지 확인합니다.
  3. 위의 조건을 모두 확인할 수없는 경우가있는 HTTP 400 잘못된 요청 오류를 반환 {"error": "invalid_grant"} 몸으로.
  4. 그렇지 않으면 갱신 토큰의 사용자 ID를 사용하여 액세스 토큰을 생성하십시오. 이러한 토큰은 임의의 문자열 값이 될 수 있지만 사용자와 클라이언트를 고유하게 나타내야 하며 토큰이 대상이 되어야 하며 추측할 수 없어야 합니다. 액세스 토큰의 경우 일반적으로 토큰을 발급한 후 한 시간 후에 토큰의 만료 시간도 기록하십시오.
  5. 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:

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:

  1. Extract access token from the Authorization header and return information for the user associated with the access token.
  2. 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.
  3. 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.

구현 확인

당신은 사용하여 구현을 확인할 수 의 OAuth 2.0 놀이터 도구를.

도구에서 다음 단계를 수행합니다.

  1. 구성을 클릭 의 OAuth 2.0 구성 창을 엽니 다.
  2. 의 OAuth 흐름 필드에 클라이언트 측을 선택합니다.
  3. OAuth를 엔드 포인트 필드에서 사용자 지정을 선택합니다.
  4. 해당 필드에 OAuth 2.0 엔드포인트와 Google에 할당한 클라이언트 ID를 지정합니다.
  5. 1 단계 섹션에서 모든 Google 범위를 선택하지 마십시오. 대신 이 필드를 비워 두거나 서버에 유효한 범위를 입력하십시오(OAuth 범위를 사용하지 않는 경우 임의의 문자열). 작업이 완료되면, API 승인을 클릭합니다.
  6. 단계 2단계 3 부에서의 OAuth 2.0 유동 통과 의도 한대로 각 단계가 제대로 작동하는지 확인.

당신은 사용하여 구현을 검증 할 수 있습니다 구글 계정에 연결하면 데모 도구를.

도구에서 다음 단계를 수행합니다.

  1. 로그인 구글 버튼을 클릭합니다.
  2. 연결할 계정을 선택합니다.
  3. 서비스 ID를 입력합니다.
  4. 선택적으로 액세스를 요청할 하나 이상의 범위를 입력합니다.
  5. 시작 데모를 클릭합니다.
  6. 메시지가 표시되면 연결 요청에 동의하고 거부할 수 있는지 확인합니다.
  7. 플랫폼으로 리디렉션되었는지 확인합니다.