Skip to content

zeropsio/zParser

BranchesTags

Repository files navigation

zParser - Zerops Parser

File parser with support for functions and string modifiers.

Description

Basic syntax

symbol description
<@ beginning of a function
( beginning of function parameters
) end of function parameters
, function parameter delimiter
< beginning of a string (without @)
> end of a string or a function
| modifier used at the end of a function or string
\ an escape character

Static string example

<this is a static string, with a modifier|upper>

Function example

<@generateRandomString(<20>)>

Function parameters

Functions support 2 types of parameters

  1. variables
    • text NOT enclosed in < and >
    • spaces at the beginning and end are trimmed
    • stored value under variable name is found and passed into the function (if no value is found, error is returned)
  2. static strings
    • text enclosed in < and >
    • spaces between < and > are NOT trimmed
    • if modifiers are used, or there are multiple nested strings in one parameter, they are processed first
    • equivalent of passing "my string" into function in some languages

⚠️ When using getVar function, parameter MUST be a variable (not enclosed in < and >)!

Example 
  # This generates a random string 20 characters long and stores it into variable named myRandomString
  <@generateRandomStringVar(<myRandomString>, <20>)>

  # This stores text `this is my custom string` into variable named myCustomString
  <@setVar(<myCustomString>, <this is my custom string>)>

  # Following function call will result in one of the following values
  # my static string
  # FpKWQv6LvVmPKb2CeXTN
  # this is my custom string
  <@pickRandom(<my static string>, myRandomString, myCustomString)>

  # This will return `THIS IS MY CUSTOM STRING`
  <@getVar(myCustomString)|upper>

Spaces

In static strings, all leading/trailing spaces between < and first occurrence of | or > (whichever occurs first) are preserved, contrary to functions, which have all trailing spaces (between parameters and modifiers) trimmed.

Example Static string:
input output comment
This is < my string | upper>. This is MY STRING . notice two spaces before MY and one before .
This is <my string | upper>. This is MY STRING . notice space before .
This is< my string | upper>. This is MY STRING . notice space before .
This is< my string| upper>. This is MY STRING. no extra spaces
This is <my string| upper>. This is MY STRING. no extra spaces (preferred syntax)

Function calls:

input output
This is my <@pickRandom(<first>, <second>, <third>) | upper> string. This is my SECOND string.
This is my <@pickRandom(<first>,<second>,<third>) | upper> string. This is my SECOND string.
This is my <@pickRandom(<first>,<second>,<third>)| upper> string. This is my SECOND string.

Function calls must begin with <@ (no space between < and @), following syntax WILL NOT work

input output
This is < @generateRandomString(<10>) | upper>. This is @GENERATERANDOMSTRING(10) .
This is < @generateRandomString(<10>)| upper>. This is @GENERATERANDOMSTRING(10).

Modifiers

Modifiers work on function calls and on static strings.

Example

Input

  RAND_UPPER_STRING: "<@generateRandomString(<50>) | upper>"
  STATIC_UPPER_STRING: "<Static string that will be turned into upper case| upper>"

Output

  RAND_UPPER_STRING: "OWKFJZJIU74QRHRMXB8GERGCKNYUDQKT6ZUPYUFISPSTYCRRYO"
  STATIC_UPPER_STRING: "STATIC STRING THAT WILL BE TURNED INTO UPPER CASE"

Nesting

Function calls and strings with or without modifier may be nested even multiple layers deep.

Example

Input

  NESTED_FUNCTIONS: "<@generateRandomString(<@generateRandomInt(<10>, <50>)>)>"
  NESTED_STRINGS: "<My normal <And My NeStED| upper> strings>"
  NESTED_STRING_MODIFIERS: "<My normal <And My NeStED| upper> strings| sha256>"
  NESTED_STRING_IN_FUNCTION: "<@setVar(<name>, <normal string <THAT IS ALL LOWER CASE| lower> even though middle part was not>)>"
  YES_THIS_IS_EXCESSIVE: "<@setVar(<randomLengthString>, <@generateRandomString(<@generateRandomInt(<@generateRandomInt(<10>, <50>)>, <@generateRandomInt(<51>, <100>)>)>)>) | upper>"

Output

  RAND_UPPER_STRING: "Lzkg38r27rq8xY6Y6VHvbqJ"
  NESTED_STRINGS: "My normal AND MY NESTED strings"
  NESTED_STRING_MODIFIERS: "57193af2e03136a21a6a88aace7a5ec5260689665a46b4eca5074656ac67a949"
  NESTED_STRING_IN_FUNCTION: "normal string that is all lower case even though middle part was not"
  YES_THIS_IS_EXCESSIVE: "FRQKTECZCSUEOCG6AOWJIRPJ2IWD623QZYUNSIJVEQEQH8APCMKJDGHU4MIZKTFGGEED6MGXJADA"

Escaping

Characters can be escaped using backslash \. This also means it is mandatory to escape \ like so \\ for it to be printed out.

⚠️ One caveat is usage in languages like YAML. If used inside YAML's quoted strings, all backslashes \ MUST be escaped twice (\\\\ instead of \\).
This is needed so backslash is preserved through both zParser and YAML parsing (as both remove one \).

Example

Input

  ESCAPED_FUNCTIONS: "\<@generateRandomString(\<@generateRandomInt(\<10\>, \<50\>)\>)\>"
  ESCAPED_BACKSLASHES: "\< \<\\\\ \\\\\\\\ \\\\\< <\\\\> \\\\\> \\\\\\\\ \\\\\> \>"
  ESCAPE_TEST_WITH_ITEM: "\\\\<sTriNG \\\\ witH, mOdiFiers| title>\\\\"

Output

  ESCAPED_FUNCTIONS: "<@generateRandomString(<@generateRandomInt(<10>, <50>)>)>"
  ESCAPED_BACKSLASHES: "< <\\ \\\\ \\< \\ \\> \\\\ \\> >"
  ESCAPE_TEST_WITH_ITEM: "\\STriNG \\ WitH, MOdiFiers\\"

Double escaping example

  # Here is how following string will look like
  - "\< \<\\\\ \\\\\\\\ \\\\\< <\\\\> \\\\\> \\\\\\\\ \\\\\> \>"
  # - after our parsing
  - "< <\\ \\\\ \\< \\ \\> \\\\ \\> >"
  # - after additional yaml parsing
  - "< <\ \\ \< \ \> \\ \> >"

Usage

As a package

go get git.vsh-labs.cz/zerops/zparser
package main

import (
	"context"
	"log"
	"os"

	"github.com/zeropsio/zParser/v2/src/parser"
)

func main() {
	yml, err := os.Open("file.yml")
	if err != nil {
		log.Fatal(err)
	}

	p := parser.NewParser(yml, os.Stdout, 200)
	if err := p.Parse(context.TODO()); err != nil {
		log.Fatal(err)
	}
}

Error handling

Parse function returns standard error or a MetaError that contains error string and metadata in map[string][]string format

Standard metaData fields (always present):

keyName desc
functionCalls amount of function calls during parsing
functionCallsLimit max amount of function calls allowed during parsing
positionColumn column which was being parsed when error occurred
positionLine line at which the error occurred
positionNear last 2 characters that were being parsed when error occurred

Following fields are set only when error occurred during item parsing:

keyName desc
item name of the processed function or content of the processed string
itemParams if itemType is function, all parsed params will be in this field
itemType type of the processed item, one of: string, function
Example 
map[
functionCalls:[66]
functionCallsLimit:[200]
item:[mercuryInRetrograde]
itemParams:[mercury is in retrograde mercury is not in retrograde my third unexpected param]
itemType:[function]
positionColumn:[140]
positionLine:[92]
positionNear:[e>]
]

Json formatted

{
  "functionCalls": [
    "66"
  ],
  "functionCallsLimit": [
    "200"
  ],
  "item": [
    "mercuryInRetrograde"
  ],
  "itemParams": [
    "mercury is in retrograde",
    "mercury is not in retrograde",
    "my third unexpected param"
  ],
  "itemType": [
    "function"
  ],
  "positionColumn": [
    "140"
  ],
  "positionLine": [
    "92"
  ],
  "positionNear": [
    "e>"
  ]
}

As a binary

# output to stdOut
./bin/yamlParser-linux-amd64 ./example.yml

# output to file
./bin/yamlParser-linux-amd64 ./example.yml -f ./example.parsed.yml

Error handling

When error occurs, binary returns a formatted error to the output

Example 
  #...
  #...
  MERCURY_RETROGRADE: "<@mercuryInRetrograde(<mercury is in retrograde>, <mercury is not in retrograde>, <my third unexpected param>) | title>"
  #...
  #...
error: invalid parameter count, 2 expected 3 provided
functionCalls: 66
functionCallsLimit: 200
item: mercuryInRetrograde
itemParams: mercury is in retrograde
            mercury is not in retrograde
            my third unexpected param
itemType: function
positionColumn: 140
positionLine: 97
positionNear: e>

Supported functions

name description example
generateRandomString generates random string in requested length <@generateRandomString(<50>)>
generateRandomBytes generates requested amount of cryptographically random bytes <@generateRandomBytes(<50>)>
generateRandomInt generates random integer in range [min, max] <@generateRandomInt(<-999>, <999>)>
pickRandom selects one of the provided parameters at random <@pickRandom(<one>, <two>, <three>, <four>)>
generateRandomStringVar generates random string and stores it for later use <@generateRandomStringVar(<myName>, <50>)>
setVar stores provided content for later use <@setVar(<myName>, <my string content>)>
getVar returns content of a stored variable <@getVar(myName)>
getDateTime returns current date and time in specified format and a timezone <@getDatetime(<DD.MM.YYYY HH:mm:ss>, <GMT>)>
generateJWT Generates JWT signed by HS256 algorithm using provided secret and payload. <@generateJWT(<mySecretString>, <{"role":"test","exp":1798761600}>)>
generateED25519Key generates Public and Private ED25519 key pairs and stores them for later use <@generateED25519Key(<myEd25519Key>)>
generateRSA2048Key generates Public and Private RSA 2048bit key pairs and stores them for later use <@generateRSA2048Key(<myRSA2048Key>)>
generateRSA4096Key generates Public and Private RSA 4096bit key pairs and stores them for later use <@generateRSA4096Key(<myRSA4096Key>)>
mercuryInRetrograde returns first parameter if Mercury IS in retrograde or second if it is not <@mercuryInRetrograde(<Yes>, <No>)>

generateRandomString(length)

Generates random string, comprised of [a-zA-Z0-9_-.] character set, in requested length

Details

Info

It is preferred to use generateRandomBytes with toString modifier: <@generateRandomBytes(length) | toString>.

Parameters

name type description
length int required string length (max. allowed value 1024)

Example

input output
<@generateRandomString(<20>)> bc84df942e8290438c21
<@generateRandomString(<10>)> 94a2f484de

generateRandomBytes(length)

Generates requested amount of cryptographically random bytes

Details

Parameters

name type description
length int required byte amount (max. allowed value 1024)

Example

input output
<@generateRandomBytes(<20>)> �m�r�Fe�Gx�9������
<@generateRandomString(<10>)> v�A��b�A

generateRandomInt(min, max)

Generates random int in range [min, max]

Details

Parameters

name type description
min int minimum number (inclusive)
max int maximum number (inclusive)

Example

input output
<@generateRandomInt(<-999>, <999>)> -155
<@generateRandomInt(<0>, <999999>)> 6659

pickRandom(...param)

Selects one of the provided parameters at random

Details

Parameters

name type description
...param string multiple parameters to be selected from

Example

input output
<@pickRandom(<one>, <two>, <three>, <four>)> three
<@pickRandom(<one>, <two>, <three>, <four>)> one

generateRandomStringVar(name, length)

Generates random string and stores it for later use (using getVar) under provided name. String is also returned as the output of the function call.

Any content that already existed under provided name is overwritten.

Details

Parameters

name type description
name string name under which string may be retrieved later using getVar
length int required string length (max. allowed value 1024)

Example

input output
<@generateRandomStringVar(<my20CharString>, <30>)> pj72x83UBgccTYfZRj3ytbApYeivq2
<@generateRandomStringVar(<my15CharString>, <15>)> yhaKq7gyPoiVhwL
<@getVar(my15CharString)> yhaKq7gyPoiVhwL

setVar(name, content)

Stores provided content for later use under provided name. String is also returned as the output of the function call.

Any content that already existed under provided name is overwritten.

Details

Parameters

name type description
name string name under which string may be retrieved later using getVar
content string content to be stored

Example

input output
<@setVar(<myFirstString>, <content of my first string>)> content of my first string
<@setVar(<mySecondString>, <content of my second string>)> content of my second string
<@setVar(<mySecondString>, <updated content of my second string>)> updated content of my second string
<@getVar(mySecondString)> updated content of my second string

getVar(name)

Returns content stored under provided variable (parameter MUST NOT be enclosed in < and >). If variable is not found, error is returned.

Details

Parameters

name type description
name string name under which the content is stored

Example

input output
<@getVar(myExistingCustomString)> content of my existing custom string
<@getVar(nonExistingString)> parsing will fail with an error variable [nonExistingString] not found

getDateTime(format, [timezone])

Returns current date and time in specified format.

Details

Parameters

name type description
format string see supported tokens below
timezone string timezone in format UTC, GMT, Europe/Prague, Etc/GMT+2, America/Chicago (optional, if not provided, UTC is assumed)

Supported tokens

Type Token Output
Year YYYY 2000, 2001, 2002 … 2012, 2013
YY 00, 01, 02 … 12, 13
Month MMMM January, February, March …
MMM Jan, Feb, Mar …
MM 01, 02, 03 … 11, 12
M 1, 2, 3 … 11, 12
Day of Year DDDD 001, 002, 003 … 364, 365
Day of Month DD 01, 02, 03 … 30, 31
D 1, 2, 3 … 30, 31
Day of Week dddd Monday, Tuesday, Wednesday …
ddd Mon, Tue, Wed …
Hour HH 00, 01, 02 … 23, 24
hh 01, 02, 03 … 11, 12
h 1, 2, 3 … 11, 12
AM / PM A AM, PM
a am, pm
Minute mm 00, 01, 02 … 58, 59
m 0, 1, 2 … 58, 59
Second ss 00, 01, 02 … 58, 59
s 0, 1, 2 … 58, 59
Microsecond S 000000 … 999999
Timezone ZZZ Asia/Baku, Europe/Warsaw, GMT
zz -07:00, -06:00 … +06:00, +07:00, +08, Z
Z -0700, -0600 … +0600, +0700, +08, Z

Example

input output
<@getDatetime(<DD.MM.YYYY HH:mm:ss>)> 03.11.2022 12:32:35
<@getDatetime(<DD.MM.YYYY HH:mm:ss>, <Europe/Prague>)> 03.11.2022 13:32:35
<@getDatetime(<DD.MM.YYYY>)> 03.11.2022

generateJWT(tokenSecret, jsonPayload)

Generates JWT (JSON Web Token) signed by HS256 algorithm using provided secret and payload.

Payload MUST be a valid JSON value.

Default values for iss and iat are set to zerops and current timestamp respectively.

Details

Parameters

name type description
tokenSecret string secret used to sign your JWT
jsonPayload string payload part of the JWT in JSON format

Example

input output
<@generateJWT(<fixedSecretString>, <{"role":"test","exp":1798761600}>)> eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3OTg3NjE2MDAsImlhdCI6MTcyOTA2OTYzMiwiaXNzIjoiemVyb3BzIiwicm9sZSI6InRlc3QifQ.2ba5vp9irnTabfTR1Co8Hd2LY8JfdC473Bb5k7yR-zQ
<@generateJWT(<fixedSecretString>, <{}>)> eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3MjkwNjk4NTcsImlzcyI6Inplcm9wcyJ9.xPrqHDtGhK5c7WMJliguwBeKI29qzAoD7KXrtACbjio
<@generateJWT(<@generateRandomStringVar(<jwtSecretKey>, <32>)>, <{"role":"test","exp":1798761600}>)> eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3OTg3NjE2MDAsImlhdCI6MTcyOTA2OTYzMiwiaXNzIjoiemVyb3BzIiwicm9sZSI6InRlc3QifQ.ksbck_HQv44YXbqJk6lDrGFYTq3nmLydFIe0Xlejk5Q
<@generateJWT(<@getVar(jwtSecretKeyVar)>, <{"role":"test","exp":1798761600}>)> eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3OTg3NjE2MDAsImlhdCI6MTcyOTA2OTYzMiwiaXNzIjoiemVyb3BzIiwicm9sZSI6InRlc3QifQ.O0RaXzGFwj2t8P2kc4nU4PfuI43-dAuAl2d0T1uUlEE

generateED25519Key(name)

Generates Public and Private ED25519 key pairs and stores them for later use under name+version suffix.

⚠️ Function produces strings with newline characters and MUST be used with Literal scalar style in YAML. Same goes for retrieval of stored key parts except public ssh key which is in one line. See example.

Details

Parameters

name type description
name string name under which all key versions will be stored (with suffixes bellow)

Generated keys

suffix description example
Public public key version, also returned when the method is called <@getVar(keyNamePublic)>
PublicSsh ssh formatted version used for authorized keys file <@getVar(keyNamePublicSsh)>
Private private key version in standard format (not usable for OpenSSH) <@getVar(keyNamePrivate)>
PrivateSsh private key version in Open SSH format <@getVar(keyNamePrivateSsh)>

Example

Input

  MY_PUBLIC_KEY: |
    <@generateED25519Key(<keyName>)>

  MY_PUBLIC_SSH_KEY: "<@getVar(keyNamePublicSsh)>"

  MY_PRIVATE_KEY: |
    <@getVar(keyNamePrivate)>

  MY_PRIVATE_SSH_KEY: |
    <@getVar(keyNamePrivateSsh)>

Output

  MY_PUBLIC_KEY: |
    -----BEGIN PUBLIC KEY-----
    MCowBQYDK2VwAyEA+1xKm4nA/ATJrQm9xX2fZj5PLxyApZURTDmDm5DQ4e0=
    -----END PUBLIC KEY-----

  MY_PUBLIC_SSH_KEY: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPtcSpuJwPwEya0JvcV9n2Y+Ty8cgKWVEUw5g5uQ0OHt"

  MY_PRIVATE_KEY: |
    -----BEGIN PRIVATE KEY-----
    MC4CAQAwBQYDK2VwBCIEIP9L2q781HpPRw0vgbiATskBeZNR4s5LXbGFKCm3V6iv
    -----END PRIVATE KEY-----

  MY_PRIVATE_SSH_KEY: |
    -----BEGIN OPENSSH PRIVATE KEY-----
    b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtz
    c2gtZWQyNTUxOQAAACD7XEqbicD8BMmtCb3FfZ9mPk8vHICllRFMOYObkNDh7QAA
    AIiaywRCmssEQgAAAAtzc2gtZWQyNTUxOQAAACD7XEqbicD8BMmtCb3FfZ9mPk8v
    HICllRFMOYObkNDh7QAAAED/S9qu/NR6T0cNL4G4gE7JAXmTUeLOS12xhSgpt1eo
    r/tcSpuJwPwEya0JvcV9n2Y+Ty8cgKWVEUw5g5uQ0OHtAAAAAAECAwQF
    -----END OPENSSH PRIVATE KEY-----

generateRSA2048Key(name)

Generates Public and Private RSA 2048bit key pairs and stores them for later use under name+version suffix.

⚠️ Function produces strings with newline characters and MUST be used with Literal scalar style in YAML. Same goes for retrieval of stored key parts except public ssh key which is in one line. See example.

For details see generateRSA4096Key(name)

generateRSA4096Key(name)

Generates Public and Private RSA 4096bit key pairs and stores them for later use under name+version suffix.

⚠️ Function produces strings with newline characters and MUST be used with Literal scalar style in YAML. Same goes for retrieval of stored key parts except public ssh key which is in one line. See example.

Details

Parameters

name type description
name string name under which all key versions will be stored (with suffixes bellow)

Generated keys

suffix description example
Public public key version, also returned when the method is called <@getVar(keyNamePublic)>
PublicSsh ssh formatted version used for authorized keys file <@getVar(keyNamePublicSsh)>
Private private key version in standard format <@getVar(keyNamePrivate)>

Example

Input

  MY_PUBLIC_KEY: |
    <@generateED25519Key(<keyName>)>

  MY_PUBLIC_SSH_KEY: "<@getVar(keyNamePublicSsh)>"

  MY_PRIVATE_KEY: |
    <@getVar(keyNamePrivate)>

Output (keys are truncated)

  MY_PUBLIC_KEY: |
    -----BEGIN PUBLIC KEY-----
    MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArtYSRy47pzn4891nihMi
    yf21Pd6qEHuJATbBiFBNm/QHJU7Swt5WQGfyvOiSrV7TgwvjUv9nh3vasgV7uStL
    IbTJ3ZIQE/YOfNYWMZgEmxZjEcoH+6FRWRRIx6kXPiNfIynQr67F3afudrJ6ioyQ
    YpOwnyxeBKq7qHCTPUC030gWXQBzLGE+sFxzyXZO/FgQb5EidARL3pqMpKEVRRiv
    sm/PjVaYa6BvqQWlBXivTb7zBuAYxrZ24WY7Socx73UnaOzXVpXuF+rWROu7f73w
    5hIVpQi/CY5JnnElWqKJsSfddaeX0tERl+n/TC4Lutr9plITg3wWWLg+QJPlz9Nz
    IQXzZlc+CfHL1oJ4+hTfhc4zKbi30wg3H+WwMJFYrv1gwL5z9v/cMSzEOqc1cufL
    OEG7wN/7OKuXO9HbIvzMX3Vmx6N/CWk9NSSjedOYfytkvOBRnkOfU4Nc+PcC4XIc
    2+JfjokzFe1rpLmYNjz6Am9576xQPqdcS9rK2cLcuw1nC8oFZ6vRmz1CrLdWyV8H
    ZYqdMV3Qc6DMzDFw8PyI9uirTgIoo5j6sgIAz+DY0S7+ZpdDwUWxBJaDhOrVSt6d
    rh2jSPSDsmCa/keSU0mNKg/oj5ZBAWaDPM3PoS0Vr40O5KWGULSzzW+DiXDvqf7V
    YZ/vPEeiaWP4L9rXZBDMA78CAwEAAQ==
    -----END PUBLIC KEY-----

  MY_PUBLIC_SSH_KEY: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCu1hJHLjunOfjz3WeKEyLJ/bU93qoQe4kBNsGIUE2b9AclTtLC3lZAZ/....../gv2tdkEMwDvw=="

  MY_PRIVATE_KEY: |
    -----BEGIN PRIVATE KEY-----
    MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQCu1hJHLjunOfjz
    3WeKEyLJ/bU93qoQe4kBNsGIUE2b9AclTtLC3lZAZ/K86JKtXtODC+NS/2eHe9qy
    BXu5K0shtMndkhAT9g581hYxmASbFmMRygf7oVFZFEjHqRc+I18jKdCvrsXdp+52
    snqKjJBik7CfLF4EqruocJM9QLTfSBZdAHMsYT6wXHPJdk78WBBvkSJ0BEvemoyk
    oRVFGK+yb8+NVphroG+pBaUFeK9NvvMG4BjGtnbhZjtKhzHvdSdo7NdWle4X6tZE
    67t/vfDmEhWlCL8JjkmecSVaoomxJ911p5fS0RGX6f9MLgu62v2mUhODfBZYuD5A
    k+XP03MhBfNmVz4J8cvWgnj6FN+FzjMpuLfTCDcf5bAwkViu/WDAvnP2/9wxLMQ6
    pzVy58s4QbvA3/s4q5c70dsi/MxfdWbHo38JaT01JKN505h/K2S84FGeQ59Tg1z4
    9wLhchzb4l+OiTMV7WukuZg2PPoCb3nvrFA+p1xL2srZwty7DWcLygVnq9GbPUKs
    t1bJXwdlip0xXdBzoMzMMXDw/Ij26KtOAiijmPqyAgDP4NjRLv5ml0PBRbEEloOE
    ......
    qGNempfsElD4BbAtxwko8NqeTANjBiE=
    -----END PRIVATE KEY-----

🥚

mercuryInRetrograde(contentIfYes, contentIfNo)

Returns first parameter if Mercury IS in retrograde or second if it is not.

Details

Parameters

name type description
contentIfYes string content to be returned if Mercury IS in retrograde
contentIfNo string content to be returned if Mercury IS NOT in retrograde

Example

input output
<@mercuryInRetrograde(<Yes>, <No>)> No

Supported modifiers

name description
sha256 hashes string using sha256 algorithm
sha512 hashes string using sha512 algorithm
bcrypt hashes string using bcrypt algorithm
argon2id hashes string using argon2id algorithm
toHex encodes provided string/bytes into hexadecimal
toString encodes provided string/bytes into string comprised of [a-zA-Z0-9_-.]
upper maps all unicode letters to their upper case
lower maps all unicode letters to their lower case
title maps all words to title case (first letter upper case, rest lower case)
noop does nothing - used in tests

Examples

input output
<@generateRandomStringVar(<myPassword>, <30>)> 7a14c8e74bc98a0d74253b1d1a4ef6
<@getVar(myPassword) | sha256> 081b91d6dff5036229a92e2442fb65d7c8124571d4e70a2ac4729aeb86957407
<@getVar(myPassword) | sha512> 89c05547de0aa4926512a958f95ab8bf4096ceec63ad5aad4266890bfa059e0cc98917c54276ba4cd61f1dde4c8efda948fc967885c9dd50558ed939722ca10c
<@getVar(myPassword) | bcrypt> $2a$10$CxKZX0yIxdc7ts6eI5aBu.g.heAsFcePdMDEpnlViTlo3vGc//PXe
<@getVar(myPassword) | argon2id> $argon2id$v=19$m=98304,t=1,p=3$uWBpmoUT3sfckXHyRF9hlg$8bGtNffuHxaRIgN99zCmJeGEYJF5BY2J9TwzqmezP28
<@generateRandomBytes(<20>) | toHex> 830e5694b3844f47f805c91956bc80ba728ca804
<@generateRandomBytes(<20>) | toString> Yf_mG3hj9BGWL3GisrPN
<sTATic StrINg wiTH a mOdifIER| upper> STATIC STRING WITH A MODIFIER
<sTATic StrINg wiTH a mOdifIER| lower> static string with a modifier
<sTATic StrINg wiTH a mOdifIER| title> Static String With A Modifier
<sTATic StrINg wiTH a mOdifIER| noop> sTATic StrINg wiTH a mOdifIER

Bcrypt configuration

  • cost: 11

Argon2id configuration

  • memory: 64MiB
  • iterations: 4
  • parallelism: 4
  • saltLen: 16B
  • keyLength: 32B

About

Zerops file parser with support for functions and string modifiers.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

3 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 10

v2.1.2 Latest
Oct 18, 2024
+ 9 releases

Packages

No packages published

Languages