הטמעה של שרת OAuth 2.0

כל פעולה smart home חייבת לכלול מנגנון אימות משתמשים.

האימות מאפשר לך לקשר את המשתמשים חשבונות Google עם חשבונות משתמש במערכת האימות שלכם. כך אתם יכולים לזהות את המשתמשים שלכם, שההזמנה מקבלת Intent לבית חכם. הבית החכם של Google תומך ב-OAuth רק עם הרשאה באמצעות קוד.

בדף הזה נסביר איך להגדיר את שרת OAuth 2.0 כך שיפעל עם הפעולה שלך smart home.

קישור של חשבון Google באמצעות OAuth

בתהליך קוד ההרשאה נדרשות שתי נקודות קצה:

• נקודת הקצה authorization, שמציגה את ממשק המשתמש לכניסה למשתמשים שעדיין לא מחוברים. נקודת הקצה של ההרשאה גם יוצרת קוד הרשאה לטווח קצר, שמתעד את הסכמת המשתמשים לגישה המבוקשת.

• נקודת הקצה של החלפת אסימונים, שאחראית על שני סוגים של חילופי אסימונים:

  1. הפונקציה מחליפה קוד הרשאה באסימון רענון לטווח ארוך ובאסימון גישה לטווח קצר. ההחלפה הזו מתרחשת כשהמשתמש עובר את תהליך קישור החשבונות.
  2. מחליפה אסימון רענון לטווח ארוך באסימון גישה לטווח קצר. ההחלפה מתבצעת כש-Google צריכה אסימון גישה חדש כי פג תוקפו.

הנחיות עיצוב

בקטע הזה מתוארות דרישות העיצוב וההמלצות לגבי מסך המשתמש שאתם מארחים לתהליכי קישור של OAuth. לאחר ההפעלה על ידי אפליקציית Google, הפלטפורמה תציג למשתמש מסך הסכמה לקישור חשבון ודף כניסה לחשבון. המשתמש מופנה בחזרה לאפליקציה של Google לאחר הבעת הסכמה לקישור החשבונות.

דרישות

1. צריך ליידע את המשתמש שחשבון המשתמש יקושר ל-Google, ולא למוצר ספציפי של Google כמו Google Home או Google Assistant.
2. צריכה להיות לך הצהרת הרשאה של Google, כמו "כניסה לחשבון מאפשרת ל-Google לשלוט במכשירים שלך". אפשר לעיין בקטע 'הרשאה לבקרת מכשירים של Google' במדיניות למפתחים של Google Home.
3. עליך לספק למשתמשים אפשרות לחזור או לבטל, אם הם יבחרו לא לקשר.
4. צריך לפתוח את דף הקישור של OAuth באינטרנט ולוודא שלמשתמשים יש שיטה ברורה לכניסה לחשבון Google, כמו שדות לשם המשתמש והסיסמה. אין להשתמש בשיטת כניסה באמצעות חשבון Google (GSI) שמאפשרת למשתמשים לבצע קישור בלי שיועברו לדף הקישור של OAuth באינטרנט. זו הפרה של מדיניות Google.

המלצות

מומלץ לבצע את הפעולות הבאות:

1. הצגת מדיניות הפרטיות של Google. מוסיפים במסך ההסכמה קישור אל מדיניות הפרטיות של Google.

2. נתונים לשיתוף. משתמשים בשפה ברורה ותמציתית כדי להסביר למשתמשים אילו נתונים Google דורשת מהם ולמה.

3. ניקוי הקריאה לפעולה. ציינו קריאה ברורה לפעולה במסך ההסכמה, למשל "הסכמה וקישור". הסיבה לכך היא שהמשתמשים צריכים להבין אילו נתונים הם צריכים לשתף עם Google כדי לקשר את החשבונות שלהם.

4. יכולת לבטל את הקישור. להציע למשתמשים מנגנון לביטול הקישור, כמו כתובת URL להגדרות החשבון שלהם בפלטפורמה. לחלופין, אפשר לכלול קישור לחשבון Google שבו המשתמשים יוכלו לנהל את החשבון המקושר שלהם.

5. יכולת לשנות חשבון משתמש. להציע למשתמשים שיטה למעבר בין חשבונות. האפשרות הזו שימושית במיוחד אם למשתמשים יש בדרך כלל כמה חשבונות.

   • אם משתמש צריך לסגור את מסך ההסכמה כדי לעבור בין חשבונות, צריך לשלוח ל-Google הודעת שגיאה שאפשר לשחזר, כדי שהוא יוכל להיכנס לחשבון הרצוי באמצעות קישור OAuth.

6. מוסיפים את הלוגו שלכם. מציגים את לוגו החברה במסך ההסכמה. אפשר להיעזר בהנחיות הסגנון כדי להציב את הלוגו. אם אתם רוצים להציג גם את הלוגו של Google, קראו את המאמר סמלי לוגו וסימנים מסחריים.

תהליך הרשאה באמצעות קוד

יישום של שרת OAuth 2.0 של תהליך קוד ההרשאה כולל שתי נקודות קצה, שהשירות שלך מספק באמצעות HTTPS. נקודת הקצה הראשונה היא נקודת הקצה של ההרשאה, שאחראית למצוא או להשיג הסכמה של משתמשים לקבלת גישה לנתונים. נקודת הקצה של ההרשאה מציגה לכניסה למשתמשים שעדיין לא נכנסו לחשבון ומתעדים הסכמה ל: את הרשאת הגישה המבוקשת. נקודת הקצה השנייה היא נקודת הקצה של המרת אסימונים, משמשות לקבלת מחרוזות מוצפנות, שנקראות אסימונים, שמאשרות למשתמש ניגשים לשירות.

כשאפליקציה של Google צריכה לשלוח קריאה לאחד מממשקי ה-API של השירות שלכם, Google משתמשת את נקודות הקצה האלה יחד כדי לקבל מהמשתמשים הרשאה לקרוא לממשקי ה-API בשמם.

בסשן של זרימת קוד הרשאה OAuth 2.0 ש-Google יזמה התהליך הבא:

1. Google פותחת את נקודת הקצה להרשאה בדפדפן של המשתמש. אם התהליך שמופעל במכשיר עם קול בלבד עבור פעולה, Google מעבירה את בטלפון.
2. המשתמש נכנס לחשבון, אם הוא עדיין לא מחובר, ומעניק ל-Google הרשאה לגשת לנתונים שלהם באמצעות ה-API, אם הוא עדיין לא העניק הרשאה.
3. השירות שלכם יוצר קוד הרשאה ומחזיר אותו ל-Google. לבצע לכן, להפנות את הדפדפן של המשתמש חזרה אל Google עם קוד ההרשאה שמצורף לבקשה.
4. Google שולחת את קוד ההרשאה לנקודת הקצה של המרת האסימון, מאמת את האותנטיות של הקוד ומחזיר אסימון גישה, רענון של אסימון. אסימון הגישה הוא אסימון לטווח קצר שהשירות שלך מקבל כפרטי כניסה לגישה לממשקי API. אסימון הרענון הוא לטווח ארוך אסימון ש-Google יכולה לאחסן ולהשתמש בו כדי לקבל אסימוני גישה חדשים כשהם שפג תוקפן.
5. אחרי שהמשתמש משלים את תהליך קישור החשבון, כל קישור הבקשה שנשלחה מ-Google מכילה אסימון גישה.

טיפול בבקשות הרשאה

מתי צריך לבצע קישור חשבונות באמצעות קוד הרשאה מסוג OAuth 2.0 Google שולחת את המשתמש לנקודת הקצה (endpoint) של ההרשאה בבקשה כוללת את הפרמטרים הבאים:

פרמטרים של נקודת קצה להרשאה
client_id	מזהה הלקוח שהקצית ל-Google.
redirect_uri	כתובת ה-URL שאליה שולחים את התגובה לבקשה הזו.
state	ערך של ניהול חשבונות שמועבר אל Google ללא שינוי URI להפניה אוטומטית.
scope	אופציונלי: קבוצה מופרדת ברווחים של מחרוזות היקף שמציינות את התג הנתונים ש-Google מבקשת עבורם הרשאה.
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, ושה-redirect_uri תואם לכתובת ה-URL להפניה אוטומטית ש-Google סיפקה לשירות שלך. הבדיקות האלה חשובות כדי למנוע גישה לאפליקציות לקוח לא מכוונות או שהוגדרו באופן שגוי. אם אתם תומכים בכמה מוצרים, תהליכי 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. מוסיפים את קוד ההרשאה שנוצר עכשיו והערך של המצב המקורי שלא השתנה כאשר מבצעים הפניה אוטומטית על ידי הוספת הפרמטרים code ו-state. זוהי דוגמה דוגמה לכתובת ה-URL שתתקבל:

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

טיפול בבקשות להחלפת אסימונים

נקודת הקצה (endpoint) של המרת האסימונים של השירות אחראית על שני סוגים של אסימונים Exchanges:

• המרת קודי הרשאה באסימוני גישה ובאסימוני רענון
• המרת אסימוני רענון באסימוני גישה

בקשות להחלפת אסימונים כוללות את הפרמטרים הבאים:

פרמטרים של נקודת קצה להחלפת אסימונים
client_id	מחרוזת המזהה את מקור הבקשה כ-Google. המחרוזת הזו חייבת יהיה רשום במערכת שלך כמזהה הייחודי של Google.
client_secret	מחרוזת סודית שרשמתם ב-Google לשירות שלכם.
grant_type	סוג האסימון המוחלף. זה או אחת מהאפשרויות authorization_code או refresh_token.
code	כשהערך הוא grant_type=authorization_code, הפרמטר הזה קוד ש-Google קיבלה מהכניסה או מהמרת האסימון נקודת הקצה.
redirect_uri	כשהערך הוא grant_type=authorization_code, הפרמטר הזה כתובת ה-URL ששימשה בבקשת ההרשאה הראשונית.
refresh_token	כשהערך הוא grant_type=refresh_token, הפרמטר הזה אסימון הרענון ש-Google קיבלה מנקודת הקצה של המרת האסימונים שלך.

המרת קודי הרשאה באסימוני גישה ובאסימוני רענון

אחרי שהמשתמש נכנס לחשבון ונקודת הקצה (endpoint) של ההרשאה מחזירה דוח לטווח קצר. את קוד ההרשאה ל-Google, Google שולחת בקשה להמרת האסימון שתחליף את קוד ההרשאה באסימון גישה וברענון ב-Assistant.

בבקשות האלה, הערך של 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

כדי להחליף קודי הרשאה באסימון גישה ובאסימון רענון, נקודת הקצה (endpoint) של המרת אסימונים מגיבה לבקשות POST על ידי ביצוע שלבים:

1. יש לוודא שה-client_id מזהה את מקור הבקשה כגורם מורשה origin, ושה-client_secret תואם לערך הצפוי.
2. מוודאים שקוד ההרשאה בתוקף, ושהוא לא בתוקף. מזהה הלקוח שצוין בבקשה תואם את מזהה הלקוח המשויך אל קוד הרשאה.
3. מוודאים שכתובת ה-URL שצוינה על ידי הפרמטר redirect_uri זהה לערך שנעשה בו שימוש בבקשת ההרשאה הראשונית.
4. אם לא ניתן לאמת את כל הקריטריונים שלמעלה, מוחזר שגיאה מסוג 'בקשה שגויה' 400 עם {"error": "invalid_grant"} בגוף ההודעה.
5. אחרת, משתמשים במזהה המשתמש מקוד ההרשאה כדי ליצור רענון וגם אסימון גישה. האסימונים האלה יכולים להיות כל ערכי מחרוזת, אבל הם לייצג את המשתמש ואת הלקוח שעבורו האסימון מיועד באופן ייחודי, שלא ניתן לנחש. עבור אסימוני גישה, צריך לרשום גם את זמן התפוגה של את האסימון, שזמינה בדרך כלל שעה אחרי הנפקת האסימון. אין תפוגה לאסימוני רענון.
6. מחזירים את אובייקט ה-JSON הבא בגוף תגובת ה-HTTPS:

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "refresh_token": "REFRESH_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }
   

Google מאחסנת את אסימון הגישה ואת אסימון הרענון עבור המשתמש והרשומות את אסימון הגישה. כשפג התוקף של אסימון הגישה, Google משתמשת אסימון הרענון כדי לקבל אסימון גישה חדש מנקודת הקצה של המרת האסימונים.

המרת אסימוני רענון באסימוני גישה

כשפג התוקף של אסימון הגישה, Google שולחת בקשה להחלפת האסימון של נקודת הקצה להחלפת אסימון רענון באסימון גישה חדש.

בבקשות האלה, הערך של grant_type הוא refresh_token והערך של refresh_token הוא הערך של אסימון הרענון שהענקת לו בעבר Google. דוגמה לבקשה להחלפת אסימון רענון לאסימון גישה:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

כדי להחליף אסימון רענון באסימון גישה, נקודת הקצה של המרת האסימון מגיב לבקשות POST על ידי ביצוע השלבים הבאים:

1. מוודאים ש-client_id מזהה את מקור הבקשה כ-Google, וכן שה-client_secret תואם לערך הצפוי.
2. יש לוודא שאסימון הרענון חוקי, ושמזהה הלקוח שצוין ב- הבקשה תואמת למזהה הלקוח שמשויך לאסימון הרענון.
3. אם לא ניתן לאמת את כל הקריטריונים שלמעלה, מוחזר HTTP 400 שגיאת 'בקשה שגויה' עם {"error": "invalid_grant"} בגוף ההודעה.
4. אחרת, משתמשים במזהה המשתמש מאסימון הרענון כדי ליצור גישה ב-Assistant. האסימונים האלה יכולים להיות כל ערכי מחרוזת, אבל הם חייבים להיות ייחודיים שמייצגים את המשתמש ואת הלקוח שעבורו האסימון מיועד, ואסור שהוא בלתי מונחית לניחוש. עבור אסימוני גישה, צריך גם לתעד את זמן התפוגה של האסימון, בדרך כלל שעה לאחר הנפקת האסימון.
5. החזרת אובייקט ה-JSON הבא בגוף ה-HTTPS תגובה:

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

טיפול בבקשות למידע על משתמשים

נקודת הקצה של userinfo היא משאב מוגן ב-OAuth 2.0 שמחזיר תלונות לגבי המשתמש המקושר. ההטמעה והאירוח של נקודת הקצה של userinfo הם אופציונליים, חוץ מאשר בתרחישים הבאים לדוגמה:

• כניסה לחשבון המקושר באמצעות Google One Tap.
• מינוי פשוט וקל ב-AndroidTV.

אחרי שהאחזור של אסימון הגישה מנקודת הקצה של האסימון מתבצע, Google שולחת בקשה לנקודת הקצה (endpoint) של userinfo כדי לאחזר פרטי פרופיל בסיסיים של המשתמש המקושר.

כותרות של בקשות של נקודות קצה של userinfo
Authorization header	אסימון הגישה מסוג נושא.

לדוגמה, אם נקודת הקצה של Userinfo זמינה https://myservice.example.com/userinfo, בקשה עשויה להיראות כך:

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

כדי שנקודת הקצה של userinfo תטפל בבקשות, מבצעים את השלבים הבאים:

1. מחלצים את אסימון הגישה מהכותרת Authorization ומחזירים מידע עבור המשתמש שמשויך לאסימון הגישה.
2. אם אסימון הגישה לא חוקי, צריך להחזיר שגיאה מסוג HTTP 401 מאושר עם שימוש בכותרת התגובה WWW-Authenticate. דוגמה לתגובה עם שגיאה של userinfo:

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   אם מתקבלת תגובה מסוג '401' ללא הרשאה, או כל תגובה אחרת של שגיאה שנכשלה במהלך תהליך הקישור, לא ניתן לשחזר את השגיאה, האסימון שאוחזר יימחק והמשתמש יצטרך להתחיל מחדש את תהליך הקישור.

3. אם אסימון הגישה תקין, מוחזר ותגובת HTTP 200 עם אובייקט ה-JSON הבא בגוף ה-HTTPS תגובה:

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

   אם נקודת הקצה (endpoint) של userinfo מחזירה תגובה מוצלחת מסוג HTTP 200, האסימון שאוחזר וההצהרות על זכויות יוצרים יירשמו בחשבון Google של המשתמש.

   תגובה של נקודת הקצה של userinfo
   sub	מזהה ייחודי שמזהה את המשתמש במערכת שלכם.
   email	כתובת האימייל של המשתמש.
   given_name	אופציונלי: השם הפרטי של המשתמש.
   family_name	אופציונלי: שם המשפחה של המשתמש.
   name	אופציונלי: השם המלא של המשתמש.
   picture	אופציונלי: תמונת פרופיל של המשתמש.