2024-08-15 00:51:51 +00:00
|
|
|
/* $OpenBSD: ssh-pkcs11-client.c,v 1.20 2024/08/15 00:51:51 djm Exp $ */
|
2010-02-11 22:21:02 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2010 Markus Friedl. All rights reserved.
|
2019-01-20 22:51:37 +00:00
|
|
|
* Copyright (c) 2014 Pedro Martelletto. All rights reserved.
|
2010-02-11 22:21:02 +00:00
|
|
|
*
|
|
|
|
* Permission to use, copy, modify, and distribute this software for any
|
|
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
|
|
* copyright notice and this permission notice appear in all copies.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
|
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
|
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
|
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
|
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
2010-02-11 22:49:06 +00:00
|
|
|
#include "includes.h"
|
|
|
|
|
2010-02-11 23:06:28 +00:00
|
|
|
#ifdef ENABLE_PKCS11
|
|
|
|
|
2010-02-11 22:21:02 +00:00
|
|
|
#include <sys/types.h>
|
2010-02-11 22:49:06 +00:00
|
|
|
#ifdef HAVE_SYS_TIME_H
|
|
|
|
# include <sys/time.h>
|
|
|
|
#endif
|
2010-02-11 22:21:02 +00:00
|
|
|
#include <sys/socket.h>
|
|
|
|
|
|
|
|
#include <stdarg.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include <unistd.h>
|
|
|
|
#include <errno.h>
|
2023-07-19 14:03:45 +00:00
|
|
|
#include <limits.h>
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2019-01-20 22:51:37 +00:00
|
|
|
#include <openssl/ecdsa.h>
|
2014-07-02 05:28:02 +00:00
|
|
|
#include <openssl/rsa.h>
|
|
|
|
|
2010-02-11 22:21:02 +00:00
|
|
|
#include "pathnames.h"
|
|
|
|
#include "xmalloc.h"
|
2018-07-09 20:39:28 +00:00
|
|
|
#include "sshbuf.h"
|
2010-02-11 22:21:02 +00:00
|
|
|
#include "log.h"
|
|
|
|
#include "misc.h"
|
2018-07-09 20:39:28 +00:00
|
|
|
#include "sshkey.h"
|
2010-02-11 22:21:02 +00:00
|
|
|
#include "authfd.h"
|
|
|
|
#include "atomicio.h"
|
|
|
|
#include "ssh-pkcs11.h"
|
2018-07-09 20:39:28 +00:00
|
|
|
#include "ssherr.h"
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
#include "openbsd-compat/openssl-compat.h"
|
|
|
|
|
2023-07-20 02:53:21 +00:00
|
|
|
#if !defined(OPENSSL_HAS_ECC) || !defined(HAVE_EC_KEY_METHOD_NEW)
|
|
|
|
#define EC_KEY_METHOD void
|
|
|
|
#define EC_KEY void
|
|
|
|
#endif
|
|
|
|
|
2010-02-11 22:21:02 +00:00
|
|
|
/* borrows code from sftp-server and ssh-agent */
|
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
/*
|
|
|
|
* Maintain a list of ssh-pkcs11-helper subprocesses. These may be looked up
|
|
|
|
* by provider path or their unique EC/RSA METHOD pointers.
|
|
|
|
*/
|
|
|
|
struct helper {
|
|
|
|
char *path;
|
|
|
|
pid_t pid;
|
|
|
|
int fd;
|
|
|
|
RSA_METHOD *rsa_meth;
|
|
|
|
EC_KEY_METHOD *ec_meth;
|
|
|
|
int (*rsa_finish)(RSA *rsa);
|
|
|
|
void (*ec_finish)(EC_KEY *key);
|
|
|
|
size_t nrsa, nec; /* number of active keys of each type */
|
|
|
|
};
|
|
|
|
static struct helper **helpers;
|
|
|
|
static size_t nhelpers;
|
|
|
|
|
|
|
|
static struct helper *
|
|
|
|
helper_by_provider(const char *path)
|
|
|
|
{
|
|
|
|
size_t i;
|
|
|
|
|
|
|
|
for (i = 0; i < nhelpers; i++) {
|
|
|
|
if (helpers[i] == NULL || helpers[i]->path == NULL ||
|
|
|
|
helpers[i]->fd == -1)
|
|
|
|
continue;
|
|
|
|
if (strcmp(helpers[i]->path, path) == 0)
|
|
|
|
return helpers[i];
|
|
|
|
}
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
static struct helper *
|
|
|
|
helper_by_rsa(const RSA *rsa)
|
|
|
|
{
|
|
|
|
size_t i;
|
|
|
|
const RSA_METHOD *meth;
|
|
|
|
|
|
|
|
if ((meth = RSA_get_method(rsa)) == NULL)
|
|
|
|
return NULL;
|
|
|
|
for (i = 0; i < nhelpers; i++) {
|
|
|
|
if (helpers[i] != NULL && helpers[i]->rsa_meth == meth)
|
|
|
|
return helpers[i];
|
|
|
|
}
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2023-07-25 03:00:22 +00:00
|
|
|
#if defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW)
|
2023-07-19 14:03:45 +00:00
|
|
|
static struct helper *
|
|
|
|
helper_by_ec(const EC_KEY *ec)
|
|
|
|
{
|
|
|
|
size_t i;
|
|
|
|
const EC_KEY_METHOD *meth;
|
|
|
|
|
|
|
|
if ((meth = EC_KEY_get_method(ec)) == NULL)
|
|
|
|
return NULL;
|
|
|
|
for (i = 0; i < nhelpers; i++) {
|
|
|
|
if (helpers[i] != NULL && helpers[i]->ec_meth == meth)
|
|
|
|
return helpers[i];
|
|
|
|
}
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
}
|
2023-07-25 03:00:22 +00:00
|
|
|
#endif /* defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW) */
|
2023-07-19 14:03:45 +00:00
|
|
|
|
|
|
|
static void
|
|
|
|
helper_free(struct helper *helper)
|
|
|
|
{
|
|
|
|
size_t i;
|
|
|
|
int found = 0;
|
|
|
|
|
|
|
|
if (helper == NULL)
|
|
|
|
return;
|
|
|
|
if (helper->path == NULL || helper->ec_meth == NULL ||
|
|
|
|
helper->rsa_meth == NULL)
|
|
|
|
fatal_f("inconsistent helper");
|
|
|
|
debug3_f("free helper for provider %s", helper->path);
|
|
|
|
for (i = 0; i < nhelpers; i++) {
|
|
|
|
if (helpers[i] == helper) {
|
|
|
|
if (found)
|
|
|
|
fatal_f("helper recorded more than once");
|
|
|
|
found = 1;
|
|
|
|
}
|
|
|
|
else if (found)
|
|
|
|
helpers[i - 1] = helpers[i];
|
|
|
|
}
|
|
|
|
if (found) {
|
|
|
|
helpers = xrecallocarray(helpers, nhelpers,
|
|
|
|
nhelpers - 1, sizeof(*helpers));
|
|
|
|
nhelpers--;
|
|
|
|
}
|
|
|
|
free(helper->path);
|
2023-07-20 02:53:21 +00:00
|
|
|
#if defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW)
|
2023-07-19 14:03:45 +00:00
|
|
|
EC_KEY_METHOD_free(helper->ec_meth);
|
2023-07-20 02:53:21 +00:00
|
|
|
#endif
|
2023-07-19 14:03:45 +00:00
|
|
|
RSA_meth_free(helper->rsa_meth);
|
|
|
|
free(helper);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
helper_terminate(struct helper *helper)
|
|
|
|
{
|
|
|
|
if (helper == NULL) {
|
|
|
|
return;
|
|
|
|
} else if (helper->fd == -1) {
|
|
|
|
debug3_f("already terminated");
|
|
|
|
} else {
|
|
|
|
debug3_f("terminating helper for %s; "
|
|
|
|
"remaining %zu RSA %zu ECDSA",
|
|
|
|
helper->path, helper->nrsa, helper->nec);
|
|
|
|
close(helper->fd);
|
|
|
|
/* XXX waitpid() */
|
|
|
|
helper->fd = -1;
|
|
|
|
helper->pid = -1;
|
|
|
|
}
|
|
|
|
/*
|
|
|
|
* Don't delete the helper entry until there are no remaining keys
|
|
|
|
* that reference it. Otherwise, any signing operation would call
|
|
|
|
* a free'd METHOD pointer and that would be bad.
|
|
|
|
*/
|
|
|
|
if (helper->nrsa == 0 && helper->nec == 0)
|
|
|
|
helper_free(helper);
|
|
|
|
}
|
2010-02-11 22:21:02 +00:00
|
|
|
|
|
|
|
static void
|
2023-07-19 14:03:45 +00:00
|
|
|
send_msg(int fd, struct sshbuf *m)
|
2010-02-11 22:21:02 +00:00
|
|
|
{
|
|
|
|
u_char buf[4];
|
2018-07-09 20:39:28 +00:00
|
|
|
size_t mlen = sshbuf_len(m);
|
|
|
|
int r;
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
if (fd == -1)
|
|
|
|
return;
|
2018-07-09 20:39:28 +00:00
|
|
|
POKE_U32(buf, mlen);
|
2010-02-11 22:21:02 +00:00
|
|
|
if (atomicio(vwrite, fd, buf, 4) != 4 ||
|
2018-07-09 21:59:10 +00:00
|
|
|
atomicio(vwrite, fd, sshbuf_mutable_ptr(m),
|
2018-07-09 20:39:28 +00:00
|
|
|
sshbuf_len(m)) != sshbuf_len(m))
|
2010-02-11 22:21:02 +00:00
|
|
|
error("write to helper failed");
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((r = sshbuf_consume(m, mlen)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "consume");
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static int
|
2023-07-19 14:03:45 +00:00
|
|
|
recv_msg(int fd, struct sshbuf *m)
|
2010-02-11 22:21:02 +00:00
|
|
|
{
|
|
|
|
u_int l, len;
|
2018-07-09 20:39:28 +00:00
|
|
|
u_char c, buf[1024];
|
|
|
|
int r;
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
sshbuf_reset(m);
|
|
|
|
if (fd == -1)
|
|
|
|
return 0; /* XXX */
|
2010-02-11 22:21:02 +00:00
|
|
|
if ((len = atomicio(read, fd, buf, 4)) != 4) {
|
|
|
|
error("read from helper failed: %u", len);
|
|
|
|
return (0); /* XXX */
|
|
|
|
}
|
2018-07-09 20:39:28 +00:00
|
|
|
len = PEEK_U32(buf);
|
2010-02-11 22:21:02 +00:00
|
|
|
if (len > 256 * 1024)
|
|
|
|
fatal("response too long: %u", len);
|
|
|
|
/* read len bytes into m */
|
|
|
|
while (len > 0) {
|
|
|
|
l = len;
|
|
|
|
if (l > sizeof(buf))
|
|
|
|
l = sizeof(buf);
|
|
|
|
if (atomicio(read, fd, buf, l) != l) {
|
|
|
|
error("response from helper failed.");
|
|
|
|
return (0); /* XXX */
|
|
|
|
}
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((r = sshbuf_put(m, buf, l)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "sshbuf_put");
|
2010-02-11 22:21:02 +00:00
|
|
|
len -= l;
|
|
|
|
}
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((r = sshbuf_get_u8(m, &c)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "parse type");
|
2018-07-09 20:39:28 +00:00
|
|
|
return c;
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
int
|
|
|
|
pkcs11_init(int interactive)
|
|
|
|
{
|
2023-07-19 14:03:45 +00:00
|
|
|
return 0;
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void
|
|
|
|
pkcs11_terminate(void)
|
|
|
|
{
|
2023-07-19 14:03:45 +00:00
|
|
|
size_t i;
|
|
|
|
|
|
|
|
debug3_f("terminating %zu helpers", nhelpers);
|
|
|
|
for (i = 0; i < nhelpers; i++)
|
|
|
|
helper_terminate(helpers[i]);
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static int
|
2019-01-20 22:51:37 +00:00
|
|
|
rsa_encrypt(int flen, const u_char *from, u_char *to, RSA *rsa, int padding)
|
2010-02-11 22:21:02 +00:00
|
|
|
{
|
2019-01-20 22:57:45 +00:00
|
|
|
struct sshkey *key = NULL;
|
|
|
|
struct sshbuf *msg = NULL;
|
|
|
|
u_char *blob = NULL, *signature = NULL;
|
2018-07-09 20:39:28 +00:00
|
|
|
size_t blen, slen = 0;
|
|
|
|
int r, ret = -1;
|
2023-07-19 14:03:45 +00:00
|
|
|
struct helper *helper;
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
if ((helper = helper_by_rsa(rsa)) == NULL || helper->fd == -1)
|
|
|
|
fatal_f("no helper for PKCS11 key");
|
|
|
|
debug3_f("signing with PKCS11 provider %s", helper->path);
|
2010-02-11 22:21:02 +00:00
|
|
|
if (padding != RSA_PKCS1_PADDING)
|
2019-01-20 22:57:45 +00:00
|
|
|
goto fail;
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((key = sshkey_new(KEY_UNSPEC)) == NULL) {
|
2020-10-18 11:32:01 +00:00
|
|
|
error_f("sshkey_new failed");
|
2019-01-20 22:57:45 +00:00
|
|
|
goto fail;
|
|
|
|
}
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((key->pkey = EVP_PKEY_new()) == NULL ||
|
|
|
|
EVP_PKEY_set1_RSA(key->pkey, rsa) != 1) {
|
|
|
|
error_f("pkey setup failed");
|
|
|
|
goto fail;
|
|
|
|
}
|
|
|
|
|
2019-01-20 22:57:45 +00:00
|
|
|
key->type = KEY_RSA;
|
|
|
|
if ((r = sshkey_to_blob(key, &blob, &blen)) != 0) {
|
2020-10-18 11:32:01 +00:00
|
|
|
error_fr(r, "encode key");
|
2019-01-20 22:57:45 +00:00
|
|
|
goto fail;
|
2018-07-09 20:39:28 +00:00
|
|
|
}
|
|
|
|
if ((msg = sshbuf_new()) == NULL)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_f("sshbuf_new failed");
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((r = sshbuf_put_u8(msg, SSH2_AGENTC_SIGN_REQUEST)) != 0 ||
|
|
|
|
(r = sshbuf_put_string(msg, blob, blen)) != 0 ||
|
|
|
|
(r = sshbuf_put_string(msg, from, flen)) != 0 ||
|
|
|
|
(r = sshbuf_put_u32(msg, 0)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "compose");
|
2023-07-19 14:03:45 +00:00
|
|
|
send_msg(helper->fd, msg);
|
2018-07-09 20:39:28 +00:00
|
|
|
sshbuf_reset(msg);
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
if (recv_msg(helper->fd, msg) == SSH2_AGENT_SIGN_RESPONSE) {
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((r = sshbuf_get_string(msg, &signature, &slen)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "parse");
|
2018-07-09 20:39:28 +00:00
|
|
|
if (slen <= (size_t)RSA_size(rsa)) {
|
2010-02-11 22:21:02 +00:00
|
|
|
memcpy(to, signature, slen);
|
|
|
|
ret = slen;
|
|
|
|
}
|
2013-06-01 21:31:17 +00:00
|
|
|
free(signature);
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
2019-01-20 22:57:45 +00:00
|
|
|
fail:
|
|
|
|
free(blob);
|
|
|
|
sshkey_free(key);
|
2018-07-09 20:39:28 +00:00
|
|
|
sshbuf_free(msg);
|
2010-02-11 22:21:02 +00:00
|
|
|
return (ret);
|
|
|
|
}
|
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
static int
|
|
|
|
rsa_finish(RSA *rsa)
|
|
|
|
{
|
|
|
|
struct helper *helper;
|
|
|
|
|
|
|
|
if ((helper = helper_by_rsa(rsa)) == NULL)
|
|
|
|
fatal_f("no helper for PKCS11 key");
|
|
|
|
debug3_f("free PKCS11 RSA key for provider %s", helper->path);
|
|
|
|
if (helper->rsa_finish != NULL)
|
|
|
|
helper->rsa_finish(rsa);
|
|
|
|
if (helper->nrsa == 0)
|
|
|
|
fatal_f("RSA refcount error");
|
|
|
|
helper->nrsa--;
|
|
|
|
debug3_f("provider %s remaining keys: %zu RSA %zu ECDSA",
|
|
|
|
helper->path, helper->nrsa, helper->nec);
|
|
|
|
if (helper->nrsa == 0 && helper->nec == 0)
|
|
|
|
helper_terminate(helper);
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
|
2023-07-20 02:53:21 +00:00
|
|
|
#if defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW)
|
2019-01-20 22:51:37 +00:00
|
|
|
static ECDSA_SIG *
|
|
|
|
ecdsa_do_sign(const unsigned char *dgst, int dgst_len, const BIGNUM *inv,
|
|
|
|
const BIGNUM *rp, EC_KEY *ec)
|
|
|
|
{
|
2019-01-20 22:57:45 +00:00
|
|
|
struct sshkey *key = NULL;
|
|
|
|
struct sshbuf *msg = NULL;
|
|
|
|
ECDSA_SIG *ret = NULL;
|
2019-01-20 22:51:37 +00:00
|
|
|
const u_char *cp;
|
2019-01-20 22:57:45 +00:00
|
|
|
u_char *blob = NULL, *signature = NULL;
|
2019-01-20 22:51:37 +00:00
|
|
|
size_t blen, slen = 0;
|
2019-01-20 22:57:45 +00:00
|
|
|
int r, nid;
|
2023-07-19 14:03:45 +00:00
|
|
|
struct helper *helper;
|
2019-01-20 22:51:37 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
if ((helper = helper_by_ec(ec)) == NULL || helper->fd == -1)
|
|
|
|
fatal_f("no helper for PKCS11 key");
|
|
|
|
debug3_f("signing with PKCS11 provider %s", helper->path);
|
2019-01-20 22:57:45 +00:00
|
|
|
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((key = sshkey_new(KEY_UNSPEC)) == NULL) {
|
2020-10-18 11:32:01 +00:00
|
|
|
error_f("sshkey_new failed");
|
2019-01-20 22:57:45 +00:00
|
|
|
goto fail;
|
2019-01-20 22:51:37 +00:00
|
|
|
}
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((key->pkey = EVP_PKEY_new()) == NULL ||
|
|
|
|
EVP_PKEY_set1_EC_KEY(key->pkey, ec) != 1) {
|
|
|
|
error("pkey setup failed");
|
|
|
|
goto fail;
|
|
|
|
}
|
|
|
|
if ((nid = sshkey_ecdsa_pkey_to_nid(key->pkey)) < 0) {
|
|
|
|
error("couldn't get curve nid");
|
|
|
|
goto fail;
|
|
|
|
}
|
2019-01-20 22:57:45 +00:00
|
|
|
key->ecdsa_nid = nid;
|
|
|
|
key->type = KEY_ECDSA;
|
|
|
|
|
|
|
|
if ((r = sshkey_to_blob(key, &blob, &blen)) != 0) {
|
2020-10-18 11:32:01 +00:00
|
|
|
error_fr(r, "encode key");
|
2019-01-20 22:57:45 +00:00
|
|
|
goto fail;
|
2019-01-20 22:51:37 +00:00
|
|
|
}
|
|
|
|
if ((msg = sshbuf_new()) == NULL)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_f("sshbuf_new failed");
|
2019-01-20 22:51:37 +00:00
|
|
|
if ((r = sshbuf_put_u8(msg, SSH2_AGENTC_SIGN_REQUEST)) != 0 ||
|
|
|
|
(r = sshbuf_put_string(msg, blob, blen)) != 0 ||
|
|
|
|
(r = sshbuf_put_string(msg, dgst, dgst_len)) != 0 ||
|
|
|
|
(r = sshbuf_put_u32(msg, 0)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "compose");
|
2023-07-19 14:03:45 +00:00
|
|
|
send_msg(helper->fd, msg);
|
2019-01-20 22:51:37 +00:00
|
|
|
sshbuf_reset(msg);
|
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
if (recv_msg(helper->fd, msg) == SSH2_AGENT_SIGN_RESPONSE) {
|
2019-01-20 22:51:37 +00:00
|
|
|
if ((r = sshbuf_get_string(msg, &signature, &slen)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "parse");
|
2019-01-20 22:51:37 +00:00
|
|
|
cp = signature;
|
|
|
|
ret = d2i_ECDSA_SIG(NULL, &cp, slen);
|
|
|
|
free(signature);
|
|
|
|
}
|
|
|
|
|
2019-01-20 22:57:45 +00:00
|
|
|
fail:
|
|
|
|
free(blob);
|
|
|
|
sshkey_free(key);
|
2019-01-20 22:51:37 +00:00
|
|
|
sshbuf_free(msg);
|
|
|
|
return (ret);
|
|
|
|
}
|
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
static void
|
|
|
|
ecdsa_do_finish(EC_KEY *ec)
|
|
|
|
{
|
|
|
|
struct helper *helper;
|
|
|
|
|
|
|
|
if ((helper = helper_by_ec(ec)) == NULL)
|
|
|
|
fatal_f("no helper for PKCS11 key");
|
|
|
|
debug3_f("free PKCS11 ECDSA key for provider %s", helper->path);
|
|
|
|
if (helper->ec_finish != NULL)
|
|
|
|
helper->ec_finish(ec);
|
|
|
|
if (helper->nec == 0)
|
|
|
|
fatal_f("ECDSA refcount error");
|
|
|
|
helper->nec--;
|
|
|
|
debug3_f("provider %s remaining keys: %zu RSA %zu ECDSA",
|
|
|
|
helper->path, helper->nrsa, helper->nec);
|
|
|
|
if (helper->nrsa == 0 && helper->nec == 0)
|
|
|
|
helper_terminate(helper);
|
|
|
|
}
|
2023-07-20 02:53:21 +00:00
|
|
|
#endif /* defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW) */
|
2019-01-20 22:51:37 +00:00
|
|
|
|
|
|
|
/* redirect private key crypto operations to the ssh-pkcs11-helper */
|
|
|
|
static void
|
2023-07-19 14:03:45 +00:00
|
|
|
wrap_key(struct helper *helper, struct sshkey *k)
|
2019-01-20 22:51:37 +00:00
|
|
|
{
|
2024-08-15 00:51:51 +00:00
|
|
|
RSA *rsa = NULL;
|
|
|
|
EC_KEY *ecdsa = NULL;
|
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
debug3_f("wrap %s for provider %s", sshkey_type(k), helper->path);
|
|
|
|
if (k->type == KEY_RSA) {
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((rsa = EVP_PKEY_get1_RSA(k->pkey)) == NULL)
|
|
|
|
fatal_f("no RSA key");
|
|
|
|
if (RSA_set_method(rsa, helper->rsa_meth) != 1)
|
|
|
|
fatal_f("RSA_set_method failed");
|
2023-07-19 14:03:45 +00:00
|
|
|
if (helper->nrsa++ >= INT_MAX)
|
|
|
|
fatal_f("RSA refcount error");
|
2024-08-15 00:51:51 +00:00
|
|
|
if (EVP_PKEY_set1_RSA(k->pkey, rsa) != 1)
|
|
|
|
fatal_f("EVP_PKEY_set1_RSA failed");
|
|
|
|
RSA_free(rsa);
|
2023-07-20 02:53:21 +00:00
|
|
|
#if defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW)
|
2023-07-19 14:03:45 +00:00
|
|
|
} else if (k->type == KEY_ECDSA) {
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((ecdsa = EVP_PKEY_get1_EC_KEY(k->pkey)) == NULL)
|
|
|
|
fatal_f("no ECDSA key");
|
|
|
|
if (EC_KEY_set_method(ecdsa, helper->ec_meth) != 1)
|
|
|
|
fatal_f("EC_KEY_set_method failed");
|
2023-07-19 14:03:45 +00:00
|
|
|
if (helper->nec++ >= INT_MAX)
|
|
|
|
fatal_f("EC refcount error");
|
2024-08-15 00:51:51 +00:00
|
|
|
if (EVP_PKEY_set1_EC_KEY(k->pkey, ecdsa) != 1)
|
|
|
|
fatal_f("EVP_PKEY_set1_EC_KEY failed");
|
|
|
|
EC_KEY_free(ecdsa);
|
2023-07-20 02:53:21 +00:00
|
|
|
#endif
|
2023-07-19 14:03:45 +00:00
|
|
|
} else
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_f("unknown key type");
|
2023-07-19 14:03:45 +00:00
|
|
|
k->flags |= SSHKEY_FLAG_EXT;
|
|
|
|
debug3_f("provider %s remaining keys: %zu RSA %zu ECDSA",
|
|
|
|
helper->path, helper->nrsa, helper->nec);
|
2019-01-20 22:51:37 +00:00
|
|
|
}
|
|
|
|
|
2023-12-18 14:46:56 +00:00
|
|
|
/*
|
|
|
|
* Make a private PKCS#11-backed certificate by grafting a previously-loaded
|
|
|
|
* PKCS#11 private key and a public certificate key.
|
|
|
|
*/
|
|
|
|
int
|
|
|
|
pkcs11_make_cert(const struct sshkey *priv,
|
|
|
|
const struct sshkey *certpub, struct sshkey **certprivp)
|
|
|
|
{
|
|
|
|
struct helper *helper = NULL;
|
|
|
|
struct sshkey *ret;
|
|
|
|
int r;
|
2024-08-15 00:51:51 +00:00
|
|
|
RSA *rsa_priv = NULL, *rsa_cert = NULL;
|
|
|
|
#if defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW)
|
|
|
|
EC_KEY *ec_priv = NULL, *ec_cert = NULL;
|
|
|
|
#endif
|
2023-12-18 14:46:56 +00:00
|
|
|
|
|
|
|
debug3_f("private key type %s cert type %s", sshkey_type(priv),
|
|
|
|
sshkey_type(certpub));
|
|
|
|
*certprivp = NULL;
|
|
|
|
if (!sshkey_is_cert(certpub) || sshkey_is_cert(priv) ||
|
|
|
|
!sshkey_equal_public(priv, certpub)) {
|
|
|
|
error_f("private key %s doesn't match cert %s",
|
|
|
|
sshkey_type(priv), sshkey_type(certpub));
|
|
|
|
return SSH_ERR_INVALID_ARGUMENT;
|
|
|
|
}
|
|
|
|
*certprivp = NULL;
|
|
|
|
if (priv->type == KEY_RSA) {
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((rsa_priv = EVP_PKEY_get1_RSA(priv->pkey)) == NULL)
|
|
|
|
fatal_f("no RSA pkey");
|
|
|
|
if ((helper = helper_by_rsa(rsa_priv)) == NULL ||
|
2023-12-18 14:46:56 +00:00
|
|
|
helper->fd == -1)
|
|
|
|
fatal_f("no helper for PKCS11 RSA key");
|
|
|
|
if ((r = sshkey_from_private(priv, &ret)) != 0)
|
|
|
|
fatal_fr(r, "copy key");
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((rsa_cert = EVP_PKEY_get1_RSA(ret->pkey)) == NULL)
|
|
|
|
fatal_f("no RSA cert pkey");
|
|
|
|
if (RSA_set_method(rsa_cert, helper->rsa_meth) != 1)
|
|
|
|
fatal_f("RSA_set_method failed");
|
2023-12-18 14:46:56 +00:00
|
|
|
if (helper->nrsa++ >= INT_MAX)
|
|
|
|
fatal_f("RSA refcount error");
|
2024-08-15 00:51:51 +00:00
|
|
|
if (EVP_PKEY_set1_RSA(ret->pkey, rsa_cert) != 1)
|
|
|
|
fatal_f("EVP_PKEY_set1_RSA failed");
|
|
|
|
RSA_free(rsa_priv);
|
|
|
|
RSA_free(rsa_cert);
|
2023-12-19 16:48:20 +00:00
|
|
|
#if defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW)
|
2023-12-18 14:46:56 +00:00
|
|
|
} else if (priv->type == KEY_ECDSA) {
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((ec_priv = EVP_PKEY_get1_EC_KEY(priv->pkey)) == NULL)
|
|
|
|
fatal_f("no EC pkey");
|
|
|
|
if ((helper = helper_by_ec(ec_priv)) == NULL ||
|
2023-12-18 14:46:56 +00:00
|
|
|
helper->fd == -1)
|
|
|
|
fatal_f("no helper for PKCS11 EC key");
|
|
|
|
if ((r = sshkey_from_private(priv, &ret)) != 0)
|
|
|
|
fatal_fr(r, "copy key");
|
2024-08-15 00:51:51 +00:00
|
|
|
if ((ec_cert = EVP_PKEY_get1_EC_KEY(ret->pkey)) == NULL)
|
|
|
|
fatal_f("no EC cert pkey");
|
|
|
|
if (EC_KEY_set_method(ec_cert, helper->ec_meth) != 1)
|
|
|
|
fatal_f("EC_KEY_set_method failed");
|
2023-12-18 14:46:56 +00:00
|
|
|
if (helper->nec++ >= INT_MAX)
|
|
|
|
fatal_f("EC refcount error");
|
2024-08-15 00:51:51 +00:00
|
|
|
if (EVP_PKEY_set1_EC_KEY(ret->pkey, ec_cert) != 1)
|
|
|
|
fatal_f("EVP_PKEY_set1_EC_KEY failed");
|
|
|
|
EC_KEY_free(ec_priv);
|
|
|
|
EC_KEY_free(ec_cert);
|
2023-12-19 16:48:20 +00:00
|
|
|
#endif
|
2023-12-18 14:46:56 +00:00
|
|
|
} else
|
|
|
|
fatal_f("unknown key type %s", sshkey_type(priv));
|
|
|
|
|
|
|
|
ret->flags |= SSHKEY_FLAG_EXT;
|
|
|
|
if ((r = sshkey_to_certified(ret)) != 0 ||
|
|
|
|
(r = sshkey_cert_copy(certpub, ret)) != 0)
|
|
|
|
fatal_fr(r, "graft certificate");
|
|
|
|
debug3_f("provider %s remaining keys: %zu RSA %zu ECDSA",
|
|
|
|
helper->path, helper->nrsa, helper->nec);
|
|
|
|
/* success */
|
|
|
|
*certprivp = ret;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2010-02-11 22:21:02 +00:00
|
|
|
static int
|
2023-07-19 14:03:45 +00:00
|
|
|
pkcs11_start_helper_methods(struct helper *helper)
|
2010-02-11 22:21:02 +00:00
|
|
|
{
|
2024-08-15 00:51:51 +00:00
|
|
|
RSA_METHOD *rsa_meth = NULL;
|
2023-07-20 02:53:21 +00:00
|
|
|
EC_KEY_METHOD *ec_meth = NULL;
|
|
|
|
#if defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW)
|
2023-07-19 14:03:45 +00:00
|
|
|
int (*ec_init)(EC_KEY *key);
|
|
|
|
int (*ec_copy)(EC_KEY *dest, const EC_KEY *src);
|
|
|
|
int (*ec_set_group)(EC_KEY *key, const EC_GROUP *grp);
|
|
|
|
int (*ec_set_private)(EC_KEY *key, const BIGNUM *priv_key);
|
|
|
|
int (*ec_set_public)(EC_KEY *key, const EC_POINT *pub_key);
|
|
|
|
int (*ec_sign)(int, const unsigned char *, int, unsigned char *,
|
2019-01-20 22:51:37 +00:00
|
|
|
unsigned int *, const BIGNUM *, const BIGNUM *, EC_KEY *) = NULL;
|
2023-07-19 14:03:45 +00:00
|
|
|
|
|
|
|
if ((ec_meth = EC_KEY_METHOD_new(EC_KEY_OpenSSL())) == NULL)
|
|
|
|
return -1;
|
|
|
|
EC_KEY_METHOD_get_sign(ec_meth, &ec_sign, NULL, NULL);
|
|
|
|
EC_KEY_METHOD_set_sign(ec_meth, ec_sign, NULL, ecdsa_do_sign);
|
|
|
|
EC_KEY_METHOD_get_init(ec_meth, &ec_init, &helper->ec_finish,
|
|
|
|
&ec_copy, &ec_set_group, &ec_set_private, &ec_set_public);
|
|
|
|
EC_KEY_METHOD_set_init(ec_meth, ec_init, ecdsa_do_finish,
|
|
|
|
ec_copy, ec_set_group, ec_set_private, ec_set_public);
|
2023-07-20 02:53:21 +00:00
|
|
|
#endif /* defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW) */
|
2023-07-19 14:03:45 +00:00
|
|
|
|
|
|
|
if ((rsa_meth = RSA_meth_dup(RSA_get_default_method())) == NULL)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_f("RSA_meth_dup failed");
|
2023-07-19 14:03:45 +00:00
|
|
|
helper->rsa_finish = RSA_meth_get_finish(rsa_meth);
|
|
|
|
if (!RSA_meth_set1_name(rsa_meth, "ssh-pkcs11-helper") ||
|
|
|
|
!RSA_meth_set_priv_enc(rsa_meth, rsa_encrypt) ||
|
|
|
|
!RSA_meth_set_finish(rsa_meth, rsa_finish))
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_f("failed to prepare method");
|
2019-01-20 22:51:37 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
helper->ec_meth = ec_meth;
|
|
|
|
helper->rsa_meth = rsa_meth;
|
|
|
|
return 0;
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
static struct helper *
|
|
|
|
pkcs11_start_helper(const char *path)
|
2010-02-11 22:21:02 +00:00
|
|
|
{
|
|
|
|
int pair[2];
|
2023-07-19 14:03:45 +00:00
|
|
|
char *prog, *verbosity = NULL;
|
|
|
|
struct helper *helper;
|
|
|
|
pid_t pid;
|
2019-01-20 22:51:37 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
if (nhelpers >= INT_MAX)
|
|
|
|
fatal_f("too many helpers");
|
|
|
|
debug3_f("start helper for %s", path);
|
2010-02-11 22:21:02 +00:00
|
|
|
if (socketpair(AF_UNIX, SOCK_STREAM, 0, pair) == -1) {
|
2023-07-19 14:03:45 +00:00
|
|
|
error_f("socketpair: %s", strerror(errno));
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
helper = xcalloc(1, sizeof(*helper));
|
|
|
|
if (pkcs11_start_helper_methods(helper) == -1) {
|
|
|
|
error_f("pkcs11_start_helper_methods failed");
|
|
|
|
goto fail;
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
|
|
|
if ((pid = fork()) == -1) {
|
2023-07-19 14:03:45 +00:00
|
|
|
error_f("fork: %s", strerror(errno));
|
|
|
|
fail:
|
|
|
|
close(pair[0]);
|
|
|
|
close(pair[1]);
|
|
|
|
RSA_meth_free(helper->rsa_meth);
|
2023-07-25 03:00:22 +00:00
|
|
|
#if defined(OPENSSL_HAS_ECC) && defined(HAVE_EC_KEY_METHOD_NEW)
|
2023-07-19 14:03:45 +00:00
|
|
|
EC_KEY_METHOD_free(helper->ec_meth);
|
2023-07-25 03:00:22 +00:00
|
|
|
#endif
|
2023-07-19 14:03:45 +00:00
|
|
|
free(helper);
|
|
|
|
return NULL;
|
2010-02-11 22:21:02 +00:00
|
|
|
} else if (pid == 0) {
|
|
|
|
if ((dup2(pair[1], STDIN_FILENO) == -1) ||
|
|
|
|
(dup2(pair[1], STDOUT_FILENO) == -1)) {
|
|
|
|
fprintf(stderr, "dup2: %s\n", strerror(errno));
|
|
|
|
_exit(1);
|
|
|
|
}
|
|
|
|
close(pair[0]);
|
|
|
|
close(pair[1]);
|
2023-07-19 14:03:45 +00:00
|
|
|
prog = getenv("SSH_PKCS11_HELPER");
|
|
|
|
if (prog == NULL || strlen(prog) == 0)
|
|
|
|
prog = _PATH_SSH_PKCS11_HELPER;
|
|
|
|
if (log_level_get() >= SYSLOG_LEVEL_DEBUG1)
|
|
|
|
verbosity = "-vvv";
|
|
|
|
debug_f("starting %s %s", prog,
|
2019-01-21 12:53:35 +00:00
|
|
|
verbosity == NULL ? "" : verbosity);
|
2023-07-19 14:03:45 +00:00
|
|
|
execlp(prog, prog, verbosity, (char *)NULL);
|
|
|
|
fprintf(stderr, "exec: %s: %s\n", prog, strerror(errno));
|
2010-02-11 22:21:02 +00:00
|
|
|
_exit(1);
|
|
|
|
}
|
|
|
|
close(pair[1]);
|
2023-07-19 14:03:45 +00:00
|
|
|
helper->fd = pair[0];
|
|
|
|
helper->path = xstrdup(path);
|
|
|
|
helper->pid = pid;
|
|
|
|
debug3_f("helper %zu for \"%s\" on fd %d pid %ld", nhelpers,
|
|
|
|
helper->path, helper->fd, (long)helper->pid);
|
|
|
|
helpers = xrecallocarray(helpers, nhelpers,
|
|
|
|
nhelpers + 1, sizeof(*helpers));
|
|
|
|
helpers[nhelpers++] = helper;
|
|
|
|
return helper;
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
int
|
2020-01-25 00:03:36 +00:00
|
|
|
pkcs11_add_provider(char *name, char *pin, struct sshkey ***keysp,
|
|
|
|
char ***labelsp)
|
2010-02-11 22:21:02 +00:00
|
|
|
{
|
2017-05-30 08:52:19 +00:00
|
|
|
struct sshkey *k;
|
2019-01-20 22:51:37 +00:00
|
|
|
int r, type;
|
2010-02-11 22:21:02 +00:00
|
|
|
u_char *blob;
|
2020-01-25 00:03:36 +00:00
|
|
|
char *label;
|
2018-07-09 20:39:28 +00:00
|
|
|
size_t blen;
|
|
|
|
u_int nkeys, i;
|
|
|
|
struct sshbuf *msg;
|
2023-07-19 14:03:45 +00:00
|
|
|
struct helper *helper;
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
if ((helper = helper_by_provider(name)) == NULL &&
|
|
|
|
(helper = pkcs11_start_helper(name)) == NULL)
|
|
|
|
return -1;
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((msg = sshbuf_new()) == NULL)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_f("sshbuf_new failed");
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((r = sshbuf_put_u8(msg, SSH_AGENTC_ADD_SMARTCARD_KEY)) != 0 ||
|
|
|
|
(r = sshbuf_put_cstring(msg, name)) != 0 ||
|
|
|
|
(r = sshbuf_put_cstring(msg, pin)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "compose");
|
2023-07-19 14:03:45 +00:00
|
|
|
send_msg(helper->fd, msg);
|
2018-07-09 20:39:28 +00:00
|
|
|
sshbuf_reset(msg);
|
2010-02-11 22:21:02 +00:00
|
|
|
|
2023-07-19 14:03:45 +00:00
|
|
|
type = recv_msg(helper->fd, msg);
|
2019-01-20 22:51:37 +00:00
|
|
|
if (type == SSH2_AGENT_IDENTITIES_ANSWER) {
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((r = sshbuf_get_u32(msg, &nkeys)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "parse nkeys");
|
2018-07-09 20:39:28 +00:00
|
|
|
*keysp = xcalloc(nkeys, sizeof(struct sshkey *));
|
2020-01-25 00:03:36 +00:00
|
|
|
if (labelsp)
|
|
|
|
*labelsp = xcalloc(nkeys, sizeof(char *));
|
2010-02-11 22:21:02 +00:00
|
|
|
for (i = 0; i < nkeys; i++) {
|
2018-07-09 20:39:28 +00:00
|
|
|
/* XXX clean up properly instead of fatal() */
|
|
|
|
if ((r = sshbuf_get_string(msg, &blob, &blen)) != 0 ||
|
2020-01-25 00:03:36 +00:00
|
|
|
(r = sshbuf_get_cstring(msg, &label, NULL)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "parse key");
|
2018-07-09 20:39:28 +00:00
|
|
|
if ((r = sshkey_from_blob(blob, blen, &k)) != 0)
|
2020-10-18 11:32:01 +00:00
|
|
|
fatal_fr(r, "decode key");
|
2023-07-19 14:03:45 +00:00
|
|
|
wrap_key(helper, k);
|
2010-02-11 22:21:02 +00:00
|
|
|
(*keysp)[i] = k;
|
2020-01-25 00:03:36 +00:00
|
|
|
if (labelsp)
|
|
|
|
(*labelsp)[i] = label;
|
|
|
|
else
|
|
|
|
free(label);
|
2013-06-01 21:31:17 +00:00
|
|
|
free(blob);
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
2019-01-20 22:51:37 +00:00
|
|
|
} else if (type == SSH2_AGENT_FAILURE) {
|
|
|
|
if ((r = sshbuf_get_u32(msg, &nkeys)) != 0)
|
|
|
|
nkeys = -1;
|
2010-02-11 22:21:02 +00:00
|
|
|
} else {
|
|
|
|
nkeys = -1;
|
|
|
|
}
|
2018-07-09 20:39:28 +00:00
|
|
|
sshbuf_free(msg);
|
2010-02-11 22:21:02 +00:00
|
|
|
return (nkeys);
|
|
|
|
}
|
|
|
|
|
|
|
|
int
|
|
|
|
pkcs11_del_provider(char *name)
|
|
|
|
{
|
2023-07-19 14:03:45 +00:00
|
|
|
struct helper *helper;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ssh-agent deletes keys before calling this, so the helper entry
|
|
|
|
* should be gone before we get here.
|
|
|
|
*/
|
|
|
|
debug3_f("delete %s", name);
|
|
|
|
if ((helper = helper_by_provider(name)) != NULL)
|
|
|
|
helper_terminate(helper);
|
|
|
|
return 0;
|
2010-02-11 22:21:02 +00:00
|
|
|
}
|
2010-02-11 23:06:28 +00:00
|
|
|
#endif /* ENABLE_PKCS11 */
|