- Requête HTTP
- Corps de la requête
- Corps de la réponse
- ListUpdateRequest
- Contraintes
- CompressionType
- ListUpdateResponse
- ResponseType
- ThreatEntrySet
- RawHashes
- RawIndices
- RiceDeltaEncoding
- Somme de contrôle
Récupère les mises à jour les plus récentes de la liste des menaces. Un client peut demander des mises à jour pour plusieurs listes à la fois.
Requête HTTP
POST https://safebrowsing.googleapis.com/v4/threatListUpdates:fetch
L'URL utilise la syntaxe de transcodage gRPC.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{ "client": { object ( |
Champs | |
---|---|
client |
Métadonnées du client. |
listUpdateRequests[] |
Mise à jour de la liste des menaces demandée. |
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :
Représentation JSON |
---|
{
"listUpdateResponses": [
{
object ( |
Champs | |
---|---|
listUpdateResponses[] |
Mises à jour de liste demandées par les clients. Le nombre de réponses peut être inférieur au nombre de requêtes envoyées par les clients. C'est le cas, par exemple, si le serveur ne dispose d'aucune mise à jour pour une liste donnée. |
minimumWaitDuration |
Durée minimale que le client doit attendre avant d'envoyer une requête de mise à jour. Si ce champ n'est pas défini, les clients peuvent se mettre à jour dès qu'ils le souhaitent. Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par " |
ListUpdateRequest
Une seule requête de mise à jour de liste.
Représentation JSON |
---|
{ "threatType": enum ( |
Champs | |
---|---|
threatType |
Type de menace posé par les entrées présentes dans la liste. |
platformType |
Type de plate-forme menacée par les entrées présentes dans la liste. |
threatEntryType |
Types d'entrées présents dans la liste. |
state |
État actuel du client pour la liste demandée (état chiffré du client reçu lors de la dernière mise à jour réussie de la liste). Chaîne encodée en base64. |
constraints |
Contraintes associées à cette requête. |
Contraintes
Contraintes pour cette mise à jour.
Représentation JSON |
---|
{
"maxUpdateEntries": integer,
"maxDatabaseEntries": integer,
"region": string,
"supportedCompressions": [
enum ( |
Champs | |
---|---|
maxUpdateEntries |
Taille maximale du nombre d'entrées. La mise à jour ne contiendra pas plus d'entrées que cette valeur. Cela devrait être une puissance de 2 comprise entre 2**10 et 2**20. Si la valeur est zéro, aucune limite de taille de mise à jour n'est définie. |
maxDatabaseEntries |
Définit le nombre maximal d'entrées que le client est prêt à avoir dans la base de données locale pour la liste spécifiée. Cela devrait être une puissance de 2 comprise entre 2**10 et 2**20. Si la valeur est zéro, aucune limite de taille de la base de données n'est définie. |
region |
Demande la liste pour un emplacement géographique spécifique. Si cette règle n'est pas configurée, le serveur peut choisir cette valeur en fonction de l'adresse IP de l'utilisateur. Attend le format ISO 3166-1 alpha-2. |
supportedCompressions[] |
Types de compression acceptés par le client. |
language |
Demande les listes pour une langue spécifique. Attend le format ISO 639 alpha-2. |
deviceLocation |
Emplacement physique du client, exprimé sous la forme d'un code de région ISO 31166-1 alpha-2. |
CompressionType
Les différentes manières de compresser les ensembles d'entrées de menaces
Enums | |
---|---|
COMPRESSION_TYPE_UNSPECIFIED |
Inconnu. |
RAW |
Données brutes non compressées. |
RICE |
Données encodées en Rice-Golomb. |
ListUpdateResponse
Mise à jour d'une liste individuelle.
Représentation JSON |
---|
{ "threatType": enum ( |
Champs | |
---|---|
threatType |
Type de menace pour lequel des données sont renvoyées. |
threatEntryType |
Format des menaces. |
platformType |
Type de plate-forme pour laquelle les données sont renvoyées. |
responseType |
Type de réponse. Cela peut indiquer qu'une action est requise de la part du client lorsque la réponse est reçue. |
additions[] |
Ensemble d'entrées à ajouter à la liste des types de menaces locaux. Répétition pour permettre l'envoi d'une combinaison de données brutes et compressées dans une seule réponse. |
removals[] |
Ensemble d'entrées à supprimer de la liste des types de menaces locaux. En pratique, ce champ est vide ou contient exactement un ThreatEntrySet. |
newClientState |
Nouvel état du client, au format chiffré. Opaque aux clients. Chaîne encodée en base64. |
checksum |
Hachage SHA256 attendu de l'état du client, c'est-à-dire de la liste triée de tous les hachages présents dans la base de données après application de la mise à jour fournie. Si l'état du client ne correspond pas à l'état attendu, le client doit ignorer cette mise à jour et réessayer plus tard. |
ResponseType
Type de réponse envoyée au client.
Enums | |
---|---|
RESPONSE_TYPE_UNSPECIFIED |
Inconnu. |
PARTIAL_UPDATE |
Les mises à jour partielles sont appliquées à la base de données locale existante du client. |
FULL_UPDATE |
Les mises à jour complètes remplacent l'intégralité de la base de données locale du client. Cela signifie que le client était vraiment obsolète ou qu'il est soupçonné d'être corrompu. |
ThreatEntrySet
Ensemble de menaces qui doivent être ajoutées ou supprimées de la base de données locale d'un client.
Représentation JSON |
---|
{ "compressionType": enum ( |
Champs | |
---|---|
compressionType |
Type de compression pour les entrées de cet ensemble. |
rawHashes |
Entrées brutes au format SHA256 |
rawIndices |
Indices bruts d'élimination pour une liste locale. |
riceHashes |
Préfixes à 4 octets encodés pour les entrées au format SHA256, utilisant un encodage Golomb-Rice. Les hachages sont convertis en uint32, triés par ordre croissant, puis encodés en delta et stockés en tant que codedData. |
riceIndices |
Indices de listes locaux encodés, triés de façon lexicographique, utilisant un encodage Golomb-Rice. Utilisé pour envoyer les index de suppression compressés. Les index de suppression (uint32) sont triés par ordre croissant, puis encodés en delta et stockés sous la forme d'encodes codés. |
RawHashes
Entrées de menaces non compressées sous forme de hachage d'une longueur de préfixe particulière. La taille des hachages peut varier de 4 à 32 octets. Une grande majorité correspond à 4 octets, mais certains hachages sont allongés s'ils entrent en conflit avec le hachage d'une URL populaire.
Utilisé pour envoyer ThreatEntrySet à des clients non compatibles avec la compression ou lors de l'envoi de hachages de moins de 4 octets à des clients compatibles avec la compression.
Représentation JSON |
---|
{ "prefixSize": integer, "rawHashes": string } |
Champs | |
---|---|
prefixSize |
Nombre d'octets pour chaque préfixe encodé ci-dessous. La valeur de ce champ peut être comprise entre 4 (préfixe le plus court) et 32 (hachage SHA256 complet). |
rawHashes |
Les hachages, au format binaire, concaténés en une longue chaîne. Les hachages sont triés par ordre lexicographique. Pour les utilisateurs de l'API JSON, les hachages sont encodés en base64. Chaîne encodée en base64. |
RawIndices
Ensemble d'index bruts à supprimer d'une liste locale.
Représentation JSON |
---|
{ "indices": [ integer ] } |
Champs | |
---|---|
indices[] |
Index à supprimer d'une liste locale triée lexicographiquement. |
RiceDeltaEncoding
Les données encodées en Rice-Golomb. Utilisé pour envoyer des hachages de 4 octets compressés ou des index de suppression compressés.
Représentation JSON |
---|
{ "firstValue": string, "riceParameter": integer, "numEntries": integer, "encodedData": string } |
Champs | |
---|---|
firstValue |
Décalage de la première entrée des données encodées ou, si un seul entier a été encodé, la valeur de cet entier unique. Si le champ est vide ou manquant, indiquez la valeur zéro. |
riceParameter |
Le paramètre Golomb-Rice, qui est un nombre compris entre 2 et 28. Ce champ est manquant (c'est-à-dire zéro) si la valeur de |
numEntries |
Nombre d'entrées encodées en delta dans les données encodées. Si un seul entier a été encodé, la valeur est zéro et la valeur unique sera stockée dans |
encodedData |
Deltas encodés à l'aide du codeur Golomb-Rice Chaîne encodée en base64. |
Total
État attendu de la base de données locale d'un client.
Représentation JSON |
---|
{ "sha256": string } |
Champs | |
---|---|
sha256 |
Hachage SHA256 de l'état du client, c'est-à-dire de la liste triée de tous les hachages présents dans la base de données. Chaîne encodée en base64. |