Annotation of src/usr.bin/ssh/ssh-ed25519.c, Revision 1.18
1.18 ! djm 1: /* $OpenBSD: ssh-ed25519.c,v 1.17 2022/10/28 00:43:08 djm Exp $ */
1.1 markus 2: /*
3: * Copyright (c) 2013 Markus Friedl <markus@openbsd.org>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
1.4 djm 17: #define SSHKEY_INTERNAL
1.1 markus 18: #include <sys/types.h>
1.4 djm 19: #include <limits.h>
1.1 markus 20:
21: #include "crypto_api.h"
22:
23: #include <string.h>
24: #include <stdarg.h>
25:
26: #include "log.h"
1.6 markus 27: #include "sshbuf.h"
1.4 djm 28: #include "sshkey.h"
29: #include "ssherr.h"
1.1 markus 30: #include "ssh.h"
31:
1.11 djm 32: static void
33: ssh_ed25519_cleanup(struct sshkey *k)
34: {
35: freezero(k->ed25519_pk, ED25519_PK_SZ);
36: freezero(k->ed25519_sk, ED25519_SK_SZ);
37: k->ed25519_pk = NULL;
38: k->ed25519_sk = NULL;
39: }
40:
1.12 djm 41: static int
42: ssh_ed25519_equal(const struct sshkey *a, const struct sshkey *b)
43: {
44: if (a->ed25519_pk == NULL || b->ed25519_pk == NULL)
45: return 0;
46: if (memcmp(a->ed25519_pk, b->ed25519_pk, ED25519_PK_SZ) != 0)
47: return 0;
48: return 1;
49: }
50:
1.13 djm 51: static int
52: ssh_ed25519_serialize_public(const struct sshkey *key, struct sshbuf *b,
1.16 djm 53: enum sshkey_serialize_rep opts)
1.13 djm 54: {
55: int r;
56:
57: if (key->ed25519_pk == NULL)
58: return SSH_ERR_INVALID_ARGUMENT;
1.16 djm 59: if ((r = sshbuf_put_string(b, key->ed25519_pk, ED25519_PK_SZ)) != 0)
1.13 djm 60: return r;
61:
62: return 0;
63: }
64:
1.14 djm 65: static int
1.18 ! djm 66: ssh_ed25519_serialize_private(const struct sshkey *key, struct sshbuf *b,
! 67: enum sshkey_serialize_rep opts)
! 68: {
! 69: int r;
! 70:
! 71: if ((r = sshbuf_put_string(b, key->ed25519_pk, ED25519_PK_SZ)) != 0 ||
! 72: (r = sshbuf_put_string(b, key->ed25519_sk, ED25519_SK_SZ)) != 0)
! 73: return r;
! 74:
! 75: return 0;
! 76: }
! 77:
! 78: static int
1.14 djm 79: ssh_ed25519_generate(struct sshkey *k, int bits)
80: {
81: if ((k->ed25519_pk = malloc(ED25519_PK_SZ)) == NULL ||
82: (k->ed25519_sk = malloc(ED25519_SK_SZ)) == NULL)
83: return SSH_ERR_ALLOC_FAIL;
84: crypto_sign_ed25519_keypair(k->ed25519_pk, k->ed25519_sk);
85: return 0;
86: }
87:
1.15 djm 88: static int
89: ssh_ed25519_copy_public(const struct sshkey *from, struct sshkey *to)
90: {
91: if (from->ed25519_pk == NULL)
92: return 0; /* XXX SSH_ERR_INTERNAL_ERROR ? */
93: if ((to->ed25519_pk = malloc(ED25519_PK_SZ)) == NULL)
94: return SSH_ERR_ALLOC_FAIL;
95: memcpy(to->ed25519_pk, from->ed25519_pk, ED25519_PK_SZ);
96: return 0;
97: }
98:
1.16 djm 99: static int
100: ssh_ed25519_deserialize_public(const char *ktype, struct sshbuf *b,
101: struct sshkey *key)
102: {
103: u_char *pk = NULL;
104: size_t len = 0;
105: int r;
106:
107: if ((r = sshbuf_get_string(b, &pk, &len)) != 0)
108: return r;
109: if (len != ED25519_PK_SZ) {
110: freezero(pk, len);
111: return SSH_ERR_INVALID_FORMAT;
112: }
113: key->ed25519_pk = pk;
114: return 0;
115: }
116:
1.17 djm 117: static int
118: ssh_ed25519_sign(struct sshkey *key,
119: u_char **sigp, size_t *lenp,
120: const u_char *data, size_t datalen,
121: const char *alg, const char *sk_provider, const char *sk_pin, u_int compat)
1.1 markus 122: {
1.4 djm 123: u_char *sig = NULL;
124: size_t slen = 0, len;
1.1 markus 125: unsigned long long smlen;
1.4 djm 126: int r, ret;
127: struct sshbuf *b = NULL;
1.1 markus 128:
1.4 djm 129: if (lenp != NULL)
130: *lenp = 0;
131: if (sigp != NULL)
132: *sigp = NULL;
133:
134: if (key == NULL ||
135: sshkey_type_plain(key->type) != KEY_ED25519 ||
136: key->ed25519_sk == NULL ||
137: datalen >= INT_MAX - crypto_sign_ed25519_BYTES)
138: return SSH_ERR_INVALID_ARGUMENT;
1.1 markus 139: smlen = slen = datalen + crypto_sign_ed25519_BYTES;
1.4 djm 140: if ((sig = malloc(slen)) == NULL)
141: return SSH_ERR_ALLOC_FAIL;
1.1 markus 142:
143: if ((ret = crypto_sign_ed25519(sig, &smlen, data, datalen,
144: key->ed25519_sk)) != 0 || smlen <= datalen) {
1.4 djm 145: r = SSH_ERR_INVALID_ARGUMENT; /* XXX better error? */
146: goto out;
1.1 markus 147: }
148: /* encode signature */
1.4 djm 149: if ((b = sshbuf_new()) == NULL) {
150: r = SSH_ERR_ALLOC_FAIL;
151: goto out;
152: }
153: if ((r = sshbuf_put_cstring(b, "ssh-ed25519")) != 0 ||
154: (r = sshbuf_put_string(b, sig, smlen - datalen)) != 0)
155: goto out;
156: len = sshbuf_len(b);
157: if (sigp != NULL) {
158: if ((*sigp = malloc(len)) == NULL) {
159: r = SSH_ERR_ALLOC_FAIL;
160: goto out;
161: }
162: memcpy(*sigp, sshbuf_ptr(b), len);
163: }
1.1 markus 164: if (lenp != NULL)
165: *lenp = len;
1.4 djm 166: /* success */
167: r = 0;
168: out:
169: sshbuf_free(b);
1.10 djm 170: if (sig != NULL)
1.8 jsg 171: freezero(sig, slen);
1.1 markus 172:
1.4 djm 173: return r;
1.1 markus 174: }
175:
1.17 djm 176: static int
1.4 djm 177: ssh_ed25519_verify(const struct sshkey *key,
1.17 djm 178: const u_char *sig, size_t siglen,
179: const u_char *data, size_t dlen, const char *alg, u_int compat,
180: struct sshkey_sig_details **detailsp)
1.1 markus 181: {
1.4 djm 182: struct sshbuf *b = NULL;
183: char *ktype = NULL;
184: const u_char *sigblob;
185: u_char *sm = NULL, *m = NULL;
186: size_t len;
187: unsigned long long smlen = 0, mlen = 0;
188: int r, ret;
189:
190: if (key == NULL ||
191: sshkey_type_plain(key->type) != KEY_ED25519 ||
192: key->ed25519_pk == NULL ||
1.17 djm 193: dlen >= INT_MAX - crypto_sign_ed25519_BYTES ||
194: sig == NULL || siglen == 0)
1.4 djm 195: return SSH_ERR_INVALID_ARGUMENT;
196:
1.17 djm 197: if ((b = sshbuf_from(sig, siglen)) == NULL)
1.4 djm 198: return SSH_ERR_ALLOC_FAIL;
199: if ((r = sshbuf_get_cstring(b, &ktype, NULL)) != 0 ||
200: (r = sshbuf_get_string_direct(b, &sigblob, &len)) != 0)
201: goto out;
1.1 markus 202: if (strcmp("ssh-ed25519", ktype) != 0) {
1.4 djm 203: r = SSH_ERR_KEY_TYPE_MISMATCH;
204: goto out;
1.1 markus 205: }
1.4 djm 206: if (sshbuf_len(b) != 0) {
207: r = SSH_ERR_UNEXPECTED_TRAILING_DATA;
208: goto out;
1.1 markus 209: }
210: if (len > crypto_sign_ed25519_BYTES) {
1.4 djm 211: r = SSH_ERR_INVALID_FORMAT;
212: goto out;
1.1 markus 213: }
1.17 djm 214: if (dlen >= SIZE_MAX - len) {
1.5 daniel 215: r = SSH_ERR_INVALID_ARGUMENT;
216: goto out;
217: }
1.17 djm 218: smlen = len + dlen;
1.4 djm 219: mlen = smlen;
1.6 markus 220: if ((sm = malloc(smlen)) == NULL || (m = malloc(mlen)) == NULL) {
1.4 djm 221: r = SSH_ERR_ALLOC_FAIL;
222: goto out;
223: }
1.1 markus 224: memcpy(sm, sigblob, len);
1.17 djm 225: memcpy(sm+len, data, dlen);
1.1 markus 226: if ((ret = crypto_sign_ed25519_open(m, &mlen, sm, smlen,
227: key->ed25519_pk)) != 0) {
1.9 djm 228: debug2_f("crypto_sign_ed25519_open failed: %d", ret);
1.1 markus 229: }
1.17 djm 230: if (ret != 0 || mlen != dlen) {
1.4 djm 231: r = SSH_ERR_SIGNATURE_INVALID;
232: goto out;
1.1 markus 233: }
234: /* XXX compare 'm' and 'data' ? */
1.4 djm 235: /* success */
236: r = 0;
237: out:
1.10 djm 238: if (sm != NULL)
1.8 jsg 239: freezero(sm, smlen);
1.10 djm 240: if (m != NULL)
1.8 jsg 241: freezero(m, smlen); /* NB mlen may be invalid if r != 0 */
1.4 djm 242: sshbuf_free(b);
243: free(ktype);
244: return r;
245: }
1.11 djm 246:
1.12 djm 247: /* NB. not static; used by ED25519-SK */
248: const struct sshkey_impl_funcs sshkey_ed25519_funcs = {
1.11 djm 249: /* .size = */ NULL,
250: /* .alloc = */ NULL,
251: /* .cleanup = */ ssh_ed25519_cleanup,
1.12 djm 252: /* .equal = */ ssh_ed25519_equal,
1.13 djm 253: /* .ssh_serialize_public = */ ssh_ed25519_serialize_public,
1.16 djm 254: /* .ssh_deserialize_public = */ ssh_ed25519_deserialize_public,
1.18 ! djm 255: /* .ssh_serialize_private = */ ssh_ed25519_serialize_private,
1.14 djm 256: /* .generate = */ ssh_ed25519_generate,
1.15 djm 257: /* .copy_public = */ ssh_ed25519_copy_public,
1.17 djm 258: /* .sign = */ ssh_ed25519_sign,
259: /* .verify = */ ssh_ed25519_verify,
1.11 djm 260: };
261:
262: const struct sshkey_impl sshkey_ed25519_impl = {
263: /* .name = */ "ssh-ed25519",
264: /* .shortname = */ "ED25519",
265: /* .sigalg = */ NULL,
266: /* .type = */ KEY_ED25519,
267: /* .nid = */ 0,
268: /* .cert = */ 0,
269: /* .sigonly = */ 0,
270: /* .keybits = */ 256,
271: /* .funcs = */ &sshkey_ed25519_funcs,
272: };
273:
274: const struct sshkey_impl sshkey_ed25519_cert_impl = {
275: /* .name = */ "ssh-ed25519-cert-v01@openssh.com",
276: /* .shortname = */ "ED25519-CERT",
277: /* .sigalg = */ NULL,
278: /* .type = */ KEY_ED25519_CERT,
279: /* .nid = */ 0,
280: /* .cert = */ 1,
281: /* .sigonly = */ 0,
282: /* .keybits = */ 256,
283: /* .funcs = */ &sshkey_ed25519_funcs,
284: };