doc/man7/openssl-core.h.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl/core.h - OpenSSL Core types
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/core.h>
  10
  11 =head1 DESCRIPTION
  12
  13 The <openssl/core.h> header file defines a number of public types that
  14 are used to communicate between the OpenSSL libraries and
  15 implementation providers.
  16 These types are designed to minimise the need for intimate knowledge
  17 of internal structures between the OpenSSL libraries and the providers.
  18
  19 The types are:
  20
  21 =over 4
  22
  23 =item C<OSSL_DISPATCH>
  24
  25 This type is a tuple of function identity and function pointer.
  26 Arrays of this type are passed between the OpenSSL libraries and the
  27 providers to describe what functionality one side provides to the
  28 other.
  29 Arrays of this type must be terminated with a tuple having function
  30 identity zero and function pointer C<NULL>.
  31
  32 The available function identities and corresponding function
  33 signatures are defined by L<openssl-core_numbers.h(7)>.
  34
  35 Any function identity not recognised by the recipient of this type
  36 will be ignored.
  37 This ensures that providers built with one OpenSSL version in mind
  38 will work together with any other OpenSSL version that supports this
  39 mechanism.
  40
  41 =item C<OSSL_ITEM>
  42
  43 This type is a tuple of integer and pointer.
  44 It's a generic type used as a generic descriptor, its exact meaning
  45 being defined by how it's used.
  46 Arrays of this type are passed between the OpenSSL libraries and the
  47 providers, and must be terminated with a tuple where the integer is
  48 zero and the pointer C<NULL>.
  49
  50 =item C<OSSL_ALGORITHM>
  51
  52 This type is a tuple of an algorithm name (string), a property
  53 definition (string) and a dispatch table (array of C<OSSL_DISPATCH>).
  54 Arrays of this type are passed on demand from the providers to the
  55 OpenSSL libraries to describe what algorithms the providers provide
  56 implementations of, and with what properties.
  57 Arrays of this type must be terminated with a tuple having function
  58 identity zero and function pointer C<NULL>.
  59
  60 The algorithm names and property definitions are defined by the
  61 providers.
  62
  63 =item C<OSSL_PARAM>
  64
  65 This type is a structure that allows passing arbitrary object data
  66 between two parties that have no or very little shared knowledge about
  67 their respective internal structures for that object.
  68 It's normally passed in arrays, where the array is terminated with an
  69 element where all fields are zero (for non-pointers) or C<NULL> (for
  70 pointers).
  71
  72 These arrays can be used to set parameters for some object, to request
  73 parameters, and to describe parameters.
  74
  75 C<OSSL_PARAM> is further described in L<OSSL_PARAM(3)>
  76
  77 =back
  78
  79 =head1 SEE ALSO
  80
  81 L<openssl-core_numbers.h(7)>
  82
  83 =head1 HISTORY
  84
  85 The types described here were added in OpenSSL 3.0.
  86
  87 =head1 COPYRIGHT
  88
  89 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  90
  91 Licensed under the Apache License 2.0 (the "License").  You may not use
  92 this file except in compliance with the License.  You can obtain a copy
  93 in the file LICENSE in the source distribution or at
  94 L<https://www.openssl.org/source/license.html>.
  95
  96 =cut