Predicates and other script evaluation (like ScriptEvalValve) has support for extensions. An extension is a library of functions in a namespace.

The following extension are available by default:

• str (common string operations)

• mv (multi-value support)

• dbg (debug)

• Ipv4 (IPv4 address matching)

Extension containing debug utilities

describe

Describes a value, prints the result to stdout and returns the value.

Output will contain:

• Type ('string', 'array', 'object', 'number', etc)

• Value (concatenated to 32 chars)

• Length (if applicable)

• If value is an array (when type is 'object')

• If value is JSON (when type is 'string')

• JSON-type (when parsed)

• JSON-length (when parsed)

Syntax

dbg.describe(value[, label])

Arguments

Example

dbg.describe('this is a string', 'string')

// Will output:
--- Describing: string ---
Type: string
Value: this is a string
Length: 16
JSON? no

The str extension contains string helper function for validation and comparison.

size

Returns the size/length of a string. If the supplied value isn't a string, -1 is returned.

Syntax

str.size(value)

Arguments

Example(s)

// Check if value is a string and larger than 3 characters
str.size(scope.value) > 3

isString

Returns true if the supplied value is a string, otherwise false.

Syntax

str.isString(value)

Arguments

Example(s)

str.isString('this is a string') // true
str.isString(99) // false (number)

isNullOrEmpty

Returns true if the supplied value is null/undefined or an empty string ("").

Syntax

str.isNullOrEmpty(value)

Arguments

Example(s)

str.isNullOrEmpty(null) // true
str.isNullOrEmpty("") // true
str.isNullOrEmpty('this is a string') // false

isNotNullOrEmpty

Returns true if the supplied value is a string and is not null/undefined or empty ("").

Syntax

str.isNotNullOrEmpty(value)

Arguments

Example(s)

str.isNotNullOrEmpty(null) // false
str.isNotNullOrEmpty("") // false
str.isNotNullOrEmpty('this is a string') // true

isEqual

Returns true if the supplied values are strings with identical content, possible with different case.

Syntax

str.isEqual(s1, s2[, ignoreCase])

Arguments

Example(s)

str.isEqual('string value', 'string value') // true
str.isEqual('string value', 'other string value') // false
str.isEqual('string value', 'STRING VALUE') // false
str.isEqual('string value', 'STRING VALUE', true) // true

isEqualIgnoreCase

Returns true if the supplied values are strings with identical content, always ignoring different case.

This function is equivalent to str.isEqual(s1, s2, true)

Syntax

str.isEqualIgnoreCase(s1, s2)

Arguments

Example(s)

str.isEqualIgnoreCase('string value', 'string value') // true
str.isEqualIgnoreCase('string value', 'other string value') // false
str.isEqualIgnoreCase('string value', 'STRING VALUE') // true

matchAny

Returns true if the supplied value match any of the supplied regular expressions (regex).

Syntax

str.matchAny(value, regex[,regex, ...])

Arguments

Example(s)

// plain string regex
str.matchAny('value', 'v.*') // true

// typed regex (format: /regex/flags)
str.matchAny('value', /v.*/) // true
str.matchAny('value', /[0-9]{1,3}/) // false

// case insensitive match using i-flag
str.matchAny('value', /V.*/i) // true 

Script extension for multi value validation and comparison.

All functions operating on multi values will convert supplied value(s) to multi value if not already (see mv.from(value))

In JavaScript multi values are represented as arrays.

mv.from

Converts a value to a multi value if not already.

Handles the following types of input values:

• arrays (returned as is)

• json arrays (parsed to array)

• single values of any types (added as first element to new array)

Syntax

mv.from(value)

Arguments

Example(s)

// Create multi value from single value string
mv.from('elem') // -> ['elem']

// Create multi value from json array
mv.from('["elem01", "elem02"]') // -> ['elem01', 'elem02']

mv.length

Returns the length of the supplied multi value.

Syntax

mv.length(value)

Arguments

Example(s)

// Get multi value length of single value string
mv.length('elem') // -> 1

// Get multi value length of an array
mv.length(['elem01', 'elem02', 'elem03']) // -> 3

// Get multi value length of an json array
mv.length('["elem01", "elem02"]') // -> 2

mv.contains

Returns true if the supplied multi value contains the supplied expected value, possibly ignoring the case (if values are strings).

Note: This function works exactly like mv.containsAny but with support for only one expected value.

Syntax

mv.contains(value, expected[, ignoreCase])

Arguments

Example(s)

mv.contains(['elem01', 'elem02', 'elem03'], 'elem02') // true
mv.contains(['elem01', 'elem02', 'elem03'], 'elem04') // false
mv.contains(['elem01', 'elem02', 'elem03'], 'ELEM02', true) // true

mv.contains([7, 99, 845], 'unknown') // false
mv.contains([7, 99, 845], 7) // true

mv.containsAny

Returns true if the supplied multi value contains at least one of the supplied expected values, possibly ignoring the case (if values are strings).

Syntax

mv.containsAny(value, expected[, expected, ...][, ignoreCase])

Arguments

Example(s)

mv.containsAny(['elem01', 'elem02', 'elem03'], 'elem02') // true
mv.containsAny(['elem01', 'elem02', 'elem03'], 'elem04') // false
mv.containsAny(['elem01', 'elem02', 'elem03'], 'elem04', 'elem02') // true

mv.containsAll

Returns true if the supplied multi value contains all of the supplied expected values, possibly ignoring the case (if values are strings).

Syntax

mv.containsAll(value, expected[, expected, ...][, ignoreCase])

Arguments

Example(s)

mv.containsAll(['elem01', 'elem02', 'elem03'], 'elem02') // true
mv.containsAll(['elem01', 'elem02', 'elem03'], 'elem04') // false
mv.containsAll(['elem01', 'elem02', 'elem03'], 'elem04', 'elem02') // false
mv.containsAll(['elem01', 'elem02', 'elem03'], 'elem01', 'elem02') // true

mv.matchAny

Returns true if at least one value in the supplied multi value matches one or more of the supplied regex's.

Regex may be supplied as strings, regex-literals or RegExp objects.

Note: Case-insensitivity is controlled by regex flag ('i').

Syntax

mv.matchAny(value, regex [,regex, ...])

Arguments

Example(s)

mv.matchAny(['elem01', 'elem02', 'elem03'], 'elem02', 'elem04') // true
mv.matchAny(['elem01', 'elem02', 'elem03'], /elem02/, /elem04/) // true
mv.matchAny(['elem01', 'elem02', 'elem03'], 'ELEM02') // false
mv.matchAny(['elem01', 'elem02', 'elem03'], /ELEM02/i) // true
mv.matchAny(['elem01', 'elem02', 'elem03'], /^elem[0-9]{,2}$/) // true

mv.equals

Returns true if the supplied multi values has exactly same content.

Syntax

mv.equals(mv1, mv2)

Arguments

Example(s)

mv.equals(['elem01'], ['elem01']) // true
mv.equals(['elem01'], ['elem02']) // false

mv.equals(['elem01', 'elem02'], ['elem01', 'elem02']) // true

mv.equals(['elem01', 'elem02'], ['elem01']) // false
mv.equals(['elem01', 'elem02'], ['elem02', 'elem01']) // false

mv.isEmpty

Returns true if the supplied multi value is not null/undefined and is empty.

Syntax

mv.isEmpty(value)

Arguments

Example(s)

mv.isEmpty([]) // true

mv.isEmpty(['elem01']) // false
mv.isEmpty(null) // false

mv.isNotEmpty

Returns true if the supplied multi value is not null/undefined and is not empty (has one or more elements).

Syntax

mv.isNotEmpty(value)

Arguments

Example(s)

mv.isNotEmpty(['elem01']) // true

mv.isNotEmpty([]) // false
mv.isNotEmpty(null) // false

mv.isNullOrEmpty

Returns true if the supplied multi value is null/undefined or is empty.

Syntax

mv.isNullOrEmpty(value)

Arguments

Example(s)

mv.isNullOrEmpty([]) // true
mv.isNullOrEmpty(null) // true

mv.isNullOrEmpty(['elem01']) // false

mv.isNotNullOrEmpty

Returns true if the supplied multi value is not null/undefined and is not empty (has one or more element).

Syntax

mv.isNotNullOrEmpty(value)

Arguments

Example(s)

mv.isNotNullOrEmpty(['elem01']) // true

mv.isNotNullOrEmpty(null) // false
mv.isNotNullOrEmpty([]) // false

Extension for asserting IPv4 addresses

isInSubnet

Returns true is the supplied IP belongs to the supplied subnet in CIDR notation.

Use this function to assert that a client belongs to a specific network.

IP-addresses should be octets in dotted-string format: '192.168.30.5'

Subnets are specified using CIDR notation containing an ip and the length of the subnet mask: '10.1.1.0/24'

Syntax

ipv4.isInSubnet(ip, subnet)

Arguments

Example