Criterio HMAC

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Calcola e verifica un codice HMAC (Hash-based Message Authentication Code). A volte noto come Keyed Message Authentication Code o hash con chiave, HMAC utilizza un hash crittografico funzione come SHA-1, SHA-224, SHA-256, SHA-384, SHA-512 o MD-5 applicata a un "messaggio" insieme a una chiave segreta, per produrre una firma o un codice di autenticazione del messaggio su quel messaggio. Termine "messaggio" qui si riferisce a qualsiasi flusso di byte. Il mittente di un messaggio può anche inviare un HMAC a un destinatario, e il destinatario può utilizzare HMAC per autenticare il messaggio.

Per scoprire di più su HMAC, consulta HMAC: Keyed-Hashing per l'autenticazione dei messaggi (rfc2104).

Esempi

<HMAC name='HMAC-1'>

  <Algorithm>SHA256</Algorithm>

  <SecretKey ref='private.secretkey'/>

  <IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables> <!-- optional -->

  <!--
    The "message" can include fixed and multiple variable parts,
    including newlines and static functions.
    Whitespace is significant.
   -->
  <Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
  </Message>

  <!-- default encoding is base64 -->
  <Output encoding='base16'>name_of_variable</Output>

</HMAC>

<HMAC name='HMAC-1'>

  <Algorithm>SHA256</Algorithm>

  <SecretKey ref='private.secretkey'/>

  <IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables> <!-- optional -->

  <!--
    The "message" can include fixed and multiple variable parts,
    including newlines and static functions.
    Whitespace is significant.
   -->
  <Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
  </Message>

  <!--
    VerificationValue is optional.
    Include it to perform an HMAC check.
  -->
  <VerificationValue encoding='base16' ref='expected_hmac_value'/>

  <!-- default encoding is base64 -->
  <Output encoding='base16'>name_of_variable</Output>

</HMAC>

Riferimento elemento per HMAC

La guida di riferimento al criterio descrive gli elementi e gli attributi del criterio HMAC.

Attributi che applica all'elemento di primo livello

<HMAC name="HMAC" continueOnError="false" enabled="true" async="false">

I seguenti attributi sono comuni a tutti gli elementi principali del criterio.

<Algorithm>

<Algorithm>algorithm-name</Algorithm>

Specifica l'algoritmo hash per calcolare l'HMAC.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Da utilizzare in aggiunta all'attributo name per etichettare il criterio nell'editor proxy della UI di Apigee con un nome diverso in linguaggio naturale.

<Message>

<Message>message_template_here</Message>
or
<Message ref='variable_here'/>

Specifica il payload dei messaggi da firmare. L'input di questo elemento supporta modelli di messaggi (sostituzione di variabili) per consentire l'inclusione di elementi aggiuntivi in fase di runtime, come timestamp, nonce, elenchi di intestazioni o altre informazioni. Ad esempio:

<Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
</Message>

Il modello di messaggio può includere parti fisse e variabili, tra cui nuove righe e funzioni statiche. Lo spazio vuoto è significativo.

<Output>

<Output encoding='encoding_name'>variable_name</Output>

Specifica il nome della variabile che il criterio deve impostare con il valore HMAC calcolato. Specifica anche la codifica da utilizzare per l'output.

<SecretKey>

<SecretKey encoding='encoding_name' ref='private.secretkey'/>

Specifica la chiave segreta utilizzata per calcolare l'HMAC. La chiave viene ottenuta dall'oggetto decodificata in base alla codifica specifica.

 <SecretKey encoding='hex' ref='private.encodedsecretkey'/>

<VerificationValue>

<VerificationValue encoding='encoding_name' ref='variable_name'/>
or
<VerificationValue encoding='encoding_name'>string_value</VerificationValue>

(Facoltativo) Specifica il valore di verifica e l'algoritmo di codifica che era utilizzato per codificare il valore di verifica. Il criterio utilizzerà questo algoritmo per decodificare il valore.

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

Imposta su false se vuoi che il criterio generi un errore quando viene specificata una variabile di riferimento del criterio non è risolvibile. Imposta su true per trattare le variabili non risolvibili come stringhe vuote (nullo).

Il valore booleano IgnoraUnresolvedVariables influisce solo sulle variabili a cui viene fatto riferimento nel di messaggistica di Google. Sebbene SecretKey e VerificationValue possano fare riferimento a una variabile, di queste devono essere risolvibili, quindi l'impostazione ignore non si applica a queste ultime.

Variabili di flusso

Il criterio può impostare queste variabili durante l'esecuzione.

Messaggi di errore

Questa sezione descrive i codici e i messaggi di errore che vengono restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Variabili di errore

Queste variabili vengono impostate quando si verifica un errore di runtime. Per ulteriori informazioni, consulta Cosa devi sapere sugli errori relativi alle norme.

Esempio di risposta di errore

Per la gestione degli errori, la best practice è il trap della parte errorcode dell'errore risposta. Non fare affidamento sul testo in faultstring, perché potrebbe cambiare.

Esempio di regola di errore

<FaultRules>
    <FaultRule name="HMAC Policy Errors">
        <Step>
            <Name>AM-Unauthorized</Name>
            <Condition>(fault.name Matches "HmacVerificationFailed")</Condition>
        </Step>
        <Condition>hmac.HMAC-1.failed = true</Condition>
    </FaultRule>
</FaultRules>