test/p_test.c

   1 /*
   2  * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /*
  11  * This is a very simple provider that does absolutely nothing except respond
  12  * to provider global parameter requests.  It does this by simply echoing back
  13  * a parameter request it makes to the loading library.
  14  */
  15
  16 #include <string.h>
  17 #include <stdio.h>
  18
  19 /*
  20  * When built as an object file to link the application with, we get the
  21  * init function name through the macro PROVIDER_INIT_FUNCTION_NAME.  If
  22  * not defined, we use the standard init function name for the shared
  23  * object form.
  24  */
  25 #ifdef PROVIDER_INIT_FUNCTION_NAME
  26 # define OSSL_provider_init PROVIDER_INIT_FUNCTION_NAME
  27 #endif
  28
  29 #include <openssl/core.h>
  30 #include <openssl/core_numbers.h>
  31
  32 static OSSL_core_get_param_types_fn *c_get_param_types = NULL;
  33 static OSSL_core_get_params_fn *c_get_params = NULL;
  34
  35 /* Tell the core what params we provide and what type they are */
  36 static const OSSL_ITEM p_param_types[] = {
  37     { OSSL_PARAM_UTF8_STRING, "greeting" },
  38     { 0, NULL }
  39 };
  40
  41 static const OSSL_ITEM *p_get_param_types(const OSSL_PROVIDER *_)
  42 {
  43     return p_param_types;
  44 }
  45
  46 static int p_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
  47 {
  48     const OSSL_PARAM *p = params;
  49     int ok = 1;
  50
  51     for (; ok && p->key != NULL; p++) {
  52         if (strcmp(p->key, "greeting") == 0) {
  53             static char *opensslv = NULL;
  54             static char *provname = NULL;
  55             static char *greeting = NULL;
  56             static OSSL_PARAM counter_request[] = {
  57                 /* Known libcrypto provided parameters */
  58                 { "openssl-version", OSSL_PARAM_UTF8_PTR,
  59                   &opensslv, sizeof(&opensslv), NULL },
  60                 { "provider-name", OSSL_PARAM_UTF8_PTR,
  61                   &provname, sizeof(&provname), NULL},
  62
  63                 /* This might be present, if there's such a configuration */
  64                 { "greeting", OSSL_PARAM_UTF8_PTR,
  65                   &greeting, sizeof(&greeting), NULL },
  66
  67                 { NULL, 0, NULL, 0, NULL }
  68             };
  69             char buf[256];
  70             size_t buf_l;
  71
  72             if (c_get_params(prov, counter_request)) {
  73                 if (greeting) {
  74                     strcpy(buf, greeting);
  75                 } else {
  76                     const char *versionp = *(void **)counter_request[0].data;
  77                     const char *namep = *(void **)counter_request[1].data;
  78
  79                     sprintf(buf, "Hello OpenSSL %.20s, greetings from %s!",
  80                             versionp, namep);
  81                 }
  82             } else {
  83                 sprintf(buf, "Howdy stranger...");
  84             }
  85
  86             *p->return_size = buf_l = strlen(buf) + 1;
  87             if (p->data_size >= buf_l)
  88                 strncpy(p->data, buf, buf_l);
  89             else
  90                 ok = 0;
  91         }
  92     }
  93     return ok;
  94 }
  95
  96 static const OSSL_DISPATCH p_test_table[] = {
  97     { OSSL_FUNC_PROVIDER_GET_PARAM_TYPES, (void (*)(void))p_get_param_types },
  98     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))p_get_params },
  99     { 0, NULL }
 100 };
 101
 102 int OSSL_provider_init(const OSSL_PROVIDER *provider,
 103                        const OSSL_DISPATCH *in,
 104                        const OSSL_DISPATCH **out)
 105 {
 106     for (; in->function_id != 0; in++) {
 107         switch (in->function_id) {
 108         case OSSL_FUNC_CORE_GET_PARAM_TYPES:
 109             c_get_param_types = OSSL_get_core_get_param_types(in);
 110             break;
 111         case OSSL_FUNC_CORE_GET_PARAMS:
 112             c_get_params = OSSL_get_core_get_params(in);
 113             break;
 114         default:
 115             /* Just ignore anything we don't understand */
 116             break;
 117         }
 118     }
 119
 120     *out = p_test_table;
 121     return 1;
 122 }