mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2024-11-26 07:55:43 +01:00
825ebd483f
Conflicts:
mbedtls.doxyfile - PROJECT_NAME - mbed TLS v2.16.6 chosen.
doc_mainpage.h - mbed TLS v2.16.6 version chosen.
hmac_drbg.h - line 260, extended description chosen.
- line 313, extended description chosen.
- line 338, extended description chosen.
version.h - 2.16.6 chosen.
CMakeLists.txt - 2.16.6 chosen.
test_suite_version.data - 2.16.6 chosen.
Makefile - 141 - manual correction - baremetal version of C_SOURCE_FILES
with variables for directories plus 2.16.6 CTAGS addition.
pkparse.c - lines 846 onwards - the asn1_get_nonzero_mpi implementation chosen.
ssl_tls.c - line 5269 - edited manually, left the ret=0, because baremetal has
a different behaviour since commit 87b5626, but added a debug
message that's new in 2.16.6.
all.sh:
- component_build_deprecated - chosen the refactored version from 2.16.6,
but with extra flags from baremetal.
- rest of the _no_xxx tests - merged make options to have PTHREAD=1 and
other changes from 2.16.6 (like -O1 instead of -O0).
- component_build_arm_none_eabi_gcc_no_64bit_multiplication - added
TINYCRYPT_BUILD=0 to the 2.16.6 version of make.
x509/req_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
x509/crl_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
x509/cert_app.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_mail_client.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_pthread_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl/ssl_fork_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_client1.c - line 54 - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_client2.c - line 54 - left baremetal log but with mbedtls_exit( 0 ) call.
- line 132 - new options of both branches added.
- skip close notify handled as in 2.16.6, but with `ssl` instead of `&ssl`.
- Merged the 2.16.6 usage split with additional baremetal usages.
- Merged options from baremetal and 2.16.6.
ssl_server.c - left baremetal log but with mbedtls_exit( 0 ) call.
ssl_server2.c - Merged the 2.16.6 usage split with additional baremetal usages.
config.pl - fixed missing defines from the documentation, removed duplicates,
and reorganised so that the documentation and excluded list
are ordered in the same way.
test_suite_x509parse.data - only added the two new pathlen tests.
x509_crt.c - change the return code by removing
MBEDTLS_ERR_X509_INVALID_EXTENSIONS, since it's added by
x509_crt_frame_parse_ext not by an "or", but by "+=".
Changelog - Assigned all entries to appropriate sections.
ssl-opt.sh - line 8263 - merged options.
- removed lines 1165 - 1176 - there was a duplicate test, probably
an artifact of previous merges.
check-files.py - sticked to old formatting.
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
97 lines
3.6 KiB
C
97 lines
3.6 KiB
C
/**
|
|
* \file doc_mainpage.h
|
|
*
|
|
* \brief Main page documentation file.
|
|
*/
|
|
/*
|
|
*
|
|
* Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
* This file is part of mbed TLS (https://tls.mbed.org)
|
|
*/
|
|
|
|
/**
|
|
* @mainpage mbed TLS v2.16.6 source code documentation
|
|
*
|
|
* This documentation describes the internal structure of mbed TLS. It was
|
|
* automatically generated from specially formatted comment blocks in
|
|
* mbed TLS's source code using Doxygen. (See
|
|
* http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen)
|
|
*
|
|
* mbed TLS has a simple setup: it provides the ingredients for an SSL/TLS
|
|
* implementation. These ingredients are listed as modules in the
|
|
* \ref mainpage_modules "Modules section". This "Modules section" introduces
|
|
* the high-level module concepts used throughout this documentation.\n
|
|
* Some examples of mbed TLS usage can be found in the \ref mainpage_examples
|
|
* "Examples section".
|
|
*
|
|
* @section mainpage_modules Modules
|
|
*
|
|
* mbed TLS supports SSLv3 up to TLSv1.2 communication by providing the
|
|
* following:
|
|
* - TCP/IP communication functions: listen, connect, accept, read/write.
|
|
* - SSL/TLS communication functions: init, handshake, read/write.
|
|
* - X.509 functions: CRT, CRL and key handling
|
|
* - Random number generation
|
|
* - Hashing
|
|
* - Encryption/decryption
|
|
*
|
|
* Above functions are split up neatly into logical interfaces. These can be
|
|
* used separately to provide any of the above functions or to mix-and-match
|
|
* into an SSL server/client solution that utilises a X.509 PKI. Examples of
|
|
* such implementations are amply provided with the source code.
|
|
*
|
|
* Note that mbed TLS does not provide a control channel or (multiple) session
|
|
* handling without additional work from the developer.
|
|
*
|
|
* @section mainpage_examples Examples
|
|
*
|
|
* Example server setup:
|
|
*
|
|
* \b Prerequisites:
|
|
* - X.509 certificate and private key
|
|
* - session handling functions
|
|
*
|
|
* \b Setup:
|
|
* - Load your certificate and your private RSA key (X.509 interface)
|
|
* - Setup the listening TCP socket (TCP/IP interface)
|
|
* - Accept incoming client connection (TCP/IP interface)
|
|
* - Initialise as an SSL-server (SSL/TLS interface)
|
|
* - Set parameters, e.g. authentication, ciphers, CA-chain, key exchange
|
|
* - Set callback functions RNG, IO, session handling
|
|
* - Perform an SSL-handshake (SSL/TLS interface)
|
|
* - Read/write data (SSL/TLS interface)
|
|
* - Close and cleanup (all interfaces)
|
|
*
|
|
* Example client setup:
|
|
*
|
|
* \b Prerequisites:
|
|
* - X.509 certificate and private key
|
|
* - X.509 trusted CA certificates
|
|
*
|
|
* \b Setup:
|
|
* - Load the trusted CA certificates (X.509 interface)
|
|
* - Load your certificate and your private RSA key (X.509 interface)
|
|
* - Setup a TCP/IP connection (TCP/IP interface)
|
|
* - Initialise as an SSL-client (SSL/TLS interface)
|
|
* - Set parameters, e.g. authentication mode, ciphers, CA-chain, session
|
|
* - Set callback functions RNG, IO
|
|
* - Perform an SSL-handshake (SSL/TLS interface)
|
|
* - Verify the server certificate (SSL/TLS interface)
|
|
* - Write/read data (SSL/TLS interface)
|
|
* - Close and cleanup (all interfaces)
|
|
*/
|