/*
- * Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 2020-2023 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the Apache License 2.0 (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
#include <openssl/core_dispatch.h>
#include <openssl/core_names.h>
+#include <openssl/core_object.h>
#include <openssl/crypto.h>
#include <openssl/err.h>
#include <openssl/params.h>
char **pem_name, char **pem_header,
unsigned char **data, long *len)
{
- BIO *in = bio_new_from_core_bio(provctx, cin);
- int ok = (PEM_read_bio(in, pem_name, pem_header, data, len) > 0);
+ BIO *in = ossl_bio_new_from_core_bio(provctx, cin);
+ int ok;
+
+ if (in == NULL)
+ return 0;
+ ok = (PEM_read_bio(in, pem_name, pem_header, data, len) > 0);
BIO_free(in);
return ok;
static OSSL_FUNC_decoder_newctx_fn pem2der_newctx;
static OSSL_FUNC_decoder_freectx_fn pem2der_freectx;
-static OSSL_FUNC_decoder_gettable_params_fn pem2der_gettable_params;
-static OSSL_FUNC_decoder_get_params_fn pem2der_get_params;
static OSSL_FUNC_decoder_decode_fn pem2der_decode;
/*
OPENSSL_free(ctx);
}
-static const OSSL_PARAM *pem2der_gettable_params(void *provctx)
-{
- static const OSSL_PARAM gettables[] = {
- { OSSL_DECODER_PARAM_INPUT_TYPE, OSSL_PARAM_UTF8_PTR, NULL, 0, 0 },
- OSSL_PARAM_END,
- };
-
- return gettables;
-}
-
-static int pem2der_get_params(OSSL_PARAM params[])
-{
- OSSL_PARAM *p;
-
- p = OSSL_PARAM_locate(params, OSSL_DECODER_PARAM_INPUT_TYPE);
- if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "PEM"))
- return 0;
-
- return 1;
-}
-
/* pem_password_cb compatible function */
struct pem2der_pass_data_st {
OSSL_PASSPHRASE_CALLBACK *cb;
OSSL_CALLBACK *data_cb, void *data_cbarg,
OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)
{
- /* Strings to peal off the pem name */
- static const char *pealable_pem_name_endings[] = {
- /*
- * These entries should be in longest to shortest order to avoid
- * mixups.
- */
- "ENCRYPTED PRIVATE KEY",
- "PRIVATE KEY",
- "PUBLIC KEY",
- "PARAMETERS"
+ /*
+ * PEM names we recognise. Other PEM names should be recognised by
+ * other decoder implementations.
+ */
+ static struct pem_name_map_st {
+ const char *pem_name;
+ int object_type;
+ const char *data_type;
+ const char *data_structure;
+ } pem_name_map[] = {
+ /* PKCS#8 and SubjectPublicKeyInfo */
+ { PEM_STRING_PKCS8, OSSL_OBJECT_PKEY, NULL, "EncryptedPrivateKeyInfo" },
+ { PEM_STRING_PKCS8INF, OSSL_OBJECT_PKEY, NULL, "PrivateKeyInfo" },
+ { PEM_STRING_PUBLIC, OSSL_OBJECT_PKEY, NULL, "SubjectPublicKeyInfo" },
+
+ /* Our set of type specific PEM types */
+ { PEM_STRING_DHPARAMS, OSSL_OBJECT_PKEY, "DH", "type-specific" },
+ { PEM_STRING_DHXPARAMS, OSSL_OBJECT_PKEY, "X9.42 DH", "type-specific" },
+ { PEM_STRING_DSA, OSSL_OBJECT_PKEY, "DSA", "type-specific" },
+ { PEM_STRING_DSA_PUBLIC, OSSL_OBJECT_PKEY, "DSA", "type-specific" },
+ { PEM_STRING_DSAPARAMS, OSSL_OBJECT_PKEY, "DSA", "type-specific" },
+ { PEM_STRING_ECPRIVATEKEY, OSSL_OBJECT_PKEY, "EC", "type-specific" },
+ { PEM_STRING_ECPARAMETERS, OSSL_OBJECT_PKEY, "EC", "type-specific" },
+ { PEM_STRING_SM2PARAMETERS, OSSL_OBJECT_PKEY, "SM2", "type-specific" },
+ { PEM_STRING_RSA, OSSL_OBJECT_PKEY, "RSA", "type-specific" },
+ { PEM_STRING_RSA_PUBLIC, OSSL_OBJECT_PKEY, "RSA", "type-specific" },
/*
- * Libcrypto currently only supports decoding keys with provider side
- * decoders, so we don't try to peal any other PEM name. That's an
- * exercise for when libcrypto starts to treat other types of objects
- * via providers.
+ * A few others that there is at least have an object type for, even
+ * though there is no provider interface to handle such objects, yet.
+ * However, this is beneficial for the OSSL_STORE result handler.
*/
+ { PEM_STRING_X509, OSSL_OBJECT_CERT, NULL, "Certificate" },
+ { PEM_STRING_X509_TRUSTED, OSSL_OBJECT_CERT, NULL, "Certificate" },
+ { PEM_STRING_X509_OLD, OSSL_OBJECT_CERT, NULL, "Certificate" },
+ { PEM_STRING_X509_CRL, OSSL_OBJECT_CRL, NULL, "CertificateList" }
};
struct pem2der_ctx_st *ctx = vctx;
char *pem_name = NULL, *pem_header = NULL;
- size_t pem_name_len, i;
+ size_t i;
unsigned char *der = NULL;
long der_len = 0;
int ok = 0;
+ int objtype = OSSL_OBJECT_UNKNOWN;
- if (read_pem(ctx->provctx, cin, &pem_name, &pem_header,
- &der, &der_len) <= 0)
- return 0;
+ ok = read_pem(ctx->provctx, cin, &pem_name, &pem_header,
+ &der, &der_len) > 0;
+ /* We return "empty handed". This is not an error. */
+ if (!ok)
+ return 1;
/*
* 10 is the number of characters in "Proc-Type:", which
EVP_CIPHER_INFO cipher;
struct pem2der_pass_data_st pass_data;
+ ok = 0; /* Assume that we fail */
pass_data.cb = pw_cb;
pass_data.cbarg = pw_cbarg;
if (!PEM_get_EVP_CIPHER_INFO(pem_header, &cipher)
}
/*
- * Peal off certain strings from the end of |pem_name|, as they serve
- * no further purpose.
+ * Indicated that we successfully decoded something, or not at all.
+ * Ending up "empty handed" is not an error.
*/
- for (i = 0, pem_name_len = strlen(pem_name);
- i < OSSL_NELEM(pealable_pem_name_endings);
- i++) {
- size_t peal_len = strlen(pealable_pem_name_endings[i]);
- size_t pem_name_offset;
-
- if (peal_len <= pem_name_len) {
- pem_name_offset = pem_name_len - peal_len;
- if (strcmp(pem_name + pem_name_offset,
- pealable_pem_name_endings[i]) == 0) {
-
- do {
- pem_name[pem_name_offset] = '\0';
- } while (pem_name_offset > 0
- && pem_name[--pem_name_offset] == ' ');
-
- if (pem_name[0] == '\0') {
- OPENSSL_free(pem_name);
- pem_name = NULL;
- }
- break;
- }
- }
- }
+ ok = 1;
+
+ /* Have a look to see if we recognise anything */
+ for (i = 0; i < OSSL_NELEM(pem_name_map); i++)
+ if (strcmp(pem_name, pem_name_map[i].pem_name) == 0)
+ break;
- {
- OSSL_PARAM params[3], *p = params;
+ if (i < OSSL_NELEM(pem_name_map)) {
+ OSSL_PARAM params[5], *p = params;
+ /* We expect these to be read only so casting away the const is ok */
+ char *data_type = (char *)pem_name_map[i].data_type;
+ char *data_structure = (char *)pem_name_map[i].data_structure;
- if (pem_name != NULL)
+ objtype = pem_name_map[i].object_type;
+ if (data_type != NULL)
*p++ =
OSSL_PARAM_construct_utf8_string(OSSL_OBJECT_PARAM_DATA_TYPE,
- pem_name, 0);
+ data_type, 0);
+
+ /* We expect this to be read only so casting away the const is ok */
+ if (data_structure != NULL)
+ *p++ =
+ OSSL_PARAM_construct_utf8_string(OSSL_OBJECT_PARAM_DATA_STRUCTURE,
+ data_structure, 0);
*p++ =
OSSL_PARAM_construct_octet_string(OSSL_OBJECT_PARAM_DATA,
der, der_len);
+ *p++ =
+ OSSL_PARAM_construct_int(OSSL_OBJECT_PARAM_TYPE, &objtype);
+
*p = OSSL_PARAM_construct_end();
ok = data_cb(params, data_cbarg);
const OSSL_DISPATCH ossl_pem_to_der_decoder_functions[] = {
{ OSSL_FUNC_DECODER_NEWCTX, (void (*)(void))pem2der_newctx },
{ OSSL_FUNC_DECODER_FREECTX, (void (*)(void))pem2der_freectx },
- { OSSL_FUNC_DECODER_GETTABLE_PARAMS,
- (void (*)(void))pem2der_gettable_params },
- { OSSL_FUNC_DECODER_GET_PARAMS,
- (void (*)(void))pem2der_get_params },
{ OSSL_FUNC_DECODER_DECODE, (void (*)(void))pem2der_decode },
- { 0, NULL }
+ OSSL_DISPATCH_END
};