קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
ממשק API של Oblivious HTTP Gateway API
הערה: המסמכים האלה עדיין בשלבי פיתוח. צפויים שיפורים בעתיד הקרוב.
ממשק API של Oblivious HTTP Gateway API הוא ממשק API לשמירה על פרטיות המבוסס על פרוטוקול IETF RFC בשם Oblivious HTTP, RFC 9458.
סקירה כללית
גלישה בטוחה של Oblivious HTTP Gateway API הוא שירות של Google שמאפשר לאפליקציות לקוח לבדוק כתובות URL מול רשימות של Google שכוללות משאבי אינטרנט לא בטוחים שמתעדכנים באופן שוטף, כולל אמצעי הגנה נוספים על פרטיות.
אפשר לעשות זאת באמצעות פרוטוקול פשוט שנקרא Oblivious HTTP, או OHTTP. זהו פרוטוקול ללא שמירת מצב, שיכול לשמש את לקוחות הגלישה הבטוחה כדי לגשת אל ממשקי ה-API של גלישה בטוחה בגרסה 5, ולקבל אמצעי הגנה חזקים וכיסוי מוגבר בלי לפגוע במשתמשים פרטיות.
Oblivious HTTP הוא פרוטוקול קל ופשוט שמוגדר ב-RFC 9458, והוא משמש להצפנה ולשליחה של הודעות HTTP מלקוח לשרת יעד. הפעולה הזו משתמשת בשירות ממסר מהימן באופן שמצמצם את השימוש של שרת היעד במטא-נתונים, כמו כתובת IP ופרטי חיבור לצורך זיהוי הלקוח, תוך שמירה על פרטיות ואבטחה בנוסף לפרוטוקול HTTP/S פשוט. הפרוטוקול משתמש ב-Binary HTTP, שמוגדר ב-RFC 9292, כדי לקודד/לפענח בקשות/תגובות של HTTP.
ברמה הכללית, שרת הממסר נמצא בין משאב הלקוח ל-Gateway, שמעביר את תנועת הלקוחות דרך שרת proxy על ידי הסרת כל מזהי הלקוח, כולל מאפיינים רגישים לפרטיות כמו כתובות IP, ומבצע אנונימיזציה של בקשות HTTP נכנסות לשירות Gateway. היתרון הנוסף של OHTTP הוא שכל הבקשות מוצפנות מקצה לקצה, כלומר שאילתות של גלישה בטוחה (כלומר גיבובים חתוכים של ביטויים של כתובות URL) לא גלויות לשרת הממסר. הטמעה לדוגמה ב-Chrome מופיעה בblogpost.
Fig: זרימת OHTTP.
הלקוחות יכולים לבחור כל ספק ממסר (למשל, Fastly) לשילוב עם השירות. כדי לגשת לשירות, הממסר צריך להשתמש באימות Oauth 2.0 עם היקף ההרשאה הבא.
GET https://safebrowsingohttpgateway.googleapis.com/v1/ohttp/hpkekeyconfig?key=<API key>
מפתח ה-API שלמעלה אינו הכרחי בהחלט. השרת לא משנה את המפתח הציבורי של OHTTP בהתאם למפתח ה-API שסופק. הלקוחות יכולים לבדוק את העובדות האלה על ידי שימוש במפתחות API תקפים שונים כדי לגשת לנקודת הקצה הזאת, בלי להשתמש בכלל במפתחות API, ולבדוק שהתשובה אכן מכילה את אותו מפתח ציבורי של OHTTP. עם זאת, כדי להקל על ניפוי באגים, מומלץ להשתמש במפתח API. כך לקוחות יכולים לצפות בנתונים סטטיסטיים כמו מספר הבקשות במסוף Google Cloud. אם הלקוח מתכוון לספק מפתח API, אפשר לקרוא את מאמרי העזרה בנושא הגדרת מפתחות API.
כפי שצוין בקטע המלצות בנושא פרטיות, כדי לעמוד ביעדים של עקביות במפתחות, מומלץ לספקי לקוח להגדיר תשתית של הפצת מפתחות מרוכזת כדי לאחזר את המפתח מנקודת הקצה הזו ולהפיץ אותו לאפליקציות הלקוח שלהם.
בהתאם להנחיות לניהול מפתחות, המפתחות עוברים רוטציה באופן קבוע בשרת. על הלקוחות לרענן את המפתח, כלומר, לאחזר ולעדכן את העותק המקומי של המפתח מדי פעם, כדי למנוע כשלים בפענוח.
הלקוחות צריכים לרענן (לאחזר ולעדכן) את המפתח הציבורי פעם ביום. אם משתמשים במנגנון הפצה ריכוזי, המנגנון הזה מבטיח אחזור והפצה של המפתחות פעם ביום.
בקשה מכוסה של OHTTP
נקודת הקצה (endpoint) הזו תציג את בקשת ה-OHTTP שכלולה בגוף ה-HTTP של בקשת ה-POST, על ידי ביצוע פענוח של הבקשה, ולאחר מכן תצפין את תגובת ה-OHTTP שתועבר חזרה לממסר בתגובת ה-HTTP. הלקוח חייב לכלול את כותרת הבקשה Content-Type כ-message/ohttp-req בבקשת ה-HTTP POST.
POST https://safebrowsingohttpgateway.googleapis.com/v1/ohttp:handleOhttpEncapsulatedRequest?key=<API key>
הערה: בהתאם להנחיות ב-RFC, צריך לקודד את הבקשה הפנימית (אפשר לעיין במסמכי התיעוד של V5 שמסבירים איך לפתח בקשה של גלישה בטוחה) באמצעות פרוטוקול Binary HTTP, RFC 9292.
ספריות לקוח
ל-Google Quiche יש הטמעות בצד הלקוח עבור הפרוטוקולים OHTTP ו-BHTTP. אנחנו ממליצים ללקוחות להשתמש בספריות האלה. בהמשך מופיע קוד מדומה להסבר על בניית בקשות OHTTP כדי לגשת ל-API.
הטמעה לדוגמה בצד הלקוח
לקוחות מאחזרים את המפתח הציבורי של Oblivious HTTP מנקודת הקצה של מפתח ציבורי. לאחר מכן מאתחלים את תצורת מפתח ה-OHTTP של קיש כמו זה, ומאתחלים את לקוח ה-OHTTP של קיש.
auto ohttp_key_cfgs = quiche::ObliviousHttpKeyConfigs::ParseConcatenatedKeys(std::string public_key);
auto key_config = ohttp_key_cfgs->PreferredConfig();
auto public_key = ohttp_key_cfgs->GetPublicKeyForId(key_config.GetKeyId())
auto ohttp_client = quiche::ObliviousHttpClient::Create(public_key, key_config);
הלקוח ישתמש בקידוד HTTP בינארי כדי ליצור בקשת BHTTP כשלב ראשון לפני ההצפנה.
לאחר מכן הלקוח יצפין את בקשת ה-HTTP הבינארית שנוצרה בשלב הקודם.
auto bhttp_serialized = bhttp_request.Serialize();
auto ohttp_request = ohttp_client.CreateObliviousHttpRequest(*bhttp_serialized);
// Client must include this in POST body, and add `Content-Type` header as "message/ohttp-req".
auto payload_include_in_post_body = ohttp_request.EncapsulateAndSerialize();
אחרי שהתשובה תתקבל משרת הממסר, הלקוח יפענח את התגובה. התגובה תכלול את כותרת התגובה Content-Type בפורמט ohttp-res.
auto ctx = std::move(ohttp_request).ReleaseContext();
auto ohttp_response = ohttp_client.DecryptObliviousHttpResponse("data included in body of http_response", ctx);
אחרי הפענוח של תגובת ה-OHTTP, צריך לפענח את הפלט באמצעות Binary HTTP באופן הזה.
auto bhttp_response = BinaryHttpResponse::Create(ohttp_response.GetPlaintextData());
if (bhttp_response.status_code() == 200) {
auto http_response = bhttp_response.body();
auto response_headers = bhttp_response.GetHeaderFields();
}
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eSafe Browsing Oblivious HTTP Gateway API allows client applications to privately check URLs against Google's unsafe web resources lists using the Oblivious HTTP protocol.\u003c/p\u003e\n"],["\u003cp\u003eThis API leverages a Relay service to anonymize client requests to Google, enhancing privacy by hiding client identifiers like IP addresses.\u003c/p\u003e\n"],["\u003cp\u003eClients need to fetch and regularly update the OHTTP public key from a dedicated endpoint for encryption and decryption of requests and responses.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses two endpoints: one for obtaining the OHTTP public key and another for handling encapsulated OHTTP requests.\u003c/p\u003e\n"],["\u003cp\u003eGoogle provides client libraries and sample code to facilitate integration with the API, recommending the use of Quiche for OHTTP and BHTTP functionalities.\u003c/p\u003e\n"]]],["\n\nI'm sorry, but I can't help you with this."],null,["# Overview\n\nSafe Browsing Oblivious HTTP Gateway API\n----------------------------------------\n\n**Note: This documentation is currently still under development. Expect improvements in the near future.**\n\nSafe Browsing Oblivious HTTP Gateway API is a privacy preserving API built on top of IETF RFC protocol named *Oblivious HTTP* , [RFC 9458](https://www.ietf.org/rfc/rfc9458.html).\n\n### Overview\n\nSafe Browsing Oblivious HTTP Gateway API is a Google service that lets client applications check URLs against Google's constantly updated lists of unsafe web resources with additional privacy protections in place.\n\nThis is achieved via a lightweight protocol called *Oblivious HTTP* , or [OHTTP](https://www.ietf.org/rfc/rfc9458.html) for short. This is a stateless protocol that can be used by Safe Browsing clients in order to access [*Google Safe Browsing V5* APIs](/safe-browsing/reference), to get robust protections and increased coverage without compromising users' privacy.\n\n**NOTE:** [Google Safe Browsing V4 APIs](https://developers.google.com/safe-browsing/v4) cannot be accessed via this service.\n\n#### Safe Browsing Oblivious HTTP protocol\n\n##### RFC Protocol\n\nOblivious HTTP is a lightweight protocol defined in [RFC 9458](https://www.ietf.org/rfc/rfc9458.html), used for encrypting and sending HTTP messages from a client to a target server. This uses a trusted relay service in a manner that mitigates the target server's use of metadata such as IP address and connection information for client identification, providing privacy and security on top of plain HTTP/S protocol. The protocol uses Binary HTTP, defined in RFC 9292, to encode/decode HTTP requests/responses.\n\nAt a high level, a Relay stands between the Client and Gateway resource that proxies client traffic by removing all client identifiers, including privacy sensitive attributes such as IP addresses, effectively anonymizing incoming HTTP requests to the Gateway service. The added benefit of OHTTP is all the requests are end-to-end encrypted, which means clients' Safe Browsing queries (i.e. truncated hashes of URL expressions) are not visible to the Relay. Refer to the [blogpost](https://security.googleblog.com/2024/03/blog-post.html) for an example implementation in Chrome.\n\n\u003cbr /\u003e\n\n**Fig**: OHTTP flow.\n\n\u003cbr /\u003e\n\nClients can choose any Relay provider (eg., [Fastly](https://docs.fastly.com/products/oblivious-http-relay)) to integrate with the service. The Relay must use [Oauth 2.0](https://developers.google.com/identity/protocols/oauth2/service-account#authorizingrequests) authentication with following *authorization scope* in order to access the service. \n\n\n // OAuth Authorization scope:\n https://www.googleapis.com/auth/3p-relay-safe-browsing\n\n##### API Endpoints\n\n###### OHTTP Public Key\n\nThis endpoint will provide [OHTTP public key configuration](https://www.ietf.org/rfc/rfc9458.html#name-key-configuration) as specified in [RFC 9458](https://www.ietf.org/rfc/rfc9458.html), which will be used by the client to encrypt OHTTP request. \n\n\n GET https://safebrowsingohttpgateway.googleapis.com/v1/ohttp/hpkekeyconfig?key=\u003cAPI key\u003e\n\nThe API key above is not strictly necessary; the server does *not* vary the OHTTP Public Key based on the supplied API key. It is allowed for clients to probe this fact by using different valid API keys to access this endpoint or using no API keys altogether, and checking that the response indeed contains the same OHTTP public key. However, for ease of debugging, an API key is recommended; this allows clients to view statistics such as number of requests on the Google Cloud Console. If the client intends to supply an API key, refer to this [documentation](https://cloud.google.com/docs/authentication/api-keys) on how to set up API keys.\n\nAs stated in the [privacy recommendations](https://www.ietf.org/rfc/rfc9458.html#name-privacy-considerations) section, in order to meet *key consistency* goals, Client vendors are recommended to set up a *centralized key distribution* infrastructure in order to fetch the key from this endpoint and subsequently distribute it to their client applications.\n\nAs per the [key management guidance](https://www.ietf.org/rfc/rfc9458.html#name-key-management), keys are rotated regularly on the server. Clients should refresh the key, i.e., fetch and update the local copy of the key every so often in order to avoid decryption failures.\n\nClients should refresh (fetch and update) the public key once per day. If a centralized distribution mechanism is in use, this mechanism should make sure to fetch and distribute the keys once per day.\n\n###### OHTTP Encapsulated Request\n\nThis endpoint will serve the OHTTP request that's included in HTTP body of the POST request, by performing request decryption, and subsequently encrypt the OHTTP response to be forwarded back to Relay in the HTTP response. The Client must include *Content-Type* request header as *message/ohttp-req* in the HTTP POST request. \n\n\n POST https://safebrowsingohttpgateway.googleapis.com/v1/ohttp:handleOhttpEncapsulatedRequest?key=\u003cAPI key\u003e\n\n**NOTE:** As per the guidance on RFC, encode the inner request (refer [V5 documentation](/safe-browsing/reference) on how to build Safe Browsing request) using *Binary HTTP* protocol, [RFC 9292](https://www.ietf.org/rfc/rfc9292.html).\n\n##### Client Libraries\n\n[Google Quiche](https://github.com/google/quiche) has client side implementations for both [OHTTP](https://github.com/google/quiche/tree/main/quiche/oblivious_http), and [BHTTP](https://github.com/google/quiche/tree/main/quiche/binary_http) protocols. Clients are recommended to use these libraries. Refer below pseudo-code on how to go about building OHTTP requests in order to access the API.\n\n###### Sample client side implementation\n\nClients fetch the Oblivious HTTP public key from the *public key* endpoint. Subsequently initialize the quiche OHTTP key config like so, and initialize quiche OHTTP client. \n\n\n auto ohttp_key_cfgs = quiche::ObliviousHttpKeyConfigs::ParseConcatenatedKeys(std::string public_key);\n auto key_config = ohttp_key_cfgs-\u003ePreferredConfig();\n auto public_key = ohttp_key_cfgs-\u003eGetPublicKeyForId(key_config.GetKeyId())\n auto ohttp_client = quiche::ObliviousHttpClient::Create(public_key, key_config);\n\nClient will use Binary HTTP encoding to create BHTTP Request as a first step before encrypting. \n\n\n quiche::BinaryHttpRequest::ControlData bhttp_ctrl_data{\n .method = \"POST\",\n .scheme = \"https\",\n .authority = \"safebrowsing.googleapis.com\",\n .path = \"/v5/hashes:search?key=\u003cAPI key\u003e&hashPrefixes=\u003cHASH prefix 1\u003e&hashPrefixes=\u003cHASH prefix 2\u003e\",\n };\n quiche::BinaryHttpRequest bhttp_request(bhttp_ctrl_data);\n\nClient will subsequently encrypt the Binary HTTP request created in the above step. \n\n\n auto bhttp_serialized = bhttp_request.Serialize();\n auto ohttp_request = ohttp_client.CreateObliviousHttpRequest(*bhttp_serialized);\n // Client must include this in POST body, and add `Content-Type` header as \"message/ohttp-req\".\n auto payload_include_in_post_body = ohttp_request.EncapsulateAndSerialize();\n\nOnce the response is received from Relay, client will decrypt the response. The response will include *Content-Type* response header as *ohttp-res*. \n\n\n auto ctx = std::move(ohttp_request).ReleaseContext();\n auto ohttp_response = ohttp_client.DecryptObliviousHttpResponse(\"data included in body of http_response\", ctx);\n\nAfter decrypting the OHTTP response successfully, decode the output using Binary HTTP like so. \n\n\n auto bhttp_response = BinaryHttpResponse::Create(ohttp_response.GetPlaintextData());\n if (bhttp_response.status_code() == 200) {\n auto http_response = bhttp_response.body();\n auto response_headers = bhttp_response.GetHeaderFields();\n }"]]
