6
6
[ ![ Build Status] ( https://img.shields.io/github/workflow/status/tsmx/object-hmac/git-ci-build )] ( https://img.shields.io/github/workflow/status/tsmx/object-hmac/git-ci-build )
7
7
[ ![ Coverage Status] ( https://coveralls.io/repos/github/tsmx/object-hmac/badge.svg?branch=master )] ( https://coveralls.io/github/tsmx/object-hmac?branch=master )
8
8
9
- > Create and verify HMAC's for JSON objects .
9
+ > Create and verify HMAC for a JSON object .
10
10
11
11
Easily create and verify [ HMAC's] ( https://en.wikipedia.org/wiki/HMAC ) for your JSON objects to ensure data integrity and authenticity.
12
12
@@ -18,28 +18,32 @@ Easily create and verify [HMAC's](https://en.wikipedia.org/wiki/HMAC) for your J
18
18
const objectHmac = require (' @tsmx/object-hmac' );
19
19
const key = ' HmacSecret-0815' ;
20
20
21
- let obj = {
21
+ let person = {
22
22
name: ' Max' ,
23
23
age: 32 ,
24
24
hobbies: [' sports' , ' travelling' ]
25
25
};
26
26
27
- objectHmac .createHmac (obj , key);
27
+ objectHmac .createHmac (person , key);
28
28
29
- // obj = {"name":"Max","age":32,"hobbies":["sports","travelling"],"__hmac":"37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f"}
29
+ // person = {"name":"Max","age":32,"hobbies":["sports","travelling"],"__hmac":"37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f"}
30
30
```
31
31
32
32
### Verify HMAC for a JSON object
33
33
34
34
``` js
35
- // obj = {"name":"Max","age":32,"hobbies":["sports","travelling"],"__hmac":"37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f"}
35
+ // person = {"name":"Max","age":32,"hobbies":["sports","travelling"],"__hmac":"37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f"}
36
36
37
37
const objectHmac = require (' @tsmx/object-hmac' );
38
38
const key = ' HmacSecret-0815' ;
39
39
40
- let verification = objectHmac .verifyHmac (obj, key);
41
-
40
+ let verification = objectHmac .verifyHmac (person, key);
42
41
// true
42
+
43
+ person .age = 33 ;
44
+
45
+ let verificationAfterChange = objectHmac .verifyHmac (person, key);
46
+ // false
43
47
```
44
48
45
49
### Only calculate HMAC for a JSON object
@@ -49,14 +53,13 @@ const objectHmac = require('@tsmx/object-hmac');
49
53
const key = ' HmacSecret-0815' ;
50
54
51
55
52
- let obj = {
56
+ let person = {
53
57
name: ' Max' ,
54
58
age: 32 ,
55
59
hobbies: [' sports' , ' travelling' ]
56
60
};
57
61
58
- let hmac = objectHmac .calculateHmac (obj, key);
59
-
62
+ let hmac = objectHmac .calculateHmac (person, key);
60
63
// 37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f
61
64
```
62
65
0 commit comments