Rename to mbed TLS in the documentation/comments

parent 967a2a5f
......@@ -19,7 +19,7 @@ addons:
coverity_scan:
project:
name: "polarssl/polarssl"
description: "PolarSSL Open Source SSL Library"
description: "mbed TLS Open Source SSL Library"
notification_email: p.j.bakker@polarssl.org
build_command_prepend:
build_command: make
......
Site: localhost
BuildName: PolarSSL-test
BuildName: mbed TLS-test
CoverageCommand: /usr/bin/gcov
MemoryCheckCommand: /usr/bin/valgrind
......@@ -71,7 +71,7 @@ lcov:
lcov --add-tracefile files.info --add-tracefile tests.info -o all.info
lcov --remove all.info -o final.info '*.h'
gendesc tests/Descriptions.txt -o descriptions
genhtml --title PolarSSL --description-file descriptions --keep-descriptions --legend --no-branch-coverage -o Coverage final.info
genhtml --title mbed TLS --description-file descriptions --keep-descriptions --legend --no-branch-coverage -o Coverage final.info
rm -f files.info tests.info all.info final.info descriptions
apidoc:
......
===================
README for PolarSSL
README for mbed TLS
===================
Configuration
=============
PolarSSL should build out of the box on most systems. Some platform specific options are available in the fully-documented configuration file *include/polarssl/config.h*, which is also the place where features can be selected.
mbed TLS should build out of the box on most systems. Some platform specific options are available in the fully-documented configuration file *include/polarssl/config.h*, which is also the place where features can be selected.
This file can be edited manually, or in a more programmatic way using the Perl
script *scripts/config.pl* (use *--help* for usage instructions).
......@@ -14,7 +14,7 @@ Compiler options can be set using standard variables such as *CC* and *CFLAGS* w
Compiling
=========
There are currently three active build systems within the PolarSSL releases:
There are currently three active build systems within the mbed TLS releases:
- Make
- CMake
......@@ -35,7 +35,7 @@ In order to run the tests, enter::
make check
Depending on your platform, you might run into some issues. Please check the Makefiles in *library/*, *programs/* and *tests/* for options to manually add or remove for specific platforms. You can also check `the PolarSSL Knowledge Base <https://polarssl.org/kb>`_ for articles on your platform or issue.
Depending on your platform, you might run into some issues. Please check the Makefiles in *library/*, *programs/* and *tests/* for options to manually add or remove for specific platforms. You can also check `the mbed TLS Knowledge Base <https://polarssl.org/kb>`_ for articles on your platform or issue.
In case you find that you need to do something else as well, please let us know what, so we can add it to the KB.
......@@ -101,7 +101,7 @@ We've included example programs for a lot of different features and uses in *pro
Tests
=====
PolarSSL includes an elaborate test suite in *tests/* that initially requires Perl to generate the tests files (e.g. *test_suite_mpi.c*). These files are generates from a **function file** (e.g. *suites/test_suite_mpi.function*) and a **data file** (e.g. *suites/test_suite_mpi.data*). The **function file** contains the template for each test function. The **data file** contains the test cases, specified as parameters that should be pushed into a template function.
mbed TLS includes an elaborate test suite in *tests/* that initially requires Perl to generate the tests files (e.g. *test_suite_mpi.c*). These files are generates from a **function file** (e.g. *suites/test_suite_mpi.function*) and a **data file** (e.g. *suites/test_suite_mpi.data*). The **function file** contains the template for each test function. The **data file** contains the test cases, specified as parameters that should be pushed into a template function.
For machines with a Unix shell and OpenSSL (and optionnally GnuTLS) installed, additional test scripts are available:
......@@ -129,7 +129,7 @@ Process
#. `Check for open issues <https://github.com/polarssl/polarssl/issues>`_ or
`start a discussion <https://polarssl.org/discussions>`_ around a feature
idea or a bug.
#. Fork the `PolarSSL repository on Github <https://github.com/polarssl/polarssl>`_
#. Fork the `mbed TLS repository on Github <https://github.com/polarssl/polarssl>`_
to start making your changes.
#. Write a test which shows that the bug was fixed or that the feature works
as expected.
......
......@@ -23,4 +23,4 @@ them, you can pick one of the following methods:
make
Note that the second method also works if you want to keep your custom
configuration file outside the PolarSSL tree.
configuration file outside the mbed TLS tree.
......@@ -16,12 +16,12 @@
//#define POLARSSL_HAVE_TIME /* Optionally used in Hello messages */
/* Other POLARSSL_HAVE_XXX flags irrelevant for this configuration */
/* PolarSSL feature support */
/* mbed TLS feature support */
#define POLARSSL_KEY_EXCHANGE_PSK_ENABLED
#define POLARSSL_SSL_PROTO_TLS1_2
#define POLARSSL_SSL_DISABLE_RENEGOTIATION
/* PolarSSL modules */
/* mbed TLS modules */
#define POLARSSL_AES_C
#define POLARSSL_CCM_C
#define POLARSSL_CIPHER_C
......
......@@ -13,14 +13,14 @@
#define POLARSSL_HAVE_TIME
#define POLARSSL_HAVE_IPV6
/* PolarSSL feature support */
/* mbed TLS feature support */
#define POLARSSL_CIPHER_MODE_CBC
#define POLARSSL_PKCS1_V15
#define POLARSSL_KEY_EXCHANGE_RSA_ENABLED
#define POLARSSL_SSL_PROTO_TLS1_1
#define POLARSSL_SSL_DISABLE_RENEGOTIATION
/* PolarSSL modules */
/* mbed TLS modules */
#define POLARSSL_AES_C
#define POLARSSL_ASN1_PARSE_C
#define POLARSSL_ASN1_WRITE_C
......
......@@ -18,7 +18,7 @@
#define POLARSSL_HAVE_TIME
#define POLARSSL_HAVE_IPV6
/* PolarSSL feature support */
/* mbed TLS feature support */
#define POLARSSL_CIPHER_MODE_CBC
#define POLARSSL_CIPHER_PADDING_PKCS7
#define POLARSSL_ECP_DP_SECP256K1_ENABLED
......@@ -27,7 +27,7 @@
#define POLARSSL_ERROR_STRERROR_DUMMY
#define POLARSSL_FS_IO
/* PolarSSL modules */
/* mbed TLS modules */
#define POLARSSL_AESNI_C
#define POLARSSL_AES_C
#define POLARSSL_ASN1_PARSE_C
......
......@@ -16,12 +16,12 @@
//#define POLARSSL_HAVE_TIME /* Optionnaly used in Hello messages */
/* Other POLARSSL_HAVE_XXX flags irrelevant for this configuration */
/* PolarSSL feature support */
/* mbed TLS feature support */
#define POLARSSL_KEY_EXCHANGE_PSK_ENABLED
#define POLARSSL_SSL_PROTO_TLS1
#define POLARSSL_SSL_DISABLE_RENEGOTIATION
/* PolarSSL modules */
/* mbed TLS modules */
#define POLARSSL_AES_C
#define POLARSSL_ARC4_C
#define POLARSSL_CIPHER_C
......
......@@ -20,14 +20,14 @@
#define POLARSSL_HAVE_TIME
#define POLARSSL_HAVE_IPV6
/* PolarSSL feature support */
/* mbed TLS feature support */
#define POLARSSL_ECP_DP_SECP256R1_ENABLED
#define POLARSSL_ECP_DP_SECP384R1_ENABLED
#define POLARSSL_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
#define POLARSSL_SSL_PROTO_TLS1_2
#define POLARSSL_SSL_DISABLE_RENEGOTIATION
/* PolarSSL modules */
/* mbed TLS modules */
#define POLARSSL_AES_C
#define POLARSSL_ASN1_PARSE_C
#define POLARSSL_ASN1_WRITE_C
......
......@@ -4,23 +4,23 @@
*/
/**
* @mainpage PolarSSL v1.3.9 source code documentation
* @mainpage mbed TLS v1.3.9 source code documentation
*
* This documentation describes the internal structure of PolarSSL. It was
* This documentation describes the internal structure of mbed TLS. It was
* automatically generated from specially formatted comment blocks in
* PolarSSL's source code using Doxygen. (See
* mbed TLS's source code using Doxygen. (See
* http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen)
*
* PolarSSL has a simple setup: it provides the ingredients for an SSL/TLS
* 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 PolarSSL usage can be found in the \ref mainpage_examples
* Some examples of mbed TLS usage can be found in the \ref mainpage_examples
* "Examples section".
*
* @section mainpage_modules Modules
*
* PolarSSL supports SSLv3 up to TLSv1.2 communication by providing the
* 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.
......@@ -34,7 +34,7 @@
* 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 PolarSSL does not provide a control channel or (multiple) session
* Note that mbed TLS does not provide a control channel or (multiple) session
* handling without additional work from the developer.
*
* @section mainpage_examples Examples
......
......@@ -28,7 +28,7 @@ DOXYFILE_ENCODING = UTF-8
# identify the project. Note that if you do not use Doxywizard you need
# to put quotes around the project name if it contains spaces.
PROJECT_NAME = "PolarSSL v1.3.9"
PROJECT_NAME = "mbed TLS v1.3.9"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
......
......@@ -119,7 +119,7 @@
*
* Enable the memory allocation layer.
*
* By default PolarSSL uses the system-provided malloc() and free().
* By default mbed TLS uses the system-provided malloc() and free().
* This allows different allocators (self-implemented or provided) to be
* provided to the platform abstraction layer.
*
......@@ -153,10 +153,10 @@
/**
* \def POLARSSL_PLATFORM_XXX_ALT
*
* Uncomment a macro to let PolarSSL support the function in the platform
* Uncomment a macro to let mbed TLS support the function in the platform
* abstraction layer.
*
* Example: In case you uncomment POLARSSL_PLATFORM_PRINTF_ALT, PolarSSL will
* Example: In case you uncomment POLARSSL_PLATFORM_PRINTF_ALT, mbed TLS will
* provide a function "platform_set_printf()" that allows you to set an
* alternative printf function pointer.
*
......@@ -170,7 +170,7 @@
/* \} name SECTION: System support */
/**
* \name SECTION: PolarSSL feature support
* \name SECTION: mbed TLS feature support
*
* This section sets support for features that are or are not needed
* within the modules that are enabled.
......@@ -193,12 +193,12 @@
/**
* \def POLARSSL_XXX_ALT
*
* Uncomment a macro to let PolarSSL use your alternate core implementation of
* Uncomment a macro to let mbed TLS use your alternate core implementation of
* a symmetric or hash algorithm (e.g. platform specific assembly optimized
* implementations). Keep in mind that the function prototypes should remain
* the same.
*
* Example: In case you uncomment POLARSSL_AES_ALT, PolarSSL will no longer
* Example: In case you uncomment POLARSSL_AES_ALT, mbed TLS will no longer
* provide the "struct aes_context" definition and omit the base function
* declarations and implementations. "aes_alt.h" will be included from
* "aes.h" to include the new function definitions.
......@@ -797,7 +797,7 @@
* \def POLARSSL_SSL_ALL_ALERT_MESSAGES
*
* Enable sending of alert messages in case of encountered errors as per RFC.
* If you choose not to send the alert messages, PolarSSL can still communicate
* If you choose not to send the alert messages, mbed TLS can still communicate
* with other servers, only debugging of failures is harder.
*
* The advantage of not sending alert messages, is that no information is given
......@@ -1158,12 +1158,12 @@
* Uncomment to enable use of ZLIB
*/
//#define POLARSSL_ZLIB_SUPPORT
/* \} name SECTION: PolarSSL feature support */
/* \} name SECTION: mbed TLS feature support */
/**
* \name SECTION: PolarSSL modules
* \name SECTION: mbed TLS modules
*
* This section enables or disables entire modules in PolarSSL
* This section enables or disables entire modules in mbed TLS
* \{
*/
......@@ -1695,7 +1695,7 @@
* Module: library/memory_buffer_alloc.c
*
* Requires: POLARSSL_PLATFORM_C
* POLARSSL_PLATFORM_MEMORY (to use it within PolarSSL)
* POLARSSL_PLATFORM_MEMORY (to use it within mbed TLS)
*
* Enable this module to enable the buffer memory allocator.
*/
......@@ -2038,7 +2038,7 @@
* \def POLARSSL_THREADING_C
*
* Enable the threading abstraction layer.
* By default PolarSSL assumes it is used in a non-threaded environment or that
* By default mbed TLS assumes it is used in a non-threaded environment or that
* contexts are not shared between threads. If you do intend to use contexts
* between threads, you will need to enable this layer to prevent race
* conditions.
......@@ -2051,7 +2051,7 @@
* You will have to enable either POLARSSL_THREADING_ALT or
* POLARSSL_THREADING_PTHREAD.
*
* Enable this layer to allow use of mutexes within PolarSSL
* Enable this layer to allow use of mutexes within mbed TLS
*/
//#define POLARSSL_THREADING_C
......@@ -2188,7 +2188,7 @@
*/
#define POLARSSL_XTEA_C
/* \} name SECTION: PolarSSL modules */
/* \} name SECTION: mbed TLS modules */
/**
* \name SECTION: Module configuration options
......
......@@ -102,7 +102,7 @@ extern "C" {
#endif
/**
* \brief Translate a PolarSSL error code into a string representation,
* \brief Translate a mbed TLS error code into a string representation,
* Result is truncated if necessary and always includes a terminating
* null byte.
*
......
......@@ -60,7 +60,7 @@ extern "C" {
* \param key_length Length of generated key
* \param output Generated key. Must be at least as big as key_length
*
* \returns 0 on success, or a PolarSSL error code if verification fails.
* \returns 0 on success, or a POLARSSL_ERR_xxx code if verification fails.
*/
int pbkdf2_hmac( md_context_t *ctx, const unsigned char *password,
size_t plen, const unsigned char *salt, size_t slen,
......
......@@ -62,7 +62,7 @@ typedef struct {
} pkcs11_context;
/**
* Fill in a PolarSSL certificate, based on the given PKCS11 helper certificate.
* Fill in a mbed TLS certificate, based on the given PKCS11 helper certificate.
*
* \param cert X.509 certificate to fill
* \param pkcs11h_cert PKCS #11 helper certificate
......
......@@ -61,7 +61,7 @@ extern "C" {
* \param len data length
* \param output the output buffer
*
* \return 0 if successful, or a PolarSSL error code
* \return 0 if successful, or a POLARSSL_ERR_xxx code
*/
int pkcs12_pbe_sha1_rc4_128( asn1_buf *pbe_params, int mode,
const unsigned char *pwd, size_t pwdlen,
......@@ -82,7 +82,7 @@ int pkcs12_pbe_sha1_rc4_128( asn1_buf *pbe_params, int mode,
* \param len data length
* \param output the output buffer
*
* \return 0 if successful, or a PolarSSL error code
* \return 0 if successful, or a POLARSSL_ERR_xxx code
*/
int pkcs12_pbe( asn1_buf *pbe_params, int mode,
cipher_type_t cipher_type, md_type_t md_type,
......
......@@ -64,7 +64,7 @@ extern "C" {
* \param datalen length of data
* \param output output buffer
*
* \returns 0 on success, or a PolarSSL error code if verification fails.
* \returns 0 on success, or a POLARSSL_ERR_xxx code if verification fails.
*/
int pkcs5_pbes2( asn1_buf *pbe_params, int mode,
const unsigned char *pwd, size_t pwdlen,
......@@ -83,7 +83,7 @@ int pkcs5_pbes2( asn1_buf *pbe_params, int mode,
* \param key_length Length of generated key
* \param output Generated key. Must be at least as big as key_length
*
* \returns 0 on success, or a PolarSSL error code if verification fails.
* \returns 0 on success, or a POLARSSL_ERR_xxx code if verification fails.
*/
int pkcs5_pbkdf2_hmac( md_context_t *ctx, const unsigned char *password,
size_t plen, const unsigned char *salt, size_t slen,
......
/**
* \file platform.h
*
* \brief PolarSSL Platform abstraction layer
* \brief mbed TLS Platform abstraction layer
*
* Copyright (C) 2006-2014, Brainspark B.V.
*
......
......@@ -1157,8 +1157,8 @@ int ssl_set_session( ssl_context *ssl, const ssl_session *session );
* order. First in the list has the highest preference.
* (Overrides all version specific lists)
*
* Note: The PolarSSL SSL server uses its own preferences
* over the preference of the connection SSL client unless
* Note: The server uses its own preferences
* over the preference of the client unless
* POLARSSL_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
*
* \param ssl SSL context
......@@ -1238,7 +1238,7 @@ int ssl_set_own_cert_rsa( ssl_context *ssl, x509_crt *own_cert,
#endif /* POLARSSL_RSA_C */
/**
* \brief Set own certificate and alternate non-PolarSSL RSA private
* \brief Set own certificate and external RSA private
* key and handling callbacks, such as the PKCS#11 wrappers
* or any other external private key handler.
* (see the respective RSA functions in rsa.h for documentation
......
/**
* \file ssl_ciphersuites.h
*
* \brief SSL Ciphersuites for PolarSSL
* \brief SSL Ciphersuites for mbed TLS
*
* Copyright (C) 2006-2013, Brainspark B.V.
*
......
......@@ -26,7 +26,7 @@
*/
/*
* This set of compile-time defines and run-time variables can be used to
* determine the version number of the PolarSSL library used.
* determine the version number of the mbed TLS library used.
*/
#ifndef POLARSSL_VERSION_H
#define POLARSSL_VERSION_H
......@@ -52,7 +52,7 @@
*/
#define POLARSSL_VERSION_NUMBER 0x01030900
#define POLARSSL_VERSION_STRING "1.3.9"
#define POLARSSL_VERSION_STRING_FULL "PolarSSL 1.3.9"
#define POLARSSL_VERSION_STRING_FULL "mbed TLS 1.3.9"
#if defined(POLARSSL_VERSION_C)
......@@ -77,9 +77,9 @@ unsigned int version_get_number( void );
void version_get_string( char *string );
/**
* Get the full version string ("PolarSSL x.y.z").
* Get the full version string ("mbed TLS x.y.z").
*
* \param string The string that will receive the value. The PolarSSL version
* \param string The string that will receive the value. The mbed TLS version
* string will use 18 bytes AT MOST including a terminating
* null byte.
* (So the buffer should be at least 18 bytes to receive this
......@@ -89,12 +89,12 @@ void version_get_string_full( char *string );
/**
* \brief Check if support for a feature was compiled into this
* PolarSSL binary. This allows you to see at runtime if the
* mbed TLS binary. This allows you to see at runtime if the
* library was for instance compiled with or without
* Multi-threading support.
*
* Note: only checks against defines in the sections "System
* support", "PolarSSL modules" and "PolarSSL feature
* support", "mbed TLS modules" and "mbed TLS feature
* support" in config.h
*
* \param feature The string for the define to check (e.g. "POLARSSL_AES_C")
......
......@@ -367,7 +367,7 @@ int x509write_crt_set_validity( x509write_cert *ctx, const char *not_before,
* \brief Set the issuer name for a Certificate
* Issuer names should contain a comma-separated list
* of OID types and values:
* e.g. "C=NL,O=Offspark,CN=PolarSSL CA"
* e.g. "C=UK,O=ARM,CN=mbed TLS CA"
*
* \param ctx CRT context to use
* \param issuer_name issuer name to set
......@@ -382,7 +382,7 @@ int x509write_crt_set_issuer_name( x509write_cert *ctx,
* \brief Set the subject name for a Certificate
* Subject names should contain a comma-separated list
* of OID types and values:
* e.g. "C=NL,O=Offspark,CN=PolarSSL Server 1"
* e.g. "C=UK,O=ARM,CN=mbed TLS Server 1"
*
* \param ctx CRT context to use
* \param subject_name subject name to set
......
......@@ -164,7 +164,7 @@ void x509write_csr_init( x509write_csr *ctx );
* \brief Set the subject name for a CSR
* Subject names should contain a comma-separated list
* of OID types and values:
* e.g. "C=NL,O=Offspark,CN=PolarSSL Server 1"
* e.g. "C=UK,O=ARM,CN=mbed TLS Server 1"
*
* \param ctx CSR context to use
* \param subject_name subject name to set
......
/**
* \file cipher.c
*
* \brief Generic cipher wrapper for PolarSSL
* \brief Generic cipher wrapper for mbed TLS
*
* \author Adriaan de Jong <dejong@fox-it.com>
*
......
/**
* \file cipher_wrap.c
*
* \brief Generic cipher wrapper for PolarSSL
* \brief Generic cipher wrapper for mbed TLS
*
* \author Adriaan de Jong <dejong@fox-it.com>
*
......
/**
* \file md.c
*
* \brief Generic message digest wrapper for PolarSSL
* \brief Generic message digest wrapper for mbed TLS
*
* \author Adriaan de Jong <dejong@fox-it.com>
*
......
/**
* \file md_wrap.c
* \brief Generic message digest wrapper for PolarSSL
* \brief Generic message digest wrapper for mbed TLS
*
* \author Adriaan de Jong <dejong@fox-it.com>
*
......
/**
* \file ssl_ciphersuites.c
*
* \brief SSL ciphersuites for PolarSSL
* \brief SSL ciphersuites for mbed TLS
*
* Copyright (C) 2006-2014, Brainspark B.V.
*
......
......@@ -313,7 +313,7 @@ static int x509_get_ext_key_usage( unsigned char **p,
* nameAssigner [0] DirectoryString OPTIONAL,
* partyName [1] DirectoryString }
*
* NOTE: PolarSSL only parses and uses dNSName at this point.
* NOTE: we only parse and use dNSName at this point.
*/
static int x509_get_subject_alt_name( unsigned char **p,
const unsigned char *end,
......
......@@ -69,7 +69,7 @@ cat include/polarssl/version.h | \
sed -e "s/_VERSION_PATCH .\+/_VERSION_PATCH $PATCH/" | \
sed -e "s/_VERSION_NUMBER .\+/_VERSION_NUMBER $VERSION_NR/" | \
sed -e "s/_VERSION_STRING .\+/_VERSION_STRING \"$VERSION\"/" | \
sed -e "s/_VERSION_STRING_FULL .\+/_VERSION_STRING_FULL \"PolarSSL $VERSION\"/" \
sed -e "s/_VERSION_STRING_FULL .\+/_VERSION_STRING_FULL \"mbed TLS $VERSION\"/" \
> tmp
mv tmp include/polarssl/version.h
......@@ -80,7 +80,7 @@ mv tmp tests/suites/test_suite_version.data
[ $VERBOSE ] && echo "Bumping PROJECT_NAME in doxygen/polarssl.doxyfile and doxygen/input/doc_mainpage.h"
for i in doxygen/polarssl.doxyfile doxygen/input/doc_mainpage.h;
do
sed -e "s/PolarSSL v[0-9\.]\+/PolarSSL v$VERSION/g" < $i > tmp
sed -e "s/mbed TLS v[0-9\.]\+/mbed TLS v$VERSION/g" < $i > tmp
mv tmp $i
done
......
......@@ -25,8 +25,8 @@ if( @ARGV ) {
my $feature_format_file = $data_dir.'/version_features.fmt';
my @sections = ( "System support", "PolarSSL modules",
"PolarSSL feature support" );
my @sections = ( "System support", "mbed TLS modules",
"mbed TLS feature support" );
my $line_separator = $/;
undef $/;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment