Style fixes
1. Fix indentations.
2. Remove redundant whitespaces.
3. Keep short lines.
4. Grammar fixes.
5. Rephrase function description.
Signed-off-by: Johan Pascal <johan.pascal@belledonne-communications.com>
diff --git a/ChangeLog b/ChangeLog
index 69e094c..83b566b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -731,8 +731,8 @@
they are enabled.
Features
- * Add support for DTLS-SRTP as defined in RFC 5764. Based on contribution done
- by Johan Pascal in #361.
+ * Add support for DTLS-SRTP as defined in RFC 5764. Based on #361 contributed
+ by Johan Pascal.
= mbed TLS 2.16.0 branch released 2018-12-21
diff --git a/include/mbedtls/ssl.h b/include/mbedtls/ssl.h
index f60fc99..1f8d176 100644
--- a/include/mbedtls/ssl.h
+++ b/include/mbedtls/ssl.h
@@ -415,7 +415,8 @@
#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
/*
- * use_srtp extension protection profiles values as defined in http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
+ * Use_srtp extension protection profiles values as defined in
+ * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
*/
#define MBEDTLS_SRTP_AES128_CM_HMAC_SHA1_80_IANA_VALUE 0x0001
#define MBEDTLS_SRTP_AES128_CM_HMAC_SHA1_32_IANA_VALUE 0x0002
@@ -890,10 +891,17 @@
typedef struct mbedtls_dtls_srtp_info_t
{
- mbedtls_ssl_srtp_profile chosen_dtls_srtp_profile; /*!< negotiated SRTP profile */
- unsigned char dtls_srtp_keys[MBEDTLS_DTLS_SRTP_MAX_KEY_MATERIAL_LENGTH]; /*!< master keys and master salt for SRTP generated during handshake */
- size_t dtls_srtp_keys_len; /*!< length in bytes of master keys and master salt for SRTP generated during handshake */
- unsigned char mki_value[MBEDTLS_DTLS_SRTP_MAX_MKI_LENGTH]; /* opaque srtp_mki<0..255> */
+ /*! The SRTP profile that was negotiated*/
+ mbedtls_ssl_srtp_profile chosen_dtls_srtp_profile;
+ /*! master keys and master salt for SRTP generated during handshake */
+ unsigned char dtls_srtp_keys[MBEDTLS_DTLS_SRTP_MAX_KEY_MATERIAL_LENGTH];
+ /*! length in bytes of master keys and master salt for
+ * SRTP generated during handshake
+ */
+ size_t dtls_srtp_keys_len;
+ /*! The mki_value used, with max size of 256 bytes */
+ unsigned char mki_value[MBEDTLS_DTLS_SRTP_MAX_MKI_LENGTH];
+ /*! The length of mki_value */
size_t mki_len;
}
mbedtls_dtls_srtp_info;
@@ -1107,8 +1115,10 @@
#endif
#if defined(MBEDTLS_SSL_DTLS_SRTP)
- mbedtls_ssl_srtp_profile *dtls_srtp_profile_list; /*!< ordered list of supported srtp profile */
- size_t dtls_srtp_profile_list_len; /*!< number of supported profiles */
+ /*! ordered list of supported srtp profile */
+ mbedtls_ssl_srtp_profile *dtls_srtp_profile_list;
+ /*! number of supported profiles */
+ size_t dtls_srtp_profile_list_len;
#endif /* MBEDTLS_SSL_DTLS_SRTP */
/*
@@ -3186,12 +3196,14 @@
#if defined(MBEDTLS_SSL_DTLS_SRTP)
/**
- * \brief Add support for mki value in use_srtp extension
- * (Default: MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED)
+ * \brief Add support for mki value in use_srtp extension.
+ * The default value is
+ * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
*
* \param conf SSL configuration
- * \param support_mki_value Enable or disable (MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
- * or MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED)
+ * \param support_mki_value Enable or disable mki usage. Values are
+ * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
+ * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
*/
void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
int support_mki_value );
@@ -3204,21 +3216,22 @@
* in decreasing preference order.
* \param profiles_number Number of supported profiles.
*
- * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
+ * \return 0 on success, or #MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
*/
-int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
- const mbedtls_ssl_srtp_profile *profiles,
- size_t profiles_number );
+int mbedtls_ssl_conf_dtls_srtp_protection_profiles
+ ( mbedtls_ssl_config *conf,
+ const mbedtls_ssl_srtp_profile *profiles,
+ size_t profiles_number );
/**
- * \brief Set the mki_value for the current dtls session.
+ * \brief Set the mki_value for the current DTLS-SRTP session.
*
- * \param ssl SSL context
- * \param mki_value MKI value to set
- * \param mki_len MKI length
+ * \param ssl SSL context to use.
+ * \param mki_value The MKI value to set.
+ * \param mki_len The length of the MKI value.
*
- * \return 0 on success, MBEDTLS_ERR_SSL_BAD_INPUT_DATA
- * or MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE on failure
+ * \return 0 on success, #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
+ * or #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE on failure
*/
int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
unsigned char *mki_value,
@@ -3231,36 +3244,39 @@
* \param ssl SSL context
*
* \return Protection Profile enum member,
- * MBEDTLS_SRTP_UNSET_PROFILE if no protocol was negotiated.
+ * #MBEDTLS_SRTP_UNSET_PROFILE if no protocol was negotiated.
*/
-mbedtls_ssl_srtp_profile mbedtls_ssl_get_dtls_srtp_protection_profile( const mbedtls_ssl_context *ssl );
+mbedtls_ssl_srtp_profile mbedtls_ssl_get_dtls_srtp_protection_profile
+ ( const mbedtls_ssl_context *ssl );
/**
* \brief Get the generated DTLS-SRTP key material.
* This function should be called after the handshake is
- * completed. It shall returns 80 bytes of key material
- * generated according to RFC5764
+ * completed. It shall returns 60 bytes of key material
+ * generated according to RFC 5764
*
- * \param ssl SSL context
- * \param key Buffer to hold the generated key material
+ * \param ssl SSL context tobe used.
+ * \param key Buffer to hold the generated key material.
* \param key_len [in/out] key buffer size. outputs the actual number
- * of bytes written
+ * of bytes written.
*
- * \return 0 on succes, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if the key buffer
- * is too small to hold the generated key
+ * \return 0 on success, #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if
+ * the key buffer is too small to hold the generated key.
*/
int mbedtls_ssl_get_dtls_srtp_key_material( const mbedtls_ssl_context *ssl,
unsigned char *key,
size_t *key_len );
/**
- * \brief Utility function to get information on dtls srtp profile.
+ * \brief Utility function to get information on DTLS-SRTP profile.
*
* \param profile The dtls-srtp profile id to get info on.
*
- * \return mbedtls_ssl_srtp_profile_info* on success, NULL if not found
+ * \return Address of the SRTP profile information structure on
+ * success,NULL if not found.
*/
-const mbedtls_ssl_srtp_profile_info *mbedtls_ssl_dtls_srtp_profile_info_from_id( mbedtls_ssl_srtp_profile profile );
+const mbedtls_ssl_srtp_profile_info *mbedtls_ssl_dtls_srtp_profile_info_from_id
+ ( mbedtls_ssl_srtp_profile profile );
#endif /* MBEDTLS_SSL_DTLS_SRTP */
/**
@@ -3279,7 +3295,7 @@
* MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
* MBEDTLS_SSL_MINOR_VERSION_3 supported)
*/
-void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf,int major, int minor );
+void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
/**
* \brief Set the minimum accepted SSL/TLS protocol version
diff --git a/library/ssl_cli.c b/library/ssl_cli.c
index 8335f00..13547ce 100644
--- a/library/ssl_cli.c
+++ b/library/ssl_cli.c
@@ -756,9 +756,9 @@
}
#endif /* MBEDTLS_SSL_ALPN */
-#if defined (MBEDTLS_SSL_DTLS_SRTP)
+#if defined(MBEDTLS_SSL_DTLS_SRTP)
static void ssl_write_use_srtp_ext( mbedtls_ssl_context *ssl,
- unsigned char *buf, size_t *olen )
+ unsigned char *buf, size_t *olen )
{
unsigned char *p = buf;
size_t protection_profiles_index = 0;
@@ -766,8 +766,8 @@
*olen = 0;
- if( (ssl->conf->dtls_srtp_profile_list == NULL) ||
- (ssl->conf->dtls_srtp_profile_list_len == 0) )
+ if( ( ssl->conf->dtls_srtp_profile_list == NULL ) ||
+ ( ssl->conf->dtls_srtp_profile_list_len == 0 ) )
{
return;
}
@@ -777,14 +777,13 @@
*p++ = (unsigned char)( ( MBEDTLS_TLS_EXT_USE_SRTP >> 8 ) & 0xFF );
*p++ = (unsigned char)( ( MBEDTLS_TLS_EXT_USE_SRTP ) & 0xFF );
- /* RFC5764 section 4.1.1
+ /* RFC 5764 section 4.1.1
* uint8 SRTPProtectionProfile[2];
*
* struct {
* SRTPProtectionProfiles SRTPProtectionProfiles;
* opaque srtp_mki<0..255>;
* } UseSRTPData;
-
* SRTPProtectionProfile SRTPProtectionProfiles<2..2^16-1>;
*/
if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED &&
@@ -811,7 +810,7 @@
protection_profiles_index < ssl->conf->dtls_srtp_profile_list_len;
protection_profiles_index++ )
{
- switch (ssl->conf->dtls_srtp_profile_list[protection_profiles_index]) {
+ switch( ssl->conf->dtls_srtp_profile_list[protection_profiles_index] ) {
case MBEDTLS_SRTP_AES128_CM_HMAC_SHA1_80:
MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_write_use_srtp_ext, add profile: %04x",
MBEDTLS_SRTP_AES128_CM_HMAC_SHA1_80_IANA_VALUE ) );
@@ -848,7 +847,7 @@
* is checked by ssl_set_dtls_srtp_protection_profiles function
*/
MBEDTLS_SSL_DEBUG_MSG( 1, ( "client hello, ignore illegal DTLS-SRTP protection profile %d",
- ssl->conf->dtls_srtp_profile_list[protection_profiles_index]) );
+ ssl->conf->dtls_srtp_profile_list[protection_profiles_index] ) );
break;
}
}
@@ -1853,7 +1852,7 @@
ssl->conf->dtls_srtp_profile_list_len == 0 )
return( 0 );
- /* RFC5764 section 4.1.1
+ /* RFC 5764 section 4.1.1
* uint8 SRTPProtectionProfile[2];
*
* struct {
@@ -1954,11 +1953,11 @@
#if defined (MBEDTLS_DEBUG_C)
if( len > 5 )
{
- MBEDTLS_SSL_DEBUG_BUF( 3, "received mki", ssl->dtls_srtp_info.mki_value,
- ssl->dtls_srtp_info.mki_len );
+ MBEDTLS_SSL_DEBUG_BUF( 3, "received mki", ssl->dtls_srtp_info.mki_value,
+ ssl->dtls_srtp_info.mki_len );
}
#endif
- return 0;
+ return( 0 );
}
#endif /* MBEDTLS_SSL_DTLS_SRTP */
@@ -3510,7 +3509,8 @@
{
#if defined(MBEDTLS_SSL_DTLS_SRTP)
/* check if we have a chosen srtp protection profile */
- if( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE ) {
+ if( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE )
+ {
ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
}
else
@@ -4169,7 +4169,8 @@
{
#if defined(MBEDTLS_SSL_DTLS_SRTP)
/* check if we have a chosen srtp protection profile */
- if( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE ) {
+ if( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE )
+ {
return ( MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE );
}
else
diff --git a/library/ssl_srv.c b/library/ssl_srv.c
index 38908c8..fae8f60 100644
--- a/library/ssl_srv.c
+++ b/library/ssl_srv.c
@@ -847,7 +847,7 @@
MBEDTLS_SSL_DEBUG_MSG( 3, ( "found srtp profile: %s", profile_info->name ) );
}
/* check if suggested profile is in our list */
- for( i=0; i < ssl->conf->dtls_srtp_profile_list_len; i++)
+ for( i = 0; i < ssl->conf->dtls_srtp_profile_list_len; i++)
{
if( client_protection == ssl->conf->dtls_srtp_profile_list[i] )
{
@@ -860,7 +860,7 @@
break;
}
if( ( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED ) &&
- ( len > ( profile_length + 2 ) ) )
+ ( len > ( profile_length + 2 ) ) )
{
ssl->dtls_srtp_info.mki_len = buf[profile_length + 2];
if( ssl->dtls_srtp_info.mki_len > MBEDTLS_DTLS_SRTP_MAX_MKI_LENGTH )
@@ -3056,7 +3056,8 @@
* force verify mode to be at least OPTIONAL
*/
if ( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE &&
- ssl->conf->authmode == MBEDTLS_SSL_VERIFY_NONE ) {
+ ssl->conf->authmode == MBEDTLS_SSL_VERIFY_NONE )
+ {
authmode = MBEDTLS_SSL_VERIFY_OPTIONAL;
}
else
@@ -3067,8 +3068,9 @@
authmode == MBEDTLS_SSL_VERIFY_NONE )
{
#if defined(MBEDTLS_SSL_DTLS_SRTP)
- /* check if we have a chosen srtp protection profile */
- if ( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE ) {
+ /* check if we have a chosen srtp protection profile */
+ if ( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE )
+ {
MBEDTLS_SSL_DEBUG_MSG( 2, ( "should not happen" ) );
return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
}
diff --git a/library/ssl_tls.c b/library/ssl_tls.c
index 3a0fbfc..0ec2913 100644
--- a/library/ssl_tls.c
+++ b/library/ssl_tls.c
@@ -873,10 +873,11 @@
#if defined(MBEDTLS_SSL_DTLS_SRTP)
/* check if we have a chosen srtp protection profile */
- if( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE ) {
+ if ( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE )
+ {
/* derive key material for srtp session RFC5764 section 4.2
* master key and master salt are respectively 128 bits and 112 bits
- * for all currently available modes :
+ * for all currently available modes:
* SRTP_AES128_CM_HMAC_SHA1_80, SRTP_AES128_CM_HMAC_SHA1_32
* SRTP_NULL_HMAC_SHA1_80, SRTP_NULL_HMAC_SHA1_32
* So we must export 2*(128 + 112) = 480 bits
@@ -2114,7 +2115,8 @@
{
#if defined(MBEDTLS_SSL_DTLS_SRTP)
/* check if we have a chosen srtp protection profile */
- if( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE ) {
+ if( ssl->dtls_srtp_info.chosen_dtls_srtp_profile != MBEDTLS_SRTP_UNSET_PROFILE )
+ {
return( MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE );
}
else
@@ -4773,14 +4775,18 @@
size_t mki_len )
{
if ( mki_len > MBEDTLS_DTLS_SRTP_MAX_MKI_LENGTH )
+ {
return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
+ }
if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
+ {
return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
+ }
memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
ssl->dtls_srtp_info.mki_len = mki_len;
- return 0;
+ return( 0 );
}
int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
@@ -4788,14 +4794,19 @@
size_t profiles_number )
{
size_t i;
- /* check in put validity : must be a list of profiles from enumeration */
- /* maximum length is 4 as only 4 protection profiles are defined */
- if( profiles_number > 4 ) {
- return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
+ /*
+ * Check input validity : must be a list of profiles from enumeration.
+ * Maximum length is 4 as only 4 protection profiles are defined.
+ */
+ if( profiles_number > 4 )
+ {
+ return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
}
mbedtls_free( conf->dtls_srtp_profile_list );
- conf->dtls_srtp_profile_list = (mbedtls_ssl_srtp_profile*)mbedtls_calloc(1, profiles_number * sizeof( mbedtls_ssl_srtp_profile ) );
+ conf->dtls_srtp_profile_list =
+ (mbedtls_ssl_srtp_profile*)mbedtls_calloc(1,
+ profiles_number * sizeof( mbedtls_ssl_srtp_profile ) );
for( i=0; i < profiles_number; i++ ) {
switch( profiles[i] ) {
@@ -4809,7 +4820,7 @@
mbedtls_free( conf->dtls_srtp_profile_list );
conf->dtls_srtp_profile_list = NULL;
conf->dtls_srtp_profile_list_len = 0;
- return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
+ return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
}
}
@@ -4819,25 +4830,28 @@
return( 0 );
}
-mbedtls_ssl_srtp_profile mbedtls_ssl_get_dtls_srtp_protection_profile( const mbedtls_ssl_context *ssl )
+mbedtls_ssl_srtp_profile
+ mbedtls_ssl_get_dtls_srtp_protection_profile( const mbedtls_ssl_context *ssl )
{
return( ssl->dtls_srtp_info.chosen_dtls_srtp_profile );
}
int mbedtls_ssl_get_dtls_srtp_key_material( const mbedtls_ssl_context *ssl,
unsigned char *key,
- size_t *key_len ) {
+ size_t *key_len )
+{
/* check output buffer size */
- if( *key_len < ssl->dtls_srtp_info.dtls_srtp_keys_len ) {
- return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
+ if( *key_len < ssl->dtls_srtp_info.dtls_srtp_keys_len )
+ {
+ return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
}
memcpy( key, ssl->dtls_srtp_info.dtls_srtp_keys,
ssl->dtls_srtp_info.dtls_srtp_keys_len );
*key_len = ssl->dtls_srtp_info.dtls_srtp_keys_len;
- return 0;
+ return( 0 );
}
#endif /* MBEDTLS_SSL_DTLS_SRTP */
diff --git a/programs/ssl/ssl_client2.c b/programs/ssl/ssl_client2.c
index 062fa11..8bfd0c3 100644
--- a/programs/ssl/ssl_client2.c
+++ b/programs/ssl/ssl_client2.c
@@ -2285,19 +2285,22 @@
if( opt.force_srtp_profile != DFL_SRTP_FORCE_PROFILE )
{
const mbedtls_ssl_srtp_profile forced_profile[] = { opt.force_srtp_profile };
- ret = mbedtls_ssl_conf_dtls_srtp_protection_profiles( &conf,
- forced_profile,
- sizeof( forced_profile ) / sizeof( mbedtls_ssl_srtp_profile ) );
+ ret = mbedtls_ssl_conf_dtls_srtp_protection_profiles
+ ( &conf,
+ forced_profile,
+ sizeof( forced_profile ) / sizeof( mbedtls_ssl_srtp_profile ) );
}
else
{
- const mbedtls_ssl_srtp_profile default_profiles[] = { MBEDTLS_SRTP_AES128_CM_HMAC_SHA1_80,
- MBEDTLS_SRTP_AES128_CM_HMAC_SHA1_32,
- MBEDTLS_SRTP_NULL_HMAC_SHA1_80,
- MBEDTLS_SRTP_NULL_HMAC_SHA1_32 };
- ret = mbedtls_ssl_conf_dtls_srtp_protection_profiles( &conf,
- default_profiles,
- sizeof( default_profiles ) / sizeof( mbedtls_ssl_srtp_profile ) );
+ const mbedtls_ssl_srtp_profile default_profiles[] =
+ { MBEDTLS_SRTP_AES128_CM_HMAC_SHA1_80,
+ MBEDTLS_SRTP_AES128_CM_HMAC_SHA1_32,
+ MBEDTLS_SRTP_NULL_HMAC_SHA1_80,
+ MBEDTLS_SRTP_NULL_HMAC_SHA1_32 };
+ ret = mbedtls_ssl_conf_dtls_srtp_protection_profiles
+ ( &conf,
+ default_profiles,
+ sizeof( default_profiles ) / sizeof( mbedtls_ssl_srtp_profile ) );
}
if( ret != 0 )
