- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- ListUpdateRequest
- אילוצים
- CompressionType
- ListUpdateResponse
- ResponseType
- ThreatEntrySet
- RawHashes
- RawIndices
- RiceDeltaEncoding
- סיכום ביקורת
אחזור של העדכונים האחרונים ברשימת האיומים. לקוח יכול לבקש עדכונים עבור כמה רשימות בבת אחת.
בקשת HTTP
POST https://safebrowsing.googleapis.com/v4/threatListUpdates:fetch
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "client": { object ( |
שדות | |
---|---|
client |
המטא-נתונים של הלקוח. |
listUpdateRequests[] |
העדכונים המבוקשים של רשימת האיומים. |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"listUpdateResponses": [
{
object ( |
שדות | |
---|---|
listUpdateResponses[] |
עדכוני הרשימה המבוקשים על ידי הלקוחות. מספר התגובות כאן עשוי להיות נמוך ממספר הבקשות שנשלחו על ידי לקוחות. זה המקרה, לדוגמה, אם לשרת אין עדכונים עבור רשימה מסוימת. |
minimumWaitDuration |
משך הזמן המינימלי שהלקוח צריך להמתין לפני שליחת בקשת עדכון. אם לא מגדירים את השדה הזה, הלקוחות יכולים להתעדכן ברגע שירצו. משך זמן בשניות עם עד תשע ספרות עשרוניות, המסתיים ב-' |
ListUpdateRequest
בקשה אחת לעדכון רשימה.
ייצוג JSON |
---|
{ "threatType": enum ( |
שדות | |
---|---|
threatType |
סוג האיום שנוצר על ידי הרשומות ברשימה. |
platformType |
סוג הפלטפורמה בסיכון שנובעת מהרשומות ברשימה. |
threatEntryType |
סוגי הרשומות שמוצגים ברשימה. |
state |
המצב הנוכחי של הלקוח עבור הרשימה המבוקשת (מצב הלקוח המוצפן שהתקבל מהעדכון המוצלח האחרון של הרשימה). מחרוזת בקידוד base64. |
constraints |
האילוצים שמשויכים לבקשה הזו. |
מגבלות
המגבלות שחלות על העדכון הזה.
ייצוג JSON |
---|
{
"maxUpdateEntries": integer,
"maxDatabaseEntries": integer,
"region": string,
"supportedCompressions": [
enum ( |
שדות | |
---|---|
maxUpdateEntries |
הגודל המרבי של מספר הערכים. העדכון לא יכלול יותר רשומות מהערך הזה. הוא צריך להיות חזקה של 2 בין 2**10 ל-2**20. אם הערך הוא אפס, לא מוגדרת מגבלת גודל לעדכון. |
maxDatabaseEntries |
מגדיר את המספר המקסימלי של הערכים שהלקוח מוכן לכלול במסד הנתונים המקומי עבור הרשימה שצוינה. הוא צריך להיות חזקה של 2 בין 2**10 ל-2**20. אם הערך הוא אפס, לא מוגדרת מגבלה לגודל של מסד הנתונים. |
region |
המערכת מבקשת את הרשימה למיקום גיאוגרפי ספציפי. אם המדיניות לא מוגדרת, השרת עשוי לבחור את הערך הזה בהתאם לכתובת ה-IP של המשתמש. נדרש פורמט ISO 3166-1 alpha-2. |
supportedCompressions[] |
סוגי הדחיסה שבהם הלקוח תומך. |
language |
הפונקציה מבקשת את הרשימות לשפה מסוימת. נדרש פורמט ISO 639 alpha-2. |
deviceLocation |
המיקום הפיזי של הלקוח, מבוטא כקוד אזור לפי תקן ISO 31166-1 alpha-2. |
CompressionType
הדרכים שבהן אפשר לדחוס קבוצות של רשומות איומים.
טיפוסים בני מנייה (enums) | |
---|---|
COMPRESSION_TYPE_UNSPECIFIED |
לא ידוע. |
RAW |
נתונים גולמיים ולא דחוסים. |
RICE |
נתונים בקידוד אורז-גולומב. |
ListUpdateResponse
עדכון לרשימה בודדת.
ייצוג JSON |
---|
{ "threatType": enum ( |
שדות | |
---|---|
threatType |
סוג האיום שעבורו מוחזרים נתונים. |
threatEntryType |
הפורמט של האיומים. |
platformType |
סוג הפלטפורמה שעבורה מוחזרים הנתונים. |
responseType |
סוג התגובה. זה יכול להצביע על כך שהלקוח נדרש לבצע פעולה כשהוא מתקבל. |
additions[] |
קבוצת רשומות להוספה לרשימת סוגי האיומים המקומיים. חוזרים על הפעולה כדי לאפשר שליחת שילוב של נתונים דחוסים ונתונים גולמיים בתגובה אחת. |
removals[] |
קבוצת רשומות להסרה מרשימת סוגי האיומים המקומיים. בפועל, השדה הזה ריק או שהוא מכיל רק ThreatEntrySet אחד. |
newClientState |
מצב הלקוח החדש, בפורמט מוצפן. אטומים ללקוחות. מחרוזת בקידוד base64. |
checksum |
גיבוב SHA256 הצפוי של מצב הלקוח, כלומר, הרשימה הממוינת של כל הגיבובים שנמצאים במסד הנתונים אחרי החלת העדכון שסופק. אם מצב הלקוח לא תואם למצב הצפוי, הלקוח צריך להתעלם מהעדכון הזה ולנסות שוב מאוחר יותר. |
ResponseType
סוג התגובה שנשלחה ללקוח.
טיפוסים בני מנייה (enums) | |
---|---|
RESPONSE_TYPE_UNSPECIFIED |
לא ידוע. |
PARTIAL_UPDATE |
עדכונים חלקיים מיושמים במסד הנתונים המקומי הקיים של הלקוח. |
FULL_UPDATE |
עדכונים מלאים מחליפים את כל מסד הנתונים המקומי של הלקוח. המשמעות היא שהלקוח היה לא עדכני בצורה חמורה או שקיים חשד שהלקוח פגום. |
ThreatEntrySet
קבוצת איומים שיש להוסיף או להסיר ממסד הנתונים המקומי של לקוח.
ייצוג JSON |
---|
{ "compressionType": enum ( |
שדות | |
---|---|
compressionType |
סוג הדחיסה עבור הערכים בקבוצה הזו. |
rawHashes |
הרשומות הגולמיות בפורמט SHA256. |
rawIndices |
אינדקסים גולמיים להסרה עבור רשימה מקומית. |
riceHashes |
הקידומות המקודדות של 4 בייט לרשומות בפורמט SHA256, באמצעות קידוד Golomb-Rice. הגיבובים עוברים המרה ל-uint32, ממוינים בסדר עולה ולאחר מכן מקודדים כדלתא ומאוחסנים כ-codingData. |
riceIndices |
רשימת האינדקסים המקומיים הממוינים באופן לקסיקוגרפי, בקידוד גולומב-אורז. משמש לשליחת אינדקסים להסרה דחוסים. סמני ההסרה (uint32) ממוינים בסדר עולה, ולאחר מכן דלתא מקודדת ומאוחסנת כ-encodeData. |
RawHashes
רשומות האיומים הלא דחוסות בפורמט גיבוב (hash) באורך קידומת מסוים. גודל הגיבוב יכול להיות בין 4 ל-32 בייטים. רובם הם באורך של 4 בייטים, אבל חלק מגיבובים (hash) עשויים לתארך אם הם מתנגשים עם הגיבוב של כתובת URL פופולרית.
משמש לשליחת ThreatEntrySet ללקוחות שלא תומכים בדחיסה, או בעת שליחת גיבובים שאינם בגודל 4 בייטים ללקוחות שתומכים בדחיסה.
ייצוג JSON |
---|
{ "prefixSize": integer, "rawHashes": string } |
שדות | |
---|---|
prefixSize |
מספר הבייטים לכל קידומת שמקודדת למטה. השדה הזה יכול להיות בין 4 (הקידומת הקצרה ביותר) ל-32 (גיבוב SHA256 מלא). |
rawHashes |
הגיבובים, בפורמט בינארי, משורשרים למחרוזת ארוכה אחת. הגיבובים ממוינים בסדר לקסיקוגרפי. למשתמשי JSON API, הגיבובים הם בקידוד base64. מחרוזת בקידוד base64. |
RawIndices
קבוצת מדדים גולמיים להסרה מרשימה מקומית.
ייצוג JSON |
---|
{ "indices": [ integer ] } |
שדות | |
---|---|
indices[] |
האינדקסים שיש להסיר מרשימה מקומית שממוינת מבחינה לקסיקוגרפית. |
RiceDeltaEncoding
הנתונים המקודדים של Rice-Golomb. משמש לשליחת גיבובים (hash) בגודל 4 בייטים דחוסים או אינדקסים של הסרה דחוסה.
ייצוג JSON |
---|
{ "firstValue": string, "riceParameter": integer, "numEntries": integer, "encodedData": string } |
שדות | |
---|---|
firstValue |
ההיסט של הערך הראשון בנתונים המקודדים, או, אם קודד מספר שלם אחד בלבד, הערך של אותו מספר שלם יחיד. אם השדה ריק או חסר, מניחים אפס. |
riceParameter |
הפרמטר Golomb-Rice, שהוא מספר בין 2 ל-28. השדה הזה חסר (כלומר, אפס) אם הערך של |
numEntries |
מספר הערכים המקודדים כדלתא בנתונים המקודדים. אם קודדו מספר שלם אחד בלבד, הוא יהיה אפס והערך היחיד יאוחסן ב- |
encodedData |
הדלתא המקודדת המקודדת באמצעות המקודד גולומב-אורז. מחרוזת בקידוד base64. |
סכום כולל
המצב הצפוי של מסד הנתונים המקומי של לקוח.
ייצוג JSON |
---|
{ "sha256": string } |
שדות | |
---|---|
sha256 |
גיבוב SHA256 של מצב הלקוח, כלומר, של הרשימה הממוינת של כל הגיבובים שנמצאים במסד הנתונים. מחרוזת בקידוד base64. |