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

FreeBSD Manual Pages

  
 
  

home | help
OSSL_DESERIALIZER_CTX(3)	    OpenSSL	      OSSL_DESERIALIZER_CTX(3)

NAME
       OSSL_DESERIALIZER_CTX, OSSL_DESERIALIZER_CTX_new,
       OSSL_DESERIALIZER_settable_ctx_params,
       OSSL_DESERIALIZER_CTX_set_params, OSSL_DESERIALIZER_CTX_free -
       Serializer context routines

SYNOPSIS
	#include <openssl/deserializer.h>

	typedef	struct ossl_deserializer_ctx_st	OSSL_DESERIALIZER_CTX;

	OSSL_DESERIALIZER_CTX *OSSL_DESERIALIZER_CTX_new(OPENSSL_CTX *libctx);
	const OSSL_PARAM *OSSL_DESERIALIZER_settable_ctx_params(OSSL_DESERIALIZER *deser);
	int OSSL_DESERIALIZER_CTX_set_params(OSSL_DESERIALIZER_CTX *ctx,
					     const OSSL_PARAM params[]);
	void OSSL_DESERIALIZER_CTX_free(OSSL_DESERIALIZER_CTX *ctx);

DESCRIPTION
       OSSL_DESERIALIZER_CTX is	a context with which OSSL_DESERIALIZER
       operations are performed.  The context typically	holds values, both
       internal	and supplied by	the application, which are useful for the
       implementations supplied	by providers.

       OSSL_DESERIALIZER_CTX_new() creates a new empty OSSL_DESERIALIZER_CTX.

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

       OSSL_DESERIALIZER_CTX_set_params() attempts to set parameters specified
       with an OSSL_PARAM(3) array params.  These parameters are passed	to all
       deserializers that have been added to the ctx so	far.  Parameters that
       an implementation doesn't recognise should be ignored by	it.

       OSSL_DESERIALIZER_CTX_free() frees the given context ctx.

RETURN VALUES
       OSSL_DESERIALIZER_CTX_new() returns a pointer to	a
       OSSL_DESERIALIZER_CTX, or NULL if the context structure couldn't	be
       allocated.

       OSSL_DESERIALIZER_settable_ctx_params() returns an OSSL_PARAM(3)	array,
       or NULL if none is available.

       OSSL_DESERIALIZER_CTX_set_params() returns 1 if all recognised
       parameters were valid, or 0 if one of them was invalid or caused	some
       other failure in	the implementation.

SEE ALSO
       provider(7), OSSL_DESERIALIZER(3), OSSL_DESERIALIZER_from_bio(3)

HISTORY
       The functions described here were added in OpenSSL 3.0.

COPYRIGHT
       Copyright 2020 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-alpha6			  2020-08-06	      OSSL_DESERIALIZER_CTX(3)

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

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

home | help