blob: 4be2d85d04f69205aa5a89254e54ad98fed68544 [file] [log] [blame]
Paul Bakker9d781402011-05-09 16:17:09 +00001/*
2 * Error message information
3 *
Manuel Pégourié-Gonnard7381ff02015-08-04 11:12:49 +02004 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker9d781402011-05-09 16:17:09 +000018 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000019 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker9d781402011-05-09 16:17:09 +000020 */
21
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#if !defined(MBEDTLS_CONFIG_FILE)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000023#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020024#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020025#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020026#endif
Paul Bakker9d781402011-05-09 16:17:09 +000027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020028#if defined(MBEDTLS_ERROR_C) || defined(MBEDTLS_ERROR_STRERROR_DUMMY)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000029#include "mbedtls/error.h"
Manuel Pégourié-Gonnardf5dc8ec2015-02-13 14:32:17 +000030#include <string.h>
Manuel Pégourié-Gonnard52207812019-10-02 15:55:23 +020031#include "mbedtls/platform_util.h"
Paul Bakker0464dd92014-07-09 10:16:18 +020032#endif
33
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020034#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000035#include "mbedtls/platform.h"
Rich Evans6aa04bc2015-01-30 11:18:42 +000036#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020037#define mbedtls_snprintf snprintf
Simon Butcherdb0feca2016-05-17 00:03:14 +010038#define mbedtls_time_t time_t
Rich Evans6aa04bc2015-01-30 11:18:42 +000039#endif
40
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#if defined(MBEDTLS_ERROR_C)
Paul Bakkerb2a11402013-06-24 13:02:12 +020042
Paul Bakkerdaae3b72015-02-08 15:49:54 +010043#include <stdio.h>
Paul Bakker9d781402011-05-09 16:17:09 +000044
Manuel Pégourié-Gonnardf5dc8ec2015-02-13 14:32:17 +000045HEADER_INCLUDED
Paul Bakkerd0a345e2011-11-10 13:03:42 +000046
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047void mbedtls_strerror( int ret, char *buf, size_t buflen )
Paul Bakker9d781402011-05-09 16:17:09 +000048{
49 size_t len;
50 int use_ret;
51
Paul Bakkerb9cfaa02013-10-11 18:58:55 +020052 if( buflen == 0 )
53 return;
54
Manuel Pégourié-Gonnard7a346b82019-10-02 14:47:01 +020055 mbedtls_platform_memset( buf, 0x00, buflen );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +020056
Paul Bakker9d781402011-05-09 16:17:09 +000057 if( ret < 0 )
58 ret = -ret;
59
60 if( ret & 0xFF80 )
61 {
62 use_ret = ret & 0xFF80;
63
64 // High level error codes
65 //
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +020066 // BEGIN generated code
Paul Bakker9d781402011-05-09 16:17:09 +000067HIGH_LEVEL_CODE_CHECKS
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +020068 // END generated code
69
Paul Bakker9d781402011-05-09 16:17:09 +000070 if( strlen( buf ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020071 mbedtls_snprintf( buf, buflen, "UNKNOWN ERROR CODE (%04X)", use_ret );
Paul Bakker9d781402011-05-09 16:17:09 +000072 }
73
74 use_ret = ret & ~0xFF80;
75
76 if( use_ret == 0 )
77 return;
78
79 // If high level code is present, make a concatenation between both
80 // error strings.
81 //
82 len = strlen( buf );
83
84 if( len > 0 )
85 {
86 if( buflen - len < 5 )
87 return;
88
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020089 mbedtls_snprintf( buf + len, buflen - len, " : " );
Paul Bakker9d781402011-05-09 16:17:09 +000090
91 buf += len + 3;
92 buflen -= len + 3;
93 }
94
95 // Low level error codes
96 //
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +020097 // BEGIN generated code
Paul Bakker9d781402011-05-09 16:17:09 +000098LOW_LEVEL_CODE_CHECKS
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +020099 // END generated code
100
Paul Bakker9d781402011-05-09 16:17:09 +0000101 if( strlen( buf ) != 0 )
102 return;
103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200104 mbedtls_snprintf( buf, buflen, "UNKNOWN ERROR CODE (%04X)", use_ret );
Paul Bakker9d781402011-05-09 16:17:09 +0000105}
106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200107#else /* MBEDTLS_ERROR_C */
Paul Bakkera0234372013-03-20 14:42:21 +0100108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109#if defined(MBEDTLS_ERROR_STRERROR_DUMMY)
Paul Bakkera0234372013-03-20 14:42:21 +0100110
Paul Bakkera0234372013-03-20 14:42:21 +0100111/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * Provide an non-function in case MBEDTLS_ERROR_C is not defined
Paul Bakkera0234372013-03-20 14:42:21 +0100113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114void mbedtls_strerror( int ret, char *buf, size_t buflen )
Paul Bakkera0234372013-03-20 14:42:21 +0100115{
116 ((void) ret);
117
118 if( buflen > 0 )
119 buf[0] = '\0';
120}
121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122#endif /* MBEDTLS_ERROR_STRERROR_DUMMY */
Paul Bakkere2ab84f2013-06-29 18:24:32 +0200123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200124#endif /* MBEDTLS_ERROR_C */