yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix some additional over-long lines

Browse source 
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
This commit is contained in:
Dave Rodgman 2023-01-23 12:31:01 +00:00
parent 38699e5323
commit 99ff0a7c50
1 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/getting_started.md
View file

@ -20,8 +20,8 @@ Mbed TLS is distributed under the Apache License, version 2.0.
#### Platform Security Architecture (PSA) #### Platform Security Architecture (PSA)
Arm's Platform Security Architecture (PSA) is a holistic set of threat models, Arm's Platform Security Architecture (PSA) is a holistic set of threat models,
security analyses, hardware and firmware architecture specifications, and an open security analyses, hardware and firmware architecture specifications, and an
source firmware reference implementation. PSA provides a recipe, based on open source firmware reference implementation. PSA provides a recipe, based on
industry best practice, that enables you to design security into both hardware industry best practice, that enables you to design security into both hardware
and firmware consistently. Part of the API provided by PSA is the cryptography and firmware consistently. Part of the API provided by PSA is the cryptography
interface, which provides access to a set of primitives. interface, which provides access to a set of primitives.
@ -204,8 +204,9 @@ symmetric cipher algorithms (both block and stream ciphers).
**Prerequisites to working with the symmetric cipher API:** **Prerequisites to working with the symmetric cipher API:**
* Initialize the library with a successful call to `psa_crypto_init()`. * Initialize the library with a successful call to `psa_crypto_init()`.
* Have a symmetric key. This key's usage flags must include `PSA_KEY_USAGE_ENCRYPT` * Have a symmetric key. This key's usage flags must include
to allow encryption or `PSA_KEY_USAGE_DECRYPT` to allow decryption. `PSA_KEY_USAGE_ENCRYPT` to allow encryption or `PSA_KEY_USAGE_DECRYPT` to
allow decryption.
**To encrypt a message with a symmetric cipher:** **To encrypt a message with a symmetric cipher:**
1. Allocate an operation (`psa_cipher_operation_t`) structure to pass to the 1. Allocate an operation (`psa_cipher_operation_t`) structure to pass to the
@ -602,11 +603,13 @@ including other keys and data, and functions to generate outputs, such as
new keys or other data. new keys or other data.
You must first initialize and set up a key derivation context, You must first initialize and set up a key derivation context,
provided with a key and, optionally, other data. Then, use the key derivation context provided with a key and, optionally, other data. Then, use the key derivation
to either read derived data to a buffer or send derived data directly to a key slot. context to either read derived data to a buffer or send derived data directly
to a key slot.
See the documentation for the particular algorithm (such as HKDF or the TLS1.2 PRF) for See the documentation for the particular algorithm (such as HKDF or the
information about which inputs to pass when, and when you can obtain which outputs. TLS 1.2 PRF) for information about which inputs to pass when, and when you can
obtain which outputs.
**Prerequisites to working with the key derivation APIs:** **Prerequisites to working with the key derivation APIs:**
* Initialize the library with a successful call to `psa_crypto_init()`. * Initialize the library with a successful call to `psa_crypto_init()`.
@ -623,11 +626,11 @@ with a given key, salt and info:**
function, specifying the derivation algorithm `PSA_ALG_HKDF(PSA_ALG_SHA_256)`. function, specifying the derivation algorithm `PSA_ALG_HKDF(PSA_ALG_SHA_256)`.
1. Provide an optional salt with `psa_key_derivation_input_bytes()`. 1. Provide an optional salt with `psa_key_derivation_input_bytes()`.
1. Provide info with `psa_key_derivation_input_bytes()`. 1. Provide info with `psa_key_derivation_input_bytes()`.
1. Provide a secret with `psa_key_derivation_input_key()`, referencing a key that 1. Provide a secret with `psa_key_derivation_input_key()`, referencing a key
can be used for key derivation. that can be used for key derivation.
1. Set the key attributes desired for the new derived key. We'll set 1. Set the key attributes desired for the new derived key. We'll set
the `PSA_KEY_USAGE_ENCRYPT` usage flag and the `PSA_ALG_CTR` algorithm for this the `PSA_KEY_USAGE_ENCRYPT` usage flag and the `PSA_ALG_CTR` algorithm for
example. this example.
1. Derive the key by calling `psa_key_derivation_output_key()`. 1. Derive the key by calling `psa_key_derivation_output_key()`.
1. Clean up the key derivation context. 1. Clean up the key derivation context.