Annotation of src/usr.bin/ssh/ssh-xmss.c, Revision 1.9
1.9 ! djm 1: /* $OpenBSD: ssh-xmss.c,v 1.8 2022/10/28 00:37:24 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,
65: const char *typename, enum sshkey_serialize_rep opts)
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;
72: if ((r = sshbuf_put_cstring(b, typename)) != 0 ||
73: (r = sshbuf_put_cstring(b, key->xmss_name)) != 0 ||
74: (r = sshbuf_put_string(b, key->xmss_pk,
75: sshkey_xmss_pklen(key))) != 0 ||
76: (r = sshkey_xmss_serialize_pk_info(key, b, opts)) != 0)
77: return r;
78:
79: return 0;
80: }
81:
1.1 markus 82: int
83: ssh_xmss_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
84: const u_char *data, size_t datalen, u_int compat)
85: {
86: u_char *sig = NULL;
87: size_t slen = 0, len = 0, required_siglen;
88: unsigned long long smlen;
89: int r, ret;
90: struct sshbuf *b = NULL;
91:
92: if (lenp != NULL)
93: *lenp = 0;
94: if (sigp != NULL)
95: *sigp = NULL;
96:
97: if (key == NULL ||
98: sshkey_type_plain(key->type) != KEY_XMSS ||
99: key->xmss_sk == NULL ||
100: sshkey_xmss_params(key) == NULL)
101: return SSH_ERR_INVALID_ARGUMENT;
102: if ((r = sshkey_xmss_siglen(key, &required_siglen)) != 0)
103: return r;
104: if (datalen >= INT_MAX - required_siglen)
105: return SSH_ERR_INVALID_ARGUMENT;
106: smlen = slen = datalen + required_siglen;
107: if ((sig = malloc(slen)) == NULL)
108: return SSH_ERR_ALLOC_FAIL;
1.4 dtucker 109: if ((r = sshkey_xmss_get_state(key, 1)) != 0)
1.1 markus 110: goto out;
111: if ((ret = xmss_sign(key->xmss_sk, sshkey_xmss_bds_state(key), sig, &smlen,
112: data, datalen, sshkey_xmss_params(key))) != 0 || smlen <= datalen) {
113: r = SSH_ERR_INVALID_ARGUMENT; /* XXX better error? */
114: goto out;
115: }
116: /* encode signature */
117: if ((b = sshbuf_new()) == NULL) {
118: r = SSH_ERR_ALLOC_FAIL;
119: goto out;
120: }
121: if ((r = sshbuf_put_cstring(b, "ssh-xmss@openssh.com")) != 0 ||
122: (r = sshbuf_put_string(b, sig, smlen - datalen)) != 0)
123: goto out;
124: len = sshbuf_len(b);
125: if (sigp != NULL) {
126: if ((*sigp = malloc(len)) == NULL) {
127: r = SSH_ERR_ALLOC_FAIL;
128: goto out;
129: }
130: memcpy(*sigp, sshbuf_ptr(b), len);
131: }
132: if (lenp != NULL)
133: *lenp = len;
134: /* success */
135: r = 0;
136: out:
1.4 dtucker 137: if ((ret = sshkey_xmss_update_state(key, 1)) != 0) {
1.1 markus 138: /* discard signature since we cannot update the state */
139: if (r == 0 && sigp != NULL && *sigp != NULL) {
140: explicit_bzero(*sigp, len);
141: free(*sigp);
142: }
143: if (sigp != NULL)
144: *sigp = NULL;
145: if (lenp != NULL)
146: *lenp = 0;
147: r = ret;
148: }
149: sshbuf_free(b);
1.2 jsg 150: if (sig != NULL)
151: freezero(sig, slen);
1.1 markus 152:
153: return r;
154: }
155:
156: int
157: ssh_xmss_verify(const struct sshkey *key,
158: const u_char *signature, size_t signaturelen,
159: const u_char *data, size_t datalen, u_int compat)
160: {
161: struct sshbuf *b = NULL;
162: char *ktype = NULL;
163: const u_char *sigblob;
164: u_char *sm = NULL, *m = NULL;
165: size_t len, required_siglen;
166: unsigned long long smlen = 0, mlen = 0;
167: int r, ret;
168:
169: if (key == NULL ||
170: sshkey_type_plain(key->type) != KEY_XMSS ||
171: key->xmss_pk == NULL ||
172: sshkey_xmss_params(key) == NULL ||
173: signature == NULL || signaturelen == 0)
174: return SSH_ERR_INVALID_ARGUMENT;
175: if ((r = sshkey_xmss_siglen(key, &required_siglen)) != 0)
176: return r;
177: if (datalen >= INT_MAX - required_siglen)
178: return SSH_ERR_INVALID_ARGUMENT;
179:
180: if ((b = sshbuf_from(signature, signaturelen)) == NULL)
181: return SSH_ERR_ALLOC_FAIL;
182: if ((r = sshbuf_get_cstring(b, &ktype, NULL)) != 0 ||
183: (r = sshbuf_get_string_direct(b, &sigblob, &len)) != 0)
184: goto out;
185: if (strcmp("ssh-xmss@openssh.com", ktype) != 0) {
186: r = SSH_ERR_KEY_TYPE_MISMATCH;
187: goto out;
188: }
189: if (sshbuf_len(b) != 0) {
190: r = SSH_ERR_UNEXPECTED_TRAILING_DATA;
191: goto out;
192: }
193: if (len != required_siglen) {
194: r = SSH_ERR_INVALID_FORMAT;
195: goto out;
196: }
197: if (datalen >= SIZE_MAX - len) {
198: r = SSH_ERR_INVALID_ARGUMENT;
199: goto out;
200: }
201: smlen = len + datalen;
202: mlen = smlen;
203: if ((sm = malloc(smlen)) == NULL || (m = malloc(mlen)) == NULL) {
204: r = SSH_ERR_ALLOC_FAIL;
205: goto out;
206: }
207: memcpy(sm, sigblob, len);
208: memcpy(sm+len, data, datalen);
209: if ((ret = xmss_sign_open(m, &mlen, sm, smlen,
210: key->xmss_pk, sshkey_xmss_params(key))) != 0) {
1.3 djm 211: debug2_f("xmss_sign_open failed: %d", ret);
1.1 markus 212: }
213: if (ret != 0 || mlen != datalen) {
214: r = SSH_ERR_SIGNATURE_INVALID;
215: goto out;
216: }
217: /* XXX compare 'm' and 'data' ? */
218: /* success */
219: r = 0;
220: out:
1.2 jsg 221: if (sm != NULL)
222: freezero(sm, smlen);
223: if (m != NULL)
224: freezero(m, smlen);
1.1 markus 225: sshbuf_free(b);
226: free(ktype);
227: return r;
228: }
1.6 djm 229:
230: static const struct sshkey_impl_funcs sshkey_xmss_funcs = {
231: /* .size = */ NULL,
232: /* .alloc = */ NULL,
233: /* .cleanup = */ ssh_xmss_cleanup,
1.7 djm 234: /* .equal = */ ssh_xmss_equal,
1.8 djm 235: /* .ssh_serialize_public = */ ssh_xmss_serialize_public,
1.9 ! djm 236: /* .generate = */ sshkey_xmss_generate_private_key,
1.6 djm 237: };
238:
239: const struct sshkey_impl sshkey_xmss_impl = {
240: /* .name = */ "ssh-xmss@openssh.com",
241: /* .shortname = */ "XMSS",
242: /* .sigalg = */ NULL,
243: /* .type = */ KEY_XMSS,
244: /* .nid = */ 0,
245: /* .cert = */ 0,
246: /* .sigonly = */ 0,
247: /* .keybits = */ 256,
248: /* .funcs = */ &sshkey_xmss_funcs,
249: };
250:
251: const struct sshkey_impl sshkey_xmss_cert_impl = {
252: /* .name = */ "ssh-xmss-cert-v01@openssh.com",
253: /* .shortname = */ "XMSS-CERT",
254: /* .sigalg = */ NULL,
255: /* .type = */ KEY_XMSS_CERT,
256: /* .nid = */ 0,
257: /* .cert = */ 1,
258: /* .sigonly = */ 0,
259: /* .keybits = */ 256,
260: /* .funcs = */ &sshkey_xmss_funcs,
261: };