במדריך הזה מוסבר איך לפתור את הבעיות הנפוצות ביותר שבהן נתקלים מפתחים כשהם מכינים את האפליקציה שלהם לייצור.
סקירה כללית
כשתהיו מוכנים לפרוס את הפתרון שהטמעתם מעבר לסביבת הפיתוח למשתמשי האפליקציה, יכול להיות שתצטרכו לבצע שלבים נוספים כדי לעמוד בדרישות של מדיניות OAuth 2.0 של Google. במדריך הזה נסביר איך לעמוד בדרישות של המדיניות בנוגע לבעיות הנפוצות ביותר שבהן נתקלים מפתחים כשהם מכינים את האפליקציה שלהם לייצור. כך תוכלו להגיע לקהל הגדול ביותר האפשרי עם כמה שפחות שגיאות.
- שימוש בפרויקטים נפרדים לבדיקה ולייצור
- ניהול רשימה של אנשי קשר רלוונטיים לפרויקט
- ייצוג מדויק של הזהות שלכם
- בקשו רק את היקפי ההרשאות שאתם צריכים
- שליחת אפליקציות בסביבת ייצור שמשתמשות בהיקפי הרשאות לא רגישים או לא מוגבלים לאימות
- להשתמש רק בדומיינים שבבעלותכם
- אירוח דף בית לאפליקציות בסביבת הייצור
- שימוש בכתובות URI מאובטחות להפניה אוטומטית ובמקורות JavaScript מאובטחים
שימוש בפרויקטים נפרדים לבדיקה ולייצור
לפי כללי המדיניות של Google בנושא OAuth, צריך פרויקטים נפרדים לבדיקה ולייצור. חלק מהדרישות וכללי המדיניות חלים רק על אפליקציות בסביבת ייצור. יכול להיות שתצטרכו ליצור ולהגדיר פרויקט נפרד שכולל לקוחות OAuth שתואמים לגרסת הייצור של האפליקציה שזמינה לכל חשבונות Google.
לקוחות Google OAuth שמשמשים בסביבת הייצור עוזרים לספק סביבה יציבה, צפויה ומאובטחת יותר לאיסוף ולאחסון נתונים, בהשוואה ללקוחות OAuth דומים שבודקים או מנפים באגים באותה אפליקציה. אתם יכולים לשלוח את הפרויקט בסביבת הייצור לאימות, ולכן הוא כפוף לדרישות נוספות להיקפי הרשאות ספציפיים של API, שעשויות לכלול הערכות אבטחה של צד שלישי.
- נכנסים אל Google API Console. לוחצים על Create project, נותנים שם לפרויקט ולוחצים על Create.
- בודקים את לקוחות ה-OAuth בפרויקט הזה שעשויים להיות משויכים לרמת הבדיקה שלכם. אם זה רלוונטי, יוצרים לקוחות OAuth דומים ללקוחות בסביבת הייצור בתוך פרויקט הייצור.
- מפעילים את כל ממשקי ה-API שבהם הלקוחות משתמשים.
- בדף המיתוג במסוף Cloud, בודקים את ההגדרות של מסך ההסכמה ל-OAuth בפרויקט החדש.
לקוחות Google OAuth שמשמשים בסביבת ייצור לא יכולים להכיל סביבות בדיקה, כתובות URI להפניה אוטומטית או מקורות JavaScript שזמינים רק לכם או לצוות הפיתוח שלכם. הנה כמה דוגמאות:
- שרתי הבדיקה של מפתחים ספציפיים
- גרסאות טרום-השקה או גרסאות לבדיקה של האפליקציה
לנהל רשימה של אנשי קשר רלוונטיים לפרויקט
יכול להיות ש-Google, או ממשקי ה-API הספציפיים שהפעלתם, יצטרכו ליצור איתכם קשר לגבי שינויים בשירותים שלהם או לגבי הגדרות אישיות חדשות שנדרשות לפרויקט וללקוחות שלו. כדאי לבדוק את רשימות ה-IAM של הפרויקט כדי לוודא שלאנשים הרלוונטיים בצוות יש גישה לעריכה או לצפייה בהגדרות הפרויקט. יכול להיות שגם החשבונות האלה יקבלו אימיילים על שינויים שצריך לבצע בפרויקט.
תפקיד מכיל קבוצת הרשאות שמאפשרות לבצע פעולות ספציפיות במשאבי הפרויקט. לעורכי הפרויקט יש הרשאות לפעולות שמשנות מצבים, כמו היכולת לבצע שינויים במסך ההסכמה ל-OAuth של הפרויקט. Project owners שיש להם את כל הרשאות העריכה יכולים להוסיף או להסיר חשבונות שמשויכים לפרויקט, או למחוק את הפרויקט. בעלי הפרויקטים יכולים גם להסביר למה צריך להגדיר את פרטי החיוב. בעלי פרויקטים יכולים להגדיר פרטי חיוב לפרויקט שמשתמש בממשקי API בתשלום.
חשוב לעדכן את ה-Project Owner והעורכים של הפרויקט. כדי להבטיח גישה רציפה לפרויקט ולתחזוקה שלו, אתם יכולים להוסיף לפרויקט כמה חשבונות רלוונטיים. אנחנו שולחים אימיילים לחשבונות האלה כשיש התראות לגבי הפרויקט או עדכונים לגבי השירותים שלנו. מנהלי הארגון ב-Google Cloud צריכים לוודא שלכל פרויקט בארגון משויך איש קשר שאפשר להגיע אליו. אם הפרטים ליצירת קשר של הפרויקט לא מעודכנים, יכול להיות שתפספסו הודעות חשובות שדורשות פעולה מצידכם.
ייצוג מדויק של הזהות שלכם
צריך לציין שם אפליקציה תקין, ואם רוצים, גם לוגו שיוצג למשתמשים. פרטי המותג חייבים לייצג במדויק את הזהות של האפליקציה. את פרטי המיתוג של האפליקציה מגדירים בדף המיתוג של OAuth.
באפליקציות בסביבת ייצור, פרטי המותג שמוגדרים במסך ההסכמה ל-OAuth צריכים לעבור אימות לפני שהם מוצגים למשתמשים. יכול להיות שמשתמשים יסכימו יותר לתת גישה לאפליקציה אחרי שהיא תשלים את אימות המותג. פרטי האפליקציה הבסיסיים, שכוללים את שם האפליקציה, דף הבית, התנאים וההגבלות ומדיניות הפרטיות, מוצגים למשתמשים במסך ההרשאה כשהם בודקים את ההרשאות הקיימות שלהם, או לאדמינים ב-Google Workspace שבודקים את השימוש באפליקציה בארגון שלהם.
Google יכולה לבטל או להשעות את הגישה לשירותי Google API ולמוצרים ולשירותים אחרים של Google לאפליקציות שמציגות מצג שווא לגבי הזהות שלהן או מנסות להטעות משתמשים.
בקשו רק את היקפי ההרשאות שאתם צריכים
במהלך פיתוח האפליקציה, יכול להיות שהשתמשתם בהיקף הרשאות לדוגמה שסופק על ידי ה-API כדי ליצור הוכחת היתכנות (PoC) באפליקציה, במטרה לקבל מידע נוסף על התכונות והפונקציונליות של ה-API. היקפי ההרשאות לדוגמה האלה בדרך כלל מבקשים יותר מידע ממה שנדרש להטמעה הסופית של האפליקציה, כי הם מספקים כיסוי מקיף של כל הפעולות האפשריות ל-API מסוים. לדוגמה, היקף ההרשאות לדוגמה עשוי לבקש הרשאות קריאה, כתיבה ומחיקה, בעוד שהאפליקציה שלכם דורשת הרשאות קריאה בלבד. מבקשים הרשאות רלוונטיות שמוגבלות למידע הקריטי שנדרש כדי להטמיע את האפליקציה.
עיינו במאמרי העזרה של נקודות הקצה ל-API שהאפליקציה שלכם קוראת להן, ושימו לב להיקפי ההרשאות שנדרשים כדי לגשת לנתונים הרלוונטיים שהאפליקציה צריכה. כדאי לעיין במדריכי ההרשאות של ה-API ולתאר את היקפי ההרשאות שלהם בפירוט רב יותר, כדי לכלול את השימוש הנפוץ ביותר. בחרו את הגישה המינימלית ביותר לנתונים שהאפליקציה שלכם צריכה כדי להפעיל את התכונות הקשורות.
למידע נוסף על הדרישה הזו, קראו את הקטע בקשת היקפי הרשאות נחוצים בלבד במדיניות OAuth 2.0, ואת הקטע בקשת הרשאות רלוונטיות במדיניות בנושא נתוני משתמשים בשירותי Google API.
שליחה לאימות של אפליקציות בסביבת ייצור שמשתמשות בהיקפי הרשאות לא רגישים או לא מוגבלים
התכונה "כניסה באמצעות חשבון Google" לא מבקשת היקפי הרשאות רגישים ומוגבלים בזמן אימות המשתמש. אם האפליקציה משתמשת בכניסה באמצעות חשבון Google רק לצורך אימות, אתם צריכים לשלוח את האפליקציה לאימות המותג. אפשר לשלוח בקשה לאימות ב-Google Cloud Console דרך דף המיתוג. האימות הזה נדרש כדי להציג במסך ההסכמה את גורמי הייחודיות של האפליקציה, כולל השם, הלוגו, מדיניות הפרטיות, התנאים וההגבלות וההיקפים.
מומלץ מאוד שהאפליקציה תעמוד בהנחיות המיתוג הרשמיות להצבת לחצן הכניסה.
להשתמש רק בדומיינים שבבעלותכם
בתהליך האימות של מסך ההסכמה ל-OAuth של Google, צריך לאמת את כל הדומיינים שמשויכים לדף הבית, למדיניות הפרטיות, לתנאים ולהגבלות, לכתובות ה-URI המורשות להפניה או למקורות המורשים של JavaScript בפרויקט. בודקים את רשימת הדומיינים שבהם האפליקציה משתמשת, שמסוכמת בקטע Authorized domains בכלי לעריכת מסך ההסכמה של OAuth, ומזהים דומיינים שלא בבעלותכם ולכן לא תוכלו לאמת אותם. כדי לאמת את הבעלות על הדומיינים המורשים של הפרויקט, משתמשים ב-Google Search Console. משתמשים בחשבון Google שמשויך לפרויקט שלכם בקונסולה לממשקי API כבעלים או כעורכים.
אם בפרויקט שלכם אתם משתמשים בספק שירות עם דומיין משותף, מומלץ להפעיל הגדרות שיאפשרו לכם להשתמש בדומיין שלכם. חלק מהספקים מציעים למפות את השירותים שלהם לתת-דומיין של דומיין שכבר נמצא בבעלותכם.
אירוח דף בית לאפליקציות בסביבת ייצור
לכל אפליקציה בסביבת הייצור שמשתמשת ב-OAuth 2.0 צריך להיות דף בית שנגיש לכולם. משתמשים פוטנציאליים של האפליקציה יכולים להיכנס לדף הבית כדי לקבל מידע נוסף על התכונות והפונקציונליות שהאפליקציה מציעה. משתמשים קיימים יכולים לבדוק את רשימת ההרשאות הקיימות שלהם ולבקר בדף הבית של האפליקציה כדי להיזכר שהם ממשיכים להשתמש במוצר או בשירות שלכם.
דף הבית של האפליקציה צריך לכלול תיאור של הפונקציונליות שלה, וגם קישורים למדיניות הפרטיות ולתנאים ולהגבלות (אופציונלי). דף הבית חייב להיות בדומיין מאומת שבבעלותכם.
שימוש במזהי URI מאובטחים להפניה אוטומטית ובמקורות JavaScript מאובטחים
לקוחות OAuth 2.0 לאפליקציות אינטרנט חייבים לאבטח את הנתונים שלהם באמצעות כתובות URI להפניה אוטומטית מסוג HTTPS ומקורות JavaScript, ולא באמצעות HTTP רגיל. Google יכולה לדחות בקשות OAuth שלא מגיעות מהקשר מאובטח או לא נפתרות בהקשר מאובטח.
חשוב לבדוק לאילו אפליקציות וסקריפטים של צד שלישי יש גישה לטוקנים ולפרטי כניסה אחרים של משתמשים שמוחזרים לדף שלכם. הגבילו את הגישה למידע אישי רגיש באמצעות מיקומי URI להפניה אוטומטית שמוגבלים לאימות ולאחסון של נתוני טוקנים.
השלבים הבאים
אחרי שמוודאים שהאפליקציה עומדת בדרישות המדיניות בנושא OAuth 2.0 שמפורטות בדף הזה, אפשר לעיין בפרטים על תהליך האימות במאמר שליחת בקשה לאימות המותג.