این سند توضیح میدهد که چگونه برنامههای وب سرور از کتابخانههای کلاینت API گوگل یا نقاط پایانی Google OAuth 2.0 برای پیادهسازی مجوز OAuth 2.0 جهت دسترسی به API دادههای یوتیوب استفاده میکنند.
OAuth 2.0 به کاربران اجازه میدهد دادههای خاصی را با یک برنامه به اشتراک بگذارند، در حالی که نام کاربری، رمز عبور و سایر اطلاعات آنها خصوصی باقی میماند. به عنوان مثال، یک برنامه میتواند از OAuth 2.0 برای دریافت مجوز آپلود ویدیوها در کانال یوتیوب کاربر استفاده کند.
این جریان OAuth 2.0 به طور خاص برای احراز هویت کاربر است. این جریان برای برنامههایی طراحی شده است که میتوانند اطلاعات محرمانه را ذخیره کرده و وضعیت را حفظ کنند. یک برنامه وب سرور که به درستی احراز هویت شده باشد، میتواند در حین تعامل کاربر با برنامه یا پس از ترک برنامه، به یک API دسترسی داشته باشد.
برنامههای وب سرور اغلب از حسابهای سرویس برای تأیید درخواستهای API نیز استفاده میکنند، به خصوص هنگام فراخوانی APIهای ابری برای دسترسی به دادههای مبتنی بر پروژه به جای دادههای خاص کاربر. برنامههای وب سرور میتوانند از حسابهای سرویس همراه با تأیید کاربر استفاده کنند. توجه داشته باشید که YouTube Data API فقط از جریان حساب سرویس برای مالکان محتوای YouTube که مالک و مدیر چندین کانال YouTube هستند، پشتیبانی میکند. به طور خاص، مالکان محتوا میتوانند از حسابهای سرویس برای فراخوانی متدهای API که از پارامتر درخواست onBehalfOfContentOwner پشتیبانی میکنند، استفاده کنند.
کتابخانههای کلاینت
مثالهای مختص زبان در این صفحه از کتابخانههای کلاینت API گوگل برای پیادهسازی احراز هویت OAuth 2.0 استفاده میکنند. برای اجرای نمونههای کد، ابتدا باید کتابخانه کلاینت را برای زبان خود نصب کنید.
وقتی از یک کتابخانه کلاینت API گوگل برای مدیریت جریان OAuth 2.0 برنامه خود استفاده میکنید، کتابخانه کلاینت اقدامات زیادی را انجام میدهد که در غیر این صورت برنامه باید به تنهایی آنها را مدیریت کند. به عنوان مثال، تعیین میکند که چه زمانی برنامه میتواند از توکنهای دسترسی ذخیره شده استفاده کند یا آنها را بهروزرسانی کند و همچنین چه زمانی برنامه باید رضایت را دوباره کسب کند. کتابخانه کلاینت همچنین URLهای هدایت مجدد صحیح را تولید میکند و به پیادهسازی کنترلکنندههای هدایت مجدد که کدهای مجوز را برای توکنهای دسترسی مبادله میکنند، کمک میکند.
کتابخانههای کلاینت API گوگل برای برنامههای سمت سرور برای زبانهای زیر در دسترس هستند:
پیشنیازها
فعال کردن APIها برای پروژه شما
هر برنامهای که APIهای گوگل را فراخوانی میکند، باید آن APIها را در ... فعال کند. API Console.
برای فعال کردن API برای پروژه خود:
- Open the API Library در Google API Console.
- If prompted, select a project, or create a new one.
- از صفحه کتابخانه برای یافتن و فعال کردن API داده یوتیوب استفاده کنید. هر API دیگری را که برنامه شما از آن استفاده خواهد کرد، پیدا کنید و آنها را نیز فعال کنید.
ایجاد اعتبارنامههای مجوز
هر برنامهای که از OAuth 2.0 برای دسترسی به APIهای گوگل استفاده میکند، باید دارای اعتبارنامههای احراز هویت باشد که برنامه را به سرور OAuth 2.0 گوگل معرفی کند. مراحل زیر نحوه ایجاد اعتبارنامه برای پروژه شما را توضیح میدهد. سپس برنامههای شما میتوانند از این اعتبارنامهها برای دسترسی به APIهایی که برای آن پروژه فعال کردهاید، استفاده کنند.
- Go to the Clients page.
- روی ایجاد کلاینت کلیک کنید.
- نوع برنامه کاربردی وب را انتخاب کنید.
- فرم را پر کنید و روی ایجاد کلیک کنید. برنامههایی که از زبانها و چارچوبهایی مانند PHP، Java، Python، Ruby و .NET استفاده میکنند، باید URI های ریدایرکت مجاز را مشخص کنند. URI های ریدایرکت، نقاط پایانی هستند که سرور OAuth 2.0 میتواند به آنها پاسخ ارسال کند. این نقاط پایانی باید از قوانین اعتبارسنجی گوگل پیروی کنند.
برای آزمایش، میتوانید URIهایی را مشخص کنید که به دستگاه محلی اشاره دارند، مانند
http://localhost:8080. با توجه به این نکته، لطفاً توجه داشته باشید که تمام مثالهای این سند ازhttp://localhost:8080به عنوان URI تغییر مسیر استفاده میکنند.توصیه میکنیم نقاط پایانی احراز هویت برنامه خود را طوری طراحی کنید که برنامه شما کدهای احراز هویت را در معرض سایر منابع موجود در صفحه قرار ندهد.
پس از ایجاد اعتبارنامههای خود، فایل client_secret.json را از اینجا دانلود کنید. API Consoleفایل را به طور ایمن در مکانی ذخیره کنید که فقط برنامه شما بتواند به آن دسترسی داشته باشد.
شناسایی محدودههای دسترسی
محدودهها به برنامه شما این امکان را میدهند که فقط به منابعی که نیاز دارد درخواست دسترسی کند و در عین حال کاربران را قادر میسازد میزان دسترسی که به برنامه شما میدهند را کنترل کنند. بنابراین، ممکن است رابطه معکوسی بین تعداد محدودههای درخواستی و احتمال کسب رضایت کاربر وجود داشته باشد.
قبل از شروع پیادهسازی احراز هویت OAuth 2.0، توصیه میکنیم محدودههایی را که برنامه شما برای دسترسی به آنها نیاز به مجوز دارد، شناسایی کنید.
ما همچنین توصیه میکنیم که برنامه شما از طریق یک فرآیند مجوزدهی افزایشی ، درخواست دسترسی به حوزههای مجوز را ارائه دهد، که در آن برنامه شما درخواست دسترسی به دادههای کاربر را در متن مربوطه ارائه میدهد. این روش برتر به کاربران کمک میکند تا راحتتر درک کنند که چرا برنامه شما به دسترسی مورد نظر خود نیاز دارد.
API داده یوتیوب نسخه ۳ از حوزههای زیر استفاده میکند:
| دامنه | توضیحات |
|---|---|
https://www. googleapis. com/ auth/ youtube | حساب YouTube خود را مدیریت کنید |
https://www. googleapis. com/ auth/ youtube. channel-memberships. creator | فهرستی از اعضای فعال فعلی کانال خود، سطح فعلی آنها و زمان عضویت آنها را مشاهده کنید |
https://www. googleapis. com/ auth/ youtube. force-ssl | ویدیوها، رتبهبندیها، نظرات و زیرنویسهای YouTube خود را مشاهده، ویرایش و برای همیشه حذف کنید |
https://www. googleapis. com/ auth/ youtube. readonly | حساب YouTube خود را مشاهده کنید |
https://www. googleapis. com/ auth/ youtube. upload | ویدیوهای YouTube خود را مدیریت کنید |
https://www. googleapis. com/ auth/ youtubepartner | دارایی ها و محتوای مرتبط خود را در YouTube مشاهده و مدیریت کنید |
https://www. googleapis. com/ auth/ youtubepartner-channel-audit | اطلاعات خصوصی مربوط به کانال YouTube خود را در طول فرآیند ممیزی با شریک YouTube مشاهده کنید |
سند OAuth 2.0 API Scopes شامل لیست کاملی از scopeهایی است که ممکن است برای دسترسی به APIهای گوگل از آنها استفاده کنید.
الزامات خاص زبان
برای اجرای هر یک از نمونههای کد موجود در این سند، به یک حساب گوگل، دسترسی به اینترنت و یک مرورگر وب نیاز دارید. اگر از یکی از کتابخانههای کلاینت API استفاده میکنید، الزامات خاص زبان را نیز در زیر مشاهده کنید.
پی اچ پی
برای اجرای نمونههای کد PHP در این سند، به موارد زیر نیاز دارید:
- PHP 8.0 یا بالاتر با رابط خط فرمان (CLI) و افزونه JSON نصب شده.
- ابزار مدیریت وابستگیهای کامپوزر .
کتابخانه کلاینت APIهای گوگل برای PHP:
composer require google/apiclient:^2.15.0
برای اطلاعات بیشتر به کتابخانه کلاینت APIهای گوگل برای PHP مراجعه کنید.
پایتون
برای اجرای نمونههای کد پایتون در این سند، به موارد زیر نیاز دارید:
- پایتون ۳.۷ یا بالاتر
- ابزار مدیریت بسته pip .
- کتابخانه کلاینت APIهای گوگل برای پایتون نسخه ۲.۰:
pip install --upgrade google-api-python-client
google-auth،google-auth-oauthlibوgoogle-auth-httplib2برای احراز هویت کاربر.pip install --upgrade google-auth google-auth-oauthlib google-auth-httplib2
- چارچوب برنامه وب پایتون Flask.
pip install --upgrade flask
- کتابخانه HTTP
requests.pip install --upgrade requests
اگر قادر به ارتقاء پایتون و راهنمای مهاجرت مرتبط نیستید، یادداشت انتشار کتابخانه کلاینت پایتون Google API را مرور کنید.
روبی
برای اجرای نمونههای کد Ruby در این سند، به موارد زیر نیاز دارید:
- روبی ۲.۶ یا بالاتر
کتابخانه Google Auth برای Ruby:
gem install googleauth
چارچوب برنامه وب Sinatra Ruby.
gem install sinatra
نود جی اس
برای اجرای نمونههای کد Node.js در این سند، به موارد زیر نیاز دارید:
- LTS مربوط به نگهداری، LTS فعال یا نسخه فعلی Node.js.
کلاینت Node.js مربوط به APIهای گوگل:
npm install googleapis crypto express express-session
HTTP/REST
برای اینکه بتوانید مستقیماً نقاط پایانی OAuth 2.0 را فراخوانی کنید، نیازی به نصب هیچ کتابخانهای ندارید.
دریافت توکنهای دسترسی OAuth 2.0
مراحل زیر نشان میدهد که چگونه برنامه شما با سرور OAuth 2.0 گوگل تعامل میکند تا رضایت کاربر را برای انجام یک درخواست API از طرف کاربر دریافت کند. برنامه شما باید قبل از اینکه بتواند یک درخواست API گوگل را که نیاز به مجوز کاربر دارد اجرا کند، این رضایت را داشته باشد.
لیست زیر به سرعت این مراحل را خلاصه میکند:
- برنامه شما مجوزهای مورد نیاز خود را شناسایی میکند.
- برنامه شما کاربر را به همراه لیست مجوزهای درخواستی به گوگل هدایت میکند.
- کاربر تصمیم میگیرد که آیا مجوزهای لازم را به برنامه شما اعطا کند یا خیر.
- برنامه شما متوجه میشود که کاربر چه تصمیمی گرفته است.
- اگر کاربر مجوزهای درخواستی را اعطا کرده باشد، برنامه شما توکنهای مورد نیاز برای ارسال درخواستهای API از طرف کاربر را بازیابی میکند.
مرحله ۱: تنظیم پارامترهای مجوز
اولین قدم شما ایجاد درخواست مجوز است. این درخواست پارامترهایی را تعیین میکند که برنامه شما را شناسایی کرده و مجوزهایی را که از کاربر خواسته میشود به برنامه شما اعطا کند، تعریف میکند.
- اگر از یک کتابخانه کلاینت گوگل برای احراز هویت و مجوز OAuth 2.0 استفاده میکنید، یک شیء ایجاد و پیکربندی میکنید که این پارامترها را تعریف میکند.
- اگر مستقیماً نقطه پایانی Google OAuth 2.0 را فراخوانی کنید، یک URL ایجاد میکنید و پارامترها را روی آن URL تنظیم میکنید.
تبهای زیر پارامترهای مجوزدهی پشتیبانیشده برای برنامههای وب سرور را تعریف میکنند. مثالهای مختص زبان همچنین نحوه استفاده از یک کتابخانه کلاینت یا کتابخانه مجوزدهی را برای پیکربندی شیء که آن پارامترها را تنظیم میکند، نشان میدهند.
پی اچ پی
قطعه کد زیر یک شیء Google\Client() ایجاد میکند که پارامترهای درخواست مجوز را تعریف میکند.
آن شیء از اطلاعات فایل client_secret.json شما برای شناسایی برنامهتان استفاده میکند. (برای اطلاعات بیشتر در مورد آن فایل، به بخش ایجاد اعتبارنامههای مجوز مراجعه کنید.) این شیء همچنین محدودههایی را که برنامه شما درخواست دسترسی به آنها را دارد و URL مربوط به نقطه پایانی احراز هویت برنامه شما را شناسایی میکند، که پاسخ سرور OAuth 2.0 گوگل را مدیریت خواهد کرد. در نهایت، کد، پارامترهای اختیاری access_type و include_granted_scopes را تنظیم میکند.
برای مثال، این کد درخواست دسترسی آفلاین برای مدیریت حساب کاربری یوتیوب کاربر را دارد:
use Google\Client; $client = new Client(); // Required, call the setAuthConfig function to load authorization credentials from // client_secret.json file. $client->setAuthConfig('client_secret.json'); // Required, to set the scope value, call the addScope function $client->addScope(GOOGLE_SERVICE_YOUTUBE::YOUTUBE_FORCE_SSL); // Required, call the setRedirectUri function to specify a valid redirect URI for the // provided client_id $client->setRedirectUri('http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php'); // Recommended, offline access will give you both an access and refresh token so that // your app can refresh the access token without user interaction. $client->setAccessType('offline'); // Recommended, call the setState function. Using a state value can increase your assurance that // an incoming connection is the result of an authentication request. $client->setState($sample_passthrough_value); // Optional, if your application knows which user is trying to authenticate, it can use this // parameter to provide a hint to the Google Authentication Server. $client->setLoginHint('hint@example.com'); // Optional, call the setPrompt function to set "consent" will prompt the user for consent $client->setPrompt('consent'); // Optional, call the setIncludeGrantedScopes function with true to enable incremental // authorization $client->setIncludeGrantedScopes(true);
پایتون
قطعه کد زیر از ماژول google-auth-oauthlib.flow برای ساخت درخواست مجوز استفاده میکند.
این کد یک شیء Flow میسازد که برنامه شما را با استفاده از اطلاعات فایل client_secret.json که پس از ایجاد اعتبارنامههای مجوز دانلود کردهاید، شناسایی میکند. این شیء همچنین محدودههایی را که برنامه شما درخواست دسترسی به آنها را دارد و URL مربوط به نقطه پایانی احراز هویت برنامه شما را شناسایی میکند که پاسخ سرور OAuth 2.0 گوگل را مدیریت خواهد کرد. در نهایت، کد پارامترهای اختیاری access_type و include_granted_scopes را تنظیم میکند.
برای مثال، این کد درخواست دسترسی آفلاین برای مدیریت حساب کاربری یوتیوب کاربر را دارد:
import google.oauth2.credentials import google_auth_oauthlib.flow # Required, call the from_client_secrets_file method to retrieve the client ID from a # client_secret.json file. The client ID (from that file) and access scopes are required. (You can # also use the from_client_config method, which passes the client configuration as it originally # appeared in a client secrets file but doesn't access the file itself.) flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file('client_secret.json', scopes=['https://www.googleapis.com/auth/youtube.force-ssl']) # Required, indicate where the API server will redirect the user after the user completes # the authorization flow. The redirect URI is required. The value must exactly # match one of the authorized redirect URIs for the OAuth 2.0 client, which you # configured in the API Console. If this value doesn't match an authorized URI, # you will get a 'redirect_uri_mismatch' error. flow.redirect_uri = 'https://www.example.com/oauth2callback' # Generate URL for request to Google's OAuth 2.0 server. # Use kwargs to set optional request parameters. authorization_url, state = flow.authorization_url( # Recommended, enable offline access so that you can refresh an access token without # re-prompting the user for permission. Recommended for web server apps. access_type='offline', # Optional, enable incremental authorization. Recommended as a best practice. include_granted_scopes='true', # Optional, if your application knows which user is trying to authenticate, it can use this # parameter to provide a hint to the Google Authentication Server. login_hint='hint@example.com', # Optional, set prompt to 'consent' will prompt the user for consent prompt='consent')
روبی
از فایل client_secrets.json که ایجاد کردهاید برای پیکربندی یک شیء کلاینت در برنامه خود استفاده کنید. هنگام پیکربندی یک شیء کلاینت، محدودههایی را که برنامه شما باید به آنها دسترسی داشته باشد، به همراه URL به نقطه پایانی احراز هویت برنامه خود که پاسخ سرور OAuth 2.0 را مدیریت میکند، مشخص میکنید.
برای مثال، این کد درخواست دسترسی آفلاین برای مدیریت حساب کاربری یوتیوب کاربر را دارد:
require 'googleauth' require 'googleauth/web_user_authorizer' require 'googleauth/stores/redis_token_store' require 'google/apis/youtube_v3' # Required, call the from_file method to retrieve the client ID from a # client_secret.json file. client_id = Google::Auth::ClientId.from_file('/path/to/client_secret.json') # Required, scope value scope = 'https://www.googleapis.com/auth/youtube.force-ssl' # Required, Authorizers require a storage instance to manage long term persistence of # access and refresh tokens. token_store = Google::Auth::Stores::RedisTokenStore.new(redis: Redis.new) # Required, indicate where the API server will redirect the user after the user completes # the authorization flow. The redirect URI is required. The value must exactly # match one of the authorized redirect URIs for the OAuth 2.0 client, which you # configured in the API Console. If this value doesn't match an authorized URI, # you will get a 'redirect_uri_mismatch' error. callback_uri = '/oauth2callback' # To use OAuth2 authentication, we need access to a CLIENT_ID, CLIENT_SECRET, AND REDIRECT_URI # from the client_secret.json file. To get these credentials for your application, visit # https://console.cloud.google.com/apis/credentials. authorizer = Google::Auth::WebUserAuthorizer.new(client_id, scope, token_store, callback_uri)
برنامه شما از شیء کلاینت برای انجام عملیات OAuth 2.0، مانند تولید URLهای درخواست مجوز و اعمال توکنهای دسترسی به درخواستهای HTTP، استفاده میکند.
نود جی اس
قطعه کد زیر یک شیء google.auth.OAuth2 ایجاد میکند که پارامترهای درخواست مجوز را تعریف میکند.
آن شیء از اطلاعات فایل client_secret.json شما برای شناسایی برنامهتان استفاده میکند. برای درخواست مجوز از یک کاربر برای بازیابی یک توکن دسترسی، او را به یک صفحه رضایت هدایت میکنید. برای ایجاد URL صفحه رضایت:
const {google} = require('googleapis'); const crypto = require('crypto'); const express = require('express'); const session = require('express-session'); /** * To use OAuth2 authentication, we need access to a CLIENT_ID, CLIENT_SECRET, AND REDIRECT_URI * from the client_secret.json file. To get these credentials for your application, visit * https://console.cloud.google.com/apis/credentials. */ const oauth2Client = new google.auth.OAuth2( YOUR_CLIENT_ID, YOUR_CLIENT_SECRET, YOUR_REDIRECT_URL ); // Access scopes for YouTube API const scopes = [ 'https://www.googleapis.com/auth/youtube.force-ssl' ]; // Generate a secure random state value. const state = crypto.randomBytes(32).toString('hex'); // Store state in the session req.session.state = state; // Generate a url that asks permissions for the Drive activity and Google Calendar scope const authorizationUrl = oauth2Client.generateAuthUrl({ // 'online' (default) or 'offline' (gets refresh_token) access_type: 'offline', /** Pass in the scopes array defined above. * Alternatively, if only one scope is needed, you can pass a scope URL as a string */ scope: scopes, // Enable incremental authorization. Recommended as a best practice. include_granted_scopes: true, // Include the state parameter to reduce the risk of CSRF attacks. state: state });
نکته مهم - refresh_token فقط در اولین مجوز بازگردانده میشود. جزئیات بیشتر اینجا .
HTTP/REST
نقطه پایانی OAuth 2.0 گوگل در https://accounts.google.com/o/oauth2/v2/auth قرار دارد. این نقطه پایانی فقط از طریق HTTPS قابل دسترسی است. اتصالات HTTP ساده رد میشوند.
سرور احراز هویت گوگل از پارامترهای رشته پرس و جوی زیر برای برنامههای وب سرور پشتیبانی میکند:
| پارامترها | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
client_id | مورد نیاز شناسه کلاینت برای برنامه شما. میتوانید این مقدار را در Cloud ConsoleClients page. | ||||||||||||||||
redirect_uri | مورد نیاز تعیین میکند که سرور API پس از تکمیل جریان مجوز توسط کاربر، کاربر را به کجا هدایت کند. مقدار باید دقیقاً با یکی از URI های هدایت مجاز برای کلاینت OAuth 2.0 که در کلاینت خود پیکربندی کردهاید، مطابقت داشته باشد. Cloud ConsoleClients pageاگر این مقدار با یک URI تغییر مسیر مجاز برای توجه داشته باشید که طرح | ||||||||||||||||
response_type | مورد نیاز تعیین میکند که آیا نقطه پایانی Google OAuth 2.0 کد مجوز را برمیگرداند یا خیر. مقدار پارامتر را برای برنامههای وب سرور روی | ||||||||||||||||
scope | مورد نیاز فهرستی از محدودهها که با فاصله از هم جدا شدهاند و منابعی را که برنامه شما میتواند از طرف کاربر به آنها دسترسی داشته باشد، مشخص میکنند. این مقادیر، صفحه رضایتنامهای را که گوگل به کاربر نمایش میدهد، مشخص میکنند. محدودهها به برنامه شما این امکان را میدهند که فقط به منابعی که نیاز دارد درخواست دسترسی کند و در عین حال کاربران را قادر میسازد میزان دسترسی که به برنامه شما میدهند را کنترل کنند. بنابراین، بین تعداد محدودههای درخواستی و احتمال کسب رضایت کاربر، رابطه معکوس وجود دارد. API داده یوتیوب نسخه ۳ از حوزههای زیر استفاده میکند:
سند OAuth 2.0 API Scopes فهرست کاملی از Scopeهایی که میتوانید برای دسترسی به APIهای گوگل استفاده کنید را ارائه میدهد. توصیه میکنیم برنامه شما در صورت امکان، درخواست دسترسی به حوزههای مجوز را در context ارائه دهد. با درخواست دسترسی به دادههای کاربر در context، با استفاده از مجوز افزایشی ، به کاربران کمک میکنید تا بفهمند که چرا برنامه شما به دسترسی مورد درخواست خود نیاز دارد. | ||||||||||||||||
access_type | توصیه شده نشان میدهد که آیا برنامه شما میتواند توکنهای دسترسی را هنگامی که کاربر در مرورگر حضور ندارد، بهروزرسانی کند یا خیر. مقادیر معتبر پارامتر، اگر برنامه شما نیاز دارد که توکنهای دسترسی را در زمانی که کاربر در مرورگر حضور ندارد، بهروزرسانی کند، مقدار را روی | ||||||||||||||||
state | توصیه شده هر مقدار رشتهای را که برنامه شما برای حفظ وضعیت بین درخواست مجوز شما و پاسخ سرور مجوز استفاده میکند، مشخص میکند. سرور پس از اینکه کاربر درخواست دسترسی برنامه شما را تأیید یا رد کرد، مقدار دقیقی را که شما به عنوان یک جفت شما میتوانید از این پارامتر برای چندین هدف استفاده کنید، مانند هدایت کاربر به منبع صحیح در برنامهتان، ارسال nonceها و کاهش جعل درخواست بین سایتی. از آنجایی که | ||||||||||||||||
include_granted_scopes | اختیاری برنامهها را قادر میسازد تا از مجوز افزایشی برای درخواست دسترسی به حوزههای اضافی در متن استفاده کنند. اگر مقدار این پارامتر را روی | ||||||||||||||||
enable_granular_consent | اختیاری پیشفرض روی وقتی گوگل مجوزهای جزئی را برای یک برنامه فعال میکند، این پارامتر دیگر هیچ تاثیری نخواهد داشت. | ||||||||||||||||
login_hint | اختیاری اگر برنامه شما بداند کدام کاربر در حال تلاش برای احراز هویت است، میتواند از این پارامتر برای ارائه یک راهنما به سرور احراز هویت گوگل استفاده کند. سرور از این راهنما برای سادهسازی جریان ورود به سیستم، یا با پر کردن فیلد ایمیل در فرم ورود به سیستم یا با انتخاب جلسه ورود چندگانه مناسب، استفاده میکند. مقدار پارامتر را روی یک آدرس ایمیل یا شناسه | ||||||||||||||||
prompt | اختیاری فهرستی از درخواستها که با فاصله از هم جدا شده و به حروف کوچک و بزرگ حساس هستند و کاربر را نمایش میدهند. اگر این پارامتر را مشخص نکنید، فقط در اولین باری که پروژه شما درخواست دسترسی میدهد، از کاربر درخواست میشود. برای اطلاعات بیشتر به بخش درخواست رضایت مجدد مراجعه کنید. مقادیر ممکن عبارتند از:
| ||||||||||||||||
مرحله ۲: هدایت به سرور OAuth 2.0 گوگل
کاربر را به سرور OAuth 2.0 گوگل هدایت کنید تا فرآیند احراز هویت و مجوزدهی آغاز شود. معمولاً این اتفاق زمانی میافتد که برنامه شما ابتدا نیاز به دسترسی به دادههای کاربر دارد. در مورد مجوزدهی افزایشی ، این مرحله همچنین زمانی رخ میدهد که برنامه شما ابتدا نیاز به دسترسی به منابع اضافی دارد که هنوز مجوز دسترسی به آنها را ندارد.
پی اچ پی
- یک URL برای درخواست دسترسی از سرور OAuth 2.0 گوگل ایجاد کنید:
$auth_url = $client->createAuthUrl(); - کاربر را به
$auth_urlهدایت میکند:header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL));
پایتون
این مثال نحوه هدایت کاربر به URL مجوز با استفاده از چارچوب برنامه وب Flask را نشان میدهد:
return flask.redirect(authorization_url)
روبی
- یک URL برای درخواست دسترسی از سرور OAuth 2.0 گوگل ایجاد کنید:
auth_uri = authorizer.get_authorization_url(request: request)
- کاربر را به
auth_uriهدایت کنید.
نود جی اس
- از URL
authorizationUrlتولید شده از متدgenerateAuthUrlمرحله 1 برای درخواست دسترسی از سرور OAuth 2.0 گوگل استفاده کنید. - کاربر را به
authorizationUrlهدایت کنید.res.redirect(authorizationUrl);
HTTP/REST
نمونه تغییر مسیر به سرور مجوز گوگل
نمونه آدرس اینترنتی زیر، دسترسی آفلاین ( access_type=offline ) را به محدودهای که امکان مشاهده حساب کاربری یوتیوب کاربر را فراهم میکند، درخواست میکند. این آدرس اینترنتی از مجوزدهی افزایشی استفاده میکند تا اطمینان حاصل شود که توکن دسترسی جدید، هر محدودهای را که کاربر قبلاً به برنامه دسترسی داده است، پوشش میدهد. این آدرس اینترنتی همچنین مقادیر پارامترهای مورد نیاز redirect_uri ، response_type و client_id و همچنین پارامتر state را تعیین میکند. این آدرس اینترنتی شامل پرش به خط و فاصله برای خوانایی بیشتر است.
https://accounts.google.com/o/oauth2/v2/auth?
scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyoutube.readonly&
access_type=offline&
include_granted_scopes=true&
state=state_parameter_passthrough_value&
redirect_uri=http%3A%2F%2Flocalhost%2Foauth2callback&
response_type=code&
client_id=client_idپس از ایجاد URL درخواست، کاربر را به آن هدایت کنید.
سرور OAuth 2.0 گوگل، کاربر را احراز هویت میکند و رضایت او را برای دسترسی برنامه شما به محدودههای درخواستی دریافت میکند. پاسخ با استفاده از URL تغییر مسیری که مشخص کردهاید، به برنامه شما ارسال میشود.
مرحله ۳: گوگل از کاربر رضایت میخواهد
در این مرحله، کاربر تصمیم میگیرد که آیا به برنامه شما دسترسی مورد درخواست را اعطا کند یا خیر. در این مرحله، گوگل یک پنجره رضایتنامه نمایش میدهد که نام برنامه شما و سرویسهای API گوگل که درخواست مجوز دسترسی به آنها را دارد، به همراه اطلاعات احراز هویت کاربر و خلاصهای از محدودههای دسترسی که باید اعطا شود را نشان میدهد. سپس کاربر میتواند با اعطای دسترسی به یک یا چند محدوده درخواستی برنامه شما موافقت کند یا درخواست را رد کند.
برنامه شما در این مرحله نیازی به انجام کاری ندارد، زیرا منتظر پاسخ از سرور OAuth 2.0 گوگل است که نشان میدهد آیا دسترسی اعطا شده است یا خیر. این پاسخ در مرحله بعد توضیح داده شده است.
خطاها
درخواستها به نقطه پایانی احراز هویت OAuth 2.0 گوگل ممکن است به جای جریانهای احراز هویت و مجوز مورد انتظار، پیامهای خطای کاربرپسند را نمایش دهند. کدهای خطای رایج و راهحلهای پیشنهادی عبارتند از:
admin_policy_enforced
حساب گوگل به دلیل سیاستهای مدیر Google Workspace خود قادر به تأیید یک یا چند محدوده درخواستی نیست. برای اطلاعات بیشتر در مورد اینکه چگونه یک مدیر میتواند دسترسی به همه محدودهها یا محدودههای حساس و محدود شده را تا زمانی که دسترسی به طور صریح به شناسه کلاینت OAuth شما اعطا نشده باشد، محدود کند، به مقاله راهنمای مدیریت Google Workspace با عنوان «کنترل دسترسی برنامههای شخص ثالث و داخلی به دادههای Google Workspace» مراجعه کنید.
disallowed_useragent
نقطه پایانی احراز هویت درون یک عامل کاربری تعبیهشده نمایش داده میشود که توسط سیاستهای OAuth 2.0 گوگل مجاز نیست.
توسعهدهندگان iOS و macOS ممکن است هنگام باز کردن درخواستهای مجوز در WKWebView با این خطا مواجه شوند. توسعهدهندگان باید به جای آن از کتابخانههای iOS مانند Google Sign-In برای iOS یا OpenID Foundation’s AppAuth برای iOS استفاده کنند.
توسعهدهندگان وب ممکن است زمانی که یک برنامه iOS یا macOS یک لینک وب عمومی را در یک عامل کاربر تعبیهشده باز میکند و کاربر از سایت شما به نقطه پایانی مجوز OAuth 2.0 گوگل هدایت میشود، با این خطا مواجه شوند. توسعهدهندگان باید اجازه دهند لینکهای عمومی در کنترلکننده لینک پیشفرض سیستم عامل، که شامل کنترلکنندههای لینک جهانی یا برنامه مرورگر پیشفرض است، باز شوند. کتابخانه SFSafariViewController نیز یک گزینه پشتیبانی شده است.
org_internal
شناسه کلاینت OAuth در درخواست، بخشی از پروژهای است که دسترسی به حسابهای گوگل را در یک سازمان ابری خاص گوگل محدود میکند. برای اطلاعات بیشتر در مورد این گزینه پیکربندی، به بخش نوع کاربر در مقاله راهنمای تنظیم صفحه رضایت OAuth خود مراجعه کنید.
invalid_client
رمز کلاینت OAuth نادرست است. پیکربندی کلاینت OAuth ، از جمله شناسه کلاینت و رمز استفاده شده برای این درخواست را بررسی کنید.
deleted_client
کلاینت OAuth که برای ایجاد درخواست استفاده شده بود، حذف شده است. حذف میتواند به صورت دستی یا خودکار در مورد کلاینتهای بلااستفاده انجام شود. کلاینتهای حذف شده را میتوان ظرف 30 روز از زمان حذف بازیابی کرد. اطلاعات بیشتر .
invalid_grant
هنگام بهروزرسانی توکن دسترسی یا استفاده از مجوز افزایشی ، ممکن است توکن منقضی شده یا نامعتبر شده باشد. کاربر را دوباره احراز هویت کنید و برای دریافت توکنهای جدید، رضایت کاربر را جویا شوید. اگر همچنان این خطا را مشاهده میکنید، مطمئن شوید که برنامه شما به درستی پیکربندی شده است و از توکنها و پارامترهای صحیح در درخواست خود استفاده میکنید. در غیر این صورت، ممکن است حساب کاربری حذف یا غیرفعال شده باشد.
redirect_uri_mismatch
redirect_uri ارسال شده در درخواست مجوز با یک URI تغییر مسیر مجاز برای شناسه کلاینت OAuth مطابقت ندارد. URI های تغییر مسیر مجاز را در Google Cloud ConsoleClients page.
پارامتر redirect_uri ممکن است به جریان OAuth out-of-band (OOB) اشاره داشته باشد که منسوخ شده و دیگر پشتیبانی نمیشود. برای بهروزرسانی ادغام خود به راهنمای مهاجرت مراجعه کنید.
invalid_request
درخواستی که ارائه دادید، مشکلی داشت. این مشکل میتواند به دلایل مختلفی باشد:
- درخواست به درستی قالب بندی نشده است
- درخواست پارامترهای مورد نیاز را نداشت
- این درخواست از روش احراز هویتی استفاده میکند که گوگل از آن پشتیبانی نمیکند. تأیید کنید که ادغام OAuth شما از روش ادغام توصیهشده استفاده میکند.
مرحله ۴: مدیریت پاسخ سرور OAuth 2.0
سرور OAuth 2.0 با استفاده از URL مشخص شده در درخواست، به درخواست دسترسی برنامه شما پاسخ میدهد.
اگر کاربر درخواست دسترسی را تأیید کند، پاسخ حاوی یک کد مجوز است. اگر کاربر درخواست را تأیید نکند، پاسخ حاوی یک پیام خطا است. کد مجوز یا پیام خطایی که به وب سرور بازگردانده میشود، در رشته پرسوجو، همانطور که در زیر نشان داده شده است، ظاهر میشود:
پاسخ یک خطا:
https://oauth2.example.com/auth?error=access_denied
پاسخ کد مجوز:
https://oauth2.example.com/auth?code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7
نمونه پاسخ سرور OAuth 2.0
شما میتوانید این جریان را با کلیک روی نمونه URL زیر که دسترسی فقط خواندنی برای مشاهده فرادادههای فایلهای گوگل درایو شما و دسترسی فقط خواندنی برای مشاهده رویدادهای تقویم گوگل شما را درخواست میکند، آزمایش کنید:
https://accounts.google.com/o/oauth2/v2/auth? scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyoutube.readonly& access_type=offline& include_granted_scopes=true& state=state_parameter_passthrough_value& redirect_uri=http%3A%2F%2Flocalhost%2Foauth2callback& response_type=code& client_id=client_id
پس از تکمیل جریان OAuth 2.0، شما باید به http://localhost/oauth2callback هدایت شوید، که احتمالاً منجر به خطای 404 NOT FOUND خواهد شد، مگر اینکه دستگاه محلی شما فایلی را در آن آدرس ارائه دهد. مرحله بعدی جزئیات بیشتری در مورد اطلاعات برگردانده شده در URI هنگام هدایت مجدد کاربر به برنامه شما ارائه میدهد.
مرحله ۵: کد مجوز را با توکنهای بهروزرسانی و دسترسی مبادله کنید
پس از اینکه وب سرور کد مجوز را دریافت کرد، میتواند کد مجوز را با یک توکن دسترسی (access token) مبادله کند.
پی اچ پی
برای تبادل یک کد مجوز با یک توکن دسترسی، از متد fetchAccessTokenWithAuthCode استفاده کنید:
$access_token = $client->fetchAccessTokenWithAuthCode($_GET['code']);پایتون
در صفحه فراخوانی خود، از کتابخانه google-auth برای تأیید پاسخ سرور احراز هویت استفاده کنید. سپس، از متد flow.fetch_token برای تبادل کد احراز هویت در آن پاسخ با یک توکن دسترسی استفاده کنید:
state = flask.session['state'] flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file( 'client_secret.json', scopes=['https://www.googleapis.com/auth/youtube.force-ssl'], state=state) flow.redirect_uri = flask.url_for('oauth2callback', _external=True) authorization_response = flask.request.url flow.fetch_token(authorization_response=authorization_response) # Store the credentials in browser session storage, but for security: client_id, client_secret, # and token_uri are instead stored only on the backend server. credentials = flow.credentials flask.session['credentials'] = { 'token': credentials.token, 'refresh_token': credentials.refresh_token, 'granted_scopes': credentials.granted_scopes}
روبی
در صفحه فراخوانی خود، از کتابخانه googleauth برای تأیید پاسخ سرور احراز هویت استفاده کنید. از متد authorizer.handle_auth_callback_deferred برای ذخیره کد احراز هویت و هدایت مجدد به URL که در ابتدا درخواست احراز هویت کرده بود، استفاده کنید. این کار با ذخیره موقت نتایج در جلسه کاربر، تبادل کد را به تعویق میاندازد.
target_url = Google::Auth::WebUserAuthorizer.handle_auth_callback_deferred(request) redirect target_url
نود جی اس
برای تبادل کد مجوز با یک توکن دسترسی، از متد getToken استفاده کنید:
const url = require('url'); // Receive the callback from Google's OAuth 2.0 server. app.get('/oauth2callback', async (req, res) => { let q = url.parse(req.url, true).query; if (q.error) { // An error response e.g. error=access_denied console.log('Error:' + q.error); } else if (q.state !== req.session.state) { //check state value console.log('State mismatch. Possible CSRF attack'); res.end('State mismatch. Possible CSRF attack'); } else { // Get access and refresh tokens (if access_type is offline) let { tokens } = await oauth2Client.getToken(q.code); oauth2Client.setCredentials(tokens); });
HTTP/REST
برای تبادل کد مجوز با یک توکن دسترسی، با نقطه پایانی https://oauth2.googleapis.com/token تماس بگیرید و پارامترهای زیر را تنظیم کنید:
| فیلدها | |
|---|---|
client_id | شناسه کلاینت به دست آمده از Cloud ConsoleClients page. |
client_secret | اختیاری راز مشتری که از ... به دست آمده است Cloud ConsoleClients page. |
code | کد مجوزی که از درخواست اولیه برگردانده شده است. |
grant_type | همانطور که در مشخصات OAuth 2.0 تعریف شده است ، مقدار این فیلد باید روی authorization_code تنظیم شود. |
redirect_uri | یکی از آدرسهای اینترنتی تغییر مسیر ذکر شده برای پروژه شما در Cloud ConsoleClients page برای client_id داده شده. |
قطعه کد زیر یک نمونه درخواست را نشان میدهد:
POST /token HTTP/1.1 Host: oauth2.googleapis.com Content-Type: application/x-www-form-urlencoded code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7& client_id=your_client_id& redirect_uri=https%3A//oauth2.example.com/code& grant_type=authorization_code
گوگل با بازگرداندن یک شیء JSON که حاوی یک توکن دسترسی کوتاهمدت و یک توکن بهروزرسانی است، به این درخواست پاسخ میدهد. توجه داشته باشید که توکن بهروزرسانی فقط در صورتی بازگردانده میشود که برنامه شما پارامتر access_type را در درخواست اولیه به سرور تأیید گوگل ، روی offline تنظیم کرده باشد.
پاسخ شامل فیلدهای زیر است:
| فیلدها | |
|---|---|
access_token | توکنی که برنامه شما برای تأیید درخواست API گوگل ارسال میکند. |
expires_in | طول عمر باقی مانده از توکن دسترسی بر حسب ثانیه. |
refresh_token | توکنی که میتوانید از آن برای دریافت یک توکن دسترسی جدید استفاده کنید. توکنهای تازهسازی تا زمانی که کاربر دسترسی را لغو کند یا توکن تازهسازی منقضی شود، معتبر هستند. باز هم، این فیلد فقط در صورتی در این پاسخ وجود دارد که پارامتر access_type را در درخواست اولیه به سرور مجوز گوگل، روی offline تنظیم کرده باشید. |
refresh_token_expires_in | طول عمر باقیماندهی توکن بهروزرسانی بر حسب ثانیه. این مقدار فقط زمانی تنظیم میشود که کاربر دسترسی مبتنی بر زمان را اعطا کند. |
scope | دامنههای دسترسی اعطا شده توسط access_token به صورت فهرستی از رشتههای جدا شده با فاصله و حساس به حروف بزرگ و کوچک بیان میشوند. |
token_type | نوع توکن برگشتی. در حال حاضر، مقدار این فیلد همیشه روی Bearer تنظیم میشود. |
قطعه کد زیر یک نمونه پاسخ را نشان میدهد:
{ "access_token": "1/fFAGRNJru1FTz70BzhT3Zg", "expires_in": 3920, "token_type": "Bearer", "scope": "https://www.googleapis.com/auth/youtube.force-ssl", "refresh_token": "1//xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI" }
خطاها
هنگام تعویض کد مجوز با یک توکن دسترسی، ممکن است به جای پاسخ مورد انتظار با خطای زیر مواجه شوید. کدهای خطای رایج و راهحلهای پیشنهادی در زیر فهرست شدهاند.
invalid_grant
کد مجوز ارائه شده نامعتبر است یا فرمت آن اشتباه است. با راهاندازی مجدد فرآیند OAuth، کد جدیدی درخواست کنید تا دوباره از کاربر رضایت بخواهد.
مرحله ۶: بررسی کنید که کاربران کدام حوزهها را اعطا کردهاند
هنگام درخواست چندین مجوز (اسکوپ)، کاربران ممکن است به برنامه شما اجازه دسترسی به همه آنها را ندهند. برنامه شما باید تأیید کند که کدام اسکوپها واقعاً اعطا شدهاند و به طور مناسب موقعیتهایی را که برخی از مجوزها رد میشوند، مدیریت کند، معمولاً با غیرفعال کردن ویژگیهایی که به آن اسکوپهای رد شده متکی هستند.
با این حال، استثنائاتی نیز وجود دارد. برنامههای Google Workspace Enterprise با تفویض اختیار در سطح دامنه یا برنامههایی که به عنوان Trusted علامتگذاری شدهاند، صفحه رضایت مجوزهای جزئی را دور میزنند. برای این برنامهها، کاربران صفحه رضایت مجوزهای جزئی را نمیبینند. در عوض، برنامه شما یا همه محدودههای درخواستی را دریافت میکند یا هیچ کدام را دریافت نمیکند.
برای اطلاعات بیشتر، به نحوه مدیریت مجوزهای جزئی مراجعه کنید.
پی اچ پی
برای بررسی اینکه کاربر کدام حوزهها را اعطا کرده است، از متد getGrantedScope() استفاده کنید:
// Space-separated string of granted scopes if it exists, otherwise null. $granted_scopes = $client->getOAuth2Service()->getGrantedScope();
پایتون
شیء credentials برگردانده شده دارای یک ویژگی granted_scopes است که لیستی از حوزههایی است که کاربر به برنامه شما اعطا کرده است.
credentials = flow.credentials flask.session['credentials'] = { 'token': credentials.token, 'refresh_token': credentials.refresh_token, 'granted_scopes': credentials.granted_scopes}
روبی
هنگام درخواست چندین حوزه به طور همزمان، بررسی کنید که کدام حوزهها از طریق ویژگی scope شیء credentials اعطا شدهاند.
# User authorized the request. Now, check which scopes were granted. if credentials.scope.include?(Google::Apis::YoutubeV3::AUTH_YOUTUBE_FORCE_SSL) # User authorized permission to see, edit, and permanently delete the # YouTube videos, ratings, comments and captions. # Calling the APIs, etc else # User didn't authorize the permission. # Update UX and application accordingly end
نود جی اس
هنگام درخواست چندین حوزه به طور همزمان، بررسی کنید که کدام حوزهها از طریق ویژگی scope شیء tokens اعطا شدهاند.
// User authorized the request. Now, check which scopes were granted. if (tokens.scope.includes('https://www.googleapis.com/auth/youtube.force-ssl')) { // User authorized permission to see, edit, and permanently delete the // YouTube videos, ratings, comments and captions. // Calling the APIs, etc. } else { // User didn't authorize read-only Drive activity permission. // Update UX and application accordingly }
HTTP/REST
برای بررسی اینکه آیا کاربر به برنامه شما دسترسی به یک محدوده خاص را اعطا کرده است یا خیر، فیلد scope در پاسخ access token بررسی کنید. محدودههای دسترسی اعطا شده توسط access_token به صورت لیستی از رشتههای حساس به حروف بزرگ و کوچک و جدا از فاصله بیان میشوند.
برای مثال، نمونه پاسخ توکن دسترسی زیر نشان میدهد که کاربر به برنامه شما اجازه داده است تا ویدیوهای یوتیوب، رتبهبندیها، نظرات و زیرنویسهای کاربر را ببیند، ویرایش کند و بهطور دائم حذف کند:
{ "access_token": "1/fFAGRNJru1FTz70BzhT3Zg", "expires_in": 3920, "token_type": "Bearer", "scope": "https://www.googleapis.com/auth/youtube.force-ssl", "refresh_token": "1//xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI" }
فراخوانی API های گوگل
پی اچ پی
با انجام مراحل زیر، از توکن دسترسی برای فراخوانی APIهای گوگل استفاده کنید:
- اگر نیاز دارید که یک توکن دسترسی را به یک شیء جدید
Google\Clientاعمال کنید - برای مثال، اگر توکن دسترسی را در یک جلسه کاربر ذخیره کردهاید - از متدsetAccessTokenاستفاده کنید:$client->setAccessToken($access_token); - یک شیء سرویس برای API که میخواهید فراخوانی کنید، بسازید. شما با ارائه یک شیء مجاز
Google\Clientبه سازنده API که میخواهید فراخوانی کنید، یک شیء سرویس میسازید. برای مثال، برای فراخوانی API داده YouTube:$youtube = new Google_Service_YouTube($client); - با استفاده از رابط ارائه شده توسط شیء سرویس، درخواستهایی را به سرویس API ارسال کنید. به عنوان مثال، برای بازیابی اطلاعات مربوط به کانال یوتیوب کاربر مجاز:
$channel = $youtube->channels->listChannels('snippet', array('mine' => $mine));
پایتون
پس از دریافت یک توکن دسترسی، برنامه شما میتواند از آن توکن برای تأیید درخواستهای API از طرف یک حساب کاربری یا حساب سرویس مشخص استفاده کند. از اعتبارنامههای تأیید مختص کاربر برای ساخت یک شیء سرویس برای API که میخواهید فراخوانی کنید استفاده کنید و سپس از آن شیء برای ارسال درخواستهای API مجاز استفاده کنید.
- یک شیء سرویس برای API که میخواهید فراخوانی کنید، بسازید. شما با فراخوانی متد
buildکتابخانهgoogleapiclient.discoveryبه همراه نام و نسخه API و اطلاعات کاربری، یک شیء سرویس میسازید: به عنوان مثال، برای فراخوانی نسخه ۳ از YouTube Data API:from googleapiclient.discovery import build youtube = build('youtube', 'v3', credentials=credentials)
- با استفاده از رابط ارائه شده توسط شیء سرویس، درخواستهایی را به سرویس API ارسال کنید. به عنوان مثال، برای بازیابی اطلاعات مربوط به کانال یوتیوب کاربر مجاز:
channel = youtube.channels().list(mine=True, part='snippet').execute()
روبی
پس از دریافت یک توکن دسترسی، برنامه شما میتواند از آن توکن برای ارسال درخواستهای API از طرف یک حساب کاربری یا حساب سرویس مشخص استفاده کند. از اعتبارنامههای مجوزدهی مختص کاربر برای ساخت یک شیء سرویس برای API که میخواهید فراخوانی کنید استفاده کنید و سپس از آن شیء برای ارسال درخواستهای API مجاز استفاده کنید.
- یک شیء سرویس برای API که میخواهید فراخوانی کنید، بسازید. برای مثال، برای فراخوانی نسخه ۳ از YouTube Data API:
youtube = Google::Apis::YoutubeV3::YouTubeService.new
- اعتبارنامهها را روی سرویس تنظیم کنید:
youtube.authorization = credentials
- با استفاده از رابط ارائه شده توسط شیء سرویس، درخواستهایی را به سرویس API ارسال کنید. به عنوان مثال، برای بازیابی اطلاعات مربوط به کانال یوتیوب کاربر مجاز:
channel = youtube.list_channels(part, :mine => mine)
به طور جایگزین، میتوان با ارائه پارامتر options به یک متد، مجوزدهی را بر اساس هر متد ارائه داد:
channel = youtube.list_channels(part, :mine => mine, options: { authorization: auth_client })
نود جی اس
پس از دریافت یک توکن دسترسی و تنظیم آن روی شیء OAuth2 ، از این شیء برای فراخوانی APIهای گوگل استفاده کنید. برنامه شما میتواند از آن توکن برای تأیید درخواستهای API از طرف یک حساب کاربری یا حساب سرویس مشخص استفاده کند. یک شیء سرویس برای API که میخواهید فراخوانی کنید، بسازید. به عنوان مثال، کد زیر از API گوگل درایو برای فهرست کردن نام فایلهای موجود در درایو کاربر استفاده میکند.
const { google } = require('googleapis'); // Example of using YouTube API to list channels. var service = google.youtube('v3'); service.channels.list({ auth: oauth2Client, part: 'snippet,contentDetails,statistics', forUsername: 'GoogleDevelopers' }, function (err, response) { if (err) { console.log('The API returned an error: ' + err); return; } var channels = response.data.items; if (channels.length == 0) { console.log('No channel found.'); } else { console.log('This channel\'s ID is %s. Its title is \'%s\', and ' + 'it has %s views.', channels[0].id, channels[0].snippet.title, channels[0].statistics.viewCount); } });
HTTP/REST
پس از اینکه برنامه شما یک توکن دسترسی دریافت کرد، میتوانید از این توکن برای برقراری تماس با یک API گوگل از طرف یک حساب کاربری مشخص استفاده کنید، البته اگر محدوده(های) دسترسی مورد نیاز API اعطا شده باشد. برای انجام این کار، توکن دسترسی را با وارد کردن پارامتر پرسوجوی access_token یا مقدار Bearer هدر HTTP Authorization ، در درخواست به API قرار دهید. در صورت امکان، هدر HTTP ترجیح داده میشود، زیرا رشتههای پرسوجو معمولاً در گزارشهای سرور قابل مشاهده هستند. در بیشتر موارد، میتوانید از یک کتابخانه کلاینت برای تنظیم تماسهای خود با APIهای گوگل استفاده کنید (برای مثال، هنگام فراخوانی API داده YouTube ).
توجه داشته باشید که API داده یوتیوب فقط از حسابهای سرویس مربوط به مالکان محتوای یوتیوب که مالک و مدیر چندین کانال یوتیوب هستند، مانند ناشران موسیقی و استودیوهای فیلم، پشتیبانی میکند.
شما میتوانید تمام APIهای گوگل را امتحان کنید و حوزههای کاربرد آنها را در OAuth 2.0 Playground مشاهده کنید.
مثالهای HTTP GET
فراخوانی نقطه پایانی youtube.channels (رابط برنامهنویسی کاربردی داده یوتیوب) با استفاده از هدر HTTP مربوط به Authorization: Bearer ممکن است چیزی شبیه به شکل زیر باشد. توجه داشته باشید که باید توکن دسترسی خودتان را مشخص کنید:
GET /youtube/v3/channels?part=snippet&mine=true HTTP/1.1 Host: www.googleapis.com Authorization: Bearer access_token
در اینجا فراخوانی همان API برای کاربر احراز هویت شده با استفاده از پارامتر رشته پرس و جوی access_token مشاهده میکنید:
GET https://www.googleapis.com/youtube/v3/channels?access_token=access_token&part=snippet&mine=true
مثالهای curl
میتوانید این دستورات را با برنامه خط فرمان curl آزمایش کنید. در اینجا مثالی آورده شده است که از گزینه هدر HTTP (ترجیحاً) استفاده میکند:
curl -H "Authorization: Bearer access_token" https://www.googleapis.com/youtube/v3/channels?part=snippet&mine=true
یا، به طور جایگزین، گزینه پارامتر رشته پرس و جو:
curl https://www.googleapis.com/youtube/v3/channels?access_token=access_token&part=snippet&mine=true
مثال کامل
مثال زیر یک شیء با فرمت JSON را چاپ میکند که اطلاعات مربوط به کانال یوتیوب کاربر را پس از احراز هویت کاربر و اعطای مجوز به برنامه برای مدیریت حساب یوتیوب کاربر، نمایش میدهد.
پی اچ پی
برای اجرای این مثال:
- در API Console، آدرس اینترنتی دستگاه محلی را به لیست آدرسهای اینترنتی هدایتشده اضافه کنید. برای مثال،
http://localhost:8080را اضافه کنید. - یک دایرکتوری جدید ایجاد کنید و به آن بروید. برای مثال:
mkdir ~/php-oauth2-example cd ~/php-oauth2-example
- کتابخانه کلاینت API گوگل برای PHP را با استفاده از Composer نصب کنید:
composer require google/apiclient:^2.15.0
- فایلهای
index.phpوoauth2callback.phpرا با محتوای زیر ایجاد کنید. - مثال را با وب سرور تست داخلی PHP اجرا کنید:
php -S localhost:8080 ~/php-oauth2-example
فهرست.php
<?php require_once __DIR__.'/vendor/autoload.php'; session_start(); $client = new Google\Client(); $client->setAuthConfig('client_secret.json'); // User granted permission as an access token is in the session. if (isset($_SESSION['access_token']) && $_SESSION['access_token']) { $client->setAccessToken($_SESSION['access_token']); $youtube = new Google_Service_YouTube($client); $channel = $youtube->channels->listChannels('snippet', array('mine' => $mine)); echo json_encode($channel); } else { // Redirect users to outh2call.php which redirects users to Google OAuth 2.0 $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php'; header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL)); } ?>
oauth2callback.php
<?php require_once __DIR__.'/vendor/autoload.php'; session_start(); $client = new Google\Client(); // Required, call the setAuthConfig function to load authorization credentials from // client_secret.json file. $client->setAuthConfigFile('client_secret.json'); $client->setRedirectUri('http://' . $_SERVER['HTTP_HOST']. $_SERVER['PHP_SELF']); // Required, to set the scope value, call the addScope function. $client->addScope(GOOGLE_SERVICE_YOUTUBE::YOUTUBE_FORCE_SSL); // Enable incremental authorization. Recommended as a best practice. $client->setIncludeGrantedScopes(true); // Recommended, offline access will give you both an access and refresh token so that // your app can refresh the access token without user interaction. $client->setAccessType("offline"); // Generate a URL for authorization as it doesn't contain code and error if (!isset($_GET['code']) && !isset($_GET['error'])) { // Generate and set state value $state = bin2hex(random_bytes(16)); $client->setState($state); $_SESSION['state'] = $state; // Generate a url that asks permissions. $auth_url = $client->createAuthUrl(); header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL)); } // User authorized the request and authorization code is returned to exchange access and // refresh tokens. if (isset($_GET['code'])) { // Check the state value if (!isset($_GET['state']) || $_GET['state'] !== $_SESSION['state']) { die('State mismatch. Possible CSRF attack.'); } // Get access and refresh tokens (if access_type is offline) $token = $client->fetchAccessTokenWithAuthCode($_GET['code']); /** Save access and refresh token to the session variables. * ACTION ITEM: In a production app, you likely want to save the * refresh token in a secure persistent storage instead. */ $_SESSION['access_token'] = $token; $_SESSION['refresh_token'] = $client->getRefreshToken(); $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/'; header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL)); } // An error response e.g. error=access_denied if (isset($_GET['error'])) { echo "Error: ". $_GET['error']; } ?>
پایتون
این مثال از چارچوب Flask استفاده میکند. این مثال یک برنامه وب را در http://localhost:8080 اجرا میکند که به شما امکان میدهد جریان OAuth 2.0 را آزمایش کنید. اگر به آن URL بروید، باید پنج لینک ببینید:
- تست یک درخواست API: این لینک به صفحهای اشاره میکند که سعی در اجرای یک درخواست API نمونه دارد. در صورت لزوم، جریان مجوزدهی را آغاز میکند. در صورت موفقیت، صفحه پاسخ API را نمایش میدهد.
- جریان احراز هویت را مستقیماً آزمایش کنید: این لینک به صفحهای اشاره میکند که سعی دارد کاربر را از طریق جریان احراز هویت هدایت کند. برنامه درخواست مجوز ارسال درخواستهای API مجاز را از طرف کاربر درخواست میکند.
- لغو اعتبارنامههای فعلی: این پیوند به صفحهای اشاره میکند که مجوزهایی را که کاربر قبلاً به برنامه اعطا کرده است، لغو میکند .
- پاک کردن اعتبارنامههای جلسه Flask: این لینک اعتبارنامههای مجوز ذخیره شده در جلسه Flask را پاک میکند. این به شما امکان میدهد ببینید اگر کاربری که قبلاً به برنامه شما مجوز داده است، سعی کند یک درخواست API را در یک جلسه جدید اجرا کند، چه اتفاقی میافتد. همچنین به شما امکان میدهد پاسخ API را که برنامه شما دریافت میکند، در صورتی که کاربری مجوزهای اعطا شده به برنامه شما را لغو کرده باشد و برنامه شما همچنان سعی در تأیید درخواستی با یک توکن دسترسی لغو شده داشته باشد، مشاهده کنید.
# -*- coding: utf-8 -*- import os import flask import json import requests import google.oauth2.credentials import google_auth_oauthlib.flow import googleapiclient.discovery # This variable specifies the name of a file that contains the OAuth 2.0 # information for this application, including its client_id and client_secret. CLIENT_SECRETS_FILE = "client_secret.json" # The OAuth 2.0 access scope allows for access to the # authenticated user's account and requires requests to use an SSL connection. SCOPES = ['https://www.googleapis.com/auth/youtube.force-ssl'] API_SERVICE_NAME = 'youtube' API_VERSION = 'v3' app = flask.Flask(__name__) # Note: A secret key is included in the sample so that it works. # If you use this code in your application, replace this with a truly secret # key. See https://flask.palletsprojects.com/quickstart/#sessions. app.secret_key = 'REPLACE ME - this value is here as a placeholder.' @app.route('/') def index(): return print_index_table() @app.route('/test') def test_api_request(): if 'credentials' not in flask.session: return flask.redirect('authorize') # Load credentials from the session. credentials = google.oauth2.credentials.Credentials( **flask.session['credentials']) youtube = googleapiclient.discovery.build( API_SERVICE_NAME, API_VERSION, credentials=credentials) channel = youtube.channels().list(mine=True, part='snippet').execute() # Save credentials back to session in case access token was refreshed. # ACTION ITEM: In a production app, you likely want to save these # credentials in a persistent database instead. flask.session['credentials'] = credentials_to_dict(credentials) return flask.jsonify(**channel) @app.route('/authorize') def authorize(): # Create flow instance to manage the OAuth 2.0 Authorization Grant Flow steps. flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file( CLIENT_SECRETS_FILE, scopes=SCOPES) # The URI created here must exactly match one of the authorized redirect URIs # for the OAuth 2.0 client, which you configured in the API Console. If this # value doesn't match an authorized URI, you will get a 'redirect_uri_mismatch' # error. flow.redirect_uri = flask.url_for('oauth2callback', _external=True) authorization_url, state = flow.authorization_url( # Enable offline access so that you can refresh an access token without # re-prompting the user for permission. Recommended for web server apps. access_type='offline', # Enable incremental authorization. Recommended as a best practice. include_granted_scopes='true') # Store the state so the callback can verify the auth server response. flask.session['state'] = state return flask.redirect(authorization_url) @app.route('/oauth2callback') def oauth2callback(): # Specify the state when creating the flow in the callback so that it can # verified in the authorization server response. state = flask.session['state'] flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file( CLIENT_SECRETS_FILE, scopes=SCOPES, state=state) flow.redirect_uri = flask.url_for('oauth2callback', _external=True) # Use the authorization server's response to fetch the OAuth 2.0 tokens. authorization_response = flask.request.url flow.fetch_token(authorization_response=authorization_response) # Store credentials in the session. # ACTION ITEM: In a production app, you likely want to save these # credentials in a persistent database instead. credentials = flow.credentials flask.session['credentials'] = credentials_to_dict(credentials) return flask.redirect(flask.url_for('test_api_request')) @app.route('/revoke') def revoke(): if 'credentials' not in flask.session: return ('You need to <a href="/authorize">authorize</a> before ' + 'testing the code to revoke credentials.') # Load client secrets from the server-side file. with open(CLIENT_SECRETS_FILE, 'r') as f: client_config = json.load(f)['web'] # Load user-specific credentials from the session. session_credentials = flask.session['credentials'] # Reconstruct the credentials object. credentials = google.oauth2.credentials.Credentials( refresh_token=session_credentials.get('refresh_token'), scopes=session_credentials.get('granted_scopes'), token=session_credentials.get('token'), client_id=client_config.get('client_id'), client_secret=client_config.get('client_secret'), token_uri=client_config.get('token_uri')) revoke = requests.post('https://oauth2.googleapis.com/revoke', params={'token': credentials.token}, headers = {'content-type': 'application/x-www-form-urlencoded'}) status_code = getattr(revoke, 'status_code') if status_code == 200: # Clear the user's session credentials after successful revocation if 'credentials' in flask.session: del flask.session['credentials'] del flask.session['features'] return('Credentials successfully revoked.' + print_index_table()) else: return('An error occurred.' + print_index_table()) @app.route('/clear') def clear_credentials(): if 'credentials' in flask.session: del flask.session['credentials'] return ('Credentials have been cleared.<br><br>' + print_index_table()) def credentials_to_dict(credentials): return {'token': credentials.token, 'refresh_token': credentials.refresh_token, 'granted_scopes': credentials.granted_scopes} def print_index_table(): return ('<table>' + '<tr><td><a href="/test">Test an API request</a></td>' + '<td>Submit an API request and see a formatted JSON response. ' + ' Go through the authorization flow if there are no stored ' + ' credentials for the user.</td></tr>' + '<tr><td><a href="/revoke">Revoke current credentials</a></td>' + '<td>Revoke the access token associated with the current user ' + ' session. After revoking credentials, if you go to the test ' + ' page, you should see an <code>invalid_grant</code> error.' + '</td></tr>' + '<tr><td><a href="/clear">Clear Flask session credentials</a></td>' + '<td>Clear the access token currently stored in the user session. ' + ' After clearing the token, if you <a href="/test">test the ' + ' API request</a> ' + ' again, you should go back to the auth flow.' + '</td></tr></table>') if __name__ == '__main__': # When running locally, disable OAuthlib's HTTPs verification. # ACTION ITEM for developers: # When running in production *do not* leave this option enabled. os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1' # This disables the requested scopes and granted scopes check. # If users only grant partial request, the warning would not be thrown. os.environ['OAUTHLIB_RELAX_TOKEN_SCOPE'] = '1' # Specify a hostname and port that are set as a valid redirect URI # for your API project in the Google API Console. app.run('localhost', 8080, debug=True)
روبی
این مثال از چارچوب Sinatra استفاده میکند.
require 'googleauth' require 'googleauth/web_user_authorizer' require 'googleauth/stores/redis_token_store' require 'google/apis/youtube_v3' require 'sinatra' configure do enable :sessions # Required, call the from_file method to retrieve the client ID from a # client_secret.json file. set :client_id, Google::Auth::ClientId.from_file('/path/to/client_secret.json') # Required, scope value # Access scopes for retrieving data about the user's YouTube channel. scope = 'Google::Apis::YoutubeV3::AUTH_YOUTUBE_FORCE_SSL' # Required, Authorizers require a storage instance to manage long term persistence of # access and refresh tokens. set :token_store, Google::Auth::Stores::RedisTokenStore.new(redis: Redis.new) # Required, indicate where the API server will redirect the user after the user completes # the authorization flow. The redirect URI is required. The value must exactly # match one of the authorized redirect URIs for the OAuth 2.0 client, which you # configured in the API Console. If this value doesn't match an authorized URI, # you will get a 'redirect_uri_mismatch' error. set :callback_uri, '/oauth2callback' # To use OAuth2 authentication, we need access to a CLIENT_ID, CLIENT_SECRET, AND REDIRECT_URI # from the client_secret.json file. To get these credentials for your application, visit # https://console.cloud.google.com/apis/credentials. set :authorizer, Google::Auth::WebUserAuthorizer.new(settings.client_id, settings.scope, settings.token_store, callback_uri: settings.callback_uri) end get '/' do # NOTE: Assumes the user is already authenticated to the app user_id = request.session['user_id'] # Fetch stored credentials for the user from the given request session. # nil if none present credentials = settings.authorizer.get_credentials(user_id, request) if credentials.nil? # Generate a url that asks the user to authorize requested scope(s). # Then, redirect user to the url. redirect settings.authorizer.get_authorization_url(request: request) end # User authorized read-only YouTube Data API permission. # Example of using YouTube Data API to list user's YouTube channel youtube = Google::Apis::YoutubeV3::YouTubeService.new channel = youtube.list_channels(part, :mine => mine, options: { authorization: auth_client }) "<pre>#{JSON.pretty_generate(channel.to_h)}</pre>" end # Receive the callback from Google's OAuth 2.0 server. get '/oauth2callback' do # Handle the result of the oauth callback. Defers the exchange of the code by # temporarily stashing the results in the user's session. target_url = Google::Auth::WebUserAuthorizer.handle_auth_callback_deferred(request) redirect target_url end
نود جی اس
برای اجرای این مثال:
- در API Console، آدرس اینترنتی دستگاه محلی را به لیست آدرسهای اینترنتی هدایتشده اضافه کنید. برای مثال،
http://localhostرا اضافه کنید. - مطمئن شوید که نسخهٔ پشتیبانی بلندمدت (LTS)، پشتیبانی بلندمدت فعال (LTS) یا آخرین نسخهٔ Node.js را نصب کردهاید.
- یک دایرکتوری جدید ایجاد کنید و به آن بروید. برای مثال:
mkdir ~/nodejs-oauth2-example cd ~/nodejs-oauth2-example
- کتابخانه کلاینت API گوگل را برای Node.js با استفاده از npm نصب کنید:
npm install googleapis
- فایل
main.jsرا با محتوای زیر ایجاد کنید. - مثال را اجرا کنید:
node .\main.js
فایل اصلی.js
const http = require('http'); const https = require('https'); const url = require('url'); const { google } = require('googleapis'); const crypto = require('crypto'); const express = require('express'); const session = require('express-session'); /** * To use OAuth2 authentication, we need access to a CLIENT_ID, CLIENT_SECRET, AND REDIRECT_URI. * To get these credentials for your application, visit * https://console.cloud.google.com/apis/credentials. */ const oauth2Client = new google.auth.OAuth2( YOUR_CLIENT_ID, YOUR_CLIENT_SECRET, YOUR_REDIRECT_URL ); // Access scopes for YouTube API const scopes = [ 'https://www.googleapis.com/auth/youtube.force-ssl' ]; /* Global variable that stores user credential in this code example. * ACTION ITEM for developers: * Store user's refresh token in your data store if * incorporating this code into your real app. * For more information on handling refresh tokens, * see https://github.com/googleapis/google-api-nodejs-client#handling-refresh-tokens */ let userCredential = null; async function main() { const app = express(); app.use(session({ secret: 'your_secure_secret_key', // Replace with a strong secret resave: false, saveUninitialized: false, })); // Example on redirecting user to Google's OAuth 2.0 server. app.get('/', async (req, res) => { // Generate a secure random state value. const state = crypto.randomBytes(32).toString('hex'); // Store state in the session req.session.state = state; // Generate a url that asks permissions for the Drive activity and Google Calendar scope const authorizationUrl = oauth2Client.generateAuthUrl({ // 'online' (default) or 'offline' (gets refresh_token) access_type: 'offline', /** Pass in the scopes array defined above. * Alternatively, if only one scope is needed, you can pass a scope URL as a string */ scope: scopes, // Enable incremental authorization. Recommended as a best practice. include_granted_scopes: true, // Include the state parameter to reduce the risk of CSRF attacks. state: state }); res.redirect(authorizationUrl); }); // Receive the callback from Google's OAuth 2.0 server. app.get('/oauth2callback', async (req, res) => { // Handle the OAuth 2.0 server response let q = url.parse(req.url, true).query; if (q.error) { // An error response e.g. error=access_denied console.log('Error:' + q.error); } else if (q.state !== req.session.state) { //check state value console.log('State mismatch. Possible CSRF attack'); res.end('State mismatch. Possible CSRF attack'); } else { // Get access and refresh tokens (if access_type is offline) let { tokens } = await oauth2Client.getToken(q.code); oauth2Client.setCredentials(tokens); /** Save credential to the global variable in case access token was refreshed. * ACTION ITEM: In a production app, you likely want to save the refresh token * in a secure persistent database instead. */ userCredential = tokens; // Example of using YouTube API to list channels. var service = google.youtube('v3'); service.channels.list({ auth: oauth2Client, part: 'snippet,contentDetails,statistics', forUsername: 'GoogleDevelopers' }, function (err, response) { if (err) { console.log('The API returned an error: ' + err); return; } var channels = response.data.items; if (channels.length == 0) { console.log('No channel found.'); } else { console.log('This channel\'s ID is %s. Its title is \'%s\', and ' + 'it has %s views.', channels[0].id, channels[0].snippet.title, channels[0].statistics.viewCount); } }); } }); // Example on revoking a token app.get('/revoke', async (req, res) => { // Build the string for the POST request let postData = "token=" + userCredential.access_token; // Options for POST request to Google's OAuth 2.0 server to revoke a token let postOptions = { host: 'oauth2.googleapis.com', port: '443', path: '/revoke', method: 'POST', headers: { 'Content-Type': 'application/x-www-form-urlencoded', 'Content-Length': Buffer.byteLength(postData) } }; // Set up the request const postReq = https.request(postOptions, function (res) { res.setEncoding('utf8'); res.on('data', d => { console.log('Response: ' + d); }); }); postReq.on('error', error => { console.log(error) }); // Post the request with data postReq.write(postData); postReq.end(); }); const server = http.createServer(app); server.listen(8080); } main().catch(console.error);
HTTP/REST
این مثال پایتون از چارچوب Flask و کتابخانه Requests برای نمایش جریان وب OAuth 2.0 استفاده میکند. توصیه میکنیم برای این جریان از کتابخانه کلاینت Google API برای پایتون استفاده کنید. (مثال موجود در تب پایتون از کتابخانه کلاینت استفاده میکند.)
import json import flask import requests app = flask.Flask(__name__) # To get these credentials (CLIENT_ID CLIENT_SECRET) and for your application, visit # https://console.cloud.google.com/apis/credentials. CLIENT_ID = '123456789.apps.googleusercontent.com' CLIENT_SECRET = 'abc123' # Read from a file or environmental variable in a real app # Access scopes for YouTube API SCOPE = 'https://www.googleapis.com/auth/youtube.force-ssl' # Indicate where the API server will redirect the user after the user completes # the authorization flow. The redirect URI is required. The value must exactly # match one of the authorized redirect URIs for the OAuth 2.0 client, which you # configured in the API Console. If this value doesn't match an authorized URI, # you will get a 'redirect_uri_mismatch' error. REDIRECT_URI = 'http://example.com/oauth2callback' @app.route('/') def index(): if 'credentials' not in flask.session: return flask.redirect(flask.url_for('oauth2callback')) credentials = json.loads(flask.session['credentials']) if credentials['expires_in'] <= 0: return flask.redirect(flask.url_for('oauth2callback')) else: headers = {'Authorization': 'Bearer {}'.format(credentials['access_token'])} req_uri = 'https://www.googleapis.com/youtube/v3/channels/list' r = requests.get(req_uri, headers=headers) return r.text @app.route('/oauth2callback') def oauth2callback(): if 'code' not in flask.request.args: state = str(uuid.uuid4()) flask.session['state'] = state # Generate a url that asks permissions for the Drive activity # and Google Calendar scope. Then, redirect user to the url. auth_uri = ('https://accounts.google.com/o/oauth2/v2/auth?response_type=code' '&client_id={}&redirect_uri={}&scope={}&state={}').format(CLIENT_ID, REDIRECT_URI, SCOPE, state) return flask.redirect(auth_uri) else: if 'state' not in flask.request.args or flask.request.args['state'] != flask.session['state']: return 'State mismatch. Possible CSRF attack.', 400 auth_code = flask.request.args.get('code') data = {'code': auth_code, 'client_id': CLIENT_ID, 'client_secret': CLIENT_SECRET, 'redirect_uri': REDIRECT_URI, 'grant_type': 'authorization_code'} # Exchange authorization code for access and refresh tokens (if access_type is offline) r = requests.post('https://oauth2.googleapis.com/token', data=data) flask.session['credentials'] = r.text return flask.redirect(flask.url_for('index')) if __name__ == '__main__': import uuid app.secret_key = str(uuid.uuid4()) app.debug = False app.run()
قوانین اعتبارسنجی URI ریدایرکت
گوگل قوانین اعتبارسنجی زیر را برای ریدایرکت URIها اعمال میکند تا به توسعهدهندگان کمک کند برنامههای خود را ایمن نگه دارند. ریدایرکت URIهای شما باید از این قوانین پیروی کنند. برای تعریف دامنه، میزبان، مسیر، پرسوجو، طرحواره و اطلاعات کاربر که در زیر ذکر شده است، به بخش ۳ RFC 3986 مراجعه کنید.
| قوانین اعتبارسنجی | |
|---|---|
| طرح | آدرسهای اینترنتی تغییر مسیر (Redirect URI) باید از طرح HTTPS استفاده کنند، نه HTTP ساده. آدرسهای اینترنتی میزبان محلی (شامل آدرسهای اینترنتی آدرس IP میزبان محلی) از این قانون مستثنی هستند. |
| میزبان | میزبانها نمیتوانند آدرسهای IP خام باشند. آدرسهای IP میزبان محلی از این قانون مستثنی هستند. |
| دامنه | “googleusercontent.com” باشند.goo.gl ) باشند، مگر اینکه برنامه مالک آن دامنه باشد. علاوه بر این، اگر برنامهای که مالک دامنه کوتاهکننده است، تصمیم به تغییر مسیر به آن دامنه بگیرد، آن آدرس URL تغییر مسیر باید یا حاوی “/google-callback/” در مسیر خود باشد یا با “/google-callback” به پایان برسد. |
| اطلاعات کاربری | آدرسهای URL تغییر مسیر نمیتوانند شامل زیرمولفه userinfo باشند. |
| مسیر | URI های ریدایرکت نمیتوانند شامل پیمایش مسیر (که به آن بازگشت به عقب دایرکتوری نیز گفته میشود) باشند، که با |
| پرس و جو | آدرسهای URL تغییر مسیر نمیتوانند شامل تغییر مسیرهای باز باشند. |
| قطعه | URI های ریدایرکت نمیتوانند شامل کامپوننت fragment باشند. |
| شخصیتها | URI های ریدایرکت نمیتوانند شامل کاراکترهای خاصی از جمله موارد زیر باشند:
|
مجوز افزایشی
در پروتکل OAuth 2.0، برنامه شما برای دسترسی به منابعی که توسط scopeها مشخص میشوند، درخواست مجوز میکند. درخواست مجوز برای منابع در زمانی که به آنها نیاز دارید، بهترین روش برای تجربه کاربری محسوب میشود. برای فعال کردن این روش، سرور احراز هویت گوگل از احراز هویت افزایشی پشتیبانی میکند. این ویژگی به شما امکان میدهد scopeها را در صورت نیاز درخواست کنید و اگر کاربر مجوز scope جدید را اعطا کند، یک کد احراز هویت را برمیگرداند که میتواند با توکنی حاوی تمام scopeهایی که کاربر به پروژه اعطا کرده است، مبادله شود.
برای مثال، فرض کنید یک برنامه به کاربران کمک میکند تا رویدادهای محلی جالب را شناسایی کنند. این برنامه به کاربران امکان میدهد ویدیوهای مربوط به رویدادها را مشاهده کنند، به ویدیوها امتیاز دهند و ویدیوها را به لیست پخش اضافه کنند. کاربران همچنین میتوانند از این برنامه برای اضافه کردن رویدادها به تقویم گوگل خود استفاده کنند.
در این حالت، در زمان ورود به سیستم، ممکن است برنامه نیازی به دسترسی به هیچ محدودهای نداشته باشد یا درخواست دسترسی به آن را نداشته باشد. با این حال، اگر کاربر سعی کند به یک ویدیو امتیاز دهد، ویدیویی را به لیست پخش اضافه کند یا اقدام دیگری در یوتیوب انجام دهد، برنامه میتواند درخواست دسترسی به محدوده https://www.googleapis.com/auth/youtube.force-ssl را داشته باشد. به طور مشابه، اگر کاربر سعی کند یک رویداد تقویم اضافه کند، برنامه میتواند درخواست دسترسی به محدوده https://www.googleapis.com/auth/calendar را داشته باشد.
برای پیادهسازی مجوزدهی افزایشی، شما روند عادی درخواست یک توکن دسترسی را تکمیل میکنید، اما مطمئن میشوید که درخواست مجوز شامل محدودههای قبلاً اعطا شده نیز میشود. این رویکرد به برنامه شما اجازه میدهد تا از مدیریت چندین توکن دسترسی اجتناب کند.
قوانین زیر در مورد توکن دسترسی که از طریق مجوز افزایشی به دست میآید، اعمال میشود:
- این توکن میتواند برای دسترسی به منابع مربوط به هر یک از حوزههای موجود در مجوز ترکیبی جدید استفاده شود.
- وقتی از توکن بهروزرسانی برای مجوز ترکیبی جهت دریافت توکن دسترسی استفاده میکنید، توکن دسترسی نشاندهنده مجوز ترکیبی است و میتواند برای هر یک از مقادیر
scopeموجود در پاسخ استفاده شود. - مجوز ترکیبی شامل تمام حوزههایی است که کاربر به پروژه API اعطا کرده است، حتی اگر این مجوزها از کلاینتهای مختلف درخواست شده باشند. به عنوان مثال، اگر کاربری با استفاده از کلاینت دسکتاپ یک برنامه، دسترسی به یک حوزه را اعطا کند و سپس از طریق یک کلاینت موبایل، حوزه دیگری را به همان برنامه اعطا کند، مجوز ترکیبی شامل هر دو حوزه خواهد بود.
- اگر توکنی را که نشاندهندهی یک مجوز ترکیبی است، لغو کنید، دسترسی به تمام حوزههای آن مجوز از طرف کاربر مرتبط بهطور همزمان لغو میشود.
نمونههای کد مختص زبان در مرحله ۱: تنظیم پارامترهای مجوز و نمونه URL ریدایرکت HTTP/REST در مرحله ۲: ریدایرکت به سرور OAuth 2.0 گوگل، همگی از مجوزدهی افزایشی استفاده میکنند. نمونههای کد زیر همچنین کدی را که برای استفاده از مجوزدهی افزایشی باید اضافه کنید، نشان میدهند.
پی اچ پی
$client->setIncludeGrantedScopes(true);پایتون
در پایتون، آرگومان کلمه کلیدی include_granted_scopes را روی true تنظیم کنید تا مطمئن شوید که درخواست مجوز شامل محدودههای قبلاً اعطا شده نیز میشود. بسیار محتمل است که include_granted_scopes تنها آرگومان کلمه کلیدی نباشد که تنظیم میکنید، همانطور که در مثال زیر نشان داده شده است.
authorization_url, state = flow.authorization_url( # Enable offline access so that you can refresh an access token without # re-prompting the user for permission. Recommended for web server apps. access_type='offline', # Enable incremental authorization. Recommended as a best practice. include_granted_scopes='true')
روبی
auth_client.update!( :additional_parameters => {"include_granted_scopes" => "true"} )
نود جی اس
const authorizationUrl = oauth2Client.generateAuthUrl({ // 'online' (default) or 'offline' (gets refresh_token) access_type: 'offline', /** Pass in the scopes array defined above. * Alternatively, if only one scope is needed, you can pass a scope URL as a string */ scope: scopes, // Enable incremental authorization. Recommended as a best practice. include_granted_scopes: true });
HTTP/REST
در این مثال، برنامهی فراخوانیکننده علاوه بر هرگونه دسترسی دیگری که کاربر قبلاً به برنامه اعطا کرده است، درخواست دسترسی برای بازیابی دادههای YouTube Analytics کاربر را نیز دارد.
GET https://accounts.google.com/o/oauth2/v2/auth?
scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyt-analytics.readonly&
access_type=offline&
state=security_token%3D138rk%3Btarget_url%3Dhttp...index&
redirect_uri=http%3A%2F%2Flocalhost%2Foauth2callback&
response_type=code&
client_id=client_id&
include_granted_scopes=true
Refreshing an access token (offline access)
Access tokens periodically expire and become invalid credentials for a related API request. You can refresh an access token without prompting the user for permission (including when the user is not present) if you requested offline access to the scopes associated with the token.
- If you use a Google API Client Library, the client object refreshes the access token as needed as long as you configure that object for offline access.
- If you are not using a client library, you need to set the
access_typeHTTP query parameter toofflinewhen redirecting the user to Google's OAuth 2.0 server. In that case, Google's authorization server returns a refresh token when you exchange an authorization code for an access token. Then, if the access token expires (or at any other time), you can use a refresh token to obtain a new access token.
Requesting offline access is a requirement for any application that needs to access a Google
API when the user is not present. For example, an app that performs backup services or
executes actions at predetermined times needs to be able to refresh its access token when the
user is not present. The default style of access is called online.
Server-side web applications, installed applications, and devices all obtain refresh tokens during the authorization process. Refresh tokens are not typically used in client-side (JavaScript) web applications.
PHP
If your application needs offline access to a Google API, set the API client's access type to
offline:
$client->setAccessType("offline");پس از اینکه کاربر دسترسی آفلاین به محدودههای درخواستی را اعطا کرد، میتوانید از کلاینت API برای دسترسی به APIهای گوگل از طرف کاربر در حالت آفلاین استفاده کنید. شیء کلاینت در صورت نیاز، توکن دسترسی را بهروزرسانی میکند.
پایتون
در پایتون، آرگومان کلمه کلیدی access_type را روی offline تنظیم کنید تا مطمئن شوید که میتوانید توکن دسترسی را بدون نیاز به درخواست مجدد مجوز از کاربر، بهروزرسانی کنید. بسیار محتمل است که access_type تنها آرگومان کلمه کلیدی تنظیم شده نباشد، همانطور که در مثال زیر نشان داده شده است.
authorization_url, state = flow.authorization_url( # Enable offline access so that you can refresh an access token without # re-prompting the user for permission. Recommended for web server apps. access_type='offline', # Enable incremental authorization. Recommended as a best practice. include_granted_scopes='true')
پس از اینکه کاربر دسترسی آفلاین به محدودههای درخواستی را اعطا کرد، میتوانید از کلاینت API برای دسترسی به APIهای گوگل از طرف کاربر در حالت آفلاین استفاده کنید. شیء کلاینت در صورت نیاز، توکن دسترسی را بهروزرسانی میکند.
روبی
اگر برنامه شما نیاز به دسترسی آفلاین به API گوگل دارد، نوع دسترسی کلاینت API را روی offline تنظیم کنید:
auth_client.update!( :additional_parameters => {"access_type" => "offline"} )
پس از اینکه کاربر دسترسی آفلاین به محدودههای درخواستی را اعطا کرد، میتوانید از کلاینت API برای دسترسی به APIهای گوگل از طرف کاربر در حالت آفلاین استفاده کنید. شیء کلاینت در صورت نیاز، توکن دسترسی را بهروزرسانی میکند.
نود جی اس
اگر برنامه شما نیاز به دسترسی آفلاین به API گوگل دارد، نوع دسترسی کلاینت API را روی offline تنظیم کنید:
const authorizationUrl = oauth2Client.generateAuthUrl({ // 'online' (default) or 'offline' (gets refresh_token) access_type: 'offline', /** Pass in the scopes array defined above. * Alternatively, if only one scope is needed, you can pass a scope URL as a string */ scope: scopes, // Enable incremental authorization. Recommended as a best practice. include_granted_scopes: true });
پس از اینکه کاربر دسترسی آفلاین به محدودههای درخواستی را اعطا کرد، میتوانید از کلاینت API برای دسترسی به APIهای گوگل از طرف کاربر در حالت آفلاین استفاده کنید. شیء کلاینت در صورت نیاز، توکن دسترسی را بهروزرسانی میکند.
توکنهای دسترسی منقضی میشوند. این کتابخانه در صورت نزدیک شدن به انقضا، به طور خودکار از یک توکن تازهسازی برای دریافت یک توکن دسترسی جدید استفاده میکند. یک راه آسان برای اطمینان از اینکه همیشه جدیدترین توکنها را ذخیره میکنید، استفاده از رویداد توکنها است:
oauth2Client.on('tokens', (tokens) => { if (tokens.refresh_token) { // store the refresh_token in your secure persistent database console.log(tokens.refresh_token); } console.log(tokens.access_token); });
این رویداد توکنها فقط در اولین مجوزدهی رخ میدهد و شما باید هنگام فراخوانی متد generateAuthUrl برای دریافت توکن بهروزرسانی، access_type خود را روی offline تنظیم کرده باشید. اگر قبلاً مجوزهای لازم را بدون تعیین محدودیتهای مناسب برای دریافت توکن بهروزرسانی به برنامه خود دادهاید، باید برنامه را برای دریافت توکن بهروزرسانی جدید مجدداً مجوزدهی کنید.
برای تنظیم refresh_token در زمان دیگری، میتوانید از متد setCredentials استفاده کنید:
oauth2Client.setCredentials({ refresh_token: `STORED_REFRESH_TOKEN` });
به محض اینکه کلاینت یک توکن بهروزرسانی (refresh token) دریافت کند، توکنهای دسترسی به طور خودکار در فراخوانی بعدی API دریافت و بهروزرسانی میشوند.
HTTP/REST
برای بهروزرسانی یک توکن دسترسی، برنامه شما یک درخواست HTTPS POST به سرور احراز هویت گوگل ( https://oauth2.googleapis.com/token ) ارسال میکند که شامل پارامترهای زیر است:
| فیلدها | |
|---|---|
client_id | شناسه کلاینت به دست آمده از API Console. |
client_secret | اختیاری راز مشتری که از ... به دست آمده است API Console. |
grant_type | همانطور که در مشخصات OAuth 2.0 تعریف شده است ، مقدار این فیلد باید برابر با refresh_token تنظیم شود. |
refresh_token | توکن بهروزرسانی که از تبادل کد مجوز بازگردانده شده است. |
قطعه کد زیر یک نمونه درخواست را نشان میدهد:
POST /token HTTP/1.1 Host: oauth2.googleapis.com Content-Type: application/x-www-form-urlencoded client_id=your_client_id& refresh_token=refresh_token& grant_type=refresh_token
تا زمانی که کاربر دسترسی اعطا شده به برنامه را لغو نکرده باشد، سرور توکن یک شیء JSON را که حاوی یک توکن دسترسی جدید است، برمیگرداند. قطعه کد زیر یک نمونه پاسخ را نشان میدهد:
{ "access_token": "1/fFAGRNJru1FTz70BzhT3Zg", "expires_in": 3920, "scope": "https://www.googleapis.com/auth/drive.metadata.readonly", "token_type": "Bearer" }
توجه داشته باشید که محدودیتهایی در تعداد توکنهای بهروزرسانی که صادر میشوند وجود دارد؛ یک محدودیت برای هر ترکیب کلاینت/کاربر، و محدودیت دیگر برای هر کاربر در تمام کلاینتها. شما باید توکنهای بهروزرسانی را در حافظه بلندمدت ذخیره کنید و تا زمانی که معتبر هستند، به استفاده از آنها ادامه دهید. اگر برنامه شما توکنهای بهروزرسانی زیادی درخواست کند، ممکن است با این محدودیتها مواجه شود، که در این صورت توکنهای بهروزرسانی قدیمیتر از کار میافتند.
ابطال توکن
در برخی موارد، کاربر ممکن است بخواهد دسترسی داده شده به یک برنامه را لغو کند. کاربر میتواند با مراجعه به تنظیمات حساب ، دسترسی را لغو کند. برای اطلاعات بیشتر، به بخش «حذف دسترسی سایت یا برنامه» در سند پشتیبانی سایتها و برنامههای شخص ثالث با دسترسی به حساب شما مراجعه کنید.
همچنین ممکن است یک برنامه به صورت برنامهنویسیشده دسترسیهای دادهشده به خود را لغو کند. لغو برنامهریزیشده در مواردی که کاربر اشتراک خود را لغو میکند، برنامه را حذف میکند یا منابع API مورد نیاز یک برنامه بهطور قابلتوجهی تغییر کرده است، مهم است. به عبارت دیگر، بخشی از فرآیند حذف میتواند شامل یک درخواست API باشد تا اطمینان حاصل شود که مجوزهایی که قبلاً به برنامه اعطا شده است، حذف میشوند.
پی اچ پی
برای لغو یک توکن از طریق برنامهنویسی، تابع revokeToken() را فراخوانی کنید:
$client->revokeToken();پایتون
برای لغو یک توکن از طریق برنامهنویسی، درخواستی به https://oauth2.googleapis.com/revoke ارسال کنید که شامل توکن به عنوان پارامتر باشد و هدر Content-Type را تنظیم کند:
requests.post('https://oauth2.googleapis.com/revoke', params={'token': credentials.token}, headers = {'content-type': 'application/x-www-form-urlencoded'})
روبی
برای لغو یک توکن از طریق برنامهنویسی، یک درخواست HTTP به نقطه پایانی oauth2.revoke ارسال کنید:
uri = URI('https://oauth2.googleapis.com/revoke') response = Net::HTTP.post_form(uri, 'token' => auth_client.access_token)
این توکن میتواند یک توکن دسترسی یا یک توکن بهروزرسانی باشد. اگر توکن، توکن دسترسی باشد و یک توکن بهروزرسانی متناظر داشته باشد، توکن بهروزرسانی نیز لغو خواهد شد.
اگر ابطال با موفقیت پردازش شود، کد وضعیت پاسخ 200 است. برای شرایط خطا، کد وضعیت 400 به همراه کد خطا بازگردانده میشود.
نود جی اس
برای لغو یک توکن از طریق برنامهنویسی، یک درخواست HTTPS POST به /revoke endpoint ارسال کنید:
const https = require('https'); // Build the string for the POST request let postData = "token=" + userCredential.access_token; // Options for POST request to Google's OAuth 2.0 server to revoke a token let postOptions = { host: 'oauth2.googleapis.com', port: '443', path: '/revoke', method: 'POST', headers: { 'Content-Type': 'application/x-www-form-urlencoded', 'Content-Length': Buffer.byteLength(postData) } }; // Set up the request const postReq = https.request(postOptions, function (res) { res.setEncoding('utf8'); res.on('data', d => { console.log('Response: ' + d); }); }); postReq.on('error', error => { console.log(error) }); // Post the request with data postReq.write(postData); postReq.end();
پارامتر token میتواند یک access token یا refresh token باشد. اگر token یک access token باشد و یک refresh token متناظر داشته باشد، refresh token نیز لغو خواهد شد.
اگر ابطال با موفقیت پردازش شود، کد وضعیت پاسخ 200 است. برای شرایط خطا، کد وضعیت 400 به همراه کد خطا بازگردانده میشود.
HTTP/REST
برای لغو یک توکن از طریق برنامهنویسی، برنامه شما درخواستی به https://oauth2.googleapis.com/revoke ارسال میکند و توکن را به عنوان پارامتر وارد میکند:
curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
https://oauth2.googleapis.com/revoke?token={token}این توکن میتواند یک توکن دسترسی یا یک توکن بهروزرسانی باشد. اگر توکن، توکن دسترسی باشد و یک توکن بهروزرسانی متناظر داشته باشد، توکن بهروزرسانی نیز لغو خواهد شد.
اگر ابطال با موفقیت پردازش شود، کد وضعیت HTTP پاسخ 200 است. برای شرایط خطا، کد وضعیت HTTP 400 به همراه یک کد خطا بازگردانده میشود.
دسترسی مبتنی بر زمان
دسترسی مبتنی بر زمان به کاربر اجازه میدهد تا برای تکمیل یک اقدام، به برنامه شما دسترسی به دادههای خود را برای مدت محدودی اعطا کند. دسترسی مبتنی بر زمان در محصولات منتخب گوگل در طول جریان رضایت در دسترس است و به کاربران این امکان را میدهد که برای مدت زمان محدودی به دادهها دسترسی بدهند. به عنوان مثال، رابط برنامهنویسی کاربردی (API) قابلیت انتقال دادهها (Data Portability API) امکان انتقال یکباره دادهها را فراهم میکند.
وقتی کاربری به برنامه شما دسترسی مبتنی بر زمان میدهد، توکن بهروزرسانی پس از مدت زمان مشخصشده منقضی میشود. توجه داشته باشید که توکنهای بهروزرسانی ممکن است تحت شرایط خاص زودتر نامعتبر شوند؛ برای جزئیات بیشتر به این موارد مراجعه کنید. فیلد refresh_token_expires_in که در پاسخ تبادل کد مجوز برگردانده میشود، نشان دهنده زمان باقیمانده تا انقضای توکن بهروزرسانی در چنین مواردی است.
پیادهسازی حفاظت از حسابهای کاربری متقابل
گام دیگری که باید برای محافظت از حسابهای کاربران خود بردارید، پیادهسازی محافظت بین حسابهای کاربری با استفاده از سرویس محافظت بین حسابهای کاربری گوگل است. این سرویس به شما امکان میدهد در اعلانهای رویدادهای امنیتی مشترک شوید که اطلاعاتی در مورد تغییرات عمده در حساب کاربری به برنامه شما ارائه میدهند. سپس میتوانید بسته به نحوه واکنش خود به رویدادها، از این اطلاعات برای انجام اقدامات لازم استفاده کنید.
برخی از نمونههای انواع رویدادهایی که توسط سرویس حفاظت از حسابهای کاربری متقابل گوگل به برنامه شما ارسال میشوند عبارتند از:
-
https://schemas.openid.net/secevent/risc/event-type/sessions-revoked -
https://schemas.openid.net/secevent/oauth/event-type/token-revoked -
https://schemas.openid.net/secevent/risc/event-type/account-disabled
برای اطلاعات بیشتر در مورد نحوه پیادهسازی محافظت از حسابهای کاربری بینحسابی و فهرست کامل رویدادهای موجود، به صفحه «محافظت از حسابهای کاربری با محافظت از حسابهای کاربری بینحسابی» مراجعه کنید.