cc/examples/aead/aead_cli_test.sh

#!/bin/bash
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
################################################################################

set -euo pipefail

#############################################################################
# Tests for Tink CC AEAD.
#############################################################################

: "${TEST_TMPDIR:=$(mktemp -d)}"

readonly CLI="$1"
readonly KEYSET_FILE="$2"
readonly DATA_FILE="${TEST_TMPDIR}/example_data.txt"
readonly TEST_NAME="TinkExamplesCcAeadTest"

echo "This is some plaintext to be encrypted." > "${DATA_FILE}"

#######################################
# A helper function for getting the return code of a command that may fail.
# Temporarily disables error safety and stores return value in TEST_STATUS.
#
# Globals:
#   TEST_STATUS
# Arguments:
#   Command to execute.
#######################################
test_command() {
  set +e
  "$@"
  TEST_STATUS=$?
  set -e
}

#######################################
# Asserts that the outcome of the latest test command is 0.
#
# If not, it terminates the test execution.
#
# Globals:
#   TEST_STATUS
#   TEST_NAME
#   TEST_CASE
#######################################
assert_command_succeeded() {
  if (( TEST_STATUS != 0 )); then
    echo "[   FAILED ] ${TEST_NAME}.${TEST_CASE}"
    exit 1
  fi
}

#######################################
# Asserts that the outcome of the latest test command is not 0.
#
# If not, it terminates the test execution.
#
# Globals:
#   TEST_STATUS
#   TEST_NAME
#   TEST_CASE
#######################################
assert_command_failed() {
  if (( TEST_STATUS == 0 )); then
      echo "[   FAILED ] ${TEST_NAME}.${TEST_CASE}"
      exit 1
  fi
}

#######################################
# Starts a new test case; records the test case name to TEST_CASE.
#
# Globals:
#   TEST_NAME
#   TEST_CASE
# Arguments:
#   test_case: The name of the test case.
#######################################
start_test_case() {
  TEST_CASE="$1"
  echo "[ RUN      ] ${TEST_NAME}.${TEST_CASE}"
}

#######################################
# Ends a test case printing a success message.
#
# Globals:
#   TEST_NAME
#   TEST_CASE
#######################################
end_test_case() {
  echo "[       OK ] ${TEST_NAME}.${TEST_CASE}"
}

#############################################################################

start_test_case "encrypt"

# Run encryption.
test_command "${CLI}" \
  --mode encrypt \
  --keyset_filename "${KEYSET_FILE}" \
  --input_filename "${DATA_FILE}" \
  --output_filename "${DATA_FILE}.encrypted"
assert_command_succeeded

end_test_case

#############################################################################

start_test_case "decrypt"

# Run decryption.
test_command "${CLI}" \
  --mode decrypt \
  --keyset_filename "${KEYSET_FILE}" \
  --input_filename "${DATA_FILE}.encrypted" \
  --output_filename "${DATA_FILE}.decrypted"
assert_command_succeeded

test_command cmp -s "${DATA_FILE}" "${DATA_FILE}.decrypted"
assert_command_succeeded

end_test_case

#############################################################################

start_test_case "encrypt_decrypt_fails_with_modified_ciphertext"

# Run encryption
test_command "${CLI}" \
  --mode encrypt \
  --keyset_filename "${KEYSET_FILE}" \
  --input_filename "${DATA_FILE}" \
  --output_filename "${DATA_FILE}.encrypted"
assert_command_succeeded

# Modify ciphertext.
echo "modified" >> "${DATA_FILE}.encrypted"

# Run decryption.
test_command "${CLI}" \
  --mode decrypt \
  --keyset_filename "${KEYSET_FILE}" \
  --input_filename "${DATA_FILE}.encrypted" \
  --output_filename "${DATA_FILE}.decrypted"
assert_command_failed

end_test_case

#############################################################################

start_test_case "encrypt_decrypt_succeeds_with_associated_data"

# Run encryption.
ASSOCIATED_DATA="header information"
test_command "${CLI}" \
  --mode encrypt \
  --keyset_filename "${KEYSET_FILE}" \
  --input_filename "${DATA_FILE}" \
  --output_filename "${DATA_FILE}.encrypted" \
  --associated_data "${ASSOCIATED_DATA}"
assert_command_succeeded

# Run decryption.
test_command "${CLI}" \
  --mode decrypt \
  --keyset_filename "${KEYSET_FILE}" \
  --input_filename "${DATA_FILE}.encrypted" \
  --output_filename "${DATA_FILE}.decrypted" \
  --associated_data "${ASSOCIATED_DATA}"
assert_command_succeeded

cmp --silent "${DATA_FILE}" "${DATA_FILE}.decrypted"
assert_command_succeeded

end_test_case

#############################################################################

start_test_case "encrypt_decrypt_fails_with_modified_associated_data"

# Run encryption.
ASSOCIATED_DATA="header information"
test_command "${CLI}" \
  --mode encrypt \
  --keyset_filename "${KEYSET_FILE}" \
  --input_filename "${DATA_FILE}" \
  --output_filename "${DATA_FILE}.encrypted" \
  --associated_data "${ASSOCIATED_DATA}"
assert_command_succeeded

# Run decryption.
MODIFIED_ASSOCIATED_DATA="modified header information"
test_command "${CLI}" \
  --mode decrypt \
  --keyset_filename "${KEYSET_FILE}" \
  --input_filename "${DATA_FILE}.encrypted" \
  --output_filename "${DATA_FILE}.decrypted" \
  --associated_data "${MODIFIED_ASSOCIATED_DATA}"
assert_command_failed

end_test_case