New ASN1_TYPE SEQUENCE functions.

[openssl.git] / doc / crypto / ASN1_TYPE_get.pod

diff --git a/doc/crypto/ASN1_TYPE_get.pod b/doc/crypto/ASN1_TYPE_get.pod
index a6c65aaa34c2958b65e5f4a88bddfb8969a8328d..79f2e382e1848106ee6d3d5ae441d17f301b53ae 100644 (file)
--- a/doc/crypto/ASN1_TYPE_get.pod
+++ b/doc/crypto/ASN1_TYPE_get.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-ASN1_TYPE_get, ASN1_TYPE_set, ASN1_TYPE_set1, ASN1_TYPE_cmp - ASN1_TYPE utility
+ASN1_TYPE_get, ASN1_TYPE_set, ASN1_TYPE_set1, ASN1_TYPE_cmp, ASN1_TYPE_unpack_sequence, ASN1_TYPE_pack_sequence - ASN1_TYPE utility
 functions
 
 =head1 SYNOPSIS
@@ -14,6 +14,10 @@ functions
  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);
+
 =head1 DESCRIPTION
 
 These functions allow an ASN1_TYPE structure to be manipulated. The
@@ -31,6 +35,17 @@ ASN1_TYPE_set1() sets the value of B<a> to B<type> a copy of B<value>.
 ASN1_TYPE_cmp() compares ASN.1 types B<a> and B<b> and returns 0 if
 they are identical and non-zero otherwise.
 
+ASN1_TYPE_unpack_sequence() attempts to parse the SEQUENCE present in
+B<t> using the ASN.1 structure B<it>. If successful it returns a pointer
+to the ASN.1 structure corresponding to B<it> which must be freed by the
+caller. If it fails it return NULL.
+
+ASN1_TYPE_pack_sequence() attempts to encode the ASN.1 structure B<s>
+corresponding to B<it> into an ASN1_TYPE. If successful the encoded
+ASN1_TYPE is returned. If B<t> and B<*t> are not NULL the encoded type
+is written to B<t> overwriting any existing data. If B<t> is not NULL
+but B<*t> is NULL the returned ASN1_TYPE is written to B<*t>.
+
 =head1 NOTES
 
 The type and meaning of the B<value> parameter for ASN1_TYPE_set() and
@@ -67,4 +82,10 @@ ASN1_TYPE_set1() returns 1 for sucess 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 ASN.1 structure or
+NULL on failure.
+
+ASN1_TYPE_pack_sequence() return an ASN1_TYPE structure if it succeeds or
+NULL on failure.
+
 =cut