Aggiunta del supporto CORS a un proxy API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Avviso: gli esempi forniti in questa sezione consentono l'accesso al proxy API da qualsiasi origine e devono essere protetti prima di essere utilizzati in un ambiente di produzione. Ad esempio, puoi consentire i domini che possono accedere al proxy API.

CORS (Cross-origin resource sharing) è un meccanismo standard che consente alle chiamate JavaScript XMLHttpRequest (XHR) eseguite in una pagina web di interagire con risorse di domini non di origine. CORS è una soluzione comunemente implementata per i criteri della stessa origine applicati da tutti i browser. Ad esempio, se effettui una chiamata XHR all'API Twitter dal codice JavaScript in esecuzione nel browser, la chiamata non andrà a buon fine. Questo perché il dominio che pubblica la pagina sul tuo browser non è lo stesso del dominio che pubblica l'API Twitter. CORS fornisce una soluzione a questo problema consentendo ai server di attivare la condivisione delle risorse tra origini.

Nota:la maggior parte dei browser moderni supporta CORS. Consulta la pagina Condivisione delle risorse tra origini diverse per visualizzare un elenco completo dei browser supportati. Per una descrizione dettagliata di CORS, consulta lo standard Fetch Living.

Se utilizzi una policy di memorizzazione nella cache sul proxy API, devi assicurarti che la risposta della policy CORS non venga memorizzata nella cache.

Caso d'uso tipico per CORS

Il seguente codice JQuery chiama un servizio di destinazione fittizio. Se eseguita dal contesto di un browser (una pagina web), la chiamata non andrà a buon fine a causa del criterio della stessa origine:

<script>
var url = "http://service.example.com";
$(document).ready(function(){
  $("button").click(function(){
    $.ajax({
        type:"GET",
        url:url,
        async:true,
        dataType: "json",
           success: function(json) {
              // Parse the response.
              // Do other things.
           },
           error: function(xhr, status, err) {
              // This is where we end up!
            }
    });
  });
});
</script>

Una soluzione a questo problema è creare un proxy API Apigee che chiami l'API del servizio sul backend. Ricorda che Apigee si trova tra il client (in questo caso un browser) e l'API di backend (il servizio). Poiché il proxy API viene eseguito sul server, non in un browser, è in grado di chiamare il servizio correttamente. A questo punto, non devi fare altro che allegare le intestazioni CORS alla risposta TargetEndpoint. Se il browser supporta CORS, queste intestazioni segnalano al browser che è possibile rilassare i criteri della stessa origine, consentendo la riuscita della chiamata API cross-origin.

Una volta creato il proxy con supporto CORS, puoi chiamare l'URL del proxy API anziché il servizio di backend nel codice lato client. Ad esempio:

<script>
var url = "http://myorg-test.apigee.net/v1/example";
$(document).ready(function(){
  $("button").click(function(){
    $.ajax({
        type:"GET",
        url:url,
        async:true,
        dataType: "json",
           success: function(json) {
              // Parse the response.
              // Do other things.
           },
           error: function(xhr, status, err) {
              // This time, we do not end up here!
            }
    });
  });
});
</script>

Nota:nel caso più semplice, puoi restituire le intestazioni CORS al client e la richiesta multiorigine funzionerà. Esistono casi più complessi in cui è richiesta una richiesta di preflight. Puoi leggere informazioni sulle richieste CORS preflight nello standard Fetch Living, nonché in numerosi articoli e blog. Vedi anche Gestione delle richieste preflight CORS di seguito.

Collegamento del criterio CORS al PreFlow della richiesta di ProxyEndpoint

Collegamento di una policy Aggiungi CORS a un nuovo proxy API

Puoi aggiungere il supporto CORS a un proxy API collegando una policy Aggiungi CORS al proxy API nei seguenti modi:

• Quando crei la policy selezionando la casella di controllo Aggiungi intestazioni CORS nella pagina Sicurezza della procedura guidata Crea un proxy
• Aggiungendolo in un secondo momento dalla finestra di dialogo Aggiungi norma

Quando aggiungi la policy CORS selezionando la casella di controllo, una policy denominata Add CORS viene aggiunta automaticamente al sistema e collegata al preflow della richiesta TargetEndpoint.

Il criterio Aggiungi CORS aggiunge le intestazioni appropriate alla risposta. In sostanza, le intestazioni comunicano al browser con quali origini condividerà le risorse, quali metodi accetta e così via. Puoi scoprire di più su queste intestazioni CORS nella raccomandazione W3C sul Cross-Origin Resource Sharing.

Devi modificare la norma nel seguente modo:

• Aggiungi le intestazioni content-type e authorization (necessarie per supportare l'autenticazione di base o OAuth2) all'intestazione Access-Control-Allow-Headers, come mostrato nell'estratto di codice riportato di seguito.
• Per l'autenticazione OAuth2, potrebbe essere necessario intervenire per correggere il comportamento non conforme alla RFC.

<CORS continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <AllowOrigins>{request.header.origin}</AllowOrigins>
    <AllowMethods>GET, PUT, POST, DELETE</AllowMethods>
    <AllowHeaders>origin, x-requested-with, accept, content-type, authorization</AllowHeaders>
    <ExposeHeaders>*</ExposeHeaders>
    <MaxAge>3628800</MaxAge>
    <AllowCredentials>false</AllowCredentials>
    <GeneratePreflightResponse>true</GeneratePreflightResponse>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</CORS>

Aggiunta di intestazioni CORS a un proxy esistente

Nota:Apigee sta introducendo una nuova versione dell'editor proxy, che semplificherà la gestione dei proxy.

Le istruzioni nelle prime due schede riportate di seguito spiegano come utilizzare il nuovo editor proxy o l'editor proxy classico.

Nuovo editor proxy

Per aggiungere il criterio CORS a un proxy API esistente:

1. Se utilizzi l'interfaccia utente Apigee nella console Cloud: seleziona Sviluppo proxy > Proxy API.

   Se utilizzi la UI Apigee classica: seleziona Sviluppa > Proxy API e nel riquadro Proxy, seleziona l'ambiente per il proxy.

2. Seleziona il proxy API a cui vuoi aggiungere la policy CORS.
3. Nell'editor del nuovo proxy API, fai clic sulla scheda Sviluppa.
4. Nel riquadro a sinistra, fai clic sul pulsante + nella riga Criteri.

5. Nella finestra di dialogo Crea criterio, fai clic nel campo Seleziona tipo di criterio e scorri verso il basso fino a Sicurezza e seleziona CORS.

6. Inserisci i dettagli del criterio e fai clic su Crea.

7. Nel riquadro a sinistra, fai clic su PreFlow in Endpoint di destinazione > predefinito.
8. Fai clic sul pulsante + accanto a PreFlow nel riquadro Richiesta in basso a destra dell'editor visuale.
9. Nella finestra di dialogo Passaggio Aggiungi policy, seleziona la policy CORS.

10. Fai clic su Aggiungi per allegare la policy.

Editor proxy classico

Per aggiungere il criterio CORS a un proxy API esistente:

1. Accedi alla UI Apigee.
2. Seleziona Sviluppa > Proxy API nella barra di navigazione a sinistra.
Se vedi il pulsante Prova ora, fai clic per visualizzare la nuova visualizzazione Sviluppa.

Informazioni sul pulsante Prova ora

Se è la prima volta che utilizzi la nuova versione dell'editor proxy, nella parte superiore della visualizzazione Sviluppa vedrai il seguente banner:



Fai clic sul pulsante Prova ora per visualizzare la nuova visualizzazione Sviluppa.

Nota:se in precedenza hai fatto clic sul pulsante Prova ora, non verrà visualizzato.

La visualizzazione Sviluppa è mostrata di seguito.



3. Seleziona il proxy API a cui vuoi aggiungere la policy CORS.
4. Nell'editor del nuovo proxy API, fai clic sulla scheda Sviluppa:

5. Nel riquadro di navigazione a sinistra, fai clic su PreFlow in Endpoint di destinazione > default.
6. Fai clic sul pulsante +Passaggio in alto, corrispondente al pre-flow della richiesta. Viene visualizzato un elenco categorizzato di tutte le norme che puoi creare.
   
7. Seleziona CORS nella categoria Sicurezza.
8. Fornisci un nome, ad esempio Add CORS, e poi fai clic su Aggiungi.

Gestione delle richieste preflight CORS

Il preflight CORS si riferisce all'invio di una richiesta a un server per verificare se supporta CORS. Le risposte preflight tipiche includono le origini da cui il server accetterà le richieste CORS, un elenco di metodi HTTP supportati per le richieste CORS, le intestazioni che possono essere utilizzate nell'ambito della richiesta di risorse, il tempo massimo per cui la risposta preflight verrà memorizzata nella cache e altro ancora. Se il servizio non indica il supporto di CORS o non vuole accettare richieste tra origini dall'origine del client, verrà applicata la policy tra origini del browser e qualsiasi richiesta tra domini effettuata dal client per interagire con le risorse ospitate su quel server non andrà a buon fine.

In genere, le richieste preflight CORS vengono effettuate con il metodo HTTP OPTIONS. Quando un server che supporta CORS riceve una richiesta OPTIONS, restituisce un insieme di intestazioni CORS al client che indicano il suo livello di supporto CORS. A seguito di questo handshake, il client sa cosa può richiedere dal dominio non di origine.

Nota: se hai un criterio per la verifica della chiave API in PreFlow dell'endpoint proxy, questo viene applicato a tutte le richieste in entrata. Se non vuoi applicare il criterio alle richieste preflight CORS, aggiungi una condizione per ignorare quando il metodo è OPTIONS. Ad esempio, utilizza la seguente configurazione del proxy API:

<PreFlow name="PreFlow">
    <Request>
        <Step>
            <Name>verify-api-key</Name>
            <Condition>request.verb != "OPTIONS"</Condition>
        </Step>
    </Request>
    <Response/>
</PreFlow>

Per ulteriori informazioni sul controllo preliminare, consulta la raccomandazione W3C per la condivisione delle risorse tra origini diverse. Esistono inoltre numerosi blog e articoli su CORS a cui puoi fare riferimento.

Apigee non include una soluzione preflight CORS predefinita, ma è possibile implementarla, come descritto in questa sezione. L'obiettivo è che il proxy valuti una richiesta OPTIONS in un flusso condizionale. Il proxy può quindi inviare una risposta appropriata al client.

Diamo un'occhiata a un flusso di esempio e poi analizziamo le parti che gestiscono la richiesta di preflight:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProxyEndpoint name="default">
    <Description/>
    <Flows>
        <Flow name="OptionsPreFlight">
            <Request>
                <Step>
                    <Name>add-cors</Name>
                </Step>
            </Request>
            <Response/>
        <Condition>request.verb == "OPTIONS" AND request.header.origin != null AND request.header.Access-Control-Request-Method != null</Condition>
        </Flow>
    </Flows>

    <PreFlow name="PreFlow">
        <Request/>
        <Response/>

    </PreFlow>
    <HTTPProxyConnection>
        <BasePath>/v1/cnc</BasePath>
        <VirtualHost>default</VirtualHost>
        <VirtualHost>secure</VirtualHost>
    </HTTPProxyConnection>
    <RouteRule name="NoRoute">
        <Condition>request.verb == "OPTIONS" AND request.header.origin != null AND request.header.Access-Control-Request-Method != null</Condition>
    </RouteRule>
    <RouteRule name="default">
        <TargetEndpoint>default</TargetEndpoint>
   </RouteRule>
   <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
</ProxyEndpoint>

Le parti principali di questo ProxyEndpoint sono le seguenti:

• Viene creata una RouteRule per una destinazione NULL con una condizione per la richiesta OPTIONS. Tieni presente che non è specificato alcun TargetEndpoint. Se viene ricevuta la richiesta OPTIONS e le intestazioni della richiesta Origin e Access-Control-Request-Method non sono nulle, il proxy restituisce immediatamente le intestazioni CORS in una risposta al client (ignorando la destinazione "backend" predefinita effettiva). Per informazioni dettagliate sulle condizioni del flusso e su RouteRule, consulta la sezione Condizioni con variabili di flusso.
  

  <RouteRule name="NoRoute">
      <Condition>request.verb == "OPTIONS" AND request.header.origin != null AND request.header.Access-Control-Request-Method != null</Condition>
  </RouteRule>

• Viene creato un flusso OptionsPreFlight che aggiunge un criterio CORS, contenente le intestazioni CORS, al flusso se viene ricevuta una richiesta OPTIONS e le intestazioni delle richieste Origin e Access-Control-Request-Method non sono nulle.
  

   <Flow name="OptionsPreFlight">
              <Request>
                  <Step>
                      <Name>add-cors</Name>
                  </Step>
              </Request>
              <Response/>
          <Condition>request.verb == "OPTIONS" AND request.header.origin != null AND request.header.Access-Control-Request-Method != null</Condition>
   </Flow>

Nota:le RouteRules vengono valutate nell'ordine specificato nella configurazione ProxyEndpoint. Alla fine deve sempre esserci la route predefinita (nessuna condizione). In caso contrario, se si trova in cima, avrà sempre una corrispondenza e non valuterà mai le altre possibilità di Route.