Annotation of src/usr.bin/ssh/ssh-xmss.c, Revision 1.12
1.12 ! djm 1: /* $OpenBSD: ssh-xmss.c,v 1.11 2022/10/28 00:41:52 djm Exp $*/
1.1 markus 2: /*
3: * Copyright (c) 2017 Stefan-Lukas Gazdag.
4: * Copyright (c) 2017 Markus Friedl.
5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18: #define SSHKEY_INTERNAL
19: #include <sys/types.h>
20: #include <limits.h>
21:
1.5 millert 22: #include <stdlib.h>
1.1 markus 23: #include <string.h>
24: #include <stdarg.h>
1.5 millert 25: #include <stdint.h>
1.1 markus 26: #include <unistd.h>
27:
28: #include "log.h"
29: #include "sshbuf.h"
30: #include "sshkey.h"
31: #include "sshkey-xmss.h"
32: #include "ssherr.h"
33: #include "ssh.h"
34:
35: #include "xmss_fast.h"
36:
1.6 djm 37: static void
38: ssh_xmss_cleanup(struct sshkey *k)
39: {
40: freezero(k->xmss_pk, sshkey_xmss_pklen(k));
41: freezero(k->xmss_sk, sshkey_xmss_sklen(k));
42: sshkey_xmss_free_state(k);
43: free(k->xmss_name);
44: free(k->xmss_filename);
45: k->xmss_pk = NULL;
46: k->xmss_sk = NULL;
47: k->xmss_name = NULL;
48: k->xmss_filename = NULL;
49: }
50:
1.7 djm 51: static int
52: ssh_xmss_equal(const struct sshkey *a, const struct sshkey *b)
53: {
54: if (a->xmss_pk == NULL || b->xmss_pk == NULL)
55: return 0;
56: if (sshkey_xmss_pklen(a) != sshkey_xmss_pklen(b))
57: return 0;
58: if (memcmp(a->xmss_pk, b->xmss_pk, sshkey_xmss_pklen(a)) != 0)
59: return 0;
60: return 1;
61: }
62:
1.8 djm 63: static int
64: ssh_xmss_serialize_public(const struct sshkey *key, struct sshbuf *b,
1.11 djm 65: enum sshkey_serialize_rep opts)
1.8 djm 66: {
67: int r;
68:
69: if (key->xmss_name == NULL || key->xmss_pk == NULL ||
70: sshkey_xmss_pklen(key) == 0)
71: return SSH_ERR_INVALID_ARGUMENT;
1.11 djm 72: if ((r = sshbuf_put_cstring(b, key->xmss_name)) != 0 ||
1.8 djm 73: (r = sshbuf_put_string(b, key->xmss_pk,
74: sshkey_xmss_pklen(key))) != 0 ||
75: (r = sshkey_xmss_serialize_pk_info(key, b, opts)) != 0)
76: return r;
77:
78: return 0;
79: }
80:
1.10 djm 81: static int
82: ssh_xmss_copy_public(const struct sshkey *from, struct sshkey *to)
83: {
84: int r = SSH_ERR_INTERNAL_ERROR;
85: u_int32_t left;
86: size_t pklen;
87:
88: if ((r = sshkey_xmss_init(to, from->xmss_name)) != 0)
89: return r;
90: if (from->xmss_pk == NULL)
91: return 0; /* XXX SSH_ERR_INTERNAL_ERROR ? */
92:
93: if ((pklen = sshkey_xmss_pklen(from)) == 0 ||
94: sshkey_xmss_pklen(to) != pklen)
95: return SSH_ERR_INTERNAL_ERROR;
96: if ((to->xmss_pk = malloc(pklen)) == NULL)
97: return SSH_ERR_ALLOC_FAIL;
98: memcpy(to->xmss_pk, from->xmss_pk, pklen);
99: /* simulate number of signatures left on pubkey */
100: left = sshkey_xmss_signatures_left(from);
101: if (left)
102: sshkey_xmss_enable_maxsign(to, left);
103: return 0;
104: }
105:
1.11 djm 106: static int
107: ssh_xmss_deserialize_public(const char *ktype, struct sshbuf *b,
108: struct sshkey *key)
109: {
110: size_t len = 0;
111: char *xmss_name = NULL;
112: u_char *pk = NULL;
113: int ret = SSH_ERR_INTERNAL_ERROR;
114:
115: if ((ret = sshbuf_get_cstring(b, &xmss_name, NULL)) != 0)
116: goto out;
117: if ((ret = sshkey_xmss_init(key, xmss_name)) != 0)
118: goto out;
119: if ((ret = sshbuf_get_string(b, &pk, &len)) != 0)
120: goto out;
121: if (len == 0 || len != sshkey_xmss_pklen(key)) {
122: ret = SSH_ERR_INVALID_FORMAT;
123: goto out;
124: }
125: key->xmss_pk = pk;
126: pk = NULL;
127: if (!sshkey_is_cert(key) &&
128: (ret = sshkey_xmss_deserialize_pk_info(key, b)) != 0)
129: goto out;
130: /* success */
131: ret = 0;
132: out:
133: free(xmss_name);
134: freezero(pk, len);
135: return ret;
136: }
137:
1.12 ! djm 138: static int
! 139: ssh_xmss_sign(struct sshkey *key,
! 140: u_char **sigp, size_t *lenp,
! 141: const u_char *data, size_t datalen,
! 142: const char *alg, const char *sk_provider, const char *sk_pin, u_int compat)
1.1 markus 143: {
144: u_char *sig = NULL;
145: size_t slen = 0, len = 0, required_siglen;
146: unsigned long long smlen;
147: int r, ret;
148: struct sshbuf *b = NULL;
149:
150: if (lenp != NULL)
151: *lenp = 0;
152: if (sigp != NULL)
153: *sigp = NULL;
154:
155: if (key == NULL ||
156: sshkey_type_plain(key->type) != KEY_XMSS ||
157: key->xmss_sk == NULL ||
158: sshkey_xmss_params(key) == NULL)
159: return SSH_ERR_INVALID_ARGUMENT;
160: if ((r = sshkey_xmss_siglen(key, &required_siglen)) != 0)
161: return r;
162: if (datalen >= INT_MAX - required_siglen)
163: return SSH_ERR_INVALID_ARGUMENT;
164: smlen = slen = datalen + required_siglen;
165: if ((sig = malloc(slen)) == NULL)
166: return SSH_ERR_ALLOC_FAIL;
1.4 dtucker 167: if ((r = sshkey_xmss_get_state(key, 1)) != 0)
1.1 markus 168: goto out;
169: if ((ret = xmss_sign(key->xmss_sk, sshkey_xmss_bds_state(key), sig, &smlen,
170: data, datalen, sshkey_xmss_params(key))) != 0 || smlen <= datalen) {
171: r = SSH_ERR_INVALID_ARGUMENT; /* XXX better error? */
172: goto out;
173: }
174: /* encode signature */
175: if ((b = sshbuf_new()) == NULL) {
176: r = SSH_ERR_ALLOC_FAIL;
177: goto out;
178: }
179: if ((r = sshbuf_put_cstring(b, "ssh-xmss@openssh.com")) != 0 ||
180: (r = sshbuf_put_string(b, sig, smlen - datalen)) != 0)
181: goto out;
182: len = sshbuf_len(b);
183: if (sigp != NULL) {
184: if ((*sigp = malloc(len)) == NULL) {
185: r = SSH_ERR_ALLOC_FAIL;
186: goto out;
187: }
188: memcpy(*sigp, sshbuf_ptr(b), len);
189: }
190: if (lenp != NULL)
191: *lenp = len;
192: /* success */
193: r = 0;
194: out:
1.4 dtucker 195: if ((ret = sshkey_xmss_update_state(key, 1)) != 0) {
1.1 markus 196: /* discard signature since we cannot update the state */
197: if (r == 0 && sigp != NULL && *sigp != NULL) {
198: explicit_bzero(*sigp, len);
199: free(*sigp);
200: }
201: if (sigp != NULL)
202: *sigp = NULL;
203: if (lenp != NULL)
204: *lenp = 0;
205: r = ret;
206: }
207: sshbuf_free(b);
1.2 jsg 208: if (sig != NULL)
209: freezero(sig, slen);
1.1 markus 210:
211: return r;
212: }
213:
1.12 ! djm 214: static int
1.1 markus 215: ssh_xmss_verify(const struct sshkey *key,
1.12 ! djm 216: const u_char *sig, size_t siglen,
! 217: const u_char *data, size_t dlen, const char *alg, u_int compat,
! 218: struct sshkey_sig_details **detailsp)
1.1 markus 219: {
220: struct sshbuf *b = NULL;
221: char *ktype = NULL;
222: const u_char *sigblob;
223: u_char *sm = NULL, *m = NULL;
224: size_t len, required_siglen;
225: unsigned long long smlen = 0, mlen = 0;
226: int r, ret;
227:
228: if (key == NULL ||
229: sshkey_type_plain(key->type) != KEY_XMSS ||
230: key->xmss_pk == NULL ||
231: sshkey_xmss_params(key) == NULL ||
1.12 ! djm 232: sig == NULL || siglen == 0)
1.1 markus 233: return SSH_ERR_INVALID_ARGUMENT;
234: if ((r = sshkey_xmss_siglen(key, &required_siglen)) != 0)
235: return r;
1.12 ! djm 236: if (dlen >= INT_MAX - required_siglen)
1.1 markus 237: return SSH_ERR_INVALID_ARGUMENT;
238:
1.12 ! djm 239: if ((b = sshbuf_from(sig, siglen)) == NULL)
1.1 markus 240: return SSH_ERR_ALLOC_FAIL;
241: if ((r = sshbuf_get_cstring(b, &ktype, NULL)) != 0 ||
242: (r = sshbuf_get_string_direct(b, &sigblob, &len)) != 0)
243: goto out;
244: if (strcmp("ssh-xmss@openssh.com", ktype) != 0) {
245: r = SSH_ERR_KEY_TYPE_MISMATCH;
246: goto out;
247: }
248: if (sshbuf_len(b) != 0) {
249: r = SSH_ERR_UNEXPECTED_TRAILING_DATA;
250: goto out;
251: }
252: if (len != required_siglen) {
253: r = SSH_ERR_INVALID_FORMAT;
254: goto out;
255: }
1.12 ! djm 256: if (dlen >= SIZE_MAX - len) {
1.1 markus 257: r = SSH_ERR_INVALID_ARGUMENT;
258: goto out;
259: }
1.12 ! djm 260: smlen = len + dlen;
1.1 markus 261: mlen = smlen;
262: if ((sm = malloc(smlen)) == NULL || (m = malloc(mlen)) == NULL) {
263: r = SSH_ERR_ALLOC_FAIL;
264: goto out;
265: }
266: memcpy(sm, sigblob, len);
1.12 ! djm 267: memcpy(sm+len, data, dlen);
1.1 markus 268: if ((ret = xmss_sign_open(m, &mlen, sm, smlen,
269: key->xmss_pk, sshkey_xmss_params(key))) != 0) {
1.3 djm 270: debug2_f("xmss_sign_open failed: %d", ret);
1.1 markus 271: }
1.12 ! djm 272: if (ret != 0 || mlen != dlen) {
1.1 markus 273: r = SSH_ERR_SIGNATURE_INVALID;
274: goto out;
275: }
276: /* XXX compare 'm' and 'data' ? */
277: /* success */
278: r = 0;
279: out:
1.2 jsg 280: if (sm != NULL)
281: freezero(sm, smlen);
282: if (m != NULL)
283: freezero(m, smlen);
1.1 markus 284: sshbuf_free(b);
285: free(ktype);
286: return r;
287: }
1.6 djm 288:
289: static const struct sshkey_impl_funcs sshkey_xmss_funcs = {
290: /* .size = */ NULL,
291: /* .alloc = */ NULL,
292: /* .cleanup = */ ssh_xmss_cleanup,
1.7 djm 293: /* .equal = */ ssh_xmss_equal,
1.8 djm 294: /* .ssh_serialize_public = */ ssh_xmss_serialize_public,
1.11 djm 295: /* .ssh_deserialize_public = */ ssh_xmss_deserialize_public,
1.9 djm 296: /* .generate = */ sshkey_xmss_generate_private_key,
1.10 djm 297: /* .copy_public = */ ssh_xmss_copy_public,
1.12 ! djm 298: /* .sign = */ ssh_xmss_sign,
! 299: /* .verify = */ ssh_xmss_verify,
1.6 djm 300: };
301:
302: const struct sshkey_impl sshkey_xmss_impl = {
303: /* .name = */ "ssh-xmss@openssh.com",
304: /* .shortname = */ "XMSS",
305: /* .sigalg = */ NULL,
306: /* .type = */ KEY_XMSS,
307: /* .nid = */ 0,
308: /* .cert = */ 0,
309: /* .sigonly = */ 0,
310: /* .keybits = */ 256,
311: /* .funcs = */ &sshkey_xmss_funcs,
312: };
313:
314: const struct sshkey_impl sshkey_xmss_cert_impl = {
315: /* .name = */ "ssh-xmss-cert-v01@openssh.com",
316: /* .shortname = */ "XMSS-CERT",
317: /* .sigalg = */ NULL,
318: /* .type = */ KEY_XMSS_CERT,
319: /* .nid = */ 0,
320: /* .cert = */ 1,
321: /* .sigonly = */ 0,
322: /* .keybits = */ 256,
323: /* .funcs = */ &sshkey_xmss_funcs,
324: };