Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OSSL_DECODER(3)			    OpenSSL		       OSSL_DECODER(3)

NAME
       OSSL_DECODER, OSSL_DECODER_fetch, OSSL_DECODER_up_ref,
       OSSL_DECODER_free, OSSL_DECODER_provider, OSSL_DECODER_properties,
       OSSL_DECODER_is_a, OSSL_DECODER_number, OSSL_DECODER_do_all_provided,
       OSSL_DECODER_names_do_all, OSSL_DECODER_gettable_params,
       OSSL_DECODER_get_params - Decoder method	routines

SYNOPSIS
	#include <openssl/decoder.h>

	typedef	struct ossl_decoder_st OSSL_DECODER;

	OSSL_DECODER *OSSL_DECODER_fetch(OSSL_LIB_CTX *ctx, const char *name,
					 const char *properties);
	int OSSL_DECODER_up_ref(OSSL_DECODER *decoder);
	void OSSL_DECODER_free(OSSL_DECODER *decoder);
	const OSSL_PROVIDER *OSSL_DECODER_provider(const OSSL_DECODER *decoder);
	const char *OSSL_DECODER_properties(const OSSL_DECODER *decoder);
	int OSSL_DECODER_is_a(const OSSL_DECODER *decoder, const char *name);
	int OSSL_DECODER_number(const OSSL_DECODER *decoder);
	void OSSL_DECODER_do_all_provided(OSSL_LIB_CTX *libctx,
					  void (*fn)(OSSL_DECODER *decoder, void *arg),
					  void *arg);
	void OSSL_DECODER_names_do_all(const OSSL_DECODER *decoder,
				       void (*fn)(const	char *name, void *data),
				       void *data);
	const OSSL_PARAM *OSSL_DECODER_gettable_params(OSSL_DECODER *decoder);
	int OSSL_DECODER_get_params(OSSL_DECODER_CTX *ctx, const OSSL_PARAM params[]);

DESCRIPTION
       OSSL_DECODER is a method	for decoders, which know how to	decode encoded
       data into an object of some type	that the rest of OpenSSL knows how to
       handle.

       OSSL_DECODER_fetch() looks for an algorithm within the provider that
       has been	loaded into the	OSSL_LIB_CTX given by ctx, having the name
       given by	name and the properties	given by properties.  The name
       determines what type of object the fetched decoder method is expected
       to be able to decode, and the properties	are used to determine the
       expected	output type.  For known	properties and the values they may
       have, please have a look	in "Names and properties" in
       provider-encoder(7).

       OSSL_DECODER_up_ref() increments	the reference count for	the given
       decoder.

       OSSL_DECODER_free() decrements the reference count for the given
       decoder,	and when the count reaches zero, frees it.

       OSSL_DECODER_provider() returns the provider of the given decoder.

       OSSL_DECODER_properties() returns the property definition associated
       with the	given decoder.

       OSSL_DECODER_is_a() checks if decoder is	an implementation of an
       algorithm that's	identifiable with name.

       OSSL_DECODER_number() returns the internal dynamic number assigned to
       the given decoder.

       OSSL_DECODER_names_do_all() traverses all names for the given decoder,
       and calls fn with each name and data as arguments.

       OSSL_DECODER_do_all_provided() traverses	all decoder implementations by
       all activated providers in the library context libctx, and for each of
       the implementations, calls fn with the implementation method and	arg as
       arguments.

       OSSL_DECODER_gettable_params() returns an OSSL_PARAM(3) array of
       parameter descriptors.

       OSSL_DECODER_get_params() attempts to get parameters specified with an
       OSSL_PARAM(3) array params.  Parameters that the	implementation doesn't
       recognise should	be ignored.

RETURN VALUES
       OSSL_DECODER_fetch() returns a pointer to an OSSL_DECODER object, or
       NULL on error.

       OSSL_DECODER_up_ref() returns 1 on success, or 0	on error.

       OSSL_DECODER_free() doesn't return any value.

       OSSL_DECODER_provider() returns a pointer to a provider object, or NULL
       on error.

       OSSL_DECODER_properties() returns a pointer to a	property definition
       string, or NULL on error.

       OSSL_DECODER_is_a() returns 1 if	decoder	was identifiable, otherwise 0.

       OSSL_DECODER_number() returns an	integer.

NOTES
       OSSL_DECODER_fetch() may	be called implicitly by	other fetching
       functions, using	the same library context and properties.  Any other
       API that	uses keys will typically do this.

SEE ALSO
       provider(7), OSSL_DECODER_CTX(3), OSSL_DECODER_from_bio(3),
       OSSL_DECODER_CTX_new_for_pkey(3), OSSL_LIB_CTX(3)

HISTORY
       The functions described here were added in OpenSSL 3.0.

COPYRIGHT
       Copyright 2020-2021 The OpenSSL Project Authors.	All Rights Reserved.

       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
       <https://www.openssl.org/source/license.html>.

3.0.0-alpha12			  2021-02-18		       OSSL_DECODER(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | NOTES | SEE ALSO | HISTORY | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OSSL_DECODER&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help