xref: /netbsd-src/crypto/external/bsd/openssh/dist/mac.c (revision a4ddc2c8fb9af816efe3b1c375a5530aef0e89e9)
1 /*	$NetBSD: mac.c,v 1.6 2012/12/12 17:42:39 christos Exp $	*/
2 /* $OpenBSD: mac.c,v 1.18 2012/06/28 05:07:45 dtucker Exp $ */
3 /*
4  * Copyright (c) 2001 Markus Friedl.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #include "includes.h"
28 __RCSID("$NetBSD: mac.c,v 1.6 2012/12/12 17:42:39 christos Exp $");
29 #include <sys/types.h>
30 
31 #include <openssl/hmac.h>
32 
33 #include <string.h>
34 #include <signal.h>
35 
36 #include "xmalloc.h"
37 #include "log.h"
38 #include "cipher.h"
39 #include "buffer.h"
40 #include "key.h"
41 #include "kex.h"
42 #include "mac.h"
43 #include "misc.h"
44 
45 #ifdef UMAC_HAS_BEEN_UNBROKEN
46 #include "umac.h"
47 #endif
48 
49 #define SSH_EVP		1	/* OpenSSL EVP-based MAC */
50 #define SSH_UMAC	2	/* UMAC (not integrated with OpenSSL) */
51 
52 struct {
53 	const char	*name;
54 	int		type;
55 	const EVP_MD *	(*mdfunc)(void);
56 	int		truncatebits;	/* truncate digest if != 0 */
57 	int		key_len;	/* just for UMAC */
58 	int		len;		/* just for UMAC */
59 } macs[] = {
60 	{ "hmac-sha1",			SSH_EVP, EVP_sha1, 0, -1, -1 },
61 	{ "hmac-sha1-96",		SSH_EVP, EVP_sha1, 96, -1, -1 },
62 	{ "hmac-sha2-256",		SSH_EVP, EVP_sha256, 0, -1, -1 },
63 	{ "hmac-sha2-512",		SSH_EVP, EVP_sha512, 0, -1, -1 },
64 	{ "hmac-md5",			SSH_EVP, EVP_md5, 0, -1, -1 },
65 	{ "hmac-md5-96",		SSH_EVP, EVP_md5, 96, -1, -1 },
66 	{ "hmac-ripemd160",		SSH_EVP, EVP_ripemd160, 0, -1, -1 },
67 	{ "hmac-ripemd160@openssh.com",	SSH_EVP, EVP_ripemd160, 0, -1, -1 },
68 #ifdef UMAC_HAS_BEEN_UNBROKEN
69 	{ "umac-64@openssh.com",	SSH_UMAC, NULL, 0, 128, 64 },
70 #endif
71 	{ NULL,				0, NULL, 0, -1, -1 }
72 };
73 
74 static void
75 mac_setup_by_id(Mac *mac, int which)
76 {
77 	int evp_len;
78 	mac->type = macs[which].type;
79 	if (mac->type == SSH_EVP) {
80 		mac->evp_md = (*macs[which].mdfunc)();
81 		if ((evp_len = EVP_MD_size(mac->evp_md)) <= 0)
82 			fatal("mac %s len %d", mac->name, evp_len);
83 		mac->key_len = mac->mac_len = (u_int)evp_len;
84 	} else {
85 		mac->mac_len = macs[which].len / 8;
86 		mac->key_len = macs[which].key_len / 8;
87 		mac->umac_ctx = NULL;
88 	}
89 	if (macs[which].truncatebits != 0)
90 		mac->mac_len = macs[which].truncatebits / 8;
91 }
92 
93 int
94 mac_setup(Mac *mac, char *name)
95 {
96 	int i;
97 
98 	for (i = 0; macs[i].name; i++) {
99 		if (strcmp(name, macs[i].name) == 0) {
100 			if (mac != NULL)
101 				mac_setup_by_id(mac, i);
102 			debug2("mac_setup: found %s", name);
103 			return (0);
104 		}
105 	}
106 	debug2("mac_setup: unknown %s", name);
107 	return (-1);
108 }
109 
110 int
111 mac_init(Mac *mac)
112 {
113 	if (mac->key == NULL)
114 		fatal("mac_init: no key");
115 	switch (mac->type) {
116 	case SSH_EVP:
117 		if (mac->evp_md == NULL)
118 			return -1;
119 		HMAC_CTX_init(&mac->evp_ctx);
120 		HMAC_Init(&mac->evp_ctx, mac->key, mac->key_len, mac->evp_md);
121 		return 0;
122 #ifdef UMAC_HAS_BEEN_UNBROKEN
123 	case SSH_UMAC:
124 		mac->umac_ctx = umac_new(mac->key);
125 		return 0;
126 #endif
127 	default:
128 		return -1;
129 	}
130 }
131 
132 u_char *
133 mac_compute(Mac *mac, u_int32_t seqno, u_char *data, int datalen)
134 {
135 	static u_char m[EVP_MAX_MD_SIZE];
136 	u_char b[4];
137 #ifdef UMAC_HAS_BEEN_UNBROKEN
138 	u_char nonce[8];
139 #endif
140 
141 	if (mac->mac_len > sizeof(m))
142 		fatal("mac_compute: mac too long %u %lu",
143 		    mac->mac_len, (u_long)sizeof(m));
144 
145 	switch (mac->type) {
146 	case SSH_EVP:
147 		put_u32(b, seqno);
148 		/* reset HMAC context */
149 		HMAC_Init(&mac->evp_ctx, NULL, 0, NULL);
150 		HMAC_Update(&mac->evp_ctx, b, sizeof(b));
151 		HMAC_Update(&mac->evp_ctx, data, datalen);
152 		HMAC_Final(&mac->evp_ctx, m, NULL);
153 		break;
154 #ifdef UMAC_HAS_BEEN_UNBROKEN
155 	case SSH_UMAC:
156 		put_u64(nonce, seqno);
157 		umac_update(mac->umac_ctx, data, datalen);
158 		umac_final(mac->umac_ctx, m, nonce);
159 		break;
160 #endif
161 	default:
162 		fatal("mac_compute: unknown MAC type");
163 	}
164 	return (m);
165 }
166 
167 void
168 mac_clear(Mac *mac)
169 {
170 #ifdef UMAC_HAS_BEEN_UNBROKEN
171 	if (mac->type == SSH_UMAC) {
172 		if (mac->umac_ctx != NULL)
173 			umac_delete(mac->umac_ctx);
174 	} else
175 #endif
176 	if (mac->evp_md != NULL)
177 		HMAC_cleanup(&mac->evp_ctx);
178 	mac->evp_md = NULL;
179 	mac->umac_ctx = NULL;
180 }
181 
182 /* XXX copied from ciphers_valid */
183 #define	MAC_SEP	","
184 int
185 mac_valid(const char *names)
186 {
187 	char *maclist, *cp, *p;
188 
189 	if (names == NULL || strcmp(names, "") == 0)
190 		return (0);
191 	maclist = cp = xstrdup(names);
192 	for ((p = strsep(&cp, MAC_SEP)); p && *p != '\0';
193 	    (p = strsep(&cp, MAC_SEP))) {
194 		if (mac_setup(NULL, p) < 0) {
195 			debug("bad mac %s [%s]", p, names);
196 			xfree(maclist);
197 			return (0);
198 		} else {
199 			debug3("mac ok: %s [%s]", p, names);
200 		}
201 	}
202 	debug3("macs ok: [%s]", names);
203 	xfree(maclist);
204 	return (1);
205 }
206