xref: /freebsd/crypto/openssh/ssherr.c (revision 2574974648c68c738aec3ff96644d888d7913a37)
1 /*	$OpenBSD: ssherr.c,v 1.11 2026/02/06 23:31:29 dtucker Exp $	*/
2 /*
3  * Copyright (c) 2011 Damien Miller
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #include <errno.h>
19 #include <string.h>
20 #include "ssherr.h"
21 
22 const char *
ssh_err(int n)23 ssh_err(int n)
24 {
25 	const char *msg = NULL;
26 
27 	switch (n) {
28 	case SSH_ERR_SUCCESS:
29 		return "success";
30 	case SSH_ERR_INTERNAL_ERROR:
31 		return "unexpected internal error";
32 	case SSH_ERR_ALLOC_FAIL:
33 		return "memory allocation failed";
34 	case SSH_ERR_MESSAGE_INCOMPLETE:
35 		return "incomplete message";
36 	case SSH_ERR_INVALID_FORMAT:
37 		return "invalid format";
38 	case SSH_ERR_BIGNUM_IS_NEGATIVE:
39 		return "bignum is negative";
40 	case SSH_ERR_STRING_TOO_LARGE:
41 		return "string is too large";
42 	case SSH_ERR_BIGNUM_TOO_LARGE:
43 		return "bignum is too large";
44 	case SSH_ERR_ECPOINT_TOO_LARGE:
45 		return "elliptic curve point is too large";
46 	case SSH_ERR_NO_BUFFER_SPACE:
47 		return "insufficient buffer space";
48 	case SSH_ERR_INVALID_ARGUMENT:
49 		return "invalid argument";
50 	case SSH_ERR_KEY_BITS_MISMATCH:
51 		return "key bits do not match";
52 	case SSH_ERR_EC_CURVE_INVALID:
53 		return "invalid elliptic curve";
54 	case SSH_ERR_KEY_TYPE_MISMATCH:
55 		return "key type does not match";
56 	case SSH_ERR_KEY_TYPE_UNKNOWN:
57 		return "unknown or unsupported key type";
58 	case SSH_ERR_EC_CURVE_MISMATCH:
59 		return "elliptic curve does not match";
60 	case SSH_ERR_EXPECTED_CERT:
61 		return "plain key provided where certificate required";
62 	case SSH_ERR_KEY_LACKS_CERTBLOB:
63 		return "key lacks certificate data";
64 	case SSH_ERR_KEY_CERT_UNKNOWN_TYPE:
65 		return "unknown/unsupported certificate type";
66 	case SSH_ERR_KEY_CERT_INVALID_SIGN_KEY:
67 		return "invalid certificate signing key";
68 	case SSH_ERR_KEY_INVALID_EC_VALUE:
69 		return "invalid elliptic curve value";
70 	case SSH_ERR_SIGNATURE_INVALID:
71 		return "incorrect signature";
72 	case SSH_ERR_LIBCRYPTO_ERROR:
73 		msg = ssherr_libcrypto();
74 		return msg != NULL ? msg : "error in libcrypto";
75 	case SSH_ERR_UNEXPECTED_TRAILING_DATA:
76 		return "unexpected bytes remain after decoding";
77 	case SSH_ERR_SYSTEM_ERROR:
78 		return strerror(errno);
79 	case SSH_ERR_KEY_CERT_INVALID:
80 		return "invalid certificate";
81 	case SSH_ERR_AGENT_COMMUNICATION:
82 		return "communication with agent failed";
83 	case SSH_ERR_AGENT_FAILURE:
84 		return "agent refused operation";
85 	case SSH_ERR_DH_GEX_OUT_OF_RANGE:
86 		return "DH GEX group out of range";
87 	case SSH_ERR_DISCONNECTED:
88 		return "disconnected";
89 	case SSH_ERR_MAC_INVALID:
90 		return "message authentication code incorrect";
91 	case SSH_ERR_NO_CIPHER_ALG_MATCH:
92 		return "no matching cipher found";
93 	case SSH_ERR_NO_MAC_ALG_MATCH:
94 		return "no matching MAC found";
95 	case SSH_ERR_NO_COMPRESS_ALG_MATCH:
96 		return "no matching compression method found";
97 	case SSH_ERR_NO_KEX_ALG_MATCH:
98 		return "no matching key exchange method found";
99 	case SSH_ERR_NO_HOSTKEY_ALG_MATCH:
100 		return "no matching host key type found";
101 	case SSH_ERR_PROTOCOL_MISMATCH:
102 		return "protocol version mismatch";
103 	case SSH_ERR_NO_PROTOCOL_VERSION:
104 		return "could not read protocol version";
105 	case SSH_ERR_NO_HOSTKEY_LOADED:
106 		return "could not load host key";
107 	case SSH_ERR_NEED_REKEY:
108 		return "rekeying not supported by peer";
109 	case SSH_ERR_PASSPHRASE_TOO_SHORT:
110 		return "passphrase is too short (minimum five characters)";
111 	case SSH_ERR_FILE_CHANGED:
112 		return "file changed while reading";
113 	case SSH_ERR_KEY_UNKNOWN_CIPHER:
114 		return "key encrypted using unsupported cipher";
115 	case SSH_ERR_KEY_WRONG_PASSPHRASE:
116 		return "incorrect passphrase supplied to decrypt private key";
117 	case SSH_ERR_KEY_BAD_PERMISSIONS:
118 		return "bad permissions";
119 	case SSH_ERR_KEY_CERT_MISMATCH:
120 		return "certificate does not match key";
121 	case SSH_ERR_KEY_NOT_FOUND:
122 		return "key not found";
123 	case SSH_ERR_AGENT_NOT_PRESENT:
124 		return "agent not present";
125 	case SSH_ERR_AGENT_NO_IDENTITIES:
126 		return "agent contains no identities";
127 	case SSH_ERR_BUFFER_READ_ONLY:
128 		return "internal error: buffer is read-only";
129 	case SSH_ERR_KRL_BAD_MAGIC:
130 		return "KRL file has invalid magic number";
131 	case SSH_ERR_KEY_REVOKED:
132 		return "Key is revoked";
133 	case SSH_ERR_CONN_CLOSED:
134 		return "Connection closed";
135 	case SSH_ERR_CONN_TIMEOUT:
136 		return "Connection timed out";
137 	case SSH_ERR_CONN_CORRUPT:
138 		return "Connection corrupted";
139 	case SSH_ERR_PROTOCOL_ERROR:
140 		return "Protocol error";
141 	case SSH_ERR_KEY_LENGTH:
142 		return "Invalid key length";
143 	case SSH_ERR_NUMBER_TOO_LARGE:
144 		return "number is too large";
145 	case SSH_ERR_SIGN_ALG_UNSUPPORTED:
146 		return "signature algorithm not supported";
147 	case SSH_ERR_FEATURE_UNSUPPORTED:
148 		return "requested feature not supported";
149 	case SSH_ERR_DEVICE_NOT_FOUND:
150 		return "device not found";
151 	default:
152 		return "unknown error";
153 	}
154 }
155