Documentation

Encoding & Crypto

Encoding & Crypto¶

Dynamic Values
Encoding & Crypto

For general information about dynamic values and instructions on how to insert them in Paw see the introduction to dynamic values.

Encoding, decoding and cryptographic Dynamic Values.

URL Encoding

URL Encoding¶

A Percent-encoding converter conforming to RFC3986.

com.luckymarmot.URLEncodingDynamicValue

Argument: input: DynamicString: None
Text input to be encoded/decoded.

Argument: charset: string: ``utf-8``

Charset to be used.

utf-8

Argument: mode: number: ``0`` (Encode)

Operation mode (0: Encode, 1: Decode).

0 (Encode)

function evaluate(context){
    var dv = new DynamicValue('com.luckymarmot.URLEncodingDynamicValue', {
        'input': 'Something to be URL-encoded'
    });
    return dv.getEvaluatedString();
};

Base64 Encoding

Base64 Encoding¶

A Base64 encoder/decoder conforming to RFC4648.

com.luckymarmot.Base64EncodingDynamicValue

Argument: input: DynamicString: None
Text input to be encoded/decoded.

Argument: mode: number: ``0`` (Encode)

Operation mode (0: Encode, 1: Decode).

0 (Encode)

Argument: lineBreakMode: number: ``0`` (No line breaks)

Line break mode (0: No line breaks, 1: Line break after 64 characters, 2: Line break after 76 characters).

0 (No line breaks)

Argument: newlinesMode: number: ``0`` (CR+LF)

New lines mode (0: CR+LF, 1: CR, 2: LF).

0 (CR+LF)

function evaluate(context){
    var dv = new DynamicValue('com.luckymarmot.Base64EncodingDynamicValue', {
        'input': 'SGVsbG8gV29ybGQh', /* Base64 encoded string */
                        'mode': 1 /* Decode */
    });
    return dv.getEvaluatedString();
};

Hash

Hash¶

A Dynamic Value providing several Cryptographic Hash Function.

com.luckymarmot.HashDynamicValue

Argument: input: DynamicString: None
Text input to be hashed.

Argument: hashType: number: ``3`` (SHA1)

Hash function (0: MD2, 1: MD4, 2: MD5, 3: SHA1, 4: SHA224, 5: SHA256, 6: SHA384, 7: SHA512).

3 (SHA1)

Argument: encoding: number: ``0`` (Hexadecimal)

Encoding (0: Hexadecimal, 1: Base64).

0 (Hexadecimal)

Argument: uppercase: bool: ``false``

Whether text output should be in uppercase.

false

function evaluate(context){
    var dv = new DynamicValue('com.luckymarmot.HashDynamicValue', {
        'input': 'Hello World!',
                        'hashType': 2 /* MD5 */
    });
    return dv.getEvaluatedString();
};

HMAC Signature

HMAC Signature¶

A Dynamic Value providing HMAC keyed hash function (Message authentication code (MAC)).

com.luckymarmot.HMACDynamicValue

Argument: input: DynamicString: None
Text input to be hashed.

Argument: key: DynamicString: None
Secret cryptographic key to be used.

Argument: algorithm: number: ``0`` (MD5)

Cryptographic hash function to be used (0: MD5, 1: SHA1, 2: SHA224, 3: SHA256, 4: SHA384, 5: SHA512).

0 (MD5)

Argument: encoding: string: ``Base64``

Encoding (Base64, Hexadecimal)

Base64

Argument: uppercase: bool: ``false``

Whether text output should be in uppercase.

false

function evaluate(context){
    var dv = new DynamicValue('com.luckymarmot.HMACDynamicValue', {
        'input': 'Hello World!',
        'key': 'supersecretkeynobodyknows',
                        'algorithm': 1 /* SHA1 */
    });
    return dv.getEvaluatedString();
};