INTEGRITY Dokumentace

API Discovery

Většina vývojářských týmů má potíže udržet si přehled o svých API. Cloudflare API Discovery vám pomáhá zmapovat a pochopit útočnou plochu vašeho API, tedy úplnou sadu koncových bodů, na které mohou útočníci zamířit.

Proces

Cloudflare vytváří mapu API endpointy seskupením podobných cest požadavků (normalizace cesty).

Můžete mít například tisíce API, ale mnoho volání vypadá podobně, například:

Obě cesty slouží podobnému účelu (načtení uživatelských profilů), ale nejsou totožné. Ve snaze zjednodušit koncové body byste je oba mohli namapovat na api.example.com/profile/*.

API Discovery provádí tento proces napříč veškerým vaším provozem a vytváří jednoduchou mapu koncových bodů, která může vypadat například takto:

/api/login/{customer_identifier}
/api/auth
/api/account/{customer_identifier}
/api/password_reset
/api/logout

Podobně platí, že pokud máte více subdomén sdílejících stejnou sadu endpointů, Cloudflare tyto subdomény sloučí:

us-api.example.com/api/v1/users/{var1}
de-api.example.com/api/v1/users/{var1}
fr-api.example.com/api/v1/users/{var1}
jp-api.example.com/api/v1/users/{var1}

Cloudflare tyto hodnoty sjednocuje na {hostVar1}.example.com/api/v1/users/{var1}.

Další technické podrobnosti najdete v blogový příspěvek ↗.

Zjištěné operace

Web Assets přidává objevené endpointy API do inventáře operací jako kandidátní operace. Ty poskytují kontext pro porovnávání, protokolování, detekce a pravidla ještě předtím, než je ručně zkontrolujete.

Zjištěné operace nemusíte povyšovat všechny. Povýšením operace ji přesunete do full stav a spustit učení profilu. Full operace podporují uložené API profily, zjištění rizik a ochrany, které vyžadují známý API endpoint.

Chcete-li povýšit zjištěnou operaci:

  1. V dashboardu Cloudflare přejděte na Webová aktiva stránce.

    Přejděte na Webová aktiva ↗
  2. Přejděte na Operace kartě.

  3. Otevřete akce řádku pro kandidátskou nebo stínovou operaci.

  4. Vyberte Naučit profil.

Cloudflare operaci přesune do full stav. Akce řádku se poté změní na Naučený profil. Další informace najdete v Povýšit operaci.

Zjišťování založené na strojovém učení

Vaše koncové body API se zjišťují jak pomocí zjišťování založeného na identifikátorech relace, tak pomocí zjišťování založeného na strojovém učení.

Chcete-li získat přístup k detekci založené na strojovém učení:

  1. V dashboardu Cloudflare přejděte na Webová aktiva stránce.

    Přejděte na Webová aktiva ↗
  2. Přejděte na Discovery kartě.

  3. Filtrujte zdrojové výsledky podle Session Identifier nebo Machine Learning , kde zobrazíte výsledky jednotlivých metod zjišťování.

Pokud veškerý provoz API vaší zóny obsahuje identifikátor relace, který jste nakonfigurovali, mohou oba zdroje díky podobnosti své metodiky poskytovat stejné výsledky. Zjišťování založené na strojovém učení dokáže rozpoznat provoz API bez ohledu na to, zda vaše API identifikátor relace používá.

Veškerou zpětnou vazbu k výsledkům API Discovery můžete směřovat na svůj tým pro správu účtu.

Požadavky

API Discovery vyžaduje aktivní předplatné API Shield na úrovni účtu i zóny. Pokud je předplatné aktivní na úrovni účtu, ale není přiřazeno zóně, Discovery pro danou zónu neběží.

Aby se endpoint zobrazil ve výsledcích Discovery, musí každý požadavek splňovat následující podmínky:

Další informace najdete v tématu Požadavky na zjišťování.

Dostupnost

API Discovery je dostupné pouze pro zákazníky s plánem Enterprise. Pokud jste zákazníkem s plánem Enterprise a máte o tento produkt zájem, obraťte se na svůj tým pro správu účtu.