Annotation of src/usr.bin/ssh/ssh-xmss.c, Revision 1.13
1.13 ! djm 1: /* $OpenBSD: ssh-xmss.c,v 1.12 2022/10/28 00:43:08 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
1.13 ! djm 82: ssh_xmss_serialize_private(const struct sshkey *key, struct sshbuf *b,
! 83: enum sshkey_serialize_rep opts)
! 84: {
! 85: int r;
! 86:
! 87: if (key->xmss_name == NULL)
! 88: return SSH_ERR_INVALID_ARGUMENT;
! 89: /* Note: can't reuse ssh_xmss_serialize_public because of sk order */
! 90: if ((r = sshbuf_put_cstring(b, key->xmss_name)) != 0 ||
! 91: (r = sshbuf_put_string(b, key->xmss_pk,
! 92: sshkey_xmss_pklen(key))) != 0 ||
! 93: (r = sshbuf_put_string(b, key->xmss_sk,
! 94: sshkey_xmss_sklen(key))) != 0 ||
! 95: (r = sshkey_xmss_serialize_state_opt(key, b, opts)) != 0)
! 96: return r;
! 97:
! 98: return 0;
! 99: }
! 100:
! 101: static int
1.10 djm 102: ssh_xmss_copy_public(const struct sshkey *from, struct sshkey *to)
103: {
104: int r = SSH_ERR_INTERNAL_ERROR;
105: u_int32_t left;
106: size_t pklen;
107:
108: if ((r = sshkey_xmss_init(to, from->xmss_name)) != 0)
109: return r;
110: if (from->xmss_pk == NULL)
111: return 0; /* XXX SSH_ERR_INTERNAL_ERROR ? */
112:
113: if ((pklen = sshkey_xmss_pklen(from)) == 0 ||
114: sshkey_xmss_pklen(to) != pklen)
115: return SSH_ERR_INTERNAL_ERROR;
116: if ((to->xmss_pk = malloc(pklen)) == NULL)
117: return SSH_ERR_ALLOC_FAIL;
118: memcpy(to->xmss_pk, from->xmss_pk, pklen);
119: /* simulate number of signatures left on pubkey */
120: left = sshkey_xmss_signatures_left(from);
121: if (left)
122: sshkey_xmss_enable_maxsign(to, left);
123: return 0;
124: }
125:
1.11 djm 126: static int
127: ssh_xmss_deserialize_public(const char *ktype, struct sshbuf *b,
128: struct sshkey *key)
129: {
130: size_t len = 0;
131: char *xmss_name = NULL;
132: u_char *pk = NULL;
133: int ret = SSH_ERR_INTERNAL_ERROR;
134:
135: if ((ret = sshbuf_get_cstring(b, &xmss_name, NULL)) != 0)
136: goto out;
137: if ((ret = sshkey_xmss_init(key, xmss_name)) != 0)
138: goto out;
139: if ((ret = sshbuf_get_string(b, &pk, &len)) != 0)
140: goto out;
141: if (len == 0 || len != sshkey_xmss_pklen(key)) {
142: ret = SSH_ERR_INVALID_FORMAT;
143: goto out;
144: }
145: key->xmss_pk = pk;
146: pk = NULL;
147: if (!sshkey_is_cert(key) &&
148: (ret = sshkey_xmss_deserialize_pk_info(key, b)) != 0)
149: goto out;
150: /* success */
151: ret = 0;
152: out:
153: free(xmss_name);
154: freezero(pk, len);
155: return ret;
156: }
157:
1.12 djm 158: static int
159: ssh_xmss_sign(struct sshkey *key,
160: u_char **sigp, size_t *lenp,
161: const u_char *data, size_t datalen,
162: const char *alg, const char *sk_provider, const char *sk_pin, u_int compat)
1.1 markus 163: {
164: u_char *sig = NULL;
165: size_t slen = 0, len = 0, required_siglen;
166: unsigned long long smlen;
167: int r, ret;
168: struct sshbuf *b = NULL;
169:
170: if (lenp != NULL)
171: *lenp = 0;
172: if (sigp != NULL)
173: *sigp = NULL;
174:
175: if (key == NULL ||
176: sshkey_type_plain(key->type) != KEY_XMSS ||
177: key->xmss_sk == NULL ||
178: sshkey_xmss_params(key) == NULL)
179: return SSH_ERR_INVALID_ARGUMENT;
180: if ((r = sshkey_xmss_siglen(key, &required_siglen)) != 0)
181: return r;
182: if (datalen >= INT_MAX - required_siglen)
183: return SSH_ERR_INVALID_ARGUMENT;
184: smlen = slen = datalen + required_siglen;
185: if ((sig = malloc(slen)) == NULL)
186: return SSH_ERR_ALLOC_FAIL;
1.4 dtucker 187: if ((r = sshkey_xmss_get_state(key, 1)) != 0)
1.1 markus 188: goto out;
189: if ((ret = xmss_sign(key->xmss_sk, sshkey_xmss_bds_state(key), sig, &smlen,
190: data, datalen, sshkey_xmss_params(key))) != 0 || smlen <= datalen) {
191: r = SSH_ERR_INVALID_ARGUMENT; /* XXX better error? */
192: goto out;
193: }
194: /* encode signature */
195: if ((b = sshbuf_new()) == NULL) {
196: r = SSH_ERR_ALLOC_FAIL;
197: goto out;
198: }
199: if ((r = sshbuf_put_cstring(b, "ssh-xmss@openssh.com")) != 0 ||
200: (r = sshbuf_put_string(b, sig, smlen - datalen)) != 0)
201: goto out;
202: len = sshbuf_len(b);
203: if (sigp != NULL) {
204: if ((*sigp = malloc(len)) == NULL) {
205: r = SSH_ERR_ALLOC_FAIL;
206: goto out;
207: }
208: memcpy(*sigp, sshbuf_ptr(b), len);
209: }
210: if (lenp != NULL)
211: *lenp = len;
212: /* success */
213: r = 0;
214: out:
1.4 dtucker 215: if ((ret = sshkey_xmss_update_state(key, 1)) != 0) {
1.1 markus 216: /* discard signature since we cannot update the state */
217: if (r == 0 && sigp != NULL && *sigp != NULL) {
218: explicit_bzero(*sigp, len);
219: free(*sigp);
220: }
221: if (sigp != NULL)
222: *sigp = NULL;
223: if (lenp != NULL)
224: *lenp = 0;
225: r = ret;
226: }
227: sshbuf_free(b);
1.2 jsg 228: if (sig != NULL)
229: freezero(sig, slen);
1.1 markus 230:
231: return r;
232: }
233:
1.12 djm 234: static int
1.1 markus 235: ssh_xmss_verify(const struct sshkey *key,
1.12 djm 236: const u_char *sig, size_t siglen,
237: const u_char *data, size_t dlen, const char *alg, u_int compat,
238: struct sshkey_sig_details **detailsp)
1.1 markus 239: {
240: struct sshbuf *b = NULL;
241: char *ktype = NULL;
242: const u_char *sigblob;
243: u_char *sm = NULL, *m = NULL;
244: size_t len, required_siglen;
245: unsigned long long smlen = 0, mlen = 0;
246: int r, ret;
247:
248: if (key == NULL ||
249: sshkey_type_plain(key->type) != KEY_XMSS ||
250: key->xmss_pk == NULL ||
251: sshkey_xmss_params(key) == NULL ||
1.12 djm 252: sig == NULL || siglen == 0)
1.1 markus 253: return SSH_ERR_INVALID_ARGUMENT;
254: if ((r = sshkey_xmss_siglen(key, &required_siglen)) != 0)
255: return r;
1.12 djm 256: if (dlen >= INT_MAX - required_siglen)
1.1 markus 257: return SSH_ERR_INVALID_ARGUMENT;
258:
1.12 djm 259: if ((b = sshbuf_from(sig, siglen)) == NULL)
1.1 markus 260: return SSH_ERR_ALLOC_FAIL;
261: if ((r = sshbuf_get_cstring(b, &ktype, NULL)) != 0 ||
262: (r = sshbuf_get_string_direct(b, &sigblob, &len)) != 0)
263: goto out;
264: if (strcmp("ssh-xmss@openssh.com", ktype) != 0) {
265: r = SSH_ERR_KEY_TYPE_MISMATCH;
266: goto out;
267: }
268: if (sshbuf_len(b) != 0) {
269: r = SSH_ERR_UNEXPECTED_TRAILING_DATA;
270: goto out;
271: }
272: if (len != required_siglen) {
273: r = SSH_ERR_INVALID_FORMAT;
274: goto out;
275: }
1.12 djm 276: if (dlen >= SIZE_MAX - len) {
1.1 markus 277: r = SSH_ERR_INVALID_ARGUMENT;
278: goto out;
279: }
1.12 djm 280: smlen = len + dlen;
1.1 markus 281: mlen = smlen;
282: if ((sm = malloc(smlen)) == NULL || (m = malloc(mlen)) == NULL) {
283: r = SSH_ERR_ALLOC_FAIL;
284: goto out;
285: }
286: memcpy(sm, sigblob, len);
1.12 djm 287: memcpy(sm+len, data, dlen);
1.1 markus 288: if ((ret = xmss_sign_open(m, &mlen, sm, smlen,
289: key->xmss_pk, sshkey_xmss_params(key))) != 0) {
1.3 djm 290: debug2_f("xmss_sign_open failed: %d", ret);
1.1 markus 291: }
1.12 djm 292: if (ret != 0 || mlen != dlen) {
1.1 markus 293: r = SSH_ERR_SIGNATURE_INVALID;
294: goto out;
295: }
296: /* XXX compare 'm' and 'data' ? */
297: /* success */
298: r = 0;
299: out:
1.2 jsg 300: if (sm != NULL)
301: freezero(sm, smlen);
302: if (m != NULL)
303: freezero(m, smlen);
1.1 markus 304: sshbuf_free(b);
305: free(ktype);
306: return r;
307: }
1.6 djm 308:
309: static const struct sshkey_impl_funcs sshkey_xmss_funcs = {
310: /* .size = */ NULL,
311: /* .alloc = */ NULL,
312: /* .cleanup = */ ssh_xmss_cleanup,
1.7 djm 313: /* .equal = */ ssh_xmss_equal,
1.8 djm 314: /* .ssh_serialize_public = */ ssh_xmss_serialize_public,
1.11 djm 315: /* .ssh_deserialize_public = */ ssh_xmss_deserialize_public,
1.13 ! djm 316: /* .ssh_serialize_private = */ ssh_xmss_serialize_private,
1.9 djm 317: /* .generate = */ sshkey_xmss_generate_private_key,
1.10 djm 318: /* .copy_public = */ ssh_xmss_copy_public,
1.12 djm 319: /* .sign = */ ssh_xmss_sign,
320: /* .verify = */ ssh_xmss_verify,
1.6 djm 321: };
322:
323: const struct sshkey_impl sshkey_xmss_impl = {
324: /* .name = */ "ssh-xmss@openssh.com",
325: /* .shortname = */ "XMSS",
326: /* .sigalg = */ NULL,
327: /* .type = */ KEY_XMSS,
328: /* .nid = */ 0,
329: /* .cert = */ 0,
330: /* .sigonly = */ 0,
331: /* .keybits = */ 256,
332: /* .funcs = */ &sshkey_xmss_funcs,
333: };
334:
335: const struct sshkey_impl sshkey_xmss_cert_impl = {
336: /* .name = */ "ssh-xmss-cert-v01@openssh.com",
337: /* .shortname = */ "XMSS-CERT",
338: /* .sigalg = */ NULL,
339: /* .type = */ KEY_XMSS_CERT,
340: /* .nid = */ 0,
341: /* .cert = */ 1,
342: /* .sigonly = */ 0,
343: /* .keybits = */ 256,
344: /* .funcs = */ &sshkey_xmss_funcs,
345: };
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh-xmss.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh