forked from open-quantum-safe/oqs-provider
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a example of how to load oqsprovider using `OSSL_PROVIDER_add_bui…
…ltin`. (open-quantum-safe#308) This commit adds an example under the `examples/` directory of how to load oqsprovider using [`OSSL_PROVIDER_add_builtin`]. A CMake test target has been added to ensure that the example works. Note that this target is skipped if `OQS_PROVIDER_BUILD_STATIC` is not enabled. [`OSSL_PROVIDER_add_builtin`]: https://www.openssl.org/docs/man3.2/man3/OSSL_PROVIDER_add_builtin.html Signed-off-by: Felipe Ventura <[email protected]>
- Loading branch information
Showing
4 changed files
with
108 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
if (OQS_PROVIDER_BUILD_STATIC) | ||
add_executable(example_static_oqsprovider static_oqsprovider.c) | ||
target_link_libraries(example_static_oqsprovider PRIVATE ${OPENSSL_CRYPTO_LIBRARY} oqsprovider) | ||
targets_set_static_provider(example_static_oqsprovider) | ||
add_test(NAME test_example_static_oqsprovider | ||
COMMAND example_static_oqsprovider) | ||
endif() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
/** | ||
* \file | ||
* \brief Example of how to load oqsprovider when compiled as a static library | ||
* `using OSSL_PROVIDER_add_builtin`. | ||
*/ | ||
|
||
#include <stdio.h> | ||
|
||
#include <openssl/crypto.h> | ||
#include <openssl/err.h> | ||
#include <openssl/provider.h> | ||
|
||
/** \brief The initialization function of oqsprovider. */ | ||
extern OSSL_provider_init_fn oqs_provider_init; | ||
|
||
/** \brief Name of the oqsprovider. */ | ||
static const char *kOQSProviderName = "oqsprovider"; | ||
|
||
/** \brief Tries to load the oqsprovider named "oqsprovider". | ||
* | ||
* \param libctx Context of the OpenSSL library in which to load the | ||
* oqsprovider. | ||
* | ||
* \returns 0 if success, else -1. */ | ||
static int load_oqs_provider(OSSL_LIB_CTX *libctx) | ||
{ | ||
OSSL_PROVIDER *provider; | ||
int ret; | ||
|
||
ret = OSSL_PROVIDER_available(libctx, kOQSProviderName); | ||
if (ret != 0) { | ||
fprintf(stderr, | ||
"`OSSL_PROVIDER_available` returned %i, but 0 was expected\n", | ||
ret); | ||
return -1; | ||
} | ||
|
||
ret = OSSL_PROVIDER_add_builtin(libctx, kOQSProviderName, | ||
oqs_provider_init); | ||
if (ret != 1) { | ||
fprintf(stderr, | ||
"`OSSL_PROVIDER_add_builtin` failed with returned code %i\n", | ||
ret); | ||
return -1; | ||
} | ||
|
||
provider = OSSL_PROVIDER_load(libctx, kOQSProviderName); | ||
if (provider == NULL) { | ||
fputs("`OSSL_PROVIDER_load` failed\n", stderr); | ||
return -1; | ||
} | ||
|
||
ret = OSSL_PROVIDER_available(libctx, kOQSProviderName); | ||
if (ret != 1) { | ||
fprintf(stderr, | ||
"`OSSL_PROVIDER_available` returned %i, but 0 was expected\n", | ||
ret); | ||
return -1; | ||
} | ||
|
||
ret = OSSL_PROVIDER_self_test(provider); | ||
if (ret != 1) { | ||
fprintf(stderr, | ||
"`OSSL_PROVIDER_self_test` failed with returned code %i\n", | ||
ret); | ||
return -1; | ||
} | ||
|
||
return 0; | ||
} | ||
|
||
int main() | ||
{ | ||
OSSL_LIB_CTX *libctx; | ||
int ret; | ||
|
||
libctx = OSSL_LIB_CTX_new(); | ||
if (libctx == NULL) { | ||
fputs("`OSSL_LIB_CTX_new` failed. Cannot initialize OpenSSL.\n", | ||
stderr); | ||
return 1; | ||
} | ||
|
||
ret = load_oqs_provider(libctx); | ||
if (ret != 0) { | ||
fputs("`load_oqs_provider` failed. Dumping OpenSSL error queue.\n", | ||
stderr); | ||
ERR_print_errors_fp(stderr); | ||
return 2; | ||
} | ||
|
||
OSSL_LIB_CTX_free(libctx); | ||
|
||
return 0; | ||
} |