ASN1_TYPE_get (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/ASN1_TYPE_get.3ssl".)

NAME

ASN1_TYPE_get, ASN1_TYPE_set, ASN1_TYPE_set1, ASN1_TYPE_cmp, ASN1_TYPE_unpack_sequence, ASN1_TYPE_pack_sequence - ASN1_TYPE utility functions

SYNOPSIS

 #include <openssl/asn1.h>

 int ASN1_TYPE_get(const ASN1_TYPE *a);
 void ASN1_TYPE_set(ASN1_TYPE *a, int type, void *value);
 int ASN1_TYPE_set1(ASN1_TYPE *a, int type, const void *value);
 int ASN1_TYPE_cmp(const ASN1_TYPE *a, const ASN1_TYPE *b);

 void *ASN1_TYPE_unpack_sequence(const ASN1_ITEM *it, const ASN1_TYPE *t);
 ASN1_TYPE *ASN1_TYPE_pack_sequence(const ASN1_ITEM *it, void *s,
                                    ASN1_TYPE **t);

DESCRIPTION

These functions allow an structure to be manipulated. The structure can contain any type or constructed type such as a it is effectively equivalent to the type.

ASN1_TYPE_get() returns the type of a.

ASN1_TYPE_set() sets the value of a to type and value. This function uses the pointer value internally so it must not be freed up after the call.

ASN1_TYPE_set1() sets the value of a to type a copy of value.

ASN1_TYPE_cmp() compares

types a and b and returns 0 if they are identical and non-zero otherwise.

ASN1_TYPE_unpack_sequence() attempts to parse the

present in t using the structure it. If successful it returns a pointer to the structure corresponding to it which must be freed by the caller. If it fails it return

ASN1_TYPE_pack_sequence() attempts to encode the

structure s corresponding to it into an If successful the encoded is returned. If t and *t are not the encoded type is written to t overwriting any existing data. If t is not but *t is the returned is written to *t.

NOTES

The type and meaning of the value parameter for ASN1_TYPE_set() and ASN1_TYPE_set1() is determined by the type parameter. If type is V_ASN1_NULL value is ignored. If type is V_ASN1_BOOLEAN then the boolean is set to if value is not If type is V_ASN1_OBJECT then value is an structure. Otherwise type is and structure. If type corresponds to a primitive type (or a string type) then the contents of the contain the content octets of the type. If type corresponds to a constructed type or a tagged type (V_ASN1_SEQUENCE, V_ASN1_SET or V_ASN1_OTHER) then the contains the entire encoding verbatim (including tag and length octets).

ASN1_TYPE_cmp() may not return zero if two types are equivalent but have different encodings. For example the single content octet of the boolean

value under can have any non-zero encoding but ASN1_TYPE_cmp() will only return zero if the values are the same.

If either or both of the parameters passed to ASN1_TYPE_cmp() is

the return value is non-zero. Technically if both parameters are the two types could be absent fields and so should match, however passing values could also indicate a programming error (for example an unparseable type which returns ) for types which do not match. So applications should handle the case of two absent values separately.

RETURN VALUES

ASN1_TYPE_get() returns the type of the argument.

ASN1_TYPE_set() does not return a value.

ASN1_TYPE_set1() returns 1 for success and 0 for failure.

ASN1_TYPE_cmp() returns 0 if the types are identical and non-zero otherwise.

ASN1_TYPE_unpack_sequence() returns a pointer to an

structure or on failure.

ASN1_TYPE_pack_sequence() return an

structure if it succeeds or on failure.

COPYRIGHT

Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the ``License''). You may not use this file except in compliance with the License. You can obtain a copy in the file

in the source distribution or at <www.openssl.org/source/license.html>.