Skip to content

Commit 8cd5746

Browse files
authored
Merge branch 'main' into main
2 parents 7a47858 + 95c5e85 commit 8cd5746

40 files changed

+1066
-44
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ For quick merging, the contribution should be short, and concentrated on a singl
1414

1515
All contributions are made under the [Apache License 2.0](LICENSE).
1616

17-
1. Fork the [Mbed TLS documentation repository on GitHub](https://github.com/ARMmbed/mbedtls-docs) to start making your changes.
17+
1. Fork the [Mbed TLS documentation repository on GitHub](https://github.com/Mbed-TLS/mbedtls-docs) to start making your changes.
1818
1. Ensure that each commit has at least one `Signed-off-by:` line from the committer. If anyone else contributes to the commit, they should also add their own `Signed-off-by:` line. By adding this line, contributor(s) certify that the contribution is made under the terms of the [Developer Certificate of Origin](dco.txt).
1919
1. Send a pull request (PR) and work with us until it gets merged and published.

getting_started/building.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The following modes are supported:
7272

7373
For debug mode, enter at the command line:
7474
```sh
75-
cmake -D CMAKE_BUILD_TYPE:Debug .
75+
cmake -D CMAKE_BUILD_TYPE=Debug .
7676
```
7777
To list other available CMake options, use:
7878
```sh

getting_started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting started with Mbed TLS
1+
# Getting Started
22
```{toctree}
33
---
44
glob:

index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ gaps, etc. We welcome contributions!
1515

1616
For more information, see the following:
1717

18-
* [GitHub repository](https://github.com/ARMmbed/mbedtls)
19-
* [Documentation GitHub repository](https://github.com/ARMmbed/mbedtls-docs)
18+
* [GitHub repository](https://github.com/Mbed-TLS/mbedtls)
19+
* [Documentation GitHub repository](https://github.com/Mbed-TLS/mbedtls-docs)
2020
* [Mbed TLS website](https://www.trustedfirmware.org/projects/mbed-tls/)
2121
* [PSA Crypto API specification](https://arm-software.github.io/psa-api/crypto/)
2222

@@ -29,7 +29,7 @@ getting_started/index.md
2929
API Reference <https://mbed-tls.readthedocs.io/projects/api>
3030
project/index.md
3131
reviews/index.md
32-
tech-updates/security-advisories/index.md
32+
security-advisories/index.md
3333
CONTRIBUTING.md
3434
kb/index.md
3535
```

kb/development/arm-thumb-error-r7-cannot-be-used-in-asm-here.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

kb/development/mbedtls-coding-standards.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Length parameters:
236236

237237
## API conventions
238238

239-
This section applies fully to classic `mbedtls_xxx()` APIs and mostly to the newer `psa_xxx()` APIs. PSA have their own [conventions described in the PSA Crypto API specification](https://armmbed.github.io/mbed-crypto/html/overview/conventions.html) which take precedence in case of conflicts.
239+
This section applies fully to classic `mbedtls_xxx()` APIs and mostly to the newer `psa_xxx()` APIs. PSA have their own [conventions described in the PSA Crypto API specification](https://arm-software.github.io/psa-api/crypto/1.1/overview/conventions.html) which take precedence in case of conflicts.
240240

241241
### Module contexts
242242

@@ -258,7 +258,7 @@ Most functions should return `int`, more specifically `0` on success (the operat
258258
259259
* Functions that can never fail should either return `void` (such as `mbedtls_cipher_init()`) or directly the information requested (such as `mbedtls_mpi_get_bit()`).
260260
* Functions that look up some information should return either a pointer to this information or `NULL` if it wasn't found.
261-
* PSA functions that can fail return a [`psa_status_t` value](https://armmbed.github.io/mbed-crypto/html/overview/conventions.html#return-status).
261+
* PSA functions that can fail return a [`psa_status_t` value](https://arm-software.github.io/psa-api/crypto/1.1/overview/conventions.html#return-status).
262262
* Some functions may multiplex the return value, such as `mbedtls_asn1_write_len()` returns the length written on success or a negative error code. This mimics the behavior of some standard functions such as `write()` and `read()`, except there is no equivalent to `errno`: the return code should be specific enough.
263263
* Some internal functions may return `-1` on errors rather than a specific error code; it is then up to the calling function to pick a more appropriate error code if the error is to be propagated back to the user.
264264
* Functions whose name clearly indicates a boolean (such as, the name contains "has", "is" or "can") should return `0` for false and `1` for true. The name must be clear: for example, `mbdtls_has_foobar_support()` will return `1` if support for foobar is present; by contrast, `mbedtls_check_foobar_support()` will return `0` if support for foobar is present (success) and `-1` or a more specific error code if not. All functions named `check` must follow this rule and return `0` to indicate acceptable/valid/present/etc. Preference should generally be given to `check` names in order to avoid a mixture of `== 0` and `!= 0` tests.

project/roadmap.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,10 @@ If you are interested in collaborating on any of the roadmap features or other f
3030
* [PSA Crypto] [Extended PSA Crypto v1.0 spec compliance](https://github.com/orgs/Mbed-TLS/projects/1#column-17950134)
3131
* [Mbed TLS] [TLS1.3 Continued](https://github.com/orgs/Mbed-TLS/projects/1#column-17950144)
3232
* [PSA Crypto][PSA Secure Element, Crypto Accelerator Support Enhancements](https://github.com/orgs/Mbed-TLS/projects/1#column-17950148)
33-
* [Raw Public Key Mode](https://github.com/ARMmbed/mbedtls/pull/336)
33+
* [Raw Public Key Mode](https://github.com/Mbed-TLS/mbedtls/pull/3552)
3434
* [EdDSA](https://github.com/orgs/Mbed-TLS/projects/1#column-17950143)
3535
* [PSA Crypto] SHA3
36-
* [Mbed TLS][Performance Optimization - ECP and Bignum](https://github.com/orgs/Mbed-TLS/projects/1#column-17950164)
37-
* [Publish Threat Model](https://github.com/orgs/ARMmbed/projects/18#column-15836340)
36+
* [Mbed TLS] Performance Optimization - ECP and Bignum
3837
* [PSA Crypto] Clean up and Stabilization
3938
* DTLS1.3
4039
* [Mbed TLS] [PKCS7 Generation](<https://github.com/Mbed-TLS/mbedtls/pull/3970>)
@@ -45,6 +44,7 @@ If you are interested in collaborating on any of the roadmap features or other f
4544
* [PSA Crypto] [Memory Optimizations (code size)](<https://github.com/orgs/Mbed-TLS/projects/1#column-19417159>)
4645
* [Mbed TLS] [Mbed TLS3.5 Release](<https://github.com/orgs/Mbed-TLS/projects/1#column-19402885>)
4746
* [PSA Crypto] [Publish PSA Crypto prototype repository](<https://github.com/orgs/Mbed-TLS/projects/1#column-19564389>)
47+
* [Mbed TLS] Publish Threat Model
4848
* [Mbed TLS] [Code size optimisation (driver only build - hashes inc. HMAC)](https://github.com/orgs/Mbed-TLS/projects/1#column-19083975)
4949
* [Mbed TLS] [PKCS7 Parser](https://github.com/orgs/Mbed-TLS/projects/1#column-17950135)
5050
* [PSA Crypto] [PSA Crypto restartable sign message](https://github.com/orgs/Mbed-TLS/projects/1#column-18883250)
@@ -55,19 +55,19 @@ If you are interested in collaborating on any of the roadmap features or other f
5555
* [Mbed TLS] [TLS1.3 PSK](https://github.com/orgs/Mbed-TLS/projects/1#column-17950145)
5656
* [Mbed TLS] [Mbed TLS3.2](https://github.com/orgs/Mbed-TLS/projects/1#column-18338314)
5757
* [Mbed TLS] [TLS1.3 server side](https://github.com/orgs/Mbed-TLS/projects/1#column-17950131)
58-
* [Mbed TLS] [TLS1.3 MVP](https://github.com/orgs/ARMmbed/projects/18#column-15836288)
59-
* [Mbed TLS] [TLS/X.509​ - Use PSA Crypto APIs Fully​ - Phase1](https://github.com/orgs/ARMmbed/projects/18#column-15836318)
60-
* [Mbed TLS] [SHA256/512 - Neon Optimization](https://github.com/orgs/ARMmbed/projects/18#column-16274498)
61-
* [Mbed TLS] [New 2.x LTS](https://github.com/orgs/ARMmbed/projects/18#column-15836286)
62-
* [PSA Crypto] [Support Missing PSA Crypto v1.0 APIs supported in MbedCrypto](https://github.com/orgs/ARMmbed/projects/18#column-15836299)
58+
* [Mbed TLS] TLS1.3 MVP
59+
* [Mbed TLS] TLS/X.509​ - Use PSA Crypto APIs Fully​ - Phase1
60+
* [Mbed TLS] SHA256/512 - Neon Optimization
61+
* [Mbed TLS] New 2.x LTS
62+
* [PSA Crypto] Support Missing PSA Crypto v1.0 APIs supported in MbedCrypto
6363
* [PSA Crypto]​ M-AEAD Implementation
6464
* [PSA Crypto]​ EdDSA API Design
6565
* [PSA Crypto]​ PBKDF2 API Design
6666
* [PSA Crypto]​ ECJPAKE API Design ​
6767
* DTLS-SRTP
6868
* Lucky13 Security Improvements
69-
* [PSA Crypto] [PSA Crypto API implementation v1.0 Specification - Phase1](https://github.com/orgs/ARMmbed/projects/18#column-15836285)
70-
* [Unified PSA Driver Interface](https://github.com/orgs/ARMmbed/projects/18#column-15836331) - API Design and initial support
69+
* [PSA Crypto] PSA Crypto API implementation v1.0 Specification - Phase1
70+
* Unified PSA Driver Interface - API Design and initial support
7171
* [PSA Crypto] PSA driver – Handle Opaque Persistent Key in Secure Element - [Design](<https://github.com/Mbed-TLS/mbedtls/blob/development/docs/architecture/psa-storage-resilience.md>)
7272
* [Mbed TLS] [Use PSA: misc. gaps](https://github.com/orgs/Mbed-TLS/projects/1#column-18337954)
7373
* [Bignum] [ECP Curves field reduction - NIST](https://github.com/orgs/Mbed-TLS/projects/1#column-17950163)

redirects.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,17 @@
77

88
- type: sphinx_htmldir
99

10+
- type: page
11+
from_url: /tech-updates/security-advisories/
12+
to_url: /security-advisories/
13+
1014
- type: page
1115
from_url: /security-advisories/security-advisories/
12-
to_url: /tech-updates/security-advisories/
16+
to_url: /security-advisories/
1317

1418
- type: exact
1519
from_url: /en/latest/security-advisories/advisories/$rest
16-
to_url: /en/latest/tech-updates/security-advisories/
20+
to_url: /en/latest/security-advisories/
1721

1822
- type: page
1923
from_url: /roadmap/

tech-updates/security-advisories/index.md renamed to security-advisories/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# Tech Updates / Security Advisories
2-
3-
## Advisories
1+
# Security Advisories
42

53
```{toctree}
64
---

0 commit comments

Comments
 (0)