From 972e33585e666d14f89138a0b7598bd25103bcfa Mon Sep 17 00:00:00 2001 From: Andrew Thoelke Date: Tue, 30 Jun 2026 18:41:16 +0100 Subject: [PATCH] Rename PSA Certified API as PSA API Currently applied to * Tools and Github documents * Document titles and citations * Header-file preamble text * Introductory paragraphs & document histories Signed-off-by: Andrew Thoelke --- CONTRIBUTING.md | 12 ++- README.md | 91 ++++++++++--------- doc/attestation/README.md | 15 +-- doc/attestation/about/intro | 7 +- doc/attestation/about/references | 3 +- doc/attestation/about/releases | 5 +- doc/attestation/api/api.rst | 7 +- doc/attestation/appendix/history.rst | 3 +- doc/attestation/conf.py | 7 +- doc/crypto-driver/README.md | 4 +- doc/crypto-driver/about/intro | 5 +- doc/crypto-driver/about/references | 3 +- doc/crypto-driver/about/releases | 3 +- doc/crypto-driver/appendix/history.rst | 3 +- doc/crypto-driver/body/using-drivers.rst | 3 +- doc/crypto-driver/conf.py | 7 +- doc/crypto/README.md | 12 ++- doc/crypto/about/intro | 5 +- doc/crypto/about/references | 5 +- doc/crypto/api/keys/lifetimes.rst | 11 ++- doc/crypto/api/library/library.rst | 3 +- doc/crypto/api/library/status.rst | 5 +- doc/crypto/appendix/history.rst | 3 +- doc/crypto/conf.py | 7 +- doc/crypto/overview/conventions.rst | 3 +- doc/fwu/README.md | 12 ++- doc/fwu/about/intro | 5 +- doc/fwu/about/references | 3 +- doc/fwu/api/api.rst | 8 +- doc/fwu/appendix/change-history.rst | 5 +- doc/fwu/conf.py | 7 +- doc/fwu/overview/goals.rst | 3 +- doc/status-code/README.md | 13 +-- doc/status-code/about/intro | 13 +-- doc/status-code/about/releases | 3 +- doc/status-code/api/status-codes.rst | 29 +++--- doc/status-code/appendix/change-history.rst | 7 +- .../appendix/reference-headers.rst | 3 +- doc/status-code/conf.py | 7 +- doc/storage/README.md | 15 +-- doc/storage/about/intro | 5 +- doc/storage/about/references | 5 +- doc/storage/about/releases | 5 +- doc/storage/api/api.rst | 11 ++- doc/storage/appendix/history.rst | 3 +- doc/storage/conf.py | 7 +- doc/storage/overview/architecture.rst | 3 +- examples/README.md | 8 +- related-projects.md | 11 ++- tools/docs/psa-api-tool-notes.md | 8 +- tools/psa-api-conf.py | 3 +- .../templates/psa-api-2026/about-chapter.rst | 3 +- tools/templates/psa-api-2026/template-conf.py | 9 +- 53 files changed, 253 insertions(+), 193 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ca0988b..4e82b845 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,6 @@ @@ -7,11 +8,11 @@ SPDX-License-Identifier: CC-BY-SA-4.0 The main copy of this project is hosted on GitHub: https://github.com/globalplatform/psa-api. -Anyone may contribute to the PSA Certified API project. Contributions are licensed under the same license that is used for distibution, and must be made with a [Developer Certificate of Origin][DCO] (DCO) attestation as described below. See the [LICENSE][license] file for details of the license. +Anyone may contribute to the PSA API project. Contributions are licensed under the same license that is used for distibution, and must be made with a [Developer Certificate of Origin][DCO] (DCO) attestation as described below. See the [LICENSE][license] file for details of the license. -PSA Certified API discussion and development uses this GitHub repository. See the [Issues][issues] and [Pull requests][prs] for a full list of current discussions, or to start a new one. +PSA API discussion and development uses this GitHub repository. See the [Issues][issues] and [Pull requests][prs] for a full list of current discussions, or to start a new one. -Alternatively, you can find issues related to a particular API on the API-specific project boards. Follow the links from the [main page][spec-list]. +Issues and PRs are labeled with the relevant API specification. ## DCO Attestation @@ -50,3 +51,8 @@ d) I understand and agree that this project and the contribution [issues]: https://github.com/globalplatform/psa-api/issues [prs]: https://github.com/globalplatform/psa-api/pulls [spec-list]: https://github.com/globalplatform/psa-api#specifications + +---- + +*Copyright 2022 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/README.md b/README.md index e51e5cdc..f5ac7cf5 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,38 @@ -# PSA Certified API Specifications +# PSA API Specifications -This is the official place for the latest documents of the PSA Certified API. +This is the official place for the development the PSA API specifications. This GitHub repository contains: * Specification source files -* Reference copies of the PSA Certified API header files -* Examples of usage and implementation of the PSA Certified APIs +* Reference copies of the PSA API header files +* Examples of usage and implementation of the PSA APIs * Build tooling for rendering the specifications * Discussions of updates to the specifications * Proposed changes to the specifications -Officially released specification documents can be found in the associated [PSA Certified API website](https://arm-software.github.io/psa-api/). +Officially released specification documents can be found at the [PSA API specifications website][PSA API website]. + +Note: The PSA APIs have previously been referred to as the PSA Certified APIs. + +[PSA API website]: https://arm-software.github.io/psa-api/ ## Specifications -The following specifications are part of the PSA Certified API. +The following specifications are part of the PSA API. -Specification | Published | Document source | Reference headers | Dashboard --|-|-|-|- -Crypto API | [1.5.0][crypto-specs] | [doc/crypto/] | [headers/crypto/1.5/] | [Project board][crypto-dash] -Secure Storage API | [1.0.4][storage-specs] | [doc/storage/] | [headers/storage/1.0/] | [Project board][storage-dash] | -Attestation API | [2.0.0][attestation-specs] | [doc/attestation/] | [headers/attestation/2.0/] | [Project board][attestation-dash] | -Firmware Update API | [1.0.1][fwu-specs] | [doc/fwu/] | [headers/fwu/1.0/] | [Project board][fwu-dash] -Status code API | [1.0.5][status-specs] | [doc/status-code/] | [headers/status-code/1.0/] | [Project board][status-code-dash] | +Specification | Published | Document source | Reference headers +-|-|-|- +Crypto API | [1.5.0][crypto-specs] | [doc/crypto/] | [headers/crypto/1.5/] +Secure Storage API | [1.0.4][storage-specs] | [doc/storage/] | [headers/storage/1.0/] +Attestation API | [2.0.0][attestation-specs] | [doc/attestation/] | [headers/attestation/2.0/] +Firmware Update API | [1.0.1][fwu-specs] | [doc/fwu/] | [headers/fwu/1.0/] +Status code API | [1.0.5][status-specs] | [doc/status-code/] | [headers/status-code/1.0/] [crypto-specs]: https://arm-software.github.io/psa-api/crypto/ [storage-specs]: https://arm-software.github.io/psa-api/storage/ @@ -35,12 +40,6 @@ Status code API | [1.0.5][status-specs] | [doc/status-code/] | [headers/status- [fwu-specs]: https://arm-software.github.io/psa-api/fwu/ [status-specs]: https://arm-software.github.io/psa-api/status-code/ -[crypto-dash]: https://github.com/orgs/ARM-software/projects/5/views/3 -[storage-dash]: https://github.com/orgs/ARM-software/projects/5/views/4 -[attestation-dash]: https://github.com/orgs/ARM-software/projects/5/views/5 -[fwu-dash]: https://github.com/orgs/ARM-software/projects/5/views/6 -[status-code-dash]: https://github.com/orgs/ARM-software/projects/5/views/7 - [doc/crypto/]: doc/crypto [doc/storage/]: doc/storage [doc/attestation/]: doc/attestation @@ -57,32 +56,33 @@ Status code API | [1.0.5][status-specs] | [doc/status-code/] | [headers/status- Extension specifications introduce new functionality that is not yet stable enough for inclusion in the main specification. -API | Extension | Published | Document source | Reference headers | Dashboard --|-|-|-|-|- -Crypto API | PAKE | [*Integrated in 1.3.0*][crypto-specs] | *n/a* | *n/a* | *n/a* -Crypto API | PQC | [*Integrated in 1.5*][crypto-specs] | *n/a* | *n/a* | *n/a* +API | Extension | Published | Document source | Reference headers +-|-|-|-|- +Crypto API | PAKE | [*Integrated in 1.3.0*][crypto-specs] | *n/a* | *n/a* +Crypto API | PQC | [*Integrated in 1.5*][crypto-specs] | *n/a* | *n/a* ### In development The following specifications are being developed towards an initial 1.0 version: -Specification | Published | Document source | Reference headers | Dashboard --|-|-|-|- -Crypto Driver Interface | [1.0 Alpha-1][crypto-driver-specs] | [doc/crypto-driver/] | *n/a* | [Project board][crypto-driver-dash] +Specification | Published | Document source | Reference headers +-|-|-|- +Crypto Driver Interface | [1.0 Alpha-1][crypto-driver-specs] | [doc/crypto-driver/] | *n/a* [crypto-driver-specs]: https://arm-software.github.io/psa-api/crypto-driver/ -[crypto-driver-dash]: https://github.com/orgs/ARM-software/projects/5/views/8 [doc/crypto-driver/]: doc/crypto-driver ## Reference header files -Reference header files for each minor version of each API are provided in the [headers/](headers) folder. +Reference header files for each minor version of each API are provided in the [headers/] folder. + +[headers/]: headers ## Building the specifications -This repository includes the documentation build tooling in [tools/](tools). The top-level `Makefile` uses that local tool copy by default, so a normal build does not require a separate checkout of the build tools. +This repository includes the documentation build tooling in [tools/]. The top-level `Makefile` uses that local tool copy by default, so a normal build does not require a separate checkout of the build tools. -The core HTML build path requires Python, Sphinx, and `make`. PDF output also requires a LaTeX toolchain with `pdflatex`. Regenerating figures can require additional tools, depending on the figure source format, including Graphviz, `wavedrompy`, PlantUML, Java, and `rsvg-convert`. +The HTML build requires Python, Sphinx, and `make`. PDF output also requires a LaTeX toolchain with `pdflatex`. Regenerating figures can require additional tools, depending on the figure source format, including Graphviz, `wavedrompy`, PlantUML, Java, and `rsvg-convert`. Build one specification from the repository root with: @@ -102,24 +102,32 @@ make html make pdf ``` -Generated output is written under [build/](build). The build guide in [tools/docs/using-psa-api-tool.md](tools/docs/using-psa-api-tool.md) describes the available targets, dependencies, and validation flow. The editing reference in [tools/docs/psa-api-tool-notes.md](tools/docs/psa-api-tool-notes.md) describes the custom directives, roles, and source conventions used by the specifications. +Generated output is written under the untracked **build/** folder. The build guide in [tools/docs/using-psa-api-tool.md] describes the available targets, dependencies, and validation flow. The editing reference in [tools/docs/psa-api-tool-notes.md] describes the custom directives, roles, and source conventions used by the specifications. + +[tools/]: tools +[tools/docs/using-psa-api-tool.md]: tools/docs/using-psa-api-tool.md +[tools/docs/psa-api-tool-notes.md]: tools/docs/psa-api-tool-notes.md ## Test Suite -Test suites are available to validate compliance of API implementations against the specifications for Crypto, Attestation, and Secure Storage APIs, from: -[github.com/ARM-software/psa-arch-tests](https://github.com/ARM-software/psa-arch-tests) +Test suites are available to validate compliance of API implementations against the specifications for Crypto, Attestation, and Secure Storage APIs, from: [github.com/ARM-software/psa-arch-tests]. -Compliance badges can be obtained from [PSA Certified](https://www.psacertified.org/getting-certified/functional-api-certification/) to showcase compatible products. +Compliance badges can be obtained from [PSA Certified] to showcase compatible products. +[github.com/ARM-software/psa-arch-tests]: https://github.com/ARM-software/psa-arch-tests +[PSA Certified]: https://www.psacertified.org/getting-certified/functional-api-certification/ ## Example source code -Source code examples of both usage, and implementation, of the PSA Certified APIs are provided in the [examples/](/examples) folder. +Source code examples of both usage, and implementation, of the PSA APIs are provided in the [examples/] folder. + +[examples/]: examples ## Related Projects -Known projects that implement or use the PSA Certified APIs are listed in [related-projects](/related-projects.md). +Known projects that implement or use the PSA APIs are listed in [related-projects]. +[related-projects]: /related-projects.md ## License @@ -129,8 +137,6 @@ Text and illustrations in this project are licensed under Creative Commons [Attr **Grant of patent license**. Subject to the terms and conditions of this license (both the CC BY-SA 4.0 Public License and this Patent License), each Licensor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Licensed Material, where such license applies only to those patent claims licensable by such Licensor that are necessarily infringed by their contribution(s) alone or by combination of their contribution(s) with the Licensed Material to which such contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Licensed Material or a contribution incorporated within the Licensed Material constitutes direct or contributory patent infringement, then any licenses granted to You under this license for that Licensed Material shall terminate as of the date such litigation is filed. -The Arm trademarks featured here are registered trademarks or trademarks of Arm Limited (or its subsidiaries) in the US and/or elsewhere. All rights reserved. Please visit [arm.com/company/policies/trademarks][trademarks] for more information about Arm's trademarks. - ### About the license The language in the additional patent license is largely identical to that in section 3 of [Apache License, Version 2.0][APACHE-2.0] (Apache 2.0) with two exceptions: @@ -141,7 +147,6 @@ The language in the additional patent license is largely identical to that in se [CC-BY-SA-4.0]: https://creativecommons.org/licenses/by-sa/4.0 [APACHE-2.0]: https://www.apache.org/licenses/LICENSE-2.0 -[trademarks]: https://www.arm.com/company/policies/trademarks ### Source code @@ -153,7 +158,7 @@ See the License for the specific language governing permissions and limitations ## Feedback -If you have questions or comments on any of the PSA Certified API specifications, or suggestions for enhancements, please [raise a new issue][psa-api-issue]. +If you have questions or comments on any of the PSA API specifications, or suggestions for enhancements, please [raise a new issue][psa-api-issue]. Please indicate which specification the issue applies to. This can be done by: @@ -164,11 +169,13 @@ Please indicate which specification the issue applies to. This can be done by: ## Contributing -Anyone may contribute to the PSA Certified API. Discussion of changes and enhancement happens in this repository's [Issues][issues] and [Pull requests][pulls]. See [CONTRIBUTING](CONTRIBUTING.md) for details. +Anyone may contribute to the PSA APIs. Discussion of changes and enhancement happens in this repository's [Issues][issues] and [Pull requests][pulls]. See [CONTRIBUTING] for details. [issues]: https://github.com/globalplatform/psa-api/issues [pulls]: https://github.com/globalplatform/psa-api/pulls +[CONTRIBUTING]: CONTRIBUTING.md ---- -*Copyright 2022-2026 Arm Limited and/or its affiliates* +*Copyright 2022-2026 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/doc/attestation/README.md b/doc/attestation/README.md index 814109a9..e97cd536 100644 --- a/doc/attestation/README.md +++ b/doc/attestation/README.md @@ -1,19 +1,22 @@ -# PSA Certified Attestation API — specification sources +# PSA Attestation API — specification sources The Attestation API specification source files are organized as follows: Folder | Content -- | -- -Current directory | Configuration and front-matter -`overview` | Informative chapters 1-3 -`api` | API reference chapter 4 -`appendix` | Appendix chapters +Current directory | Configuration and table of contents +`about` | Front matter +`overview` | Informative chapters +`api` | API reference +`appendix` | Appendices ---- -*Copyright 2022, Arm Limited and/or its affiliates* +*Copyright 2022 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/doc/attestation/about/intro b/doc/attestation/about/intro index 6f553cb9..2132afbe 100644 --- a/doc/attestation/about/intro +++ b/doc/attestation/about/intro @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2020, 2022-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. introduction:: @@ -7,7 +8,7 @@ .. rubric:: About the |API| - The interface described in this document is a PSA Certified API, that provides a verifiable report of the state of the platform. The platform attestation service is provided by the :term:`Platform Root of Trust` and is described in :cite-title:`PSM`. + The interface described in this document is a PSA API, that provides a verifiable report of the state of the platform. The platform attestation service is provided by the :term:`Platform Root of Trust` and is described in :cite-title:`PSM`. The format of the attestation report that is produced by the |API| is specified in :rfc-title:`9783`. @@ -20,9 +21,9 @@ * A set of common use cases. See :secref:`use cases`. * The associated Application Programming Interface (API). See :secref:`api`. - The |API| can be used either to directly produce verifiable evidence about the platform state in the context of a challenge-response interaction, or as a way to bootstrap trust in other attestation schemes. The PSA Certified framework provides the generic security features allowing OEM and service providers to integrate various attestation schemes on top of the Platform Root of Trust. + The |API| can be used either to directly produce verifiable evidence about the platform state in the context of a challenge-response interaction, or as a way to bootstrap trust in other attestation schemes. The PSA framework provides the generic security features allowing OEM and service providers to integrate various attestation schemes on top of the Platform Root of Trust. - You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/attestation`, and find other PSA Certified APIs here at :url:`arm-software.github.io/psa-api`. + You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/attestation`, and find other PSA APIs here at :url:`arm-software.github.io/psa-api`. .. audience:: diff --git a/doc/attestation/about/references b/doc/attestation/about/references index ab4e8c02..d1d53925 100644 --- a/doc/attestation/about/references +++ b/doc/attestation/about/references @@ -1,8 +1,9 @@ .. SPDX-FileCopyrightText: Copyright 2018-2020, 2022-2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. reference:: PSA STAT - :title: PSA Certified Status code API + :title: PSA Status code API :kind: normative :doc_id: Arm IHI 0097 :url: arm-software.github.io/psa-api/status-code diff --git a/doc/attestation/about/releases b/doc/attestation/about/releases index ccf79af9..03cff0b4 100644 --- a/doc/attestation/about/releases +++ b/doc/attestation/about/releases @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2020, 2022-2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. Releases of this specification @@ -15,9 +16,9 @@ First stable release with 1.0 API finalized. - Uses the PSA Certified API common error status codes. + Uses the PSA API common error status codes. - Modified the API parameters to align with other PSA Certified APIs. + Modified the API parameters to align with other PSA APIs. Updated the claims and lifecycle to match the latest Platform Security Model. diff --git a/doc/attestation/api/api.rst b/doc/attestation/api/api.rst index 94a2101a..fd933017 100644 --- a/doc/attestation/api/api.rst +++ b/doc/attestation/api/api.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2020, 2022-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _api: @@ -14,7 +15,7 @@ API reference :system-include: stddef.h stdint.h /* This file is a reference template for implementation of the - * PSA Certified Attestation API v2.0 + * PSA Attestation API v2.0 */ The |API| defines a header file that is provided by the implementation. The header is :file:`psa/initial_attestation.h`. @@ -34,7 +35,7 @@ Pointers to input parameters may be in read-only memory. Output parameters must Status codes ------------ -The |API| uses the status code definitions that are shared with the other PSA Certified APIs. +The |API| uses the status code definitions that are shared with the other PSA APIs. The following elements are defined in :file:`psa/error.h` from :cite-title:`PSA STAT`: @@ -53,7 +54,7 @@ These definitions must be available to an application that includes the :file:`p .. admonition:: Implementation note - An implementation is permitted to define the status code interface elements within :file:`psa/initial_attestation.h`, or to define them via inclusion of a :file:`psa/error.h` header file that is shared with the implementation of other PSA Certified APIs. + An implementation is permitted to define the status code interface elements within :file:`psa/initial_attestation.h`, or to define them via inclusion of a :file:`psa/error.h` header file that is shared with the implementation of other PSA APIs. General definitions diff --git a/doc/attestation/appendix/history.rst b/doc/attestation/appendix/history.rst index 51b28c02..d5de527f 100644 --- a/doc/attestation/appendix/history.rst +++ b/doc/attestation/appendix/history.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2020, 2022-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _document-history: @@ -17,7 +18,7 @@ Document history * - TBD - *Draft GlobalPlatform publication revision* - * Migrated the document to the 2026 PSA Certified API template. + * Migrated the document to the 2026 PSA API template. * Changed the document front matter structure and publication styling, without changing the API. * - June 2019 diff --git a/doc/attestation/conf.py b/doc/attestation/conf.py index d038e2cd..3a03782c 100644 --- a/doc/attestation/conf.py +++ b/doc/attestation/conf.py @@ -1,7 +1,8 @@ # SPDX-FileCopyrightText: Copyright 2018-2020, 2022-2026 Arm Limited and/or its affiliates +# SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform # SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license -# PSA Certified API document configuration +# PSA API document configuration # # This is used to generate all of the sphinx configuration data and determine # the document file name etc. @@ -11,12 +12,10 @@ 'template': 'psa-api-2026', # Document title, MANDATORY - 'title': 'PSA Certified\nAttestation API', - 'author': 'Arm Limited', + 'title': 'PSA Attestation API', # Document copyright date, default to year of 'date' 'copyright_date': '2018-2020, 2022-2026', - 'copyright': 'Arm Limited and/or its affiliates', # Document identifier, marked as open issue if not provided 'doc_id': 'GPD_SPE_085', diff --git a/doc/crypto-driver/README.md b/doc/crypto-driver/README.md index aa6b7bcc..c3dcb2e5 100644 --- a/doc/crypto-driver/README.md +++ b/doc/crypto-driver/README.md @@ -1,5 +1,6 @@ @@ -17,4 +18,5 @@ Current directory | Configuration and table of contents ---- -*Copyright 2025, Arm Limited and/or its affiliates* +*Copyright 2025 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/doc/crypto-driver/about/intro b/doc/crypto-driver/about/intro index 1dff9b15..c00f6edb 100644 --- a/doc/crypto-driver/about/intro +++ b/doc/crypto-driver/about/intro @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2025-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. introduction:: @@ -7,7 +8,7 @@ .. rubric:: About the |API| - This document describes an interface for cryptoprocessor drivers within an implementation of the PSA Certified Crypto API. This interface complements :cite-title:`PSA CRYPT`, which describes the interface between a Crypto API implementation and an application. + This document describes an interface for cryptoprocessor drivers within an implementation of the PSA Crypto API. This interface complements :cite-title:`PSA CRYPT`, which describes the interface between a Crypto API implementation and an application. In the remainder of this document: @@ -38,4 +39,4 @@ * Software cryptographic drivers to be integrated into a framework that uses the |API|. * Software drivers for cryptographic hardware to be integrated into a framework that uses the |API|. - * Frameworks that use the |API| to integrate software and hardware providers of cryptographic services. This includes implementations of the PSA Certified Crypto API that provide extensibility via the |API|. + * Frameworks that use the |API| to integrate software and hardware providers of cryptographic services. This includes implementations of the PSA Crypto API that provide extensibility via the |API|. diff --git a/doc/crypto-driver/about/references b/doc/crypto-driver/about/references index 0a4841d4..74b60a30 100644 --- a/doc/crypto-driver/about/references +++ b/doc/crypto-driver/about/references @@ -1,7 +1,8 @@ .. SPDX-FileCopyrightText: Copyright 2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. reference:: PSA CRYPT - :title: PSA Certified Crypto API + :title: PSA Crypto API :doc_id: Arm IHI 0086 :url: arm-software.github.io/psa-api/crypto diff --git a/doc/crypto-driver/about/releases b/doc/crypto-driver/about/releases index eb402826..adedd06e 100644 --- a/doc/crypto-driver/about/releases +++ b/doc/crypto-driver/about/releases @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. release:: N/A @@ -11,7 +12,7 @@ :date: September 2025 :confidentiality: Non-confidential - Republished as part of the PSA Certified APIs. + Republished as part of the PSA APIs. .. release-info:: :extend: diff --git a/doc/crypto-driver/appendix/history.rst b/doc/crypto-driver/appendix/history.rst index 6c4ee894..86d9d9b7 100644 --- a/doc/crypto-driver/appendix/history.rst +++ b/doc/crypto-driver/appendix/history.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license Changes to the API @@ -17,6 +18,6 @@ Changes in the draft GlobalPlatform publication revision Other changes ~~~~~~~~~~~~~ -* Migrated the document to the 2026 PSA Certified API template. +* Migrated the document to the 2026 PSA API template. This changes the document front matter structure and publication styling, without changing the API. diff --git a/doc/crypto-driver/body/using-drivers.rst b/doc/crypto-driver/body/using-drivers.rst index e6c0b9ae..190d5758 100644 --- a/doc/crypto-driver/body/using-drivers.rst +++ b/doc/crypto-driver/body/using-drivers.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2020-2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 .. _using-drivers: @@ -39,7 +40,7 @@ For example, the following snippet creates an AES-GCM key which is only accessib Lifetimes and locations ^^^^^^^^^^^^^^^^^^^^^^^ -The PSA Certified Crypto API defines `lifetimes `__ as an attribute of a key that indicates where the key is stored and which application and system actions will create and destroy it. +The PSA Crypto API defines `lifetimes `__ as an attribute of a key that indicates where the key is stored and which application and system actions will create and destroy it. The lifetime is expressed as a 32-bit value (``typedef uint32_t psa_key_lifetime_t``). An upcoming version of the Crypto API defines more structure for lifetime values to separate these two aspects of the lifetime: diff --git a/doc/crypto-driver/conf.py b/doc/crypto-driver/conf.py index d3dfb9dc..fea439ad 100644 --- a/doc/crypto-driver/conf.py +++ b/doc/crypto-driver/conf.py @@ -1,7 +1,8 @@ # SPDX-FileCopyrightText: Copyright 2025 Arm Limited and/or its affiliates +# SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform # SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license -# PSA Certified API document configuration +# PSA API document configuration # # This is used to generate all of the sphinx configuration data and determine # the document file name etc. @@ -11,12 +12,10 @@ 'template': 'psa-api-2026', # Document title, MANDATORY - 'title': 'PSA Certified\nCrypto Driver Interface', - 'author': 'Arm Limited', + 'title': 'PSA Crypto Driver Interface', # Document copyright date, default to year of 'date' 'copyright_date': '2020-2026', - 'copyright': 'Arm Limited and/or its affiliates', # Document identifier, marked as open issue if not provided 'doc_id': '111106', diff --git a/doc/crypto/README.md b/doc/crypto/README.md index 316600e3..2d8998ce 100644 --- a/doc/crypto/README.md +++ b/doc/crypto/README.md @@ -1,9 +1,10 @@ -# PSA Certified Crypto API — specification sources +# PSA Crypto API — specification sources The Crypto API specification source files are organized as follows: @@ -11,11 +12,12 @@ Folder | Content -- | -- Current directory | Configuration and table of contents `about` | Front matter -`overview` | Informative chapters 1-7 -`api` | API reference chapters 8-10 -`appendix` | Appendix chapters +`overview` | Informative chapters +`api` | API reference +`appendix` | Appendices `figure` | Image files ---- -*Copyright 2022, 2025 Arm Limited and/or its affiliates* +*Copyright 2022, 2025 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/doc/crypto/about/intro b/doc/crypto/about/intro index 2cd5ad2d..4946fec3 100644 --- a/doc/crypto/about/intro +++ b/doc/crypto/about/intro @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. introduction:: @@ -7,11 +8,11 @@ .. rubric:: About the |API| - The interface described in this document is a PSA Certified API, that provides a portable programming interface to cryptographic operations, and key storage functionality, on a wide range of hardware. + The interface described in this document is a PSA API, that provides a portable programming interface to cryptographic operations, and key storage functionality, on a wide range of hardware. The interface is user-friendly, while still providing access to the low-level primitives used in modern cryptography. It does not require that the user has access to the key material. Instead, it uses opaque key identifiers. - You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/crypto`, and find other PSA Certified APIs here at :url:`arm-software.github.io/psa-api`. + You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/crypto`, and find other PSA APIs here at :url:`arm-software.github.io/psa-api`. This document includes: diff --git a/doc/crypto/about/references b/doc/crypto/about/references index 5ac455d6..26ffa5c9 100644 --- a/doc/crypto/about/references +++ b/doc/crypto/about/references @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2020-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. reference:: PSM @@ -9,7 +10,7 @@ :url: psacertified.org/development-resources/building-in-security/threat-models/ .. reference:: PSA STAT - :title: PSA Certified Status code API + :title: PSA Status code API :kind: normative :doc_id: Arm IHI 0097 :url: arm-software.github.io/psa-api/status-code @@ -416,7 +417,7 @@ :url: www.threadgroup.org/ThreadSpec .. reference:: PSA PQC - :title: PSA Certified Crypto API 1.4 PQC Extension + :title: PSA Crypto API 1.4 PQC Extension :doc_id: Arm AES 0119 :url: arm-software.github.io/psa-api/crypto diff --git a/doc/crypto/api/keys/lifetimes.rst b/doc/crypto/api/keys/lifetimes.rst index 2092bd06..ccdfc6e5 100644 --- a/doc/crypto/api/keys/lifetimes.rst +++ b/doc/crypto/api/keys/lifetimes.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. header:: psa/crypto @@ -126,14 +127,14 @@ Key lifetime encoding Implementations should support this value if they support persistent keys at all. Applications should use this value if they have no specific needs that are only met by implementation-specific features. * - ``2 - 127`` - - Persistent key with a PSA Certified API-specified lifetime. + - Persistent key with a PSA API-specified lifetime. - The |API| does not define the meaning of these values, but another PSA Certified API may do so. + The |API| does not define the meaning of these values, but another PSA API may do so. * - ``128 - 254`` - Persistent key with a vendor-specified lifetime. - No PSA Certified API will define the meaning of these values, so implementations may choose the meaning freely. As a guideline, higher persistence levels should cause a key to survive more management events than lower levels. + No PSA API will define the meaning of these values, so implementations may choose the meaning freely. As a guideline, higher persistence levels should cause a key to survive more management events than lower levels. * - :code:`255 = PSA_KEY_PERSISTENCE_READ_ONLY` - Read-only or write-once key. @@ -178,12 +179,12 @@ Key lifetime encoding * - ``2 - 0x7fffff`` - Other locations defined by a PSA specification. - The |API| does not currently assign any meaning to these locations, but future versions of this specification or other PSA Certified APIs may do so. + The |API| does not currently assign any meaning to these locations, but future versions of this specification or other PSA APIs may do so. * - ``0x800000 - 0xffffff`` - Vendor-defined locations. - No PSA Certified API will assign a meaning to locations in this range. + No PSA API will assign a meaning to locations in this range. .. note:: diff --git a/doc/crypto/api/library/library.rst b/doc/crypto/api/library/library.rst index d0f1e9e2..c101e650 100644 --- a/doc/crypto/api/library/library.rst +++ b/doc/crypto/api/library/library.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license |API| library @@ -14,7 +15,7 @@ :include: psa/error.h /* This file is a reference template for implementation of the - * PSA Certified Crypto API v1.5 + * PSA Crypto API v1.5 */ diff --git a/doc/crypto/api/library/status.rst b/doc/crypto/api/library/status.rst index fc21af1e..7dbebd26 100644 --- a/doc/crypto/api/library/status.rst +++ b/doc/crypto/api/library/status.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _status-codes: @@ -6,7 +7,7 @@ Status codes ------------ -The |API| uses the status code definitions that are shared with the other PSA Certified APIs. The |API| also provides some |API|-specific status codes, see :secref:`specific-errors`. +The |API| uses the status code definitions that are shared with the other PSA APIs. The |API| also provides some |API|-specific status codes, see :secref:`specific-errors`. The following elements are defined in :file:`psa/error.h` from :cite-title:`PSA STAT`: @@ -40,7 +41,7 @@ These definitions must be available to an application that includes the :file:`p .. admonition:: Implementation note - An implementation is permitted to define the status code interface elements within the :file:`psa/crypto.h` header file, or to define them via inclusion of a :file:`psa/error.h` header file that is shared with the implementation of other PSA Certified APIs. + An implementation is permitted to define the status code interface elements within the :file:`psa/crypto.h` header file, or to define them via inclusion of a :file:`psa/error.h` header file that is shared with the implementation of other PSA APIs. Common error codes ^^^^^^^^^^^^^^^^^^ diff --git a/doc/crypto/appendix/history.rst b/doc/crypto/appendix/history.rst index 4dce0754..8d926edf 100644 --- a/doc/crypto/appendix/history.rst +++ b/doc/crypto/appendix/history.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license Changes to the API @@ -17,7 +18,7 @@ Changes in the draft GlobalPlatform publication revision Other changes ~~~~~~~~~~~~~ -* Migrated the document to the 2026 PSA Certified API template. +* Migrated the document to the 2026 PSA API template. This changes the document front matter structure and publication styling, without changing the API. diff --git a/doc/crypto/conf.py b/doc/crypto/conf.py index 073241fc..d463e62c 100644 --- a/doc/crypto/conf.py +++ b/doc/crypto/conf.py @@ -1,7 +1,8 @@ # SPDX-FileCopyrightText: Copyright 2018-2026 Arm Limited and/or its affiliates +# SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform # SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license -# PSA Certified API document configuration +# PSA API document configuration # # This is used to generate all of the sphinx configuration data and determine # the document file name etc. @@ -11,12 +12,10 @@ 'template': 'psa-api-2026', # Document title, MANDATORY - 'title': 'PSA Certified\nCrypto API', - 'author': 'Arm Limited', + 'title': 'PSA Crypto API', # Document copyright date, default to year of 'date' 'copyright_date': '2018-2026', - 'copyright': 'Arm Limited and/or its affiliates', # Document identifier, marked as open issue if not provided 'doc_id': 'GPD_SPE_086', diff --git a/doc/crypto/overview/conventions.rst b/doc/crypto/overview/conventions.rst index 59786c96..85e42b66 100644 --- a/doc/crypto/overview/conventions.rst +++ b/doc/crypto/overview/conventions.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2024 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _library-conventions: @@ -17,7 +18,7 @@ The header file for the |API| has the name :file:`psa/crypto.h`. All of the API Implementations must provide their own version of the :file:`psa/crypto.h` header file. Implementations can provide a subset of the API defined in this specification and a subset of the available algorithms. :secref:`appendix-example-header` provides an incomplete, example header file which includes all of the API elements. See also :secref:`implementation-considerations`. -The |API| uses the status code definitions that are shared with the other PSA Certified APIs. :cite-title:`PSA STAT` defines these status codes in the :file:`psa/error.h` header file. Applications are not required to explicitly include the :file:`psa/error.h` header file when using these status codes with the |API|. See :secref:`status-codes`. +The |API| uses the status code definitions that are shared with the other PSA APIs. :cite-title:`PSA STAT` defines these status codes in the :file:`psa/error.h` header file. Applications are not required to explicitly include the :file:`psa/error.h` header file when using these status codes with the |API|. See :secref:`status-codes`. .. _api-conventions: diff --git a/doc/fwu/README.md b/doc/fwu/README.md index 4f3756bf..8b292ea6 100644 --- a/doc/fwu/README.md +++ b/doc/fwu/README.md @@ -1,9 +1,10 @@ -# PSA Certified Firmware Update API — specification sources +# PSA Firmware Update API — specification sources The Firmware Update API specification source files are organized as follows: @@ -11,12 +12,13 @@ Folder | Content -- | -- Current directory | Configuration and table of contents `about` | Front matter -`overview` | Informative chapters 1-4 -`api` | API reference chapter 5 -`appendix` | Appendix chapters +`overview` | Informative chapters +`api` | API reference +`appendix` | Appendices `figure` | Image files `example` | C source of example usage ---- -*Copyright 2022, Arm Limited and/or its affiliates* +*Copyright 2022 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/doc/fwu/about/intro b/doc/fwu/about/intro index 6988753c..a735af26 100644 --- a/doc/fwu/about/intro +++ b/doc/fwu/about/intro @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2020-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. introduction:: @@ -7,11 +8,11 @@ .. rubric:: About the |API| - The interface described in this document is a PSA Certified API, that provides a portable programming interface to firmware update and installation operations on a wide range of hardware. + The interface described in this document is a PSA API, that provides a portable programming interface to firmware update and installation operations on a wide range of hardware. The interface enables the software and systems that manage and deliver a firmware update to a device, to be developed independently from the hardware-specific mechanisms required to apply the update to the device. Reusing the deployment and delivery system for firmware updates reduces the complexity of providing firmware updates across a diverse set of managed devices. - You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/fwu`, and find other PSA Certified APIs here at :url:`arm-software.github.io/psa-api`. + You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/fwu`, and find other PSA APIs here at :url:`arm-software.github.io/psa-api`. .. audience:: diff --git a/doc/fwu/about/references b/doc/fwu/about/references index fba6e473..8c90f75e 100644 --- a/doc/fwu/about/references +++ b/doc/fwu/about/references @@ -1,8 +1,9 @@ .. SPDX-FileCopyrightText: Copyright 2020-2023, 2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. reference:: PSA STAT - :title: PSA Certified Status code API + :title: PSA Status code API :kind: normative :doc_id: ARM IHI 0097 :url: arm-software.github.io/psa-api/status-code diff --git a/doc/fwu/api/api.rst b/doc/fwu/api/api.rst index c5f634ad..d3303635 100644 --- a/doc/fwu/api/api.rst +++ b/doc/fwu/api/api.rst @@ -1,5 +1,5 @@ - .. SPDX-FileCopyrightText: Copyright 2020-2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. header:: psa/update @@ -11,7 +11,7 @@ :include: psa/error.h /* This file is a reference template for implementation of the - * PSA Certified Firmware Update API v1.0 + * PSA Firmware Update API v1.0 */ .. _api-reference: @@ -192,7 +192,7 @@ Library version Status codes ------------ -The |API| uses the status code definitions that are shared with the other PSA Certified APIs. The |API| also provides some |API|-specific status codes, see :secref:`specific-errors` and :secref:`specific-success`. +The |API| uses the status code definitions that are shared with the other PSA APIs. The |API| also provides some |API|-specific status codes, see :secref:`specific-errors` and :secref:`specific-success`. Common status codes ^^^^^^^^^^^^^^^^^^^ @@ -218,7 +218,7 @@ The following elements are defined in :file:`psa/error.h` from :cite:`PSA STAT`: .. admonition:: Implementation note - An implementation is permitted to define these interface elements within the :file:`psa/update.h` header, or to define them via inclusion of a :file:`psa/error.h` header file that is shared with the implementation of other PSA Certified APIs. + An implementation is permitted to define these interface elements within the :file:`psa/update.h` header, or to define them via inclusion of a :file:`psa/error.h` header file that is shared with the implementation of other PSA APIs. .. _specific-errors: diff --git a/doc/fwu/appendix/change-history.rst b/doc/fwu/appendix/change-history.rst index 2720eeba..b35c3808 100644 --- a/doc/fwu/appendix/change-history.rst +++ b/doc/fwu/appendix/change-history.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2020-2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _change-history: @@ -11,7 +12,7 @@ Changes in the draft GlobalPlatform publication revision .. rubric:: General changes -* Migrated the document to the 2026 PSA Certified API template. +* Migrated the document to the 2026 PSA API template. This changes the document front matter structure and publication styling, without changing the API. @@ -102,7 +103,7 @@ Changes between version *0.7* and *1.0 Beta* - :code:`PSA_ERROR_DECRYPTION_FAILURE` - :code:`PSA_ERROR_MISSING_MANIFEST` - * Standardize the use of error codes, aligning with other PSA Certified APIs: + * Standardize the use of error codes, aligning with other PSA APIs: - Use :code:`PSA_ERROR_BAD_STATE` when operations are called in the wrong sequence. - Use :code:`PSA_ERROR_DOES_NOT_EXIST` when operations are called with an unknown component Id. diff --git a/doc/fwu/conf.py b/doc/fwu/conf.py index 9c83f70a..c7300770 100644 --- a/doc/fwu/conf.py +++ b/doc/fwu/conf.py @@ -1,7 +1,8 @@ # SPDX-FileCopyrightText: Copyright 2020-2025 Arm Limited and/or its affiliates +# SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform # SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license -# PSA Certified API specification configuration +# PSA API specification configuration # # This is used to generate all of the sphinx configuration data and determine # the document file name etc. @@ -11,12 +12,10 @@ 'template': 'psa-api-2026', # Document title, MANDATORY - 'title': 'PSA Certified\nFirmware Update API', - 'author': 'Arm Limited', + 'title': 'PSA Firmware Update API', # Document copyright date, default to year of 'date' 'copyright_date': '2020-2026', - 'copyright': 'Arm Limited and/or its affiliates', # Document identifier, marked as open issue if not provided 'doc_id': 'GPD_SPE_093', diff --git a/doc/fwu/overview/goals.rst b/doc/fwu/overview/goals.rst index e69306c2..2535644a 100644 --- a/doc/fwu/overview/goals.rst +++ b/doc/fwu/overview/goals.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2020-2023, 2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _intro: @@ -40,7 +41,7 @@ The remainder of this document includes: * A description of the interface design. See :secref:`programming-model`. * A detailed definition of the API. See :secref:`api-reference`. -The appendixes provide additional information: +The appendices provide additional information: * A sample header file containing all of the API elements. See :secref:`appendix-example-header`. * Some example code demonstrating various use cases. See :secref:`examples`. diff --git a/doc/status-code/README.md b/doc/status-code/README.md index 435856ca..0c568303 100644 --- a/doc/status-code/README.md +++ b/doc/status-code/README.md @@ -1,20 +1,21 @@ -# PSA Certified Status code API — specification sources +# PSA Status code API — specification sources The Status code API specification source files are organized as follows: Folder | Content -- | -- -Current directory | Configuration and Table of contents +Current directory | Configuration and table of contents `about` | Front matter -`overview` | Informative chapter 1 -`api` | API reference chapter 2 -`appendix` | Appendix chapters +`api` | API reference +`appendix` | Appendices ---- -*Copyright 2022, 2026, Arm Limited and/or its affiliates* +*Copyright 2022, 2026 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/doc/status-code/about/intro b/doc/status-code/about/intro index e4a24eca..8d859bdf 100644 --- a/doc/status-code/about/intro +++ b/doc/status-code/about/intro @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2022, 2025-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. introduction:: @@ -7,15 +8,15 @@ .. rubric:: About the |API| - The interface described in this document is a PSA Certified API, that provides a shared set of interface definitions used by other PSA Certified APIs. + The interface described in this document is a PSA API, that provides a shared set of interface definitions used by other PSA APIs. - You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/status-code`, and find other PSA Certified APIs here at :url:`arm-software.github.io/psa-api`. + You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/status-code`, and find other PSA APIs here at :url:`arm-software.github.io/psa-api`. .. audience:: This document is intended primarily for the use of developers of: - * PSA Certified API specifications. - * Implementations of PSA Certified APIs. - * Frameworks that provide access to security services via the PSA Certified APIs. - * Client applications and Root of Trust Services that use any of the PSA Certified APIs. + * PSA API specifications. + * Implementations of PSA APIs. + * Frameworks that provide access to security services via the PSA APIs. + * Client applications and Root of Trust Services that use any of the PSA APIs. diff --git a/doc/status-code/about/releases b/doc/status-code/about/releases index 2cbc5b98..099572e8 100644 --- a/doc/status-code/about/releases +++ b/doc/status-code/about/releases @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2022, 2024 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. release:: 1.0.1 @@ -7,7 +8,7 @@ Definition of status codes moved to a separate specification. - Incorporated some error codes from other PSA Certified APIs. + Incorporated some error codes from other PSA APIs. Relicensed as open source under CC BY-SA 4.0. diff --git a/doc/status-code/api/status-codes.rst b/doc/status-code/api/status-codes.rst index b10dcefa..fcfbe30e 100644 --- a/doc/status-code/api/status-codes.rst +++ b/doc/status-code/api/status-codes.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2017-2022, 2024 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license Status codes @@ -9,14 +10,14 @@ Status codes Overview -------- -The PSA Certified APIs are often implemented together in a larger framework. For example, the :cite-title:`TF-M` project implements all of the PSA functional APIs as Root of Trust Services within the Secure Processing Environment that it provides. Using a common definition for status and error codes enables easier integration and inter-operation of these APIs. +The PSA APIs are often implemented together in a larger framework. For example, the :cite-title:`TF-M` project implements all of the PSA functional APIs as Root of Trust Services within the Secure Processing Environment that it provides. Using a common definition for status and error codes enables easier integration and inter-operation of these APIs. -The PSA Certified APIs use the convention that status codes that are negative indicate an error, and zero or positive values indicate success. These are identified in the API by the `psa_status_t` type. +The PSA APIs use the convention that status codes that are negative indicate an error, and zero or positive values indicate success. These are identified in the API by the `psa_status_t` type. -Status codes ``-129`` to ``-248`` are for use by PSA Certified API specifications. These codes are defined in the current PSA specifications, or are reserved for future PSA specifications. Status codes in this range are used in the following ways: +Status codes ``-129`` to ``-248`` are for use by PSA API specifications. These codes are defined in the current PSA specifications, or are reserved for future PSA specifications. Status codes in this range are used in the following ways: -* A set of standard error codes that cover failure conditions that are common to more than one PSA Certified API. -* Error codes that are specific to an individual PSA Certified API. +* A set of standard error codes that cover failure conditions that are common to more than one PSA API. +* Error codes that are specific to an individual PSA API. Status codes in this range must only be used as defined in a PSA specification. @@ -25,7 +26,7 @@ In the context of an implementation of :cite-title:`PSA FFM`: * The :term:`Secure Partition Manager` (SPM) implementation can define error codes in the range ``-249`` to ``-256`` for :sc:`IMPLEMENTATION DEFINED` purposes. * A :term:`Root of Trust Service` (RoT Service) can define additional error codes in the ranges ``-1`` to ``-128`` and ``-257`` to ``MIN_INT32`` for RoT Service-specific error conditions. -:numref:`tab-error-codes` defines the common error codes and reserved ranges for the PSA Certified APIs. See the error code macros and function definitions in :secref:`api` for details on their usage. +:numref:`tab-error-codes` defines the common error codes and reserved ranges for the PSA APIs. See the error code macros and function definitions in :secref:`api` for details on their usage. .. csv-table:: Standard error codes :name: tab-error-codes @@ -55,13 +56,13 @@ In the context of an implementation of :cite-title:`PSA FFM`: ``PSA_ERROR_COMMUNICATION_FAILURE``, ``-145``, Communication failure with another component. ``PSA_ERROR_STORAGE_FAILURE``, ``-146``, Storage failure that may have led to data loss. ``PSA_ERROR_HARDWARE_FAILURE``, ``-147``, General hardware failure. - *Reserved*, ``-148``, Reserved for PSA Certified APIs. + *Reserved*, ``-148``, Reserved for PSA APIs. ``PSA_ERROR_INVALID_SIGNATURE``, ``-149``, "A signature, MAC or hash is incorrect." - *Reserved*, ``-150``, Reserved for PSA Certified APIs. + *Reserved*, ``-150``, Reserved for PSA APIs. ``PSA_ERROR_CORRUPTION_DETECTED``, ``-151``, Internal data has been tampered with. ``PSA_ERROR_DATA_CORRUPT``, ``-152``, Stored data has been corrupted. ``PSA_ERROR_DATA_INVALID``, ``-153``, Data read from storage is not valid. - *Reserved*, ``-154`` to ``-247``, Reserved for PSA Certified APIs. + *Reserved*, ``-154`` to ``-247``, Reserved for PSA APIs. ``PSA_OPERATION_INCOMPLETE``, ``-248``, The requested operation is not finished. *SPM Implementation error*, ``-249`` to ``-256``, Reserved for the SPM implementation. *API-specific error*, ``<= -257``, API-specific error code. @@ -79,17 +80,17 @@ API Reference :c++: :system-include: stddef.h stdint.h - // This file is a reference template for implementation of the PSA Certified Status code API + // This file is a reference template for implementation of the PSA Status code API -These are common status and error codes for all PSA Certified APIs, and for SPM and RoT Service APIs. See :secref:`error-codes` for a summary of the status codes. +These are common status and error codes for all PSA APIs, and for SPM and RoT Service APIs. See :secref:`error-codes` for a summary of the status codes. The API elements described in the following sections :std:numref:`status-type` to :std:numref:`status-pending`, must be defined in a header file :file:`psa/error.h`. See :secref:`reference-headers` for a reference version of this header file. -It is permitted for these API elements to also be defined in header files that are part of an implementation of another PSA Certified API, for example, in :file:`psa/crypto.h`. +It is permitted for these API elements to also be defined in header files that are part of an implementation of another PSA API, for example, in :file:`psa/crypto.h`. .. admonition:: Implementation note - In an implementation of any PSA Certified API, it essential that the status code macros are defined precisely as shown in the API specifications and reference header files. In particular, there is no white-space in the definition. + In an implementation of any PSA API, it essential that the status code macros are defined precisely as shown in the API specifications and reference header files. In particular, there is no white-space in the definition. The C language only permits a macro definition to be repeated within a compilation, if every definition is identical, including the white-space separation. @@ -102,7 +103,7 @@ Status type :guard: PSA_SUCCESS :comment: Prevent multiple definitions of psa_status_t, if PSA_SUCCESS is already defined in an external header - .. summary:: A status code type used for all PSA Certified APIs. + .. summary:: A status code type used for all PSA APIs. A zero or positive value indicates success, the interpretation of the value depends on the specific operation. diff --git a/doc/status-code/appendix/change-history.rst b/doc/status-code/appendix/change-history.rst index a7992047..fc6560b0 100644 --- a/doc/status-code/appendix/change-history.rst +++ b/doc/status-code/appendix/change-history.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2022, 2024-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _change-history: @@ -13,7 +14,7 @@ Document and API Changes Changes in the draft GlobalPlatform publication revision -------------------------------------------------------- -* Migrated the document to the 2026 PSA Certified API template. +* Migrated the document to the 2026 PSA API template. This changes the document front matter structure and publication styling, without changing the API. @@ -43,8 +44,8 @@ Changes between version 1.0.0 and version 1.0.1 * Moved the specification of the common error codes into a separate specification. * Relicensed the document under Attribution-ShareAlike 4.0 International with a patent license derived from Apache License 2.0. See :secref:`license`. -* Generalized the definitions of the error codes to better fit all PSA Certified APIs. -* Added definitions from other PSA Certified APIs: +* Generalized the definitions of the error codes to better fit all PSA APIs. +* Added definitions from other PSA APIs: - `PSA_ERROR_CORRUPTION_DETECTED` - `PSA_ERROR_DATA_CORRUPT` diff --git a/doc/status-code/appendix/reference-headers.rst b/doc/status-code/appendix/reference-headers.rst index a551fa7d..98b30954 100644 --- a/doc/status-code/appendix/reference-headers.rst +++ b/doc/status-code/appendix/reference-headers.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2022 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _reference-headers: @@ -9,7 +10,7 @@ Reference header file The following is an example of the standard header files for the |API|. -An implementation of other PSA Certified APIs will provide an instance of the :file:`psa/error.h` source file. +An implementation of other PSA APIs will provide an instance of the :file:`psa/error.h` source file. .. rubric:: psa/error.h diff --git a/doc/status-code/conf.py b/doc/status-code/conf.py index b5462900..fc733caa 100644 --- a/doc/status-code/conf.py +++ b/doc/status-code/conf.py @@ -1,7 +1,8 @@ # SPDX-FileCopyrightText: Copyright 2022, 2024-2026 Arm Limited and/or its affiliates +# SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform # SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license -# PSA Certified API document configuration +# PSA API document configuration # # This is used to generate all of the sphinx configuration data and determine # the document file name etc. @@ -11,12 +12,10 @@ 'template': 'psa-api-2026', # Document title, MANDATORY - 'title': 'PSA Certified\nStatus code API', - 'author': 'Arm Limited', + 'title': 'PSA Status code API', # Document copyright date, default to year of 'date' 'copyright_date': '2017-2022, 2024-2026', - 'copyright': 'Arm Limited and/or its affiliates', # Document identifier, marked as open issue if not provided 'doc_id': 'GPD_SPE_097', diff --git a/doc/storage/README.md b/doc/storage/README.md index bc4a8639..a2a3b8dc 100644 --- a/doc/storage/README.md +++ b/doc/storage/README.md @@ -1,20 +1,23 @@ -# PSA Certified Secure Storage API — specification sources +# PSA Secure Storage API — specification sources The Secure Storage API specification source files are organized as follows: Folder | Content -- | -- -Current directory | Configuration and front-matter -`overview` | Informative chapters 1-4 -`api` | API reference chapter 5 -`appendix` | Appendix chapters +Current directory | Configuration and table of contents +`about` | Front matter +`overview` | Informative chapters +`api` | API reference +`appendix` | Appendices `figure` | Image files ---- -*Copyright 2022, Arm Limited and/or its affiliates* +*Copyright 2022 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/doc/storage/about/intro b/doc/storage/about/intro index 797c4723..b0271cc3 100644 --- a/doc/storage/about/intro +++ b/doc/storage/about/intro @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2019, 2022,2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. introduction:: @@ -7,7 +8,7 @@ .. rubric:: About the |API| - The interface described in this document is a PSA Certified API, that provides key/value storage interfaces for use with device-protected storage. The |API| describes two interfaces for storage: + The interface described in this document is a PSA API, that provides key/value storage interfaces for use with device-protected storage. The |API| describes two interfaces for storage: .. csv-table:: :widths: 3 7 @@ -19,7 +20,7 @@ If there are no :term:`Application Root of Trust` (ARoT) services that rely on it, the Protected Storage API can be implemented in the :term:`NSPE`. Otherwise, the Protected Storage API must be implemented in an ARoT within the :term:`SPE`. - You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/storage`, and find other PSA Certified APIs here at :url:`arm-software.github.io/psa-api`. + You can find additional resources relating to the |API| here at :url:`arm-software.github.io/psa-api/storage`, and find other PSA APIs here at :url:`arm-software.github.io/psa-api`. .. audience:: diff --git a/doc/storage/about/references b/doc/storage/about/references index 6f8f003b..89230b57 100644 --- a/doc/storage/about/references +++ b/doc/storage/about/references @@ -1,14 +1,15 @@ .. SPDX-FileCopyrightText: Copyright 2018-2019, 2022-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. reference:: PSA STAT - :title: PSA Certified Status code API + :title: PSA Status code API :kind: normative :doc_id: Arm IHI 0097 :url: arm-software.github.io/psa-api/status-code .. reference:: PSA CRYPT - :title: PSA Certified Crypto API + :title: PSA Crypto API :kind: informative :doc_id: Arm IHI 0086 :url: arm-software.github.io/psa-api/crypto diff --git a/doc/storage/about/releases b/doc/storage/about/releases index 9a07dc92..1a413690 100644 --- a/doc/storage/about/releases +++ b/doc/storage/about/releases @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2019, 2022-2026 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. release:: 1.0.0 @@ -7,9 +8,9 @@ First stable release with 1.0 API finalized. - Uses the common PSA Certified Status codes. + Uses the common PSA Status codes. - Modified the API parameters to align with other PSA Certified APIs. + Modified the API parameters to align with other PSA APIs. Added storage flags to specify protection requirement. diff --git a/doc/storage/api/api.rst b/doc/storage/api/api.rst index c64873c5..2d69eb1c 100644 --- a/doc/storage/api/api.rst +++ b/doc/storage/api/api.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2019, 2022-2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license API Reference @@ -7,7 +8,7 @@ API Reference Status codes ------------ -The |API| uses the status code definitions that are shared with the other PSA Certified APIs. +The |API| uses the status code definitions that are shared with the other PSA APIs. The following elements are defined in :file:`psa/error.h` from :cite-title:`PSA STAT`: @@ -31,7 +32,7 @@ These definitions must be available to an application that includes either of th .. admonition:: Implementation note - An implementation is permitted to define the status code interface elements within the |API| header files, or to define them via inclusion of a :file:`psa/error.h` header file that is shared with the implementation of other PSA Certified APIs. + An implementation is permitted to define the status code interface elements within the |API| header files, or to define them via inclusion of a :file:`psa/error.h` header file that is shared with the implementation of other PSA APIs. General Definitions ------------------- @@ -44,7 +45,7 @@ General Definitions :system-include: stddef.h stdint.h /* This file is a reference template for implementation of the - * PSA Certified Secure Storage API v1.0 + * PSA Secure Storage API v1.0 * * This file includes common definitions */ @@ -116,7 +117,7 @@ Internal Trusted Storage API :include: psa/error.h psa/storage_common.h /* This file is a reference template for implementation of the - * PSA Certified Secure Storage API v1.0 + * PSA Secure Storage API v1.0 * * This file describes the Internal Trusted Storage API */ @@ -327,7 +328,7 @@ Protected Storage API :include: psa/error.h psa/storage_common.h /* This file is a reference template for implementation of the - * PSA Certified Secure Storage API v1.0 + * PSA Secure Storage API v1.0 * * This file describes the Protected Storage API */ diff --git a/doc/storage/appendix/history.rst b/doc/storage/appendix/history.rst index c61b6c14..802a4f0b 100644 --- a/doc/storage/appendix/history.rst +++ b/doc/storage/appendix/history.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2019, 2022-2025 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _document-history: @@ -17,7 +18,7 @@ Document history * - TBD - *Draft GlobalPlatform publication revision* - - Migrated the document to the 2026 PSA Certified API template. + - Migrated the document to the 2026 PSA API template. This changes the document front matter structure and publication styling, without changing the API. diff --git a/doc/storage/conf.py b/doc/storage/conf.py index 09f5989f..8a5107c5 100644 --- a/doc/storage/conf.py +++ b/doc/storage/conf.py @@ -1,7 +1,8 @@ # SPDX-FileCopyrightText: Copyright 2018-2019, 2022-2026 Arm Limited and/or its affiliates +# SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform # SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license -# PSA Certified API document configuration +# PSA API document configuration # # This is used to generate all of the sphinx configuration data and determine # the document file name etc. @@ -11,12 +12,10 @@ 'template': 'psa-api-2026', # Document title, MANDATORY - 'title': 'PSA Certified\nSecure Storage API', - 'author': 'Arm Limited', + 'title': 'PSA Secure Storage API', # Document copyright date, default to year of 'date' 'copyright_date': '2018-2019, 2022-2026', - 'copyright': 'Arm Limited and/or its affiliates', # Document identifier, marked as open issue if not provided 'doc_id': 'GPD_SPE_087', diff --git a/doc/storage/overview/architecture.rst b/doc/storage/overview/architecture.rst index edae69d8..e25edf51 100644 --- a/doc/storage/overview/architecture.rst +++ b/doc/storage/overview/architecture.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2018-2019, 2022 Arm Limited and/or its affiliates +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license Architecture @@ -25,7 +26,7 @@ Most embedded microprocessors (MCU) have on-chip flash storage that can be made In addition, many platforms also have external storage that requires confidentiality, integrity, and replay protection from attackers with physical access to the device. -By providing consistent APIs for accessing storage, software in both the :term:`NSPE` and :term:`SPE` can be written in a platform-independent manner. This improves portability between platforms that implement the PSA Certified APIs. +By providing consistent APIs for accessing storage, software in both the :term:`NSPE` and :term:`SPE` can be written in a platform-independent manner. This improves portability between platforms that implement the PSA APIs. The Protected Storage API ------------------------- diff --git a/examples/README.md b/examples/README.md index e94d9ac6..e4b980b8 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,11 +1,12 @@ -# PSA Certified API Examples +# PSA API Examples -This folder includes examples of both usage, and implementation, of the PSA Certified APIs. +This folder includes examples of both usage, and implementation, of the PSA APIs. Each example includes a README that explains the example, and how to use it. @@ -18,4 +19,5 @@ Each example includes a README that explains the example, and how to use it. ---- -*Copyright 2022, 2024, Arm Limited and/or its affiliates* +*Copyright 2022, 2024 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/related-projects.md b/related-projects.md index 27f14c11..3b5589f1 100644 --- a/related-projects.md +++ b/related-projects.md @@ -1,9 +1,10 @@ -# Known implementations and projects related to the PSA Certified APIs +# Known implementations and projects related to the PSA APIs Updated Sep 2025. @@ -12,7 +13,7 @@ Updated Sep 2025. - The reference implementation for PSA Crypto API can be found inside Mbed TLS. [mbed-tls.readthedocs.io/en/latest](https://mbed-tls.readthedocs.io/en/latest/) -- Other PSA Certified APIs are included in the TF-M project. +- Other PSA APIs are included in the TF-M project. [www.trustedfirmware.org/projects/tf-m](https://www.trustedfirmware.org/projects/tf-m/) - Trusted Services implements those services in a Trusted Execution Environment on Cortex A processors. @@ -30,7 +31,7 @@ Updated Sep 2025. ## Crypto driver implementations The PSA Crypto Driver Interface complements the Crypto API. -Initially developed as part of the Mbed TLS project, development now continues as part of the PSA Certified API project. +Initially developed as part of the Mbed TLS project, development now continues as part of the PSA API project. The aim of the Driver Interface is to simplify the integration of cryptographic peripherals, secure elements, and optimized software into implementations of the Crypto API. See [doc/crypto-driver/psa-driver-interface.rst](doc/crypto-driver/psa-driver-interface.rst). @@ -71,5 +72,5 @@ The aim of the Driver Interface is to simplify the integration of cryptographic ---- -*Copyright 2022, 2025 Arm Limited and/or its affiliates* - +*Copyright 2022, 2025 Arm Limited and/or its affiliates*\ +*Copyright 2026 GlobalPlatform* diff --git a/tools/docs/psa-api-tool-notes.md b/tools/docs/psa-api-tool-notes.md index 0d0d7478..9f902603 100644 --- a/tools/docs/psa-api-tool-notes.md +++ b/tools/docs/psa-api-tool-notes.md @@ -1,5 +1,6 @@ @@ -133,7 +134,7 @@ Prefer: Avoid: -- `Arm recommends that ...` +- ` recommends that ...` - `We recommend that ...` This keeps advisory specification text independent of a motivated speaker, while still @@ -470,7 +471,7 @@ Example: :include: psa/error.h /* This file is a reference template for implementation of the - * PSA Certified Crypto API v1.5 + * PSA Crypto API v1.5 */ ``` @@ -2513,4 +2514,5 @@ The mitigation is described in :m:`isolate-components`. ---- -*Copyright 2018-2026 Arm Limited* +*Copyright 2018-2026 Arm Limited*\ +*Copyright 2026 GlobalPlatform* diff --git a/tools/psa-api-conf.py b/tools/psa-api-conf.py index 35dc1e83..c60c794b 100644 --- a/tools/psa-api-conf.py +++ b/tools/psa-api-conf.py @@ -1,10 +1,11 @@ # SPDX-FileCopyrightText: Copyright 2018-2026 Arm Limited +# SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform # SPDX-License-Identifier: Apache-2.0 # -*- coding: utf-8 -*- # # This is a common set of configuration options for using Sphinx to build -# PSA Certified API specifications. Project specific definitions are contained in +# PSA API specifications. Project specific definitions are contained in # the conf.py file that forms the master document directory. # # This script is included and executed as part of conf.py, it is not a diff --git a/tools/templates/psa-api-2026/about-chapter.rst b/tools/templates/psa-api-2026/about-chapter.rst index a843725e..010fc0ea 100644 --- a/tools/templates/psa-api-2026/about-chapter.rst +++ b/tools/templates/psa-api-2026/about-chapter.rst @@ -1,4 +1,5 @@ .. SPDX-FileCopyrightText: Copyright 2026 Arm Limited +.. SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform .. SPDX-License-Identifier: CC-BY-SA-4.0 AND LicenseRef-Patent-license .. _introduction: @@ -94,7 +95,7 @@ Introduction .. insert-section:: Revision History :section: release-info - PSA Certified API documents use the following versioning scheme: + PSA API documents use the following versioning scheme: * Those with version x.0 are major releases. * Those versioned x.1, x.2, etc., are minor releases where changes typically introduce supplementary items that do not impact backward compatibility or interoperability of the specifications. diff --git a/tools/templates/psa-api-2026/template-conf.py b/tools/templates/psa-api-2026/template-conf.py index 6065717f..c70e8a43 100644 --- a/tools/templates/psa-api-2026/template-conf.py +++ b/tools/templates/psa-api-2026/template-conf.py @@ -1,4 +1,5 @@ # SPDX-FileCopyrightText: Copyright 2018-2026 Arm Limited +# SPDX-FileCopyrightText: Copyright 2026 GlobalPlatform # SPDX-License-Identifier: Apache-2.0 # -*- coding: utf-8 -*- @@ -92,8 +93,8 @@ def make_doc_filename(info, id, title, version, status): template_info['numfig_sec_depth'] = 1 template_info['page_break'] = 'chapter' -doc_info.setdefault('author', 'The PSA Certified API contributors') -doc_info.setdefault('copyright', 'The PSA Certified API contributors') +doc_info.setdefault('author', 'The PSA API contributors') +doc_info.setdefault('copyright', 'The PSA API contributors') doc_info.setdefault('feedback', 'visit :url:`github.com/globalplatform/psa-api/issues`' + - ' to create a new issue at the PSA Certified API GitHub project') -doc_info.setdefault('license', 'psa-certified-api-license') + ' to create a new issue at the PSA API GitHub project') +doc_info.setdefault('license', 'psa-api-license')