xref: /aosp_15_r20/external/tink/python/examples/mac/README.md (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang# Python MAC example
2*e7b1675dSTing-Kang Chang
3*e7b1675dSTing-Kang ChangThis example shows how to check the integrity of data using Message
4*e7b1675dSTing-Kang ChangAuthentication Code (MAC).
5*e7b1675dSTing-Kang Chang
6*e7b1675dSTing-Kang ChangIt demonstrates the basic steps of using Tink, namely loading key material,
7*e7b1675dSTing-Kang Changobtaining a primitive, and using the primitive to do crypto.
8*e7b1675dSTing-Kang Chang
9*e7b1675dSTing-Kang ChangThe key material was generated with:
10*e7b1675dSTing-Kang Chang
11*e7b1675dSTing-Kang Chang```shell
12*e7b1675dSTing-Kang Chang$ tinkey create-keyset --key-template HMAC_SHA256_256BITTAG --out-format JSON \
13*e7b1675dSTing-Kang Chang    --out mac_test_keyset.json
14*e7b1675dSTing-Kang Chang```
15*e7b1675dSTing-Kang Chang
16*e7b1675dSTing-Kang Chang## Build and Run
17*e7b1675dSTing-Kang Chang
18*e7b1675dSTing-Kang Chang### Bazel
19*e7b1675dSTing-Kang Chang
20*e7b1675dSTing-Kang ChangBuild the examples:
21*e7b1675dSTing-Kang Chang
22*e7b1675dSTing-Kang Chang```shell
23*e7b1675dSTing-Kang Chang$ git clone https://github.com/google/tink
24*e7b1675dSTing-Kang Chang$ cd tink/python/examples
25*e7b1675dSTing-Kang Chang$ bazel build ...
26*e7b1675dSTing-Kang Chang```
27*e7b1675dSTing-Kang Chang
28*e7b1675dSTing-Kang ChangCompute a MAC:
29*e7b1675dSTing-Kang Chang
30*e7b1675dSTing-Kang Chang```shell
31*e7b1675dSTing-Kang Chang$ echo "some data" > data.txt
32*e7b1675dSTing-Kang Chang$ touch mac_file.txt
33*e7b1675dSTing-Kang Chang$ ./bazel-bin/mac/mac --mode compute \
34*e7b1675dSTing-Kang Chang    --keyset_path ./mac/mac_test_keyset.json \
35*e7b1675dSTing-Kang Chang    --data_path data.txt --mac_path mac_file.txt
36*e7b1675dSTing-Kang Chang```
37*e7b1675dSTing-Kang Chang
38*e7b1675dSTing-Kang ChangVerify a MAC:
39*e7b1675dSTing-Kang Chang
40*e7b1675dSTing-Kang Chang```shell
41*e7b1675dSTing-Kang Chang$ ./bazel-bin/mac/mac --mode verify \
42*e7b1675dSTing-Kang Chang    --keyset_path ./mac/mac_test_keyset.json \
43*e7b1675dSTing-Kang Chang    --data_path data.txt --mac_path mac_file.txt
44*e7b1675dSTing-Kang Chang```
45