Goto main content

hmac

Compute HMAC

HMAC

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==

SEE ALSO

{{ include("includes/strings.sn") }}

AUTHOR

Written by Pierre Laplante, <laplante@sednove.com>

MODIFICATIONS

1.0 2018-05-30 laplante@sednove.com

Edit

Other topics in sncode,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 string
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 list with a delimiter between each element.
getnbre

This function returns the number of match regular expression
getoffset

This function returns the position of the last match regular expression
getre

This function return the value of a named parameter in a regular expression.
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 contain only alphabetic and digit character.
isalpha

Checks for an alphabetic character.
isascii

Checks whether c is a 7-bit unsigned char value that fits into the ASCII character set.
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 representation.
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 an alphanumeric character.
isset

This function is used to check if a value is contained in a list with a delimiter between each element.
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 contain only alphabetic and digit character.
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 representation.
iswlower

Checks for a lower-case character.
iswprint

Checks whether c is a character with graphical representation.
iswpunct

Checks for any printable character which is not a space or an alphanumeric character.
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 8 9 a b c d e f A B C D E F.
isxdigit

Checks for a hexadecimal digits, i.e. one of 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F.
lc

This function returns the lowercase value of a string.
lcfirst

Returns lc value of the 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 string.
savecsv

Stores array to a file.
savexls

Export data to xls (Excel format)
setlocale

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

This function is used to split a string.
splitre

This function is used to split a string with a regular expression.
strcasecmp

Case-insensitive string comparison.
strcspn

Find length of initial segment not matching mask.
strinatcmp

Case insensitive string comparisons using a natural order algorithm.
string

Functions for string manipulation
stringnify

Take an expression and return a string.
stripos

Find the position of the first occurrence of a case-insensitive substring in a string.
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 a string.
strrev

Reverse a string
strripos

Find the position of the last occurrence of a case-insensitive substring in a string.
strrpos

Find the position of the last occurrence of a substring in a string.
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 replacement string (case insensitive).
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 replacement string.
str_shuffle

Randomly shuffles a string
str_split

Convert a string to an array.
substr

Return part of a string.
trim

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

Strip whitespace (or other characters) from the beginning and end of a string.
type

This function return the type of a variable.
uc

This function return the uppercase value of a string.
ucfirst

Make a string's first character uppercase.
ucwords

Uppercase the first character of each word in a string.
unstringnify

Take a string and return an expression.
uriparse

Parse an uri and return its components.
urldecode

Decode a string.
urlencode

Encode a string.
uuid

Create a new unique UUID value
uuid_time

Return the time when a uuid was created.
wordwrap

Wraps a string to a given number of characters.
wstrsub

Returns a substring from the original string.

© 2024 extenso Inc. All rights reserved.