xref: /netbsd-src/crypto/external/bsd/openssh/dist/mac.c (revision 6f47b6603c076f1e97d037b0632b2be857a417ad)
1 /*	$NetBSD: mac.c,v 1.4 2011/09/07 17:49:19 christos Exp $	*/
2 /* $OpenBSD: mac.c,v 1.16 2011/08/02 01:22:11 djm 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.4 2011/09/07 17:49:19 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-256-96",		SSH_EVP, EVP_sha256, 96, -1, -1 },
64 	{ "hmac-sha2-512",		SSH_EVP, EVP_sha512, 0, -1, -1 },
65 	{ "hmac-sha2-512-96",		SSH_EVP, EVP_sha512, 96, -1, -1 },
66 	{ "hmac-md5",			SSH_EVP, EVP_md5, 0, -1, -1 },
67 	{ "hmac-md5-96",		SSH_EVP, EVP_md5, 96, -1, -1 },
68 	{ "hmac-ripemd160",		SSH_EVP, EVP_ripemd160, 0, -1, -1 },
69 	{ "hmac-ripemd160@openssh.com",	SSH_EVP, EVP_ripemd160, 0, -1, -1 },
70 #ifdef UMAC_HAS_BEEN_UNBROKEN
71 	{ "umac-64@openssh.com",	SSH_UMAC, NULL, 0, 128, 64 },
72 #endif
73 	{ NULL,				0, NULL, 0, -1, -1 }
74 };
75 
76 static void
77 mac_setup_by_id(Mac *mac, int which)
78 {
79 	int evp_len;
80 	mac->type = macs[which].type;
81 	if (mac->type == SSH_EVP) {
82 		mac->evp_md = (*macs[which].mdfunc)();
83 		if ((evp_len = EVP_MD_size(mac->evp_md)) <= 0)
84 			fatal("mac %s len %d", mac->name, evp_len);
85 		mac->key_len = mac->mac_len = (u_int)evp_len;
86 	} else {
87 		mac->mac_len = macs[which].len / 8;
88 		mac->key_len = macs[which].key_len / 8;
89 		mac->umac_ctx = NULL;
90 	}
91 	if (macs[which].truncatebits != 0)
92 		mac->mac_len = macs[which].truncatebits / 8;
93 }
94 
95 int
96 mac_setup(Mac *mac, char *name)
97 {
98 	int i;
99 
100 	for (i = 0; macs[i].name; i++) {
101 		if (strcmp(name, macs[i].name) == 0) {
102 			if (mac != NULL)
103 				mac_setup_by_id(mac, i);
104 			debug2("mac_setup: found %s", name);
105 			return (0);
106 		}
107 	}
108 	debug2("mac_setup: unknown %s", name);
109 	return (-1);
110 }
111 
112 int
113 mac_init(Mac *mac)
114 {
115 	if (mac->key == NULL)
116 		fatal("mac_init: no key");
117 	switch (mac->type) {
118 	case SSH_EVP:
119 		if (mac->evp_md == NULL)
120 			return -1;
121 		HMAC_Init(&mac->evp_ctx, mac->key, mac->key_len, mac->evp_md);
122 		return 0;
123 #ifdef UMAC_HAS_BEEN_UNBROKEN
124 	case SSH_UMAC:
125 		mac->umac_ctx = umac_new(mac->key);
126 		return 0;
127 #endif
128 	default:
129 		return -1;
130 	}
131 }
132 
133 u_char *
134 mac_compute(Mac *mac, u_int32_t seqno, u_char *data, int datalen)
135 {
136 	static u_char m[EVP_MAX_MD_SIZE];
137 	u_char b[4];
138 #ifdef UMAC_HAS_BEEN_UNBROKEN
139 	u_char nonce[8];
140 #endif
141 
142 	if (mac->mac_len > sizeof(m))
143 		fatal("mac_compute: mac too long %u %lu",
144 		    mac->mac_len, (u_long)sizeof(m));
145 
146 	switch (mac->type) {
147 	case SSH_EVP:
148 		put_u32(b, seqno);
149 		/* reset HMAC context */
150 		HMAC_Init(&mac->evp_ctx, NULL, 0, NULL);
151 		HMAC_Update(&mac->evp_ctx, b, sizeof(b));
152 		HMAC_Update(&mac->evp_ctx, data, datalen);
153 		HMAC_Final(&mac->evp_ctx, m, NULL);
154 		break;
155 #ifdef UMAC_HAS_BEEN_UNBROKEN
156 	case SSH_UMAC:
157 		put_u64(nonce, seqno);
158 		umac_update(mac->umac_ctx, data, datalen);
159 		umac_final(mac->umac_ctx, m, nonce);
160 		break;
161 #endif
162 	default:
163 		fatal("mac_compute: unknown MAC type");
164 	}
165 	return (m);
166 }
167 
168 void
169 mac_clear(Mac *mac)
170 {
171 #ifdef UMAC_HAS_BEEN_UNBROKEN
172 	if (mac->type == SSH_UMAC) {
173 		if (mac->umac_ctx != NULL)
174 			umac_delete(mac->umac_ctx);
175 	} else
176 #endif
177 	if (mac->evp_md != NULL)
178 		HMAC_cleanup(&mac->evp_ctx);
179 	mac->evp_md = NULL;
180 	mac->umac_ctx = NULL;
181 }
182 
183 /* XXX copied from ciphers_valid */
184 #define	MAC_SEP	","
185 int
186 mac_valid(const char *names)
187 {
188 	char *maclist, *cp, *p;
189 
190 	if (names == NULL || strcmp(names, "") == 0)
191 		return (0);
192 	maclist = cp = xstrdup(names);
193 	for ((p = strsep(&cp, MAC_SEP)); p && *p != '\0';
194 	    (p = strsep(&cp, MAC_SEP))) {
195 		if (mac_setup(NULL, p) < 0) {
196 			debug("bad mac %s [%s]", p, names);
197 			xfree(maclist);
198 			return (0);
199 		} else {
200 			debug3("mac ok: %s [%s]", p, names);
201 		}
202 	}
203 	debug3("macs ok: [%s]", names);
204 	xfree(maclist);
205 	return (1);
206 }
207