Skip to content

Commit

Permalink
Replace unicode n-dash in code blocks with hyphen
Browse files Browse the repository at this point in the history
This is an artefact of the original documentation generation tooling.
  • Loading branch information
athoelke committed Sep 3, 2024
1 parent ae0af92 commit 144bf40
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions doc/crypto/api/keys/ids.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Key identifiers are integral values that act as permanent names for persistent k

:code:`PSA_KEY_ID_NULL = 0`
Reserved as an invalid key identifier.
:code:`PSA_KEY_ID_USER_MIN PSA_KEY_ID_USER_MAX`
:code:`PSA_KEY_ID_USER_MIN - PSA_KEY_ID_USER_MAX`
Applications can freely choose persistent key identifiers in this range.
:code:`PSA_KEY_ID_VENDOR_MIN PSA_KEY_ID_VENDOR_MAX`
:code:`PSA_KEY_ID_VENDOR_MIN - PSA_KEY_ID_VENDOR_MAX`
Implementations can define additional persistent key identifiers in this range, and must allocate any volatile key identifiers from this range.

Key identifiers outside these ranges are reserved for future use.
Expand Down
8 changes: 4 additions & 4 deletions doc/crypto/api/keys/lifetimes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,12 @@ Lifetime encodings

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``
* - ``2 - 127``
- Persistent key with a PSA Certified API-specified lifetime.

The |API| does not define the meaning of these values, but another PSA Certified API may do so.

* - ``128 254``
* - ``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.
Expand Down Expand Up @@ -171,12 +171,12 @@ Lifetime encodings

Implementations should support this value if there is a secure element attached to the operating environment. As a guideline, secure elements may provide higher resistance against side channel and physical attacks than the primary local storage, but may have restrictions on supported key types, sizes, policies and operations and may have different performance characteristics.

* - ``2 0x7fffff``
* - ``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.

* - ``0x800000 0xffffff``
* - ``0x800000 - 0xffffff``
- Vendor-defined locations.

No PSA Certified API will assign a meaning to locations in this range.
Expand Down
12 changes: 6 additions & 6 deletions doc/crypto/api/keys/types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Key type encoding

:code:`PSA_KEY_TYPE_NONE == 0`
Reserved as an invalid key type.
:code:`0x0001 0x7fff`
:code:`0x0001 - 0x7fff`
Specification-defined key types.
Key types defined by this standard always have bit 15 clear.
Unallocated key type values in this range are reserved for future use.
:code:`0x8000 0xffff`
:code:`0x8000 - 0xffff`
Implementation-defined key types.
Implementations that define additional key types must use an encoding with bit 15 set.
The related support macros will be easier to write if these key encodings also respect the bitwise structure used by standard encodings.
Expand Down Expand Up @@ -757,10 +757,10 @@ The curve type affects the key format, the key derivation procedure, and the alg

:code:`0x00`
Reserved. Not allocated to an ECC family.
:code:`0x01 0x7f`
:code:`0x01 - 0x7f`
ECC family identifiers defined by this standard.
Unallocated values in this range are reserved for future use.
:code:`0x80 0xff`
:code:`0x80 - 0xff`
Implementations that define additional families must use an encoding in this range.

.. macro:: PSA_KEY_TYPE_ECC_KEY_PAIR
Expand Down Expand Up @@ -1174,10 +1174,10 @@ Diffie Hellman keys

:code:`0x00`
Reserved. Not allocated to a DH group family.
:code:`0x01 0x7f`
:code:`0x01 - 0x7f`
DH group family identifiers defined by this standard.
Unallocated values in this range are reserved for future use.
:code:`0x80 0xff`
:code:`0x80 - 0xff`
Implementations that define additional families must use an encoding in this range.

.. macro:: PSA_KEY_TYPE_DH_KEY_PAIR
Expand Down
4 changes: 2 additions & 2 deletions doc/crypto/api/ops/algorithms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ Algorithm encoding

:code:`0x00000000`
Reserved as an invalid algorithm identifier.
:code:`0x00000001 0x7fffffff`
:code:`0x00000001 - 0x7fffffff`
Specification-defined algorithm identifiers.
Algorithm identifiers defined by this standard always have bit 31 clear.
Unallocated algorithm identifier values in this range are reserved for future use.
:code:`0x80000000 0xffffffff`
:code:`0x80000000 - 0xffffffff`
Implementation-defined algorithm identifiers.
Implementations that define additional algorithms must use an encoding with bit 31 set.
The related support macros will be easier to write if these algorithm identifier encodings also respect the bitwise structure used by standard encodings.
Expand Down

0 comments on commit 144bf40

Please sign in to comment.