mirror of
https://github.com/Mbed-TLS/mbedtls.git
synced 2025-01-31 00:32:50 +00:00
1ae9f756ba
This commit adds an MPS-specific compile-time option `MBEDTLS_MPS_TRACE` to the internal MPS header `mps/common.h`. So far -- this may need revisiting -- MPS comes with its own internal tracing module which allows to track the operation of MPS' various layers for the purpose of understanding of it workings as well as for debugging. The reasons for the introduction of a module separate from SSL debug are the following: 1) The SSL debug module requires an SSL context to function because debug callbacks are part of the runtime configuration of the SSL module. The MPS tracing module, in contrast, is not supposed to be used in production environments, and there is no need for a runtime configuration. Instead, a compile-time defined tracing callback is used. 2) In the interest of modularity, MPS' tracing module shouldn't require having an SSL context around. 3) Purely visually, MPS' tracing module adds support for indentation according to call-depth and coloring according to which module is being used, which makes it very useful for what's going on; however, those features aren't available in the SSL debug module (and they shouldn't be). Signed-off-by: Hanno Becker <hanno.becker@arm.com>
56 lines
1.6 KiB
C
56 lines
1.6 KiB
C
/*
|
|
* Copyright The Mbed TLS Contributors
|
|
* 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)
|
|
*/
|
|
|
|
/**
|
|
* \file common.h
|
|
*
|
|
* \brief Common functions and macros used by MPS
|
|
*/
|
|
|
|
#ifndef MBEDTLS_MPS_COMMON_H
|
|
#define MBEDTLS_MPS_COMMON_H
|
|
|
|
/**
|
|
* \name SECTION: MPS Configuration
|
|
*
|
|
* \{
|
|
*/
|
|
|
|
/*! This flag enables/disables assertions on the internal state of MPS.
|
|
*
|
|
* Assertions are sanity checks that should never trigger when MPS
|
|
* is used within the bounds of its API and preconditions.
|
|
*
|
|
* Enabling this increases security by limiting the scope of
|
|
* potential bugs, but comes at the cost of increased code size.
|
|
*
|
|
* Note: So far, there is no guiding principle as to what
|
|
* expected conditions merit an assertion, and which don't.
|
|
*
|
|
* Comment this to disable assertions.
|
|
*/
|
|
#define MBEDTLS_MPS_ENABLE_ASSERTIONS
|
|
|
|
/*! This flag controls whether tracing for MPS should be enabled. */
|
|
#define MBEDTLS_MPS_TRACE
|
|
|
|
/* \} name SECTION: MPS Configuration */
|
|
|
|
#endif /* MBEDTLS_MPS_COMMON_H */
|