function

hmac . string . sncode

VERSION5.106 Compute HMAC

HMAC(1e)

NAME

hmac - Compute HMAC in base64 with different algorythms

SYNOPSIS

hmac(key:string, text:string[, algo: integer])

DESCRIPTION

This function compuite HMAC in BASE64.

From Wikipedia:

In cryptography, an HMAC (sometimes disabbreviated as either keyed-hash message authentication code or hash-based message authentication code) is a specific type of message authentication code (MAC) involving a cryptographic hash function and a secret cryptographic key. It may be used to simultaneously verify both the data integrity and the authentication of a message, as with any MAC. Any cryptographic hash function, such as MD5 or SHA-1, may be used in the calculation of an HMAC; the resulting MAC algorithm is termed HMAC-X, where X is the hash function used (e.g. HMAC-MD5 or HMAC-SHA1). The cryptographic strength of the HMAC depends upon the cryptographic strength of the underlying hash function, the size of its hash output, and the size and quality of the key.

PARAMETERS

text
The input strings.
 
key
The value of the key
algo
The algorithm to use. By default, it is set to sha256. The following definition for the algo exist in extenso.sn:
 

%define HMAC_SHA1                   1;

%define HMAC_SHA224                 2;

%define HMAC_SHA256                 0;

%define HMAC_SHA384                 3;

%define HMAC_SHA512                 4

RETURN

Returns the hmac value in base64

EXAMPLES

        hmac(key:"this is a key",data:"this is a test");  return N2QlRcskbAzqng/Zm5k3z6pkDTBqa8q0Zsx8cPPI1dA=
        hmac(algo:0,key:"this is a key",data:"this is a test"); return N2QlRcskbAzqng/Zm5k3z6pkDTBqa8q0Zsx8cPPI1dA=
        hmac(algo:1,key:"this is a key",data:"this is a test"); return FWZky3vay5I0/GKafy/FmJxrvYw= 
        hmac(algo:2,key:"this is a key",data:"this is a test"); return SNDYnrmTQwJtpdzk76+FeLvQXnyYk72Vjo++lA== 
        hmac(algo:3,key:"this is a key",data:"this is a test"); return R8gwP7XxamCLOJuWygRCMxeTAxcHIS/h6HXqu8N0gs4he+fHKU9pamZKnMmXGuLD 
        hmac(algo:4,key:"this is a key",data:"this is a test"); return dR++AXStnCcqRCbLixSVEt/FXP1HtlALj/xHtbVnVFaAshzO0kvjcGcq219wHLxSnzXU+9AMQ06rDopHURcIDQ==
   

AUTHOR

Written by Pierre Laplante

Other functions in String

addslashes

Quote string with slashes.

 base64_​decode

Decodes data with MIME base64

 base64_​encode

Encodes data with MIME base64

 bin2hex

Converts binary data into hexadecimal representation

 cgidata

parse cgidata

 chr

Return a specific character

 chunk_​split

Split a string into smaller chunks.

 Count_​chars

Return information about characters used in a string.

 crc32

Calculates the crc32 polynomial of a string.

 dq

This function is used to use any characters as quotes in str ...

esc

This function is used to apply a filter to a string.

 explode

Split a string by string

 extention

Return the length of an expression.

 find_​in_​set

This function is used to check is a value is set within a li ...

getnbre

This function returns the number of match regular expression

 getoffset

This function returns the position of the last match regular ...

getre

This function return the value of a named parameter in a reg ...

hash

Calculate the hash of a string.

 hex2bin

Decodes a hexadecimally encoded binary string.

 html2text

Convert html text to plain text.

 htmlentities

Convert all applicable characters to HTML entities.

 htmlspecialchars

Convert special characters to HTML entities.

 htmlspecialchars_​decode

Convert HTML entities to special characters

 html_​entity_​decode

Convert all HTML entities to special characters

 implode

Join array elements with a string.

 isalnum

This function is used to verify that the argument string con ...

isalpha

Checks for an alphabetic character.

 isascii

Checks whether c is a 7-bit unsigned char value that fits in ...

isblank

Test for whitespace wide character.

 iscntrl

Checks for an control character.

 isdigit

Checks for a digit (0 through 9).

 isfloat

Checks if the argument is a float number.

 isgraph

Checks whether c is a character with graphical representatio ...

isinteger

Checks for a digit (0 through 9) that may be preceed by + or ...

islower

Checks for a lower-case character.

 isprint

Checks for any printable character including space.

 ispunct

Checks for any printable character which is not a space or a ...

isset

This function is used to check if a value is contained in a ...

isspace

Checks whether c is a white-space character.

 isupper

Checks for a upper-case character.

 iswalnum

This function is used to verify that the argument string con ...

iswalpha

Checks for an alphabetic character.

 iswblank

Test for whitespace wide character.

 iswcntrl

Checks for an control character.

 iswdigit

Checks for a digit (0 through 9).

 iswgraph

Checks whether c is a character with graphical representatio ...

iswlower

Checks for a lower-case character.

 iswprint

Checks whether c is a character with graphical representatio ...

iswpunct

Checks for any printable character which is not a space or a ...

iswspace

Checks whether c is a white-space character.

 iswupper

Checks for a upper-case character.
iswxdigit

Checks for a hexadecimal digits, i.e. one of 0 1 2 3 4 5 6 7 ...

isxdigit

Checks for a hexadecimal digits, i.e. one of 0 1 2 3 4 5 6 7 ...

lc

This function returns the lowercase value of a string.

 lcfirst

Returns lc value of a string’s first character.

 length

Returns the length of an expression

 levenshtein

Return the distance between 2 strings.

 ltrim

Eliminates whitespace from the beginning of a string.

 money_​format

Formats a number as a currency string.

 nl2br

Inserts HTML line breaks before all newlines in a string

 number_​format

Formats a number as a regional number string

 ord

Return Unicode value of character.

 parse

Parse strings.

 parse_​query_​string

This function is used to parse a query string.

 print

Output a string.

 printf

Print formatted text.

 quotemeta

Quote meta characters.

 resub

Perform a regular expression substitute.

 rindex

Locate character in string (last occurence).

 rtrim

Strip whitespace (or other characters) from the end of a str ...

savecsv

Stores array to a file.

 savexls

Export data to xls (Excel format)

 setlocale

Strip whitespace (or other characters) from the end of a str ...

split

This function is used to split a string.

 splitre

This function is used to split a string with a regular expre ...

strcasecmp

Case-insensitive string comparison.

 strcspn

Find length of initial segment not matching mask.

 strinatcmp

Case insensitive string comparisons using a natural order al ...

stringnify

Take an expression and return a string.

 stripos

Find the position of the first occurrence of a case-insensit ...

stripslashes

Un-quotes a quoted string

 strip_​tags

Strip HTML and extenso tags from a string.

 strnatcmp

String comparisons using a natural order algorithm.

 strncasecmp

Case-insensitive string comparison of the first n characters ...

strncmp

Comparison of the first n characters.

 strpos

Find the position of the first occurrence of a substring in ...

strrev

Reverse a string

 strripos

Find the position of the last occurrence of a case-insensiti ...

strrpos

Find the position of the last occurrence of a substring in a ...

strsub

return a substring from the original string.

 strtr

Translate characters or replace substrings.

 strtr_​ctx

Translate substrings.

 strtr_​list

Translate substrings.

 str_​getcsv

Parse a CSV string into an array.

 str_​ireplace

Replace all occurrences of the search string with the replac ...

str_​pad

Pad a string to a certain length with another string.

 str_​repeat

Repeat a string

 str_​replace

Replace all occurrences of the search string with the replac ...

str_​shuffle

Randomly shuffles a string

 str_​split

Convert a string to an array.