2019-01-20 20:23:30 +08:00
|
|
|
=pod
|
|
|
|
|
|
|
|
|
|
=head1 NAME
|
|
|
|
|
|
|
|
|
|
openssl/core.h - OpenSSL Core types
|
|
|
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
|
|
|
|
|
#include <openssl/core.h>
|
|
|
|
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
|
2019-08-22 13:21:25 +08:00
|
|
|
The F<< <openssl/core.h> >> header defines a number of public types that
|
2019-01-20 20:23:30 +08:00
|
|
|
are used to communicate between the OpenSSL libraries and
|
|
|
|
|
implementation providers.
|
|
|
|
|
These types are designed to minimise the need for intimate knowledge
|
|
|
|
|
of internal structures between the OpenSSL libraries and the providers.
|
|
|
|
|
|
|
|
|
|
The types are:
|
|
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
2022-12-05 23:26:39 +08:00
|
|
|
=item L<OSSL_DISPATCH(3)>
|
2019-01-20 20:23:30 +08:00
|
|
|
|
2022-12-05 23:26:39 +08:00
|
|
|
=item L<OSSL_ITEM(3)>
|
2019-01-20 20:23:30 +08:00
|
|
|
|
2022-12-05 23:26:39 +08:00
|
|
|
=item L<OSSL_ALGORITHM(3)>
|
2019-01-20 20:23:30 +08:00
|
|
|
|
2022-12-05 23:26:39 +08:00
|
|
|
=item L<OSSL_PARAM(3)>
|
2019-01-20 20:23:30 +08:00
|
|
|
|
2022-12-05 23:26:39 +08:00
|
|
|
=item L<OSSL_CALLBACK(3)>
|
2019-01-20 20:23:30 +08:00
|
|
|
|
2022-12-05 23:26:39 +08:00
|
|
|
=item L<OSSL_PASSPHRASE_CALLBACK(3)>
|
SERIALIZER: New API for serialization of objects through providers
Serialization is needed to be able to take a provider object (such as
the provider side key data) and output it in PEM form, DER form, text
form (for display), and possibly other future forms (XML? JSON? JWK?)
The idea is that a serializer should be able to handle objects it has
intimate knowledge of, as well as object data in OSSL_PARAM form. The
latter will allow libcrypto to serialize some object with a different
provider than the one holding the data, if exporting of that data is
allowed and there is a serializer that can handle it.
We will provide serializers for the types of objects we know about,
which should be useful together with any other provider that provides
implementations of the same type of object.
Serializers are selected by method name and a couple of additional
properties:
- format used to tell what format the output should be in.
Possibilities could include "format=text",
"format=pem", "format=der", "format=pem-pkcs1"
(traditional), "format=der-pkcs1" (traditional)
- type used to tell exactly what type of data should be
output, for example "type=public" (the public part of
a key), "type=private" (the private part of a key),
"type=domainparams" (domain parameters).
This also adds a passphrase callback function type,
OSSL_PASSPHRASE_CALLBACK, which is a bit like OSSL_CALLBACK, but it
takes a few extra arguments to place the result in.
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10394)
2019-11-18 08:29:06 +08:00
|
|
|
|
2019-01-20 20:23:30 +08:00
|
|
|
=back
|
|
|
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
|
|
2020-06-21 07:21:19 +08:00
|
|
|
L<openssl-core_dispatch.h(7)>
|
2019-01-20 20:23:30 +08:00
|
|
|
|
|
|
|
|
=head1 HISTORY
|
|
|
|
|
|
|
|
|
|
The types described here were added in OpenSSL 3.0.
|
|
|
|
|
|
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
|
|
2021-05-06 20:03:23 +08:00
|
|
|
Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
|
2019-01-20 20:23:30 +08:00
|
|
|
|
|
|
|
|
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
|
|
|
|
|
in the file LICENSE in the source distribution or at
|
|
|
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
|
|
|
|
|
|
=cut
|
