blob: 162d93b45c4592da58477c7a3ffb4c809d31e8d8 [file] [log] [blame]
Paul Bakker9d781402011-05-09 16:17:09 +00001/*
2 * Error message information
3 *
Bence Szépkútia2947ac2020-08-19 16:37:36 +02004 * Copyright The Mbed TLS Contributors
Bence Szépkútif744bd72020-06-05 13:02:18 +02005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
6 *
7 * This file is provided under the Apache License 2.0, or the
8 * GNU General Public License v2.0 or later.
9 *
10 * **********
11 * Apache License 2.0:
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 *
13 * Licensed under the Apache License, Version 2.0 (the "License"); you may
14 * not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
21 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
Paul Bakker9d781402011-05-09 16:17:09 +000024 *
Bence Szépkútif744bd72020-06-05 13:02:18 +020025 * **********
26 *
27 * **********
28 * GNU General Public License v2.0 or later:
29 *
30 * This program is free software; you can redistribute it and/or modify
31 * it under the terms of the GNU General Public License as published by
32 * the Free Software Foundation; either version 2 of the License, or
33 * (at your option) any later version.
34 *
35 * This program is distributed in the hope that it will be useful,
36 * but WITHOUT ANY WARRANTY; without even the implied warranty of
37 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
38 * GNU General Public License for more details.
39 *
40 * You should have received a copy of the GNU General Public License along
41 * with this program; if not, write to the Free Software Foundation, Inc.,
42 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
43 *
44 * **********
Paul Bakker9d781402011-05-09 16:17:09 +000045 */
46
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047#if !defined(MBEDTLS_CONFIG_FILE)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000048#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020049#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020051#endif
Paul Bakker9d781402011-05-09 16:17:09 +000052
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020053#if defined(MBEDTLS_ERROR_C) || defined(MBEDTLS_ERROR_STRERROR_DUMMY)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/error.h"
Manuel Pégourié-Gonnardf5dc8ec2015-02-13 14:32:17 +000055#include <string.h>
Paul Bakker0464dd92014-07-09 10:16:18 +020056#endif
57
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020058#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000059#include "mbedtls/platform.h"
Rich Evans6aa04bc2015-01-30 11:18:42 +000060#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020061#define mbedtls_snprintf snprintf
Simon Butcherdb0feca2016-05-17 00:03:14 +010062#define mbedtls_time_t time_t
Rich Evans6aa04bc2015-01-30 11:18:42 +000063#endif
64
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065#if defined(MBEDTLS_ERROR_C)
Paul Bakkerb2a11402013-06-24 13:02:12 +020066
Paul Bakkerdaae3b72015-02-08 15:49:54 +010067#include <stdio.h>
Paul Bakker9d781402011-05-09 16:17:09 +000068
Manuel Pégourié-Gonnardf5dc8ec2015-02-13 14:32:17 +000069HEADER_INCLUDED
Paul Bakkerd0a345e2011-11-10 13:03:42 +000070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020071void mbedtls_strerror( int ret, char *buf, size_t buflen )
Paul Bakker9d781402011-05-09 16:17:09 +000072{
73 size_t len;
74 int use_ret;
75
Paul Bakkerb9cfaa02013-10-11 18:58:55 +020076 if( buflen == 0 )
77 return;
78
Paul Bakker9d781402011-05-09 16:17:09 +000079 memset( buf, 0x00, buflen );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +020080
Paul Bakker9d781402011-05-09 16:17:09 +000081 if( ret < 0 )
82 ret = -ret;
83
84 if( ret & 0xFF80 )
85 {
86 use_ret = ret & 0xFF80;
87
88 // High level error codes
89 //
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +020090 // BEGIN generated code
Paul Bakker9d781402011-05-09 16:17:09 +000091HIGH_LEVEL_CODE_CHECKS
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +020092 // END generated code
93
Paul Bakker9d781402011-05-09 16:17:09 +000094 if( strlen( buf ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020095 mbedtls_snprintf( buf, buflen, "UNKNOWN ERROR CODE (%04X)", use_ret );
Paul Bakker9d781402011-05-09 16:17:09 +000096 }
97
98 use_ret = ret & ~0xFF80;
99
100 if( use_ret == 0 )
101 return;
102
103 // If high level code is present, make a concatenation between both
104 // error strings.
105 //
106 len = strlen( buf );
107
108 if( len > 0 )
109 {
110 if( buflen - len < 5 )
111 return;
112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113 mbedtls_snprintf( buf + len, buflen - len, " : " );
Paul Bakker9d781402011-05-09 16:17:09 +0000114
115 buf += len + 3;
116 buflen -= len + 3;
117 }
118
119 // Low level error codes
120 //
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +0200121 // BEGIN generated code
Paul Bakker9d781402011-05-09 16:17:09 +0000122LOW_LEVEL_CODE_CHECKS
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +0200123 // END generated code
124
Paul Bakker9d781402011-05-09 16:17:09 +0000125 if( strlen( buf ) != 0 )
126 return;
127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200128 mbedtls_snprintf( buf, buflen, "UNKNOWN ERROR CODE (%04X)", use_ret );
Paul Bakker9d781402011-05-09 16:17:09 +0000129}
130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200131#else /* MBEDTLS_ERROR_C */
Paul Bakkera0234372013-03-20 14:42:21 +0100132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#if defined(MBEDTLS_ERROR_STRERROR_DUMMY)
Paul Bakkera0234372013-03-20 14:42:21 +0100134
Paul Bakkera0234372013-03-20 14:42:21 +0100135/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200136 * Provide an non-function in case MBEDTLS_ERROR_C is not defined
Paul Bakkera0234372013-03-20 14:42:21 +0100137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138void mbedtls_strerror( int ret, char *buf, size_t buflen )
Paul Bakkera0234372013-03-20 14:42:21 +0100139{
140 ((void) ret);
141
142 if( buflen > 0 )
143 buf[0] = '\0';
144}
145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200146#endif /* MBEDTLS_ERROR_STRERROR_DUMMY */
Paul Bakkere2ab84f2013-06-29 18:24:32 +0200147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200148#endif /* MBEDTLS_ERROR_C */