PSA Developer APIs : Architecture Test Suite

Introduction

PSA Developer APIs

PSA defines security service APIs for application developers. Some of these services are Crypto Services, Attestation Services, and Secure Storage Services. For more information on API specification, refer the PSA Developer facing APIs specifications

Architecture Test Suite

The Architecture Test Suite is a set of examples of the invariant behaviours that are specified by the PSA Developer APIs Specifications. Use this suite to verify that these behaviours are implemented correctly in your system.

The Architecture Test Suite contains the tests that are self-checking, portable C-based tests with directed stimulus.

The tests are available as open source. The tests and the corresponding abstraction layers are available with an Apache v2.0 license allowing for external contribution.

For more information on Architecture Test Suite specification, refer the Validation Methodology document.

Release Update

Release Version - 0.5
Code Quality - Alpha. This indicates the suite is in development and it contains tests which have not been validated on any platform. Please use this opportunity to suggest enhancements and point out errors.
Current release contains Crypto tests that are written for the crypto service APIs defined in the crypto.h
This test suite is not a substitute for design verification.
To review the test logs, Arm licensees can contact Arm directly through their partner managers.

Tests Scenarios

The mapping of the rules in the specification to the test cases and the steps followed in the tests are mentioned in the Scenario document present in the docs/ folder.

Getting Started

Follow the instructions in the subsequent sections to get a copy of the source code on your local machine and build the tests.

Prerequisite

Please make sure you have all required software installed as explained in the software requirements.

Porting steps

Refer to the Porting Guide document for porting steps.

Build steps

To build test suite for a given platform, execute the following commands:

cd api-tests
./tools/scripts/setup.sh --target <platform_name> --cpu_arch <cpu_architecture_version> --suite <suite_name>  --build <build_dir> --include <include_path>

where:

<platform_name> is the same as the name of the target specific directory created in the platform/targets/ directory.
<cpu_architecture_version> is the Arm Architecture version name for which test binaries should be compiled. For example, Armv7M, Armv8M-Baseline and Armv8M-Mainline Architecture.
<suite_name> is the suite name and it is same as the suite name available in test_suites/ directory.
<include_path> is an additional directory to be included into compiler search path. Note - To run crypto tests, include path must point to path where "psa/crypto.h" is located in your build system.
<build_dir> is an output directory to keep build files.

Refer ./tools/scripts/setup.sh --help to know more about options.

To compile crypto tests for fvp_mps2_cm4_mbedos platform

cd api-tests
./tools/scripts/setup.sh --target fvp_mps2_cm4_mbedos --cpu_arch armv7m --suite crypto --build BUILD_CRYPTO --include <include_path>

Build output

Test suite build generates following binaries:

NSPE libraries:

<build_dir>/BUILD/val/val_nspe.a
<build_dir>/BUILD/platform/pal_nspe.a
<build_dir>/BUILD/dev_apis/<suite_name>/test_elf_combine.bin

Binaries integration into your platform

Integrate val_nspe.a and pal_nspe.a libraries with your non-secure OS so that these libraries get access to PSA Developer APIs. For example, Crypto tests would require to get access to PSA Crypto APIs. This will form a NSPE binary.
Load NSPE binary and test_elf_combine.bin to NS memory
Build your SPE binary and load into S memory

Test Suite Execution

The following steps describe the execution flow prior to the start of test execution:

The target platform must load above binaries into appropriate memory.
Upon booting firmware and non-secure OS, the SUT - boot software would give control to the test suite entry point- void val_entry(void); as an non-secure application entry point.
The tests are executed sequentially in a loop in the test_dispatcher function.

License

Arm PSA test suite is distributed under Apache v2.0 License.

Feedback, contributions, and support

For feedback, use the GitHub Issue Tracker that is associated with this repository.
For support, send an email to support-psa-arch-tests@arm.com with details.
Arm licensees can contact Arm directly through their partner managers.
Arm welcomes code contributions through GitHub pull requests.