test/p_test.c

   1 /*
   2  * Copyright 2019-2020 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_gettable_params_fn *c_gettable_params = 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_PARAM p_param_types[] = {
  37     { "greeting", OSSL_PARAM_UTF8_STRING, NULL, 0, 0 },
  38     { NULL, 0, NULL, 0, 0 }
  39 };
  40
  41 /* This is a trick to ensure we define the provider functions correctly */
  42 static OSSL_provider_gettable_params_fn p_gettable_params;
  43 static OSSL_provider_get_params_fn p_get_params;
  44 static OSSL_provider_get_reason_strings_fn p_get_reason_strings;
  45
  46 static const OSSL_PARAM *p_gettable_params(void *_)
  47 {
  48     return p_param_types;
  49 }
  50
  51 static int p_get_params(void *vhand, OSSL_PARAM params[])
  52 {
  53     const OSSL_CORE_HANDLE *hand = vhand;
  54     OSSL_PARAM *p = params;
  55     int ok = 1;
  56
  57     for (; ok && p->key != NULL; p++) {
  58         if (strcmp(p->key, "greeting") == 0) {
  59             static char *opensslv;
  60             static char *provname;
  61             static char *greeting;
  62             static OSSL_PARAM counter_request[] = {
  63                 /* Known libcrypto provided parameters */
  64                 { "openssl-version", OSSL_PARAM_UTF8_PTR,
  65                   &opensslv, sizeof(&opensslv), 0 },
  66                 { "provider-name", OSSL_PARAM_UTF8_PTR,
  67                   &provname, sizeof(&provname), 0},
  68
  69                 /* This might be present, if there's such a configuration */
  70                 { "greeting", OSSL_PARAM_UTF8_PTR,
  71                   &greeting, sizeof(&greeting), 0 },
  72
  73                 { NULL, 0, NULL, 0, 0 }
  74             };
  75             char buf[256];
  76             size_t buf_l;
  77
  78             opensslv = provname = greeting = NULL;
  79
  80             if (c_get_params(hand, counter_request)) {
  81                 if (greeting) {
  82                     strcpy(buf, greeting);
  83                 } else {
  84                     const char *versionp = *(void **)counter_request[0].data;
  85                     const char *namep = *(void **)counter_request[1].data;
  86
  87                     sprintf(buf, "Hello OpenSSL %.20s, greetings from %s!",
  88                             versionp, namep);
  89                 }
  90             } else {
  91                 sprintf(buf, "Howdy stranger...");
  92             }
  93
  94             p->return_size = buf_l = strlen(buf) + 1;
  95             if (p->data_size >= buf_l)
  96                 strcpy(p->data, buf);
  97             else
  98                 ok = 0;
  99         }
 100     }
 101     return ok;
 102 }
 103
 104 static const OSSL_ITEM *p_get_reason_strings(void *_)
 105 {
 106     static const OSSL_ITEM reason_strings[] = {
 107         {1, "dummy reason string"},
 108         {0, NULL}
 109     };
 110
 111     return reason_strings;
 112 }
 113
 114 static const OSSL_DISPATCH p_test_table[] = {
 115     { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))p_gettable_params },
 116     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))p_get_params },
 117     { OSSL_FUNC_PROVIDER_GET_REASON_STRINGS,
 118         (void (*)(void))p_get_reason_strings},
 119     { 0, NULL }
 120 };
 121
 122 int OSSL_provider_init(const OSSL_CORE_HANDLE *handle,
 123                        const OSSL_DISPATCH *in,
 124                        const OSSL_DISPATCH **out,
 125                        void **provctx)
 126 {
 127     for (; in->function_id != 0; in++) {
 128         switch (in->function_id) {
 129         case OSSL_FUNC_CORE_GETTABLE_PARAMS:
 130             c_gettable_params = OSSL_get_core_gettable_params(in);
 131             break;
 132         case OSSL_FUNC_CORE_GET_PARAMS:
 133             c_get_params = OSSL_get_core_get_params(in);
 134             break;
 135         default:
 136             /* Just ignore anything we don't understand */
 137             break;
 138         }
 139     }
 140
 141     /* Because we use this in get_params, we need to pass it back */
 142     *provctx = (void *)handle;
 143
 144     *out = p_test_table;
 145     return 1;
 146 }