Richtlinienerweiterungen - Anwendungsfälle

Bestimmte Kundenanwendungen haben Anforderungen, die mit bestehenden Richtlinien und Ausdrücken nicht berücksichtigt werden können. Mit der Richtlinienerweiterung können Kunden benutzerdefinierte Funktionen zu ihren Anwendungen hinzufügen, um ihre Anforderungen zu erfüllen.

Die folgenden Anwendungsfälle veranschaulichen das Hinzufügen neuer Funktionen mithilfe der Richtlinienerweiterungsfunktion auf der Citrix ADC Appliance.

• Fall 1: Benutzerdefinierter Hash
• Fall 2: Doppelschrägstriche in URLs reduzieren
• Fall 3: Kopfzeilen kombinieren

Fall 1: Benutzerdefinierter Hash

Die CUSTOM_HASH Funktion bietet einen Mechanismus, um jede Art von Hash-Wert in die an den Client gesendeten Antworten einzufügen. In diesem Anwendungsfall wird die Hash-Funktion verwendet, um den Hash der Abfragezeichenfolge für eine Rewrite HTTP-Anforderung zu berechnen und einen HTTP-Header namens CUSTOM_HASH mit dem berechneten Wert einzufügen. Die CUSTOM_HASH Funktion implementiert den DJB2-Hash-Algorithmus.

Beispielverwendung von CUSTOM_HASH:

> add rewrite action test_custom_hash insert_http_header "CUSTOM_HASH" "HTTP.REQ.URL.QUERY.CUSTOM_HASH"
 

Beispieldefinition von CUSTOM_HASH ():

    -- Extension function to compute custom hash on the text

    -- Uses the djb2 string hash algorithm
    function NSTEXT:CUSTOM_HASH() : NSTEXT

        local hash = 5381

        local len = string.len(self)

        for i = 1, len do

             hash = bit32.bxor((hash * 33), string.byte(self, i))

        end

        return tostring(hash)

    end
 

Zeilenweise Beschreibung der obigen Probe:

function NSTEXT:CUSTOM_HASH() : NSTEXT

Defines the CUSTOM_HASH() function, with text input and a text return value.

local hash = 5381
local len = string.len(self)

Declares two local variables:

 - hash. Accumulates the compute hash value and is seeded with the number 5381

 - len. Sets to the length of the self input text string, using the built-in string.len() function.

for i = 1, len do
      hash = bit32.bxor((hash * 33), string.byte(self, i))
end

Iterates through each byte of the input string and adds the byte to the hash. It uses the built-in string.byte() function to get the byte and the built-in bit32.bxor() function to compute the XOR of the existing hash value (multiplied by 33) and the byte.

return tostring(hash)

Calls the built-in tostring() function to convert the numeric hash value to a string and returns the string as the value of the function.
 

Fall 2: Doppelschrägstriche in URLs reduzieren

Durch das Reduzieren doppelter Schrägstriche in URLs wird die Rendering-Zeit der Website verbessert, da Browser die URLs mit einem Schrägstrich effizienter analysieren. Die einzelnen Schrägstriche URLs auch zur Aufrechterhaltung der Kompatibilität mit Anwendungen, die keine doppelten Schrägstriche akzeptieren. Mit der Richtlinienerweiterung können Kunden eine Funktion hinzufügen, die die doppelten Schrägstriche durch einzelne Schrägstriche in den URLs ersetzt. Das folgende Beispiel veranschaulicht das Hinzufügen einer Richtlinienerweiterungsfunktion, die Doppelschrägstriche in URLs reduziert.

Beispieldefinition von COLLAPSE_DOUBLE_SLASHES ():

    -- Collapse double slashes in URL to a single slash and return the result
    function NSTEXT:COLLAPSE_DOUBLE_SLASHES() : NSTEXT

        local result = string.gsub(self, "//", "/")

        return result

    end
 

Zeilenweise Beschreibung der obigen Probe:

function NSTEXT:COLLAPSE_DOUBLE_SLASHES() : NSTEXT

Declares the COLLAPSE_DOUBLE_SLASHES() function with text input and return.

local result = string.gsub(self, "//", "/")

Declares a local variable named result and uses the built-in string.gsub() function to replace all double slashes with single slashes in the self input text.

The second parameter of string.gsub() is actually a regular expression pattern, although here a simple string is used for the pattern.

return result

Returns the resulting string.
 

Fall 3: Kopfzeilen kombinieren

Bestimmte Kundenanwendungen können nicht mehrere Header in einer Anforderung verarbeiten. Auch das Parsen von doppelten Headern mit gleichen Header-Werten oder mehreren Headern mit demselben Namen, aber unterschiedlichen Werten in einer Anforderung verbraucht Zeit und Netzwerkressourcen. Die Richtlinienerweiterungsfunktion ermöglicht es Kunden, eine Funktion hinzuzufügen, um diese Header zu einzelnen Headern zu kombinieren, wobei ein Wert, der die ursprünglichen Werte kombiniert. Beispiel: Kombinieren Sie die Werte der Header H1 und H2.

Ursprüngliche Anfrage:

GET /combine_headers HTTP/1.1
User-Agent: amigo unit test
Host: myhost
H2: h2val1
H1: abcd
Accept: \*/\*
H2: h2val2
Content-Length: 0
H2: h2val3
H1: 1234
 

Geänderte Anfrage:

GET /combine_headers HTTP/1.1
User-Agent: amigo unit test
Host: myhost
H2: h2val1, h2val2, h2val3
H1: abcd, 1234
Accept: \*/\*
Content-Length: 0
 

Im Allgemeinen wird diese Art von Anforderungsänderung mit der Funktion “Umschreiben” durchgeführt, wobei Richtlinienausdrücke verwendet werden, um den Teil der zu ändernden Anforderung (das Ziel) und die durchzuführende Änderung (der Zeichenfolgengenerator-Ausdruck) zu beschreiben. Richtlinienausdrücke können jedoch nicht über eine beliebige Anzahl von Headern iterieren.

Die Lösung dieses Problems erfordert eine Erweiterung der Richtlinienfazilität. Um dies zu tun, werden wir eine Erweiterungsfunktion definieren, genannt COMBINE_HEADERS. Mit dieser Funktion können wir die folgende Rewrite-Aktion einrichten:

> add rewrite action combine_headers_act replace 'HTTP.REQ.FULL_HEADER.AFTER_STR("HTTP/1.1rn")' 'HTTP.REQ.FULL_HEADER.AFTER_STR("HTTP/1.1rn").COMBINE_HEADERS'

Hier ist das Rewrite-Ziel HTTP.REQ.FULL_HEADER.AFTER_STR (“HTTP/1.1rn”). Die AFTER_STR (“HTTP/1.1rn”) ist erforderlich, da FULL_HEADER die erste Zeile der HTTP-Anfrage enthält (z.B. GET /combine_headers HTTP/1.1).

Der String-Builder-Ausdruck ist HTTP.REQ.FULL_HEADER.AFTER_STR(“HTTP/1.1rn”).COMBINE_HEADERS, wobei die Header (ohne die erste Zeile) in die Erweiterungsfunktion COMBINE_HEADERS eingespeist werden, die die Werte für Header kombiniert und zurückgibt.

Beispieldefinition von COMBINE_HEADERS ():

    -- Extension function to combine multiple headers of the same name into one header.



    function NSTEXT:COMBINE_HEADERS(): NSTEXT

        local headers = {} -- headers

        local combined_headers = {} -- headers with final combined values
        -- Iterate over each header (format "name:valuer\r\n")

        -- and build a list of values for each unique header name.

        for name, value in string.gmatch(self, "([^:]+):([^\r\n]*)\r\n") do

            if headers[name] then

                local next_value_index = #(headers[name]) + 1

                headers[name][next_value_index] = value

            else

                headers[name] = {name .. ":" .. value}

            end

        end



        -- iterate over the headers and concat the values with separator ","

        for name, values in pairs(headers) do

            local next_header_index = #combined_headers + 1

            combined_headers[next_header_index] = table.concat(values, ",")

        end



        -- Construct the result headers using table.concat()

        local result_str = table.concat(combined_headers, "\r\n") .. "\r\n\r\n"

        return result_str

    end
 

Zeilenweise Beschreibung der obigen Probe:

function NSTEXT:COMBINE_HEADERS(): NSTEXT

Defines the COMBINE_HEADERS extension function, with the text input into the function from the policy expression and a text return type to the policy expression.

local headers = {} -- headers
local combined_headers = {} -- headers with final combined values

Declares local variables headers and combined_headers and initialize these variables to empty tables. headers will be a table of arrays of strings, where each array holds one or more values for a header. combined_headers will be an array of strings, where each array element is a header with its combined values.

for name, value in string.gmatch(self, "([^:]+):([^\r\n]*)\r\n") do
. . .
end
 

Diese generische for-Schleife analysiert jeden Header in der Eingabe. Der Iterator ist die integrierte String.gmatch () Funktion. Diese Funktion verwendet zwei Parameter: eine zu suchende Zeichenfolge und ein Muster, mit dem Teile der Zeichenfolge übereinstimmen. Die zu suchende Zeichenfolge wird durch den impliziten Selbstparameter bereitgestellt, der der Text für die Header ist, die in die Funktion eingegeben werden.

Das Muster wird mit einem regulären Ausdruck ausgedrückt (Regex für kurz). Diese Regex entspricht dem Headernamen und -wert für jeden Header, den der HTTP-Standard als name:value\r\n definiert. Die Klammern in der Regex geben die passenden Teile an, die extrahiert werden sollen. Daher lautet das Regex-Schema (Match-Name):(Match-Wert)\r\n. Das Match-Name-Muster muss mit allen Zeichen außer dem Doppelpunkt übereinstimmen. Dies ist geschrieben [^:]+ ([^:] ist ein beliebiges Zeichen außer: und + ist eine oder mehrere Wiederholungen). In ähnlicher Weise muss das Match-Wert-Muster mit allen Zeichen außer dem\ r\ n übereinstimmen, also wird es geschrieben [^\ r\ n]([^\ r\ n] entspricht jedem Zeichen außer\ r und\ n und ist Null oder mehr Wiederholungen). Dies macht die komplette Regex ([^:]+):([^\ r\ n]*)\r\n.

Die for -Anweisung verwendet eine Mehrfachzuweisung, um Namen und Wert auf die beiden Übereinstimmungen festzulegen, die vom string.gmatch () Iterator zurückgegeben werden. Diese werden implizit als lokale Variablen im Körper der for-Schleife deklariert.

if headers[name] then
     local next_value_index = #(headers[name]) + 1
     headers[name][next_value_index] = value
else
     headers[name] = {name .. ":" .. value}
end
 

Diese Anweisungen innerhalb der for-Schleife setzen die Headernamen und -werte in die Header-Tabelle. Wenn ein Header-Name zum ersten Mal analysiert wird (z. B. H2: h2val1 in der Beispieleingabe), gibt es keinen Headereintrag für den Namen und der[Headername] ist nil.

Da nil als falsch behandelt wird, wird die else-Klausel ausgeführt. Dies setzt den Header-Eintrag für name auf ein Array mit einem Zeichenfolgenwert name:value.

Hinweis: Der Array-Konstruktor in der else-Schleife entspricht {[1] = name.. “:”.. value}, wodurch das erste Element des Arrays festgelegt wird.) Für den ersten H2-Header setzt es die Header[“H2”] = {“ H2:H2val1”}.

Bei nachfolgenden Instanzen eines Headers (z. B. H2: h2val2 in der Beispieleingabe). header[Headername] ist nicht nil, daher wird die then-Klausel ausgeführt. Dies bestimmt den nächsten verfügbaren Index im Array-Wert für headers[Headername]und setzt den Header-Wert in diesen Index. Für den zweiten H2-Header setzt er headers[“H2”]= {“H2:h2val1”, “h2val2”}.

for name, values in pairs(headers) do
    local next_header_index = #combined_headers + 1
    combined_headers[next_header_index] = table.concat(values, ",")
end
 

Nachdem die ursprünglichen Header analysiert und die Header-Tabelle ausgefüllt wurde, erstellt diese Schleife das kombined_headers-Array. Es verwendet die pairs() Funktion als for-Schleifen-Iterator.

Jeder Aufruf von pairs() gibt den Namen und den Wert des nächsten Eintrags in der Header-Tabelle zurück.

Die nächste Zeile bestimmt den nächsten verfügbaren Index im array combined_headers, und die nächste Zeile setzt dieses Array-Element auf den kombinierten Header. Es verwendet die integrierte Funktion table.concat(), die als Argumente ein Array von Strings und eine Zeichenfolge als Trennzeichen verwendet, und gibt eine Zeichenfolge zurück, die die Verkettung der Array-Strings ist, getrennt durch das Trennzeichen.

Für Werte = {“H2:h2val1”, “h2val2”} ergibt dies beispielsweise “H2:h2val1, h2val2”

local result_str = table.concat(combined_headers, "\r\n") .. "\r\n\r\n"
 

Nachdem das Array combined_headers erstellt wurde, verkettet es die Elemente zu einer Zeichenfolge und fügt einen doppelten \r\n hinzu, der die HTTP-Header beendet.

return result_str
 

Gibt eine Zeichenfolge als Ergebnis der Erweiterungsfunktion COMBINE_HEADERS zurück.