blob: c5c8707dcc7b3a75fe96d31d3c7b4a9e06bfde6b [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)
Gilles Peskine076c97e2020-11-09 15:14:10 +010054
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000055#include "mbedtls/error.h"
Gilles Peskine076c97e2020-11-09 15:14:10 +010056
57#if defined(MBEDTLS_ERROR_C)
Paul Bakker0464dd92014-07-09 10:16:18 +020058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000060#include "mbedtls/platform.h"
Rich Evans6aa04bc2015-01-30 11:18:42 +000061#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020062#define mbedtls_snprintf snprintf
Rich Evans6aa04bc2015-01-30 11:18:42 +000063#endif
64
Paul Bakkerdaae3b72015-02-08 15:49:54 +010065#include <stdio.h>
Gilles Peskine076c97e2020-11-09 15:14:10 +010066#include <string.h>
Paul Bakker9d781402011-05-09 16:17:09 +000067
Manuel Pégourié-Gonnardf5dc8ec2015-02-13 14:32:17 +000068HEADER_INCLUDED
Paul Bakkerd0a345e2011-11-10 13:03:42 +000069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070void mbedtls_strerror( int ret, char *buf, size_t buflen )
Paul Bakker9d781402011-05-09 16:17:09 +000071{
72 size_t len;
73 int use_ret;
74
Paul Bakkerb9cfaa02013-10-11 18:58:55 +020075 if( buflen == 0 )
76 return;
77
Paul Bakker9d781402011-05-09 16:17:09 +000078 memset( buf, 0x00, buflen );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +020079
Paul Bakker9d781402011-05-09 16:17:09 +000080 if( ret < 0 )
81 ret = -ret;
82
83 if( ret & 0xFF80 )
84 {
85 use_ret = ret & 0xFF80;
86
87 // High level error codes
88 //
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +020089 // BEGIN generated code
Paul Bakker9d781402011-05-09 16:17:09 +000090HIGH_LEVEL_CODE_CHECKS
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +020091 // END generated code
92
Paul Bakker9d781402011-05-09 16:17:09 +000093 if( strlen( buf ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020094 mbedtls_snprintf( buf, buflen, "UNKNOWN ERROR CODE (%04X)", use_ret );
Paul Bakker9d781402011-05-09 16:17:09 +000095 }
96
97 use_ret = ret & ~0xFF80;
98
99 if( use_ret == 0 )
100 return;
101
102 // If high level code is present, make a concatenation between both
103 // error strings.
104 //
105 len = strlen( buf );
106
107 if( len > 0 )
108 {
109 if( buflen - len < 5 )
110 return;
111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 mbedtls_snprintf( buf + len, buflen - len, " : " );
Paul Bakker9d781402011-05-09 16:17:09 +0000113
114 buf += len + 3;
115 buflen -= len + 3;
116 }
117
118 // Low level error codes
119 //
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +0200120 // BEGIN generated code
Paul Bakker9d781402011-05-09 16:17:09 +0000121LOW_LEVEL_CODE_CHECKS
Manuel Pégourié-Gonnardfe671f42014-04-11 18:06:44 +0200122 // END generated code
123
Paul Bakker9d781402011-05-09 16:17:09 +0000124 if( strlen( buf ) != 0 )
125 return;
126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200127 mbedtls_snprintf( buf, buflen, "UNKNOWN ERROR CODE (%04X)", use_ret );
Paul Bakker9d781402011-05-09 16:17:09 +0000128}
129
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200130#else /* MBEDTLS_ERROR_C */
Paul Bakkera0234372013-03-20 14:42:21 +0100131
Paul Bakkera0234372013-03-20 14:42:21 +0100132/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133 * Provide an non-function in case MBEDTLS_ERROR_C is not defined
Paul Bakkera0234372013-03-20 14:42:21 +0100134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200135void mbedtls_strerror( int ret, char *buf, size_t buflen )
Paul Bakkera0234372013-03-20 14:42:21 +0100136{
137 ((void) ret);
138
139 if( buflen > 0 )
140 buf[0] = '\0';
141}
142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143#endif /* MBEDTLS_ERROR_C */
Gilles Peskine076c97e2020-11-09 15:14:10 +0100144
145#endif /* MBEDTLS_ERROR_C || MBEDTLS_ERROR_STRERROR_DUMMY */