xref: /aosp_15_r20/external/tink/python/examples/deterministic_aead/README.md (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang# Python Deterministic AEAD example
2*e7b1675dSTing-Kang Chang
3*e7b1675dSTing-Kang ChangThis example shows how to encrypt files with Tink using Deterministic
4*e7b1675dSTing-Kang ChangAuthenticated Encryption with Associated Data (Deterministic AEAD).
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 Tinkey:
10*e7b1675dSTing-Kang Chang
11*e7b1675dSTing-Kang Chang```shell
12*e7b1675dSTing-Kang Chang$ tinkey create-keyset --key-template AES256_SIV --out-format JSON \
13*e7b1675dSTing-Kang Chang    --out deterministic_aead_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 Chang```shell
21*e7b1675dSTing-Kang Chang$ git clone https://github.com/google/tink
22*e7b1675dSTing-Kang Chang$ cd tink/python/examples
23*e7b1675dSTing-Kang Chang$ bazel build ...
24*e7b1675dSTing-Kang Chang```
25*e7b1675dSTing-Kang Chang
26*e7b1675dSTing-Kang ChangYou can then encrypt a file
27*e7b1675dSTing-Kang Chang
28*e7b1675dSTing-Kang Chang```shell
29*e7b1675dSTing-Kang Chang$ echo "some data" > testdata.txt
30*e7b1675dSTing-Kang Chang$ ./bazel-bin/deterministic_aead/deterministic_aead --mode encrypt \
31*e7b1675dSTing-Kang Chang    --keyset_path deterministic_aead/deterministic_aead_test_keyset.json \
32*e7b1675dSTing-Kang Chang    --input_path testdata.txt --output_path testdata.txt.encrypted
33*e7b1675dSTing-Kang Chang```
34*e7b1675dSTing-Kang Chang
35*e7b1675dSTing-Kang Changor decrypt the file with
36*e7b1675dSTing-Kang Chang
37*e7b1675dSTing-Kang Chang```shell
38*e7b1675dSTing-Kang Chang$ ./bazel-bin/deterministic_aead/deterministic_aead --mode decrypt \
39*e7b1675dSTing-Kang Chang    --keyset_path deterministic_aead/deterministic_aead_test_keyset.json \
40*e7b1675dSTing-Kang Chang    --input_path testdata.txt.encrypted --output_path testdata.txt.decrypted
41*e7b1675dSTing-Kang Chang$ diff testdata.txt testdata.txt.decrypted
42*e7b1675dSTing-Kang Chang```
43