yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Typos and doc additions

Browse source
This commit is contained in:
Nicholas Wilson 2015-05-11 10:39:49 +01:00
parent 770b5e1e9e
commit d0fa5ccbb0
6 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
include/polarssl/ecp.h
View file

@ -412,7 +412,7 @@ int ecp_point_read_binary( const ecp_group *grp, ecp_point *P,
* *
* \note buf is updated to point right after the ECPoint on exit * \note buf is updated to point right after the ECPoint on exit
* *
* \return O if successful, * \return 0 if successful,
* POLARSSL_ERR_MPI_XXX if initialization failed * POLARSSL_ERR_MPI_XXX if initialization failed
* POLARSSL_ERR_ECP_BAD_INPUT_DATA if input is invalid * POLARSSL_ERR_ECP_BAD_INPUT_DATA if input is invalid
*/ */
@ -462,7 +462,7 @@ int ecp_group_read_string( ecp_group *grp, int radix,
* \param grp Destination group * \param grp Destination group
* \param index Index in the list of well-known domain parameters * \param index Index in the list of well-known domain parameters
* *
* \return O if successful, * \return 0 if successful,
* POLARSSL_ERR_MPI_XXX if initialization failed * POLARSSL_ERR_MPI_XXX if initialization failed
* POLARSSL_ERR_ECP_FEATURE_UNAVAILABLE for unkownn groups * POLARSSL_ERR_ECP_FEATURE_UNAVAILABLE for unkownn groups
* *
@ -480,7 +480,7 @@ int ecp_use_known_dp( ecp_group *grp, ecp_group_id index );
* *
* \note buf is updated to point right after ECParameters on exit * \note buf is updated to point right after ECParameters on exit
* *
* \return O if successful, * \return 0 if successful,
* POLARSSL_ERR_MPI_XXX if initialization failed * POLARSSL_ERR_MPI_XXX if initialization failed
* POLARSSL_ERR_ECP_BAD_INPUT_DATA if input is invalid * POLARSSL_ERR_ECP_BAD_INPUT_DATA if input is invalid
*/ */

2
include/polarssl/oid.h
View file

@ -396,7 +396,7 @@ typedef struct {
* \param oid OID to translate * \param oid OID to translate
* *
* \return Length of the string written (excluding final NULL) or * \return Length of the string written (excluding final NULL) or
* POLARSSL_ERR_OID_BUF_TO_SMALL in case of error * POLARSSL_ERR_OID_BUF_TOO_SMALL in case of error
*/ */
int oid_get_numeric_string( char *buf, size_t size, const asn1_buf *oid ); int oid_get_numeric_string( char *buf, size_t size, const asn1_buf *oid );

2
include/polarssl/rsa.h
View file

@ -43,7 +43,7 @@
#define POLARSSL_ERR_RSA_BAD_INPUT_DATA -0x4080 /**< Bad input parameters to function. */ #define POLARSSL_ERR_RSA_BAD_INPUT_DATA -0x4080 /**< Bad input parameters to function. */
#define POLARSSL_ERR_RSA_INVALID_PADDING -0x4100 /**< Input data contains invalid padding and is rejected. */ #define POLARSSL_ERR_RSA_INVALID_PADDING -0x4100 /**< Input data contains invalid padding and is rejected. */
#define POLARSSL_ERR_RSA_KEY_GEN_FAILED -0x4180 /**< Something failed during generation of a key. */ #define POLARSSL_ERR_RSA_KEY_GEN_FAILED -0x4180 /**< Something failed during generation of a key. */
#define POLARSSL_ERR_RSA_KEY_CHECK_FAILED -0x4200 /**< Key failed to pass the libraries validity check. */ #define POLARSSL_ERR_RSA_KEY_CHECK_FAILED -0x4200 /**< Key failed to pass the library's validity check. */
#define POLARSSL_ERR_RSA_PUBLIC_FAILED -0x4280 /**< The public key operation failed. */ #define POLARSSL_ERR_RSA_PUBLIC_FAILED -0x4280 /**< The public key operation failed. */
#define POLARSSL_ERR_RSA_PRIVATE_FAILED -0x4300 /**< The private key operation failed. */ #define POLARSSL_ERR_RSA_PRIVATE_FAILED -0x4300 /**< The private key operation failed. */
#define POLARSSL_ERR_RSA_VERIFY_FAILED -0x4380 /**< The PKCS#1 verification failed. */ #define POLARSSL_ERR_RSA_VERIFY_FAILED -0x4380 /**< The PKCS#1 verification failed. */

7
include/polarssl/ssl.h
View file

@ -1154,6 +1154,9 @@ int ssl_set_session( ssl_context *ssl, const ssl_session *session );
* order. First in the list has the highest preference. * order. First in the list has the highest preference.
* (Overrides all version specific lists) * (Overrides all version specific lists)
* *
* The ciphersuites array is not copied, and must remain
* valid for the lifetime of the ssl_context.
*
* Note: The server uses its own preferences * Note: The server uses its own preferences
* over the preference of the client unless * over the preference of the client unless
* POLARSSL_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined! * POLARSSL_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
@ -1540,7 +1543,7 @@ void ssl_set_arc4_support( ssl_context *ssl, char arc4 );
* SSL_MAX_FRAG_LEN_512, SSL_MAX_FRAG_LEN_1024, * SSL_MAX_FRAG_LEN_512, SSL_MAX_FRAG_LEN_1024,
* SSL_MAX_FRAG_LEN_2048, SSL_MAX_FRAG_LEN_4096) * SSL_MAX_FRAG_LEN_2048, SSL_MAX_FRAG_LEN_4096)
* *
* \return O if successful or POLARSSL_ERR_SSL_BAD_INPUT_DATA * \return 0 if successful or POLARSSL_ERR_SSL_BAD_INPUT_DATA
*/ */
int ssl_set_max_frag_len( ssl_context *ssl, unsigned char mfl_code ); int ssl_set_max_frag_len( ssl_context *ssl, unsigned char mfl_code );
#endif /* POLARSSL_SSL_MAX_FRAGMENT_LENGTH */ #endif /* POLARSSL_SSL_MAX_FRAGMENT_LENGTH */
@ -1589,7 +1592,7 @@ void ssl_set_cbc_record_splitting( ssl_context *ssl, char split );
* \param use_tickets Enable or disable (SSL_SESSION_TICKETS_ENABLED or * \param use_tickets Enable or disable (SSL_SESSION_TICKETS_ENABLED or
* SSL_SESSION_TICKETS_DISABLED) * SSL_SESSION_TICKETS_DISABLED)
* *
* \return O if successful, * \return 0 if successful,
* or a specific error code (server only). * or a specific error code (server only).
*/ */
int ssl_set_session_tickets( ssl_context *ssl, int use_tickets ); int ssl_set_session_tickets( ssl_context *ssl, int use_tickets );

2
library/error.c
View file

@ -356,7 +356,7 @@ void polarssl_strerror( int ret, char *buf, size_t buflen )
if( use_ret == -(POLARSSL_ERR_RSA_KEY_GEN_FAILED) ) if( use_ret == -(POLARSSL_ERR_RSA_KEY_GEN_FAILED) )
polarssl_snprintf( buf, buflen, "RSA - Something failed during generation of a key" ); polarssl_snprintf( buf, buflen, "RSA - Something failed during generation of a key" );
if( use_ret == -(POLARSSL_ERR_RSA_KEY_CHECK_FAILED) ) if( use_ret == -(POLARSSL_ERR_RSA_KEY_CHECK_FAILED) )
polarssl_snprintf( buf, buflen, "RSA - Key failed to pass the libraries validity check" ); polarssl_snprintf( buf, buflen, "RSA - Key failed to pass the library's validity check" );
if( use_ret == -(POLARSSL_ERR_RSA_PUBLIC_FAILED) ) if( use_ret == -(POLARSSL_ERR_RSA_PUBLIC_FAILED) )
polarssl_snprintf( buf, buflen, "RSA - The public key operation failed" ); polarssl_snprintf( buf, buflen, "RSA - The public key operation failed" );
if( use_ret == -(POLARSSL_ERR_RSA_PRIVATE_FAILED) ) if( use_ret == -(POLARSSL_ERR_RSA_PRIVATE_FAILED) )

2
library/x509.c
View file

@ -449,7 +449,7 @@ int x509_get_name( unsigned char **p, const unsigned char *end,
if( *p == end_set ) if( *p == end_set )
break; break;
/* Mark this item as being only one in a set */ /* Mark this item as being not the only one in a set */
cur->next_merged = 1; cur->next_merged = 1;
cur->next = polarssl_malloc( sizeof( x509_name ) ); cur->next = polarssl_malloc( sizeof( x509_name ) );