Zarządzanie maskowaniem informacji umożliwiających identyfikację w pakietach proxy i wspólnych przepływów

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

Zarządzanie maskowaniem informacji umożliwiających identyfikację w pakietach serwera proxy i współdzielonych przepływów

W ramach procesu synchronizacji integracja łącznika centrum interfejsów API przesyła pakiety proxy interfejsu API do centrum interfejsów API. Te pakiety mogą zawierać dane wrażliwe lub informacje umożliwiające identyfikację w konfiguracjach zasad. Ta funkcja umożliwia maskowanie zidentyfikowanych pól informacji umożliwiających identyfikację, zanim pakiety zostaną przesłane do centrum interfejsów API.

Podejście do maskowania

Maskowanie informacji umożliwiających identyfikację jest stosowane za pomocą wyrażeń XPath, aby kierować reklamy na określone elementy w konfiguracjach zasad w pakietach serwera proxy i sharedflow w formacie XML, ale nie na inne ogólne elementy XML w pakiecie. Ta funkcja jest podzielona na 2 części:

Domyślne maski

Apigee Edge zawiera wstępnie zdefiniowaną, wbudowaną listę wyrażeń XPath, które automatycznie kierują reklamy na typowe pola informacji umożliwiających identyfikację. Maski są stosowane automatycznie podczas przesyłania.

Lista domyślnych masek:

Nazwa zasady Opis pola (lub wartości) Wyrażenia XPath
AccessEntity Identyfikator jednostki //AccessEntity/EntityIdentifier
AccessEntity Dodatkowy identyfikator //AccessEntity/SecondaryIdentifier
BasicAuthentication Wartość pola użytkownika //BasicAuthentication/User
BasicAuthentication Wartość pola hasła //BasicAuthentication/Password
ConnectorCallout Treść żądania w formacie JSON do wysłania do rozszerzenia //ConnectorCallout/Input
FlowCallout Wartości parametrów przekazywanych do wywołania przepływu //FlowCallout/Parameter
//FlowCallout/Parameters/Parameter
HMAC Klucz tajny używany do obliczania HMAC //HMAC/SecretKey
HMAC Treść wiadomości do podpisania //HMAC/Message
HMAC Wartość weryfikacji HMAC //HMAC/VerificationValue
JavaCallout Przekazywane właściwości (konfiguracja/dane wrażliwe) //JavaCallout/Properties/Property
Javascript Źródło w tekście //Javascript/Source
Javascript Wartości właściwości //Javascript/Properties/Property
GenerateJWS Wartość klucza prywatnego //GenerateJWS/PrivateKey/Value
GenerateJWS Hasło do klucza prywatnego //GenerateJWS/PrivateKey/Password
GenerateJWS Identyfikator klucza prywatnego //GenerateJWS/PrivateKey/Id
GenerateJWS Wartość klucza obiektu tajnego //GenerateJWS/SecretKey/Value
GenerateJWS Identyfikator klucza obiektu tajnego //GenerateJWS/SecretKey/Id
VerifyJWS Klucze publiczne JWKS //VerifyJWS/PublicKey/JWKS
VerifyJWS Wartość klucza publicznego //VerifyJWS/PublicKey/Value
VerifyJWS Wartość klucza obiektu tajnego //VerifyJWS/SecretKey/Value
GenerateJWT Krytyczne wartości nagłówków //GenerateJWT/CriticalHeaders
GenerateJWT Wartość klucza prywatnego używana do podpisywania tokena JWT. //GenerateJWT/PrivateKey/Value
GenerateJWT Hasło do klucza prywatnego //GenerateJWT/PrivateKey/Password
GenerateJWT Identyfikator klucza prywatnego //GenerateJWT/PrivateKey/Id
GenerateJWT Wartość klucza obiektu tajnego //GenerateJWT/SecretKey/Value
GenerateJWT Identyfikator klucza obiektu tajnego //GenerateJWT/SecretKey/Id
VerifyJWT Klucz publiczny //VerifyJWT/PublicKey/Value
VerifyJWT Klucz obiektu tajnego //VerifyJWT/SecretKey/Value
KeyValueMapOperations Wartości dla początkowych wpisów i operacji PUT //KeyValueMapOperations/InitialEntries/Entry/Value
//KeyValueMapOperations/Put/Value
Ldap Wartości pól nazwy użytkownika i hasła //Ldap/Authentication/UserName
//Ldap/Authentication/Password
OAuthV1 Tokeny //OAuthV1/Tokens/Token
OAuthV1 Token dostępu //OAuthV1/AccessToken
OAuthV1 Wartości atrybutów //OAuthV1/Attributes/Attribute
OAuthV1 Kod weryfikatora //OAuthV1/VerifierCode
OAuthV1 Identyfikator użytkownika aplikacji //OAuthV1/AppUserId
OAuthV1 Żądanie tokena //OAuthV1/RequestToken
OAuthV2 Wartości atrybutów //OAuthV2/Attributes/Attribute
GetOAuthV2Info Token dostępu //GetOAuthV2Info/AccessToken
GetOAuthV2Info Kod autoryzacji //GetOAuthV2Info/AuthorizationCode
GetOAuthV2Info Identyfikator klienta //GetOAuthV2Info/ClientId
GetOAuthV2Info Token odświeżania //GetOAuthV2Info/RefreshToken
RevokeOAuthV2 Identyfikator aplikacji //RevokeOAuthV2/AppId
RevokeOAuthV2 Identyfikator użytkownika //RevokeOAuthV2/EndUserId
SetOAuthV2Info Token dostępu //SetOAuthV2Info/AccessToken
SetOAuthV2Info Wartości atrybutów //SetOAuthV2Info/Attributes/Attribute
DeleteOAuthV2Info Wartość tokena dostępu //DeleteOAuthV2Info/AccessToken
DeleteOAuthV2Info Wartość kodu autoryzacji //DeleteOAuthV2Info/AuthorizationCode
StatisticsCollector Wartość statystyki //StatisticsCollector/Statistics/Statistic
VerifyAPIKey Klucz interfejsu API zakodowany na stałe //VerifyAPIKey/APIKey

Zarządzanie maskami niestandardowymi

Specjalny interfejs API umożliwia przesyłanie dostosowanej listy wyrażeń XPath w celu maskowania określonych pól, które uznasz za zawierające informacje umożliwiające identyfikację. Dzięki temu możesz mieć pewność, że Twoje unikalne potrzeby w zakresie ochrony danych są zaspokojone.

Niestandardowymi maskami informacji umożliwiających identyfikację możesz zarządzać za pomocą /v1/organizations/<var>ORG_NAME/uapim/proxymasks punktu końcowego interfejsu Edge Management API. Aby wykonać te operacje, musisz mieć rolę orgadmin.

Interfejs API działa na jednej liście wyrażeń XPath o nazwie proxymasks dla danej organizacji.

Metoda Zasób Podsumowanie Opis
GET /v1/organizations/ORG_NAME/uapim/proxymasks Pobieranie listy XPath „proxymasks” Pobiera pełną listę wyrażeń XPath dla „proxymasks” w przypadku danej organizacji.
PUT /v1/organizations/ORG_NAME/uapim/proxymasks Tworzenie lub zastępowanie listy XPath „proxymasks” Tworzy listę „proxymasks”, jeśli nie istnieje, lub całkowicie zastępuje jej zawartość, jeśli istnieje.
DELETE /v1/organizations/ORG_NAME/uapim/proxymasks Usuń listę XPath „proxymasks”. Usuwa wszystkie wyrażenia XPath z listy „proxymasks” w organizacji.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/append Dołączanie wyrażeń XPath do listy „proxymasks” Dodaje co najmniej 1 ciąg XPath na końcu istniejącej listy „proxymasks”.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems Usuwanie określonych ścieżek XPath z listy „proxymasks” Usuwa określone ciągi XPath z listy „proxymasks”. Dopasowuje dokładnie do konkretnych ciągów.

Wszystkie żądania i odpowiedzi dotyczące tworzenia, zastępowania, pobierania, dołączania lub usuwania elementów z listy XPath używają tego schematu JSON:

{
  "xpaths": [
    "//Path/To/Element"
  ]
}
Pole Typ Opis
xpaths tablica ciągów znaków Lista ciągów wyrażeń XPath, które mają zostać zamaskowane. To pole jest wymagane.

1. Tworzenie lub zastępowanie niestandardowej listy XPath (PUT)

Użyj metody PUT, aby utworzyć nową listę niestandardową lub całkowicie zastąpić zawartość istniejącej listy. Wszystkie dotychczasowe wyrażenia XPath zostaną zastąpione.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \
  -H "Authorization: Bearer OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "xpaths": [
      "//StatisticsCollector/Statistics/Statistic[@name='caller']",
      "//AssignMessage/AssignVariable[Name='password']/Value"
    ]
  }'

Po zakończeniu aktualizacji wyświetli się odpowiedź 201 Created lub 200K z tym komunikatem: Success response (201 Created or 200 OK)

{
  "xpaths": [
    "//StatisticsCollector/Statistics/Statistic[@name='caller']",
    "//AssignMessage/AssignVariable[Name='password']/Value"
  ]
}

2. Pobieranie listy niestandardowych wyrażeń XPath (GET)

Aby pobrać bieżącą listę niestandardowych wyrażeń XPath, użyj metody GET.

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \
  -H "Authorization: Bearer OAUTH_TOKEN"

Po zakończeniu pobierania wyświetli się odpowiedź 200K z tym komunikatem:Success response (200 OK):

{
  "xpaths": [
    "//StatisticsCollector/Statistics/Statistic[@name='caller']",
    "//AssignMessage/AssignVariable[Name='password']/Value"
  ]
}

3. Dołączanie do listy wyrażeń XPath (POST append)

Użyj metody POST, aby dodać do istniejącej listy co najmniej 1 wyrażenie XPath bez zastępowania bieżącej zawartości.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks/append \
  -H "Authorization: Bearer OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "xpaths": [
      "//New/Appended/XPath"
    ]
  }'

Po zakończeniu dołączania wyświetli się odpowiedź 200K z tym komunikatem: Success response (200 OK):

{
  "xpaths": [
    "//StatisticsCollector/Statistics/Statistic[@name='caller']",
    "//AssignMessage/AssignVariable[Name='password']/Value",
    "//New/Appended/XPath"
  ]
}

4. Usuwanie z listy określonych ścieżek XPath (POST deleteItems)

Użyj metody POST, aby usunąć z dotychczasowej listy określone wyrażenia XPath. Prośba musi zawierać dokładne ciągi XPath, które mają zostać usunięte.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems \
  -H "Authorization: Bearer OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "xpaths": [
      "//New/Appended/XPath"
    ]
  }'

Po zakończeniu usuwania pojawi się odpowiedź 200K z tym komunikatem: Success response (200 OK):

{
  "xpaths": [
    "//StatisticsCollector/Statistics/Statistic[@name='caller']",
    "//AssignMessage/AssignVariable[Name='password']/Value"
  ]
}

5. Usuwanie całej listy niestandardowych wyrażeń XPath (DELETE)

Aby całkowicie usunąć niestandardową listę XPath, użyj metody DELETE. Spowoduje to usunięcie tylko niestandardowych masek. Domyślne maski nadal będą stosowane.

curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \
  -H "Authorization: Bearer OAUTH_TOKEN"

Po zakończeniu usuwania pojawi się odpowiedź 204 No Content z tym komunikatem: Success response (204 No Content):

HTTP/1.1 204 No Content

Aktualizowanie zamaskowanych pakietów

Gdy zmodyfikujesz niestandardową konfigurację maskowania informacji umożliwiających identyfikację, pakiety proxy interfejsu API, które zostały wcześniej przesłane ze starszą konfiguracją maskowania, muszą zostać ponownie przetworzone przy użyciu najnowszych masek. Aby zaktualizować pakiety za pomocą najnowszych ustawień maskowania, prześlij zgłoszenie, aby rozpocząć niezbędne ponowne przetwarzanie.