Skip to content

Commit 18cf194

Browse files
dreemkillerdreemkiller
authored
Merge pull request #956 from kegilbert/dreemkiller-patch-1
Add configuration parameters list to TLS config page
2 parents 3665422 + 333ce00 commit 18cf194

File tree

1 file changed

+130
-0
lines changed
  • docs/reference/configuration

1 file changed

+130
-0
lines changed

‎docs/reference/configuration/TLS.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,136 @@ When configuring MbedTLS on Mbed OS, developers should add the Mbed TLS ciphersu
4242
"mbedtls.ecdhe-ecdsa-with-aes-128-gcm-sha256": 1
4343
```
4444
in their `target_overrides` section. Developer should include as many ciphersuites as they deem necessary, keeping in mind that the more they add, the larger the binary footprint of MbedTLS will be on their device.
45+
46+
### Configuration Paramaters
47+
48+
The following list can be found locally by running `mbed compile --config -v --prefix mbedtls`.
49+
50+
```
51+
Configuration parameters
52+
------------------------
53+
Name: mbedtls.app-config-file
54+
Description: Use an application provided config file instead of any other MBEDTLS configuration options
55+
Defined by: library:mbedtls
56+
No value set
57+
Name: mbedtls.ecdh-ecdsa-with-aes-128-cbc-sha256
58+
Description: Include support for the TLS-ECDH-ECDSA-WITH-AES-128-CBC-SHA256 ciphersuite
59+
Defined by: library:mbedtls
60+
No value set
61+
Name: mbedtls.ecdh-ecdsa-with-aes-128-gcm-sha256
62+
Description: Include support for the TLS-ECDH-ECDSA-WITH-AES-128-GCM-SHA256 ciphersuite
63+
Defined by: library:mbedtls
64+
No value set
65+
Name: mbedtls.ecdh-ecdsa-with-aes-256-cbc-sha384
66+
Description: Include support for the TLS-ECDH-ECDSA-WITH-AES-256-CBC-SHA384 ciphersuite
67+
Defined by: library:mbedtls
68+
No value set
69+
Name: mbedtls.ecdh-ecdsa-with-aes-256-gcm-sha384
70+
Description: Include support for the TLS-ECDH-ECDSA-WITH-AES-256-GCM-SHA384 ciphersuite
71+
Defined by: library:mbedtls
72+
No value set
73+
Name: mbedtls.ecdh-rsa-with-aes-128-cbc-sha256
74+
Description: Include support for TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256 ciphersuite
75+
Defined by: library:mbedtls
76+
No value set
77+
Name: mbedtls.ecdh-rsa-with-aes-128-gcm-sha256
78+
Description: Include support for the TLS-ECDH-RSA-WITH-AES-128-GCM-SHA256 ciphersuite
79+
Defined by: library:mbedtls
80+
No value set
81+
Name: mbedtls.ecdh-rsa-with-aes-256-cbc-sha384
82+
Description: Include support for the TLS-ECDH-RSA-WITH-AES-256-CBC-SHA384 ciphersuite
83+
Defined by: library:mbedtls
84+
No value set
85+
Name: mbedtls.ecdh-rsa-with-aes-256-gcm-sha384
86+
Description: Include support for the TLS-ECDH-RSA-WITH-AES-256-GCM-SHA384 ciphersuite
87+
Defined by: library:mbedtls
88+
No value set
89+
Name: mbedtls.ecdhe-ecdsa-with-aes-128-cbc-sha256
90+
Description: Include support for the TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256 ciphersuite
91+
Defined by: library:mbedtls
92+
No value set
93+
Name: mbedtls.ecdhe-ecdsa-with-aes-128-gcm-sha256
94+
Description: Include support for the TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256 ciphersuites
95+
Defined by: library:mbedtls
96+
Macro name: MBED_CONF_MBEDTLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
97+
Value: 1 (set by library:mbedtls)
98+
Name: mbedtls.ecdhe-ecdsa-with-aes-256-cbc-sha384
99+
Description: Include support for the TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384 ciphersuite
100+
Defined by: library:mbedtls
101+
No value set
102+
Name: mbedtls.ecdhe-ecdsa-with-aes-256-gcm-sha384
103+
Description: Include support for the TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384 ciphersuite
104+
Defined by: library:mbedtls
105+
Macro name: MBED_CONF_MBEDTLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
106+
Value: 1 (set by library:mbedtls)
107+
Name: mbedtls.ecdhe-ecdsa-with-aes-ccm
108+
Description: Include support for the TLS-ECDHE-ECDSA-WITH-AES-*-CCM* ciphersuites
109+
Defined by: library:mbedtls
110+
No value set
111+
Name: mbedtls.ecdhe-rsa-with-aes-128-cbc-sha256
112+
Description: Include support for the TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256 ciphersuite
113+
Defined by: library:mbedtls
114+
No value set
115+
Name: mbedtls.ecdhe-rsa-with-aes-128-gcm-sha256
116+
Description: Include support for TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256 ciphersuite
117+
Defined by: library:mbedtls
118+
No value set
119+
Name: mbedtls.ecdhe-rsa-with-aes-256-cbc-sha384
120+
Description: Include support for the TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384 ciphersuite
121+
Defined by: library:mbedtls
122+
Macro name: MBED_CONF_MBEDTLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
123+
Value: 1 (set by library:mbedtls)
124+
Name: mbedtls.ecdhe-rsa-with-aes-256-gcm-sha384
125+
Description: Include support for the TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384 ciphersuite
126+
Defined by: library:mbedtls
127+
No value set
128+
Name: mbedtls.pelion-client
129+
Description: Include support needed to connect to Pelion Cloud
130+
Defined by: library:mbedtls
131+
Macro name: MBED_CONF_MBEDTLS_PELION_CLIENT
132+
Value: 1 (set by library:mbedtls)
133+
Name: mbedtls.pelion-mini-client
134+
Description: Include support needed to connect to Pelion Cloud as a mini client
135+
Defined by: library:mbedtls
136+
No value set
137+
Name: mbedtls.psk-with-aes-128-cbc-sha256
138+
Description: Include support for the TLS-PSK-WITH-AES-128-CBC-SHA256 ciphersuite
139+
Defined by: library:mbedtls
140+
No value set
141+
Name: mbedtls.psk-with-aes-128-gcm-sha256
142+
Description: Include support for the TLS-PSK-WITH-AES-128-GCM-SHA256 ciphersuite
143+
Defined by: library:mbedtls
144+
No value set
145+
Name: mbedtls.psk-with-aes-256-cbc-sha384
146+
Description: Include support for the TLS-PSK-WITH-AES-256-CBC-SHA384 ciphersuite
147+
Defined by: library:mbedtls
148+
No value set
149+
Name: mbedtls.psk-with-aes-256-gcm-sha384
150+
Description: Include support for the TLS-PSK-WITH-AES-256-GCM-SHA384 ciphersuite
151+
Defined by: library:mbedtls
152+
No value set
153+
Name: mbedtls.psk-with-aes-ccm
154+
Description: Include support for the TLS-PSK-WITH-AES-*-CCM* ciphersuites
155+
Defined by: library:mbedtls
156+
No value set
157+
Name: mbedtls.rsa-with-aes-128-cbc-sha256
158+
Description: Include support for the TLS-RSA-WITH-AES-128-CBC-SHA256 cipersuite
159+
Defined by: library:mbedtls
160+
No value set
161+
Name: mbedtls.rsa-with-aes-128-gcm-sha256
162+
Description: Include support for the TLS-RSA-WITH-AES-128-GCM-SHA256 ciphersuite
163+
Defined by: library:mbedtls
164+
No value set
165+
Name: mbedtls.rsa-with-aes-256-cbc-sha256
166+
Description: Include support for the TLS-RSA-WITH-AES-256-CBC-SHA256 cipersuite
167+
Defined by: library:mbedtls
168+
No value set
169+
Name: mbedtls.rsa-with-aes-256-gcm-sha384
170+
Description: Include support for the TLS-RSA-WITH-AES-256-GCM-SHA384 ciphersuite
171+
Defined by: library:mbedtls
172+
No value set
173+
```
174+
45175
### Pelion Client
46176
As a shortcut, the configuration system supports an option, `mbedtls.pelion-client`, that enables the ciphersuites required by the Pelion Cloud Service. To allow a device to connect to Pelion, developers need only enable this option.
47177

0 commit comments

Comments
 (0)